| Help Center
Group Admin Documentation
Core Concepts
Account Setup - Managed Users
Account Setup - Managed Syncs
Account & Billing
Go to User Docs

API (Beta)

Version history
0.1    2022-12-01    Initial Beta Release

POST /links

Base URL: https://manageapi.calendarbridge.com

This endpoint is for creating and deleting managed sync connections between calendars on admin-authorized domains.

Important! The API assumes the desire is to sync the default/primary calendars of the two accounts.

Headers

KeyValueDescription
cb_key<<Your API Key>>API key provided to you by CalendarBridge

 

Request Body

PropertyTypedescriptionRequired?
actionStringTwo supported values:

  • “add” for creating a sync connection;
  • “delete” for deleting a sync connection
Always
sourceEmailStringEmail address for the source calendarAlways
sourceTypeStringTwo supported values:

  • “ms” for Microsoft 365
  • “google” for Google Workspace
Always
sourceTzStringSee supported time zones belowFor “add”
destinationEmailStringEmail address for the destination calendarAlways
destinationTypeStringTwo supported values:

  • “ms” for Microsoft 365
  • “google” for Google Workspace
Always
destinationTzStringSee supported time zones appendixFor “add”
policyStringIf you want to sync one or more fields of the calendar event object, provide a string with the fields you want to sync separated by ‘|’ (vertical bar or “pipe”). Available fields:

  • “time” – a policy of simply “time” will res
  • “subject” – sync the event subject
  • “description” – sync the event description/body
  • “location” – sync the location of the event
  • “meeting” – Sync the online conference (e.g., Zoom, Teams, Meet) information
  • “contact” – copy the list of attendees into the body/description of the event copy

There are two additional flags that can be included in the string:

  • “reminder” – this will cause the event copy to have a notification according to the default notification settings of the destination calendar.  The default is that the event copy will have no notification set.
  • “private” – this will cause all event copies to be marked as private.  The default is that the public/private status of the event is synced to the event copy
For “add”

Responses

Action: Add

  • “200: added to queue” – creation of the sync is queued. Creating a sync connection can take from 1 to 10 minutes depending mostly on how many events on are on the source calendar. Sync connections on a tenant are created sequentially (not in parallel) so creating many sync connections can take up to 10 minutes times the number of sync connections queued.
  • “400: Sync already exists” — The sync connection already exists.  If you don’t see it in the dashboard, it is still in queue.
  • “500: Error creating sync, users may not exist” — Currently this error is thrown if the request is missing a required property.  If all required request properties are present, double check for typos in the email addresses, and that the mailboxes have been initialized (they may need to be logged into at least once before the calendar is fully initialized).

Action: Delete

  • “200: added to queue” – deletion of the sync is queued. Deleting a sync connection can take from 1 to 10 minutes depending mostly on how many events on are on the source calendar. Sync connections on a tenant are created sequentially (not in parallel) so creating many sync connections can take up to 10 minutes times the number of sync connections queued.
  • “404: Sync not found” — Double check the email addresses and that all required properties are present

Example Requests

Create a new sync connection from tester@managelegalspend.com to pradeepg@tzv1w.onmicrosoft.com where event subjects, descriptions, attendees, and locations are synced to the destination calendar and “(from mls)” is appended to the subjects of the event copies

curl –request POST \
--url https://dev-manageapi.calendarbridge.com/links \
--header ‘cb_key <<YOUR_API_KEY>>’ \
--data ‘{"action": "add","sourceEmail": "tester@managelegalspend.com","sourceType": "google","sourceTz": "America/Chicago","destinationEmail": "pradeepg@tzv1w.onmicrosoft.com","destinationTz": "America/Chicago","destinationType": "ms","tag": "(from mls)","policy": "subject|description|contact|location"}'

 

Delete a sync connection from tester@managelegalspend.com to pradeepg@tzv1w.onmicrosoft.com

curl –request POST \
--url https://dev-manageapi.calendarbridge.com/links \
--header ‘cb_key <<YOUR_API_KEY>>’ \
--data ‘{"action": "delete","sourceEmail": "tester@managelegalspend.com","sourceType": "google","destinationEmail": "pradeepg@tzv1w.onmicrosoft.com","destinationType": "ms"}'

 

Supported Time Zones

America/Phoenix
America/Port_of_Spain
America/Port-au-Prince
America/Porto_Velho
America/Puerto_Rico
America/Punta_Arenas
America/Rainy_River
America/Rankin_Inlet
America/Recife
America/Regina
America/Resolute
America/Rio_Branco
America/Santarem
America/Santiago
America/Santo_Domingo
America/Sao_Paulo
America/Scoresbysund
America/Sitka
America/St_Johns
America/Swift_Current
America/Tegucigalpa
America/Thule
America/Thunder_Bay
America/Tijuana
America/Toronto
America/Vancouver
America/Whitehorse
America/Winnipeg
America/Yakutat
America/Yellowknife
Antarctica/Casey
Antarctica/Davis
Antarctica/DumontDUrville
Antarctica/Macquarie
Antarctica/Mawson
Antarctica/Palmer
Antarctica/Rothera
Antarctica/Syowa
Antarctica/Troll
Antarctica/Vostok
Asia/Almaty
Asia/Amman
Asia/Anadyr
Asia/Aqtau
Asia/Aqtobe
Asia/Ashgabat
Asia/Atyrau
Asia/Baghdad
Asia/Baku
Asia/Bangkok
Asia/Barnaul
Asia/Beirut
Asia/Bishkek
Asia/Brunei
Asia/Chita
Asia/Choibalsan
Asia/Colombo
Asia/Damascus
Asia/Dhaka
Asia/Dili
Asia/Dubai
Asia/Dushanbe
Asia/Famagusta
Asia/Gaza
Asia/Hebron
Asia/Ho_Chi_Minh
Asia/Hong_Kong
Asia/Hovd
Asia/Irkutsk
Asia/Jakarta
Asia/Jayapura
Asia/Jerusalem
Asia/Kabul
Asia/Kamchatka
Asia/Karachi
Asia/Kathmandu
Asia/Khandyga
Asia/Kolkata
Asia/Krasnoyarsk
Asia/Kuala_Lumpur
Asia/Kuching
Asia/Macau
Asia/Magadan
Asia/Makassar
Asia/Manila
Asia/Nicosia
Asia/Novokuznetsk
Asia/Novosibirsk
Asia/Omsk
Asia/Oral
Asia/Pontianak
Asia/Pyongyang
Asia/Qatar
Asia/Qostanay
Asia/Qyzylorda
Asia/Riyadh
Asia/Sakhalin
Asia/Samarkand
Asia/Seoul
Asia/Shanghai
Asia/Singapore
Asia/Srednekolymsk
Asia/Taipei
Asia/Tashkent
Asia/Tbilisi
Asia/Tehran
Asia/Thimphu
Asia/Tokyo
Asia/Tomsk
Asia/Ulaanbaatar
Asia/Urumqi
Asia/Ust-Nera
Asia/Vladivostok
Asia/Yakutsk
Asia/Yangon
Asia/Yekaterinburg
Asia/Yerevan
Atlantic/Azores
Atlantic/Bermuda
Atlantic/Canary
Atlantic/Cape_Verde
Atlantic/Faroe
Atlantic/Madeira
Atlantic/Reykjavik
Atlantic/South_Georgia
Atlantic/Stanley
Australia/Adelaide
Australia/Brisbane
Australia/Broken_Hill
Australia/Darwin
Australia/Eucla
Australia/Hobart
Australia/Lindeman
Australia/Lord_Howe
Australia/Melbourne
Australia/Perth
Australia/Sydney
Etc/GMT
Europe/Amsterdam
Europe/Andorra
Europe/Astrakhan
Europe/Athens
Europe/Belgrade
Europe/Berlin
Europe/Brussels
Europe/Bucharest
Europe/Budapest
Europe/Chisinau
Europe/Copenhagen
Europe/Dublin
Europe/Gibraltar
Europe/Helsinki
Europe/Istanbul
Europe/Kaliningrad
Europe/Kiev
Europe/Kirov
Europe/Lisbon
Europe/London
Europe/Luxembourg
Europe/Madrid
Europe/Malta
Europe/Minsk
Europe/Monaco
Europe/Moscow
Europe/Oslo
Europe/Paris
Europe/Prague
Europe/Riga
Europe/Rome
Europe/Samara
Europe/Saratov
Europe/Simferopol
Europe/Sofia
Europe/Stockholm
Europe/Tallinn
Europe/Tirane
Europe/Ulyanovsk
Europe/Uzhgorod
Europe/Vienna
Europe/Vilnius
Europe/Volgograd
Europe/Warsaw
Europe/Zaporozhye
Europe/Zurich
Indian/Chagos
Indian/Christmas
Indian/Cocos
Indian/Kerguelen
Indian/Mahe
Indian/Maldives
Indian/Mauritius
Indian/Reunion
Pacific/Apia
Pacific/Auckland
Pacific/Bougainville
Pacific/Chatham
Pacific/Chuuk
Pacific/Easter
Pacific/Efate
Pacific/Enderbury
Pacific/Fakaofo
Pacific/Fiji
Pacific/Funafuti
Pacific/Galapagos
Pacific/Gambier
Pacific/Guadalcanal
Pacific/Guam
Pacific/Honolulu
Pacific/Kiritimati
Pacific/Kosrae
Pacific/Kwajalein
Pacific/Majuro
Pacific/Marquesas
Pacific/Nauru
Pacific/Niue
Pacific/Norfolk
Pacific/Noumea
Pacific/Pago_Pago
Pacific/Palau
Pacific/Pitcairn
Pacific/Pohnpei
Pacific/Port_Moresby
Pacific/Rarotonga
Pacific/Tahiti
Pacific/Tarawa
Pacific/Tongatapu
Pacific/Wake
Pacific/Wallis