Skip to main content
PATCH
Update low-credit warning preferences

Authorizations

Authorization
string
header
required

API key (fam_..., created under Settings → API Keys) or an OAuth 2.0 access token (fam_at_...). REST operations also require API Access for the credential's workspace. Keys can be restricted to scopes such as assistants:read, calls:write, campaigns:write, automations:read, dashboards:read, dashboards:write, leads:write, segments:write, loop:read, loop: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 within the workspace's available capabilities.

Body

application/json
enabled
boolean
required

Whether personal low-credit warnings are enabled.

threshold_credits
integer
required

Send the warning when the available balance reaches this number of credits.

Required range: 1 <= x <= 1000000000
push_enabled
boolean
required

Deliver the warning through browser push notifications.

email_enabled
boolean
required

Deliver the warning to the account email address.

Response

Updated personal low-credit warning preferences.

data
object
required