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

Contacts

Introduction to contacts
POST
Create
GET
List
PATCH
Update
DEL
Delete
POST
Authenticate contact

Companies

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

Sessions

Sessions
POST
Create
GET
Get
GET
List
POST
Filter
PATCH
Update
PUT
Set Custom Status
DEL
Clear Custom Status
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
GET
List transfer destinations
POST
Make outbound call

AI Email

POST
Email API
PUT
Put domains
GET
Get domains
PATCH
Patch domains verify
DEL
Delete domains

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
Export content
POST
Sync content

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
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

Secrets

Secrets
POST
Create
PUT
Upsert

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

Webhooks

Event Types

Update

Update. Use when maintaining group membership and scoping from an external directory.

Was this page helpful?

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