Sign in

v4

latestOpenAPI 3.1.02026-07-313621,3961.8 MB
workspace

Invite Multiple Users

Sends email invitations to join your workspace to the provided emails. Requires all email addresses to be part of a verified domain. If the users don't have an account they will be prompted to create one. If the users accept these invites they will be added as users to your workspace and your subscription using one of your seats. This endpoint may only be called by workspace members with the WORKSPACE_MEMBERS_INVITE permission.

post/v1/workspace/invites/add-bulk

Headers

xi-api-keystring nullable

Your API key. This is required by most endpoints to access our API programmatically. You can view your xi-api-key using the 'Profile' tab on the website.

Your API key. This is required by most endpoints to access our API programmatically. You can view your xi-api-key using the 'Profile' tab on the website.

Request body

emailsstring[] required

The email of the customer

seat_type'workspace_admin' | 'workspace_member' | 'workspace_lite_member'

Seat types for workspace members.

group_idsstring[] nullable

The group ids of the user

usage_limitinteger nullable

Monthly credit usage limit for the invitee. Omit or set to null for no custom cap.

Example request

{
  "group_ids": [
    "group_id_1",
    "group_id_2"
  ],
  "usage_limit": 5000
}

Response

Successful Response

statusstring required

The status of the workspace invite request. If the request was successful, the status will be 'ok'. Otherwise an error message with status 500 will be returned.

Example response

{
  "status": "ok"
}