Skip to main content

TaskUpdateRequest

Request body for PATCH /tasks/{id}.

All fields are optional, but at least one must be provided. The validator raises a parameter_error if the request is empty.

Allowed changes: condition_version — rebind to a new version of the same condition delivery — change delivery channel/endpoint/etc. entity_scope — change the evaluated entity or group status — pause (paused) or resume (active) only

Forbidden changes (rejected by TaskStore.update() with HTTP 400): concept_id, concept_version, condition_id, action_id, action_version These require creating a new task via POST /tasks.

condition_version object
anyOf
string
delivery object
anyOf
typeDeliveryType (string)required

Possible values: [webhook, notification, email, workflow]

endpoint object
anyOf
string
channel object
anyOf
string
workflow_id object
anyOf
string
entity_scope object
anyOf
string
status object
anyOf
MutableTaskStatus (string)

Subset of TaskStatus that a PATCH request is allowed to set.

Deletion is a dedicated DELETE endpoint, not a status update. preview cannot be set via PATCH — it is only produced by dry_run.

Possible values: [active, paused]

TaskUpdateRequest
{
"condition_version": "string",
"delivery": {
"type": "webhook",
"endpoint": "string",
"channel": "string",
"workflow_id": "string"
},
"entity_scope": "string",
"status": "active"
}