Update an initiative

PATCH/api/v2/workspaces/{slug}/initiatives/{pk}/

Initiatives group projects and work items under one strategic objective. Update an initiative. Send only the keys you want to change. Omitted keys keep their current value, and an explicit null clears a nullable field.

Path Parameters

slug:requiredstring

The workspace slug. It appears in your Plane URLs. In https://app.plane.so/my-team/projects/, the slug is my-team.

pk:requiredstring (uuid)

The initiative id.

Body Parameters

description:optionalstring

Free-form description.

Nullable.

description_html:optionalstring

Rich-text body as HTML. This is the field the Plane editor round-trips.

Nullable.

end_date:optionalstring (date-time)

End date, as YYYY-MM-DD.

Nullable.

lead_id:optionalstring (uuid)

Id of the related lead.

Nullable.

logo_props:optionalstring

Editor-owned logo descriptor. Pass back what you read rather than composing it by hand.

name:optionalstring

Display name.

Maximum 255 characters.

project_ids:optionalarray of string (uuid)

Ids of the projects to associate. Replaces the current set.

start_date:optionalstring (date-time)

Planned start date, as YYYY-MM-DD.

Nullable.

state:optionalstring

• DRAFT - Draft
• PLANNED - Planned
• ACTIVE - Active
• COMPLETED - Completed
• CLOSED - Closed

One of DRAFT, PLANNED, ACTIVE, COMPLETED, CLOSED.

Response shaping

fields:optionalstring

Comma-separated list of fields to return. Unrequested keys are omitted, not returned as null. id always comes back. Pass all for every requestable field. An unknown name is a 400. See Sparse fields.

Requestable here: archived_at, created_at, created_by_id, description, description_html, end_date, id, label_ids, lead_id, logo_props, name, project_ids, start_date, state, updated_at, updated_by_id.

expand:optionalstring

Comma-separated relations to embed: lead.

Expansion is separate-key — ?expand=state keeps state_id and adds a state object next to it. ?fields= and ?expand= are independent: naming a relation in ?fields= is a 400, and expanded objects survive field filtering. See Expanding relations.

Scopes

initiatives:write

Errors

Status	Code	Cause
400	invalid_request	The request body or a query parameter failed validation.
401	unauthorized	Missing or invalid credentials.
402	payment_required	The feature this endpoint belongs to isn't enabled on your plan or is switched off.
403	forbidden	Your role or token scope doesn't allow this.
404	not_found	No such resource, or it's outside your tenant.
406	not_acceptable	The Accept header asks for a representation the API can't produce.
409	conflict	A business rule blocks the write — see the notes above.
413	payload_too_large	The request body is over the size limit.
415	unsupported_media_type	The Content-Type isn't one this endpoint accepts.
429	rate_limited	Throttled. Honor the Retry-After header before retrying.

Update an initiative

curl -X PATCH \
  "https://api.plane.so/api/v2/workspaces/my-team/initiatives/9c1f0b3d-6d2e-4c9a-8b41-2f7e5a0d6c88/" \
  -H "X-Api-Key: $PLANE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "description": "What this is for.",
  "description_html": "<p>Details go here.</p>",
  "end_date": "2026-01-31"
}'

import requests

response = requests.patch(
    "https://api.plane.so/api/v2/workspaces/my-team/initiatives/9c1f0b3d-6d2e-4c9a-8b41-2f7e5a0d6c88/",
    headers={"X-Api-Key": "your-api-key"},
    json={
        "description": "What this is for.",
        "description_html": "<p>Details go here.</p>",
        "end_date": "2026-01-31"
    },
)
print(response.json())

const response = await fetch(
  "https://api.plane.so/api/v2/workspaces/my-team/initiatives/9c1f0b3d-6d2e-4c9a-8b41-2f7e5a0d6c88/",
  {
    method: "PATCH",
    headers: {
      "X-Api-Key": "your-api-key",
      "Content-Type": "application/json",
    },
    body: JSON.stringify({
      description: "What this is for.",
      description_html: "<p>Details go here.</p>",
      end_date: "2026-01-31",
    }),
  },
);
const data = await response.json();

Response200

{
  "archived_at": null,
  "created_at": "2026-01-14T09:22:41.478363Z",
  "updated_at": "2026-02-03T16:45:12.904117Z",
  "created_by_id": "16c61a3a-512a-48ac-b0be-b6b46fe6f430",
  "updated_by_id": "16c61a3a-512a-48ac-b0be-b6b46fe6f430",
  "description": "What this is for.",
  "description_html": "<p>Details go here.</p>",
  "end_date": "2026-01-31",
  "id": "b7e42a19-3c5d-4f80-9a26-8d1c0f4e7b53",
  "label_ids": ["16c61a3a-512a-48ac-b0be-b6b46fe6f430"],
  "lead_id": "f960d3c2-8524-4a41-b8eb-055ce4be2a7f",
  "logo_props": null,
  "name": "Example name",
  "project_ids": ["16c61a3a-512a-48ac-b0be-b6b46fe6f430"],
  "start_date": "2026-01-12",
  "state": "DRAFT"
}

Response404

{
  "type": "not_found",
  "code": "not_found",
  "detail": "No initiative matches the given query."
}