Skip to main content
PATCH
/
v1
/
checklists
/
{id}
Update a checklist
curl --request PATCH \
  --url https://api.lunary.ai/v1/checklists/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "slug": "updated-checklist-slug",
  "data": {
    "items": [
      {
        "name": "Run tests",
        "completed": true
      },
      {
        "name": "Update documentation",
        "completed": true
      },
      {
        "name": "Deploy to production",
        "completed": false
      }
    ]
  }
}
'
{
  "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>.

Path Parameters

​
id
string<uuid>
required

The ID of the checklist to update

Body

application/json
​
slug
string

Updated slug for the checklist

​
data
object

Updated checklist data

Response

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>