Create a calendar event

post

https://api.unipile.com/v2/{account_id}/calendars/{calendar_id}/events

Create a brand new calendar event.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

calendar_id

string

required

length ≥ 1

Identifier of the parent calendar.

account_id

string

required

^acc_(.*)$

ID of the Account (acc_xxx) to call the method on behalf of.

Body Params

title

string

required

The title of the event.

body

string

The body of the event.

location

string

The location of the event.

background_color

string

Background color of the calendar in hexadecimal format. For Google we match the closest palette available

transparency

string

enum

Defaults to transparent

The transparency of the event.
- opaque does block time on the calendar and is equivalent to setting Show me as to Busy in the Calendar UI.
- transparent does not block time on the calendar and is equivalent to setting Show me as to Available in the Calendar UI.

Allowed:

visibility

string

enum

Defaults to public

The visibility of the event.
- public is visible to all.
- private is visible only to the calendar owner.

Allowed:

conference

object

is_attendees_list_hidden

boolean

Is the attendees list hidden for attendees.

attendees

array of objects

required

attendees*

recurrence

array of strings

List of RRULE, EXRULE, RDATE and EXDATE lines for a recurring event, as specified in RFC5545.

recurrence

start

required

The start date and time of the event. Use date for all day events.

end

required

The end date and time of the event. Use date for all day events.

timezone

string

The IANA timezone the event is expressed in (e.g. Europe/Paris). Defaults to UTC when omitted.

Response

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201Default Response