Docmost Octri Preview
POST/workspace/invites/link

Get a direct workspace invitation link

Retrieves a direct link for a workspace invitation. Use this operation only on a self-hosted deployment; it is not available on cloud, and the authenticated user must have Manage/Member permission.

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

1 body field

The workspace invitation whose direct link you want to retrieve.

invitationIdstringrequired
The UUID of the invitation to retrieve a direct link for.

2 status codes
200Returns the direct invitation link in the response `data` field, alongside the standard `status` and `success` fields.
dataobjectoptional
statusintegeroptional
successbooleanoptional
403Returned when the authenticated user does not have Manage/Member permission or the operation is unavailable for the deployment.
errorstringoptional
Reason phrase, for example `Bad Request`.
messagestringoptional
statusCodeintegeroptional

Error handling

invitationId must be a UUID identifying the invitation. A 403 is returned when the authenticated user lacks Manage/Member permission or the operation is used on cloud.