Skip to main content
POST
Create broadcastInterestPoint 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.

Body

application/json
mapId
string<objectId>
required

Carte parente.

Required string length: 24
Example:

"64b7f8b6f23a4a4f3d0a9b12"

status
enum<string>
default:draft
required

Statut editorial (draft, published).

Available options:
draft,
published
categoryIds
string<objectId>[] | null

Categories associees au point d'interet.

Required string length: 24
name
string | null

Nom du point d'interet.

Required string length: 1 - 100
Example:

"x"

description
string | null

Description du point.

Required string length: 1 - 500
Example:

"x"

media
any | null

Media du point d'interet.

defaultLocale
enum<string> | null

Locale par defaut.

Available options:
fr,
en,
es
Example:

"fr"

blocks
(media · object | button · object | divider · object | embed · object | question · object | paragraph · object | sessions · object | hosts · object | interestPoints · object | articles · object | countdown · object | section · object | socials · object | meteo · object | map · object)[] | null

Contenu detaille du point.

Bloc de contenu rendu dans l'ordre du tableau. Type peut être title pour un titre, paragraph pour un texte markdown, media pour une image ou une video, embed pour un contenu embarqué (ex: tweet, video externe, etc), button pour un bouton cliquable, question pour une question avec reponses cliquables, sessions, hosts ou interestPoints pour afficher des listes de sessions, hosts ou points d'interet d'un broadcast, articles pour afficher une selection d'articles d'un broadcast, ou countdown pour afficher un compte a rebours vers une date cible.

pin
object | null

Configuration du marqueur du point d'interet.

polygon
object | null

Polygone associe au point d'interet.

curve
object | null

Courbe associee au point d'interet.

object
object | null

Objet libre associe au point d'interet.

localeDetails
object | null

Variantes localisees du point d'interet.

metadata
object

Response

201 - application/json

Success

mapId
string<objectId>
required

Carte parente.

Required string length: 24
Example:

"64b7f8b6f23a4a4f3d0a9b12"

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"

categoryIds
string<objectId>[] | null

Categories associees au point d'interet.

Required string length: 24
name
string | null

Nom du point d'interet.

Required string length: 1 - 100
Example:

"x"

description
string | null

Description du point.

Required string length: 1 - 500
Example:

"x"

media
any | null

Media du point d'interet.

defaultLocale
enum<string> | null

Locale par defaut.

Available options:
fr,
en,
es
Example:

"fr"

blocks
(media · object | button · object | divider · object | embed · object | question · object | paragraph · object | sessions · object | hosts · object | interestPoints · object | articles · object | countdown · object | section · object | socials · object | meteo · object | map · object)[] | null

Contenu detaille du point.

Bloc de contenu rendu dans l'ordre du tableau. Type peut être title pour un titre, paragraph pour un texte markdown, media pour une image ou une video, embed pour un contenu embarqué (ex: tweet, video externe, etc), button pour un bouton cliquable, question pour une question avec reponses cliquables, sessions, hosts ou interestPoints pour afficher des listes de sessions, hosts ou points d'interet d'un broadcast, articles pour afficher une selection d'articles d'un broadcast, ou countdown pour afficher un compte a rebours vers une date cible.

pin
object | null

Configuration du marqueur du point d'interet.

polygon
object | null

Polygone associe au point d'interet.

curve
object | null

Courbe associee au point d'interet.

object
object | null

Objet libre associe au point d'interet.

localeDetails
object | null

Variantes localisees du point d'interet.

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

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

_reference
string | null
Example:

"string"