Skip to main content
POST
Invite workspace members in bulk

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

Invitations to send in one request.

invitations
BulkInvitationItem · object[]
required

The people to invite, 1 to 50. Each email can appear once.

Required array length: 1 - 50 elements
Example:

Response

Which invitations went out.

Which invitations went out.

total_sent
integer
required

Number of invitations sent, the length of successful.

Example:

1

successful
string[]
required

Emails an invitation was sent to.

Example:
failed
FailedInvitation · object[]
required

Invitations that weren't sent, with the reason. Empty when every invitation went out.

Example: