Create or Update Event ALPHA

Description #

Requests conferencing details are added to an event.

Example Request #

POST /v1/calendars/cal_n23kjnwrw2_jsdfjksn234/events HTTP/1.1
Host: api.cronofy.com
Authorization: Bearer {ACCESS_TOKEN}
Content-Type: application/json; charset=utf-8

{
  "event_id": "qTtZdczOccgaPncGJaCiLg",
  "summary": "Board meeting",
  "description": "Discuss plans for the next quarter.",
  "start": "2020-06-04T15:30:00Z",
  "end": "2020-06-04T17:00:00Z",
  "conferencing": {
    "profile_id": "default"
  }
}

Parameters #

conferencing optional  #

Object describing the desired conferencing details.

conferencing.profile_id required  #

When provided defines the conferencing profile to use when provisioning the conference details.

default is a special value to ease integration. This has the following preference:

  1. The default conferencing profile out of those authorized by the user. This will be the first conferencing profile that they have authorized unless the user has explicitly chosen a default.
  2. The implicit conferencing provider for the calendar (e.g Google Meet).
  3. Anonymous, browser based video link.

To explicitly remove conferencing from an event, a special value of none should be provided.

To explicitly select a conferencing profile, a profile_id taken from the account’s Conferencing Profiles should be used.

8x8 is a special value which allows 8x8 to be chosen explicitly.

Example Event With Conferencing Assigned #

{
  "event_id": "qTtZdczOccgaPncGJaCiLg",
  "summary": "Board meeting",
  "description": "Discuss plans for the next quarter.",
  "start": "2020-04-11T15:30:00Z",
  "end": "2020-04-11T17:00:00Z",
  "conferencing": {
    "provider_name": "zoom",
    "join_url": "https://zoom.us/00001111-222",
    "entry_points": [
      {
        "type": "video",
        "uri": "https://zoom.us/00001111-222"
      }
    ]
  }
}

Conferencing details are added asynchronously.

Search