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, billing:write, 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 successful memory update until content goes stale; null = never.

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

Configured memory channels. Web Chat and Web Voice require a current verified widget email or phone and visitor consent. Web and SMS memory require a root workspace. An empty array disables all memory channels.

Memory channels. Web Chat and Web Voice require a current verified widget email or phone and memory consent. Web and SMS memory require a root workspace. Legacy web configuration expands to both web channels; anonymous sessions remain excluded.

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

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