update_plan

Partial update of a plan: mutable fields and stage transitions.

Input Schema

{
  "type": "object",
  "required": [
    "plan_uuid"
  ],
  "properties": {
    "title": {
      "type": "string",
      "description": "Optional. New title."
    },
    "prompt": {
      "type": "string",
      "description": "Optional. Updated content prompt."
    },
    "due_date": {
      "type": "string",
      "description": "Optional. ISO YYYY-MM-DD. Pass null to clear."
    },
    "plan_uuid": {
      "type": "string",
      "format": "uuid",
      "description": "UUID of the plan to update."
    },
    "project_id": {
      "type": "string",
      "format": "uuid",
      "description": "Optional. Project UUID. Pass null to clear."
    },
    "assigned_to": {
      "type": "integer",
      "description": "Optional. Integer user ID. Must be a current team member."
    },
    "category_id": {
      "type": "integer",
      "description": "Optional. Content category ID. Pass null to clear."
    },
    "description": {
      "type": "string",
      "description": "Optional. New description."
    },
    "blueprint_id": {
      "type": "string",
      "format": "uuid",
      "description": "Optional. Blueprint UUID. Pass null to clear."
    },
    "target_stage": {
      "type": "string",
      "description": "Optional. Trigger a stage transition. Use UNDERSCORE form (e.g. In_Process). Allowed: Suggested, Accepted, In_Process, Complete, Dismissed."
    },
    "context_collection_ids": {
      "type": "array",
      "items": {
        "type": "integer"
      },
      "description": "Optional. REPLACES the full set of context collections. Pass [] to clear all."
    },
    "reference_document_ids": {
      "type": "array",
      "items": {
        "type": "string",
        "format": "uuid"
      },
      "description": "Optional. REPLACES the full set of reference documents. Pass [] to clear all."
    },
    "targeting_dimension_ids": {
      "type": "array",
      "items": {
        "type": "integer"
      },
      "description": "Optional. REPLACES the full set of targeting dimensions. Pass [] to clear all."
    }
  }
}

Output Schema

{
  "type": "object",
  "properties": {
    "id": {
      "type": "integer"
    },
    "stage": {
      "type": "string"
    },
    "title": {
      "type": "string"
    },
    "source": {
      "type": "string"
    },
    "plan_uuid": {
      "type": "string"
    },
    "created_at": {
      "type": "string"
    },
    "updated_at": {
      "type": "string"
    }
  },
  "description": "Updated plan object with all fields."
}

Instructions

Performs a partial update on a plan. All fields are optional — supply only what you want to change.

Array fields replace entirely: reference_document_ids, context_collection_ids, and targeting_dimension_ids REPLACE the full set when provided. Pass an empty array [] to clear all associations.

Nullable fields: Pass null to clear blueprint_id, project_id, category_id, and due_date.

Stage transitions (use target_stage):

  • Suggested -> Accepted or Dismissed
  • Accepted -> In_Process or Dismissed
  • In_Process -> Complete, Accepted, or Dismissed
  • Complete -> Accepted or Dismissed
  • Dismissed -> terminal, no further transitions

Use UNDERSCORE form for stage values: In_Process (not In Process).

Note: source and source_metadata are immutable and cannot be updated after creation.

Scroll to Top