POST/api/v1/calendars

Crear calendario

Crear un nuevo calendario

Autenticación

Envía tu API key en el header x-api-key header.

x-api-keybearer

Cuerpo de la petición

obligatorio

Datos del calendario

PublicApiCreateCalendarDto

namerequired

string

Name of the calendar

description

string

Description of the calendar

hexColor

string

Hex color code for the calendar

hexForegroundColor

string

Hex foreground color code for the calendar

isPrimary

boolean

Whether this is the primary calendar

location

string

Location associated with the calendar

timezone

string

IANA time zone database formatted string

readOnly

boolean

Whether the calendar is read-only

metadata

object

Additional metadata for the calendar

Ejemplo de petición

json

{
  "name": "My Calendar",
  "description": "My personal calendar for work events",
  "hexColor": "#4285f4",
  "hexForegroundColor": "#ffffff",
  "isPrimary": false,
  "location": "New York, NY",
  "timezone": "America/New_York",
  "readOnly": false,
  "metadata": {
    "customField": "value"
  }
}

Respuestas

201Calendario creado exitosamente

PublicApiCreateCalendarResponseDto

statusCoderequired

number

countrequired

number

errorrequired

string

datarequired

PublicApiCalendarDto

Ejemplo de respuesta

json

{
  "statusCode": 200,
  "count": 0,
  "error": null,
  "data": {
    "id": "5516cd47-2bd0-4f4f-adc2-22524e54ba4d",
    "name": "My Calendar",
    "description": "My personal calendar for work events",
    "hexColor": "#4285f4",
    "hexForegroundColor": "#ffffff",
    "isPrimary": false,
    "location": "New York, NY",
    "timezone": "America/New_York",
    "readOnly": false,
    "metadata": {
      "customField": "value"
    },
    "createdAt": "2024-07-15T09:00:00.000Z",
    "updatedAt": "2024-07-15T09:30:00.000Z"
  }
}

401No autorizado - clave API o token Bearer faltante o inválido