plans

updatePlan

Update a plan. versionTimestamp (optimistic locking) is the plan's updated_at in epoch milliseconds: listPlans and getPlan return it, and every write returns the new one. Pass fields (for example ["id", "versionTimestamp"]) for a short answer instead of the whole plan.

post/tools/updatePlan

Request

  • Base URL: https://api.stablebaseline.io/functions/v1/cloud-serve/api/v1
  • URL: https://api.stablebaseline.io/functions/v1/cloud-serve/api/v1/tools/updatePlan
  • Auth: HTTP bearer

Request body

projectIdstring

Optional. Narrows a friendly-id lookup to one project. Only needed when a friendly id is ambiguous — TAS-/IMP-/PLN- ids are numbered per PROJECT, so the same id can exist in several. Ignored when the id is a UUID.

planIdstring required
versionTimestampnumber required

The plan's current versionTimestamp (its updated_at in epoch ms), as listPlans, getPlan or your last write of it returned.

titlestring
descriptionstring
statusstring

Status: draft, planning, active, on_hold, completed, cancelled.

prioritystring

Priority: low, medium, high, critical.

iconstring
colorstring
start_datestring

YYYY-MM-DD.

end_datestring

YYYY-MM-DD.

linked_documentsobject[]
linked_document_idsstring[]

Document IDs to link.

metadataobject
fieldsstring[]

Optional. Answer with only these fields instead of the whole plan, for example ["id", "versionTimestamp"]. Any of the plan's own fields (snake_case or camelCase) or of the keys around it in the full answer (versionTimestamp, href and, where present, url, title, trackingId, message). The id is always returned, and so is any notice that needs your attention (a note, such as a phase's dates following its tasks or an item's id changing with its type, and a date change's cascadePreview). Unknown names are ignored.

Response

Tool result (shape varies per tool — refer to the tool's docs for the exact return value).

object required

Changes

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