/tasktemplates/{templateId}

patch

https://api.dev.orbit.do/v5/tasktemplates/{templateId}

Update a task template. Send any subset of the create body's fields; omitted fields keep their stored value, and optional fields (filter, taskDescription, form, dueDateRule, documentTemplateId) are cleared by sending null. The merged result is re-validated as a whole, so changing the trigger re-checks the stored Liquid expressions and filter against the new trigger's data objects. Existing tasks are never touched; setting status to 'inactive' pauses future firing. key cannot be changed (400 TASK_TEMPLATE_KEY_IMMUTABLE). Send expectedVersion to refuse the write when the template changed since it was read (412 TASK_TEMPLATE_VERSION_MISMATCH).

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

templateId

string

required

The task template ID

Body Params

Fields to change; omitted fields keep their stored value. Optional stored fields (filter, taskDescription, form, dueDateRule, documentTemplateId) are cleared by sending null. key cannot be changed; expectedVersion guards against concurrent edits.

name

string

length between 1 and 200

Operator-facing name of the template (1-200 characters). Not required to be unique.

key

string | null

Read-only after creation. Any value here, even the stored one or null, is rejected with 400 and internalCode TASK_TEMPLATE_KEY_IMMUTABLE; omit the field.

status

string

enum

Initial lifecycle status. 'inactive' creates the template paused. Defaults to 'active'.

Allowed:

trigger

When this template is considered: a curated platform trigger naming a business fact (tour created, tour assigned, stop arrived, tour completed, shipment created).

filter

object | null

Optional condition narrowing which trigger occurrences fire this template. A react-querybuilder rule group: { combinator: 'and' | 'or', rules: [...] }, where each rule is { field, operator, value } or a nested group. Rule fields are dotted paths into the trigger's data objects (e.g. 'tour.regionId'). Omit to fire on every occurrence. A filter that fails to evaluate creates no task.

taskName

string

length between 1 and 200

Name of the created tasks (1-200 characters). May contain Liquid template expressions over the trigger's data objects, resolved when the task is created (e.g. 'Check pallets for {{ tour.name }}').

taskDescription

string | null

form

object | null

A form definition: steps of typed elements, optionally shown conditionally. The task's outcome is validated against it on completion.

assigneeRule

Who the created tasks are assigned to.

dueDateRule

isSkippable

boolean

Whether the created tasks may be skipped. Defaults to false.

isBlocking

boolean

Whether open tasks from this template block the flow they gate (e.g. stop completion in the driver app). Defaults to false.

notifications

object

Per-template notification behavior for created tasks. Defaults to notifying on assignment and not sending due-soon reminders.

requiresHuman

boolean

When true, completion of the created tasks is accepted only from a signed-in human user; machine actors (API keys, automations, agents) are rejected. Defaults to false.

documentTemplateId

string | null

expectedVersion

integer

≤ 9007199254740991

The version the client last read. When present, the write is rejected with 412 and internalCode TASK_TEMPLATE_VERSION_MISMATCH if the stored template has changed since, so two editors cannot silently overwrite each other. Omit to write unconditionally.

Responses

400

bad request - invalid template definition

401

unauthorized

404

task template not found

409

conflict - template was deleted, or modified by another request

412

precondition failed - expectedVersion does not match the stored version (internalCode TASK_TEMPLATE_VERSION_MISMATCH)

Language

Credentials

Header

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200The updated task template