For AI agents: the docs index is at https://docs.talkdesk.com/llms.txt. Append .md to any documentation page URL to get its markdown version.
Jump to Content
Guides
API Endpoints
Knowledge Base
Support
Talkdesk Website
Marketplace
Discussions
API Change Log
OpenAPI Specification Download
Home
Guides
API Endpoints
API Change Log
OpenAPI Specification Download
Guides
API Endpoints
Knowledge Base
Support
Talkdesk Website
Marketplace
Discussions
API Change Log
OpenAPI Specification Download
Log In
Home
API Endpoints
Log In
Home
API Endpoints
OpenAPI Specification Download
My Requests
Getting Started
API Endpoints
Public API
Accounts API
Get account details
get
Digital Connect API
Create digital-connect conversation
post
Create digital-connect conversation
post
delete digital-connect conversation
del
Financial Services Experience Cloud for Banking
Update Talkdesk contact found by phone number or contact id with the Fsi member information.
post
FSI Integrations API
Returns contact accounts list
get
Return Payoff Calculation
post
Returns one or more contacts matching the given criteria.
get
Return contact information
get
Returns card information
get
Deactivate a card and give it a new status
post
Inform when a card needs to be activate
post
Lock a card
post
Unlock a card
post
Returns contact cards list
get
Returns account upcoming payments
get
Transfers between accounts
post
Verify a destination account
post
Transfers between accounts
post
Transfers between accounts
post
Enable users to cancel various types of payments, including personal checks, before they are processed.
post
Create a new endpoint for Travel Notifications with the necessary parameters for the different banking connectors
post
Returns check status
post
request the issuance of a replacement card
post
Set up ACH transfers from their external bank accounts to their internal accounts or loans
post
Enable users to generate a temporary pin for unlocking account as first step.
post
Enable users to reset pin for unlocking account as second step.
post
The decryption based on AES algorithm
get
Send any type of other information back to core system
post
Used the card ID to query the daily limit of the card
get
Modify daily limit.
put
Returns account transactions
get
Fallback Experience
Get account information regarding continuity settings activation
get
Enables or disables fallback experience
put
Retrieves fallback experience settings.
get
Sets fallback experience configuration.
put
Proactive Outbound Client Custom Automations
Triggers attempt disposition event
post
Triggers schedule callback created event
post
Triggers callback disposition event
post
Prompts API
Create Prompt
post
List prompts (audio files) from Studio flows
get
Get a Prompt Detail by its ID
get
Delete a Prompt
del
Partially updates the prompt
patch
Update a Prompt
put
Generate Download Link
get
Get usage of a prompt
get
Request Link to Upload Audio File
post
Get prompts quota
get
Prompts Bulk Operation
post
Get the flow list by a prompt id
get
Webhook Trigger API
Create a Webhook Trigger
post
Delete a Webhook Trigger
del
Industries Settings
Create an interaction specific configuration which can be used for all the requests of the interaction ID.
put
Returns configurations for the provided service and roles.
get
Returns configurations for the provided service and roles.
get
Industries Contexts
Get context
get
Delete context
del
Add context value
post
Delete context value
del
Update context value
put
Retail Experience Cloud Bridge
Get Customer Details
get
Get Customer Orders
get
Get Customer Order
get
Update order attributes
patch
Get Order Items
get
Cancel Customer Order Items
put
Change Order Shipping Address
post
Cancel Customer Order
post
Get order cancellation preview
get
Get Customer Shipments
get
Schedule Customer Shipments
post
Get Most Recent Order
get
Get Shipment Available Slots
get
Sync cart items
put
Set cart delivery address
put
Select cart delivery option
put
Bind customer to cart
post
Get Customer Cart
get
Get order by cart ID
get
Get Orders
get
Get Products
get
Get Customer Technician Visit Slots
get
Schedule Customer Technician Visits
post
Get Customer Technician Visits
get
Get External Customers
get
Get Shopify Integration Credentials
get
Update Shopify Integration Credentials
put
Delete Shopify Integration Credentials
del
Get Available Return Reasons
get
Calculate Return Refund Amount
post
Cancel a Return
post
Create a New Return
post
Request a New Return (In-Band Error Response)
post
Get Suggested Refund
post
Create a Refund
post
Process return and create refund
post
Ingest recall contacts
post
Upload recall contacts as a CSV file
post
Create a suppression entry
post
List suppression entries
get
Revoke a suppression entry
del
Check cart activity validity
get
Search catalog
post
EXPRESS API
Get reseller contract info for an express account
get
Get contract actions
get
Create a contract action for express account
post
Instantiate a Trial
post
Valid if account exists
get
Industries External Entity Mapper
Create a map
post
Create a map
post
Search Talkdesk contact by phone
get
Search Talkdesk contact
post
Create a contact
post
Contact bind to an interaction
post
Sync a contact by integration and external ID
put
Feedback API
Collect feedback data
post
Locations Directory
Get the paginated list of locations
get
/locations-directory/locations
post
/locations-directory/locations
del
Get a location by id
get
Update a location by ID
put
Get location next week opening hours
get
Get the paginated list of services
get
/locations-directory/services
post
/locations-directory/services
del
Get the paginated list of services
get
Get the paginated list of services
get
Get a service by id
get
Update a service by ID
put
Get service next week opening hours
get
Get Google geo addresses
get
Get Google geocoding
get
Get the paginated list of service types
get
Search staffs by conditions
get
/locations-directory/staffs
post
/locations-directory/staffs
del
Get a staff by id
get
Update a staff by id
put
Get the paginated list of specialties
get
Apply a batch of LOCATION/SERVICE/STAFF/ARTICLE create, update, and delete operations
post
Get the paginated list of articles
get
Create an article
post
Get an article by id
get
Delete an article
del
Bulk upsert articles
post
Roll back a bulk-upsert run
post
List article types
get
Create an article type
post
Get an article type by id
get
Update an article type's ingestion routing config
patch
Delete an article type
del
Trigger an asynchronous article ingestion from an uploaded file
post
Get an article ingestion job
get
Get a presigned download URL for an ingestion job's source file
get
Add or update locations, services, or staff members from a CSV file
post
INDUSTRIES SCHEDULER API
Get teams associated to an account
get
Get availabilities by email
post
Get appointments associated to an account
get
Create and notify appointment via SMS
post
Update appointment by eventId
put
Delete appointment by eventId
post
industries-workflows
List workflow schedules
get
Create a workflow schedule
post
Pause or resume a schedule
patch
Delete a schedule
del
List workflows
get
Start a workflow
post
Get a workflow
get
Cancel or terminate a workflow
patch
Get workflow progress
get
Industries Messaging Service
Send Message
post
Send Email
post
Reporting Custom Fields API
Publish interaction custom fields
post
Queues API
List Queues
get
Assign users to queues
post
Unassings users to queues
del
List Queue Users
get
Messages
SMS Message Delivery
post
Campaign Messages
Send Bulk Campaign Messages
post
Outbound Notifications API
Send outbound notification messages
post
Attributes API
Attributes List
get
Create a New Attribute
post
Attribute Details
get
Update an Attribute
put
Attribute Users List
get
Associate Users to an Attribute
post
Remove Association of Users to an Attribute
del
Attributes Categories List
get
Create a New Attribute Category
post
Delete an Attribute Category
del
Update an Attribute Category
patch
User Attributes List
get
Apps API
Get the list of apps
get
Submit app
post
Get information about an app
get
Partially updates the app info
patch
Get information about installation
get
Get installation enabled users
get
Set the state of the installation
post
Get installation subscription
get
Get the installation trial information
get
Rotates the installation's credentials
post
Acknowledge installation credentials
post
Authentication
Terminates all of the user's sessions
post
Events API
Get event validation public key
get
Callback API
Request a new direct callback
post
Recordings API
Get call recordings list
get
Delete a recording
del
Get recording details
get
Redirect to the recording file
get
Contacts API
Get contacts list
get
Get a contact by id
get
Delete a contact by id
del
Get a list of contact's integrations
get
GDPR contacts by dates, list of phones or emails, tags, or contact ids
post
Flows API
Execute published flow
post
Campaign Management API
Get Entry Details
get
Update a Single Entry
patch
Delete an Entry
del
List Entries
get
Create an Entry
post
Update Multiple Entries
patch
Bulk Delete Entries
del
Create a Do Not Call List
post
List Do Not Call Lists
get
Get Do Not Call List Details
get
Create or Duplicate Campaign
post
List Campaigns
get
Get Campaign Details
get
Delete Campaign
del
Update Campaign
patch
List Campaign Do Not Call Lists
get
Assign Do Not Call Lists
post
Dissociate Do Not Call Lists
del
List Campaign Record Lists
get
Assign Record Lists
post
Dissociate Record Lists
del
List Campaign Users
get
Assign Users to Campaign
post
Dissociate Users
del
List Campaign Numbers
get
Assign Numbers to Campaign
post
Dissociate Numbers
del
Search Entries
post
Record Lists API
List Record Lists
get
Create a Record List
post
Get Record List Details
get
Update Record List Status
patch
Get Record Details
get
Delete a Record
del
Update a Record
patch
Get a List of Records
get
Create a Record
post
Delete Records by Phone Number
del
List Record Timezones
get
Delete External Records
del
Create Multiple Records
post
Update Multiple Records
patch
Bulk Delete Records
del
Create Upload Request
post
Update Upload Request
patch
Identity API
Get activities
get
Get an email address validation
get
Get an email address validation stats
get
Get an IP address validation
get
Get a phone number validation data
get
Get a phone number validation data
get
Deletes the contact's enrollment information
del
Creates a new contact enrollment
put
Provides a contact's consent for voice biometrics authentication
get
Changes a contact's consent for voice biometrics authentication
put
Schedule Event Import API
Bulk import agent schedule events from CSV
post
Get schedule import status and error report URL
get
Scheduled Time Off API
A time off is deleted by an external service
del
A time off is updated by an external service
patch
A time off is created by an external service
post
Retrieve agent schedule as iCalendar
get
Live API
Subscribe to a New Stream
post
Get subscription
get
Connect to the subscription stream
get
Update query from subscription
put
List available queries
get
Explore API
Get report jobs by type
get
Creates a new report job
post
Get job report execution details
get
Cancel a report job
post
Get job report execution result
get
Delete a report
del
Guardian API
Get all session logs odata
get
Get all cases
get
Get all users
get
Get user by id.
get
Get user role changes
get
Get call quality metrics
get
Users API
Get list of users
get
Get user details
get
Set external_id of user from integration
post
Get user info (OpenID Connect)
get
Pause a recording given a contact
post
Start a recording given a contact
post
SCIM API
Get Users
get
Create User
post
Delete User
del
User Details
get
Update partial User's attributes
patch
Update User's attributes
put
Get Groups
get
Group Details
get
Get Service Provider Configurations
get
Get Service Provider's Resource Types
get
Get Service Provider's User Resource Type
get
Get Schemas
get
Get Schema by ID
get
Usage-Manager API
Get account wallet list
get
Get single account wallet
get
Get all bucket configurations of an account.
get
Case API
Creating a case
post
Deleting cases softly
del
Getting a list of cases
get
Getting case details
get
Updating a case
patch
Getting newest case details by contact
get
Deleting cases permanently
del
Update a case note
patch
Getting a list of case fields
get
Bulk Import API
Get list of imports
get
Create a new import
post
Get an import
get
Updates one import
patch
Get a CSV file containing errors
get
Get the outputs of an export
get
Omnichannel API
Start recording for ongoing interaction
post
Pause recording for ongoing interaction
post
WFM Request Management API
create or update the Time off balance.
put
A time off balance is deleted by an external service
del
Financial Services Experience Cloud for Insurance
Create and publish an event to the automated-notifications system.
post
Get accounts from a search criteria
get
Get account with account number
get
Get policies from an account holder
get
Get policy period from a policy
get
Search policies
get
Get policy metadata from a policy
get
Create a new claim through FNOL
post
Get billing by account holder member
get
Get billing details by account holder
get
Search claims related to account holders
get
Get claim by id
get
Update contact details for an account
patch
Send document delivery by SMS and email
post
Write contact event data back to the core system
post
Get claim by id
get
Search claims related to a policy
get
Search claims related to an account
get
Billing Insights API
Returns the collection of the accounts that are under the caller's organization.
get
Returns a collection of products.
get
Returns info on the account subscription.
get
Returns a collection of invoice lines for the given accounts.
get
Returns a collection of usage data aggregated by month.
get
Schedule Callbacks
List Scheduled Callbacks
get
Create a Callback
post
Cancel a Callback
del
Update a Callback
patch
Get Callback Details
get
HLS Providers
Get a patient's billing summary
get
Search a patient's coverage
get
Get a patient's coverage details
get
Schedule appointments
post
Get future appointments
get
Cancel appointments
del
Send HL7 Events.
post
Search provider availability slots for VA returning a ProviderAvailabilityVA object
get
Search provider availability slots returning a list of ProviderSlot objects. Deprecated, please use `/healthcare/available-provider-slots` instead.
get
Search provider availability slots returning a list of ProviderSlot objects.
get
Get the balance of a patient
get
Search suggest provider returning a list of Provider's names
get
Search by patients returning a PatientStudio object
get
Search patients returning brief information of the patient
get
Get the patient information of a patient.
get
Write to the HLS Providers Call Answered API
post
Update Talkdesk contact by phone number with the patient information for the given interaction id
post
Reset Talkdesk contact by phone number
post
Act (Pause or resume) call recording of specified EHR agent
post
Initiate call for authorized EHR agent
post
Outgoing SMS - EPIC
post
Agent status sync for Epic
post
Send inbasket message
post
Reset patient password
post
Get the jwks to be used within the header of the jwt epic oauth2 flow
get
Search by patients on VA returning a PatientStudio object
get
Get the prescriptions of a patient, adapted for the VA
get
Request a prescription refill, adapted for the VA
post
Cancel appointments on VA
del
Schedule appointments on VA
post
Search future appointments on VA returning a FutureAppointmentsVA object
get
Resets VA Arrays and returns patient studio information for specific interaction
get
Get encounters
get
Get the medication orders of a patient
get
Appointment Confirmation
post
Reschedule an appointment
post
Appointment Confirmation
post
Get service requests
get
Get the procedures of a patient, as public endpoint for VA usage
get
Diagnosis API, returns diagnosis results, whether to continue asking the next question, and the content of the question
post
Triage API, returns triage level
post
Store interaction-specific configuration overrides.
put
Create a case documents of a patient.
post
Get the outstanding orders of a patient.
get
Save intent of a patient.
post
Get Medication Statement.
get
Create Medication Statement.
post
Create medication order(request).
post
Verify patient data
post
Get the schedulable service requests of a patient
get
Get patient's last known location
get
Get the appointment practices of a patient
get
Get guarantor identifiers
get
Get guarantor billing summary
get
Reset guarantor password
post
Data Tables API
/data-tables
post
/data-tables/{data_table_id}
get
/data-tables/{data_table_id}/usages
get
/data-tables/{data_table_id}/rows
get
/data-tables/{data_table_id}/rows
post
/data-tables/{data_table_id}/rows
del
/data-tables/{data_table_id}/rows/{row_id}
put
/data-tables/{data_table_id}/rows/bulk
post
/data-tables/{data_table_id}/row-batches
post
/data-tables/{data_table_id}/metadata
patch
/data-tables/{data_table_id}/schema
patch
/data-tables/bulk
post
/data-tables/export/jobs
post
/data-tables/export/jobs
get
/data-tables/export/files/{job_id}
get
/data-tables/{data_table_id}/rows/import
post
/data-tables/import
post
External Credentials
List Public Certificates
get
Certificates Endpoint Options
optns
Automated Notifications
Get Account configuration
get
Delete Account configuration
del
Get Event Types
get
Create new event type
post
Get Event Type by id
get
Update an event type
put
Delete a event type
del
Create or update Rule
put
Get rule by id
get
Delete Rule by id
del
Get Events
get
Create Event
post
Get Event by id
get
Delete Event by id
del
Delete Events by external id
del
Get Topics
get
Create Topic
post
Get Topic by id
get
Delete Topic by id
del
Get Subscriptions
get
Upsert Subscription
put
Get a subscription by id
get
Check opt-in status with topic ids and channel.
post
Search Interactions
get
Automated Notifications Bridge for webhooks
post
Appointment scheduling service
Retrieve flat appointment scheduling
get
Search physicians based on the patient's past encounters
get
WFM
Upload Forecast Import from CSV file
post
Get Forecast Import Status
get
HLS Payers
Update contact
put
Find Member by id
get
Member lookup connections
get
Get a claim status by its id
get
Get a prior authorization status by its id
get
Provider lookup connections
get
Get claims
get
Get prior authorizations
get
HLS Sycurio Integration
HLS Providers Sycurio Integration
post
Dialer Integrations
Get the campaign record information
get
Authentication API
Authentication
Obtain a new access token
post
Obtain a new authorization code
get
Obtain a service token status
post
Obtains the public server JWK set
get
Powered by
