post https://api.talkdeskapp.com/digital-connect/conversations
Create Digital Connect conversations
Scope
digital-connect:write
Body Request - Example
{
"touchpoint_id": "my-touchpoint-id",
"subject": "This is the subject I need to talk about",
"contact_person": {
"email": "[email protected]"
},
"context_parameters": {
"contact_name": "name",
"contact_phone": "+18445852205",
"contact_reason": "consulting products",
"website_location": "http://location.com"
},
"previous_messages": [
{
"type": "EXTERNAL",
"content": "How can I help you?",
"created_at": "2022-01-01T08:00:00+08:00"
},
{
"type": "USER",
"content": "I want to reset my account.",
"created_at": "2022-01-01T09:00:00+08:00"
}
]
}
Body Response - Schema
201 (success, creates a new conversation, or finds an existing one through its idempotency key, and returns its ID)
| Parameter | Type | Description | Required |
|---|---|---|---|
| id | string | ID for the created conversation. >= 1 characters <= 255 characters | no |
400 (malformed request), 401 (unauthorized), 403 (forbidden), 404 (not found), 409 (conflict)
| 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 Digital Connect 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 Digital Connect API has been in EA since April 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.