Docmost Octri Preview
POST/workspace/invites/accept

Accept a workspace invitation

Accepts a workspace invitation and creates a user account for the invitee. Supply the invitation ID, matching invitation token, display name, and password; the name must be 2–60 characters and the password must be at least 8 characters.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

4 body fields

The invitation and account details required to accept the workspace invitation.

invitationIdstringrequired
ID of the invitation being accepted.
namestringrequired
Display name for the new user account.
passwordstringrequired
Password for the new user account.
tokenstringrequired
Invitation token from the invitation email. Must match the stored token.

2 status codes
200Returns a response confirming that the invitation was accepted, with the standard `data`, `status`, and `success` fields.
dataunknownoptional
Response payload
statusintegeroptional
successbooleanoptional
400Returned when the invitation token is invalid or the request fails validation.
errorstringoptional
Reason phrase, for example `Bad Request`.
messagestringoptional
statusCodeintegeroptional

Error handling

A 400 is returned when a required field is missing, the invitation token does not match, or a field fails validation. invitationId must be a UUID, name must be 2–60 characters, and password must contain at least 8 characters.