Skip to main content
PATCH
Update broadcastMap resource

Authorizations

X-API-KEY
string
header
required

Use the format X-API-KEY YOUR_API_KEY. Each key is tied to a single broadcast.

Path Parameters

userId
string<objectId>
required

Resource identifier.

broadcastId
string<objectId>
required

Resource identifier.

broadcastMapId
string<objectId>
required

Resource identifier.

Body

application/json

Carte d'un broadcast Amply.

type
enum<string>
required

Type de carte (interactive, image).

Available options:
image
Example:

"image"

status
enum<string>

Statut editorial (draft, published).

Available options:
draft,
published
Example:

"draft"

name
string | null

Nom de la carte.

Required string length: 1 - 100
Example:

"x"

configuration
object | null

Configuration de la carte.

backgroundColor
string | null

Couleur de fond de la carte image.

Pattern: ^#(?:[A-Fa-f0-9]{3,4}|[A-Fa-f0-9]{6}|[A-Fa-f0-9]{8})$
Example:

"#A1B2C3"

opacity
number | null

Opacite de la carte image.

Example:

0

size
number | null

Taille de la carte image.

Example:

0

media
any | null

Image de plan/import statique.

layers
media · object[] | null

Layers affiches au-dessus de la carte.

metadata
object

Response

200 - application/json

Success

Carte d'un broadcast Amply.

type
enum<string>
required

Type de carte (interactive, image).

Available options:
image
Example:

"image"

status
enum<string>
default:draft
required

Statut editorial (draft, published).

Available options:
draft,
published
_id
string<objectId>
required
Example:

"64b7f8b6f23a4a4f3d0a9b12"

_createdAt
string<date-time>
required
Example:

"2024-01-01T00:00:00.000Z"

name
string | null

Nom de la carte.

Required string length: 1 - 100
Example:

"x"

configuration
object | null

Configuration de la carte.

backgroundColor
string | null

Couleur de fond de la carte image.

Pattern: ^#(?:[A-Fa-f0-9]{3,4}|[A-Fa-f0-9]{6}|[A-Fa-f0-9]{8})$
Example:

"#A1B2C3"

opacity
number | null

Opacite de la carte image.

Example:

0

size
number | null

Taille de la carte image.

Example:

0

media
any | null

Image de plan/import statique.

layers
media · object[] | null

Layers affiches au-dessus de la carte.

metadata
object
_updatedAt
string<date-time> | null
Example:

"2024-01-01T00:00:00.000Z"

_reference
string | null
Example:

"string"