Accept a document invitation

POST

/api/v1/invitations/{id}/accept

App integration: Accept only at the user's request. The API verifies the matching email and preserves an already higher role. Use the returned document and permission to refresh the shared library.

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:

permissions:write-Share documents and change or remove access

Path Params

Responses

🟢200

application/json

The document and your permission (a higher role you hold is kept).

Headers

Bodyapplication/json

🟠401Unauthorized

🟠403Forbidden

🟠404NotFound

🟠422Unprocessable

🟠429TooManyRequests

🔴500ServerError

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST '/api/v1/invitations//accept' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Example 1

{
    "document": {
        "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"
    },
    "permission": {
        "principal": "user:3f2b…",
        "role": "viewer",
        "email": "string",
        "grantedBy": "user:3f2b…",
        "createdAt": "2019-08-24T14:15:22.123Z",
        "updatedAt": "2019-08-24T14:15:22.123Z"
    }
}

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

Document invitations to your verified email

Decline a document invitation