Skip to main content
POST
Create broadcastSession 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
status
enum<string>
default:draft
required

Statut editorial (draft, published).

Available options:
draft,
published
time
object
required

Dates/heures de session.

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)[]
required

Contenu detaille de la session.

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.

title
string | null

Titre de la session.

Minimum string length: 1
Example:

"x"

categoryIds
string<objectId>[] | null

Categories associees a la session.

Required string length: 24
description
string | null

Description courte.

Example:

"string"

hostIds
string<objectId>[] | null

Intervenants lies a la session.

Required string length: 24
interestPointId
string<objectId> | null

Point d'interet associe.

Required string length: 24
Example:

"64b7f8b6f23a4a4f3d0a9b12"

media
any | null

Media principal de la session.

defaultLocale
enum<string> | null

Locale par defaut.

Available options:
fr,
en,
es
Example:

"fr"

color
string | null

Couleur metier de la session.

Example:

"string"

broadcastMapId
string<objectId> | null

Carte associee.

Required string length: 24
Example:

"64b7f8b6f23a4a4f3d0a9b12"

localeDetails
object | null

Variantes localisees de la session.

metadata
object

Response

201 - application/json

Success

status
enum<string>
default:draft
required

Statut editorial (draft, published).

Available options:
draft,
published
time
object
required

Dates/heures de session.

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)[]
required

Contenu detaille de la session.

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.

_id
string<objectId>
required
Example:

"64b7f8b6f23a4a4f3d0a9b12"

_createdAt
string<date-time>
required
Example:

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

title
string | null

Titre de la session.

Minimum string length: 1
Example:

"x"

categoryIds
string<objectId>[] | null

Categories associees a la session.

Required string length: 24
description
string | null

Description courte.

Example:

"string"

hostIds
string<objectId>[] | null

Intervenants lies a la session.

Required string length: 24
interestPointId
string<objectId> | null

Point d'interet associe.

Required string length: 24
Example:

"64b7f8b6f23a4a4f3d0a9b12"

media
any | null

Media principal de la session.

defaultLocale
enum<string> | null

Locale par defaut.

Available options:
fr,
en,
es
Example:

"fr"

color
string | null

Couleur metier de la session.

Example:

"string"

broadcastMapId
string<objectId> | null

Carte associee.

Required string length: 24
Example:

"64b7f8b6f23a4a4f3d0a9b12"

localeDetails
object | null

Variantes localisees de la session.

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

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

_reference
string | null
Example:

"string"