Skip to main content
POST
Send a checklist to a client

Authorizations

Authorization
string
header
required

A firm API key, shown once when it is made, or a connected app’s OAuth access token. Each operation lists the scope it needs, such as clients:write.

Path Parameters

client
string
required

The client id, from list_clients.

Required string length: 1 - 60

Body

application/json
template_id
string | null

A checklist template to copy. Leave out to send name and items instead.

Required string length: 1 - 60
name
string | null
Maximum string length: 120
items
object[] | null

Response

Created.

object
enum<string>
required
Available options:
checklist
id
string
required
client_id
string
required
name
string
required
template_id
string | null
required
sent_at
string | null
required

An ISO 8601 time in UTC.

progress
object
required
complete
boolean
required

Every required item is done.

items
object[]
required