Update an initiative

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

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

Update an initiative

cURL

curl --request PATCH \
  --url https://api.plane.so/api/v1/workspaces/{workspace_slug}/initiatives/{initiative_id}/ \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "description_html": "<string>",
  "description_stripped": "<string>",
  "description_binary": "<string>",
  "lead": "<string>",
  "start_date": "<string>",
  "end_date": "<string>",
  "logo_props": {},
  "state": "<string>"
}
'

Path parameters

workspace_slug · string · required

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 · string · required

The unique identifier for the initiative.

Body parameters

name · string · required

Name of the initiative.

description · string

Plain text description of the initiative.

description_html · string

HTML-formatted description of the initiative.

description_stripped · string

Stripped version of the HTML description.

description_binary · string

Binary representation of the description.

lead · string

ID of the user who leads the initiative.

start_date · string

Start date in YYYY-MM-DD format.

end_date · string

End date in YYYY-MM-DD format.

logo_props · object

Logo properties for the initiative

state · string

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