Sign in

v1

latestOpenAPI 3.0.02026-07-2688129326.6 KB
category resource

Create category resource

post/v1/organizers/{organizerId}/events/{eventId}/categories

Path parameters

organizerIdstring objectId required

Resource identifier.

eventIdstring objectId required

Resource identifier.

Request body

namestring
{"stackTrail":"components:schemas:categoryCreate:properties:media","oasType":"schema","type":"unknown","nullable":true}
descriptionstring nullable
maxCountnumber nullable
defaultLocale'fr' | 'en' | 'es' nullable
localeDetailsobject nullable
indexinteger nullable

Example request

{
  "name": "string",
  "description": "string",
  "defaultLocale": "fr"
}

Response

Success

namestring required
{"stackTrail":"components:schemas:category:properties:media","oasType":"schema","type":"unknown","nullable":true}
descriptionstring nullable
maxCountnumber nullable
defaultLocale'fr' | 'en' | 'es' nullable
localeDetailsobject nullable
_idstring objectId required
_createdAtstring date-time required
_updatedAtstring date-time nullable
_referencestring nullable

Example response

{
  "name": "string",
  "description": "string",
  "defaultLocale": "fr",
  "_id": "64b7f8b6f23a4a4f3d0a9b12",
  "_createdAt": "2024-01-01T00:00:00.000Z",
  "_updatedAt": "2024-01-01T00:00:00.000Z",
  "_reference": "string"
}