Update tenant UX preferences

PATCH

/api/v1/ux/preferences

curl --request PATCH \
  --url https://api.ultimateteam.ai/api/v1/ux/preferences \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <X-API-Key>' \
  --data '{ "dashboard_layout": {}, "notification_preferences": {}, "report_schedule": {} }'

• Production
• Local development

UX-04: Partial-patch UX preferences. If dashboard_layout is included, layout_customized_at is set automatically.

Authorizations

• ApiKeyAuth

Request Body^required

Media typeapplication/json

PatchPreferencesRequest

Request body for patching UX preferences.

Attributes: dashboard_layout: Optional dashboard layout configuration. notification_preferences: Optional notification settings. report_schedule: Optional report schedule settings.

object

dashboard_layout

Any of:

object

object

key

additional properties

any

null

null

notification_preferences

Any of:

object

object

key

additional properties

any

null

null

report_schedule

Any of:

object

object

key

additional properties

any

null

null

Example^generated

{
  "dashboard_layout": {},
  "notification_preferences": {},
  "report_schedule": {}
}

Responses

200

Successful Response

Media typeapplication/json

Response Patch Preferences Api V1 Ux Preferences Patch

object

key

additional properties

any

Example^generated

{}

422

Validation Error

Media typeapplication/json

HTTPValidationError

object

detail

Detail

Array<object>

ValidationError

object

ctx

Context

object

input

Input

loc

required

Location

Array

msg

required

Message

string

type

required

Error Type

string

Example^generated

{
  "detail": [
    {
      "ctx": {},
      "input": "example",
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}