Update a deadline

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"
}
'

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://reporter.sandbox.lerian.net/v1/deadlines/{id}"

	payload := strings.NewReader("{\n  \"active\": false,\n  \"color\": \"#00FF00\",\n  \"description\": \"Updated description\",\n  \"dueDate\": \"2026-06-30T23:59:59Z\",\n  \"filters\": {\n    \"accounts\": {\n      \"account\": {\n        \"vencimento\": {\n          \"period\": \"previous_month\"\n        }\n      }\n    }\n  },\n  \"frequency\": \"annual\",\n  \"monthsOfYear\": [\n    6\n  ],\n  \"name\": \"Updated Report Name\",\n  \"notifyDaysBefore\": 10,\n  \"templateId\": \"00000000-0000-0000-0000-000000000001\",\n  \"type\": \"custom\"\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    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'
  })
};

fetch('https://reporter.sandbox.lerian.net/v1/deadlines/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://reporter.sandbox.lerian.net/v1/deadlines/{id}"

payload = {
    "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"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

{
  "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"
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "body.templateId",
      "message": "expected string to match 'uuid' format",
      "value": "not-a-uuid"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "body.templateId",
      "message": "expected string to match 'uuid' format",
      "value": "not-a-uuid"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "body.templateId",
      "message": "expected string to match 'uuid' format",
      "value": "not-a-uuid"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "body.templateId",
      "message": "expected string to match 'uuid' format",
      "value": "not-a-uuid"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "body.templateId",
      "message": "expected string to match 'uuid' format",
      "value": "not-a-uuid"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "body.templateId",
      "message": "expected string to match 'uuid' format",
      "value": "not-a-uuid"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "body.templateId",
      "message": "expected string to match 'uuid' format",
      "value": "not-a-uuid"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

PATCH

deadlines

{id}

Update a deadline

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"
}
'

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://reporter.sandbox.lerian.net/v1/deadlines/{id}"

	payload := strings.NewReader("{\n  \"active\": false,\n  \"color\": \"#00FF00\",\n  \"description\": \"Updated description\",\n  \"dueDate\": \"2026-06-30T23:59:59Z\",\n  \"filters\": {\n    \"accounts\": {\n      \"account\": {\n        \"vencimento\": {\n          \"period\": \"previous_month\"\n        }\n      }\n    }\n  },\n  \"frequency\": \"annual\",\n  \"monthsOfYear\": [\n    6\n  ],\n  \"name\": \"Updated Report Name\",\n  \"notifyDaysBefore\": 10,\n  \"templateId\": \"00000000-0000-0000-0000-000000000001\",\n  \"type\": \"custom\"\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    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'
  })
};

fetch('https://reporter.sandbox.lerian.net/v1/deadlines/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://reporter.sandbox.lerian.net/v1/deadlines/{id}"

payload = {
    "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"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

{
  "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"
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "body.templateId",
      "message": "expected string to match 'uuid' format",
      "value": "not-a-uuid"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "body.templateId",
      "message": "expected string to match 'uuid' format",
      "value": "not-a-uuid"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "body.templateId",
      "message": "expected string to match 'uuid' format",
      "value": "not-a-uuid"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "body.templateId",
      "message": "expected string to match 'uuid' format",
      "value": "not-a-uuid"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "body.templateId",
      "message": "expected string to match 'uuid' format",
      "value": "not-a-uuid"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "body.templateId",
      "message": "expected string to match 'uuid' format",
      "value": "not-a-uuid"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "body.templateId",
      "message": "expected string to match 'uuid' format",
      "value": "not-a-uuid"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

Authorizations

Authorization

string

header

required

JWT bearer token issued by the identity provider.

Path Parameters

string

required

Unique deadline identifier.

Body

application/json

JSON request payload.

active

boolean

Updated active state.

Example:

false

color

string

Updated hex color.

Example:

"#00FF00"

description

string

Updated deadline description.

Example:

"Updated description"

dueDate

string<date-time>

Updated deadline due date and time.

Example:

"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

Example:

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

frequency

string

Updated recurrence frequency.

Example:

"annual"

monthsOfYear

integer<int64>[] | null

Updated recurrence months.

Example:

[6]

name

string

Updated human-readable deadline name.

Example:

"Updated Report Name"

notifyDaysBefore

integer<int64>

Updated notification lead time in days.

Example:

10

templateId

string

Updated template identifier.

Example:

"00000000-0000-0000-0000-000000000001"

type

string

Updated deadline category.

Example:

"custom"

Response

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. Its clock time is the hour the reminder starts firing from.

Example:

"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

Example:

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

frequency

string

Deadline recurrence frequency.

Example:

"monthly"

string

Unique deadline identifier.

Example:

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

Example:

"00000000-0000-0000-0000-000000000000"

monthsOfYear

integer<int64>[] | null

Months in which a semiannual or annual deadline occurs.

Example:

[1, 6]

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"

timezone

string

IANA timezone name that gives the dueDate clock time its meaning and along which the recurrence advances. Empty means UTC.

Example:

"America/Sao_Paulo"

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"

Getting started

Templates API

Template Builder API

Reports API

Deadlines API

Data Sources API

Institutions API

Regulatory Catalog API

Regulatory Subscriptions API

Regulatory Bindings API

Regulatory Reports API

Metrics API

Streaming API

Error handling

Events

Update a deadline

Authorizations

Path Parameters

Body

Response