Skip to main content
PATCH
Update data retention settings

Authorizations

Authorization
string
header
required

API key (fam_..., created under Settings → API Keys) or an OAuth 2.0 access token (fam_at_...). Keys can be restricted to scopes such as assistants:read, calls:write, campaigns:write, automations:read, dashboards:read, dashboards:write, leads:write, segments:write, phone_numbers:write, sip_trunks:write, knowledge:write, voices:read, billing:read, settings:write, platform:read, platform:write; a *:write scope implies the matching *:read. Automation and dashboard endpoints also accept the legacy calls:* scope. Keys without scope restrictions have full access.

Body

application/json

Per-channel retention overrides in months. null clears an override and restores the plan default.

calls_months
integer | null
leads_months
integer | null
email_months
integer | null
sms_months
integer | null
telegram_months
integer | null
slack_months
integer | null
messenger_months
integer | null
teams_months
integer | null
discord_months
integer | null
gchat_months
integer | null
x_months
integer | null
whatsapp_months
integer | null

Response

The updated workspace retention policy.

data
object