Docmost Octri Preview
POST/workspace/invites/create

Invite users to the workspace

Invites users to the workspace by email and assigns each invitee a workspace role. Supply 1–50 valid email addresses in emails and choose a role; you can also specify groups to add invitees to when they accept.

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

3 body fields

Workspace invitation details, including the invitee email addresses, assigned role, and optional groups.

emailsarray<string>required
Email addresses to invite. 1–50 emails per request. Users already in the workspace are skipped.
groupIdsarray<string>optional
Groups to automatically add invitees to when they accept the invitation. Optional.
rolestringrequired
Workspace role assigned to all invitees.
Allowed:owneradminmember

3 status codes
200Returns a response confirming that the invitation was created, with the standard `data`, `status`, and `success` fields.
dataunknownoptional
Response payload
statusintegeroptional
successbooleanoptional
400Returned when the invitation details fail validation, including when an email address is invalid or the email or group list exceeds its allowed size.
errorstringoptional
Reason phrase, for example `Bad Request`.
messagestringoptional
statusCodeintegeroptional
403Returned when the authenticated user does not have Manage/Member permission.
errorstringoptional
Reason phrase, for example `Bad Request`.
messagestringoptional
statusCodeintegeroptional

Error handling

A 400 is returned when emails or role is missing, an email address is invalid, or a list exceeds its allowed size. role must be owner, admin, or member; each groupIds value must be a UUID. A 403 is returned when the authenticated user lacks Manage/Member permission.