Update an initiative

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

Update an initiative by its ID

Path Parameters

initiative_id:requiredstring

Initiative ID

pk:requiredstring

Pk.

slug:requiredstring

Workspace slug

Body Parameters

name:optionalstring

Name.

description:optionalstring

Description.

description_html:optionalstring

Description html.

description_stripped:optionalstring

Description stripped.

start_date:optionalstring

Start date.

end_date:optionalstring

End date.

logo_props:optionalobject

Logo props.

state:optionalstring

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

archived_at:optionalstring

Archived at.

created_by:optionalstring

Created by.

updated_by:optionalstring

Updated by.

lead:optionalstring

Lead.

Scopes

initiatives:write

Update an initiative

curl -X PATCH \
  "https://api.plane.so/api/v1/workspaces/my-workspace/initiatives/550e8400-e29b-41d4-a716-446655440000/" \
  -H "X-API-Key: $PLANE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Example Name",
  "description": "Example description",
  "description_html": "<p>Example content</p>",
  "description_stripped": "Example description",
  "start_date": "2024-01-01T00:00:00Z",
  "end_date": "2024-01-01T00:00:00Z",
  "logo_props": "example-value",
  "state": "DRAFT",
  "archived_at": "2024-01-01T00:00:00Z",
  "created_by": "550e8400-e29b-41d4-a716-446655440000",
  "updated_by": "550e8400-e29b-41d4-a716-446655440000",
  "lead": "550e8400-e29b-41d4-a716-446655440000"
}'

import requests

response = requests.patch(
    "https://api.plane.so/api/v1/workspaces/my-workspace/initiatives/550e8400-e29b-41d4-a716-446655440000/",
    headers={"X-API-Key": "your-api-key"},
    json={
      "name": "Example Name",
      "description": "Example description",
      "description_html": "<p>Example content</p>",
      "description_stripped": "Example description",
      "start_date": "2024-01-01T00:00:00Z",
      "end_date": "2024-01-01T00:00:00Z",
      "logo_props": "example-value",
      "state": "DRAFT",
      "archived_at": "2024-01-01T00:00:00Z",
      "created_by": "550e8400-e29b-41d4-a716-446655440000",
      "updated_by": "550e8400-e29b-41d4-a716-446655440000",
      "lead": "550e8400-e29b-41d4-a716-446655440000"
    }
)
print(response.json())

const response = await fetch(
  "https://api.plane.so/api/v1/workspaces/my-workspace/initiatives/550e8400-e29b-41d4-a716-446655440000/",
  {
    method: "PATCH",
    headers: {
      "X-API-Key": "your-api-key",
      "Content-Type": "application/json",
    },
    body: JSON.stringify({
      name: "Example Name",
      description: "Example description",
      description_html: "<p>Example content</p>",
      description_stripped: "Example description",
      start_date: "2024-01-01T00:00:00Z",
      end_date: "2024-01-01T00:00:00Z",
      logo_props: "example-value",
      state: "DRAFT",
      archived_at: "2024-01-01T00:00:00Z",
      created_by: "550e8400-e29b-41d4-a716-446655440000",
      updated_by: "550e8400-e29b-41d4-a716-446655440000",
      lead: "550e8400-e29b-41d4-a716-446655440000",
    }),
  }
);
const data = await response.json();

Response200

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "Example Name",
  "description": "Example description"
}