Pular para o conteúdo principal
PATCH
Set deadline delivery state

Autorizações

Authorization
string
header
obrigatório

JWT bearer token issued by the identity provider.

Parâmetros de caminho

id
string
obrigatório

Unique deadline identifier.

Corpo

application/json

JSON request payload.

delivered
boolean | null
obrigatório

Whether to mark the deadline delivered or revert its delivery.

Exemplo:

true

Resposta

OK

active
boolean

Whether the deadline is active.

Exemplo:

true

color
string

Hex color used to identify the deadline.

Exemplo:

"#FF5733"

createdAt
string<date-time>

Date and time when the deadline was created.

Exemplo:

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

deliveredAt
string<date-time>

Date and time when the deadline was delivered.

Exemplo:

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

description
string

Optional deadline description.

Exemplo:

"Monthly regulatory compliance report"

dueDate
string<date-time>

Date and time when the deadline is due. Its clock time is the hour the reminder starts firing from.

Exemplo:

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

filters
object

Filter conditions this deadline applies when it fires, grouped by data source, table, and field. Absent when the deadline filters nothing.

Exemplo:
frequency
string

Deadline recurrence frequency.

Exemplo:

"monthly"

id
string

Unique deadline identifier.

Exemplo:

"00000000-0000-0000-0000-000000000000"

institution
string

The institution the reports this deadline generates read for: an institution id, or "all". Absent, each report takes the tenant's only institution when it fires, reads everything when the tenant has none, and is refused when it has several.

Exemplo:

"00000000-0000-0000-0000-000000000000"

monthsOfYear
integer<int64>[] | null

Months in which a semiannual or annual deadline occurs.

Exemplo:
name
string

Human-readable deadline name.

Exemplo:

"Monthly Regulatory Report"

notifyDaysBefore
integer<int64>

Days before the due date when notifications begin.

Exemplo:

5

status
string

Current derived deadline status.

Exemplo:

"pending"

templateId
string

Template used to generate the report.

Exemplo:

"00000000-0000-0000-0000-000000000000"

templateName
string

Human-readable name of the associated template.

Exemplo:

"Financial Template"

timezone
string

IANA timezone name that gives the dueDate clock time its meaning, along which the recurrence advances, and in which today's calendar day is counted for the past-day refusal and daysUntilDue. Empty means UTC.

Exemplo:

"America/Sao_Paulo"

type
string

Deadline category.

Exemplo:

"regulatory"

updatedAt
string<date-time>

Date and time when the deadline was last updated.

Exemplo:

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