Atualizar um prazo

curl --request PATCH \
  --url http://localhost:4005/v1/deadlines/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "active": true,
  "color": "<string>",
  "description": "<string>",
  "dueDate": "2023-11-07T05:31:56Z",
  "frequency": "<string>",
  "monthsOfYear": [
    123
  ],
  "name": "<string>",
  "notifyDaysBefore": 123,
  "templateId": "<string>",
  "type": "<string>"
}
'

import requests

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

payload = {
    "active": True,
    "color": "<string>",
    "description": "<string>",
    "dueDate": "2023-11-07T05:31:56Z",
    "frequency": "<string>",
    "monthsOfYear": [123],
    "name": "<string>",
    "notifyDaysBefore": 123,
    "templateId": "<string>",
    "type": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    active: true,
    color: '<string>',
    description: '<string>',
    dueDate: '2023-11-07T05:31:56Z',
    frequency: '<string>',
    monthsOfYear: [123],
    name: '<string>',
    notifyDaysBefore: 123,
    templateId: '<string>',
    type: '<string>'
  })
};

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

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "4005",
  CURLOPT_URL => "http://localhost:4005/v1/deadlines/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'active' => true,
    'color' => '<string>',
    'description' => '<string>',
    'dueDate' => '2023-11-07T05:31:56Z',
    'frequency' => '<string>',
    'monthsOfYear' => [
        123
    ],
    'name' => '<string>',
    'notifyDaysBefore' => 123,
    'templateId' => '<string>',
    'type' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

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

	payload := strings.NewReader("{\n  \"active\": true,\n  \"color\": \"<string>\",\n  \"description\": \"<string>\",\n  \"dueDate\": \"2023-11-07T05:31:56Z\",\n  \"frequency\": \"<string>\",\n  \"monthsOfYear\": [\n    123\n  ],\n  \"name\": \"<string>\",\n  \"notifyDaysBefore\": 123,\n  \"templateId\": \"<string>\",\n  \"type\": \"<string>\"\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))

}

HttpResponse<String> response = Unirest.patch("http://localhost:4005/v1/deadlines/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"active\": true,\n  \"color\": \"<string>\",\n  \"description\": \"<string>\",\n  \"dueDate\": \"2023-11-07T05:31:56Z\",\n  \"frequency\": \"<string>\",\n  \"monthsOfYear\": [\n    123\n  ],\n  \"name\": \"<string>\",\n  \"notifyDaysBefore\": 123,\n  \"templateId\": \"<string>\",\n  \"type\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"active\": true,\n  \"color\": \"<string>\",\n  \"description\": \"<string>\",\n  \"dueDate\": \"2023-11-07T05:31:56Z\",\n  \"frequency\": \"<string>\",\n  \"monthsOfYear\": [\n    123\n  ],\n  \"name\": \"<string>\",\n  \"notifyDaysBefore\": 123,\n  \"templateId\": \"<string>\",\n  \"type\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "active": true,
  "color": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "deliveredAt": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "dueDate": "2023-11-07T05:31:56Z",
  "frequency": "<string>",
  "id": "<string>",
  "monthsOfYear": [
    123
  ],
  "name": "<string>",
  "notifyDaysBefore": 123,
  "status": "<string>",
  "templateId": "<string>",
  "templateName": "<string>",
  "type": "<string>",
  "updatedAt": "2023-11-07T05:31:56Z"
}

{
  "code": "<string>",
  "detail": "<string>",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "about:blank"
}

{
  "code": "<string>",
  "detail": "<string>",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "about:blank"
}

{
  "code": "<string>",
  "detail": "<string>",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "about:blank"
}

{
  "code": "<string>",
  "detail": "<string>",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "about:blank"
}

{
  "code": "<string>",
  "detail": "<string>",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "about:blank"
}

{
  "code": "<string>",
  "detail": "<string>",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "about:blank"
}

{
  "code": "<string>",
  "detail": "<string>",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "about:blank"
}

PATCH

deadlines

{id}

Atualizar um prazo

curl --request PATCH \
  --url http://localhost:4005/v1/deadlines/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "active": true,
  "color": "<string>",
  "description": "<string>",
  "dueDate": "2023-11-07T05:31:56Z",
  "frequency": "<string>",
  "monthsOfYear": [
    123
  ],
  "name": "<string>",
  "notifyDaysBefore": 123,
  "templateId": "<string>",
  "type": "<string>"
}
'

import requests

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

payload = {
    "active": True,
    "color": "<string>",
    "description": "<string>",
    "dueDate": "2023-11-07T05:31:56Z",
    "frequency": "<string>",
    "monthsOfYear": [123],
    "name": "<string>",
    "notifyDaysBefore": 123,
    "templateId": "<string>",
    "type": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    active: true,
    color: '<string>',
    description: '<string>',
    dueDate: '2023-11-07T05:31:56Z',
    frequency: '<string>',
    monthsOfYear: [123],
    name: '<string>',
    notifyDaysBefore: 123,
    templateId: '<string>',
    type: '<string>'
  })
};

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

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "4005",
  CURLOPT_URL => "http://localhost:4005/v1/deadlines/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'active' => true,
    'color' => '<string>',
    'description' => '<string>',
    'dueDate' => '2023-11-07T05:31:56Z',
    'frequency' => '<string>',
    'monthsOfYear' => [
        123
    ],
    'name' => '<string>',
    'notifyDaysBefore' => 123,
    'templateId' => '<string>',
    'type' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

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

	payload := strings.NewReader("{\n  \"active\": true,\n  \"color\": \"<string>\",\n  \"description\": \"<string>\",\n  \"dueDate\": \"2023-11-07T05:31:56Z\",\n  \"frequency\": \"<string>\",\n  \"monthsOfYear\": [\n    123\n  ],\n  \"name\": \"<string>\",\n  \"notifyDaysBefore\": 123,\n  \"templateId\": \"<string>\",\n  \"type\": \"<string>\"\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))

}

HttpResponse<String> response = Unirest.patch("http://localhost:4005/v1/deadlines/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"active\": true,\n  \"color\": \"<string>\",\n  \"description\": \"<string>\",\n  \"dueDate\": \"2023-11-07T05:31:56Z\",\n  \"frequency\": \"<string>\",\n  \"monthsOfYear\": [\n    123\n  ],\n  \"name\": \"<string>\",\n  \"notifyDaysBefore\": 123,\n  \"templateId\": \"<string>\",\n  \"type\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"active\": true,\n  \"color\": \"<string>\",\n  \"description\": \"<string>\",\n  \"dueDate\": \"2023-11-07T05:31:56Z\",\n  \"frequency\": \"<string>\",\n  \"monthsOfYear\": [\n    123\n  ],\n  \"name\": \"<string>\",\n  \"notifyDaysBefore\": 123,\n  \"templateId\": \"<string>\",\n  \"type\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "active": true,
  "color": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "deliveredAt": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "dueDate": "2023-11-07T05:31:56Z",
  "frequency": "<string>",
  "id": "<string>",
  "monthsOfYear": [
    123
  ],
  "name": "<string>",
  "notifyDaysBefore": 123,
  "status": "<string>",
  "templateId": "<string>",
  "templateName": "<string>",
  "type": "<string>",
  "updatedAt": "2023-11-07T05:31:56Z"
}

{
  "code": "<string>",
  "detail": "<string>",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "about:blank"
}

{
  "code": "<string>",
  "detail": "<string>",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "about:blank"
}

{
  "code": "<string>",
  "detail": "<string>",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "about:blank"
}

{
  "code": "<string>",
  "detail": "<string>",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "about:blank"
}

{
  "code": "<string>",
  "detail": "<string>",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "about:blank"
}

{
  "code": "<string>",
  "detail": "<string>",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "about:blank"
}

{
  "code": "<string>",
  "detail": "<string>",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "about:blank"
}

Esses endpoints permitem o gerenciamento de prazos no Console. Você também pode chamá-los diretamente para integrar prazos aos seus próprios sistemas.

Autorizações

Authorization

string

header

obrigatório

Token bearer JWT emitido pelo provedor de identidade.

Parâmetros de caminho

string

obrigatório

Identificador único do prazo.

Corpo

application/json

Payload JSON da requisição.

active

boolean

Estado ativo atualizado.

Exemplo:

false

color

string

Cor hexadecimal atualizada.

Exemplo:

"#00FF00"

description

string

Descrição do prazo atualizada.

Exemplo:

"Updated description"

dueDate

string<date-time>

Data e hora de vencimento do prazo atualizadas.

Exemplo:

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

frequency

string

Frequência de recorrência atualizada.

Exemplo:

"annual"

monthsOfYear

integer<int64>[] | null

Meses de recorrência atualizados.

Exemplo:

[6]

name

string

Nome legível do prazo atualizado.

Exemplo:

"Updated Report Name"

notifyDaysBefore

integer<int64>

Antecedência de notificação atualizada, em dias.

Exemplo:

10

templateId

string

Identificador do template atualizado.

Exemplo:

"00000000-0000-0000-0000-000000000001"

type

string

Categoria do prazo atualizada.

Exemplo:

"custom"

Resposta

active

boolean

Se o prazo está ativo.

Exemplo:

true

color

string

Cor hexadecimal usada para identificar o prazo.

Exemplo:

"#FF5733"

createdAt

string<date-time>

Data e hora em que o prazo foi criado.

Exemplo:

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

deliveredAt

string<date-time>

Data e hora em que o prazo foi entregue.

Exemplo:

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

description

string

Descrição opcional do prazo.

Exemplo:

"Monthly regulatory compliance report"

dueDate

string<date-time>

Data e hora de vencimento do prazo.

Exemplo:

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

frequency

string

Frequência de recorrência do prazo.

Exemplo:

"monthly"

string

Identificador único do prazo.

Exemplo:

"00000000-0000-0000-0000-000000000000"

monthsOfYear

integer<int64>[] | null

Meses em que ocorre um prazo semestral ou anual.

Exemplo:

[1, 6]

name

string

Nome legível do prazo.

Exemplo:

"Monthly Regulatory Report"

notifyDaysBefore

integer<int64>

Quantidade de dias antes da data de vencimento em que as notificações começam.

Exemplo:

5

status

string

Status derivado atual do prazo.

Exemplo:

"pending"

templateId

string

Template usado para gerar o relatório.

Exemplo:

"00000000-0000-0000-0000-000000000000"

templateName

string

Nome legível do template associado.

Exemplo:

"Financial Template"

type

string

Categoria do prazo.

Exemplo:

"regulatory"

updatedAt

string<date-time>

Data e hora da última atualização do prazo.

Exemplo:

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

Listar notificações de prazo

Excluir um prazo

⌘I

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

Atualizar um prazo

Autorizações

Parâmetros de caminho

Corpo

Resposta