canvases

Write one key of the canvas's runtime state, or delete it with a null value.

post/api/projects/{project_id}/canvases/{id}/state/set/

Request

  • Base URL: https://us.posthog.com
  • URL: https://us.posthog.com/api/projects/{project_id}/canvases/{id}/state/set/
  • Auth: HTTP bearer

Path parameters

idstring uuid required

A UUID string identifying this canvas.

project_idstring required

Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.

Request body

scope'user' | 'shared' required
  • user - user
  • shared - shared
keystring required

Key to write, unique within its scope.

valueunknown required

Response

scope'user' | 'shared' required
  • user - user
  • shared - shared
keystring required

The entry's key, unique within its scope.

valueunknown
updated_atstring date-time required

When the entry was last written.

Changes

No recorded changes to this operation across all 1 revision of this API.