Update a sticky

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

PATCH /api/v1/workspaces/{workspace_slug}/stickies/{sticky_id}

Update a sticky

cURL

curl --request PATCH \
  --url https://api.plane.so/api/v1/workspaces/{workspace_slug}/stickies/{sticky_id}/ \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "name": "<string>",
  "description_html": "<string>",
  "logo_props": {},
  "color": "<string>",
  "background_color": "<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.

sticky_id · string · required

The unique identifier for the sticky.

Body parameters

name · string

Name of the sticky.

description_html · string

HTML-formatted content of the sticky.

logo_props · object

Logo properties and visual configuration.

color · string

Text color for the sticky (hex code).

background_color · string

Background color for the sticky (hex code).