Calendar NotificationsVersion: 2021-04-15

Get notifications

GET/calendars/{calendarId}/notifications

Get calendar notifications based on query

Authorizations

Authorizationstringheaderrequired

Bearer authentication header of the form Bearer <token>, where <token> is your access token.

Scope:calendars/events.readonly

Auth methods:OAuthPrivate Integration

Token type:Sub-Account Token

Request

Headers

Versionstringrequired

API Version

Available options2021-04-15

Example:2021-04-15

Path Parameters

calendarIdstringrequired

Calendar ID

Example:ocQHyuzHvysMo5N5VsXc

Query Parameters

isActiveboolean

Filter by active status

Example:true

deletedboolean

Include deleted notifications

Example:false

limitnumber

Number of records to return

Default:100

Example:20

skipnumber

Number of records to skip

Default:0

Example:0

Response

application/json

Successful response

Array items

_idstring

Notification ID

Example:629a5d0a8c3f2b001f3d4e5a

receiverTypestring

Notification recipient type

Available optionscontactguestassignedUseremailsphoneNumbersbusiness

Example:contact

additionalEmailIdsstring[]

Additional email addresses to receive notifications

Example:["[email protected]","[email protected]"]

additionalPhoneNumbersstring[]

Additional phone numbers to receive notifications

Example:["+919876744444","+919876744445"]

channelstring

Notification channel

Available optionsemailinAppsmswhatsapp

Example:email

notificationTypestring

Notification type

Available optionsbookedconfirmationcancellationreminderfollowupreschedule

Example:confirmation

isActiveboolean

Whether the notification is active

Example:true

additionalWhatsappNumbersstring[]

Additional WhatsApp numbers to receive notifications

Example:["+919876744444","+919876744445"]

templateIdstring

Template ID for the notification

Example:0as9d8as0d

bodystring

Notification body content

Example:This is a test notification

subjectstring

Notification subject line

Example:Test Notification

afterTimeobject[]

Time schedules after which follow-up notifications are sent

beforeTimeobject[]

Time schedules before which reminder notifications are sent

selectedUsersstring[]

Selected user IDs for the notification

Example:["user1","user2"]