add-sticky.md

title	Create a sticky
description	Create a sticky via Plane API. HTTP POST request format, required fields, and example responses.
keywords	plane api, create sticky, add note, sticky note, quick capture, rest api, api integration

Create a sticky

POST /api/v1/workspaces/{workspace_slug}/stickies/

Creates a new sticky note in a workspace.

Path Parameters

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.

Body Parameters

Name of the sticky.

HTML-formatted content of the sticky.

Logo properties and visual configuration.

Text color for the sticky (hex code).

Background color for the sticky (hex code).

Scopes

stickies:write

curl -X POST \
  "https://api.plane.so/api/v1/workspaces/my-workspace/stickies/" \
  -H "X-API-Key: $PLANE_API_KEY" \
  # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "example-name",
  "description_html": "example-description_html",
  "logo_props": "example-logo_props",
  "color": "example-color",
  "background_color": "example-background_color"
}'

import requests

response = requests.post(
    "https://api.plane.so/api/v1/workspaces/my-workspace/stickies/",
    headers={"X-API-Key": "your-api-key"},
    json={
  'name': 'example-name',
  'description_html': 'example-description_html',
  'logo_props': 'example-logo_props',
  'color': 'example-color',
  'background_color': 'example-background_color'
}
)
print(response.json())

const response = await fetch(
  "https://api.plane.so/api/v1/workspaces/my-workspace/stickies/",
  {
    method: "POST",
    headers: {
      "X-API-Key": "your-api-key",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
  "name": "example-name",
  "description_html": "example-description_html",
  "logo_props": "example-logo_props",
  "color": "example-color",
  "background_color": "example-background_color"
})
  }
);
const data = await response.json();

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