createBrandBugInstance

POST

/api/v1/plugins/brand-bug/instances

curl --request POST \
  --url https://example.com/api/v1/plugins/brand-bug/instances \
  --header 'Content-Type: application/json' \
  --header 'X-CSRF-Token: example' \
  --data '{ "name": "example", "corner": "top_left", "imageAssetId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "text": "example", "widthPercent": 1, "textSizePercent": 1, "opacityPercent": 1, "marginPercent": 1, "textColor": "example", "backgroundStyle": "none", "startsAt": "2026-04-15T12:00:00Z", "endsAt": "2026-04-15T12:00:00Z", "enabled": true, "priority": 1, "targetScope": "all", "targetIds": [ "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" ] }'

Parameters

Header Parameters

X-CSRF-Token

required

string

Request Body^required

Media typeapplication/json

A mark needs a logo image, text, or both. Sizes are percentages of the screen so one instance reads the same at any panel resolution.

object

name

required

string

>= 1 characters <= 180 characters

corner

required

Allowed values: top_left top_right bottom_left bottom_right

imageAssetId

A ready image in the Media library.

string | null format: uuid

text

required

string

<= 180 characters

widthPercent

required

integer

>= 2 <= 40

textSizePercent

required

integer

>= 1 <= 12

opacityPercent

required

integer

>= 10 <= 100

marginPercent

required

integer

<= 20

textColor

required

string

/^#[0-9a-fA-F]{6}$/

backgroundStyle

required

Allowed values: none scrim

startsAt

string | null format: date-time

endsAt

string | null format: date-time

enabled

required

boolean

priority

required

integer

>= -1000 <= 1000

targetScope

required

Allowed values: all screens sync_groups locations

targetIds

required

Array<string>

<= 250 items unique items

Responses

201

Brand Bug instance created

400

Typed configuration, logo image, or targets are invalid

403

Owner or Administrator required