SmartMatchApp

Create Task Checklist

Add a new checklist group to a specific task. Checklist groups help organise task items into labelled sections.

Example Request:
curl "https://<your-agency>.smartmatchapp.com/api3/tasks/<task_id>/checklists/" \
    -u <token>: \
    -X POST \
    -d "title=Pre-call checklist"
Request Parameters:

title: Required. The name of the checklist group. Maximum 100 characters.

Example Success Response:
{
    "id": 1
}
Base Request:

Method: POST

Authentication: Basic Authentication. Requires a valid <token> passed.

Rate Limits:

10 requests within 10 seconds

Error Responses:
400 Bad Request

This error occurs if title is missing or exceeds 100 characters.
Possible errors: "this field is required", "ensure this value has at most 100 characters"
401 Unauthorized

This error occurs when the <token> is missing, invalid, or the API access is disabled.

Possible errors: "not authenticated" or "token is disabled" or "Agency API is disabled"
404 Not Found

This error occurs if the task with the specified ID does not exist.
Possible errors: "object does not exist"
405 Method Not Allowed

This error occurs if an HTTP method other than POST is used.
Possible errors: "wrong method"
429 Too Many Requests

This error occurs when the client has sent too many requests in a given amount of time, leading to rate limiting by the server.

Possible errors: "too many requests"
500 Server Error

Possible errors: "Internal server error"