Create workspace member invitations
curl --request POST \
--url https://{platformHost}/api/public/v1/workspaces/{workspaceId}/members \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"members": [
{
"email": "jane.doe@example.com",
"roleId": "builtin.workspace.restricted_member",
"externalId": "00u1abcd2345",
"name": "Jane Doe",
"attributes": {
"department": "Support"
}
}
],
"sendInviteEmail": true
}
'{
"success": true,
"data": {
"items": [
{
"email": "<string>",
"outcome": "created",
"memberId": "<string>",
"warning": "INVITE_EMAIL_QUEUED",
"details": {
"reason": "<string>",
"memberId": "<string>"
}
}
]
}
}{
"success": true,
"data": {
"items": [
{
"email": "<string>",
"outcome": "created",
"memberId": "<string>",
"warning": "INVITE_EMAIL_QUEUED",
"details": {
"reason": "<string>",
"memberId": "<string>"
}
}
]
}
}{
"success": false,
"error": {
"code": "INSUFFICIENT_SCOPE",
"message": "<string>",
"messages": [
"<string>"
],
"retryable": true,
"details": {}
}
}{
"success": false,
"error": {
"code": "INSUFFICIENT_SCOPE",
"message": "<string>",
"messages": [
"<string>"
],
"retryable": true,
"details": {}
}
}{
"success": false,
"error": {
"code": "INSUFFICIENT_SCOPE",
"message": "<string>",
"messages": [
"<string>"
],
"retryable": true,
"details": {}
}
}{
"success": false,
"error": {
"code": "INSUFFICIENT_SCOPE",
"message": "<string>",
"messages": [
"<string>"
],
"retryable": true,
"details": {}
}
}{
"success": false,
"error": {
"code": "INSUFFICIENT_SCOPE",
"message": "<string>",
"messages": [
"<string>"
],
"retryable": true,
"details": {}
}
}{
"success": false,
"error": {
"code": "INSUFFICIENT_SCOPE",
"message": "<string>",
"messages": [
"<string>"
],
"retryable": true,
"details": {}
}
}{
"success": false,
"error": {
"code": "INSUFFICIENT_SCOPE",
"message": "<string>",
"messages": [
"<string>"
],
"retryable": true,
"details": {}
}
}{
"success": false,
"error": {
"code": "INSUFFICIENT_SCOPE",
"message": "<string>",
"messages": [
"<string>"
],
"retryable": true,
"details": {}
}
}{
"success": false,
"error": {
"code": "INSUFFICIENT_SCOPE",
"message": "<string>",
"messages": [
"<string>"
],
"retryable": true,
"details": {}
}
}Create workspace member invitations
Invite up to 100 people to a workspace in one request. Each person stays pending until they accept.
POST
/
api
/
public
/
v1
/
workspaces
/
{workspaceId}
/
members
Create workspace member invitations
curl --request POST \
--url https://{platformHost}/api/public/v1/workspaces/{workspaceId}/members \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"members": [
{
"email": "jane.doe@example.com",
"roleId": "builtin.workspace.restricted_member",
"externalId": "00u1abcd2345",
"name": "Jane Doe",
"attributes": {
"department": "Support"
}
}
],
"sendInviteEmail": true
}
'{
"success": true,
"data": {
"items": [
{
"email": "<string>",
"outcome": "created",
"memberId": "<string>",
"warning": "INVITE_EMAIL_QUEUED",
"details": {
"reason": "<string>",
"memberId": "<string>"
}
}
]
}
}{
"success": true,
"data": {
"items": [
{
"email": "<string>",
"outcome": "created",
"memberId": "<string>",
"warning": "INVITE_EMAIL_QUEUED",
"details": {
"reason": "<string>",
"memberId": "<string>"
}
}
]
}
}{
"success": false,
"error": {
"code": "INSUFFICIENT_SCOPE",
"message": "<string>",
"messages": [
"<string>"
],
"retryable": true,
"details": {}
}
}{
"success": false,
"error": {
"code": "INSUFFICIENT_SCOPE",
"message": "<string>",
"messages": [
"<string>"
],
"retryable": true,
"details": {}
}
}{
"success": false,
"error": {
"code": "INSUFFICIENT_SCOPE",
"message": "<string>",
"messages": [
"<string>"
],
"retryable": true,
"details": {}
}
}{
"success": false,
"error": {
"code": "INSUFFICIENT_SCOPE",
"message": "<string>",
"messages": [
"<string>"
],
"retryable": true,
"details": {}
}
}{
"success": false,
"error": {
"code": "INSUFFICIENT_SCOPE",
"message": "<string>",
"messages": [
"<string>"
],
"retryable": true,
"details": {}
}
}{
"success": false,
"error": {
"code": "INSUFFICIENT_SCOPE",
"message": "<string>",
"messages": [
"<string>"
],
"retryable": true,
"details": {}
}
}{
"success": false,
"error": {
"code": "INSUFFICIENT_SCOPE",
"message": "<string>",
"messages": [
"<string>"
],
"retryable": true,
"details": {}
}
}{
"success": false,
"error": {
"code": "INSUFFICIENT_SCOPE",
"message": "<string>",
"messages": [
"<string>"
],
"retryable": true,
"details": {}
}
}{
"success": false,
"error": {
"code": "INSUFFICIENT_SCOPE",
"message": "<string>",
"messages": [
"<string>"
],
"retryable": true,
"details": {}
}
}pending. Access starts when the person accepts the invitation and signs in. The API matches people by externalId first, then by email address, ignoring case.
The call returns 201 when every item succeeds and 207 when any item fails. Each item in the response carries its own outcome. Items not started within the 15-second request deadline return NOT_PROCESSED. Retry them with the same Idempotency-Key. Set sendInviteEmail to false to skip the invitation email. The request needs the workspace.members.write scope.
Each item in members needs an email and a roleId. The externalId, name, and attributes fields are optional. An item’s outcome is created or reinvited when it succeeds. Otherwise it is an error code such as ALREADY_MEMBER or ALREADY_PENDING. A warning of INVITE_EMAIL_QUEUED means the member exists and the invitation email is queued for retry. Invitation emails are limited to 500 per hour for each workspace and 3 per address in 24 hours. To find the roles that a key can assign, use List workspace roles.Authorizations
platformApiKeybearerPlatformKey
Headers
Recommended on every write. A retry with the same key and body replays the first result instead of repeating the change. A different body returns 422 IDEMPOTENCY_KEY_REUSED; a retry while the first is still running returns 409 IDEMPOTENCY_IN_PROGRESS.
Required string length:
1 - 255Body
application/json
Was this page helpful?