POST /api/v2/tickets/{ticket_id}/task_lists
Adds a task list to the specified ticket. There are two ways to create a task list:
Create from a template: Include task_list_template_id in the request body. The new task list will inherit the template's name, description, and task items.
Create a custom task list: Include name (and optionally description) instead of task_list_template_id. Custom task lists have no template and allow you to add, update, and delete task items individually.
Allowed For
- Agents
Servers
- https://{subdomain}.{domain}.com
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
ticket_id |
Integer | Yes |
The ID of the ticket |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
task_list |
Object | No |
To create a task list from a template, provide |
task_list.name |
String | No |
The name of the custom task list. Required if |
task_list.task_list_template_id |
String | No |
The id of the task list template to attach to the ticket. Required if not creating a custom task list. |
task_list.description |
String | No |
The description of the custom task list. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.