Skip to content
calternal docs

Update the mode order

PUT
/api/v1/preferences/mode-order
curl --request PUT \
  --url https://example.com/api/v1/preferences/mode-order \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "mode_order": [ "example" ] }'

Updates the mode order. It requires a signed-in User with the account scope. It can return 400 if the request is invalid, 401 if the session is missing or expired, 403 if access is denied, 409 if the request conflicts with the current state, 413 if the request is too large and 503 if the service is temporarily unavailable. Route: /api/v1/preferences/mode-order. Inputs: . Do not automatically replay this operation after an uncertain result.

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json

One validated order. Unknown Plugin IDs stay in the list so a later Plugin can return to its saved position without moving the User’s other modes.

object
mode_order
required

Stable Plugin IDs in the User’s chosen order.

Array<string>
Examplegenerated
{
  "mode_order": [
    "example"
  ]
}

Responses

Section titled “Responses”

200

Section titled “200”

The mode order was saved for this User

Media typeapplication/json

The current User ID lets the Installation keep its local first-paint cache attached to the right User when several people sign in on one browser.

object
mode_order

None means no Installation has saved a custom order yet.

Array<string> | null
user_id
required

Immutable ID of the authenticated User.

string
Examplegenerated
{
  "mode_order": [
    "example"
  ],
  "user_id": "example"
}

400

Section titled “400”

The mode order contains invalid Plugin IDs

Media typeapplication/json

The standard API error response: { "error": { ... } }.

object
error
required

Error details.

object
code
required

Stable machine-readable code.

string
Allowed values: bad_request unauthorized forbidden not_found conflict name_conflict_case name_too_long push_endpoint_rejected too_many_requests internal service_unavailable
details
One of:

Optional field or operation details.

object
key
additional properties
string
message
required

Safe text for logs or a user-facing error message.

string
Example
{
  "error": {
    "code": "bad_request"
  }
}

401

Section titled “401”

Authentication required

Media typeapplication/json

The standard API error response: { "error": { ... } }.

object
error
required

Error details.

object
code
required

Stable machine-readable code.

string
Allowed values: bad_request unauthorized forbidden not_found conflict name_conflict_case name_too_long push_endpoint_rejected too_many_requests internal service_unavailable
details
One of:

Optional field or operation details.

object
key
additional properties
string
message
required

Safe text for logs or a user-facing error message.

string
Example
{
  "error": {
    "code": "bad_request"
  }
}

403

Section titled “403”

Account scope required

Media typeapplication/json

The standard API error response: { "error": { ... } }.

object
error
required

Error details.

object
code
required

Stable machine-readable code.

string
Allowed values: bad_request unauthorized forbidden not_found conflict name_conflict_case name_too_long push_endpoint_rejected too_many_requests internal service_unavailable
details
One of:

Optional field or operation details.

object
key
additional properties
string
message
required

Safe text for logs or a user-facing error message.

string
Example
{
  "error": {
    "code": "bad_request"
  }
}

409

Section titled “409”

User settings could not be merged

Media typeapplication/json

The standard API error response: { "error": { ... } }.

object
error
required

Error details.

object
code
required

Stable machine-readable code.

string
Allowed values: bad_request unauthorized forbidden not_found conflict name_conflict_case name_too_long push_endpoint_rejected too_many_requests internal service_unavailable
details
One of:

Optional field or operation details.

object
key
additional properties
string
message
required

Safe text for logs or a user-facing error message.

string
Example
{
  "error": {
    "code": "bad_request"
  }
}

413

Section titled “413”

The request body exceeds 8 KiB

503

Section titled “503”

User settings could not be saved

Media typeapplication/json

The standard API error response: { "error": { ... } }.

object
error
required

Error details.

object
code
required

Stable machine-readable code.

string
Allowed values: bad_request unauthorized forbidden not_found conflict name_conflict_case name_too_long push_endpoint_rejected too_many_requests internal service_unavailable
details
One of:

Optional field or operation details.

object
key
additional properties
string
message
required

Safe text for logs or a user-facing error message.

string
Example
{
  "error": {
    "code": "bad_request"
  }
}