v5

latestOpenAPI 3.1.02026-08-043621,4011.8 MB

workspace

Invite User

Sends an email invitation to join your workspace to the provided email. If the user doesn't have an account they will be prompted to create one. If the user accepts this invite they will be added as a user 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. If the user is already in the workspace a 400 error will be returned.

post/v1/workspace/invites/add

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.

Request body

emailstring required

The email of the customer

workspace_permissionstring nullable

The workspace permission of the user. This is deprecated, use seat_type instead.

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

{
  "email": "john.doe@testmail.com",
  "workspace_permission": "workspace_member",
  "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"
}