Skip to main content
PATCH
Update WhatsApp sender profile

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.

Path Parameters

id
string<uuid>
required

Body

application/json
ai_enabled
boolean

Automatically reply to incoming customer messages.

ignore_message_reactions
boolean
default:true

Ignore emoji reactions. When false, new reactions are processed as incoming messages.

keep_conversations_unread
boolean

Keep customer messages unread and omit the typing indicator.

response_delay_sec
integer

Debounce after the latest customer message. Zero means no deliberate delay; AI generation and delivery take additional time.

Required range: 0 <= x <= 30
inactivity_timeout_min
integer

Customer inactivity before ending a conversation.

Required range: 1 <= x <= 1440
allow_retrigger
boolean

Send the configured conversation-ended webhook again after a customer resumes the same chat and becomes inactive.

conversation_ended_webhook_url
string | null

HTTPS destination for the transcript and extracted variables. Null disables this webhook.

Response

Updated profile.