Change settings (per key, the newer updatedAt wins)

PATCH

/api/v1/settings

App integration: Send only changed keys with their per-key updatedAt timestamp. Inspect applied and kept; an older/equal write can lose without the request failing. Do not send local-only storage/sync/app-lock keys or retry a policy-locked value as a way around enforcement.

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:

settings:write-Change your app and reader settings

Body Params application/jsonRequired

Examples

Responses

🟢200

application/json

The merged settings with applied and kept keys.

Headers

Bodyapplication/json

🟠400BadRequest

🟠401Unauthorized

🟠403Forbidden

🟠409Conflict

🟠429TooManyRequests

🔴500ServerError

Request Example

Shell

JavaScript

Java

Swift

curl --location --request PATCH '/api/v1/settings' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "device": "string",
    "changes": {
        "property1": {
            "value": null,
            "updatedAt": "2019-08-24T14:15:22.123Z"
        },
        "property2": {
            "value": null,
            "updatedAt": "2019-08-24T14:15:22.123Z"
        }
    }
}'

Response Example

200 - Example 1

{
    "settings": {
        "property1": {
            "value": null,
            "updatedAt": "2019-08-24T14:15:22.123Z",
            "updatedBy": "string"
        },
        "property2": {
            "value": null,
            "updatedAt": "2019-08-24T14:15:22.123Z",
            "updatedBy": "string"
        }
    },
    "version": 0,
    "updatedAt": "2019-08-24T14:15:22.123Z",
    "applied": [
        "string"
    ],
    "kept": [
        "string"
    ]
}

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

Synced app and reader settings

Incoming webhook delivery — README