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_...). 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.

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
watch_scope
enum<string>

Gmail, Outlook, and Zoho Mail only. Which mailbox slice the assistant watches.

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

Display name of the selected Gmail label or mail folder.

watch_id
string | null

Provider id from GET /messaging-connectors/{id}/watch-options.

Response

200 - application/json

Updated connector.

data
object