| ⚠️ Note |
|---|
| This API endpoint has been deprecated, please update to the latest version. |
Description
Create a case.
Request
HTTP Method: POST
| Parameter | Description |
|---|---|
| team_id | The team ID the case is within. |
| name | The case name. |
| description | Optional The case description. Supports markdown and mentioning users. To mention a user, use the notation <@user-2435>, replacing '2435' with the user ID. |
| priority | Optional The case priority - critical, high, medium, low or info. |
| status | Optional The case status - open or closed. |
| author_email | Optional The email of the user creating the cases. |
| assignee_emails | Optional An array of user email addresses to assign to the case. Case will automatically be assigned to the user associated with the API token if none provided. |
| tag_names | Optional An array of tag names. |
| record_ids | Optional An array of record IDs to add to the case. |
| opened_at | Optional ISO 8601 Timestamp representing the date and time the case was opened at. |
| resolved_at | Optional ISO 8601 Timestamp representing the date and time the case was resolved at. |
| metadata | Optional Case related metadata represented as key-value pairs. |
| team_case_buttons | Optional An array of team case buttons for downstream actions associated with the case. |
| closure_conditions | Optional An array of closure requirements in the form of a set of formula rules that need to evaluate to true to enable the closing of a case. |
Sample request
Response
A successful request will return a JSON object describing the created case.
Field description
| Parameter | Description |
|---|---|
| case_id | The case ID. |
| name | The case name. |
| description | The case description. |
| status | The case status - open or closed. |
| url | The case URL. |
| metadata | Case related metadata represented as key-value pairs. |
| author | An object describing the case author. |
| opened_by | An object describing the user who opened the case. |
| resolved_by | An object describing the user who resolved the case. |
| assignees | An array of users assigned to the case. |
| tags | An array of tags associated with the case. |
| team_case_actions | An array of team case actions taken within the case. |
| team | The team the case is within - ID & name. |
| team_case_buttons | An array of team case buttons for downstream actions associated with the case. |
| linked_cases | An array of cases linked to this case (IDs only). |
| opened_at | ISO 8601 Timestamp representing the date and time the case was opened at. |
| resolved_at | ISO 8601 Timestamp representing the date and time the case was resolved at. |
| created_at | ISO 8601 Timestamp representing the date and time the case was created at. |
| updated_at | ISO 8601 Timestamp representing the date and time the case was updated at. |
| records | An array of records associated with the case. |
| priority | The case priority - critical, high, medium, low or info. |
| closure_conditions | An array of closure requirements for the case. |
Sample response