API Documentation
Analytics
Agent Endpoints
Chat & Call Endpoints
Transcripts
Agent Integrations
Agent Tools
Tool Instance Endpoints
Tool Configuration
Contact Endpoints
Conversation Endpoints
Send Messages
Workflows
- GETList Workflows
- GETGet Workflow
- POSTCreate Workflow
- PATCHUpdate Workflow
- DELDelete Workflow
- POSTDuplicate Workflow
- GETList Workflow Folders
- POSTCreate Workflow Folder
- PATCHUpdate Workflow Folder
- DELDelete Workflow Folder
- GETList Workflow Executions
- GETList All Workflow Executions
- GETList All Execution Logs
- GETList Workflow Enrollments
- POSTAdd Workflow Enrollments
- POSTRemove Workflow Enrollments
- DELRemove Workflow Enrollment
- GETList All Enrollment History
- GETList Enrollment Execution Logs
- GETList Contacts Waiting on Action
- POSTAdvance Contacts on Action
- POSTRemove Contacts from Action
CRM Opportunities
Company Settings
Company Staff Management
Company Phone Numbers
Agency Settings
Agency Companies
Agency Phone Numbers
Email Campaigns
- GETList Email Campaigns
- GETGet Email Campaign
- POSTCreate Email Campaign
- PATCHUpdate Email Campaign
- DELDelete Email Campaign
- POSTLaunch Email Campaign
- POSTBulk Add Contacts to Campaign
- GETList Campaign Steps
- POSTCreate Campaign Step
- PATCHUpdate Campaign Step
- DELDelete Campaign Step
- GETList Campaign Senders
- POSTAdd Campaign Sender
- DELRemove Campaign Sender
- GETList Campaign Enrollments
- DELRemove Campaign Enrollment
- GETGet Enrollment Activity
- GETList Email Message Logs
- GETList Campaign Message Logs
Email Providers, Domains & Senders
- GETList Email Providers
- POSTConnect Email Provider
- DELDisconnect Email Provider
- GETList Email Domains
- POSTAdd Email Domain
- DELDelete Email Domain
- POSTVerify Email Domain
- GETGet Email Domain Verification Status
- GETList Email Senders
- POSTCreate Email Sender
- PATCHUpdate Email Sender
- DELDelete Email Sender
- POSTVerify Email Sender
- GETGet Email Sender Verification Status
Update Module Instance
curl --request PATCH \
--url https://api.getoutbox.ai/module/instance/{instance_id} \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"instance_name": "<string>"
}
'Tool Instance Endpoints
Update Module Instance
Update a module instance’s name
PATCH
/
module
/
instance
/
{instance_id}
Update Module Instance
curl --request PATCH \
--url https://api.getoutbox.ai/module/instance/{instance_id} \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"instance_name": "<string>"
}
'Documentation Index
Fetch the complete documentation index at: https://docs.getoutbox.ai/llms.txt
Use this file to discover all available pages before exploring further.
⌘I
Assistant
Responses are generated using AI and may contain mistakes.