API reference descriptions are provided in English to preserve the exact published contract.
GET /v1/accounts/{AC}/users
Required scope: `users:read`.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
limit | query · integer (1–100) | ||
cursor | query · string (max 2048 chars) | ||
AC | path · string (AC… SID) | yes | Account SID |
Errors: 400, 401, 403, 404, 409, 422, 429, 500, 503 — see errors.
POST /v1/accounts/{AC}/users
Required scope: `users:write`.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
AC | path · string (AC… SID) | yes | Account SID |
| Name | Type | Required | Description |
|---|---|---|---|
displayName | string (max 128 chars) | yes | |
email | string (email, max 320 chars) | yes | |
environment | "live" | "sandbox" | "both" | ||
inboxSid | string (IB… SID) | ||
role | string (max 64 chars) | yes | |
scopeKind | "ORGANIZATION" | "ACCOUNT" | "SUBACCOUNT" | "INBOX" | ||
stepUpToken | string (max 256 chars) | yes |
Errors: 400, 401, 403, 404, 409, 422, 429, 500, 503 — see errors.
GET /v1/accounts/{AC}/users/{US}
Required scope: `users:read`.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
AC | path · string (AC… SID) | yes | Account SID |
US | path · string (US… SID) | yes |
Errors: 400, 401, 403, 404, 409, 422, 429, 500, 503 — see errors.
PATCH /v1/accounts/{AC}/users/{US}
Required scope: `users:write`.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
AC | path · string (AC… SID) | yes | Account SID |
US | path · string (US… SID) | yes |
| Name | Type | Required | Description |
|---|---|---|---|
displayName | string (max 128 chars) | ||
mfaRequired | boolean | ||
status | "ACTIVE" | "LOCKED" | "DISABLED" |
Errors: 400, 401, 403, 404, 409, 422, 429, 500, 503 — see errors.
DELETE /v1/accounts/{AC}/users/{US}
Required scope: `users:write`.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
AC | path · string (AC… SID) | yes | Account SID |
US | path · string (US… SID) | yes |
| Name | Type | Required | Description |
|---|---|---|---|
reason | string (max 1000 chars) | yes |
Errors: 400, 401, 403, 404, 409, 422, 429, 500, 503 — see errors.
POST /v1/accounts/{AC}/users/{US}/invitation
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. Required scope: `users:write`.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
AC | path · string (AC… SID) | yes | Account SID |
US | path · string (US… SID) | yes |
Errors: 400, 401, 403, 404, 409, 422, 429, 500, 503 — see errors.