Skip to main content
POST
cURL
Legacy endpoint. /api/v1/invitations/bulk-invite/ predates workspaces. It keeps working for existing integrations, but it cannot place an invitee in a workspace. New integrations should use Bulk Invite Users, which takes the same request with the role named organization_role and accepts workspaces.
Each entry in invitations takes the same fields as the legacy single invite. The batch is all-or-nothing, and the response (message, invited, resent) is the same as Bulk Invite Users.

Authorizations

x-api-key
string
header
required

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

Body

invitations
object[]
required

The people to invite.

Response

200 - application/json

What a bulk invite 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 that had no outstanding invitation and now do.

resent
string<email>[]
required

Addresses whose outstanding invitation was re-sent.