POST
/
v1
/
events

Authorizations

Authorization
string
headerrequired

Bearer HTTP authentication. Allowed headers-- Authorization: Bearer <api_key>

Body

application/json
name
string
required

The event's name, meant to be displayable to the customer.

Maximum length: 5000
start
string
required

The start date and time of the event, in ISO 8601 format.

calendar
any
required

The ID of the calendar this event is associated with.

active
boolean
default: true

Whether the event is currently available. Defaults to true.

description
string

The event's description, meant to be displayable to the customer. Use this field to optionally store a long form explanation of the event for your own rendering purposes.

Maximum length: 40000
end
string

The end date and time of the event, in ISO 8601 format.

location
string

The intended physical or virtual place where the event will take place.

Maximum length: 5000
url
string | null

A URL of a publicly-accessible webpage for this event.

Maximum length: 2048

Response

200 - application/json

Events describe the specific events available to your customers. Events are programmed within Calendars.

active
boolean

Whether the event is currently available for use.

created
string

Time at which the object was created, in ISO 8601 format.

description
string | null

The event's description, meant to be displayable to the customer. Use this field to optionally store a long form explanation of the event for your own rendering purposes.

Maximum length: 40000
end
string

The end date and time of the event, in ISO 8601 format.

id
string

Unique identifier for the object.

Maximum length: 5000
location
string

The intended physical or virtual place where the event will take place.

Maximum length: 5000
name
string

The event's name, meant to be displayable to the customer.

Maximum length: 5000
object
enum<string>

String representing the object's type. Objects of the same type share the same value.

Available options:
event
calendar
any

The ID of the calendar this event is associated with.

start
string

The start date and time of the event, in ISO 8601 format.

updated
string

Time at which the object was last updated, in ISO 8601 format.

url
string | null

A URL of a publicly-accessible webpage for this event.

Maximum length: 2048