---
title: "Create Checklists"
method: POST
path: "/settings/checklist"
---

# Create Checklists

`POST /settings/checklist`

## Request

- Base URL: `https://dc-region.zuperpro.com/api`
- URL: `https://dc-region.zuperpro.com/api/settings/checklist`
- Auth: API key in header `x-api-key`

## Request body

- object
  - `category_uid` string, required: Job Category UID
  - `job_status_uid` string, required: Job Status UID
  - `checklist` object[], required
    - `label` string, required: field_name
    - `component` 'textInput' | 'textArea' | 'checkbox' | 'select' | 'barcode' | 'image' | 'multi_image' | 'radio' | 'dateInput' | 'timeInput' | 'dateTimeInput' | 'lookUp' | 'signature' | 'header' | 'table' | 'video' | 'number' | 'file'
    - `description` string
    - `placeholder` string
    - `meta_data` object
    - `options` string[]
    - `required` boolean
    - `hide_to_fe` boolean
    - `is_dependent` boolean
    - `dependent_on` string
    - `dependent_options` string[]
    - `validation` string: [number]/[regex]
    - `hide_field` boolean
    - `min_value` string: if validation is "[number]"
    - `max_value` string: if validation is "[number]"
    - `regex_value` string: if validation is "[regex]"
    - `meta_options` object
      - `restrict_to_camera` boolean
      - `watermark_image` boolean
      - `watermark_timestamp` boolean
      - `watermark_geo_cords` boolean
      - `restrict_status_update` object
        - `is_enabled` boolean
        - `restricted_options` string[]
        - `message` string
    - `restrict_status_update` object
      - `is_enabled` boolean
      - `restricted_options` object: if restricted_options inside meta_data is ["value one"] then here it should be {value one: true}
    - `read_only` boolean
    - `default_option` boolean
    - `default_options` string[]
    - `lookup_module` 'JOB' | 'CUSTOMER' | 'EMPLOYEE' | 'ESTIMATE' | 'INVOICE' | 'PRODUCT' | 'JOB_PRODUCT' | 'PURCHASE_ORDER' | 'SERVICE_CONTRACT' | 'ASSET' | 'PROPERTY' | 'ORGANIZATION': if component is lookUp
    - `checklist_view_type` 'SINGLE_PAGE' | 'MULTI_PAGE'
  - `prefill_checklist` boolean

## Response `200`

200

- object
  - `type` string
  - `title` string
  - `message` string

## Other responses

- `500`: 500

## Changes

- **2026-11-03** `3c21bc232e16`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/zuper/apis/zuper-pro-api/changes/settings/checklist/post.md)

---

[API](https://skmtc.dev/zuper/apis/zuper-pro-api.md) - [All operations](https://skmtc.dev/zuper/apis/zuper-pro-api/llms.txt) - [OpenAPI document](https://skmtc.dev/zuper/apis/zuper-pro-api/revisions/3c21bc232e16?raw)