Create a Deadline

curl --request POST \ --url https://reporter.sandbox.lerian.net/v1/deadlines \ --header 'Content-Type: application/json' \ --header 'X-Organization-id: <x-organization-id>' \ --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>" }

Headers

Authorization

string

The authorization token in the 'Bearer ' format.

Important: This header is required if your environment has Access Manager enabled. For more information, refer to the Access Manager documentation.

X-Organization-id

string

required

The unique identifier of the Organization associated with the request.

X-Idempotency

string

Optional idempotency key for safe retries. If omitted, the server may generate one automatically.

See Retries and idempotency for details.

Body

application/json

The input payload to create a deadline.

name

string

required

Human-readable name of the deadline.

type

string

required

Type of the deadline (e.g., regulatory, custom).

frequency

string

required

How often the deadline recurs (e.g., monthly, annual).

dueDate

string

required

The date and time when the deadline is due, in RFC 3339 format.

color

string

required

Color used to visually identify the deadline (hex format).

description

string

Optional description of the deadline.

notifyDaysBefore

integer

Number of days before the due date when notifications start.

monthsOfYear

integer[]

Months of the year (1-12) in which the deadline applies.

templateId

string

Unique identifier of the template used to fulfill the deadline (UUID).

active

boolean

Whether the deadline is active.

Response

Indicates that the deadline was successfully created.

Details about a deadline.

string

Unique identifier of the deadline (UUID).

name

string

Human-readable name of the deadline.

description

string

Description of the deadline.

type

string

Type of the deadline (e.g., regulatory, custom).

frequency

string

How often the deadline recurs (e.g., monthly, annual).

dueDate

string

The date and time when the deadline is due, in RFC 3339 format.

color

string

Color used to visually identify the deadline (hex format).

notifyDaysBefore

integer

Number of days before the due date when notifications start.

monthsOfYear

integer[]

Months of the year (1-12) in which the deadline applies.

templateId

string

Unique identifier of the template used to fulfill the deadline (UUID).

templateName

string

Name of the template used to fulfill the deadline.

status

string

Current status of the deadline (e.g., pending, overdue, delivered).

active

boolean

Whether the deadline is active.

deliveredAt

string

Timestamp marking when the deadline was delivered, if applicable.

createdAt

string

Timestamp marking when the deadline was created.

updatedAt

string

Timestamp marking the last update to the deadline.