Crear un plazo

curl --request POST \ --url https://reporter.sandbox.lerian.net/v1/deadlines \ --header 'Content-Type: application/json' \ --data ' { "name": "Monthly Regulatory Report", "description": "Monthly regulatory compliance report", "type": "regulatory", "frequency": "monthly", "dueDate": "2026-03-31T23:59:59Z", "color": "#FF5733", "notifyDaysBefore": 5, "monthsOfYear": [ 1, 6 ], "templateId": "00000000-0000-0000-0000-000000000000", "active": true } '

{ "id": "<string>", "name": "<string>", "description": "<string>", "type": "<string>", "frequency": "<string>", "dueDate": "<string>", "color": "<string>", "notifyDaysBefore": 123, "monthsOfYear": [ 123 ], "templateId": "<string>", "templateName": "<string>", "status": "<string>", "active": true, "deliveredAt": "<string>", "createdAt": "<string>", "updatedAt": "<string>" }

Encabezados

Authorization

string

El token de autorización en formato 'Bearer '.

Importante: Este encabezado es obligatorio si su entorno tiene habilitado Access Manager. Para obtener más información, consulte la documentación de Access Manager.

X-Organization-id

string

The unique identifier of the Organization associated with the request.

X-Idempotency

string

Clave de idempotencia opcional que el cliente debe reutilizar cuando reintente exactamente la misma operación.

Si se omite, la solicitud se procesa normalmente, pero no debe asumirse deduplicación entre reintentos a menos que la API devuelva explícitamente la clave generada.

Consulte Reintentos e idempotencia para más detalles.

Cuerpo

application/json

El payload de entrada para crear un plazo.

name

string

requerido

Nombre legible del plazo.

type

string

requerido

Tipo del plazo (p. ej., regulatory, custom).

frequency

string

requerido

Con qué frecuencia se repite el plazo (p. ej., monthly, annual).

dueDate

string

requerido

Fecha y hora de vencimiento del plazo, en formato RFC 3339.

color

string

requerido

Color usado para identificar visualmente el plazo (formato hexadecimal).

description

string

Descripción opcional del plazo.

notifyDaysBefore

integer

Número de días antes de la fecha de vencimiento en que comienzan las notificaciones.

monthsOfYear

integer[]

Meses del año (1-12) en los que aplica el plazo.

templateId

string

Identificador único de la plantilla usada para cumplir el plazo (UUID).

active

boolean

Indica si el plazo está activo.

Respuesta

Indica que el plazo se creó correctamente.

Detalles sobre un plazo.

string

Identificador único del plazo (UUID).

name

string

Nombre legible del plazo.

description

string

Descripción del plazo.

type

string

Tipo del plazo (p. ej., regulatory, custom).

frequency

string

Con qué frecuencia se repite el plazo (p. ej., monthly, annual).

dueDate

string

Fecha y hora de vencimiento del plazo, en formato RFC 3339.

color

string

Color usado para identificar visualmente el plazo (formato hexadecimal).

notifyDaysBefore

integer

Número de días antes de la fecha de vencimiento en que comienzan las notificaciones.

monthsOfYear

integer[]

Meses del año (1-12) en los que aplica el plazo.

templateId

string

Identificador único de la plantilla usada para cumplir el plazo (UUID).

templateName

string

Nombre de la plantilla usada para cumplir el plazo.

status

string

Estado actual del plazo (p. ej., pending, overdue, delivered).

active

boolean

Indica si el plazo está activo.

deliveredAt

string

Fecha y hora en que se entregó el plazo, si aplica.

createdAt

string

Fecha y hora en que se creó el plazo.

updatedAt

string

Fecha y hora de la última actualización del plazo.