Update a deadline

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}

Update a deadline

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

These endpoints power deadline management in the Console. You can also call them directly to integrate deadlines into your own systems.

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"

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.

Example:

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

frequency

string

Deadline recurrence frequency.

Example:

"monthly"

string

Unique deadline identifier.

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"

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"

List deadline notifications

Delete a deadline

⌘I