post https://api.talkdeskapp.com/cm/core/va/cases
Scope
cases-public:write
Request Parameters Sample
{
"title": "test title",
"description": "test description",
"priority": "LOW",
"requester_name": "[email protected]",
"requester_email": "example",
"requester_type": "Contact",
"custom_fields": {
"checkbox1": true,
"dropdown1": "001",
"text1": "text desc",
"dependent_field1": ["3a20c48f-3e33-49b0-af22-63eba6fa4cc3","bbb2a5e7-6190-4eb1-b889-ec37e0badd0b","e9e3c93a-1b28-489a-96fe-6b3e9ca60976"],
"date1": "2022-04-21T06:30:21Z",
"numeric1": 1,
"decimal1": 1.2,
"multi_line_text1": "11\n22",
"multi_select1": ["002", "003"]
},
"notes":[
{
"note_title": "test subject",
"note_body": "test body",
"public": true
}
]
}
Body Response - Schema
201 (success - returns the case details after created)
| Parameter | Type | Description | Required |
|---|---|---|---|
| id | string | Case ID, the unique numeric identifiers given to each case. Starting from 1. | yes |
| title | string | case subject | yes |
| description | string | case description | yes |
| status | string | case status | yes |
| type | string | case type | no |
| priority | string | case priority | no |
| custom_fields | object | Fields added by users. Only the following enum fields are supported as prefixes: checkbox, dropdown, text, dependent_field, date, numeric, decimal, multi_line_text, multi_select | no |
| notes | array[object] | The notes of the array. "notes" subdivides into: 1 - "id" (string) - the unique numeric identifiers given to each note 2 - "note_title" (string) 3 - "note_body" (string) 4 - "public" (boolean) - is true if any notes are public, false otherwise. Defaults to true. | no |
| requester_id | string | Case requester id. | yes |
| requester_name | string | Case requester name. | yes |
| requester_email | string | Case requester email. | yes |
| requester_type | string | Default value is Contact. |
400 (bad request), 401 (unauthorized access - invalid or unverifiable JWT), 403 (forbidden)
| 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 Case API has been in GA since October 2023.
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.