GEgetsales
workflow_tasks

Update workflow task

Edit a planned task before it runs: the rendered text (variables_snapshot, partial: the type's template fields, each within its cap) and/or scheduled_at (a past time = send now). Only status scheduled; pending (edit the inbox task), dispatched or terminal is 409 invalid_transition. Find the task via search (people_sid, status eq scheduled) and read variables_snapshot first. Not for changing the step for everyone: update_workflow draft_steps, then publish.

Contract:

  • MCP tool update_workflow_task, registry package mcp.playtables/workflow_tasks, mount playtables.journeys.
  • Operation update, response envelope update.
  • Flags: none.
patch/api/workflow-tasks/{sid}

Request

  • Base URL
    https://beta.getsales.io/playtables/v1
  • Auth
    HTTP bearer and API key in header Team-SID

Path parameters

sidstring required

Workflow task sid (wf_tk_…).

Request body

variables_snapshotobject

Partial: the rendered text fields to replace, keyed by the type's template field (message / subject / body / comment / prompt / title / instructions). Unknown keys and over-cap values → 422.

scheduled_atstring date-time

When the task may run (ISO 8601). A past time clamps to now = "send now".

Response

update success envelope.

successtrue required
operation'update' required
updated_fieldsstring[] required
previous_valuesobject required
kept_fieldsstring[]

The fields this write did not change because the person's own value stands on them (stamped person); read the item for what landed.

Changes

No recorded changes to this operation across all 1 revision of this API.