Skip to main content
POST
Create a new checklist with items

Authorizations

Authorization
string
header
required

Owner-scoped bearer token. The owner a request is scoped to is derived from the token; list endpoints also take an explicit owner query parameter your token must be authorized to read.

Body

application/json
owner
string
required

The ID of the owner

displayName
string
required

Name of the QC checklist

checklistItems
object[]
required

The list of items to include in the checklist

description
string

A longer description of the QC checklist.

checklistType
enum<string>

The type of checklist. Defaults to quality when omitted.

Available options:
quality,
review
groupType
enum<string>

The type of numbering used for this checklist's groups. Only applicable when checklistType is review. If omitted, the type is instead established by the first group later created on this checklist.

Available options:
alphanumeric,
numeric
roles
object[]

Roles associated with the QC checklist.

Response

Checklist created successfully

id
string<uuid>
required

Unique identifier for the QC checklist

createdOn
string<date-time>
required

Timestamp when the QC checklist was created

displayName
string
required

Name of the QC checklist

checklistItems
object[]
required
archivedOn
string<date-time>

Timestamp when the QC checklist was archived

description
string

A longer description of the QC checklist.

version
string

The version of the checklist

groupType
enum<string>

The type of numbering used for this checklist's groups. Only set once the checklist has at least one group.

Available options:
alphanumeric,
numeric
roles
object[]

Roles associated with the QC checklist.

groups
object[]

Groups associated with the QC checklist. Only applicable to review type checklists.