Create or Update Event BETA

Description #

Requests conferencing details are added to an event. When creating or updating an event, add the conferencing property as specified below. When the conferencing property is not specified, we will not make changes to the event’s conferencing.

Example Requests #

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-10-22T15:30:00Z",
  "end": "2020-10-22T17:00:00Z",
  "conferencing": {
    "profile_id": "default"
  }
}
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-10-22T15:30:00Z",
  "end": "2020-10-22T17:00:00Z",
  "conferencing": {
    "profile_id": "explicit",
    "provider_description": "Custom conferencing",
    "join_url": "https://conferencing.example.com/join/xyz"
  }
}

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.

This should equal one of the built-in values, or, to explicitly select a conferencing profile, a profile_id taken from the account’s Conferencing Profiles.

Built-in values
  • 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 integrated conferencing provider for the destination calendar, if available. (e.g. Google Meet for Google calendars)
    3. Anonymous, browser based video link.
  • none explicitly removes conferencing from an event.

  • explicit is a special value which allows you to manually specify the conferencing join details. When using explicit, you must also specify the conferencing.provider_description and conferencing.join_url parameters.

  • integrated is a special value which requests the integrated conferencing service for the destination calendar be used. Currently, only Google calendars are supported, where a Google Meet conference will be created. Discover whether this is available by checking the calendar_integrated_conferencing_available value on the List Calendars API.

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

conferencing.provider_description  #

Required, and only used, when using the explicit special conferencing.profile_id.

Use this to specify the user-facing name of the conferencing provider. This displays in calendars that have native support for conferencing, for example on the Google Calendar conferencing join button.

conferencing.join_url  #

Required, and only used, when using the explicit special conferencing.profile_id.

Use this to specify the URL to join the conference. This must be an HTTP/HTTPS URI.

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"
  }
}

Conferencing details are added asynchronously. Your application can subscribe to a push notification when this is assigned. See Conferencing Services Push Notification documentation for more information.

Error Responses #

422 Unprocessable #

Requesting integrated conferencing on a calendar which does not support it will result in the following error response.

This might be because the target calendar is not a Google calendar, or because Google Meet has been administratively disabled on that account in the case of a G Suite domain.

{
  "errors": {
    "conferencing.profile_id": [
      {
          "key": "errors.integrated_conferencing_not_available",
          "description": "Integrated conferencing is not available on this calendar"
      }
    ]
  }
}
Search