Skip to main content
PATCH
Update Zendesk integration settings

Authorizations

Authorization
string
header
required

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

Body

application/json
default_agent_id
string | null

Zendesk user id new tickets are assigned to when no team mapping applies

default_agent_group_id
string | null

Zendesk group id new tickets go to when no team mapping applies; null = none

create_ticket_only_on_handoff
boolean

true = a ticket is created only when the session is handed off to a human

skip_handoff_for_web
boolean

true = web handoffs stay inside OpenCX and never sync to Zendesk

skip_ticket_creation_for_web
boolean

true = no Zendesk ticket is created for web sessions

sync_automated_sender_tickets
boolean

true = tickets from automated senders (noreply@…) still get a session; the AI never replies to them

create_tickets_for_email_sessions
boolean

true = every email session opens a Zendesk ticket up front; false = only on handoff

ai_reads_private_notes
boolean

true = Zendesk internal notes are given to the AI as private context

post_handoff_note
boolean

true = a handoff posts a "Handoff Summary" internal note on the ticket

email_recipient_sync_enabled
boolean

true = agents can edit To/Cc recipients in OpenCX and the edits sync to Zendesk

Response

Default Response

connected
boolean
required

false = Zendesk is not connected; settings is null

settings
object | null
required