Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.

Skip to main content

Open.cx Docs home page

Dashboard
Get Started
Get Started

Overview

Authentication

Blocklist

Blocklist
GET
List contacts
POST
Block contact
GET
Check contact
DEL
Unblock contact
GET
List domains
POST
Block domains
GET
Check domain
DEL
Unblock domain
GET
List blocked IPs
POST
Block IPs
GET
Check IP
DEL
Unblock IP
GET
Session IP activity

Autopilot

GET
Get
PUT
Update

Organization

Organization
GET
Get
PATCH
Update

Session sidebar

GET
Get layout
PUT
Update layout

Macros

Macros
GET
List
GET
Get
POST
Create
PATCH
Update
DEL
Delete
GET
List variables
GET
Get settings
PUT
Update settings
GET
Get translations
POST
Retranslate
GET
List suggestion insights
GET
Get suggestion insights

Contacts

Introduction to contacts
POST
Create
GET
Get
GET
List
POST
Search
PATCH
Update
DEL
Delete
GET
Get Structured Field Values
PUT
Set Structured Field Values
POST
Authenticate contact
POST
Authenticate contact by phone
POST
Authenticate contact by external ID

Companies

Introduction to companies
POST
Upsert
GET
List
POST
Search
GET
Get
PUT
Set owner
POST
Bulk link

Sessions

Sessions
POST
Create
POST
Merge sessions
GET
Get
GET
List
POST
Filter
PATCH
Update
PUT
Set Custom Status
DEL
Clear Custom Status
GET
Get Structured Field Values
PUT
Set Structured Field Values
POST
Assign
POST
Transfer to Team
POST
Add Tag
DEL
Remove Tag
POST
Send
POST
Create comment
PATCH
Update comment
DEL
Delete comment
POST
Handoff
GET
List history
GET
Export events
GET
Search

Connect

Overview
POST
Create thread
GET
Get thread
GET
List threads
PATCH
Update thread
POST
Add participant
DEL
Remove participant
POST
Create token
POST
Send message
GET
List messages

AI Phone Agents

POST
Create
GET
List
PUT
Set caller number
GET
List transfer destinations
POST
Hand back a call
POST
Finish wrap-up
POST
Make outbound call
POST
Create app voice call
POST
Connect app voice call
GET
Get app voice call
DEL
End app voice call

Classical IVR

GET
List recordings
POST
Upload recording
PUT
Assign number

AI Email

POST
Email API
PUT
Put domains
GET
Get domains
PATCH
Patch domains verify
DEL
Delete domains
GET
List email channels
PATCH
Update email channel template

AI WhatsApp

POST
Send template

AI Actions

AI Actions
GET
List
GET
Get
POST
Create
PATCH
Update
DEL
Delete
DEL
Delete all
PUT
Import
GET
List tags

Sequences

Sequences overview

Outbound Blocklist

Outbound blocklist overview
POST
Block address
DEL
Unblock address
GET
Check address
GET
List addresses

Media

Media
POST
Upload an image

AI Training

AI Training
POST
Create
GET
Get
PUT
Update
DEL
Delete
PUT
Toggle draft
POST
Move
POST
Search

Help Center

Overview
GET
List help centers
GET
Get
PUT
Update

Resource Usage

Resource Usage
GET
List Usage
GET
Get Usage Summary
GET
List Conversations

Customer Insights

Customer Insights
POST
Get all
GET
Get a specific customer insight
POST
Resolve
POST
Assign

Teams

Teams
GET
Get all
GET
Get
POST
Create
PUT
Update
GET
List categories
POST
Create category
DEL
Delete
POST
Add user
DEL
Remove user

CSAT

CSAT
GET
Get all
GET
Get
GET
Get session
GET
Check channel
GET
Check sent
GET
Get settings
PATCH
Update settings

Redaction

Redaction
POST
Redact message
POST
Redact session

Crawl

Crawl
POST
Create datasource
GET
List datasources
GET
Get datasource
PATCH
Update datasource
DEL
Delete datasource
POST
Start crawl
DEL
Cancel crawl
GET
List crawl jobs
GET
Get crawl job
GET
List pages
POST
Exclude pages
POST
Include pages

Custom Statuses

Custom Statuses
GET
List
GET
Get
POST
Create
PATCH
Update
DEL
Delete

Inbox Views

Inbox Views
GET
List
POST
Create
PATCH
Update
DEL
Delete

Office Hours

Office Hours
GET
Get Default
PUT
Update Default
GET
List
GET
Get
POST
Create
PUT
Update
DEL
Delete

Handoff Analytics

Handoff Analytics
GET
Get Analytics
GET
List Events

SLA Analytics

SLA Analytics
GET
Overview
GET
Breakdown
GET
Trend
GET
Breach heatmap
GET
Phone answer time
GET
Phone answer time breakdown
GET
Phone answer time by agent

SLA Policies

SLA Policies
GET
List
GET
Get
POST
Create
PUT
Update
DEL
Delete

Secrets

Secrets
POST
Create
PUT
Upsert

Audit Logs

Overview
GET
List

Workflows (Beta)

Workflows (Beta)
GET
Definitions
POST
Validate
POST
Create
GET
List
GET
Get
PATCH
Update
DEL
Delete
POST
Activate
POST
Deactivate
POST
Trigger
GET
List runs
GET
Get run

Salesforce MIAW

Salesforce MIAW
POST
Webhook

Zendesk Integration

Zendesk Integration
GET
Get settings
PATCH
Update settings
GET
List groups

HubSpot Integration

HubSpot Integration
GET
Get settings
PATCH
Update settings
GET
List users

Salesforce Integration

Salesforce Integration
GET
Get settings
PATCH
Update settings
GET
List org-wide addresses

Dynamics 365 Integration

Dynamics 365 Integration
GET
Get settings
PATCH
Update settings
GET
List queues
GET
List users

Front Integration

Front Integration
GET
Get settings
PATCH
Update settings
GET
List teammates
GET
List inboxes
GET
List signatures

Infobip Integration

Infobip Integration
GET
Get settings
PATCH
Update settings
GET
List agents
GET
List queues

Twilio Flex Integration

Twilio Flex Integration
GET
Get settings
PATCH
Update settings
GET
List task attributes

Freshdesk Integration

Freshdesk Integration
GET
Get settings
PATCH
Update settings
GET
List groups
GET
List agents

Freshchat Integration

Freshchat Integration
GET
Get settings
PATCH
Update settings
GET
List groups

Gorgias Integration

Gorgias Integration
GET
Get settings
PATCH
Update settings

Intercom Integration

Intercom Integration
GET
Get settings
PATCH
Update settings
GET
List admins
GET
List teams

Webhooks

Event Types

Zendesk Integration

Get settings

Read the Zendesk ticket creation, assignment, handoff, internal-note, and recipient settings.

Was this page helpful?

Zendesk Integration

Update settings

Powered byThis documentation is built and hosted on Mintlify, a developer documentation platform