Docs
Esc

Suggested

QuickstartGet started
Webhooks and signaturesMessaging
Create a messagemessages.create · POST /v1/accounts/{AC}/messages
RATE_LIMITED429 · Rate limit exceeded.
message.deliveredMessage resource
Contents

API reference

Users

API reference descriptions are provided in English to preserve the exact published contract.

List organization users

GET/v1/accounts/{AC}/users

users.listSDK operation getV1AccountsByAcUsers

Parameters

  • limitinteger (1–100)query
  • cursorstring (max 2048 chars)query

Invite an organization user

POST/v1/accounts/{AC}/users

users.createSDK operation postV1AccountsByAcUsers

Request body

  • displayNamestring (max 128 chars)Required
  • emailstring (email, max 320 chars)Required
  • rolestring (max 64 chars)Required
  • stepUpTokenstring (max 256 chars)Required
  • environmentenum

    livesandboxboth

  • inboxSidstring (IB… SID)
  • scopeKindenum

    ORGANIZATIONACCOUNTSUBACCOUNTINBOX

Get an organization user

GET/v1/accounts/{AC}/users/{US}

users.retrieveSDK operation getV1AccountsByAcUsersByUs

Parameters

  • USstring (US… SID)Required

Update an organization user

PATCH/v1/accounts/{AC}/users/{US}

users.updateSDK operation patchV1AccountsByAcUsersByUs

Parameters

  • USstring (US… SID)Required

Request body

  • displayNamestring (max 128 chars)
  • mfaRequiredboolean
  • statusenum

    ACTIVELOCKEDDISABLED

Disable an organization user

DELETE/v1/accounts/{AC}/users/{US}

users.deleteSDK operation deleteV1AccountsByAcUsersByUs

Parameters

  • USstring (US… SID)Required

Request body

  • reasonstring (max 1000 chars)Required

Resend an invited member's invitation e-mail

POST/v1/accounts/{AC}/users/{US}/invitation

users.invitationSDK operation postV1AccountsByAcUsersByUsInvitation

A2-ROLES-07: for a member still INVITED, issues a fresh invitation link (the previous one stops working) and e-mails it. Grants nothing, so no step-up is asked.

Parameters

  • USstring (US… SID)Required