Change title, text, content type or language

PATCH

/api/v1/documents/{id}

App integration: PATCH only fields the user changed. Send If-Match with the last observed revision. On 412 re-fetch and reconcile. Content changes may be blocked while live editing is active; do not fall back to an unconditional overwrite.

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

OAuth 2.0

Authorization Code

Add the parameter

Authorization

to Headers，whose value is to concatenate the Token after the Bearer.

Example:

Authorization: Bearer ********************

Authorize URL: https://handwrites.io/oauth/authorize

Token URL: https://handwrites.io/api/oauth/token

Refresh URL: https://handwrites.io/api/oauth/token

Scopes:

documents:write-Create documents, edit them and upload their files

Path Params

Header Params

Body Params application/jsonRequired

Examples

Responses

🟢200

application/json

The new revision.

Headers

Bodyapplication/json

🟠400BadRequest

🟠401Unauthorized

🟠403Forbidden

🟠404NotFound

🟠409Conflict

🟠412PreconditionFailed

🟠413TooLarge

🟠429TooManyRequests

🔴500ServerError

Request Example

Shell

JavaScript

Java

Swift

curl --location --request PATCH '/api/v1/documents/' \
--header 'If-Match;' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "title": "string",
    "content": "string",
    "contentType": "text/plain",
    "language": "en"
}'

Response Example

200 - Example 1

{
    "id": "doc_Ab3dEf6hIj9kLm0n",
    "title": "string",
    "language": "en",
    "revision": 0,
    "contentType": "text/plain",
    "contentLength": 0,
    "contentSha256": "string",
    "file": {
        "name": "string",
        "type": "application/pdf",
        "length": 0
    },
    "owner": "user:3f2b…",
    "access": "owner",
    "source": "api",
    "createdAt": "2019-08-24T14:15:22.123Z",
    "updatedAt": "2019-08-24T14:15:22.123Z"
}

Modified at 2026-10-26 12:58:15

A document's metadata

Delete a document (owner)