GEgetsales
tasks

Update task

Edit a task and move it between states: done completes it, canceled discards it, open reopens a done task and clears the pick. A task carrying options closes with chosen_option_id. A play's draft (kind play_draft) closes done with its words as edited in draft, or canceled (the play skips them); a play's question (kind play_question) closes done with the chosen option, and with workflow_sid when its key is move or add and play_ref names no workflow. Empty patch: 422 nothing_to_update.

Contract:

  • MCP tool update_task, registry package mcp.unibox/tasks, mount unibox.inbox.
  • Operation update, response envelope update.
  • Flags: none.
patch/api/tasks/{sid}

Request

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

Path parameters

sidstring required

Task sid (ub_tk_…).

Request body

titlestring

Replacement title, 1..255 chars.

bodystring nullable

Replacement detail (full replace); null clears it.

due_atstring nullable

ISO 8601 UTC deadline; null clears the deadline and takes the task out of the due sweep.

expires_atstring nullable

ISO 8601 UTC, after now (422 otherwise): the new instant the sweep cancels the open task at; null takes the expiry off. A close (done or canceled) clears it, and so does a reopen past it.

state'open' | 'done' | 'canceled'

done = complete it (completed_at stamped), canceled = discard it, open = reopen it (completed_at and the pick cleared). The service applies the value it is given; it runs no transition guard.

assignee_user_sidstring nullable

Reassign the work; null unassigns it.

chosen_option_idinteger nullable

The arm picked from options. Required with state=done on a task that carries options, and refused (422 chosen_option_id) on one that does not or for an id outside the list.

draftstring nullable

A play's draft, as edited (2026-10-14): the words that go when the task closes done. Kept on any other task but meaningless there.

workflow_sidstring nullable

A play's question only: the workflow a move or an add puts the person into (play_ref.workflow_sid). Required with state done when the chosen option's key is move or add and the ref names none (422 workflow_sid); 422 on a task that is no play's question.

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.