Skip to main content
POST
Invite workspace member

Authorizations

Authorization
string
header
required

Personal access token, sent as Authorization: Bearer <token>.

Query Parameters

workspaceId
string
required

ID of the workspace. With a personal access token, use the token's workspace. Get it from organization_id in Get app.

Minimum string length: 1

Body

application/json

An invitation to join a workspace.

email
string
required

Email of the person to invite.

Required string length: 5 - 254
Example:

"dana@acme.com"

role
enum<string>
default:viewer

Role the invitee gets when they accept. Defaults to viewer. admin needs the Business plan or higher.

Available options:
admin,
editor,
viewer
Example:

"editor"

group_id
string | null

ID of a custom group to add the invitee to when they accept. Get it from List workspace groups. Needs a plan that includes groups.

Example:

"68b4e1d2c9a7f3001e2d4b61"

Response

The invitation was saved. The body is null.