Skip to main content

Outbox AI home page

Support
Dashboard
Dashboard

Documentation
Discord Community
SKOOL Course
Affiliate (20%)

API Documentation

Introduction

Analytics

GET
Get Analytics
GET
Get Analytics Pie

Agent Endpoints

GET
List Agents
GET
Get Agent
POST
Create Agent
PATCH
Update Agent
POST
Duplicate Agent
DEL
Delete Agent
POST
Adjust Agent Prompt
GET
List Agent Prompt History
GET
Get Agent Prompt History Entry
POST
Revert Agent Prompt
POST
Upload Agent Background Sound

Chat & Call Endpoints

POST
Send Chat Message
POST
Initiate Phone Call
POST
Start Web Call

Call Queue

GET
List Call Queue
POST
Bulk Update Call Queue
POST
Import Call Queue

Agent Files

GET
Get File Content
POST
Upload File
PATCH
Update File Content
DEL
Delete File
POST
Scan Agent File

Agent Integrations

POST
Create/Update Platform Integration
PATCH
Update Integration
DEL
Delete Integration

Agent Tools

GET
List Agent Tools
POST
Create/Update Tool
DEL
Delete Tool
POST
Run Agent Tool
GET
List Agent MCP Tools

Module Instance Endpoints

GET
List Module Instances
GET
Get Module Instance
POST
Create Module Instance
PATCH
Update Module Instance
POST
Duplicate Module Instance
DEL
Delete Module Instance

Module Configuration

GET
Get Instance Configurations
PATCH
Update Instance Configuration

Module Scheduling

GET
Get Instance Schedule
POST
Create/Update Schedule
DEL
Delete Schedule

Contact Endpoints

GET
List Contacts
GET
Get Contact
POST
Create Contact
PATCH
Update Contact
DEL
Delete Contact
GET
Download Contacts
POST
Import Contacts

Conversation Endpoints

GET
List Conversations
GET
Get Conversation

Send Messages

POST
Send SMS
POST
Send Email
POST
Send Bulk SMS
POST
Send Bulk Email
POST
Send Facebook Message
POST
Send Instagram Message

Email Campaigns

GET
List Email Campaigns
GET
Get Email Campaign
POST
Create Email Campaign
PATCH
Update Email Campaign
DEL
Delete Email Campaign
POST
Launch Email Campaign
POST
Bulk Add Contacts to Campaign
GET
List Campaign Steps
POST
Create Campaign Step
PATCH
Update Campaign Step
DEL
Delete Campaign Step
GET
List Campaign Senders
POST
Add Campaign Sender
DEL
Remove Campaign Sender
GET
List Campaign Enrollments
GET
Get Campaign Enrollment
GET
Get Enrollment Activity
GET
List Email Message Logs
GET
List Campaign Message Logs
GET
List Email Suppressions
POST
Add Email Suppression
GET
Get Email Reply Preview

Email Providers, Domains & Senders

GET
List Email Providers
POST
Connect Email Provider
DEL
Disconnect Email Provider
GET
List Email Domains
POST
Add Email Domain
DEL
Delete Email Domain
POST
Verify Email Domain
GET
Get Email Domain Verification Status
GET
List Email Senders
POST
Create Email Sender
PATCH
Update Email Sender
DEL
Delete Email Sender
POST
Verify Email Sender
GET
Get Email Sender Verification Status

CRM Opportunities

GET
List Pipelines
GET
Get Pipeline
POST
Create Pipeline
PATCH
Update Pipeline
DEL
Delete Pipeline
GET
List Pipeline Stages
POST
Create Pipeline Stage
PATCH
Update Pipeline Stage
DEL
Delete Pipeline Stage
GET
List Opportunities
GET
Get Opportunity
POST
Create Opportunity
PATCH
Update Opportunity
DEL
Delete Opportunity

Workflows

GET
List Workflows
GET
Get Workflow
POST
Create Workflow
PATCH
Update Workflow
DEL
Delete Workflow
POST
Duplicate Workflow
GET
List Workflow Folders
POST
Create Workflow Folder
PATCH
Update Workflow Folder
DEL
Delete Workflow Folder
GET
List Workflow Executions
GET
List All Workflow Executions
GET
List All Execution Logs
GET
List Workflow Enrollments
POST
Add Workflow Enrollments
POST
Remove Workflow Enrollments
GET
Get Workflow Enrollment
GET
List All Enrollment History
GET
List Enrollment Execution Logs
GET
List Contacts Waiting on Action
POST
Advance Contacts on Action
POST
Remove Contacts from Action
GET
Get Inbound Webhook URL
GET
Get Inbound Webhook Reference Payloads

Application Integrations

GET
List Applications
GET
Get Application
GET
List Application Integrations
POST
Create Application Integration
GET
Get Application Integration
GET
Get Integration Status
POST
Reconnect Integration
POST
Create Integration Temporary Token

MCP Endpoints

GET
List MCP Integrations
GET
List MCP Toolkit Tools
GET
List Agent MCP Integrations
POST
Create Agent MCP Server
PATCH
Update Agent MCP Server
POST
Create Agent MCP GHL Server

Call Logs

GET
List Call Logs
GET
Download Call Logs
GET
Bulk Download Call Logs

Chat Logs

GET
List Chat Logs
GET
Download Chat Logs
GET
Bulk Download Chat Logs

Transcripts

GET
List Transcripts
GET
List Transcripts by Agent
GET
Get Transcript
GET
Download Transcript
POST
Switch Transcript Speaker
GET
Get Transcript Tool Call
DEL
Delete Transcript

Company Settings

GET
Get Account Settings
GET
Get Company Settings
PATCH
Update Company Settings
DEL
Delete Company
POST
Transfer Company
POST
Duplicate Company
GET
Get Company Billing
GET
Get Company Integrations
GET
Manage Custom Fields
GET
Manage Custom Values
GET
List Company Email Senders

Company Staff Management

POST
Invite Staff Member
DEL
Cancel Invitation
PATCH
Update Staff Member
DEL
Remove Staff Member

Company Phone Numbers

GET
List Phone Numbers
POST
Add/Update Phone Number
PATCH
Assign Agent to Phone Number

Agency Settings

GET
Get Agency Settings
PATCH
Update Agency Settings

Agency Companies

GET
List Agency Companies
GET
Get Agency Company Details
POST
Create Agency Company
PATCH
Update Agency Company
DEL
Delete Agency Company

Agency Phone Numbers

GET
List Agency Phone Numbers
POST
Add/Update Agency Phone Number
PATCH
Assign Company to Agency Phone Number
DEL
Delete Agency Phone Number

CRM Opportunities

Get Opportunity

List Opportunities Create Opportunity

⌘I

x linkedin facebook instagram

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

Assistant

Responses are generated using AI and may contain mistakes.