Update a deadline

curl --request PATCH \
  --url http://localhost:4005/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",
  "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 := "http://localhost:4005/v1/deadlines/{id}"

	payload := strings.NewReader("{\n  \"active\": false,\n  \"color\": \"#00FF00\",\n  \"description\": \"Updated description\",\n  \"dueDate\": \"2026-06-30T23:59:59Z\",\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',
    frequency: 'annual',
    monthsOfYear: [6],
    name: 'Updated Report Name',
    notifyDaysBefore: 10,
    templateId: '00000000-0000-0000-0000-000000000001',
    type: 'custom'
  })
};

fetch('http://localhost:4005/v1/deadlines/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "http://localhost:4005/v1/deadlines/{id}"

payload = {
    "active": False,
    "color": "#00FF00",
    "description": "Updated description",
    "dueDate": "2026-06-30T23:59:59Z",
    "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",
  "frequency": "monthly",
  "id": "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",
  "type": "regulatory",
  "updatedAt": "2026-01-01T00:00:00Z"
}

{
  "code": "ERR-0001",
  "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"
}

{
  "code": "ERR-0001",
  "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"
}

{
  "code": "ERR-0001",
  "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"
}

{
  "code": "ERR-0001",
  "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"
}

{
  "code": "ERR-0001",
  "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"
}

{
  "code": "ERR-0001",
  "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"
}

{
  "code": "ERR-0001",
  "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"
}

PATCH

deadlines

{id}

Update a deadline

curl --request PATCH \
  --url http://localhost:4005/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",
  "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 := "http://localhost:4005/v1/deadlines/{id}"

	payload := strings.NewReader("{\n  \"active\": false,\n  \"color\": \"#00FF00\",\n  \"description\": \"Updated description\",\n  \"dueDate\": \"2026-06-30T23:59:59Z\",\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',
    frequency: 'annual',
    monthsOfYear: [6],
    name: 'Updated Report Name',
    notifyDaysBefore: 10,
    templateId: '00000000-0000-0000-0000-000000000001',
    type: 'custom'
  })
};

fetch('http://localhost:4005/v1/deadlines/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "http://localhost:4005/v1/deadlines/{id}"

payload = {
    "active": False,
    "color": "#00FF00",
    "description": "Updated description",
    "dueDate": "2026-06-30T23:59:59Z",
    "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",
  "frequency": "monthly",
  "id": "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",
  "type": "regulatory",
  "updatedAt": "2026-01-01T00:00:00Z"
}

{
  "code": "ERR-0001",
  "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"
}

{
  "code": "ERR-0001",
  "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"
}

{
  "code": "ERR-0001",
  "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"
}

{
  "code": "ERR-0001",
  "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"
}

{
  "code": "ERR-0001",
  "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"
}

{
  "code": "ERR-0001",
  "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"
}

{
  "code": "ERR-0001",
  "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"
}

Autorizações

Authorization

string

header

obrigatório

JWT bearer token issued by the identity provider.

Parâmetros de caminho

string

obrigatório

Unique deadline identifier.

Corpo

application/json

JSON request payload.

active

boolean

Updated active state.

Exemplo:

false

color

string

Updated hex color.

Exemplo:

"#00FF00"

description

string

Updated deadline description.

Exemplo:

"Updated description"

dueDate

string<date-time>

Updated deadline due date and time.

Exemplo:

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

frequency

string

Updated recurrence frequency.

Exemplo:

"annual"

monthsOfYear

integer<int64>[] | null

Updated recurrence months.

Exemplo:

[6]

name

string

Updated human-readable deadline name.

Exemplo:

"Updated Report Name"

notifyDaysBefore

integer<int64>

Updated notification lead time in days.

Exemplo:

10

templateId

string

Updated template identifier.

Exemplo:

"00000000-0000-0000-0000-000000000001"

type

string

Updated deadline category.

Exemplo:

"custom"

Resposta

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.

Exemplo:

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

frequency

string

Deadline recurrence frequency.

Exemplo:

"monthly"

string

Unique deadline identifier.

Exemplo:

"00000000-0000-0000-0000-000000000000"

monthsOfYear

integer<int64>[] | null

Months in which a semiannual or annual deadline occurs.

Exemplo:

[1, 6]

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"

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"

Primeiros passos

API de Templates

API do Construtor de Templates

API de Relatórios

API de Prazos

API de Fontes de Dados

API de Métricas

API de Streaming

Tratamento de erros

Eventos

Update a deadline

Autorizações

Parâmetros de caminho

Corpo

Resposta