Skip to main content
PUT
/
api
/
v1
/
task
/
checklists
/
{id}
Update Checklist Template
curl --request PUT \
  --url https://api.xenia.team/api/v1/task/checklists/{id} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'workspace-id: <api-key>' \
  --data '{
  "name": "templates name comes here",
  "ChecklistIndustryId": "a0584fcb-99a4-4fa1-9a6c-39cf6aeb2e10",
  "ChecklistTypeId": "f17c356e-577e-4c81-9f6a-efde14b1df55",
  "icon": {
    "icon": "Default",
    "color": "#FFA681"
  },
  "attachments": [],
  "checklistItems": [
    {
      "id": "95603094-6604-499b-92d9-195e9fbb4bd4",
      "description": "General Information",
      "order": 0,
      "type": "header",
      "attachments": [],
      "isImageOrNoteRequired": false,
      "isActive": true
    },
    {
      "id": "3efec7f6-06ef-4c48-be61-5bd2d9b2c9a8",
      "description": "Select Location",
      "order": 1,
      "type": "location",
      "attachments": [],
      "isImageOrNoteRequired": false,
      "options": {
        "isDefaultLocation": true
      },
      "isActive": true
    }
  ],
  "description": "description of template comes here",
  "FolderId": "2d15dce8-19c7-4969-a2b6-1696a08db09d"
}'
{
  "data": {
    "id": "921f520c-e4d7-4490-8bc1-f9585f98b6b2",
    "name": "templates name comes here",
    "description": "description of template comes here",
    "ChecklistItems": [
      {
        "id": "95603094-6604-499b-92d9-195e9fbb4bd4",
        "description": "General Information",
        "type": "header",
        "order": 0,
        "isActive": true
      },
      {
        "id": "3efec7f6-06ef-4c48-be61-5bd2d9b2c9a8",
        "description": "Select Location",
        "type": "location",
        "order": 1,
        "isActive": true,
        "options": {
          "isDefaultLocation": true
        }
      }
    ]
  },
  "meta": {}
}

Authorizations

Authorization
string
header
required
workspace-id
string
header
required

Headers

workspace-id
string<uuid>
required

Path Parameters

id
string<uuid>
required

Checklist template ID

Body

application/json
name
string
required
ChecklistIndustryId
string<uuid>
required
ChecklistTypeId
string<uuid>
required
icon
object
required
checklistItems
object[]
required
description
string
required
FolderId
string<uuid>
required
attachments
object[]

Response

200 - application/json

Checklist updated successfully

The response is of type object.

I