Skip to main content
PATCH
Update Twilio Flex integration settings

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
ai_queue_sid
string

Optional AI queue SID for routing AI-handled conversations

ai_worker_email_domain
string | null

Optional email domain for AI workers. When set, each worker gets an email like opencx{N}-{random}@{domain} on its Twilio attributes. Set to empty string or null to clear.

Minimum string length: 1
Pattern: ^[a-z0-9.-]+\.[a-z]{2,}$
internal_notes_enabled
boolean

Whether to post internal notes (e.g. the AI handoff summary) to the Flex conversation. Twilio Conversations has no internal-note concept — notes are delivered to ALL participants including the customer — so this is disabled by default. Notes are stamped with an internal_note message attribute so client apps can filter them. Omitting the field keeps the stored value.

interactions_handoff_enabled
boolean

Whether OpenCX drives the handoff routing itself via the Flex Interactions API (inviting a human into the interaction). Disabled by default: most customers listen to the OpenCX conversation-handoff webhook and run their own Interactions transfer — enabling this on top of that produces duplicate chat requests. Omitting the field keeps the stored value.

contact_synced_task_attributes
string[]

Task attribute names to promote from the session onto the contact, written as your Flex workflow sends them (e.g. "user_id", "is_hvc", "customers.name"). Empty (the default) syncs nothing. Only durable, customer-level attributes belong here — per-conversation values like an order id would be overwritten on every new session. Omitting the field keeps the stored value.

Minimum string length: 1

Response

Default Response

connected
boolean
required
settings
object | null
required
unusable_contact_sync_attributes
object[]
required

Synced attribute names that will never match: 'invalid' = malformed, 'not_seen' = absent from recent tasks. Advisory; the save still happened.