API reference descriptions are provided in English to preserve the exact published contract.
GET /v1/accounts/{AC}/legal-holds
Required scope: `legal_holds: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}/legal-holds
The account's own compliance role (legal_holds:manage: OWNER, ADMIN, COMPLIANCE_MANAGER) places a hold on the account, a contact, a conversation, a campaign or a date range. While it stands, retention skips the data in scope and erasure requests that touch it are parked. ShipMsg staff holds need an approvalSid. Required scope: any one of `legal_holds:write`, `legal_holds:manage`.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
AC | path · string (AC… SID) | yes | Account SID |
| Name | Type | Required | Description |
|---|---|---|---|
approvalSid | string (AP… SID) | ||
caseRef | string (max 128 chars) | yes | |
customerVisible | boolean | ||
scope | object | yes |
Errors: 400, 401, 403, 404, 409, 422, 429, 500, 503 — see errors.
POST /v1/accounts/{AC}/legal-holds/{holdId}/release
Releasing lets retention and parked erasures remove the data again. The account's compliance role releases only holds it placed, with a step-up token for LEGAL_HOLD_RELEASE; a hold ShipMsg placed is released only by ShipMsg compliance. Required scope: any one of `legal_holds:write`, `legal_holds:manage`.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
AC | path · string (AC… SID) | yes | Account SID |
holdId | path · string (uuid) | yes |
| Name | Type | Required | Description |
|---|---|---|---|
caseRef | string (max 128 chars) | yes | |
stepUpToken | string (max 256 chars) |
Errors: 400, 401, 403, 404, 409, 422, 429, 500, 503 — see errors.
GET /v1/accounts/{AC}/privacy/requests
Required scope: `privacy: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}/privacy/requests
Required scope: `privacy:write`.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
AC | path · string (AC… SID) | yes | Account SID |
| Name | Type | Required | Description |
|---|---|---|---|
changes | object | ||
changes.attributes | object | ||
changes.displayName | null | string (max 128 chars) | ||
changes.locale | null | string (max 16 chars) | ||
changes.timezone | null | string (max 64 chars) | ||
kind | "ERASURE" | "ACCESS" | "PORTABILITY" | "RECTIFICATION" | "RESTRICTION" | yes | |
reason | string (max 2000 chars) | yes | |
stepUpToken | string (max 256 chars) | yes | |
subject | object | yes |
Errors: 400, 401, 403, 404, 409, 422, 429, 500, 503 — see errors.
GET /v1/accounts/{AC}/privacy/requests/{DR}
Required scope: `privacy:read`.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
AC | path · string (AC… SID) | yes | Account SID |
DR | path · string (DR… SID) | yes |
Errors: 400, 401, 403, 404, 409, 422, 429, 500, 503 — see errors.
POST /v1/accounts/{AC}/privacy/requests/{DR}/lift-restriction
Required scope: `privacy:write`.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
AC | path · string (AC… SID) | yes | Account SID |
DR | path · string (DR… SID) | yes |
| Name | Type | Required | Description |
|---|---|---|---|
reason | string (max 2000 chars) | yes | |
stepUpToken | string (max 256 chars) | yes |
Errors: 400, 401, 403, 404, 409, 422, 429, 500, 503 — see errors.
GET /v1/accounts/{AC}/privacy/retention-policy
A null window means the data is kept until the customer deletes it, which is the default for an account that never set a policy. Required scope: `privacy:read`.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
AC | path · string (AC… SID) | yes | Account SID |
Errors: 400, 401, 403, 404, 409, 422, 429, 500, 503 — see errors.
PUT /v1/accounts/{AC}/privacy/retention-policy
Content is kept 30 to 3650 days and message records 1 to 120 months; null keeps them until deleted. A change that shortens either window removes data and needs a step-up token for RETENTION_POLICY_CHANGE; the response says what the retention job will remove on its next run. Required scope: `retention:write`.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
AC | path · string (AC… SID) | yes | Account SID |
| Name | Type | Required | Description |
|---|---|---|---|
analyticsMonths | integer (1–36) | ||
messageContentDays | integer (30–3650) | null | yes | |
messageMetadataMonths | integer (1–120) | null | yes | |
stepUpToken | string (max 256 chars) |
Errors: 400, 401, 403, 404, 409, 422, 429, 500, 503 — see errors.
GET /v1/accounts/{AC}/privacy/retention-policy/preview
A dry run with the retention job's own windows and legal-hold rules. Nothing is changed. Omit a window to preview keeping that data until deleted. Required scope: `privacy:read`.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
messageContentDays | query · integer (30–3650) | ||
messageMetadataMonths | query · integer (1–120) | ||
AC | path · string (AC… SID) | yes | Account SID |
Errors: 400, 401, 403, 404, 409, 422, 429, 500, 503 — see errors.