SnozeDevelopers
API referenceUser preferences

Set the caller's custom order for an item

Stores the caller's custom sort position for one workspace item in their sidebar, creating the preference row if needed. Requires `workspace:read`. Naturally idempotent: writing the same order again leaves the row unchanged.

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

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
order*number

Response Body

Success

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

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.

Replace the caller's desktop home layout

Overwrites the caller's saved home dashboard widget layout for this workspace. Requires `workspace:read`. This is a full replacement rather than a patch, so sending the same layout twice is a no-op.