Skip to main content
PATCH
Set deadline delivery state
These endpoints power deadline management in the Console. You can also call them directly to integrate deadlines into your own systems.

Authorizations

Authorization
string
header
required

JWT bearer token issued by the identity provider.

Path Parameters

id
string
required

Unique deadline identifier.

Body

application/json

JSON request payload.

delivered
boolean | null
required

Whether to mark the deadline delivered or revert its delivery.

Example:

true

Response

OK

active
boolean

Whether the deadline is active.

Example:

true

color
string

Hex color used to identify the deadline.

Example:

"#FF5733"

createdAt
string<date-time>

Date and time when the deadline was created.

Example:

"2026-01-01T00:00:00Z"

deliveredAt
string<date-time>

Date and time when the deadline was delivered.

Example:

"2026-03-15T10:00:00Z"

description
string

Optional deadline description.

Example:

"Monthly regulatory compliance report"

dueDate
string<date-time>

Date and time when the deadline is due.

Example:

"2026-03-31T23:59:59Z"

frequency
string

Deadline recurrence frequency.

Example:

"monthly"

id
string

Unique deadline identifier.

Example:

"00000000-0000-0000-0000-000000000000"

monthsOfYear
integer<int64>[] | null

Months in which a semiannual or annual deadline occurs.

Example:
name
string

Human-readable deadline name.

Example:

"Monthly Regulatory Report"

notifyDaysBefore
integer<int64>

Days before the due date when notifications begin.

Example:

5

status
string

Current derived deadline status.

Example:

"pending"

templateId
string

Template used to generate the report.

Example:

"00000000-0000-0000-0000-000000000000"

templateName
string

Human-readable name of the associated template.

Example:

"Financial Template"

type
string

Deadline category.

Example:

"regulatory"

updatedAt
string<date-time>

Date and time when the deadline was last updated.

Example:

"2026-01-01T00:00:00Z"