Skip to main content
POST
cURL
Runs Invite to Workspace for each entry, and answers with the addresses split by what happened to each.
All-or-nothing. One entry that fails, such as a person deactivated in the organization or one already in the workspace with another role, undoes the whole batch: nothing is written and nobody is emailed.

Request body

Response

Returns 200 OK:

Example

Authentication

This endpoint requires an API key created by a workspace admin of the key’s workspace. Organization owners and admins are admins of every workspace.

Errors

Every one of these rejects the whole batch.

Authorizations

x-api-key
string
header
required

API Key authentication. Format: 'x-api-key: api_key'

Body

Several people to invite to your current workspace, each as a single invitation takes one.

invitations
object[]
required

The people to invite.

Response

200 - application/json

What a bulk invite to the workspace did, split by what happened to each address.

message
string
required

Human-readable summary of what the bulk invite did.

invited
string<email>[]
required

Addresses invited to the organization from this workspace, waiting in it until they accept.

resent
string<email>[]
required

Addresses whose outstanding invitation was re-sent from this workspace.

associated
string<email>[]
required

Addresses already active in the organization, only added to this workspace; nothing was sent to them.