Skip to main content
PATCH
Update messaging connector

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
name
string
Maximum string length: 120
assistant_id
string<uuid>
is_active
boolean
response_delay_sec
integer
Required range: 0 <= x <= 30
inactivity_timeout_min
integer
Required range: 1 <= x <= 1440
allow_retrigger
boolean
conversation_ended_webhook_url
string<uri> | null
reply_mode
enum<string>

App channels only. send (default) or draft (Gmail and Outlook only; 400 elsewhere).

Available options:
send,
draft
extra_actions_enabled
boolean

App channels only. Allow one app-specific action (e.g. label, tag, prioritize) alongside each reply.

watch_scope
enum<string>

Gmail, Outlook, Zoho Mail, and AgentMail only. Which mailbox slice the assistant watches. AgentMail always uses inbox; set watch_id to choose the inbox.

Available options:
inbox,
all,
label,
folder
watch_name
string | null

Display name of the selected Gmail label, mail folder, or AgentMail inbox address.

watch_id
string | null

Provider id from GET /messaging-connectors/{id}/watch-options. For AgentMail, the inbox the assistant answers and replies from.

ai_enabled
boolean

Enable or pause automatic replies on this channel.

outbound_sms_enabled
boolean

SMS only. Save the linked number's outbound SMS permission atomically with the channel settings and assistant assignment. Omit to preserve the current permission.

expected_updated_at
string<date-time>

SMS only. The channel updated_at value from the last read. If the channel has changed, the update returns HTTP 409 and preserves the newer settings. Reload before retrying. Optional for existing clients.

sms_delivery_mode
enum<string>

Delivery selection within SMS. Omit to inherit the saved connection policy; SMS only prevents RCS upgrade.

Available options:
sms_only,
rcs_preferred,
rcs_only
rcs_sender_id
string<uuid> | null

Owned company sender ID for this SMS connection. Must be ready before RCS can be enabled.

rcs_default_connector
boolean
write-only

SMS only: true routes new incoming RCS contacts for the company sender to this connection. False releases this connection when it is the current default; another linked connection may be selected. Omit to preserve incoming routing. Read the sender default_connector_id for the authoritative selection.

Response

Updated connector.

data
object