Skip to main content
PATCH
/
{version}
/
calendars
/
{calendar}
Update calendar
curl --request PATCH \
  --url https://api.perscom.io/{version}/calendars/{calendar} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "color": "<string>",
  "description": "<string>"
}
'
{
  "data": {
    "name": "<string>",
    "color": "<string>",
    "id": 123,
    "description": "<string>",
    "label": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
version
enum<string>
default:v2
required

The API version to use.

Available options:
v1,
v2
​
calendar
integer
required

Query Parameters

​
include
enum<string>
Available options:
events,
events.author,
tags

Body

application/json
​
name
string
required

The name of the calendar.

Maximum string length: 255
​
color
string
required

The calendar color. Provided as a 6 digit hex code.

Maximum string length: 255
​
description
string | null

A description of the calendar. Supports HTML.

Maximum string length: 65535

Response

OK

​
data
CalendarResource · object