Calendar NotificationsVersion: v3

Update notification

PUT/calendars/{calendarId}/notifications/{notificationId}

Update Event notification by id

Authorizations

Authorizationstringheaderrequired

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

Scope:calendars/events.write

Auth methods:OAuthPrivate Integration

Token type:Sub-Account Token

Request

Headers

Versionstringrequired

API Version

Available optionsv3

Example:v3

Path Parameters

calendarIdstringrequired

Calendar ID

Example:ocQHyuzHvysMo5N5VsXc

notificationIdstringrequired

Notification ID

Example:ocQHyuzHvysMo5N5VsXc

Body

application/json

receiverTypestring

Notification recipient type

Available optionscontactguestassignedUseremailsphoneNumbersbusiness

Example:user

additionalEmailIdsstring[]

Additional email addresses to receive notifications.

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

additionalPhoneNumbersstring[]

Additional phone numbers to receive notifications.

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

selectedUsersstring[]

Selected users for in-App and business email notifications. Supports user IDs and special keyword "sub_account_admin"

Example:["userId1","userId2","sub_account_admin"]

channelstring

Notification channel

Available optionsemailinAppsmswhatsapp

Example:email

notificationTypestring

Notification type

Available optionsbookedconfirmationcancellationreminderfollowupreschedule

Example:confirmation

isActiveboolean

Is the notification active

Default:true

Example:true

deletedboolean

Marks the notification as deleted (soft delete)

Default:false

Example:false

templateIdstring

Template ID for email notification

Example:MwPcayliwcdoUFzvbTok

bodystring

Body for email notification. Not necessary for in-App notification

Example:Your appointment has been confirmed.

subjectstring

Subject for email notification. Not necessary for in-App notification

Example:Appointment Confirmation

afterTimeobject[]

Specifies the time after which the follow-up notification should be sent. This is not required for other notification types.

beforeTimeobject[]

Specifies the time before which the reminder notification should be sent. This is not required for other notification types.

fromAddressstring

From address for email notification

Example:[email protected]

fromNumberstring

from number for sms notification

Example:+15551234567

fromNamestring

From name for email/sms notification

Example:Acme Scheduling

Response

application/json

Successful response

messagestringrequired

Result of delete/update operation

Example:Notification deleted successfully