Update an offboarding checklist template item | Comp AI API

Updates an existing offboarding checklist template item by id, changing its label, description, or settings on the organization’s offboarding template.

PATCH /v1/offboarding-checklist/template/{id}

Update an offboarding checklist template item

cURL

curl --request PATCH \
  --url https://api.trycomp.ai/v1/offboarding-checklist/template/{id} \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "title": "<string>",
  "description": "<string>",
  "evidenceRequired": true,
  "sortOrder": 123,
  "isEnabled": true
}
'

Authorizations

apikeyoauth2

X-API-Key · string · header · required

API key for authentication

Path Parameters

id · string · required

Body

application/json

title · string

description · string

evidenceRequired · boolean

sortOrder · number

isEnabled · boolean

Response

200 - undefined