Jump to Content
Guides
API Endpoints
Knowledge Base
Support
Talkdesk Website
Marketplace
Discussions
Developers Blog
Home
Guides
API Endpoints
Developers Blog
Guides
API Endpoints
Knowledge Base
Support
Talkdesk Website
Marketplace
Discussions
Developers Blog
Log In
API Endpoints
Log In
API Endpoints
My Requests
All
Pages
Start typing to search…
JUMP TO
Getting Started
API Endpoints
Authentication
Client Credentials - JWT
post
Client Credentials - Basic
post
Client Credentials - STS
post
Authorization Code - JWT
post
Authorization Code
get
Authorization Code - Basic
post
Refresh Token - JWT
post
Refresh Token - Basic
post
End User Session
post
Apps API
App Information
get
Installation Information
get
Users for an Installation
get
Installation State
post
Installation Subscription
get
Installation Channels
get
Installation Channels
post
Credentials Transition
post
Credentials Rotation
post
List of Apps
get
Installation Trial Information
get
Event from App ID
get
Events API
app.installed
app.updated
app.uninstalled
app.trial_started
app.trial_extended
app.trial_ended
user.logout
app.credentials_rotated
Callback API
New Direct Callback
post
Recordings API
List of Recordings for a Call
get
Recording Details
get
Redirect to the Recording File
get
Contacts API
Contacts List
get
Contact by ID
get
Contact Removal
del
Contact's Integrations
get
GDPR Contact
post
Ring Groups API
Get List of Ring Groups
get
Users Assigned to Ring Group
get
Flows API
Execute Publish Flow
post
Campaign Management API
List Do Not Call Lists
get
Create a Do Not Call List
post
Do Not Call List Details
get
Entry in the Do Not Call List
get
Create an Entry in the DNCL
post
Delete Entry
del
Update Multiple Entries
patch
Update a Single Entry
patch
Bulk Delete Entries
del
Filtered List of Entries
post
Create/Duplicate Campaign
post
Campaigns List
get
Campaign Details
get
Delete Campaign
del
Patch Campaign
patch
Get a DNCL
get
Associate a DNCL
post
Dissociate a DNCL
del
Get Record Lists
get
Associate Record Lists
post
Dissociate Record Lists
del
Get Users
get
Associate Users
post
Dissociate Users
del
Get Numbers
get
Associate Numbers
post
Dissociate Numbers
del
Record Lists API
All Record Lists
get
Get a List of Records
get
Create a Record List
post
Record List Details
get
Create a Record
post
Delete a Record
del
Get a Record
get
Delete a Record
del
Create Multiple Records
post
Signed URL
post
Upload Request Object
patch
Update Record Lists
patch
Update a Record
patch
Update a List of Records
patch
Bulk Delete Records
del
Delete Records by Provider/ID
del
Identity API
Identity Insights API
Activities List
get
Phone Validation API
Phone Number Insights
get
Voice Biometrics Opt-Out API
New Contact Enrollment
put
Enrollment Info Removal
del
Voice Biometrics Opt-In API
Contact Consent Status
get
Set a Contact Consent Status
put
Digital Connect API
Start a Conversation
post
Send a Message
post
End a Conversation
del
Attributes API
Attributes List
get
New Attribute
post
Attributes Categories List
get
New Attribute Category
post
Update an Attribute Category
patch
Delete an Attribute Category
del
Attribute Details
get
Update an Attribute
put
Attribute Users List
get
Associate Users to an Attribute
post
Remove Users from Attribute
del
User Attributes List
get
Scheduled Time Off API
Create a Time Off
post
Update a Time Off
patch
Delete the Time Off
del
FSI Integrations API
Sync a Talkdesk Contact
post
Fetch Contacts
get
Fetch Contact
get
Fetch Accounts
get
Fetch Transactions
get
Fetch Payments
get
Fetch Cards
get
Fetch Card
get
Activate Card
post
Deactivate Card
post
Stop Payment
post
Search Check Status
post
Return Payoff Calculation
post
Create a Transfer (Internal)
post
Create a Transfer (External)
post
Create a Transfer (International)
post
Prompts API
Update a Prompt
put
Create a Prompt
post
Request Link to Upload Audio File
post
Delete a Prompt
del
Partially Update a Prompt
patch
List a Prompt
get
Get a Prompt Detail by its ID
get
Download Audio File
get
Get a Prompt Usage
get
Get Prompt Flows
get
Live API
List Available Queries
get
Subscribe to a New Stream
post
Get a Subscription
get
Update Subscription
put
Subscription Stream
get
Explore API
Check a Report Status
get
Download a Report
get
List all Reports of a Type
get
Delete a Report
del
Execute a Report
post
Reporting Custom Fields API
Interaction Custom Fields
post
Guardian API
Guardian Users API
List of Users
get
User by ID
get
User Role Changes
get
Guardian Sessions API
All Sessions Logs' Data
get
Guardian Cases API
All Cases
get
Guardian Call Quality API
Call's Quality
get
Users API
List of Users
get
User Details
get
User Info
get
SCIM API
Service Provider's Resource Types
get
User Resource Type
get
Service Provider Configurations
get
Users
get
Create User
post
User Details
get
Update User's Attributes
put
Update Partial User's Attributes
patch
Delete User
del
Accounts API
Account Details
get
Usage-Manager API
Account Wallet List
get
Single Account Wallet
get
Bucket Configurations
get
Case API
Create a New Case
post
Update a Case
patch
Get a List of Cases
get
Get Case Details
get
Get Case Details by Contact
get
Softly Delete Cases
del
Delete Cases Permanently
del
Get a List of Case Fields
get
Update a Case Note
patch
EXPRESS API
Create Contract Actions
post
Get Contract Actions
get
Get Reseller Contract Information
get
Instantiate a Trial
post
Webhook Trigger API
Create a Webhook Trigger
post
Delete a Webhook Trigger
del
Redirect a Talkdesk Trigger
post
Get Schema
get
Retail Experience Cloud - ERC Ecommerce Integrations
Integrations Customer by ID
get
Get the ERC e-commerce Cart provided by the Customer ID or Cart ID
get
Cancel items from the ERC e-commerce customer order with the provided customer and order ID.
put
Customer Orders Provided by the Customer ID
get
Customer Order Items for the Provided Customer ID and Order ID
get
Customer Order for the Provided Customer and Order ID
get
Change the Shipping Address
post
Most Recent Order for the Provided Customer ID
get
Cancel a Customer's Order
post
Orders Provided by the Account ID
get
Search the Products of the Store
get
Get the ERC e-commerce Shopify Integration credentials for the currently authenticated Talkdesk account
get
PUT ERC e-commerce Shopify Integration credentials for the currently authenticated Talkdesk account
put
Delete the ERC e-commerce Shopify Integration credentials configured for the currently authenticated Talkdesk account.
del
Bulk Import API
Get List of Imports
get
Create a New Import
post
Get an Import
get
Update an Import
patch
Get Errors from an Import
get
CFM API
Collect Feedback Data
post
Simulated Email API
Send a Simulated Email
post
Financial Services Experience Cloud for Insurance
Get Accounts
get
Get Accounts by Account Number
get
Get all Type List Names
get
Get the Type List Name of the Type List Name
get
Get Policy Details by Account Number
get
Get Policy Details by Policy Number
get
Create a Product Model Data
post
Create a New Quick Quote
post
Get Claims for an Account Number
get
Get Claims Details by Policy Numbers
get
Get Claim Detail for Claim Number
get
Creates a New Claim
post
Search Policies Based on Search Criteria
get
Get Policy Metadata Information
get
Get all Type List Names
get
Get Type List of Type List Name
get
Get Account Details
get
Get Billing Card Details
get
Get Policy Billing Side Panel Details
get
Get Account Invoices
get
Billing Insights API
Get Accounts
get
Get Products
get
Get Subscriptions
get
Get Invoices
get
Get Monthly Usage
get
INDUSTRIES SCHEDULER API
Get Teams
get
Get Appointment
get
Collecting User Availability
post
Create a Calendar Event
post
Omnichannel API
Bulk Deleting Interactions
del
WFM Request Management API
Importing Time-Off Balance
put
Deleting Time-Off Balance
del
Financial Services Experience Cloud for Banking
Get Member Data
get
Get Payment Data
get
Get Transaction Data
get
Get Cards/Card Details
get
Schedule Callbacks
Get a Callback Entry
get
Query Callback and Count Callback
get
Update a Callback
patch
Cancel a Callback
del
Powered by
