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

Each person is created at once with status pending; access starts when they accept and sign in. People are matched by externalId first, then email (case-insensitive). Returns 201 when every item succeeds and 207 when any item fails; each item carries its own outcome. Items not started within the 15-second request deadline return NOT_PROCESSED; retry with the same Idempotency-Key.

Required scope: workspace.members.write

POST

api

public

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": {}
  }
}

Use this endpoint to invite up to 100 people to a workspace in one request. Each person is created at once with the status 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.

Authorizations

X-API-Key

string

header

required

Platform key, for example abl_ws_….

Headers

Idempotency-Key

string

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 - 255

Path Parameters

workspaceId

string

required

Minimum string length: 1

Body

application/json

members

object[]

required

Required array length: 1 - 100 elements

Show child attributes

sendInviteEmail

boolean

default:true

Response

All items succeeded.

success

enum<boolean>

required

Available options:

true

data

object

required

Show child attributes

APIs

SDKs

Create workspace member invitations

Authorizations

Headers

Path Parameters

Body

Response