Update the Talkdesk contact information fields with the information of the FSI member. To get the Talkdesk contact, it is required to provided one of the query parameters: contact_id or phone_number. When the contact_id is provided, the Talkdesk contact to be updated will be found by the contact_id. When the phone_number is provided, Talkdesk contact to be updated will be found if only one match of the phone number exists in the Contact API. The update process will only occur if a Talkdesk contact is retrieved and exists one FSI member with identifier equals to member_id. The Talkdesk contact information that may be updated will be:
- Name.
- Address.
- Email.
- Phone numbers.
Scope
fsi-workspace-contact-synchronization:write
Body Response - Schema
400 (bad request), 401 (unauthorized), 403 (forbidden), 404 (not found), 422 (unprocessable entity)
| Parameter | Type | Description | Required |
|---|---|---|---|
| code | string | n/a | yes |
| message | string | n/a | yes |
| description | string | n/a | no |
| fields | array[object] | "fields" subdivides into: "name" (string) "description" (string) | yes (name and description) |
API Availability
The FSI Integrations API is only available for customers enrolled in Talkdesk's Early Access (EA) program.
To enter the EA program, contact a Customer Success Manager.The FSI Integrations API has been in EA since December 2022.
Troubleshooting
If you have any questions regarding the usage of this API, or if you’re having any technical issues, please open a ticket using this form.