Skip to main content
PATCH
Pin or unpin a navigation item

Authorizations

Authorization
string
header
required

Passport bearer token authentication for legacy admin sessions.

Body

application/json

Validated request fields for this operation.

operation
enum<string>
required

Requested preference mutation.

Available options:
pin,
unpin
Example:

"pin"

navigation_key
string
required

Stable sidebar navigation key.

Required string length: 1 - 120
Pattern: ^[A-Za-z0-9]+(?:[._-][A-Za-z0-9]+)*$
Example:

"apps.events"

expected_version
integer
required

Version from the last preference snapshot.

Required range: x >= 0
Example:

0

Response

Operation result.

pinned_navigation_keys
string[]

Address metadata, personal navigation and restricted record privacy contracts.

Maximum array length: 6

Stable sidebar navigation key.

Required string length: 1 - 120
Pattern: ^[A-Za-z0-9]+(?:[._-][A-Za-z0-9]+)*$
expanded_navigation_group_keys
string[]
Maximum array length: 24

Stable sidebar navigation key.

Required string length: 1 - 120
Pattern: ^[A-Za-z0-9]+(?:[._-][A-Za-z0-9]+)*$
collapsed_navigation_group_keys
string[]
Maximum array length: 24

Stable sidebar navigation key.

Required string length: 1 - 120
Pattern: ^[A-Za-z0-9]+(?:[._-][A-Za-z0-9]+)*$
version
integer

Optimistic concurrency version. Unchanged for a no-op.

Required range: x >= 0
Example:

0

available
boolean

Whether preferences are available.

Example:

true