Skip to main content
PATCH
Update memory settings

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
memory_enabled_default
boolean

Workspace default for caller memory.

memory_staleness_days
integer | null

Days without a call until a caller profile goes stale; null = never.

Required range: 1 <= x <= 3650
memory_channels
enum<string>[]

Operational channels allowed to read and write canonical customer memory. Web is reserved until a server-verified signed-in identity boundary exists.

Minimum array length: 1

A currently operational memory channel. Web is deliberately excluded until signed-in browser users have a server-verified identity boundary.

Available options:
voice,
sms,
whatsapp,
email,
telegram,
slack,
messenger,
teams,
discord,
gchat,
x,
freshdesk,
gmail,
outlook,
zendesk,
servicenow,
intercom,
zoho_mail,
agent_mail,
instagram,
zulip

When true, unknown consent blocks memory reads and writes.

memory_retention_days
integer

Rolling retention in days; -1 keeps memory until it is manually erased.

Required range: -1 <= x <= 3650

Response

The updated settings.

data
object