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 administrators. If the user is already in the workspace a 400 error will be returned.

Request

This endpoint expects an object.

emailstringRequired

The email of the customer

seat_typeenum or nullOptional

The seat type of the user

Allowed values:

group_idslist of strings or nullOptional

The group ids of the user

workspace_permissionstring or nullOptionalDeprecated

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

Response

Successful Response

statusstring

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.

1	curl -X POST https://api.elevenlabs.io/v1/workspace/invites/add \
2	-H "xi-api-key: xi-api-key" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"email": "john.doe@testmail.com"
6	}'

Headers

Request

Response

Errors