Create a new checklist

Creates a new checklist with the provided slug, type, and data.

POST /v1/checklists

Create a new checklist

cURL

curl --request POST \
  --url https://api.lunary.ai/v1/checklists \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "slug": "pre-deployment-checklist",
  "type": "deployment",
  "data": {
    "items": [
      {
        "name": "Run tests",
        "completed": false
      },
      {
        "name": "Update documentation",
        "completed": false
      }
    ]
  }
}
'

200

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "slug": "<string>",
  "type": "<string>",
  "data": {},
  "projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "ownerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization · string · header · required

Use a project private API key via Authorization: Bearer <key>.

Body

application/json

slug · string · required

Unique identifier for the checklist within the project

type · string · required

The type of checklist

data · array · required

The checklist data

Response

200

application/json

Successful response

id · string<uuid>

slug · string

type · string

data · object

The checklist data

projectId · string<uuid>

ownerId · string<uuid>

createdAt · string<date-time>

updatedAt · string<date-time>