updatePreferences

PATCH

/api/v1/me/preferences

curl --request PATCH \
  --url https://example.com/api/v1/me/preferences \
  --header 'Content-Type: application/json' \
  --cookie tilecast_session=<tilecast_session> \
  --data '{ "revision": 1, "values": {} }'

Requires an authenticated user with the write scope. Cookie requests additionally require the X-CSRF-Token header; Bearer grants never send it. Updates the calling user’s own preferences against the expected revision.

Authorizations

• sessionCookie
• userBearer

Parameters

Header Parameters

X-CSRF-Token

string

Cookie-backed browser requests only, and only on unsafe methods. Bearer grants never send it.

Request Body^required

Media typeapplication/json

object

revision

required

integer format: int64

values

required

object

key

additional properties

any

Example^generated

{
  "revision": 1,
  "values": {}
}

Responses

200

Updated preferences

Media typeapplication/json

object

data

required

Versioned organization or preference document. Definitions always ride along; callers never merge a second read to render titles.

object

schemaVersion

required

integer

>= 1

revision

required

integer format: int64

values

required

object

key

additional properties

any

definitions

required

Array<object>

object

key

required

string

category

required

string

type

required

string

title

required

string

description

string

documentation

string

default

required

min

number

max

number

allowed

Array<string>

scope

required

string

Allowed values: organization policy preference

sensitive

required

boolean

restartRequired

required

boolean

immediate

required

boolean

futureOnly

required

boolean

updatedAt

required

string format: date-time

Example

{
  "data": {
    "definitions": [
      {
        "scope": "organization"
      }
    ]
  }
}

401

Dashboard authentication required

403

CSRF token required

409

Revision conflict