Actualizar un plazo

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}

Actualizar un plazo

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

Estos endpoints sustentan la gestión de plazos en la Consola. También puede llamarlos directamente para integrar los plazos en sus propios sistemas.

Autorizaciones

Authorization

string

header

requerido

Autenticación mediante token Bearer. Formato: 'Bearer {access_token}'. Solo es obligatoria cuando el plugin de autenticación está habilitado.

Parámetros de ruta

string

requerido

Identificador único del plazo (UUID).

Cuerpo

application/json

Cuerpo JSON de la solicitud.

active

boolean

Estado activo actualizado.

Ejemplo:

false

color

string

Color hexadecimal actualizado.

Ejemplo:

"#00FF00"

description

string

Descripción del plazo actualizada.

Ejemplo:

"Updated description"

dueDate

string<date-time>

Fecha y hora de vencimiento del plazo actualizadas.

Ejemplo:

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

frequency

string

Frecuencia de recurrencia actualizada.

Ejemplo:

"annual"

monthsOfYear

integer<int64>[] | null

Meses de recurrencia actualizados.

Ejemplo:

[6]

name

string

Nombre legible del plazo actualizado.

Ejemplo:

"Updated Report Name"

notifyDaysBefore

integer<int64>

Tiempo de antelación de la notificación actualizado, en días.

Ejemplo:

10

templateId

string

Identificador de la plantilla actualizado.

Ejemplo:

"00000000-0000-0000-0000-000000000001"

type

string

Categoría del plazo actualizada.

Ejemplo:

"custom"

Respuesta

Correcto

active

boolean

Indica si el plazo está activo.

Ejemplo:

true

color

string

Color usado para identificar visualmente el plazo (formato hexadecimal).

Ejemplo:

"#FF5733"

createdAt

string<date-time>

Fecha y hora en que se creó el plazo.

Ejemplo:

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

deliveredAt

string<date-time>

Fecha y hora en que se entregó el plazo, si aplica.

Ejemplo:

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

description

string

Descripción del plazo.

Ejemplo:

"Monthly regulatory compliance report"

dueDate

string<date-time>

Fecha y hora de vencimiento del plazo, en formato RFC 3339.

Ejemplo:

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

frequency

string

Con qué frecuencia se repite el plazo (p. ej., monthly, annual).

Ejemplo:

"monthly"

string

Identificador único del plazo (UUID).

Ejemplo:

"00000000-0000-0000-0000-000000000000"

monthsOfYear

integer<int64>[] | null

Meses del año (1-12) en los que aplica el plazo.

Ejemplo:

[1, 6]

name

string

Nombre legible del plazo.

Ejemplo:

"Monthly Regulatory Report"

notifyDaysBefore

integer<int64>

Número de días antes de la fecha de vencimiento en que comienzan las notificaciones.

Ejemplo:

5

status

string

Estado actual del plazo (p. ej., pending, overdue, delivered).

Ejemplo:

"pending"

templateId

string

Identificador único de la plantilla usada para cumplir el plazo (UUID).

Ejemplo:

"00000000-0000-0000-0000-000000000000"

templateName

string

Nombre de la plantilla usada para cumplir el plazo.

Ejemplo:

"Financial Template"

type

string

Tipo del plazo (p. ej., regulatory, custom).

Ejemplo:

"regulatory"

updatedAt

string<date-time>

Fecha y hora de la última actualización del plazo.

Ejemplo:

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

Obtener notificaciones de plazos

Eliminar un plazo

⌘I