PATCH
/
{version}
/
events
/
{event}
curl --request PATCH \
  --url https://api.perscom.io/{version}/events/{event} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "<string>",
  "calendar_id": 123,
  "description": "<string>",
  "content": "<string>",
  "location": "<string>",
  "url": "<string>",
  "author_id": 123,
  "all_day": false,
  "starts": "2023-11-07T05:31:56Z",
  "ends": "2023-11-07T05:31:56Z",
  "repeats": false,
  "registration_enabled": true,
  "registration_deadline": "2023-11-07T05:31:56Z",
  "notifications_enabled": true,
  "notifications_interval": [
    "pt0m"
  ],
  "notifications_channels": [
    "broadcast"
  ]
}'
{
  "data": {
    "id": 123,
    "name": "<string>",
    "calendar_id": 123,
    "description": "<string>",
    "content": "<string>",
    "location": "<string>",
    "url": "<string>",
    "author_id": 123,
    "all_day": false,
    "starts": "2023-11-07T05:31:56Z",
    "ends": "2023-11-07T05:31:56Z",
    "repeats": false,
    "registration_enabled": true,
    "registration_deadline": "2023-11-07T05:31:56Z",
    "notifications_enabled": true,
    "notifications_interval": [
      "pt0m"
    ],
    "notifications_channels": [
      "broadcast"
    ],
    "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
​
event
integer
required

Query Parameters

​
include
enum<string>
Available options:
attachments,
author,
author.*,
calendar,
calendar.*,
comments,
comments.*,
image,
schedule,
tags

Body

application/json
​
name
string
required
​
calendar_id
integer
required
​
author_id
integer
required
​
all_day
boolean
default:false
required
​
starts
string
required
​
ends
string | null
required
​
repeats
boolean
default:false
required
​
registration_enabled
boolean
default:true
required
​
notifications_enabled
boolean
default:true
required
​
description
string | null

Supports HTML.

​
content
string | null

Supports HTML.

​
location
string | null
​
url
string | null
​
registration_deadline
string | null
​
notifications_interval
enum<string>[] | null
Available options:
pt0m,
pt15m,
pt1h,
p1d,
p1w
​
notifications_channels
enum<string>[] | null
Available options:
broadcast,
database,
discord_private,
discord_public,
mail,
sms

Response

200
application/json
OK
​
data
object

Was this page helpful?

Delete eventCreate a batch of events