API documentation
Outbound Agents
Campaigns
- POSTCreate a new scheduled campaign
- GETGet my schedule campaigns
- GETGet scheduled campaign data
- PUTToggle campaign active status
- PUTToggle scheduled campaign active status
- PUTUpdate scheduled campaign
- DELDelete auto campaign
- DELDelete scheduled campaign
- POSTCreate a new standard campaign
- GETGet standard campaign data
- PUTToggle standard campaign active status
- DELDelete standard campaign
Standard Campaigns
Pathway
Twilio
- GETFetch user Twilio data
- POSTSearch available phone numbers
- POSTPurchase a phone number
- GETGet user phone numbers
- GETGet twilio data
- POSTStore new data
- POSTCheck phone numbers for spam
- DELDelete a phone number
- DELRelease a phone number
- POSTSend a message
- GETFetch event stream for a specific call
- GETFetch call recording data
- GETFetch call recording data
- GETGet A2P campaign registered numbers
- GETGet A2P campaign SIDs only
- GETGet phone numbers for a messaging service
- POSTAdd phone numbers to a messaging service
- DELRemove a phone number from a messaging service
- POSTSync A2P campaign numbers with local database
- GETGet A2P phone numbers from local database
- POSTSubmit customer profile information
- POSTSubmit SHAKEN/STIR registration
- POSTSubmit voice integrity registration
- POSTSubmit CNAME registration
- POSTSubmit A2P brand registration
- POSTSubmit A2P campaign registration
- GETGet all customer profiles
- GETGet all trust products (SHAKEN/STIR, Voice Integrity, CNAME)
- GETGet all A2P brand registrations
- GETGet all messaging services
- GETGet specific trust product by SID
- GETGet specific customer profile by SID
- GETGet detailed information for a specific call
- GETGet CNAME registrations
- GETGet Voice Integrity registrations
- GETGet SHAKEN/STIR registrations
- GETGet all end users
- GETGet specific end user by SID
- GETGet all policies
- GETGet specific policy by SID
- GETGet all supporting documents
- GETGet specific supporting document by SID
- GETGet all end user types
- GETGet specific end user type by SID
- GETGet all supporting document types
- GETGet specific supporting document type by SID
- POSTAssign phone number to trust profiles
- POSTAuto-assign phone number to trust profiles based on End User type
- GETGet approved trust products
- GETGet approved business profiles
- GETGet phone numbers associated with a specific messaging service by SID
Custom Dialing Pools
Knowledge Base
- POSTSave text knowledge to knowledge base
- POSTSave file to knowledge base
- POSTScrape websites and save to knowledge base
- POSTDiscover sitemap URLs from a website for web scraping
- POSTChat with knowledge base using conversational context
- GETGet paginated list of knowledge bases from cleartalk AI
- GETGet knowledge base by ID from cleartalk AI
- PUTUpdate knowledge base name and/or description
- DELDelete knowledge base by ID from cleartalk AI
Tools
Inbound Agents
- GETGet all inbound numbers for the authenticated user
- POSTUnassign an inbound agent
- POSTCreate a new inbound agent
- POSTCreate a new tool
- GETGet tool information
- PUTUpdate a tool
- DELDelete a tool
- GETGet system prompts
- POSTSubmit system prompts
- GETGet inbound agent details
- POSTUpdate an inbound agent
- DELDelete an inbound agent if it exists
ClearTalk
Profile
Zapier
Campaigns - Texting
- POSTCreate a new auto campaign
- PUTUpdate Texting auto campaign
- DELDelete auto campaign
- GETGet my texting auto campaign data
- GETGet texting auto campaign for editing
- GETGet texting auto campaign data by agents
- GETGet texting auto campaign agent by id
- PUTToggle texting auto campaign status
- POSTCreate a new standard texting campaign
- GETGet my standard texting campaigns
- GETGet standard texting campaign by ID
- PUTUpdate standard texting campaign
- DELDelete standard texting campaign
- PUTToggle standard texting campaign status
ClearTalk SMS
Callback
Contacts
- GETGet all contacts
- POSTCreate a new contact
- POSTCreate multiple contacts
- GETGet contact list data fields
- GETGet all unique tags
- GETGet all unique list names
- GETGet all contacts with optional filters, pagination, and search
- GETGet a contact by ID
- DELDelete a contact
- PATCHUpdate a contact
- POSTInsert cal data
- POSTStore custom fields from GHL API
- POSTGet custom field names from contacts table schema
Web Agent
Agency
Chatbot
- POSTCreate a new chat session
- POSTSend a message in chat
- POSTSend a test payload to a webhook URL
- GETGet all chatbots for the current user
- POSTCreate a new chatbot
- GETGet chatbots history data with pagination and search
- GETGet a specific chatbot
- DELDelete a chatbot
- PATCHUpdate a chatbot
- GETGet chat history for a specific history record
Memory
- GETGet all memories for the authenticated user
- POSTCreate a new memory
- GETGet memory details by ID
- DELDelete memory permanently from cleartalk and local database
- PATCHUpdate memory name
- POSTGet detailed memory information for a specific user/phone number
- POSTSearch call history and data for a specific user/phone number within a memory
- POSTAdd a new user/phone number to an existing memory
- POSTUpdate the metadata and summary information for a specific user within a memory
- POSTRemove a specific user/phone number and all their associated data from a memory
- POSTAdd an existing call to a memory
- POSTRemove a specific call from a memory
- GETGet local memory users for a specific memory
- GETGet local memory calls for a specific memory
- POSTEnable memory for inbound phone number
SIP Trunking
- POSTAttach SIP Endpoint
- POSTCreate new SIP integration
- POSTDetach a SIP Number
- PATCHUpdate SIP integration configuration
- GETList User SIP Configurations
- DELDelete SIP Configuration
- POSTverify SIP Endpoint
- GETGet Available SIP Regions
- GETGet SIP Configuration for a Number
- POSTDetach SIP Configuration from a Number
Update a contact
Copy
curl --request PATCH \
--url https://api.cleartalk.ai/contacts/{id} \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"listName": "<string>",
"tag": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"email": "<string>",
"phone": "<string>",
"dateOfBirth": "<string>",
"contactSource": "<string>",
"clearTalkNotes": "<string>",
"customField": {}
}
'Copy
{
"id": 123,
"userId": 123,
"listName": "<string>",
"tag": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"email": "<string>",
"phone": "<string>",
"dateOfBirth": "<string>",
"contactSource": "<string>",
"clearTalkNotes": "<string>",
"customField": {},
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}Contacts
Update a contact
PATCH
/
contacts
/
{id}
Update a contact
Copy
curl --request PATCH \
--url https://api.cleartalk.ai/contacts/{id} \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"listName": "<string>",
"tag": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"email": "<string>",
"phone": "<string>",
"dateOfBirth": "<string>",
"contactSource": "<string>",
"clearTalkNotes": "<string>",
"customField": {}
}
'Copy
{
"id": 123,
"userId": 123,
"listName": "<string>",
"tag": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"email": "<string>",
"phone": "<string>",
"dateOfBirth": "<string>",
"contactSource": "<string>",
"clearTalkNotes": "<string>",
"customField": {},
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}Authorizations
API Key for authentication
Path Parameters
Body
application/json
List name for the contact
Tag for the contact
First name of the contact
Last name of the contact
Email of the contact
Phone number of the contact
Date of birth of the contact
Source of the contact
Notes for the contact
Custom fields for the contact
Response
200 - application/json
Contact updated successfully
Contact ID
User ID
List name for the contact
Tag for the contact
First name of the contact
Last name of the contact
Email of the contact
Phone number of the contact
Date of birth of the contact
Source of the contact
Notes for the contact
Custom fields for the contact
Creation date
Last update date
⌘I