Update Animation Config

Update animation config (partial update). Admin only.

PATCH /cabinet/branding/animation-config

Update Animation Config

cURL

curl --request PATCH \
  --url https://api.example.com/cabinet/branding/animation-config \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "enabled": true,
  "settings": {},
  "opacity": 0.5,
  "blur": 50,
  "reducedOnMobile": true
}
'

200

{
  "enabled": true,
  "type": "aurora",
  "settings": {},
  "opacity": 1,
  "blur": 0,
  "reducedOnMobile": true
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Request to update animation config (partial update).

enabled · boolean | null

type · enum<string> | null

Available options: aurora, sparkles, vortex, shooting-stars, background-beams, background-beams-collision, gradient-animation, wavy, background-lines, boxes, meteors, grid, dots, spotlight, ripple, none

settings · Settings · object

opacity · number | null

Required range: 0 <= x <= 1

blur · number | null

Required range: 0 <= x <= 100

reducedOnMobile · boolean | null

Response

200

application/json

Successful Response

Full animation config.

enabled · boolean · default: true

type · string · default: aurora

settings · Settings · object

opacity · number · default: 1

Required range: 0 <= x <= 1

blur · number · default: 0

Required range: 0 <= x <= 100

reducedOnMobile · boolean · default: true