Create a new Job Checklist

post

https://api.servicem8.com/api_1.0/jobchecklist.json

OAuth Scope

This endpoint requires the following OAuth scope manage_job_checklists.

Record UUID

UUID is optional for record creation. If no UUID is supplied, a UUID will be automatically generated for the new record and returned in the x-record-uuid response header.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Job Checklist record to create

uuid

Unique identifier for this record

job_uuid

uuid

UUID of the job this checklist item belongs to. This links the checklist item to a specific job in the system.

name

string

length ≤ 512

The name or description of the checklist item. This is displayed to users in the mobile app and web interface.

section_name

string

length ≤ 256

The section or category name under which this checklist item is grouped. This helps organize related checklist items together.

item_type

string

The type of checklist item. Valid values are: 'Todo', 'Asset', 'Photo', 'Form', and 'Document'. Defaults to 'Todo' if not specified. This determines the functionality and appearance of the checklist item.

sort_order

integer

A numeric value determining the order in which checklist items appear in the user interface. Lower values appear first. Used to customize the display sequence of items.

completed_timestamp

string

The date and time when the checklist item was marked as completed. Empty or '0000-00-00 00:00:00' indicates the item is not completed.

completed_by_staff_uuid

uuid

UUID of the staff member who completed this checklist item. References a Staff object. Empty if the item is not completed.

completed_during_checkin_uuid

uuid

UUID of the job check-in during which this checklist item was completed. This links the checklist completion to a specific check-in event in the job history.

reminder_type

string

The type of reminder associated with this checklist item. Valid values are: '' (no reminder), 'CHECK_IN', 'NAVIGATE', 'CHECK_OUT', 'ABSOLUTE_DATETIME', or 'RELATIVE_DATETIME'. Determines when the system will remind users about this checklist item.

reminder_data

JSON data containing additional information for the reminder. Format depends on the reminder_type. For ABSOLUTE_DATETIME, includes 'absoluteDateTime'. For RELATIVE_DATETIME, includes 'relativeDateTime' with 'baseDate', 'unit', and 'quantity'. Exposed via API as 'reminder_data'.

regarding_object

string

The type of object which this checklist item is related to. For example, for Form checklists, this will be 'Form'.

regarding_object_uuid

uuid

The UUID of the object which this checklists item is related to. For example, for Form checklists, this is the UUID of the Form that must be completed to complete the checklist item.

fulfilled_by_object_name

string

The type of object which completes this checklist item. For example, for Form checklists, this will be 'FormResponse'.

fulfilled_by_object_uuid

uuid

The UUID of the object which completes this checklist item. For example, for Form checklists, this references the UUID of a FormResponse record.

assigned_to_staff_uuids

array of strings

length ≤ 1

JSON array of staff UUIDs to whom this checklist item is assigned. Determines which staff members are responsible for completing this checklist item. Currently limited to a maximum of 1 staff member.

assigned_to_staff_uuids

Responses

200Success

400Bad Request - The request is malformed or contains invalid parameters

401Unauthorized - Authentication credentials are missing or invalid

403Forbidden - You don't have permission to create this resource

429Too Many Requests - You have exceeded the rate limit

500Internal Server Error - An unexpected error occurred on the server