SnozeDevelopers
API referenceUser preferences

Pin or unpin an item for the caller

Sets the caller's pinned flag on one workspace item, creating their preference row if it does not exist yet. Requires `workspace:read`. The write is private to the caller and naturally idempotent for a given `pinned` value.

POST
/v1/workspaces/{workspaceId}/preferences/items/{itemId}/pin

Authorization

apiKey
headerAuthorizationBearer <snoze_sk_…>

Workspace API key created in Workspace settings → API keys. Scopes on the key bound what it can read and write.

Path Parameters

workspaceId*string
itemId*string

Request Body

application/json
  1. body
itemId*string
pinned*boolean

Response Body

Success

application/json
  1. response
data*
Example Request
curl -X POST 'https://api.snoze.dev/v1/workspaces/string/preferences/items/string/pin' \  -H 'Content-Type: application/json' \  -d '{  "itemId": "string",  "pinned": true}'
Example Response
{  "data": {    "itemId": "string",    "pinned": true  }}