Skip to main content
POST
Create broadcastCategory 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
name
string | null

Nom de la categorie.

Required string length: 1 - 100
Example:

"x"

description
string | null

Description de la categorie.

Required string length: 1 - 500
Example:

"x"

color
string | null

Couleur associee a la categorie.

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

"#A1B2C3"

defaultLocale
enum<string> | null

Locale par defaut.

Available options:
fr,
en,
es
Example:

"fr"

localeDetails
object | null

Variantes localisees de la categorie.

metadata
object

Response

201 - application/json

Success

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 categorie.

Required string length: 1 - 100
Example:

"x"

description
string | null

Description de la categorie.

Required string length: 1 - 500
Example:

"x"

color
string | null

Couleur associee a la categorie.

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

"#A1B2C3"

defaultLocale
enum<string> | null

Locale par defaut.

Available options:
fr,
en,
es
Example:

"fr"

localeDetails
object | null

Variantes localisees de la categorie.

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

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

_reference
string | null
Example:

"string"