Update a batch of events

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

{
  "data": [
    {
      "name": "<string>",
      "calendar_id": 123,
      "all_day": false,
      "starts": "2023-11-07T05:31:56Z",
      "ends": "2023-11-07T05:31:56Z",
      "repeats": false,
      "registration_enabled": true,
      "notifications_enabled": true,
      "id": 123,
      "description": "<string>",
      "content": "<string>",
      "location": "<string>",
      "url": "<string>",
      "author_id": 123,
      "registration_deadline": "2023-11-07T05:31:56Z",
      "notifications_interval": [
        "pt0m"
      ],
      "notifications_channels": [
        "broadcast"
      ],
      "label": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ]
}

PATCH

{version}

events

batch

Update a batch of events

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

{
  "data": [
    {
      "name": "<string>",
      "calendar_id": 123,
      "all_day": false,
      "starts": "2023-11-07T05:31:56Z",
      "ends": "2023-11-07T05:31:56Z",
      "repeats": false,
      "registration_enabled": true,
      "notifications_enabled": true,
      "id": 123,
      "description": "<string>",
      "content": "<string>",
      "location": "<string>",
      "url": "<string>",
      "author_id": 123,
      "registration_deadline": "2023-11-07T05:31:56Z",
      "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

Query Parameters

include

enum<string>

Available options:

attachments,

author,

author.*,

calendar,

calendar.*,

comments,

comments.*,

image,

schedule,

tags

Body

application/json

resources

object

Show child attributes

resources.{key}

Event · object

Show child attributes

resources.{key}.name

string

required

resources.{key}.calendar_id

integer

required

resources.{key}.all_day

boolean

default:false

required

resources.{key}.starts

string<date-time>

required

resources.{key}.ends

string<date-time> | null

required

resources.{key}.repeats

boolean

default:false

required

resources.{key}.registration_enabled

boolean

default:true

required

resources.{key}.notifications_enabled

boolean

default:true

required

resources.{key}.description

string | null

Supports HTML.

resources.{key}.content

string | null

Supports HTML.

resources.{key}.location

string | null

resources.{key}.url

string | null

resources.{key}.author_id

integer

resources.{key}.registration_deadline

string<date-time> | null

resources.{key}.notifications_interval

enum<string>[] | null

Available options:

pt0m,

pt15m,

pt1h,

p1d,

p1w

resources.{key}.notifications_channels

enum<string>[] | null

Available options:

broadcast,

database,

discord_private,

discord_public,

mail,

sms

Response

data

EventResource · object[]

Show child attributes

data.name

string

required

data.calendar_id

integer

required

data.all_day

boolean

default:false

required

data.starts

string<date-time>

required

data.ends

string<date-time> | null

required

data.repeats

boolean

default:false

required

data.registration_enabled

boolean

default:true

required

data.notifications_enabled

boolean

default:true

required

data.id

integer

data.description

string | null

Supports HTML.

data.content

string | null

Supports HTML.

data.location

string | null

data.url

string | null

data.author_id

integer

data.registration_deadline

string<date-time> | null

data.notifications_interval

enum<string>[] | null

Available options:

pt0m,

pt15m,

pt1h,

p1d,

p1w

data.notifications_channels

enum<string>[] | null

Available options:

broadcast,

database,

discord_private,

discord_public,

mail,

sms

data.label

string

data.created_at

string<date-time>

The date the resource was created. Stored in UTC.

data.updated_at

string<date-time>

The date the resource was updated. Stored in UTC.

Delete a batch of events Get a list of images

⌘I

API Reference

Authorizations

Path Parameters

Query Parameters

Body

Response