Accept an entity access invitation

PATCH

/entity-access-invites

Accepts a pending invitation to access an entity using the invitation token sent to the invitee's email address. On success, this grants the authenticated identity resource access to the entity with the role specified in the invitation, and marks the invitation as accepted. The identity is resolved from the authenticated session's token, not from the request body. The invitation's email must match the primary email of the authenticated identity, the invitation must still be pending and not expired, and the identity must not already have access to the entity, otherwise the request fails.

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

Authorization: ********************

Body Params application/jsonRequired

Examples

Responses

🟢200

application/json

The invitation was accepted successfully and resource access to the entity was granted to the authenticated identity.

Bodyapplication/json

🟠400

🟠401

Request Example

Shell

JavaScript

Java

Swift

curl --location --request PATCH '/entity-access-invites' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "token": "3f7a9c2e8b1d4f6a0c5e7b9d2a4f6c8e"
}'

Response Example

200 - Success

{
    "message": "Entity access invite accepted successfully",
    "status": "success",
    "data": {
        "id": "01HQZR2BKPFQ8MXJVT3G7LWNA",
        "entity_id": "01HQZR2BKPFQ8MXJVT3G7LW01",
        "role": "developer"
    }
}

Modified at 2026-09-30 00:29:30

List an entity's team members

Invite a new member to an entity