Skip to main content
POST
/
v1
/
offboarding-checklist
/
template
Add an offboarding checklist template item
curl --request POST \
  --url https://api.trycomp.ai/v1/offboarding-checklist/template \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "title": "Collect access badges"
}
'
const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({title: 'Collect access badges'})
};

fetch('https://api.trycomp.ai/v1/offboarding-checklist/template', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
import requests

url = "https://api.trycomp.ai/v1/offboarding-checklist/template"

payload = { "title": "Collect access badges" }
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

Authorizations

X-API-Key
string
header
required

API key for authentication

Body

application/json
title
string
required

Checklist item title

Example:

"Collect access badges"

description
string

Guidance text for the admin

evidenceRequired
boolean

Whether evidence upload is required

Response

201 - undefined