Skip to main content
PUT
Update notification

Authorizations

Authorization
string
header
required

Use the Access Token generated with user type as Sub-Account (OR) Private Integration Token of Sub-Account.

Headers

Version
enum<string>
required

API Version

Available options:
2021-04-15

Path Parameters

calendarId
string
required
notificationId
string
required

Body

application/json
receiverType
enum<string>

Notification recipient type

Available options:
contact,
guest,
assignedUser,
emails,
phoneNumbers,
business
additionalEmailIds
string[]

Additional email addresses to receive notifications.

Example:
additionalPhoneNumbers
string[]

Additional phone numbers to receive notifications.

Example:
selectedUsers
string[]

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

Example:
channel
enum<string>

Notification channel

Available options:
email,
inApp,
sms,
whatsapp
notificationType
enum<string>

Notification type

Available options:
booked,
confirmation,
cancellation,
reminder,
followup,
reschedule
isActive
boolean
default:true

Is the notification active

deleted
boolean
default:false

Marks the notification as deleted (soft delete)

templateId
string

Template ID for email notification

body
string

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

subject
string

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

afterTime
object[]

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

Example:
beforeTime
object[]

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

Example:
fromAddress
string

From address for email notification

fromNumber
string

from number for sms notification

fromName
string

From name for email/sms notification

Response

Successful response

message
string
required

Result of delete/update operation

Last modified on March 8, 2026