RevoEngine Documentation

POST

/

api

/

v1

/

preferences

Create a preference.

curl --request POST \
  --url https://api.revoengine.com/api/v1/preferences \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "orders-grid-default",
  "type": "GRID",
  "referenceType": "orders",
  "data": [
    {
      "field": "status",
      "width": 180,
      "order": 0
    }
  ]
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: 'orders-grid-default',
    type: 'GRID',
    referenceType: 'orders',
    data: [{field: 'status', width: 180, order: 0}]
  })
};

fetch('https://api.revoengine.com/api/v1/preferences', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.revoengine.com/api/v1/preferences"

payload = {
    "name": "orders-grid-default",
    "type": "GRID",
    "referenceType": "orders",
    "data": [
        {
            "field": "status",
            "width": 180,
            "order": 0
        }
    ]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

Authorizations

Authorization

string

header

required

Bearer JWT token or API Key (sk-*).

Body

application/json

name

string

required

Stable preference name.

Example:

"orders-grid-default"

type

string

required

Preference family that determines the allowed data payload.

Example:

"GRID"

referenceType

string

required

Reference type used when the preference is scoped to a resource family.

Example:

"orders"

data

array[]

required

Preference payload items validated against the selected preference type.

Example:

[
  {
    "field": "status",
    "width": 180,
    "order": 0
  }
]

desc

string

Optional operator-facing preference description.

Example:

"Default orders grid for support staff."

reference

string

Reference id used when the preference is scoped to one resource.

Example:

"support-dashboard"

metadata

object

Optional resource metadata. Values may use any JSON type. Maximum 16 KiB and 64 top-level keys. Top-level keys starting with "__" are reserved for backend use.

Example:

{ "layout": "support" }

global

boolean

Whether the preference is shared with all eligible users.

Example:

false

default

boolean

Whether this preference becomes the default selection.

Example:

true

autoFit

boolean

Whether the grid should auto-fit columns when the preference is applied.

Example:

true

Response

OK.

Last modified on September 5, 2026

Create a preference.

curl --request POST \
  --url https://api.revoengine.com/api/v1/preferences \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "orders-grid-default",
  "type": "GRID",
  "referenceType": "orders",
  "data": [
    {
      "field": "status",
      "width": 180,
      "order": 0
    }
  ]
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: 'orders-grid-default',
    type: 'GRID',
    referenceType: 'orders',
    data: [{field: 'status', width: 180, order: 0}]
  })
};

fetch('https://api.revoengine.com/api/v1/preferences', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.revoengine.com/api/v1/preferences"

payload = {
    "name": "orders-grid-default",
    "type": "GRID",
    "referenceType": "orders",
    "data": [
        {
            "field": "status",
            "width": 180,
            "order": 0
        }
    ]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)