Replace the caller's mobile home layout
Overwrites the caller's saved mobile home layout for this workspace, and clears a stored desktop layout that was only ever a legacy mobile stand-in. Requires `workspace:read`. Send an `Idempotency-Key` header to make retries safe; a replay within the window returns the original response.
Authorization
apiKey Workspace API key created in Workspace settings → API keys. Scopes on the key bound what it can read and write.
In: header
Path Parameters
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
curl -X PUT "https://example.com/v1/workspaces/string/preferences/mobile-home-layout" \ -H "Content-Type: application/json" \ -d '{ "sections": [ { "id": "string", "kind": "recents" } ] }'{ "data": { "mobileHomeLayout": { "sections": [ { "id": "string", "kind": "recents", "config": {} } ] } }}{ "_tag": "ApiNotFound", "error": "not_found", "message": "That item does not exist, or this key cannot see it.", "status": 404}{ "_tag": "ApiNotFound", "error": "not_found", "message": "That item does not exist, or this key cannot see it.", "status": 404}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.
Resolve a shared item and the caller's access to it
Given an item id — or the id of the underlying resource, which is what deep links carry — returns the owning workspace, its name, the item summary, and the caller's effective access level, so the client can route a bare link to the right workspace. Requires an authenticated caller with at least `view` on the item. Archived items and ids that match nothing are not found.