Update an initiative

PATCH/api/v1/workspaces/{workspace_slug}/initiatives/{initiative_id}/

Updates an existing initiative by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

Path Parameters

workspace_slug:requiredstring

The workspace_slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL https://app.plane.so/my-team/projects/, the workspace slug is my-team.

initiative_id:requiredstring

The unique identifier for the initiative.

Body Parameters

name:requiredstring

Name of the initiative.

description:optionalstring

Plain text description of the initiative.

description_html:optionalstring

HTML-formatted description of the initiative.

description_stripped:optionalstring

Stripped version of the HTML description.

description_binary:optionalstring

Binary representation of the description.

lead:optionalstring

ID of the user who leads the initiative.

start_date:optionalstring

Start date in YYYY-MM-DD format.

end_date:optionalstring

End date in YYYY-MM-DD format.

logo_props:optionalobject

Logo properties for the initiative

state:optionalstring

Current state of the initiative. Possible values: DRAFT, PLANNED, ACTIVE, COMPLETED, CLOSED.

Update an initiative

curl -X PATCH \
  "https://api.plane.so/api/v1/workspaces/my-workspace/initiatives/{initiative_id}/" \
  -H "X-API-Key: $PLANE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "example-name",
  "description": "example-description",
  "description_html": "example-description_html",
  "description_stripped": "example-description_stripped",
  "description_binary": "example-description_binary",
  "lead": "example-lead",
  "start_date": "example-start_date",
  "end_date": "example-end_date",
  "logo_props": "example-logo_props",
  "state": "example-state"
}'

import requests

response = requests.patch(
    "https://api.plane.so/api/v1/workspaces/my-workspace/initiatives/{initiative_id}/",
    headers={"X-API-Key": "your-api-key"},
    json={
  'name': 'example-name',
  'description': 'example-description',
  'description_html': 'example-description_html',
  'description_stripped': 'example-description_stripped',
  'description_binary': 'example-description_binary',
  'lead': 'example-lead',
  'start_date': 'example-start_date',
  'end_date': 'example-end_date',
  'logo_props': 'example-logo_props',
  'state': 'example-state'
}
)
print(response.json())

const response = await fetch('https://api.plane.so/api/v1/workspaces/my-workspace/initiatives/{initiative_id}/', {
  method: 'PATCH',
  headers: {
    'X-API-Key': 'your-api-key',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    name: 'example-name',
    description: 'example-description',
    description_html: 'example-description_html',
    description_stripped: 'example-description_stripped',
    description_binary: 'example-description_binary',
    lead: 'example-lead',
    start_date: 'example-start_date',
    end_date: 'example-end_date',
    logo_props: 'example-logo_props',
    state: 'example-state',
  }),
});
const data = await response.json();

Response200

{
  "id": "resource-uuid",
  "created_at": "2024-01-01T00:00:00Z"
}