Talkdesk
API integration

list_all_talkdesk_users

List Talkdesk users. Returns: id, email, name, active, gender, extension, external_phone_number, created_at, _links. Max 200 per page.

get_single_talkdesk_user_by_id

Get details of a specific Talkdesk user by id. Returns: id, email, name, active, gender, extension, external_phone_number, created_at, _links. Required: id.

list_all_talkdesk_me

Get the authenticated Talkdesk user's info via the OpenID Connect user info endpoint. Returns: id, sub, name, email, _links. Takes no parameters.

list_all_talkdesk_accounts

Get details for the authenticated Talkdesk account. Returns: id, name, company_name, email, timezone, created_at, provisioned_at, _links.

get_single_talkdesk_contact_by_id

Get a single Talkdesk contact by id. Returns the contact object including id, name, company, phones, emails, and _links. Required: id.

delete_a_talkdesk_contact_by_id

Delete a Talkdesk contact by id. The contact is marked as deleted and can be restored; personal data is not permanently erased (use the GDPR endpoint for data erasure requests). Returns an empty 204 response on success. Required: id.

list_all_talkdesk_contacts

List Talkdesk contacts with optional filters by name, company, emails, phones, or integration. Returns: id, name, company, emails, phones, _links.

create_a_talkdesk_attribute

Create a new routing attribute in Talkdesk. Returns: id, name, active, category_id, category_name, proficiency, default_proficiency, users_count, flows_count, team_ids, _links, GA. Required: name, category_id, active, proficiency, default_proficiency.

get_single_talkdesk_attribute_by_id

Get the details of a Talkdesk routing attribute by id. Returns: id, name, active, category_id, category_name, proficiency, default_proficiency, users_count, flows_count, team_ids, _links, GA. Required: id.

list_all_talkdesk_attributes

List routing attributes in Talkdesk. Returns: id, name, active, category_id, category_name, proficiency, default_proficiency, users_count, flows_count, team_ids, _links, GA. Filterable by name, active status, categories, and proficiency.

update_a_talkdesk_attribute_by_id

Update an existing routing attribute in Talkdesk by id. Returns: id, name, active, category_id, category_name, proficiency, default_proficiency, users_count, flows_count, team_ids, _links, GA. Required: id.

talkdesk_attribute_users_bulk_delete

Remove the association between one or more users and a Talkdesk attribute by supplying a list of user IDs to disassociate. Returns an empty 204 response on success. Required: attribute_id.

create_a_talkdesk_attribute_user

Associate one or more users with a Talkdesk attribute, optionally setting a proficiency level for each user. Returns: attributes_users, GA. Required: attribute_id, attributes_users.

list_all_talkdesk_attribute_users

List all Talkdesk users assigned to a specific attribute. Returns: id, name, team, proficiency, _links. Required: attribute_id. Optionally filter by user name.

create_a_talkdesk_attributes_category

Create a new attribute category in Talkdesk. Returns the created category object including its id, name, and attribute_count. Required: name. Category names must be unique within the account.

delete_a_talkdesk_attributes_category_by_id

Delete an existing attribute category in Talkdesk by id. Returns an empty 204 response on success. Required: id. Note: deleting a category may affect attributes currently assigned to it.

list_all_talkdesk_attributes_categories

List all attribute categories in the Talkdesk account. Returns each category's id, name, and attribute_count. Results can optionally be sorted by name in ascending or descending order.

update_a_talkdesk_attributes_category_by_id

Update the name of an existing attribute category in Talkdesk. Returns the updated category including its id, name, and attribute_count. Required: id, name. Category names must be unique within the account.

create_a_talkdesk_app

Submit a new app to Talkdesk. Returns the id of the newly created app. Accepts app metadata including name, display_name, app_type, render, urls, scopes, emails, assets, capabilities, and subscription_types.

update_a_talkdesk_app_by_id

Partially update a Talkdesk app by id. Returns the updated app object including name, display_name, app_type, slug, render, sandbox, urls, emails, assets, scopes, scopes_reason, description, notes, listing_summary, version_number, and subscription_types. Required: id.

list_all_talkdesk_apps

List all apps registered in Talkdesk. Returns an array of app records; each record includes id, name, display_name, app_type, slug, render, description, listing_summary, emails, assets, urls, scopes, capabilities, and subscription_types.

get_single_talkdesk_apps_app_by_id

Get information about a specific Talkdesk app by id. Returns the app object including id, name, display_name, app_type, slug, description, render, scopes, emails, assets, urls, subscription_types, and capabilities. Required: id.

list_all_talkdesk_account_wallets

Get a single Talkdesk account wallet by name. Returns the wallet object including name, product_name, balance, account_id, created_at, and updated_at. Required: name.

talkdesk_account_wallets_fetch

List Talkdesk account wallets. Returns a paginated collection of wallet objects, each including name, product_name, balance, account_id, created_at, and updated_at. Supports filtering by wallet attributes (name, product_name) via a filter expression and sorting via order_by. Use expand=true to include credit commit entries.

get_single_talkdesk_app_installation_by_id

Get information about a specific Talkdesk app installation by id. Returns the installation object including id, app_id, account_id, scopes, auto_provision_filters, total_licenses, created_at, created_by, and embedded state details. Required: app_id, id.

get_single_talkdesk_installation_user_by_id

Get the users enabled for a specific Talkdesk app installation. Returns a list of user objects including id, name, email, active, extension, external_phone_number, and created_at. Required: id, app_id.

create_a_talkdesk_installation_channel

Activate channels for a Talkdesk app installation. Returns: total, page, per_page, _embedded, _links, EarlyAccess. Required: app_id, installation_id, id.

get_single_talkdesk_installation_channel_by_id

List channels provisioned for a Talkdesk app installation. Returns: total, page, per_page, _embedded, _links, EarlyAccess. Required: app_id, id.

get_single_talkdesk_installation_subscription_by_id

Get the current subscription for a Talkdesk app installation. Returns: type, license_type, name, price, description, listing_summary, min_licenses, max_licenses, created_by, id, total_licenses, _links, GA. Required: app_id, id.

get_single_talkdesk_installation_trial_by_id

Get the trial information for a specific Talkdesk app installation by id. Returns: state, started_at, expires_at, ended_at, ended_reason, subscription_name, _links, GA. Required: app_id, id.

talkdesk_installation_credentials_rotate

Rotate the credentials for a Talkdesk app installation. Triggers a credential rotation action for the specified app and installation. Returns an empty 201 response on success. Required: app_id, installation_id.

create_a_talkdesk_credential_state

Acknowledge installation credentials in Talkdesk by creating a transition to the 'acknowledged' state for a specific installation's credentials. Returns: state, _links. Required: app_id, installation_id, client_id, id.

create_a_talkdesk_attachments_2023_03

Create a new attachment in Talkdesk after uploading file content via an upload link. Returns the created attachment including id, name, state, size, type, metadata, and provider. The attachment name must be unique within the account; a 409 error is returned if a duplicate name is detected.

delete_a_talkdesk_attachments_2023_03_by_id

Permanently delete a specific Talkdesk attachment by id. This action is irreversible. Returns an empty 204 response on success. Required: id.

list_all_talkdesk_attachments_2023_03_s

List attachments for the current Talkdesk account with optional filters by name, types, metadata, or state. Returns: id, name, state, size, type, metadata, provider, _links.

get_single_talkdesk_attachments_2023_03_s_2023_03_by_id

Get a single Talkdesk digital attachment by id. Returns: id, name, state, size, type, metadata, provider, _links. Required: id.

get_single_talkdesk_2023_03_download_link_by_id

Get a temporary download link for a Talkdesk attachment by id. Returns: url, expire_time, EarlyAccess. Required: id. The generated link expires after 10 minutes.

create_a_talkdesk_2023_03_upload_link

Initiate an attachment upload in Talkdesk by generating a temporary upload link. Use this as the first step when adding a new attachment: call this endpoint, upload the file content to the returned URL, then call the Create Attachment endpoint to finalize. Returns: request_id, url. The upload link expires after a limited time window.

create_a_talkdesk_bulk_imports_user

Create a new bulk user import job in Talkdesk. Accepts a JSON body to enqueue an EXPORT_USERS import, with an optional export_criteria filter. Returns the enqueued import object including id, filename, status, type, total_records, created_at, and _links. Required: type.

talkdesk_bulk_imports_users_get_errors

Download a CSV file containing the error records from a bulk user import in Talkdesk. Returns a raw CSV file with an extra errors column appended to the original import columns. Required: import_id. Only available for imports with status COMPLETED_WITH_ERRORS or FAILED.

update_a_talkdesk_bulk_imports_user_by_id

Update a bulk user import job in Talkdesk. Currently supports cancellation by setting status to CANCELED. Returns the updated import object including id, filename, status, type, total_records, created_at, and _links. Required: id, status.

list_all_talkdesk_bulk_imports_users

List bulk user import jobs in Talkdesk. Returns a paginated array of import records, each including id, filename, status, type, total_records, created_at, updated_at, and _links. Supports filtering by status and sorting by created_at, filename, status, total_records, or updated_at.

get_single_talkdesk_bulk_imports_users_bulk_import_by_id

Get a single Talkdesk bulk user import job by id. Returns the import record including id, filename, status, total_records, completed_records, failed_records, type, created_by, created_at, updated_by, updated_at, canceled_by, and canceled_at. Required: id.

get_single_talkdesk_user_output_by_id

Get the output files of a completed bulk user import/export job in Talkdesk. Returns: outputs, GA. Required: import_id.

get_single_talkdesk_call_recording_by_id

Get the list of audio recordings for a specific Talkdesk call (screen recordings are not included). Returns recording objects with id, call_id, created_at, index, duration, type, agents (per-channel participant details), and _links (self and media URLs). Required: call_id.

create_a_talkdesk_calls_callback

Request a new direct callback in Talkdesk, routing the call to the specified Talkdesk phone number from the contact's phone number. Optionally supply contextual fields shown to the agent. Returns a 200 success response with no body on success.

create_a_talkdesk_oauth_token

Obtain a new OAuth access token from Talkdesk using the client credentials, authorization code, or refresh token grant flow. Returns: access_token, token_type, expires_in, scope, refresh_token, sid, id_token. Required: grant_type.

list_all_talkdesk_oauth_certs

List the public server JSON Web Key (JWK) set from Talkdesk's authentication API. Returns an array of JWK objects each including kty, kid, alg, use, x5c, and x5t, plus key-material fields specific to the key type: crv, x, y for EC keys or n, e for RSA keys.

list_all_talkdesk_2023_10_certs

Obtain the public server JSON Web Key (JWK) set from Talkdesk for verifying token signatures. Returns: keys. No required parameters.

list_all_talkdesk_oauth_authorizes

Obtain a new Talkdesk OAuth authorization code to initiate the authorization code flow. On success, issues a 302 redirect to the redirect_uri with code and state as query parameters. Required: client_id, redirect_uri, response_type.

list_all_talkdesk_account_bucket_configurations

Get all bucket configurations for a Talkdesk account. Returns a list of records, each including id, charge_number, plafond, plafond_multiplier, effective_start, effective_end, resource, unit_of_measure, properties, status, type, and created_at. Optionally filter by status (ACTIVE or ALL; defaults to ACTIVE).

create_a_talkdesk_oauth_introspect

Obtain the status of a Talkdesk service token by introspecting it. Returns: kid, sig, token_introspection. Required: token.

create_a_talkdesk_installation_state

Set the state of a Talkdesk app installation, approving or rejecting it. Returns: state, reason, updated_at, _links, GA. Required: app_id, installation_id, id.

list_all_talkdesk_agent_roles

List agent role changes for a specific agent in Talkdesk Guardian. Returns a paged list of role assignment records including id, role, assigned_at, and assigned_by. Required: agent_id, filter, id.

list_all_talkdesk_calls_call_qualities

List historical call quality metrics from Talkdesk Guardian. Returns: call_id, interaction_id, affected_call, jitter, mos, rtt, packets_loss_percentage, timestamp, user_id. Calls without metrics have jitter, mos, and rtt set to null. Supports OData-like filter and order_by parameters.

get_single_talkdesk_contact_custom_field_by_id

Get a list of custom fields stored on a Talkdesk contact. Returns: total, _embedded, count, _links, EarlyAccess. Required: contact_id. Only works for active contacts — deleted contacts return 404.

get_single_talkdesk_contact_integration_by_id

Get a list of external systems linked to a Talkdesk contact (e.g. Salesforce, Zendesk, Dynamics). Returns: _embedded, _links, GA. Only works for active contacts — deleted contacts return 404. Required: contact_id.

list_all_talkdesk_conversations_interactions

Query Talkdesk conversation interactions that started within a specified time range (max 7-day interval). Returns: id, customer_id, started_at, ended_at, direction, ring_groups, queues, messages, agents. Optionally narrow results with an OData filter and sort with order_by.

list_all_talkdesk_emailvalidation_stats

Get aggregated email validation statistics for a given email address in Talkdesk. Looks up how many times the address has been validated within the current account without calling the external provider — making it non-billable and safe to call frequently. Emails never previously validated return zero. Returns: email, number_validations_last_24h.…

get_single_talkdesk_events_signature_key_by_id

Get a Talkdesk event validation public key by id. Returns: public_key, key_id, created_at, expires_at. Required: id.

list_all_talkdesk_external_credentials_certs

List public JWK certificates from Talkdesk used for token verification. Returns one item per certificate including: kty (key type), use (intended use), kid (key identifier), alg (algorithm), n (RSA modulus), e (RSA exponent), and tag. Required: tag.

talkdesk_fallback_experience_settings_bulk_update

Set the Talkdesk fallback experience configuration, defining call forwarding rules and a downtime message to play during service disruptions. Returns: forward, message.

list_all_talkdesk_fallback_experience_settings

Retrieve the Talkdesk fallback experience settings, including call forwarding rules and the downtime message configuration played to inbound callers during service disruptions. Returns: forward, message.

talkdesk_fallback_experiences_bulk_update

Enable or disable the Talkdesk fallback experience for inbound calls. When enabled, new inbound calls are forwarded based on the fallback experience settings. Returns: enabled, type, required. Required: enabled.

list_all_talkdesk_fallback_experiences

Retrieve whether the Talkdesk fallback experience is currently enabled or disabled for inbound calls. Returns: enabled.

get_single_talkdesk_guardian_agent_by_id

Get a single Talkdesk Guardian agent by id. Returns the full agent record including id, name, email, role, status, presence, presence_type, risk, ring_groups, creation_time, and call_quality. Required: id.

list_all_talkdesk_guardian_agents

List all Talkdesk Guardian agents as a paged collection. Returns each agent's id, name, email, role, status, presence, presence_type, risk, ring_groups, creation_time, and call_quality. Required: filter. Supports comparison and logical operators (eq, ne, gt, ge, lt, le, contains, and, or). Optionally sort using order_by.

list_all_talkdesk_guardian_cases

List Talkdesk Guardian anomaly cases. Returns a paginated collection of detected anomaly records including id, event_id, user_id, ingest_timestamp, hits, hits_number, baseline, case, specification, user_prob, user_conf, and 5 more fields. Supports filter expressions and order_by sorting. Defaults to ordering by ingest_timestamp descending.

get_single_talkdesk_guardian_user_by_id

Get a single Talkdesk Guardian agent by id. Returns: _links, creation_time, email, id, name, presence, presence_type, ring_groups, risk, role, status, call_quality, GA. Required: id.

list_all_talkdesk_guardian_users

List all Talkdesk Guardian agents with filtering and sorting support. Returns a paged list of agents, each including id, name, email, role, status, presence, presence_type, risk, ring_groups, creation_time, and call_quality. Required: filter.

list_all_talkdesk_identity_activities

List the paginated history of contact voice authentication activities for the Talkdesk account. Returns each activity record including id, contact_id, timestamp, voice_operation, voice_result, phone_status, voice_risk_score, and overall_risk_score, plus detailed phone, email, and IP risk/validation fields. Max 250 items per page.

list_all_talkdesk_identity_emailvalidations

Get reputation and risk validation for an email address in Talkdesk Identity. Returns: id, status, valid, fraud_score, disposable, deliverability, catch_all, leaked, suspect, spam_trap_score, domain_trust, sanitized_email, first_seen, domain_age, and 17 more. Required: email. Each validation is billable for accounts with an active Identity license.

list_all_talkdesk_identity_ipvalidations

Get reputation and risk information for an IP address in Talkdesk Identity. Returns the full IP validation record including id, status, fraud_score, geolocation fields (country_code, region, city, latitude, longitude), network fields (isp, and 8 more fields. Required: ip. Each validation is billable for accounts with an active Identity license.

list_all_talkdesk_identity_phonevalidations

Get reputation and quality validation data for a phone number in Talkdesk Identity. Returns the full validation object including id, status, valid, fraud_score, carrier, country, line_type, voip, risky, recent_abuse, do_not_call, related risk signals. Required: phone_number. Each validation is billable for accounts with an active Identity license.

list_all_talkdesk_ipvalidation_stats

Get aggregated validation statistics for a given IP address in Talkdesk. Returns ip and number_validations_last24h (the count of validations in the last 24 hours; zero for IPs never validated). The lookup is local to the account and does not call the external provider, so it is non-billable and safe to call frequently. Required: ip.

list_all_talkdesk_logs_sessions

List Guardian session logs in Talkdesk. Returns: browser_full, country, ip_address, latitude, login_timestamp, logout_timestamp, longitude, os_full, id, sso, user_id, support_access. Required: filter.

list_all_talkdesk_phonevalidation_stats

Get aggregated validation statistics for a given phone number in Talkdesk. Returns the phone_number and number_validations_last_24h (count of validations performed within the current account in the last 24 hours). The lookup is local and not billable. Required: phone_number.

list_all_talkdesk_user_roles

List role changes for a Talkdesk user from the Guardian API. Returns a paged collection of role records including role, assigned_at, assigned_by, and id. Required: user_id, filter, id.

create_a_talkdesk_mcp

Send a JSON-RPC 2.0 request to the Talkdesk MCP Streamable HTTP server to perform a protocol handshake, list available API operation tools, or invoke a tool by operationId. Returns: jsonrpc, id, result, error. Required: jsonrpc, method.

talkdesk_do_not_call_list_entries_bulk_delete

Bulk delete multiple entries from a Talkdesk Do Not Call List in a single request. Returns: id, has_errors, total_errors, total_deleted, _links, _embedded. Required: do_not_call_list_id. The request body must contain between 1 and 200 entry ids.

talkdesk_do_not_call_list_entries_bulk_delete_version

Delete a specific entry from a Talkdesk Do Not Call List by entry id. Returns an empty 204 response on success. Required: do_not_call_list_id, id_entry.

talkdesk_do_not_call_list_entries_bulk_update

Update multiple entries in a Talkdesk Do Not Call List in a single request using JSON Patch-style operations. Returns: do_not_call_list_id, has_errors, total_errors, total_updated, _links, _embedded. Required: do_not_call_list_id.

create_a_talkdesk_do_not_call_list_entry

Create a new entry in a Talkdesk Do Not Call List by adding a phone number with an optional expiration date and reason. Returns: id, do_not_call_list_id, phone_number, reason, expiration_date, created_at, updated_at, _links, GA. Required: do_not_call_list_id, id, phone_number.

get_single_talkdesk_do_not_call_list_entry_by_id

Get details of a specific entry in a Talkdesk Do Not Call List by entry id. Returns: id, do_not_call_list_id, phone_number, reason, expiration_date, created_at, updated_at, _links, GA. Required: id, id_entry.

list_all_talkdesk_do_not_call_list_entries

List entries from a Talkdesk Do Not Call List. Returns: id, do_not_call_list_id, phone_number, reason, expiration_date, created_at, updated_at, _links. Required: do_not_call_list_id. Optionally filter by phone_number or sort via order_by.

update_a_talkdesk_do_not_call_list_entry_by_id

Update a specific entry in a Talkdesk Do Not Call List using JSON Patch operations (e.g., replace expiration_date). Returns the updated entry including id, phone_number, reason, expiration_date, created_at, and updated_at. Required: id, id_entry.

list_all_talkdesk_data_search_datasets

List the historical reporting datasets available to the current Talkdesk user for use in reporting queries. Returns: id, dataset, label, description. Results are scoped to what the user can access in Explore; an empty list means the user has no reporting access.

get_single_talkdesk_dataset_detail_by_id

Get the queryable shape of a specific Talkdesk dataset, including its available fields, field types, filter/sort capabilities, synonyms, and the constraints the dataset always enforces. Returns: id, dataset, description, always_filter, fields, EarlyAccess. Required: dataset.

create_a_talkdesk_dataset_query

Run a structured query on a Talkdesk reporting dataset and return matching rows. Returns: dataset, fields, applied_filters, rows, row_count, truncated, warnings. Required: dataset, fields. Max 1000 rows returned; always include a short date filter to avoid timeouts.

create_a_talkdesk_record_list

Create a new Talkdesk record list for outbound campaigns and receive a signed S3 URL to upload the associated CSV file. Returns: id, name, unique_identifier_type, status, signed_url, _links, GA. Required: name.

update_a_talkdesk_record_list_by_id

Update the status of a Talkdesk record list by id using a JSON Patch operation to trigger CSV file validation and processing. Returns: id, name, unique_identifier_type, created_at, records_count, account_id, status, _links, GA. Required: id, op, path, value.

list_all_talkdesk_record_lists

List Talkdesk record lists for the account with optional filtering by name, status, team, or campaign. Returns per record: id, name, status, unique_identifier_type, created_at, updated_at, records_count, account_id, teams, and campaign_page.

get_single_talkdesk_record_lists_record_list_by_id

Get the full configuration and metadata of a specific Talkdesk record list by id. Returns: id, name, unique_identifier_type, created_at, updated_at, status, records_count, teams, campaign_page, _links. Required: id. Pass fields=TEAMS to include the teams sub-entity in the response.

talkdesk_flows_platform_flows_trigger

Trigger a Talkdesk automation flow on-demand by its flow ID. Optionally pass input variables as key-value pairs in the request body. Returns: execution_id, workflow_execution_id. Required: flow_id. The flow must be enabled — triggering a disabled flow returns a 409 Conflict error.

talkdesk_product_flows_trigger

Trigger a Talkdesk automation flow on-demand by its flow ID, scoped to a given product. Returns: execution_id, workflow_execution_id. Required: product_id, flow_id. The flow must be enabled; triggering a disabled flow returns a 409 Conflict error.

create_a_talkdesk_internal_contacts_gdpr

Submit a GDPR deletion request in Talkdesk for contacts matched by phones, emails, ids, tags, or creation date range. Returns an empty 204 response on success.

create_a_talkdesk_oauth_end_user_session

Terminate all active and inactive sessions for a specified Talkdesk user. Returns an empty 204 response on success. Required: user_id.

create_a_talkdesk_interaction_announcement

Play an announcement in a Talkdesk interaction by supplying an MP3 file URL (e.g. a beep to notify that the call is being recorded). Returns an empty 200 response on success. Required: interaction_id, mp3_file_url.

talkdesk_interactions_pause_recording

Pause recording for an ongoing Talkdesk interaction where an agent is in conversation with a contact. Returns an empty 204 response on success. Required: interaction_id.

talkdesk_interactions_start_recording

Start recording for an ongoing Talkdesk interaction where an agent is in conversation with a contact. Returns an empty 204 response on success. Required: interaction_id.

create_a_talkdesk_message

Send an outbound SMS message to a contact phone number using a Talkdesk phone number. The request is processed asynchronously and accepted with a 202 response. Returns: talkdesk_phone_number, contact_phone_number, body, id, _links, GA. Required: body. Phone numbers must be in E.164 format.

get_single_talkdesk_number_by_id

Get details for a single Talkdesk phone number by id. Returns: id, phone_number, friendly_name, dedicated_line, sip, capabilities, _links, vcid, EarlyAccess. Required: id. Deprecated — use the Phone Details API instead.

list_all_talkdesk_numbers

List phone numbers belonging to the Talkdesk account. Returns per number: id, phone_number, friendly_name, dedicated_line, sip, and capabilities. Optionally filter by sip or phone_number. Deprecated — use the Phone Details API instead. Required: page, per_page.

create_a_talkdesk_do_not_call_list

Create a new Do Not Call List in Talkdesk and receive a signed URL for uploading the corresponding CSV file of phone numbers. Returns: id, name, status, signed_url, _links, GA. Required: name.

list_all_talkdesk_do_not_call_lists

List Do Not Call Lists in Talkdesk with optional filtering by name, status, team, and campaign. Returns items each containing id, name, status, entries_count, created_at, updated_at, account_id, teams, and campaign_page.

get_single_talkdesk_do_not_call_lists_do_not_call_list_by_id

Get a single do-not-call list by id in Talkdesk. Returns the full list object including id, name, account_id, created_at, updated_at, entries_count, status, associated teams, and campaign_page. Required: id.

delete_a_talkdesk_interaction_recording_by_id

Permanently delete a specific recording from a Talkdesk interaction. The deletion is processed asynchronously — the request is accepted immediately and the file is removed in the background. Returns an empty 204 response on success. Required: id, interaction_id, recording_id.

list_all_talkdesk_interactions_consents

List interaction recording consent records from the Talkdesk recordings-storage service. Returns consent record objects including id and attributes; the exact attribute-level fields are not enumerated in the available source—consult the upstream Talkdesk API documentation for the full response shape.

get_single_talkdesk_media_by_id

Get the HAL media link for a Talkdesk recording by id. Returns a _links object containing self.href (URL to this recording media resource) and file.href (signed URL to download or stream the recording file). Screen recordings are not included. Required: id.

talkdesk_record_list_external_records_bulk_delete

Delete records from a Talkdesk record list by external provider reference and external ID. Returns an empty 204 response on success. Required: record_list_id, external_provider, external_id.

talkdesk_record_list_records_bulk_delete

Delete all records from a Talkdesk record list that match a given phone number. Returns an empty 204 response on success. Required: record_list_id, phone_number.

talkdesk_record_list_records_bulk_delete_version

Delete a single record from a Talkdesk record list by its record id. Returns an empty 204 response on success. Required: record_list_id, id_record.

talkdesk_record_list_records_bulk_update

Update records in bulk in a Talkdesk record list. Returns an empty 204 response on success. Required: record_list_id.

create_a_talkdesk_record_list_record

Create a new record in a Talkdesk record list. Returns the created record including id, record_list_id, phone_numbers, first_name, last_name, timezone, priority, extra_data, external_provider, external_id, sync_external_id, created_at, and updated_at. Required: record_list_id, id, phone_number, phone_numbers, first_name, last_name.

get_single_talkdesk_record_list_record_by_id

List records in a Talkdesk record list with optional filtering and sorting. Returns: id, record_list_id, phone_number, phone_numbers, first_name, last_name, timezone, priority, extra_data, external_provider, external_id, external_url, sync_external_id, created_at, updated_at, _links, GA. Required: id.

list_all_talkdesk_record_list_records

Get details of a specific record within a Talkdesk record list. Returns: id, record_list_id, phone_number, phone_numbers, first_name, last_name, timezone, priority, extra_data, external_provider, external_id, external_url, sync_external_id, created_at, updated_at, _links. Required: record_list_id, id_record.

update_a_talkdesk_record_list_record_by_id

Update a specific record within a Talkdesk record list using JSON Patch operations. Supports replace and add operations on fields such as priority, phone_numbers, first_name, last_name, timezone, and extra_data. Returns the updated record including id, record_list_id, phone_numbers, first_name, last_name, and 4 more fields. Required: id, id_record.

talkdesk_record_list_upload_requests_bulk_update

Update a Talkdesk record list upload request's status to trigger file validation and record processing. Call this after uploading a CSV file to the signed URL obtained from the create method. Returns: id, record_list_id, status, _links. Required: record_list_id, id_upload_request, op, path.

create_a_talkdesk_record_list_upload_request

Create a signed S3 URL to upload a CSV file into an existing Talkdesk record list. Returns: id, record_list_id, signed_url, status, _links, GA. Required: record_list_id, id, csv_metadata.

talkdesk_records_bulks_bulk_delete

Bulk delete up to 200 records from a Talkdesk record list in a single request. Records can be identified by id, phone_number, or external_provider + external_id (mutually exclusive per call). Returns: record_list_id, has_errors, total_errors, total_deleted, _links, _embedded. Required: record_list_id.

talkdesk_records_bulks_bulk_update

Update multiple records in a Talkdesk record list in a single request using JSON Patch operations (application/json-patch+json). Each operation specifies an op ('replace' or 'add'), a path targeting a record, and a value with the fields to modify. Returns: record_list_id, has_errors, total_errors, and 5 more. Required: record_list_id.

create_a_talkdesk_records_bulk

Create multiple contact records in a Talkdesk record list in a single bulk insert request. Returns: record_list_id, has_errors, total_errors, total_created, _links, _embedded, GA. Required: record_list_id, records.

get_single_talkdesk_records_timezone_by_id

Get the paginated list of timezones present in a Talkdesk record list. Returns an array of timezone identifier strings (e.g., America/New_York) extracted from the record list. Required: id. Use the optional `search` parameter for fuzzy filtering by timezone name (supports `*` wildcard operator, min 3 chars).

get_single_talkdesk_recording_by_id

Get details for a single Talkdesk recording by id (screen recording is not included). Returns: recording, _links, GA. Required: id.

delete_a_talkdesk_report_file_by_id

Delete a Talkdesk report file by id. Required: type, id. Returns an empty 204 response on success.

get_single_talkdesk_report_file_by_id

Get the execution result of a Talkdesk report job by id. Returns a redirect (302) to the report file location along with total and type in the response body. Required: type, id.

create_a_talkdesk_report_job

Create a new Talkdesk report job for the specified report type. Returns: job, _links. Required: type.

delete_a_talkdesk_report_job_by_id

Delete a Talkdesk report job by id. Returns an empty 204 response on success. Required: type, id.

get_single_talkdesk_report_job_by_id

Get a single Talkdesk report job by id. Returns: job, _links, GA. Required: type, id.

list_all_talkdesk_report_jobs

List all Talkdesk report jobs for a given report type. Returns: id, name, status, timespan, _links, format. Required: type.

talkdesk_report_jobs_cancel

Cancel a Talkdesk report job that is still in created or processing status, immediately freeing the account's quota slot. Returns: job, _links, GA. Jobs in a terminal status cannot be canceled. Required: type, job_id, id.

get_single_talkdesk_report_jobs_datum_by_id

Get report job execution details for a single Talkdesk Explore API report job. Returns the job object including job (id, name, status, timezone, format, timespan) and _links. Required: id, type.

list_all_talkdesk_live_queries

List available live queries in Talkdesk. Returns each query's id, name, params (with optional defaults and limits), filters (with optional json_map and default values), and _links.

create_a_talkdesk_live_subscription

Subscribe to a new Talkdesk Live stream to receive real-time data via HTTP SSE notifications. Returns: id, _links, entries.

get_single_talkdesk_live_subscription_by_id

Get a Talkdesk Live subscription by id. Returns: id, _links, entries, GA. Required: id.

get_single_talkdesk_live_subscription_stream_by_id

Connect to a Talkdesk live subscription stream by id to receive server-sent events with live metric data. Returns a stream of events, each containing: event (event type), data (object with metadata and result). Required: id, subscription_id, token.

update_a_talkdesk_live_subscription_entry_by_id

Update a query entry within a Talkdesk live subscription. Returns the updated entry including id, query_id, filters, metadata, params, and _links to the related query, self, and subscription resources. Required: subscription_id, id.

create_a_talkdesk_flow_interaction

Start an interaction that executes the published version of a Talkdesk flow. Returns: interaction_id, flow_version_id, flow_execution_id. Required: flow_id.

create_a_talkdesk_scim_user

Create a new SCIM user in the authenticated Talkdesk account. Returns: schemas, id, active, externalId, meta, name, userName, urn:ietf:params:scim:schemas:extension:talkdesk:2.0:User, GA. Required: name, userName, active.

get_single_talkdesk_scim_user_by_id

Get details of a Talkdesk SCIM user by id. Returns: schemas, id, active, externalId, meta, name, userName, urn:ietf:params:scim:schemas:extension:talkdesk:2.0:User, GA. Required: id.

list_all_talkdesk_scim_users

List SCIM users in the authenticated Talkdesk account with optional filtering and sorting. Returns: schemas, id, active, externalId, meta, name, userName, valid. Supports filter, sortBy, and sortOrder query parameters.

update_a_talkdesk_scim_user_by_id

Replace all attributes of a Talkdesk SCIM user by id (full PUT replace). Returns: schemas, id, active, externalId, meta, name, userName, urn:ietf:params:scim:schemas:extension:talkdesk:2.0:User, GA. Required: id, name, userName, active.

delete_a_talkdesk_scim_user_by_id

Delete a Talkdesk SCIM user by id. Returns an empty 204 response on success. Required: id.

talkdesk_scim_users_partial_update

Update selected fields of a Talkdesk SCIM user using JSON PATCH operations (cannot change user ID). Returns the updated user object including id, userName, active, name, externalId, meta, and Talkdesk extension attributes (rolesString, teamsString). Required: user_id, schemas, Operations.

talkdesk_disposition_settings_bulk_update

Update disposition settings for a specific Talkdesk user, controlling after-call work activation, inbound/outbound enablement, timeout duration, internal transfer behaviour, and wrap-up occupancy handling. Required: user_id. Returns an empty 204 response on success.

talkdesk_presence_occupancies_bulk_update

Update a Talkdesk user's presence occupancy by applying JSON Patch operations (add, remove, or test) to their interactions list. Returns an empty 204 response on success. Required: user_id. Deprecated.

talkdesk_presence_status_bulk_update

Update the presence status for a Talkdesk user by setting a standard or custom status. Returns an empty 204 response on success. Required: user_id.

create_a_talkdesk_recordings_pause

Pause a recording in Talkdesk for an ongoing voice interaction, identified by the contact person's email address. Returns an empty 204 response on success. Required: email.

create_a_talkdesk_recordings_start

Start a recording for an ongoing Talkdesk voice interaction identified by a contact person's email address. Returns an empty 204 response on success. Required: email.

list_all_talkdesk_user_attributes

List attributes assigned to a specific Talkdesk user (agent). Returns id, name, active, proficiency, and user_proficiency for each attribute assigned to the user. Required: user_id.

create_a_talkdesk_user_integration

Set the external_id of a Talkdesk user from a named integration. Returns an empty 204 response on success. Required: user_id, integration_name, external_id.

create_a_talkdesk_user_presence

Subscribe to user presence in Talkdesk and obtain MQTT broker connection details for receiving real-time presence events. Returns: url, password, username, client_id, topic, Deprecated. Required: user_id, id.

get_single_talkdesk_user_presence_by_id

Get the current presence state of a Talkdesk user by id. Returns: id, account_id, user_id, status, custom_status, custom_status_id, occupancy, channels, devices, interactions, updated_by, updated_at, _links, Deprecated. Required: id.

talkdesk_data_table_rows_bulk_create

Perform a bulk DELETE operation on multiple rows in a Talkdesk data table by supplying a list of row IDs. Returns: data_table_id, has_errors, total_errors, total_deleted, _embedded, _links, GA. Required: data_table_id, row_ids, op.

talkdesk_data_table_rows_bulk_delete

Delete specific rows from a Talkdesk data table by passing a comma-delimited list of row IDs, or truncate all rows in the table when row_ids is omitted. Returns: data_table_id, has_errors, total_errors, total_deleted, _embedded, _links. Required: data_table_id. Max 100 row IDs per call.

create_a_talkdesk_data_table_row

Create a new row in a Talkdesk data table. Returns the created row including its id, key, data_table_id, value, created_at, and created_by_user_id. Required: data_table_id, key, value.

get_single_talkdesk_data_table_row_by_id

List rows in a Talkdesk data table with optional keyword search, date range filtering, and sort order. Returns each row with its id, key, value, last_saved_at, and last_saved_by. Required: data_table_id.

update_a_talkdesk_data_table_row_by_id

Replace the key and values of an existing row in a Talkdesk data table. The provided value object fully replaces the previous value. Returns the updated row including its id, key, data_table_id, value, created_at, and created_by_user_id. Required: id, data_table_id, key, value.

talkdesk_data_tables_bulk_create

Perform a bulk team operation on multiple Talkdesk data tables, either adding or removing team assignments across all specified tables in one call. Returns an empty 204 response on success. Required: table_ids, op.

create_a_talkdesk_data_table

Create a new data table in Talkdesk with a specified name and column definitions. Returns: id, name, description. Required: name, columns.

get_single_talkdesk_data_table_by_id

Get details of a Talkdesk data table by its id. Returns: id, name, description, team_ids, columns, _links, GA. Required: id.

talkdesk_data_table_metadata_bulk_update

Update metadata for a Talkdesk data table, including its name, description, and associated teams. Returns: id, name, description, columns, last_saved_at, last_saved_by, _links. Required: data_table_id, name.

create_a_talkdesk_data_table_row_batch

Create multiple rows atomically in a Talkdesk data table in a single request. Returns: batch_request_id, data_table_id, has_errors, total_created, total_errors, _links, GA. Required: data_table_id, rows. Maximum of 50 rows per batch.

talkdesk_data_table_schemas_bulk_update

Partially update a Talkdesk data table's schema by adding, renaming, or removing columns without modifying table metadata (name, description). Returns the updated schema including id, name, columns (each with id, display_name, type, slug), last_saved_at, and last_saved_by. Required: data_table_id, columns.

get_single_talkdesk_data_table_usage_by_id

Get the usage list for a specific Talkdesk data table, returning the resources that reference it. Returns: id, name, resource_type, extra_data. Required: data_table_id. Optionally filter by resource_type (FLOW or AUTOMATION_FLOW) or search_term.

get_single_talkdesk_export_file_by_id

Get a presigned download URL for a completed Talkdesk data table export job by id. Returns: id, download_url, file_name, expires_at, _links, GA. Required: id. Only available for COMPLETED-status exports; the download URL is valid for 15 minutes.

create_a_talkdesk_export_job

Create an asynchronous export job for data table rows in Talkdesk. The job is queued and processed asynchronously. Returns: id, status, file_name, format, export_type, created_at, _links, GA. Required: format, export_type, sources. Maximum 50 concurrent exports per account.

list_all_talkdesk_export_jobs

List export jobs for the current user in Talkdesk, scoped to the authenticated user. Returns: id, file_name, status, format, export_type, created_at, expires_in_days. Optionally filter by status or control sort order.

list_all_talkdesk_resource_types_users

Get the SCIM User Resource Type metadata from Talkdesk. Returns: schemas, description, endpoint, id, name, schema, meta.

create_a_talkdesk_rows_import

Import rows into a Talkdesk data table by uploading a CSV or JSON file. The file is validated against the table schema and rows are upserted (created or updated) matched by key. Returns: created, updated, _links, GA. Required: data_table_id, file. CSV max 10 MB; JSON max 2 MB; max 1000 rows per table.

create_a_talkdesk_account_payoff

Calculate the payoff amount for a Talkdesk FSI account based on a provided future date. Returns: daily_per_diem, payoff_amount, payoff_amount_details, custom_fields. Required: contact_id, account_id, payoff_date.

create_a_talkdesk_card_activation

Activate a specific card associated with a contact in Talkdesk FSI. Returns: confirmation_code, custom_fields, GA. Required: contact_id, card_id, interaction_id.

create_a_talkdesk_card_deactivation

Deactivate a specific card associated with a contact in Talkdesk FSI, rendering it inactive for further use. Returns: confirmation_code, custom_fields. Required: contact_id, card_id, new_status.

get_single_talkdesk_contact_account_by_id

Retrieve the financial or membership accounts associated with a specific Talkdesk FSI contact. Returns `_embedded` (accounts array with id, description, account_type, balance, available_balance, status, and parties) and `total` count. Required: contact_id.

get_single_talkdesk_contact_card_by_id

Retrieve the list of cards associated with a specific Talkdesk contact. Returns: total, _embedded, GA. Required: contact_id.

talkdesk_contact_cards_lock

Temporarily lock a specific card associated with a Talkdesk contact, blocking its usage without deactivating it. Returns: confirmation_code, custom_fields. Required: contact_id, card_id.

talkdesk_contact_cards_unlock

Unlock a previously locked card associated with a Talkdesk contact, restoring it to active use. Returns: confirmation_code, custom_fields. Required: contact_id, card_id.

get_single_talkdesk_contact_cards_contact_by_id

Get a single card associated with a Talkdesk FSI contact by card id. Returns: id, card_name, card_number, card_type, activation_at, expiration_at, inactive_date, holder_name, issuer, status, description, custom_type, custom_status, custom_fields, account_id, deactivation_note, _links. Required: contact_id, id.

get_single_talkdesk_contact_payment_by_id

List past and upcoming payments associated with a specific Talkdesk FSI contact. Returns a collection with total count and a payments array, each item including id, description, total_amount_due, currency, due_at, status, type, account_id, minimum_payment_due, due_fees_amount, and amount_details. Required: contact_id.

create_a_talkdesk_data_tables_import

Create a new Talkdesk data table and atomically import rows from a CSV or JSON file in a single operation (rolled back if import fails). Returns: id, name, _links, GA. CSV max 10 MB; JSON max 2 MB; max 1,000 rows per table. Required: file, schema.

talkdesk_fsi_checks_search

Search for the status of a check in Talkdesk FSI by providing an account ID and check number. Returns: account_id, check_number, check_status, custom_fields. Required: contact_id, account_id, check_number.

list_all_talkdesk_fsi_contacts

Search Talkdesk FSI contacts matching the given filter criteria. Returns total, _embedded (containing a contacts array where each contact includes id, name, member_id, addresses, id_documents, birth_date, contacts, and custom_fields), and redacted_fields. All filter parameters are optional.

get_single_talkdesk_fsi_contacts_fsi_by_id

Get a single FSI contact by id in Talkdesk. Returns the contact record including id, member_id, name, contacts (channel entries), addresses, id_documents, id_document_number, id_document_type, birth_date, custom_fields, _links, and redacted_fields. Required: id.

create_a_talkdesk_internal_verify

Verify a destination account in Talkdesk FSI by its base number, suffix, and owner's last name. Returns: verification_code, error.

create_a_talkdesk_payment

Cancel a payment in Talkdesk before it has been processed. Returns: member_id, account_id, stop_check_status_code, stop_check_status_desc, effective_date, custom_fields, GA. Required: contact_id, account_id, check_currency_code_value, stop_type.

get_single_talkdesk_scim_group_by_id

Get details for a specific Talkdesk SCIM group by id. Returns the group object including id, displayName, meta, and members. Pass excludedAttributes=members to skip fetching group members. Required: id, group_id.

list_all_talkdesk_scim_groups

List Talkdesk SCIM groups in the authenticated account with optional filtering by displayName. Returns: schemas, Resources, totalResults, startIndex, itemsPerPage, GA. Supports eq and co filter operators via the filter parameter.

list_all_talkdesk_scim_resource_types

List all SCIM resource types supported by the Talkdesk service provider. Returns each resource type's id, name, description, schema, endpoint, schemas, and meta (resourceType and location).

get_single_talkdesk_scim_schema_by_id

Get a specific Talkdesk SCIM schema definition by its unique URI identifier. Returns the schema object including id, name, description, attributes (each with name, type, mutability, returned, uniqueness, caseExact, and optional subAttributes), and meta. Required: id.

list_all_talkdesk_scim_schemas

List all SCIM schema definitions supported by Talkdesk. Returns each schema's id, name, description, attributes (each with name, type, mutability, returned, uniqueness, caseExact, and optional subAttributes), and meta. Optionally narrow results using SCIM filter syntax via the filter parameter.

list_all_talkdesk_scim_service_provider_configs

Get the SCIM Service Provider Configuration for a Talkdesk instance, describing which SCIM features are supported. Returns: schemas, bulk, changePassword, documentationUri, etag, filter, patch, sort, meta.

create_a_talkdesk_transfers_external

Initiate an external transfer between accounts in Talkdesk FSI. Returns: transaction_post_date, confirmation_code, custom_fields. Required: origin_member_id, origin_account_number, and value. Domestic transfers require destination_account_number and destination_bank_routing_number; international transfers require iban and swift.

create_a_talkdesk_transfers_internal

Create an internal funds transfer between two member accounts in Talkdesk FSI. Returns: transaction_post_date, confirmation_code, custom_fields, error. Required: origin_member_id, destination_member_id, origin_account_number, destination_account_number, value.

create_a_talkdesk_transfers_international

Create an international transfer between member accounts in Talkdesk FSI. Returns: transaction_post_date, confirmation_code, custom_fields. Required: origin_member_id, origin_account_number, iban, swift, value.

create_a_talkdesk_travel_notification

Create a travel notification in Talkdesk FSI for a contact's upcoming trip, registering their destinations and travel dates. Returns: itinerary_id, custom_fields, itineraryId. Required: contact_id, destination, departure_date, return_date, contact_number.

list_all_talkdesk_automated_notifications_event_types

List automated notification event types in Talkdesk. Returns: id, name, updated_at. Optionally filter the results by one or more event type ids.

create_a_talkdesk_automated_notifications_event_type

Create a new automated notification event type in Talkdesk. Returns the created event type including its id, name, and updated_at. Required: id, name.

delete_a_talkdesk_automated_notifications_event_type_by_id

Delete an automated notification event type in Talkdesk by id. This operation is irreversible and may affect any notification rules that reference the deleted event type. Returns an empty 204 response on success. Required: id.

get_single_talkdesk_automated_notifications_event_type_by_id

Get a single automated notification event type in Talkdesk by id. Returns: id, name, updated_at, GA. Required: id.

update_a_talkdesk_automated_notifications_event_type_by_id

Update an existing automated notification event type in Talkdesk by id. The full event type object must be provided; partial updates are not supported. Returns: id, name, updated_at. Required: id, name.

delete_a_talkdesk_report_files_report_by_id

Delete a Talkdesk Explore API report file by id. Returns an empty 204 response on success. Required: id, type.

get_single_talkdesk_report_files_report_by_id

Get a Talkdesk Explore API report file execution result by id. Returns a 302 redirect to the file location along with: total, type. Required: id, type.

create_a_talkdesk_report_jobs_report

Create a new Talkdesk Explore API report job for the specified report type. Returns: id, name, timezone, status, format, timespan. Required: type.

get_single_talkdesk_report_jobs_report_by_id

Get all Talkdesk Explore API report jobs for the specified report type. Returns each job record including id, name, status, timezone, format, timespan, and _links. Required: type.

create_a_talkdesk_card_replace_card

Request the issuance of a replacement card for a contact in Talkdesk FSI. Returns: expected_delivery_date, custom_fields. Required: contact_id, card_id, account_id, address.

create_a_talkdesk_events_write_back

Send event write-back information to the Talkdesk FSI core system for a given interaction. Returns: event_id, event_name, additional_properties. Required: interaction_id, event_name, event_date.

get_single_talkdesk_fsi_decrypt_by_id

Decrypt encrypted content using the AES algorithm via Talkdesk's FSI Integrations API. Returns: decrypted_content. Required: encrypt_key, encrypted_content.

create_a_talkdesk_payments_ach

Set up an ACH transfer for a Talkdesk contact, moving funds between an external bank account and an internal account or loan. Returns: confirmation_code. Required: contact_id, transfer_type, source_account_number, target_account_number, currency, payment_amount, payment_type, payment_date.

create_a_talkdesk_pin_generate

Generate a temporary PIN for a Talkdesk FSI contact and send it to the customer's mobile phone as the first step in unlocking their account. Returns: tem_pin, action_status, custom_fields. Required: contact_id, account_number, card_id, action.

create_a_talkdesk_pin_reset

Verify a temporary PIN and reset the account PIN for a contact in Talkdesk FSI (second step of the unlock flow). Returns: reset_status, custom_fields. Required: contact_id, account_number, card_id, tem_pin, new_pin.

delete_a_talkdesk_events_external_id_by_id

Delete Talkdesk automated notification events by external id and publish deletedEvents. Returns an empty 204 response on success. Required: id, publisher_name.

create_a_talkdesk_events_write_backs_writeback

Write disposition or notes data back to a contact's record in Talkdesk's Financial Services Experience Cloud for Insurance core system. Returns: event_id, event_name, additional_properties. Required: event_name, contact_id.

create_a_talkdesk_healthcare_appointment

Schedule a healthcare appointment in Talkdesk by submitting an available slot for a patient interaction. Returns an empty 200 response on success. Required: interaction_id.

delete_a_talkdesk_healthcare_appointment_by_id

Cancel a Talkdesk healthcare appointment by id. Returns an empty 200 response on success. Required: id, interaction_id, appointment_id.

list_all_talkdesk_healthcare_appointments

List future healthcare appointments linked to a patient interaction in Talkdesk. Returns: count, total, page, per_page, total_pages, _links, _embedded. Required: interaction_id.

list_all_talkdesk_healthcare_available_appointments_vas

Search available VA healthcare appointment slots in Talkdesk, returning the closest matching ProviderAvailabilityVA object. Returns: remaining, date, time, timezone, time_preferences_flag, _links, GA. Required: interaction_id, provider_id. At least one of service_type_id or service_type_ids must also be provided.

list_all_talkdesk_healthcare_available_provider_slots

Search available Talkdesk Healthcare provider appointment slots. Returns a paginated HAL response including _embedded.provider_slots (each with id, date, time, provider_id, location_id, service_type_id, time_zone_id, and time_preferences_flag), count, total, and _links. At least one of service_type_id or service_type_ids must be provided.

list_all_talkdesk_healthcare_available_slots

[Deprecated: use /healthcare/available-provider-slots instead.] Search Talkdesk Healthcare provider availability slots. Returns a paginated HAL response with provider_slots including id, date, time, provider_id, location_id, service_type_id, and time_zone_id. Required: service_type_id, location_id.

list_all_talkdesk_healthcare_balances

Get the balance of a patient in Talkdesk by interaction ID. Returns: id, total_balance, accounts, GA. Required: interaction_id.

create_a_talkdesk_healthcare_call_answered

Write to the Talkdesk HLS Providers Call Answered API, mapping an agent to a patient interaction. Returns a 200 response with no body on success. Required: interaction_id, agent_id.

list_all_talkdesk_healthcare_patient_informations

Get patient information for a Talkdesk Healthcare interaction. Returns: id, name, birth_date, gender, pcp, mrn, self_service_active, rendering_provider_name, rendering_provider_id, custom_fields, home_address, GA. Required: interaction_id.

list_all_talkdesk_healthcare_patients_studios

Search for patients in Talkdesk Healthcare PatientStudio. Returns a single PatientStudio object including id, name, birth_date, gender, count, ssn, mrn, pcp_id, pcp_name, and mychart_account_id. If the search yields a count other than one, the count field reflects the total number of matches found. Required: interaction_id.

list_all_talkdesk_healthcare_suggest_providers_vas

List VA healthcare provider name suggestions in Talkdesk based on an interaction. Returns a HAL-paginated result including count, total, total_pages, _embedded.provider_names (array of provider name objects with name), and _links navigation URLs. Required: interaction_id.

get_single_talkdesk_patient_billing_by_id

Get a patient's billing summary in Talkdesk. Returns: id, account_guarantors, GA. Required: id.

get_single_talkdesk_patient_coverage_by_id

Get detailed insurance coverage for a Talkdesk patient by coverage id. Returns: id, plan_id, plan_name, subscribe, unsubscribe, plan_status, priority, plan_type, relationship, network_type, payor, copay_information, accumulators, GA. Required: id, patient_id, coverage_id.

list_all_talkdesk_patient_coverages

List insurance coverages for a Talkdesk patient. Returns one record per coverage including id, plan_id, plan_name, plan_status, subscribe, unsubscribe, and priority. Required: patient_id.

list_all_talkdesk_patients_studio_briefs

Search Talkdesk patients and return brief basic information optimised for speed. Returns: _links, id, name, ssn, mrn, birth_date, gender, count, GA. Required: interaction_id.

create_a_talkdesk_subscriptions_opt_in

Check the opt-in status for one or more notification topics on a specific channel in Talkdesk. Returns: opt_in. Required: topic_ids, channel.

talkdesk_automated_notifications_accounts_bulk_delete

Delete the automated notifications account configuration in Talkdesk. Returns an empty 204 response on success.

list_all_talkdesk_automated_notifications_accounts

Get the automated notifications account configuration in Talkdesk. Returns: id, account_rules, _links.

create_a_talkdesk_automated_notifications_event

Create a Talkdesk automated notification event and publish an addedEvent. Returns: id, external_id, correlation_id, publisher_name, type, source, time_zone, primary_date, secondary_date, contacts, data, _links, GA. Required: publisher_name, type, source, time_zone, primary_date, contacts.

delete_a_talkdesk_automated_notifications_event_by_id

Delete a Talkdesk automated notification event by id and publish a deletedEvent. Returns an empty 204 response on success. Required: id, event_id, publisher_name.

get_single_talkdesk_automated_notifications_event_by_id

Get a single Talkdesk automated notification event by id. Returns: id, external_id, correlation_id, publisher_name, type, source, time_zone, primary_date, secondary_date, contacts, data, _links, GA. Required: id.

list_all_talkdesk_automated_notifications_events

List Talkdesk automated notification events for the account, optionally filtered by publisher name or external id. Returns per event: id, type, source, publisher_name, primary_date, time_zone, contacts, external_id, correlation_id, secondary_date, data, and _links.

list_all_talkdesk_automated_notifications_interactions

List Talkdesk Automated Notifications Interactions, filterable by event, rule, contact, state, channel type, escalation, and date range. Returns _embedded containing an interactions array — each record with id, account_id, state, channel_type, contact_id, an_event_id, rule_id, escalation_id, escalation_state, an_channel_uri, contact_channel_uri,…

talkdesk_automated_notifications_rules_bulk_update

Upsert an automated notification rule in Talkdesk (include id in the body to update an existing rule, omit it to create a new one). Returns: id, name, action_type, trigger_on, recurrence, and 7 more. Required: event_type, name, action_type, action_data, trigger_on, discard_out_of_available_interval, include_conversation_history.

delete_a_talkdesk_automated_notifications_rule_by_id

Delete an automated notification rule in Talkdesk by id. Returns an empty 204 response on success. Required: id.

get_single_talkdesk_automated_notifications_rule_by_id

Get an automated notification rule in Talkdesk by id. Returns the full rule object including id, name, action_type, trigger_on, discard_out_of_available_interval, include_conversation_history, created_date, updated_date, and event_type. Required: id.

talkdesk_automated_notifications_subscriptions_bulk_update

Upsert a Talkdesk automated notification subscription — creates a new subscription or updates an existing one for the given topic and channel. Returns the upserted subscription including its id, topic_id, channel (type and uri), opt_in status, and _links. Required: topic_id, channel, opt_in.

get_single_talkdesk_automated_notifications_subscription_by_id

Get a single Talkdesk automated notification subscription by id. Returns the subscription object including its id, topic_id, channel (type and uri), opt_in status, and _links. Required: id.

list_all_talkdesk_automated_notifications_subscriptions

List Talkdesk automated notification subscriptions associated with a topic or channel. Returns: _embedded, count, _links, GA. Optionally filter by topic_id, channel_type, or channel_uri.

create_a_talkdesk_automated_notifications_topic

Create a new automated notification topic in Talkdesk. Returns: id, name, requires_opt_in, _links. Required: name, requires_opt_in.

delete_a_talkdesk_automated_notifications_topic_by_id

Delete a Talkdesk automated notification topic by id. Returns an empty 204 response on success. Required: id.

get_single_talkdesk_automated_notifications_topic_by_id

Get a Talkdesk automated notification topic by id. Returns: id, name, requires_opt_in, _links, GA. Required: id, topic_id.

list_all_talkdesk_automated_notifications_topics

List automated notification topics for the Talkdesk account. Returns: _embedded, count, total, _links, GA.

create_a_talkdesk_account_hl_7

Send a raw HL7 event to a Talkdesk healthcare account. Returns: hl7_message (the accepted HL7 message string echoed back on 202 Accepted). Required: account_id, message_type.

get_single_talkdesk_account_transaction_by_id

Retrieve the transaction history for a specific Talkdesk FSI contact's account. Returns: total, _embedded, GA. Required: contact_id, account_id.

get_single_talkdesk_card_spend_limit_by_id

Get the daily spend limits for a debit card in Talkdesk FSI. Returns: id, card_id, reason, is_one_day_only, spend_limit_controls, custom_fields, GA. Required: contact_id, card_id.

talkdesk_card_spend_limits_bulk_update

Modify the daily spend limits for a debit card in Talkdesk FSI. Returns the updated record including id, card_id, reason, is_one_day_only, spend_limit_controls (with ATM, OTC, and retail authorization limits), and custom_fields. Required: contact_id, card_id, spend_limit_controls.

create_a_talkdesk_contacts_reset

Reset a Talkdesk healthcare contact by phone number, removing all traits from the contact except the phone number and renaming the contact to that number. Returns an empty 200 response on success. Required: phone_number.

talkdesk_contacts_sync_from_ehrs_bulk_update

Update a Talkdesk healthcare contact by phone number with patient information from the EHR for a given interaction. Returns an empty 204 response on success. Required: phone_number, interaction_id.

create_a_talkdesk_contacts_synchronizations_from_core

Update a Talkdesk FSI contact's name, address, email, and phone numbers by syncing FSI member data into the contact record. The contact is located by contact_id or phone_number; the FSI member is matched by member_id. Returns an empty 200 response on success. Required: member_id. Either contact_id or phone_number must also be supplied.

create_a_talkdesk_epic_click_to_call

Initiate a click-to-call for an authorized Epic EHR agent in Talkdesk. Returns: PhoneSystemCallID. Required: PhoneAgentID, OriginPhoneExtension, PhoneNumber, EpicCallID.

create_a_talkdesk_epic_outgoing_sm

Send an outgoing SMS via EPIC in Talkdesk Healthcare. Submits the message body to the specified recipient phone number and returns a 200 response on success. Required: ToPhoneParameter, BodyParameter.

create_a_talkdesk_epic_phone_action

Pause or resume call recording for a specified EHR agent in Talkdesk via the Epic healthcare integration. Returns: PhoneSystemResponse. Required: PhoneSystemRequest.

list_all_talkdesk_oauth_jwks

Get the JWKS (JSON Web Key Set) string used within the header of the JWT Epic OAuth2 flow in Talkdesk Healthcare. Returns the JWKS as a raw string scalar; no structured named fields are exposed.

create_a_talkdesk_appointment_confirmation

Trigger a confirmation for a Talkdesk healthcare appointment, signaling to the EHR that the patient will attend. Returns an empty 204 response on success. Required: appointment_id, interaction_id.

create_a_talkdesk_appointment_rescheduling

Reschedule an existing healthcare appointment in Talkdesk. Returns the rescheduled appointment object including id, date_time, provider, location, patient_id, patient_name, duration_in_minutes, and 2 more fields. Required: appointment_id, interaction_id, location_id, provider_id, service_type_id, date_time, duration, time_zone_id, and comments.

create_a_talkdesk_epic_agent_status_sync

Sync an agent status change from Epic to Talkdesk by sending a RESERVE or RELEASE action for one or more Epic-identified agents. Returns an empty 204 response on success. Required: EpicAgentIDs, Action.

create_a_talkdesk_healthcare_triage

Submit a triage request in Talkdesk and receive a triage level assessment for a diagnosis process. Returns: id, diagnosis_process_id, triage_level, GA. Required: triage_id, interaction_id, diagnosis_process_id.

create_a_talkdesk_patient_password_reset

Send a password reset request to a patient's healthcare portal (e.g., MyChart) in Talkdesk. Returns an empty 204 response on success. Required: patient_id, delivery_method. A prior patient lookup must be performed within the same interaction before calling this endpoint.

talkdesk_patient_verifications_verify

Verify patient data in Talkdesk by comparing caller-provided fields against the patient record in the configured EHR, returning a similarity score and a match result. Returns: match, score. Required: patient_id, fields, confidence_level.

create_a_talkdesk_popup_intent

Save a patient's intent in Talkdesk Healthcare. Returns: id, success. Required: interaction_id, intent.

talkdesk_contact_consents_bulk_update

Update the voice biometrics consent status for a contact in Talkdesk, creating a new consent record or updating an existing one. Returns: status. Required: contact_id, status.

get_single_talkdesk_contact_consent_by_id

Get the current voice biometrics consent state for a contact in Talkdesk. Returns: status, consented_at, _links, GA. Required: id. Returns 404 if no consent record exists for the contact in voice biometrics.

talkdesk_contact_enrollments_bulk_delete

Delete the voice biometrics enrollment for a contact in Talkdesk, removing them from voice authentication and resetting their consent status. If the contact is already in a non-enrolled state the call is treated as a no-op except for resetting consent. Returns an empty 204 response on success. Required: contact_id.

talkdesk_contact_enrollments_bulk_update

Create or replace the voice biometrics enrollment for a contact in Talkdesk, associating it with an enrollment phrase. If the contact does not yet exist it is created automatically and consent is marked as granted; re-issuing replaces the phrase association while preserving the existing consent state. Returns an empty 204 response on success.….…

talkdesk_external_entities_contact_bind_interactions_lookup

Bind a contact to an interaction in Talkdesk. Returns the binding result including id, status, channel_type, and contact_person (with endpoint, href, and id). Required: contact_id, interaction_id.

talkdesk_external_entities_contact_externals_search

Create or look up a Talkdesk contact by external contact info for use with digital chat channels. Returns: matched, _embedded. Required: external_id.

update_a_talkdesk_external_entities_contact_sync_by_id

Upsert a Talkdesk contact by integration platform and external entity ID — updates the matched contact if one exists, or creates a new one when no match is found. Returns: matched, _embedded, GA. Required: id, integration_id, external_id, integrations.

list_all_talkdesk_external_entities_contacts

Search for a Talkdesk contact by phone number. Returns the matched contact object including id, name, address, emails, phones, custom_fields, tags, and integrations. Required: phone.

create_a_talkdesk_industries_external_entity

Create a new external entity map in Talkdesk Industries, linking an external entity to a Talkdesk interaction. Returns an empty 200 response on success. Required: external_entity_context, external_entity_id, interaction_id.

create_a_talkdesk_industries_external_entities_mapper

Create a new external entity map in Talkdesk, associating an external entity with an interaction. Returns an empty 200 response on success. Required: external_entity_context, external_entity_id, interaction_id.

list_all_talkdesk_search_contacts_channels

Search Talkdesk contacts by email address or phone number. Returns an array of matching contact records, each including id, name, address, emails, phones, tags, and custom_fields.

talkdesk_healthcare_cancel_appointments_vas_bulk_delete

Cancel a VA appointment in Talkdesk Healthcare associated with a given interaction. Returns the cancelled appointment's id, provider_id, provider_name, service_type_id, and location_id. Required: interaction_id.

create_a_talkdesk_healthcare_appointment_confirmation_va

Trigger an appointment confirmation in Talkdesk Healthcare, signaling to the EHR that the patient will attend the scheduled appointment. Returns an empty 204 response on success. Required: interaction_id.

list_all_talkdesk_healthcare_encounters

List healthcare encounters in Talkdesk connected to a given interaction. Returns: count, total, page, per_page, total_pages, _links, _embedded, GA. Required: interaction_id.

list_all_talkdesk_healthcare_future_appointments_vas

Search future VA appointments in Talkdesk by interaction ID, returning the closest upcoming appointment as a FutureAppointmentsVA object. Returns: _links, remaining, id, service_type, date_time, date, time, category, timezone, provider, location, patient_instructions, cancellable, comment, sub_location, and 13 more. Required: interaction_id.

create_a_talkdesk_healthcare_in_basket_message

Send an in-basket message to Epic via Talkdesk. Returns an empty 204 response on success. Required: message_priority, message_text, message_type, recipients, sender_id.

talkdesk_healthcare_interactions_overrides_bulk_update

Store configuration overrides scoped to a specific interaction in Talkdesk Healthcare, allowing per-interaction customisation of provider settings (e.g., temporarily switching the active EHR provider for a single interaction). Returns an empty 202 response on success. Required: service, interaction_id, overrides.

list_all_talkdesk_healthcare_medication_orders

List medication orders for a patient in Talkdesk. Returns a collection of medication order records including id, name, category, status, authored_on, dose, requester, quantity, validity_period, substitution_allowed, dispenser, and destination. Required: interaction_id.

list_all_talkdesk_healthcare_outstanding_orders

List outstanding orders for a patient in Talkdesk. Returns each order's id, name, status, date_ordered, assigned_user, ordering_provider, order_class, clinical_provider_name, department_id, encounter_id, and related contraindication/declined reason details. Required: interaction_id.

create_a_talkdesk_healthcare_patient_case

Create a patient case document in Talkdesk for a given interaction. Returns: id, success. Required: interaction_id.

list_all_talkdesk_healthcare_patients_vas

Search Talkdesk VA for a patient by various identifiers and return a PatientStudio object with demographics and contact details. Returns: id, name, ssn, mrn, birth_date, gender, home_phone_number, active, count, patient_status, pcp_id, pcp_name, and 16 more. If count differs from 1, the result represents multiple matches. Required: interaction_id.

create_a_talkdesk_healthcare_prescriptions_refill_va

Request a VA prescription refill in Talkdesk for a specific patient prescription. Returns: error_message, prescription_result, GA. Required: prescription_id.

list_all_talkdesk_healthcare_prescriptions_vas

List all VA-adapted prescriptions associated with a patient in Talkdesk. Returns count, total, total_pages, _links, and _embedded containing a prescriptions array where each item includes id, medication, status, pharmacy_name, end_date, fills_remaining, is_fillable, and is_rar_able. Required: patient_id.

list_all_talkdesk_healthcare_procedures

List all healthcare procedures associated with a patient in Talkdesk. Returns a paginated collection of procedure records including id, name, status, category, performed_start_date_time, performed_end_date_time, outcome, subject, performers, encounter, and 4 more fields. Optional filters: interaction_id, patient_id, category, start_date, end_date.

create_a_talkdesk_healthcare_schedule_appointments_va

Schedule the appointment selected on an interaction in Talkdesk Healthcare using its interaction ID. Returns 200 OK with no response body on success. Required: interaction_id.

list_all_talkdesk_healthcare_service_requests

List Talkdesk healthcare service requests connected to a specific interaction. Returns a collection of service request records, each including id, status, intent, category, type, authored_on, start, end, requester, reason, priority, performer, location, insurance, and patient_instructions. Required: interaction_id.

create_a_talkdesk_patient_medication_order

Create a medication order (request) for a patient in Talkdesk. Returns: id. Required: patient_id, medication_order_id.

list_all_talkdesk_patient_schedulable_service_requests

List schedulable service requests (pending-scheduling clinical orders and, for Epic, appointment requests) for a patient in Talkdesk. Returns: count, total, page, per_page, total_pages, _links, _embedded. The returned id can be used as order_id when scheduling an appointment. Required: patient_id.

create_a_talkdesk_patient_medication_statement

Create a medication statement for a patient in Talkdesk. Returns: id. Required: patient_id, medication_statement_id.

list_all_talkdesk_patient_medication_statements

List medication statements for a patient in Talkdesk. Returns records including id, status, name, authored_on, dose, patientInstruction, effectivePeriod, and informationSource. Required: patient_id.

list_all_talkdesk_past_encounters_physicians

Search Talkdesk physicians based on a patient's past encounters, falling back to general search conditions if no encounters exist. Returns: id, total, physicians, GA. Required: patient_id.

talkdesk_patient_mychart_passwords_bulk_update

Send a password reset request to Epic MyChart for a patient. **Deprecated** — use the provider-agnostic `POST /healthcare/patients/{patient_id}/password-reset` endpoint instead. Returns an empty 202 Accepted response on success. Required: patient_id, my_chart_account_id, site_id.

list_all_talkdesk_providers_reset_vas

Reset all VA arrays and retrieve patient studio information from Talkdesk for a specific interaction. Returns: _links, id, name, ssn, mrn, birth_date, gender, home_phone_number, work_phone_number, patient_status, pcp_id, pcp_name, rendering_provider_name, rendering_provider_id, mychart_account_id, and 13 more. Required: interaction_id.

list_all_talkdesk_virtual_agent_schedule_settings

Retrieve flat appointment scheduling settings in Talkdesk, filterable by provider, service type, or location. Returns: provider_id, provider_description, photo_url, gender, language, service_type_id, service_type_description, location_id, location_description, office_address, office_city, office_state, office_zip_code, and 6 more.

create_a_talkdesk_schedules_time_off

Create a scheduled time off in Talkdesk WFM for an agent. Returns the newly created time off object including its id, agent_email, start_at, end_at, event_type_name, and description. Required: agent_email, start_at, end_at, event_type_name. The event_type_name must reference a pre-existing WFM event type of type TIME OFF.

delete_a_talkdesk_schedules_time_off_by_id

Delete a scheduled time off in Talkdesk WFM by id. Returns an empty 204 response on success. Required: id.

update_a_talkdesk_schedules_time_off_by_id

Update the start time, end time, or description of an existing scheduled time off in Talkdesk WFM by id. Returns an empty 204 response on success. Required: id, start_at, end_at.

create_a_talkdesk_timeseries_forecast_import

Upload a forecast CSV file to Talkdesk WFM to create a new Forecast Import, queued asynchronously for processing. Returns: id, status. Required: csv_file, file_name, time_zone. Maximum file size is 5 MB.

get_single_talkdesk_timeseries_forecast_import_by_id

Get the current processing status of a Talkdesk WFM Forecast Import by id. Returns: id, status, created_at, updated_at, error_file_url, EarlyAccess. Required: id.

create_a_talkdesk_timeseries_history_import

Upload a CSV file to Talkdesk WFM to import historical timeseries data. Returns a 202 response with no body; the URL for tracking import status is provided in the Content-Location response header.

get_single_talkdesk_timeseries_history_import_by_id

Get a Talkdesk WFM History Import by id. Returns the import record including its id and status. Required: id.

create_a_talkdesk_healthcare_diagnosis

Submit a healthcare diagnosis request in Talkdesk by providing patient symptoms and optional follow-up questionnaire answers. Returns: id, diagnosis_process_id, should_stop, diagnosis_result, question, GA. Required: interaction_id.

talkdesk_campaign_do_not_call_lists_bulk_delete

Delete (unassign) one or more Do Not Call Lists from a Talkdesk campaign. Accepts a JSON array of DNCL id objects in the request body. Returns an empty 204 response on success. Required: campaign_id.

create_a_talkdesk_campaign_do_not_call_list

Assign a Do Not Call List to a Talkdesk campaign to prevent dialing numbers on that list. Accepts a JSON array containing exactly one DNCL id object. Returns an empty 204 response on success. Required: campaign_id, id.

get_single_talkdesk_campaign_do_not_call_list_by_id

List the Do Not Call Lists assigned to a Talkdesk campaign. Returns each record's id and _links (self href and do_not_call_lists href). Optionally filter by DNCL id using the filter parameter. Required: id.

get_single_talkdesk_campaign_number_by_id

List phone numbers assigned to a Talkdesk campaign. Returns: id, phone_number, _links. Required: id. Optionally filter by specific number IDs using the filter parameter.

create_a_talkdesk_campaign_number

Assign one or more phone numbers to a Talkdesk campaign for outbound dialing. Accepts an array of number objects (up to 100). Returns an empty 204 response on success. Required: campaign_id, id.

talkdesk_campaign_numbers_bulk_delete

Remove the association of one or more phone numbers from a Talkdesk campaign. Accepts an array of number objects (up to 100). Returns an empty 204 response on success. Required: campaign_id.

talkdesk_campaign_record_lists_bulk_delete

Dissociate one or more record lists from a Talkdesk campaign by supplying an array of record list IDs to remove. Returns an empty 204 response on success. Required: campaign_id. Body must contain between 1 and 100 items.

create_a_talkdesk_campaign_record_list

Assign one or more record lists to a Talkdesk campaign by supplying an array of record list IDs. Returns an empty 204 response on success. Body must contain between 1 and 100 items. Required: campaign_id, id.

get_single_talkdesk_campaign_record_list_by_id

List the record lists assigned to a Talkdesk campaign by id. Returns each record list's id and _links (HAL navigation links including self and record_lists hrefs). Required: id. Optionally filter by specific record list IDs using the filter parameter (supports eq and or operators).

talkdesk_campaign_users_bulk_delete

Remove one or more users from a Talkdesk campaign by supplying a list of user IDs in the request body. Returns an empty 204 response on success. Required: campaign_id. Maximum of 50 user IDs per request.

create_a_talkdesk_campaign_user

Assign one or more users (agents) to a Talkdesk campaign. Returns an empty 204 response on success. Maximum of 50 user IDs per request. Required: campaign_id, id.

get_single_talkdesk_campaign_user_by_id

List all users (agents) assigned to a Talkdesk campaign by id. Returns: id, _links, email, name, active, gender, extension, external_phone_number, created_at. Optionally filter results by user IDs using the filter parameter. Required: id.

create_a_talkdesk_campaign

Create a new outbound campaign in Talkdesk, or duplicate an existing one by supplying source_id. Returns: id, name, dialing_mode, priority, run_once, action_required, status, dialing_mode_configuration, dialing_strategy, created_at, _links. Required: name.

delete_a_talkdesk_campaign_by_id

Delete a Talkdesk campaign by id. Returns an empty 204 response on success. A campaign that is currently running cannot be deleted. Required: id.

update_a_talkdesk_campaign_by_id

Update a Talkdesk campaign by id using a JSON Patch operation. Supports replacing status, name, or priority. Returns: id, name, dialing_mode, priority, run_once, action_required, status, dialing_mode_configuration, dialing_strategy, created_at, _links. Required: id, op, path, value.

list_all_talkdesk_campaigns

List Talkdesk campaigns with optional filtering by name, status, dialing mode, priority, and date range. Returns items with: id, name, dialing_mode, priority, status, created_at, run_once, action_required. Supports sorting and partial-match search.

get_single_talkdesk_campaigns_campaign_by_id

Get a Talkdesk campaign by id. Returns: id, name, dialing_mode, priority, run_once, action_required, status, dialing_mode_configuration, dialing_strategy, created_at, _links. Required: id.

talkdesk_va_cases_bulk_delete

Soft-delete multiple Talkdesk cases in bulk. Returns: ids, statusCode, message, payload. Required: ids.

create_a_talkdesk_va_case

Create a new case in Talkdesk. Returns: id, title, description, parent_id, owner_id, status, type, priority, custom_fields, notes, requester_id, requester_name, requester_email, requester_type. Required: title, description.

get_single_talkdesk_va_case_by_id

Get details of a single Talkdesk case by id. Returns: id, title, description, owner_id, form_name, priority, type, status, resolution, notes, custom_fields, GA. Required: id.

list_all_talkdesk_va_cases

List Talkdesk cases with optional filters. Returns a list of case records each including id, title, description, status, priority, type, requester_id, requester_name, group_id, agent_id, create_at, update_at, notes, and custom_fields.

update_a_talkdesk_va_case_by_id

Update an existing Talkdesk case by id. Returns: id, parent_id, title, description, owner_id, priority, type, status, resolution, notes, custom_fields, group_id, GA. Required: id.

talkdesk_cases_deleted_cases_bulk_delete

Permanently delete multiple Talkdesk cases by their IDs. Returns the list of case IDs that were successfully deleted permanently. Required: ids.

list_all_talkdesk_cases_info

Get the newest Talkdesk case details for a contact. Returns: id, title, description, requester_id, requester_name, requester_email, requester_integration, requester_phone, group_id, group_name, agent_id, agent_name, form_name, priority, status, create_at, update_at, custom_fields, notes, and 3 more. Required: id, name, email, phone, integration.

list_all_talkdesk_va_fields

List all case fields defined in Talkdesk. Returns each field's id, name, key, type, description, dict_list (for dropdown/dictionary-backed fields), required, active, create_at, and update_at. No required parameters.

update_a_talkdesk_va_note_by_id

Update a case note in Talkdesk by id. Returns the updated note object including its id, note_title, note_body, and public visibility flag. Required: id.

delete_a_talkdesk_industries_context_by_id

Delete a Talkdesk industries context by id, removing all key/value pairs stored for that context. Returns an empty 204 response on success. Required: id.

get_single_talkdesk_industries_context_by_id

Get all key/value pairs stored for a Talkdesk industries context by id. Returns a dynamic string map whose keys are user-defined context attributes; example fields include customer_id and insurance_plan — actual keys depend on what was stored for the context. Required: id.

create_a_talkdesk_context_value

Add a new key/value pair to a Talkdesk Industries context. Returns the created pair including its id and value. Required: context_id, id, value.

delete_a_talkdesk_context_value_by_id

Delete a key/value pair from a Talkdesk Industries context by id. Returns an empty 204 response on success. Required: id, context_id, value_id.

update_a_talkdesk_context_value_by_id

Create or update a key/value pair in a Talkdesk Industries context by id (upsert). Returns the updated pair including its id and value. Required: id, context_id, value_id, value.

talkdesk_digital_connect_conversations_attach_message

Create an inbound message in an existing Talkdesk Digital Connect conversation. Returns: id, created_at, message_id, GA. Required: conversation_id, id.

create_a_talkdesk_digital_connect_conversation

Create a new Talkdesk Digital Connect conversation. Returns: id. Required: touchpoint_id, contact_person.

delete_a_talkdesk_digital_connect_conversation_by_id

Delete a Talkdesk Digital Connect conversation by id. Returns an empty 204 response on success. Required: id.

create_a_talkdesk_external_result

Submit feedback survey data for a Talkdesk conversation via the Digital Connect channel. Use this endpoint within survey-completion flows to record each question/answer pair and to signal survey completion by setting survey_is_end to true. Returns an empty 200 response on success.

create_fsi_insurance_connections_automated_notification

Create and publish an event to the Talkdesk automated-notifications system in Financial Services Experience Cloud for Insurance. Returns an empty 204 response on success. Required: type, external_system, primary_date, time_zone, contacts.

create_a_talkdesk_function_execution

Execute a previously saved Talkdesk function by its ID with the provided arguments. Returns the function execution result as a dynamic object whose shape depends on the function's implementation (e.g., spacedCode). Required: function_id, function_args.

create_a_talkdesk_functions_execution

Execute an inline Talkdesk function with provided arguments and return the computed result, without saving the function. Returns a dynamic object whose keys and types reflect the function's own return value (e.g., spacedCode in the documented example). Required: function_body, function_args.

industries_settings_interaction_configurations_bulk_update

Create or replace an interaction-specific configuration in Talkdesk Industries Settings, binding an interaction ID to a named service and its JSON configuration string. Returns: json, site_service_key. Required: service, interaction_id, json.

list_all_talkdesk_phone_details_numbers

Get phone numbers belonging to the Talkdesk account. Returns a list of phone number records including id, phone_number, friendly_name, dedicated_line, sip, vcid, capabilities. Required: page, per_page. Supports filtering by sip or vcid flags, free-text search across friendly name, phone number, or dedicated line agent ID, and field-level sorting.

get_single_talkdesk_phone_details_numbers_phone_detail_by_id

Get details for a specific Talkdesk phone number by id. Returns: id, phone_number, friendly_name, dedicated_line, dedicated_line_agent_id, sip, vcid, capabilities. Required: id.

list_all_talkdesk_phone_details_outbound_numbers

List phone numbers available for outbound use in Talkdesk, including dedicated lines and numbers belonging to an agent ring group. Returns: id, phone_number, friendly_name, dedicated_line, dedicated_line_agent_id, sip, vcid, capabilities. Optionally filter by search term or capability. Required: page, per_page.

talkdesk_phone_labels_bulk_update

Update all custom phone labels for the Talkdesk account in a single request. Every label must be included — partial updates are not supported and duplicates are not allowed. Returns the updated label list including total, count, _embedded (with the full labels array), and _links. Required: labels.

list_all_talkdesk_phone_labels

List phone labels configured for the Talkdesk account. Returns custom labels when defined, otherwise the default system labels. Returns: id, type, name, default_name.

talkdesk_schedules_ics

Retrieve a Talkdesk agent's schedule in iCalendar (RFC 5545) format via a unique calendar subscription token. Returns a raw text/calendar string containing scheduled events with their DTSTART, DTEND, and SUMMARY fields. Required: token.

create_a_talkdesk_schedules_event_import

Bulk import agent schedule events (shifts, time off, breaks, meetings) into Talkdesk WFM from a CSV file for asynchronous processing. Returns a 202 Accepted response with no body; poll the URI in the Location response header for import status. Required: csv_file, file_name, time_zone. Max file size is 5 MB.

get_single_talkdesk_schedules_event_import_by_id

Get the current status of a Talkdesk WFM schedule event import by id. Returns: id, status, error_report_url, error_report_expires_at, total_events, successful_events, failed_events, EarlyAccess. Required: id.

talkdesk_time_offs_balances_bulk_update

Bulk update time off balances in Talkdesk WFM, replacing agent balances for specified event types. Returns: time_off_balances. Required: time_off_balances.

delete_a_talkdesk_time_offs_balance_by_id

Delete a time off balance in Talkdesk WFM by id. Returns an empty 200 response on success. Required: id.

create_a_talkdesk_industries_activities_activity

Create an activity in Talkdesk for the given activity type. Returns the created activity object including id, account_id, activity_type_id, direction, started_at, contact_id, duration, interaction_id, ring_groups, tags, user_id, user_name, data, events, external_integration_name, and external_id. Required: activity_type_id, direction, started_at.

update_a_talkdesk_industries_activities_activity_by_id

Update a Talkdesk activity by id using JSON Patch operations (RFC 6902). Returns the modified activity object including id, account_id, activity_type_id, direction, started_at, contact_id, duration, interaction_id, ring_groups, tags, user_id, user_name, data, events, external_integration_name, and external_id. Required: id.

talkdesk_industries_activities_activities_attach_event

Add an event to a Talkdesk activity. Returns the created event object including id, event_type_id, occurred_at, and data. Required: activity_id, event_type_id, occurred_at.

list_all_talkdesk_schedule_callbacks

List scheduled callbacks in Talkdesk with optional filtering by status, phone number, agent, campaign, channel type, and time range. Returns per item: callback_id, phone_number, status, scheduled_time_to_call, assign_type_v2, created_at.

create_a_talkdesk_schedule_callback

Create a new scheduled callback in Talkdesk for a specific phone number. Returns: callback_id, interaction_id, caller_id, time_to_call, timezone, assign_type_v2, from_call_type, channel_type, dialing_model, and 11 more. Required: interaction_id, phone_number, caller_id, time_to_call, timezone, assign_type, from_call_type, dialing_model.

get_single_talkdesk_schedule_callback_by_id

Get the full details of a scheduled callback by id in Talkdesk. Returns: callback_id, account_id, interaction_id, caller_id, scheduled_time_to_call, timezone, preferred_start_time, preferred_end_time, processed_time, assign_type_v2, current_retry_attempts, current_rescheduled_attempts, max_rescheduled_attempts, status, and 22 more. Required: id.

update_a_talkdesk_schedule_callback_by_id

Update a scheduled callback by id in Talkdesk by submitting a JSON Patch array of replace operations (e.g. /timeToCall, /phoneNumber, /timezone, /assignType). Returns: callback_id, account_id, interaction_id, caller_id, scheduled_time_to_call, timezone, assign_type_v2, from_call_type, dialing_model, phone_number, status, and 19 more. Required: id.

delete_a_talkdesk_schedule_callback_by_id

Cancel a scheduled callback by id in Talkdesk. Returns an empty 204 response on success. Required: id.

list_all_talkdesk_studio_callbacks

List Talkdesk Studio Callbacks with optional filtering. Returns total, count, _links, and _embedded callbacks where each callback includes callback_id, phone_number, status, scheduled_time_to_call, created_at, and updated_at. Optionally filter by status, phone_number, agent_id, ring_group, team_id, from_call_type, attribute_id, or…

create_a_talkdesk_entries_query

Search entries in a Talkdesk Do Not Call List by phone numbers and timezone to check whether they exist and their expiration status. Returns a paginated result with total, count, per_page, and _embedded entries including id, phone_number, reason, expiration_date, and created_at. Required: do_not_call_list_id, id, phone_numbers.

update_a_talkdesk_contacts_member_by_id

Update a Talkdesk healthcare payer contact member by id, replacing its phone number. Returns an empty response on success. Required: id, phone_number.

list_all_talkdesk_connections_members

Search for the best-matching Talkdesk healthcare payer connection member using query parameters. Returns: id, full_name, date_of_birth, home_phone_number, mobile_phone_number, home_email, work_email, address, preferred_language, ssn, medicare_beneficiary_identifier, count, work_phone_number, GA.

get_single_talkdesk_connections_member_by_id

Get a single Talkdesk healthcare payer connection member by id. Returns: id, full_name, date_of_birth, gender, marital_status, phone_numbers, emails, address, preferred_language, ssn, primary_care_provider, medical_group, member_since, medicare_beneficiary_identifier, primary_plan, other_plans, screen_popup_url, GA. Required: id.

get_single_talkdesk_claim_status_by_id

Get the current status of a healthcare claim in Talkdesk by its id. Returns: status, GA. Optionally narrow the lookup with date_of_service, organization_unit, provider_id, or member_id. Required: id, claim_id.

get_single_talkdesk_prior_authorization_status_by_id

Get the status of a prior authorization in Talkdesk by its id. Returns: status, GA. Required: id, prior_authorization_id.

list_all_talkdesk_connections_providers

List Talkdesk healthcare providers by searching with optional query parameters. Returns provider records including id, full_name, date_of_birth, npi, phone_number, organization_unit, medical_group_id, medical_group_name, pcp_speciality_id, and pcp_speciality_name.

list_all_talkdesk_connections_claims

List healthcare claims from Talkdesk payer connections. Returns _embedded (an object containing a claims array, where each claim includes id, status, billing_amount, paid_amount, claim_provider, and date_of_service) and total count of matching records. All filter parameters are optional.

list_all_talkdesk_connections_prior_authorizations

List prior authorizations from Talkdesk Healthcare payer connections. Returns: id, status, pre_authorization_referring_provider, dos, reason, requested_date, authorization_date, expiration_date, number_of_units.

create_a_talkdesk_sycurio_login

Log in to the Sycurio client in Talkdesk using the configurations defined in industries-setting. Returns: id, login_successful, sycurio_session_id, sycurio_login_error_reason, GA.

create_a_talkdesk_call_attempt_disposition

Trigger a call attempt disposition automation event in Talkdesk for a specific record within a record list. Returns an empty 204 response on success. Required: record_list_id, record_id, disposition.

create_a_talkdesk_schedule_callback_created

Trigger the schedule callback created automation for a specific record in a Talkdesk record list. Returns an empty 204 response on success. Required: record_list_id, record_id.

create_a_talkdesk_callback_attempt_disposition

Trigger a callback attempt disposition automation event in Talkdesk for a specific record in a record list. Returns an empty 204 response on success. Required: record_list_id, record_id, disposition.

create_a_talkdesk_webhooks_trigger

Register a new webhook trigger in Talkdesk for a specified event type, subscribing to event notifications via a callback URL. Returns a 201 response with a location header pointing to the created trigger; no response body. Required: trigger_name, callbackurl.

delete_a_talkdesk_webhooks_trigger_by_id

Delete an existing webhook trigger in Talkdesk by trigger name and id, unsubscribing from a previously registered webhook event. Returns an empty 200 response on success. Required: id, trigger_name, trigger_id.

list_all_talkdesk_express_accounts

List all Talkdesk Express accounts under the caller's organization. Returns a paginated HAL envelope including count, total, total_pages, _embedded (with an accounts array of id, name, company_name, and status), and _links (pagination hrefs). Optionally sorted by order_by.

list_all_talkdesk_account_contracts

Get reseller contract info for a Talkdesk Express account. Returns: id, trial, account_status, license_number, transition_date, transition_status, GA. Required: account_id.

list_all_talkdesk_contracts_actions

List contract actions for a Talkdesk Express account. Returns: count, page, per_page, total, total_pages, _embedded, _links. Required: account_id. Optionally filter by status or action_type using comparison operators, or sort results by created_at or updated_at.

create_a_talkdesk_contracts_action

Create a contract action for a Talkdesk Express account to subscribe (NEWTDE), amend (AMENDTDE), or cancel (CANCELTDE) a contract. Returns: id, action_type, quantity, status, status_message, created_at, updated_at. Required: account_id, action_type.

list_all_talkdesk_express_products

List all available Talkdesk Express products from the Billing Insights API. Returns: count, page, per_page, total, total_pages, _embedded, _links. Supports optional filtering by product id and result ordering via filter and order_by.

list_all_talkdesk_express_subscriptions

List Talkdesk Express account subscriptions from the Billing Insights API. Returns subscription records including id, account_id, contract_number, currency, billing_period, status, start_date, end_date, edition, auto_renewal, product_id, quantity, unit_price, billing_frequency, pricing_model, concurrent, seasonal, and 2 more fields.

list_all_talkdesk_express_invoices

List invoice lines for all accounts under the organization in Talkdesk. Returns: count, page, per_page, total, total_pages, _embedded, _links. Optionally filter or sort results using filter and order_by.

list_all_talkdesk_usage_months

List Talkdesk monthly usage data aggregated by product across all accounts in the organization. Returns: first, last, next, prev, self, _embedded, _links. Use `filter` to narrow by account_id, month, or id; use `order_by` to control sort order.

create_a_talkdesk_provisioning_account

Provision a new Talkdesk Express trial account. Returns the created account object including id, name, admin_email, organization_id, created_at, and updated_at. Required: account_name, admin_email, admin_name, company_name, currency_iso_code, num_licenses, phone_number, website_url, edition.

list_all_talkdesk_validate_accounts

Validate whether a Talkdesk account exists by name. Returns an account validator object with a type field indicating the result. Required: account_name.

create_a_talkdesk_bridge_digital_connect

Send an automated notification webhook event to Talkdesk for a Digital Connect (DCE) conversation. Returns an empty 204 response on success. Required: event_type, conversation_id, timestamp.

create_a_talkdesk_eas_simulated_email

Send a simulated email message to an agent in Talkdesk via the email channel. Returns: id, message_id, thread_id, interaction_id, EarlyAccess. Required: content, from, to.

list_all_talkdesk_prompts

List audio prompts (audio files) from Talkdesk Studio flows. Returns: id, name, description, type, asset_id, created_at, created_by, created_user_name, updated_at, updated_by, updated_user_name, _links. Filterable by created_by, updated_by, date ranges, and free-text search.

create_a_talkdesk_prompt

Create a new audio prompt in Talkdesk. Returns the created prompt including id, name, description, type, asset_id, created_at, updated_at, updated_by, and _links. Required: request_id, name, file_name, description.

get_single_talkdesk_prompt_by_id

Get a single Talkdesk audio prompt by id. Returns: id, name, description, type, asset_id, created_at, created_by, created_user_name, updated_at, updated_by, updated_user_name, _links, GA. Required: id.

update_a_talkdesk_prompt_by_id

Update a Talkdesk audio prompt by id with a full replacement. Returns the updated prompt including id, name, description, type, asset_id, updated_at, updated_by, and _links. Required: id, name, description.

talkdesk_prompts_partial_update

Partially update a Talkdesk audio prompt using JSON Patch operations. Returns the updated prompt including id, name, description, type, asset_id, updated_at, updated_by, and _links. Required: prompt_id.

delete_a_talkdesk_prompt_by_id

Delete a Talkdesk audio prompt by id. Returns an empty 204 response on success. Required: id.

talkdesk_prompts_bulk_create

Perform a bulk download or delete operation on Talkdesk audio prompts. Returns an array of results each containing path, method, status, and response_body. Required: method, requests.

get_single_talkdesk_prompt_download_link_by_id

Generate a temporary download link for a Talkdesk audio prompt by id. Returns: expires_in, _links, GA. Required: id. The optional expires_in query parameter sets a custom link lifetime between 600 and 43200 seconds.

list_all_talkdesk_prompts_usages

Get usage statistics for a specific prompt in Talkdesk. Returns: id, usage, flows_usage, queues_usage. Required: prompt_id (sent to Talkdesk as the id query parameter).

create_a_talkdesk_prompts_request

Request a pre-signed upload link for an audio file in Talkdesk's Prompts API. Returns: id, _links.

list_all_talkdesk_prompts_quotas

Get the prompts quota for the Talkdesk account. Returns: id, account_id, max_value, current_count, threshold, _links.

list_all_talkdesk_prompt_flows

List flows associated with a Talkdesk prompt. Returns id, flow_id, flow_name, published_flow_version, and draft_flow_version for each flow in the collection. Required: prompt_id, id.

list_all_talkdesk_fsi_insurance_integrations_accounts

List insurance accounts from Talkdesk's Financial Services Experience Cloud for Insurance using optional search criteria. Returns account records including account_number, first_name, last_name, account_status, date_of_birth, policies, primary_phone_number, and primary_address. Max 500 accounts per page.

fsi_insurance_integrations_accounts_fsi_insurance_integrations_l

Get a Talkdesk FSI Insurance account by account number. Returns: id, account_number, first_name, last_name, policies, customer_since, date_of_birth, account_status, delinquent, primary_phone_number, work_phone_number, fax_phone_number, home_phone_number, mobile_phone_number, tax_id, custom_fields, primary_address, _links. Required: account_number.

list_all_talkdesk_account_holder_policies

List insurance policies associated with a Talkdesk account holder. Returns a collection of policy records, each including number, type, delinquency_status, status, and custom_fields. Required: account_holder_id, id.

list_all_talkdesk_fsi_insurance_integrations_policies

Search insurance policies in Talkdesk's Financial Services Experience Cloud for Insurance. Returns _embedded.policies (an array of policy records each with id, number, type, type_name, insured_name, address, effective_at, renewal_at, status, status_name, and custom_fields) and a total count. All filter parameters are optional.

fsi_insurance_integrations_policies_fsi_insurance_integrations_g

Get a Talkdesk Financial Services Insurance policy by id. Returns the full policy record including policy_number, status, product, effective_date, expiration_date, primary_named_insured, producer_code, pa_coverages, pa_vehicles, payment_schedule, policy_contact_roles, hop_dwellings, hop_coverages, and custom_fields. Required: id.

get_single_talkdesk_metadatum_by_id

Get policy metadata for a Talkdesk FSI Insurance policy by id. Returns: id, locations, contacts, vehicles, policy_locations, dwelling_coverage_limit, other_structures_coverage_limit, personal_property_coverage_limit, living_expenses_coverage_limit, custom_fields, GA. Required: id.

create_a_talkdesk_fsi_insurance_integrations_claim

Create a new insurance claim through FNOL (First Notice of Loss) in Talkdesk. Returns id and claim_number of the newly created claim. Required: policy, reporter, primary_contact, general_information.

get_single_talkdesk_fsi_insurance_integrations_claim_by_id

Get a Talkdesk insurance claim by id. Returns claim_number, claim_status, policy_number, loss_date, loss_cause, loss_location, loss_estimate, exposures, paid_amount, recovered_amount, report_date, product, description, and custom_fields. Required: id.

get_single_talkdesk_account_holder_billing_by_id

Get billing information for a Talkdesk account holder member by id. Returns: id, max_policy_period_end_date, next_invoice_due, next_invoice_due_amount, next_invoice_number, total_paid, total_unbilled, total_currently_billed, total_past_due, total_outstanding, delinquencies, total_billed_invoices, and 4 more. Required: id.

get_single_talkdesk_billing_detail_by_id

Get billing details for an account holder in Talkdesk FSI Insurance by member id. Returns: id, account_number, account_since, active_policies, billing_period, payor, send_invoices_by, billing_address, payment_instrument, custom_fields, GA. Required: id.

list_all_talkdesk_account_claims

List insurance claims related to an account holder in Talkdesk FSI Insurance Integrations. Returns: id, claim_number, product, policy_number, claim_status, assigned_user, description, loss_date, reported_date, custom_fields, _links. Required: account_number.

get_single_talkdesk_account_claim_by_id

Search insurance claims related to an account holder in Talkdesk FSI Insurance Connections. Returns: id, claim_number, product, policy_number, claim_status, description, assigned_user, loss_date, reported_date, custom_fields, _links. Required: account_number.

update_a_talkdesk_fsi_insurance_integrations_contact_by_id

Update contact details for an account holder in Talkdesk's Financial Services Insurance integration. Supports partial updates to phone number, email, and/or address. Returns: id, phone_number, email, address, updated_at, GA. Required: id.

create_a_talkdesk_fsi_insurance_integrations_document_delivery

Send a document delivery via SMS or email in Talkdesk's Financial Services Experience Cloud for Insurance. Returns an empty 200 response on success. Required: channel, address, document_type.

get_single_talkdesk_fsi_insurance_connections_claim_by_id

Get a single insurance claim by id from Talkdesk's Financial Services Experience Cloud for Insurance. Returns the full claim object including claim_number, claim_status, policy_number, loss_cause, loss_date, loss_location, paid, recovered_amount, exposures, report_date, and custom_fields. Required: id.

get_single_talkdesk_policie_claim_by_id

Search claims related to a policy in Talkdesk's Financial Services Experience Cloud for Insurance. Returns a list of claim objects, each including id, claim_number, product, policy_number, claim_status, assigned_user, loss_date, and reported_date. Required: policy_number.

list_all_talkdesk_customer_orders

List customer orders for a customer in Talkdesk's ERC e-commerce connections. Returns: id, order_number, customer_id, purchase_datetime, delivery_type, shipping_addresses, items_number, price_summary, order_extra_info, status, cancellation_status, fulfillment_status, is_refundable, is_returnable, is_cancellable, and 6 more. Required: customer_id.

get_single_talkdesk_customer_order_by_id

Get a single customer order by id in Talkdesk's ERC e-commerce Bridge. Returns the order object including id, order_number, customer_id, brand, purchase_datetime, delivery_type, shipping_address, billing_address, price_summary, payment_details, order_extra_info, items_number, status, is_refundable, and is_returnable. Required: customer_id, id.

update_a_talkdesk_customer_order_by_id

Partially update a customer order's tags in Talkdesk's ERC e-commerce Bridge (Shopify only). New tags are prepended to existing tags with duplicates removed case-insensitively. Returns the updated order including id, order_number, customer_id, brand, delivery_type, shipping_address, and 7 more fields. Required: id, customer_id, order_id, tags.

talkdesk_customer_orders_cancel

Cancel a customer's order in Talkdesk's ERC e-commerce connections. The request body is optional; omitting it cancels with provider defaults (cancel_reason=other, restock=false, no notification, no automatic refund). Returns an empty 200 response on success. Required: customer_id, order_id.

create_a_talkdesk_customer_order

Create a new order for a customer in Talkdesk's ERC e-commerce Bridge. Returns the created order object including id, order_number, customer_id, purchase_datetime, delivery_type, status, shipping_address, billing_address, and price_summary. Required: customer_id.

talkdesk_customer_orders_cancel_order

Cancel Customer Order. Cancel a customer's order. Required fields: - customer_id - order_id A successful request cancels the order and returns it with the updated status CANCELLED. Required: customer_id, order_id.

get_single_talkdesk_customer_orders_customer_by_id

Get all orders for a specific customer in Talkdesk's Retail Experience Cloud. Returns order records including id, order_number, status, purchase_datetime, delivery_type, shipping_address, billing_address, price_summary, payment_details, items_number, is_refundable, and is_returnable. Required: customer_id.

create_a_talkdesk_order_change_shipping_addrese

Change the shipping address of a customer's order in Talkdesk. Returns an empty 200 response on success. Required: customer_id, order_id.

create_order_change_shipping_addreses_change_shipping_address

Change the shipping address of an existing order in Talkdesk Retail Experience Cloud. Returns the updated order object including id, order_number, shipping_address, billing_address, price_summary, payment_details, and items_number. Required: customer_id, order_id.

list_all_talkdesk_customer_shipments

List customer shipments via the Talkdesk ERC e-commerce connections service for a given customer. Returns shipment records including id, order_id, shipping_provider, tracking_info, shipping_address, items, and 2 more fields. Required: customer_id. Supports Customers Bridge (all parameters), BigCommerce, and Shopify (subset of parameters).

get_single_talkdesk_customer_shipment_by_id

Get customer shipments from the Talkdesk ERC e-commerce bridge for a given customer, with filtering options by order, product, item, delivery status, and shipping provider. Returns shipment records including id, order_id, shipping_provider, tracking_info, shipping_address, items, latest_status_info, and custom_fields. Required: customer_id.

create_a_talkdesk_shipments_schedule

Schedule a customer shipment slot in Talkdesk's ERC e-commerce system for a specific order or delivery. Returns: _links. Required: customer_id, id. At least one of order_id or delivery_id must also be provided in the request body.

create_a_talkdesk_shipments_schedules_schedule

Schedule a customer shipment slot in Talkdesk's Retail Experience Cloud. At least one of order_id or delivery_id must also be provided. Returns an empty 204 response on success. Required: customer_id, id.

get_single_talkdesk_connections_customer_by_id

Get an ERC e-commerce connections customer by id in Talkdesk. Returns: id, first_name, last_name, customer_since, shipping_addresses, integration_info, custom_fields, brand, _links, GA. The brand query parameter is required for multi-brand accounts. Required: id, customer_id.

list_all_talkdesk_customer_most_recent_orders

Get the most recent order for an ERC e-commerce customer in Talkdesk. Returns: id, brand, status_info, order_number, tracking_info, delivery_type, shipping_address, is_cancellable, is_change_shipping_address_allowed, highlighted_item, is_refundable, is_returnable, payment_status, delivery_status, and 7 more. Required: customer_id.

get_single_talkdesk_customer_most_recent_order_by_id

Get the most recent order for a customer via the Talkdesk ERC e-commerce connections service. Returns: id, customer_id, status_info, order_number, tracking_info, delivery_type, shipping_addresses, highlighted_item, is_refundable, is_returnable, is_cancellable, is_change_shipping_address_allowed, _links, and 5 more. Required: id, customer_id.

list_all_talkdesk_shipments_available_slots

List available shipment delivery slots for an ERC e-commerce customer in Talkdesk. Returns _embedded.delivery_slots containing slot objects with id, brand, date, time, timezone, shipping_provider, and custom_fields, plus _links for pagination navigation.

talkdesk_shipments_available_slots_fetch

Get available shipment delivery slots for an ERC e-commerce customer in Talkdesk via the connections endpoint. Returns _embedded.delivery_slots containing slot objects with id, brand, date, time, timezone, shipping_provider, and custom_fields, plus _links for pagination navigation.

list_all_talkdesk_connections_products

Get or search products from the Talkdesk-integrated e-commerce store in the Retail Experience Cloud. Returns _embedded.products (each with id, title, brand, description, images, variants, options, and custom_fields) and _links for pagination navigation. The brand parameter is required for multi-brand accounts.

get_single_talkdesk_order_item_by_id

Get order items for a customer order from the Talkdesk ERC Customers Bridge. Returns: _embedded, _links, GA. Required: customer_id, order_id.

list_all_talkdesk_order_items

List order items for a customer order from the Talkdesk ERC connections endpoint (supports BigCommerce, Shopify, and Customers Bridge). Returns: _embedded, _links, GA. Required: customer_id, order_id.

talkdesk_items_cancels_bulk_update

Cancel items from a Talkdesk ERC e-commerce customer order by supplying a list of item IDs to cancel. Returns `_embedded` containing the updated cancelled items (each with id, name, price, quantity, deliverable_quantity, and refundable_quantity) and `_links` for navigation. Required: customer_id, order_id, ids.

talkdesk_items_cancels_bulk_update_connections

Cancel items from a Talkdesk ERC e-commerce connections customer order (supported for BigCommerce and Shopify; Shopify auto-issues a refund for cancelled quantity). Returns `_embedded.items` with id, name, price, sku, custom_fields, and deliveries, plus top-level `refunds`, `returns`, and `_links`. Required: customer_id, order_id, ids.

list_all_talkdesk_customers_carts

Get a customer's ERC e-commerce cart via the Talkdesk connections service. Returns the cart object including cart_id, customer_id, cart_status, cost, cart_lines, cart_discounts, checkout, brand, custom_fields_type, custom_fields, and 2 more fields. At least one of customer_id or cart_id must be provided; brand is required for multi-brand accounts.

talkdesk_customers_carts_fetch

Get a customer's ERC e-commerce cart via the Talkdesk bridge. Returns the cart object including cart_id, customer_id, cart_status, cost, cart_lines, cart_discounts, checkout, delivery_address, selected_delivery_option, brand, and 2 more fields. At least one of customer_id or cart_id must be provided; brand is required for multi-brand accounts.

get_single_talkdesk_ecommerce_customer_by_id

Get an ecommerce customer by id in Talkdesk's Retail Experience Cloud. Returns: id, first_name, last_name, brand, customer_since, addresses, integration_info, average_order_value, custom_fields, _links, GA. Pass brand to filter by provider in multi-brand accounts. Required: id.

get_single_talkdesk_order_cancel_preview_by_id

Get a pre-cancellation preview for a customer's order in Talkdesk to populate the cancellation UI before submitting the cancel request. Returns: use_new_cancel_flow, supports_refund_on_cancel, cancel_reasons, refund_payments, refundable_items, GA. Required: id, customer_id, order_id.

talkdesk_cart_items_bulk_update

Bulk update items in an ecommerce cart in Talkdesk's Retail Experience Cloud. Returns the updated cart state including cart_id, total_quantity, currency, cost breakdown, checkout URL with expiry, and the full cart_lines collection. Required: interaction_id, cart_lines.

talkdesk_delivery_addreses_bulk_update

Set or update the delivery address on a Talkdesk cart and retrieve available delivery options. Returns: delivery_group_id, delivery_address, available_delivery_options. Required: cart_id. For multi-brand accounts, brand is also required.

talkdesk_delivery_options_bulk_update

Select a delivery option for a Talkdesk cart by specifying the delivery group and option handle. Returns: selected_delivery_option. Required: cart_id, delivery_group_id, delivery_option_handle.

create_a_talkdesk_cart_bind

Bind a customer to a cart in the Talkdesk Retail Experience Cloud, associating a Talkdesk interaction with an existing or new Shopify cart. Returns the updated cart including cart_id, customer_id, cart_status, total_quantity, currency, cost, and cart_lines. Required: interaction_id.

create_a_talkdesk_checkout_token

Generate (or refresh) a short-lived checkout token for a Talkdesk cart, producing a secure redirect URL that allows a customer to reach the provider's checkout page without a Talkdesk JWT. Calling this endpoint again for the same cart overwrites the previous token. Returns: cart_id, token, expires_at, checkout_url, GA. Required: cart_id.

get_single_talkdesk_checkout_by_id

Validate the checkout access token for a Talkdesk Retail Experience Cloud cart and redirect to the provider's checkout URL. Returns an HTTP 302 redirect; the Location response header contains the provider checkout URL (e.g., a Shopify checkout URL). Required: id, cart_id.

get_single_talkdesk_order_by_id

Get the order associated with a specific cart in Talkdesk via a database-only lookup of the persisted cart-to-order relation; works regardless of cart status. Returns: id, order_number, purchase_datetime, delivery_type, shipping_address, billing_address, price_summary, payment_details, status, is_refundable, and 16 more. Required: id, cart_id.

list_all_talkdesk_ecommerce_orders

Get e-commerce orders from the Talkdesk Retail Experience Cloud for the authenticated account. Returns _embedded (containing an orders array with fields: id, order_number, status, purchase_datetime, items_number, shipping_address, billing_address, price_summary, payment_details, delivery_type, and fulfillment/cancellation flags) and _links for…

list_all_talkdesk_ecommerce_products

Get or search ecommerce products from the connected store in Talkdesk's Retail Experience Cloud. Returns a HAL-style envelope with _embedded (products array — each record includes id, title, brand, description, default_variant_id, default_image_id, images, options, and variants) and _links (self and next hrefs). Optionally filter by brand or…

list_all_talkdesk_ecommerce_brands

Get all brand information configured for the current Talkdesk account. Returns: multiple_integrations, _links.

list_all_talkdesk_technician_visits_available_slots

Retrieve available technician visit slots in Talkdesk for a given customer or visit. Returns a paginated list of slots, each including id, brand, date, time (start/end), timezone, technician details (id, name, phone_number, and 2 more fields. All filter parameters are optional, but providing customer_id or visit_id is recommended to scope results.

create_a_talkdesk_technician_visits_schedule

Schedule a customer technician visit in Talkdesk by booking a specific slot for a given customer. Returns an empty 200 OK response on success. Required: customer_id, id.

get_single_talkdesk_customer_technician_visit_by_id

Get technician visits for a Talkdesk customer. Returns a list of visit records including id, status, type, date, timezone, address, technician, and custom_fields. Required: customer_id.

list_all_talkdesk_external_customers

Get external customers from the Talkdesk Retail Experience Cloud, optionally filtering by name, phone, email, brand, match_mode, address_phone, or ids. Returns total, count, and _embedded contacts — each contact includes customer_id, name, emails, phones, created_at, updated_at, and custom_fields.

talkdesk_shopify_webhooks_handler_credentials_bulk_update

Upsert Shopify Integration credentials for the currently authenticated Talkdesk account. Returns the updated credential configuration including if_multiple_integration, default_integration, and multiple_integrations. Required: shopify_store_domain, shopify_api_key, shopify_api_secret.

talkdesk_shopify_webhooks_handler_credentials_bulk_delete

Delete Shopify Integration credentials for a specific store domain in the authenticated Talkdesk account. Returns an empty 204 response on success. Required: shopify_store_domain.

list_all_talkdesk_shopify_webhooks_handler_credentials

Get the Shopify Integration credentials configured for the currently authenticated Talkdesk account. Returns: if_multiple_integration, default_integration, multiple_integrations, callbar_customer_search, _links.

list_all_talkdesk_return_reasons

Retrieve the list of available return reasons from Talkdesk's Retail Experience Cloud Bridge. Returns each reason's type, description, and sub_reasons. The optional brand parameter is required when the account is configured for multiple brands.

create_a_talkdesk_return_calculation

Calculate the expected refund amount for a return request in Talkdesk. Returns: taxes_included, return_item_amount, exchange_item_amount, subtotal_amount, return_shipping_fee_amount, restocking_fee_amount, taxes, total_outstanding_amount, return_item_discount_amount, customer_collect_amount, and 3 more. Required: order_id, return_line_items.

create_a_talkdesk_order_cancel_return

Cancel a return in Talkdesk by the provided return ID. Returns an empty 204 response on success. Required: return_id.

create_a_talkdesk_order_create_return

Create a new return for an order in Talkdesk. Returns: order_id, return_id, status, name, custom_fields, _links, GA. Required: order_id, return_line_items.

create_a_talkdesk_order_request_return

Request a new order return in Talkdesk's Retail Experience Cloud. Always returns HTTP 200 — check error_code to determine outcome. On success returns order_id, return_id, status, name, and custom_fields; on failure returns error_code and error_message. Required: order_id, return_line_items.

create_a_talkdesk_refund_suggested

Calculate the suggested refund for a Talkdesk ERC order or return. Returns amount, maximum_refundable, subtotal, total_tax, total_duties, refund_line_items, suggested_transactions, suggested_refund_methods, shipping, deductions, and refund_owed. Either order_id or return_id must be provided.

create_a_talkdesk_ecommerce_refund

Create a direct refund for an order in Talkdesk's Retail Experience Cloud, supporting specific line items, shipping costs, and duties with configurable payment transactions and refund methods. Returns: refund_id, order_id, note, created_at, updated_at, total_refunded, shipping, total_duties, refund_line_items, and 4 more. Required: order_id.

create_a_talkdesk_return_process_refund

Process a return and create a refund for an associated order in Talkdesk. Returns the created refund object including refund_id, order_id, total_refunded, refund_line_items, transactions, created_at, and updated_at. Required: order_id, return_id.

create_a_talkdesk_recall_contact

Ingest a batch of recall contacts into Talkdesk's Retail Experience Cloud and asynchronously trigger the configured Journey for each valid recipient. Recipients are validated synchronously; valid ones are queued for Journey triggering and invalid ones are reported. Returns: recall_id, accepted_recipients, rejected_recipients, and 1 more field.…

create_a_talkdesk_contacts_upload

Upload a CSV file of recall-affected customers to Talkdesk and asynchronously trigger the configured recall Journey for each row. The file is validated synchronously as a whole — if any row is invalid, nothing is sent. Returns: upload_id, total_rows, accepted_rows. Required: journey_id, brand, file. Max 5 MiB and 20,000 data rows; same file…

get_single_talkdesk_customer_suppression_by_id

List suppression entries for a Talkdesk ERC customer within a business domain. Returns an entries array where each item includes id, domain, scope, customer_id, reason_code, status, created_at, and updated_at. Required: customer_id, domain, brand.

create_a_talkdesk_customer_suppression

Create a suppression entry in Talkdesk ERC for a customer, preventing future outbound contact in a domain. Returns the created (or revived) entry including id, status, domain, scope, customer_id, reason_code, created_at, and updated_at. Required: customer_id, domain, scope, brand, reason_code, source.

delete_a_talkdesk_customer_suppression_by_id

Revoke a Talkdesk suppression entry by id (soft revoke — the entry's status changes to REVOKED and it remains in the system for audit history). Returns the revoked entry including id, status, domain, scope, customer_id, reason_code, created_at, and updated_at. Required: id, customer_id, suppression_id.

get_single_talkdesk_cart_activity_check_by_id

Check whether a Talkdesk cart activity is still valid for the next outbound step in a cart-recovery Journey. Returns: valid, reason, GA. Required: id.

talkdesk_ecommerce_catalogs_search

Search the Talkdesk Retail Experience Cloud product catalog. Returns products (id, title, brand, description, handle, image_url, options, variants) and pagination metadata (cursor, has_next_page). Optionally filter by query, intent, brand, categories, and price range.

talkdesk_user_status_bulk_update

Update the availability status of a specific Talkdesk contact center user. Accepts current_status and new_status; valid values are available, away, or a custom status starting with away_ or busy_ (custom statuses must already exist in the account). The statuses busy, after_call_work, and offline cannot be used as source or target. Returns an…

create_a_talkdesk_users_status

Retrieve the current availability status of up to 20 Talkdesk agents in a single bulk request. Returns an array of user status objects, each containing id and status. Maximum of 20 user IDs per request.

list_all_talkdesk_addresses_geo_addresses

List Google geo addresses in Talkdesk by proxying the Google Places Text Search API. Returns: id, display_name, address, zip_code, city, region_name, country_name, coordinates. Required: address.

list_all_talkdesk_addresses_geocodings

List Google geocoding results in Talkdesk by proxying the Google Geocoding API. Returns a collection of addresses, each including id, display_name, address, zip_code, city, region_name, country_name, and coordinates (latitude/longitude). Either latlng or address must be provided; if both are supplied, address prevails.

list_all_talkdesk_ccaas_queues

List queues configured for the Talkdesk account, with optional filtering and sorting. Returns: id, name, description, created_at, updated_at, settings.

list_all_talkdesk_location_next_week_opening_hours

List the next week's opening hours for a Talkdesk location, returning one record per day for the next 7 days ordered by date. Returns: id, date, special_date_name, day_of_week, slots. Required: location_id.

list_all_talkdesk_locations_cities

List distinct city names from the Talkdesk Locations Directory. Returns an array of city name strings (e.g., 'Lisbon', 'New York'). Supports optional filtering by location_name, alternative_name, city, zip_code, specialities, and service_names. Geo-radius filtering via latitude, longitude, and distance is also available but requires a Feature Flag…

list_all_talkdesk_locations_customer_addreses

List customer addresses from the Talkdesk Locations Directory. Returns: id, display_name, address, zip_code, city, region_name, country_name, coordinates. Optionally filter results by interaction_id, contact_id, or industry.

list_all_talkdesk_locations_directory_locations

List locations in the Talkdesk Locations Directory with optional filters for name, address, geo-proximity, service, and staff. Returns per-record fields: id, name, type, time_zone, address, open_hours, staffs, and custom_fields. Max 50 locations per page.

get_single_talkdesk_locations_directory_location_by_id

Get a single Talkdesk Locations Directory location by id. Returns: id, custom_fields, provenance, name, alternative_names, external_id, type, time_zone, phone_numbers, image_url, address, opening_status, services, staffs, open_hours, special_dates, _links, GA. Required: id.

create_a_talkdesk_locations_directory_location

Create a new location in the Talkdesk Locations Directory. Returns the created location including id, name, time_zone, address, open_hours, special_dates, staffs, and provenance. Required: name, time_zone, address.

update_a_talkdesk_locations_directory_location_by_id

Fully replace a Talkdesk Locations Directory location by id. Returns the updated location including id, name, time_zone, address, staffs, open_hours, services, and opening_status. Required: id, name, time_zone, address, staffs.

talkdesk_locations_directory_locations_bulk_delete

Bulk delete multiple Talkdesk Locations Directory locations by their ids. Returns an empty 204 response on success. Required: location_ids.

list_all_talkdesk_locations_directory_locations_agents

List Talkdesk Locations Directory locations for the agent view. Returns: id, opening_hours, specialities, service_names, name, alternative_names, external_id, type, time_zone, phone_numbers, image_url, address, and 3 more. Supports filtering by location_type, cities, region_name, country_name, and proximity (latitude, longitude, distance).

list_all_talkdesk_locations_directory_locations_staffs

Retrieve locations and staff records for agent view in Talkdesk by posting filter criteria. Returns up to 100 records per request including id, name, entity_type, external_id, phone_numbers, services, location_address, location_opening_status, location_business_hours, and staff-specific fields such as staff_job_title, and 2 more fields.

list_all_talkdesk_locations_directory_services

List Talkdesk location directory services with optional filtering by service name, type, location attributes, staff, geographic proximity, and custom field expressions. Returns: id, service_name, external_id, service_type, duration, description, virtual_location_url, price, open_hours, special_dates, time_zone, phone_numbers, locations, and 3 more.

get_single_talkdesk_locations_directory_service_by_id

Get a single Talkdesk location directory service by id. Returns the full service object including id, service_name, description, service_type, time_zone, open_hours, special_dates, phone_numbers, locations, price, custom_fields, created_at, and updated_at. Required: id.

create_a_talkdesk_locations_directory_service

Create a new service in the Talkdesk Locations Directory. Returns the created service object including id, service_name, description, service_type, open_hours, locations, phone_numbers, time_zone, created_at, and updated_at. Required: service_name, description.

update_a_talkdesk_locations_directory_service_by_id

Update an existing Talkdesk location directory service by id (full replacement). Returns the updated service object including id, service_name, description, service_type, open_hours, locations, phone_numbers, time_zone, created_at, and updated_at. Required: id, service_name, description.

talkdesk_locations_directory_services_bulk_delete

Bulk delete multiple Talkdesk location directory services by their ids. Returns an empty 204 response on success. Required: service_ids.

list_all_talkdesk_locations_directory_services_agents

List services available for agent view in Talkdesk's Locations Directory. Returns each service's id, service_name, service_type, duration, description, price, time_zone, open_hours, special_dates, phone_numbers, locations, created_at, and updated_at. Required: location_id.

list_all_talkdesk_locations_names

List location names from the Talkdesk Locations Directory. This is a lightweight endpoint that returns only the name and id of each location. Supports optional filtering by location_name and by geographic radius using latitude, longitude, and distance (in meters); the radius parameters require a Feature Flag to be enabled. Returns: name, id.

list_all_talkdesk_queue_users

List users assigned to a specific Talkdesk queue. Returns: id, _links, email, name, active, gender, extension, external_phone_number, created_at. Required: queue_id.

talkdesk_queues_users_bulk_delete

Unassign users from queues in Talkdesk by providing an array of queue-user mappings (up to 100 queue entries, up to 100 users per entry). The operation is idempotent and not transactional. Returns: result, errors.

create_a_talkdesk_queues_user

Assign users to queues in Talkdesk by providing an array of queue-user mappings. The operation is idempotent and not transactional. Returns: result, errors.

list_all_talkdesk_service_next_week_opening_hours

List the next week's opening hours for a Talkdesk Locations Directory service, returning one entry per day for the next 7 days ordered by date. Returns: id, date, special_date_name, day_of_week, slots. Required: service_id.

list_all_talkdesk_services_durations

List service durations from the Talkdesk Locations Directory. Returns an array of service duration strings (e.g., '1 hours', '30 minutes'). Optionally filter results using the service_duration parameter, which supports fuzzy matching.

list_all_talkdesk_services_names

List service names from the Talkdesk Locations Directory. This endpoint returns a lightweight index of services (id and name only). Returns: name, id. Optionally filter by specialities, service_name, or cities.

list_all_talkdesk_services_services_locations

List services with their associated location details from the Talkdesk Locations Directory. Returns: id, service_name, service_type, duration, description, virtual_location_url, location_id, and 3 more. Filterable by service name/type, location city/zip_code/country, staff details, and geographic radius (latitude, longitude, distance).

list_all_talkdesk_services_types

List service types from the Talkdesk Locations Directory. Returns a paginated collection of service type name strings, e.g., 'Online' and 'Offline'. Optionally filter by service_name, service_type, location_name, location_type, or location_id.

create_a_talkdesk_appointment_cancel

Cancel a Talkdesk scheduled appointment by event ID. Sends an SMS notification to the contact upon cancellation. Returns an empty 204 response on success. Required: event_id, sms_notification.

create_a_talkdesk_articles_ingestion

Trigger an asynchronous article ingestion in Talkdesk by uploading a source file (e.g. PDF) for a given article type; the job is accepted immediately (202) and processed by a background workflow. Returns: id, type_id, source_key, status, workflow_id, warnings, errors, summary, report_url, created_at, updated_at. Required: type_id, source_key, file.

get_single_talkdesk_articles_ingestion_by_id

Get the status and details of a Talkdesk article ingestion job by id. Poll this endpoint to track progress — status moves from PENDING through RUNNING to the terminal SUCCESS or FAILURE. Returns: id, type_id, source_key, status, workflow_id, warnings, errors, summary, report_url, created_at, updated_at, GA. Required: id.

create_a_talkdesk_articles_rollback

Roll back a bulk-upsert run in the Talkdesk Locations Directory by discarding everything a prior `POST /locations-directory/articles/bulk` run wrote and restoring any superseded versions of affected link tuples. Idempotent — repeated calls with the same token return `{"discarded": 0, "restored": 0}` rather than an error. Returns: discarded,….…

list_all_talkdesk_articles_types

List article types in the Talkdesk Locations Directory shared catalog. Returns: id, name, display_name, description, content_type, json_schema, supported_link_patterns, ingestion_task_queue, ingestion_workflow_name, created_at, updated_at. Optionally filter to types enabled for the caller's account via enabled_only.

create_a_talkdesk_articles_type

Create a new article type in the Talkdesk Locations Directory shared catalog. Returns: id, name, display_name, description, content_type, json_schema, supported_link_patterns, ingestion_task_queue, ingestion_workflow_name, created_at, updated_at, GA. Required: name, display_name, content_type, supported_link_patterns.

get_single_talkdesk_articles_type_by_id

Get a single Talkdesk Locations Directory article type by id. Returns: id, name, display_name, description, content_type, json_schema, supported_link_patterns, ingestion_task_queue, ingestion_workflow_name, created_at, updated_at, GA. Required: id.

update_a_talkdesk_articles_type_by_id

Update the ingestion routing config for a Talkdesk article type by id. Only ingestion_task_queue and ingestion_workflow_name can be changed; provide both together or both null to clear. Returns: id, name, display_name, content_type, json_schema, supported_link_patterns, ingestion_task_queue, ingestion_workflow_name, and 3 more. Required: id.

delete_a_talkdesk_articles_type_by_id

Delete a Talkdesk Locations Directory article type by id. Returns an empty 204 response on success. Cannot delete an article type while articles of that type still exist. Required: id.

delete_a_talkdesk_external_source_document_by_id

Delete a document from a Talkdesk Knowledge Management external source by id. Only valid for CUSTOM-type external sources; attempts on other source types are rejected with a 400 error. Returns an empty 204 response on success. Required: id, external_source_id, doc_id.

update_a_talkdesk_external_source_document_by_id

Upsert a document in a Talkdesk Knowledge Management external source — inserts it if no document with the given id exists, updates it otherwise. Only valid for CUSTOM-type external sources. Returns an empty 204 response on success. Required: id, external_source_id, doc_id, url, title, content, created_at.

create_a_talkdesk_industries_messaging_service_email

Send an email via the Talkdesk Industries Messaging Service. Returns the email identifier string on success. Required: subject, from, to, content. The `to` array accepts between 1 and 1000 recipients.

create_a_talkdesk_industries_messaging_service_message

Send a message via the Talkdesk Industries Messaging Service. Returns the created message's id. Required: body, contact_phone_number, talkdesk_phone_number.

talkdesk_industries_scheduler_appointments_bulk_update

Update a Talkdesk scheduler appointment by event ID and send an SMS notification to the client. Returns the updated appointment including id, account_id, calendar_event_id, start, end, team_member, conference_link, and reschedule_count. Required: event_id, appointment_dto.

create_a_talkdesk_industries_scheduler_appointment

Create a Talkdesk scheduler appointment and notify the client via SMS. Returns the created appointment including id, account_id, calendar_event_id, start, end, team_member, conference_link, and reschedule_count. Required: member_email, start, team_id, sms_notification, client_name, client_email.

list_all_talkdesk_industries_scheduler_appointments

List Talkdesk scheduler appointments associated with the account. Returns items including id, account_id, team_member, calendar_event_id, start, end, team_id, conference_link, and reschedule_count.

create_a_talkdesk_industries_scheduler_availability

Get availabilities for one or more team members in Talkdesk by submitting their emails and working time windows. Returns an array of availability objects, each including id, calendar_id, and free_time_periods (unix epoch timestamps in milliseconds). Required: team_members, meeting_duration, working_time.

list_all_talkdesk_industries_scheduler_teams

Get all teams associated to a Talkdesk Industries Scheduler account. Returns a paginated collection containing _embedded.teams (each with id, topic, account_id, and sub_topics), total team count, and _links for navigation.

list_all_talkdesk_industries_workflows

List Talkdesk industry workflows for the authenticated account, with optional filters by workflow_name, job_name, status, time ranges, and tags. Returns per workflow: id, workflow_name, status, tags, created_at, progress, schedule_id, and cron_expression.

create_a_talkdesk_industries_workflow

Start a new Talkdesk industry workflow. Returns: id. Required: workflow_name, task_queue.

get_single_talkdesk_industries_workflow_by_id

Get the detailed state of a Talkdesk industry workflow by id, including its actions and associated schedule. Returns: id, run_id, workflow_name, job_name, status, created_at, started_at, completed_at, next_run_at, tags, progress, payload, actions, schedule, GA. Required: id.

update_a_talkdesk_industries_workflow_by_id

Cancel or terminate a running Talkdesk industry workflow by id by transitioning it to CANCELLED or TERMINATED. Returns the updated workflow object including id, workflow_name, status, payload, actions, and schedule. Required: id, status.

get_single_talkdesk_ingestion_download_url_by_id

Get a short-lived presigned download URL for the source file originally uploaded with an article ingestion job in Talkdesk. Returns: url, expires_at, GA. The URL expires at expires_at; call this endpoint again to obtain a fresh link rather than caching the returned one. Required: id.

create_a_talkdesk_interaction_custom_field

Publish interaction custom fields to the Talkdesk Custom Fields Report for a given interaction. Returns an empty 204 response on success. Required: interaction_id.

list_all_talkdesk_knowledge_management_external_sources

Search Talkdesk Knowledge Management external sources with optional filters. Returns: details, id, enabled, EarlyAccess. Supports filtering by query_by_name, metadata, connector_type, status, last_sync_after, and last_sync_before.

create_a_talkdesk_knowledge_management_external_source

Create a new external source in Talkdesk Knowledge Management. Returns the created record including id, enabled, and details (name, knowledge_type, knowledge_segments, ring_groups, metadata). Required: details, enabled.

get_single_talkdesk_knowledge_management_external_source_by_id

Get a single Talkdesk Knowledge Management external source by id. Returns: details, id, enabled, EarlyAccess. Required: id.

update_a_talkdesk_knowledge_management_external_source_by_id

Update an external source in Talkdesk Knowledge Management by id. Returns the updated record including id, enabled, and details (name, knowledge_type, knowledge_segments, ring_groups, metadata). Required: id, name, knowledge_type.

delete_a_talkdesk_knowledge_management_external_source_by_id

Delete an external source in Talkdesk Knowledge Management by id. Returns an empty 204 response on success. Required: id.

list_all_talkdesk_locations_directory_articles

List Talkdesk locations-directory articles in paginated form. Returns: id, type_id, content, tags, links, created_at, updated_at. Optionally filter by type, location, service, staff, or tags. Setting exact_links=true requires at least one of location, service, or staff.

create_a_talkdesk_locations_directory_article

Create a new article in the Talkdesk locations directory. Returns the created article including id, type_id, content, tags, links, created_at, and updated_at. Required: type_id, content, links. Fails with 409 Conflict when an article of the same type already exists for a SINGLE-cardinality linked entity.

get_single_talkdesk_locations_directory_article_by_id

Get a single Talkdesk locations-directory article by id. Returns: id, type_id, content, tags, links, created_at, updated_at, GA. Required: id.

delete_a_talkdesk_locations_directory_article_by_id

Soft-delete a Talkdesk locations-directory article by id. The article stops appearing in list and get responses immediately. Returns an empty 204 response on success. Required: id.

talkdesk_locations_directory_articles_bulk_create

Bulk upsert up to 100 articles in one call in the Talkdesk locations directory, creating or versioning articles keyed by their link tuple identity. Returns: created, versioned, skipped, results, GA. Required: version_token, source_key, articles. The entire batch is applied all-or-nothing; any validation failure rejects the whole batch.

create_a_talkdesk_locations_directory_batch

Apply a batch of UPSERT and DELETE operations across LOCATION, SERVICE, STAFF, and ARTICLE entities in Talkdesk in a single all-or-nothing transaction. Returns results array with entity_type, operation, id, and optionally external_id or version per submitted operation. Required: operations. Max 100 operations per call.

list_all_talkdesk_locations_directory_staffs

List staff members in the Talkdesk Locations Directory with optional filters. Returns: id, name, description, contacts, job_title, manager, pronouns, specialities, external_id, industry, photo_url, gender, status, date_of_birth, date_of_hire, languages, attributes, relationships, visit_types, tags, custom_fields, provenance.

create_a_talkdesk_locations_directory_staff

Create a new staff member in the Talkdesk Locations Directory. Returns: id, name, description, contacts, job_title, manager, pronouns, specialities, external_id, industry, photo_url, gender, status, date_of_birth, date_of_hire, languages, attributes, relationships, visit_types, tags, custom_fields, provenance. Required: name.

get_single_talkdesk_locations_directory_staff_by_id

Get a single staff member from the Talkdesk Locations Directory by id. Returns: id, name, description, contacts, job_title, manager, pronouns, specialities, external_id, industry, photo_url, gender, status, date_of_birth, date_of_hire, languages, attributes, relationships, visit_types, tags, custom_fields, provenance, GA. Required: id.

update_a_talkdesk_locations_directory_staff_by_id

Fully replace a staff member's data in the Talkdesk Locations Directory by id. Returns: id, name, description, contacts, job_title, manager, pronouns, specialities, external_id, industry, photo_url, gender, status, date_of_birth, date_of_hire, languages, attributes, relationships, visit_types, tags, custom_fields, and 2 more. Required: id, name.

talkdesk_locations_directory_staffs_bulk_delete

Bulk delete multiple staff members from the Talkdesk Locations Directory by providing an array of staff IDs. Returns an empty 204 response on success. Required: staff_ids.

list_all_talkdesk_locations_directory_staffs_agents

List Talkdesk Locations Directory staffs for the agent view, paginated and filtered by location. Returns: count, total, page, per_page, total_pages, _embedded, _links, EarlyAccess. Required: location_id.

talkdesk_omnichannel_interactions_bulk_delete

Bulk delete omnichannel interactions of a given resource type in Talkdesk. Returns: id, has_errors, errors, total_deleted, total_errors. Required: resource_type, interaction_ids.

list_all_talkdesk_staffs_genders

List staff genders from the Talkdesk Locations Directory. Returns: count, total, page, per_page, total_pages, _embedded, _links, EarlyAccess. Optionally filter by gender using a fuzzy-match search via the gender parameter.

list_all_talkdesk_staffs_specialities

List staff specialities in Talkdesk's Locations Directory. Returns: count, total, page, per_page, total_pages, _embedded, _links, EarlyAccess. Optionally filter by speciality (fuzzy search), location_id, service_id, service_names, or cities.

list_all_talkdesk_staffs_specialities_services_locations

List paginated staff specialities with their associated services and locations in Talkdesk's Locations Directory. Returns: count, total, page, per_page, total_pages, _embedded, _links. Filter by zip_code, city, country_name, region_name, speciality, location attributes, or staff attributes.

get_single_talkdesk_workflow_progrese_by_id

Get the completion progress of a Talkdesk industries workflow by id. Returns: id, overall_percentage, actions, _links, GA. Required: id.

list_all_talkdesk_workflows_schedules

List all workflow schedules owned by the authenticated Talkdesk account. Returns: id, workflow_name, job_name, cron_expression, start_at, payload, is_paused, created_at, next_run_time. Up to 100 items per page.

create_a_talkdesk_workflows_schedule

Create a new Talkdesk workflow schedule that triggers a configured workflow on a cron expression or one-shot start time. Returns: id. Required: workflow_name, task_queue.

delete_a_talkdesk_workflows_schedule_by_id

Permanently delete a Talkdesk workflow schedule by id. Returns an empty 204 response on success. Required: id.

update_a_talkdesk_workflows_schedule_by_id

Pause or resume a Talkdesk workflow schedule by id. Updates only the paused state of an existing schedule. Returns an empty 200 response on success. Required: id, is_paused.

list_all_talkdesk_account_licenses

List account licenses in Talkdesk. Returns paginated license records including id, license_id, account_id, product_id, pricing, quantity, start_date, end_date, revision, model, seat_limit, and 3 more fields. Use revision_status to filter by active, last, upcoming, or all revisions; use expand to include product apps, connectors, and assets.

list_all_talkdesk_account_subscriptions

Get the aggregated subscription details for the Talkdesk account. Returns: account_id, subscription_product_name, agent_license_count, duration, duration_units, start_at, finish_at, auto_renew, _links.

get_single_talkdesk_campaign_contact_by_id

Get campaign contact record information from Talkdesk by campaign and record id. Returns: id, campaign_id, contact_name, campaign_records, GA. Required: id, campaign_id, record_id.

create_a_talkdesk_campaign_message

Send bulk campaign messages in Talkdesk via SMS or EMAIL channels. Returns: id, bulk_id, campaign_id, _links, EarlyAccess. Required: bulk_id, campaign_id, campaign_info, callback_url, domain, bindings.

create_a_talkdesk_execute_action

Execute a digital connection action in Talkdesk by specifying the target message, connection, and action to perform, with optional contact attributes. Returns an empty 204 response on success. Required: message_id, connection_id, action_id.

create_a_talkdesk_exports_conversation

Submit an asynchronous bulk export of Talkdesk AI Agent conversations for a time window. Returns: export_id, status, EarlyAccess. Required: from, to. Window must not exceed 30 days per request — split larger ranges into multiple exports.

get_single_talkdesk_exports_conversation_by_id

Poll a previously submitted Talkdesk AI Agent conversations export by id. When ready, returns a gzip-compressed NDJSON stream — one interaction per line — including interaction_id, channel, interaction_started, interaction_ended, turns (with tool-call and message records), and more. Returns status "processing" while still preparing; poll at…

get_single_talkdesk_filter_by_id

Get Talkdesk Industries Settings configurations for a given service and type, returning all matching configurations grouped as a map of key-value pairs. Returns: id, bank_url, show_cobrowse_button, GA. Required: service, type.

list_all_talkdesk_filters

List Talkdesk Industries Settings configurations for a given service, type, and specific type identifier, returning matching configurations grouped as a map of key-value pairs. Returns: id, bank_url, show_cobrowse_button. Required: service, type, type_id.

get_single_talkdesk_guarantor_billing_by_id

Get the billing summary for a guarantor in Talkdesk. Returns: id, account_type, billing_system, credit_score, is_paperless, patient_is_guarantor, patients, professional_billing, hospital_billing, single_billing_office, propensity_to_pay, and 5 more. Required: id, guarantor_id. At least one of patient_id or self_service_id must be provided.

create_a_talkdesk_guarantor_password_reset

Send a password reset request to a guarantor's healthcare portal (e.g., MyChart) in Talkdesk. This provider-agnostic endpoint works across different EHR systems. Returns an empty 204 response on success. Required: guarantor_id, delivery_method.

list_all_talkdesk_healthcare_guarantors

List upstream EHR identifiers that uniquely reference a guarantor in Talkdesk Healthcare. Returns each identifier's id and type (e.g., MRN, CSN). Required: guarantor_id.

talkdesk_license_seats_bulk_create

Bulk assign and/or release license seats for multiple users in Talkdesk. Returns: available, assigned. Required: license_id. Limited to 10,000 user operations per call; the license must be active and seats must be available for users being assigned.

talkdesk_license_seats_bulk_delete

Remove a user's seat for a given license in Talkdesk. Returns an empty 204 response on success. Required: license_id, user_id.

create_a_talkdesk_license_seat

Assign a license seat to a specified user in Talkdesk. Returns the seat record including id, account_id, license_id, user_id, and created_at. Required: license_id, user_id.

list_all_talkdesk_license_seats

List all seats assigned to a given license in Talkdesk. Returns each seat's id, account_id, license_id, user_id, and created_at. Required: license_id.

list_all_talkdesk_license_users

List users for a Talkdesk license with a flag indicating whether each user has an assigned seat. Returns: id, email, name, active, created_at, role_id, role, confirmed, team, team_id, seat, gender, extension, external_phone_number, _links. Required: license_id.

create_a_talkdesk_licenses_seat

Assign seats to users in Talkdesk from any available license. Returns a result array where each entry contains user_id, success, and (on failure) error with code and message indicating the per-user outcome. Required: user_ids. Accepts 1–100 user IDs per request.

delete_a_talkdesk_licenses_seat_by_id

Remove the existing seat assignments for a Talkdesk user by id. Returns an empty 204 response on success. Required: id.

create_a_talkdesk_locations_directory_bulk

Bulk add or update locations, services, or staff members in Talkdesk by uploading a CSV file. The file is accepted and processed asynchronously. Returns a 202 Accepted response with no body on success. Required: directory_type, file.

create_a_talkdesk_outbound_notification

Send outbound notification messages at scale in Talkdesk through WhatsApp or SMS channels using content or template message types. Returns: bulk_id, messages. Required: channel, sender, messages.

list_all_talkdesk_patient_practices

List the appointment practices for a Talkdesk healthcare patient. Returns: id, name, patient_id, appointment_date_time. Required: patient_id.

list_all_talkdesk_patients_locations

List patients' last known locations in Talkdesk Healthcare. Returns: id, external_id, location_id, admitted_date. Supports optional filters including patient_id, external_id, first_name, last_name, birth_date, gender, mrn, ssn, and zipcode.

list_all_talkdesk_seats_users

List Talkdesk users who have an assigned seat for a given asset. Returns a paged collection of user records including id, email, name, active, seat, role, role_id, confirmed, team, team_id, created_at, and optionally license_ids when expand is true. Required: asset_type, asset_id.

get_single_talkdesk_subscription_license_by_id

Get detailed information about a specific Talkdesk subscription license by id. Returns: id, product_rate_plan_id, product_rate_plan_name, friendly_name, product_family, product_rate_plan_description, billing_period, quantity, price, currency, self_service, model, multiplier, seat_limit, seats_in_use, start_at, finish_at, and 3 more. Required: id.

list_all_talkdesk_subscription_licenses

List all subscription licenses associated with the Talkdesk account subscription. Returns: id, friendly_name, billing_period, quantity, price, self_service, product_family, next_billing_date, seats_in_use, manageable_seats, model, multiplier, seat_limit, _links.

get_single_talkdesk_voicemail_transcription_by_id

Get the text transcription for a specific Talkdesk voicemail by id. Returns: text, EarlyAccess. Required: id.

update_a_talkdesk_voicemail_by_id

Update a Talkdesk voicemail by id, modifying its resolved status, user assignment, or linked contact. Returns the updated voicemail object including id, interaction_id, created_at, duration, resolved, talkdesk_phone_number, contact_phone_number, ring_groups, and automation details. Required: id.

list_all_talkdesk_voicemails

List Talkdesk voicemails for the authenticated account with optional filtering by status, assignment, user, date, ring group, and phone number. Returns: id, interaction_id, created_at, duration, resolved, number_id, talkdesk_phone_number, contact_phone_number, contact_id, user_id, ring_groups, automation, _links. Required: page, per_page.

get_single_talkdesk_voicemails_voicemail_by_id

Get a single Talkdesk voicemail by id. Returns: id, interaction_id, created_at, duration, resolved, number_id, talkdesk_phone_number, contact_phone_number, contact_id, user_id, ring_groups, automation, _links. Required: id.