Update a deadline

Partially updates a deadline and returns the persisted entity.

PATCH /v1/deadlines/{id}

Update a deadline

cURL

curl --request PATCH \
  --url https://reporter.sandbox.lerian.net/v1/deadlines/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "active": false,
  "color": "#00FF00",
  "description": "Updated description",
  "dueDate": "2026-06-30T23:59:59Z",
  "filters": {
    "accounts": {
      "account": {
        "vencimento": {
          "period": "previous_month"
        }
      }
    }
  },
  "frequency": "annual",
  "monthsOfYear": [
    6
  ],
  "name": "Updated Report Name",
  "notifyDaysBefore": 10,
  "templateId": "00000000-0000-0000-0000-000000000001",
  "type": "custom"
}
'

200

{
  "active": true,
  "color": "#FF5733",
  "createdAt": "2026-01-01T00:00:00Z",
  "deliveredAt": "2026-03-15T10:00:00Z",
  "description": "Monthly regulatory compliance report",
  "dueDate": "2026-03-31T23:59:59Z",
  "filters": {
    "accounts": {
      "account": {
        "vencimento": {
          "period": "previous_month"
        }
      }
    }
  },
  "frequency": "monthly",
  "id": "00000000-0000-0000-0000-000000000000",
  "institution": "00000000-0000-0000-0000-000000000000",
  "monthsOfYear": [
    1,
    6
  ],
  "name": "Monthly Regulatory Report",
  "notifyDaysBefore": 5,
  "status": "pending",
  "templateId": "00000000-0000-0000-0000-000000000000",
  "templateName": "Financial Template",
  "timezone": "America/Sao_Paulo",
  "type": "regulatory",
  "updatedAt": "2026-01-01T00:00:00Z"
}

Autorizaciones

Authorization · string · header · requerido

JWT bearer token issued by the identity provider.

Parámetros de ruta

id · string · requerido

Unique deadline identifier.

Cuerpo

application/json

JSON request payload.

active · boolean

Updated active state.

Ejemplo:

false

color · string

Updated hex color.

Ejemplo:

"#00FF00"

description · string

Updated deadline description.

Ejemplo:

"Updated description"

dueDate · string<date-time>

Updated deadline due date and time.

Ejemplo:

"2026-06-30T23:59:59Z"

filters · object

Updated filter conditions, grouped by data source, table, and field. Omit the member, or send null, to leave the stored filter unchanged; send an empty object to remove it. A filter that is sent REPLACES the stored one whole: there is no merge, and no way to remove one branch while keeping the rest.

Show child attributes

Ejemplo:

{
  "accounts": {
    "account": {
      "vencimento": { "period": "previous_month" }
    }
  }
}

frequency · string

Updated recurrence frequency.

Ejemplo:

"annual"

monthsOfYear · integer<int64>[] | null

Updated recurrence months.

Ejemplo:

[6]

name · string

Updated human-readable deadline name.

Ejemplo:

"Updated Report Name"

notifyDaysBefore · integer<int64>

Updated notification lead time in days.

Ejemplo:

10

templateId · string

Updated template identifier.

Ejemplo:

"00000000-0000-0000-0000-000000000001"

type · string

Updated deadline category.

Ejemplo:

"custom"

Respuesta

200

application/json

OK

active · boolean

Whether the deadline is active.

Ejemplo:

true

color · string

Hex color used to identify the deadline.

Ejemplo:

"#FF5733"

createdAt · string<date-time>

Date and time when the deadline was created.

Ejemplo:

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

deliveredAt · string<date-time>

Date and time when the deadline was delivered.

Ejemplo:

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

description · string

Optional deadline description.

Ejemplo:

"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.

Ejemplo:

"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.

Show child attributes

Ejemplo:

{
  "accounts": {
    "account": {
      "vencimento": { "period": "previous_month" }
    }
  }
}

frequency · string

Deadline recurrence frequency.

Ejemplo:

"monthly"

id · string

Unique deadline identifier.

Ejemplo:

"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.

Ejemplo:

"00000000-0000-0000-0000-000000000000"

monthsOfYear · integer<int64>[] | null

Months in which a semiannual or annual deadline occurs.

Ejemplo:

[1, 6]

name · string

Human-readable deadline name.

Ejemplo:

"Monthly Regulatory Report"

notifyDaysBefore · integer<int64>

Days before the due date when notifications begin.

Ejemplo:

5

status · string

Current derived deadline status.

Ejemplo:

"pending"

templateId · string

Template used to generate the report.

Ejemplo:

"00000000-0000-0000-0000-000000000000"

templateName · string

Human-readable name of the associated template.

Ejemplo:

"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.

Ejemplo:

"America/Sao_Paulo"

type · string

Deadline category.

Ejemplo:

"regulatory"

updatedAt · string<date-time>

Date and time when the deadline was last updated.

Ejemplo:

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