Skip to main content
POST
Create 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

Body

application/json
receiverType
enum<string>
required

notification recipient type

Available options:
contact,
guest,
assignedUser,
emails,
phoneNumbers,
business
channel
enum<string>
required

Notification channel

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

Notification type

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

Is the notification active

templateId
string

Template ID for email notification. Not necessary for in-App 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:
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:
fromAddress
string

from address for email notification

fromName
string

from name for email/sms notification

fromNumber
string

from number for sms notification

Response

Successful response

_id
string

Notification ID

receiverType
enum<string>
Available options:
contact,
guest,
assignedUser,
emails,
phoneNumbers,
business
Example:

"contact"

additionalEmailIds
string[]
Example:
additionalPhoneNumbers
string[]
Example:
channel
enum<string>
Available options:
email,
inApp,
sms,
whatsapp
Example:

"email"

notificationType
enum<string>
Available options:
booked,
confirmation,
cancellation,
reminder,
followup,
reschedule
Example:

"confirmation"

isActive
boolean
Example:

true

additionalWhatsappNumbers
string[]
Example:
templateId
string
Example:

"0as9d8as0d"

body
string
Example:

"This is a test notification"

subject
string
Example:

"Test Notification"

afterTime
object[]
Example:
beforeTime
object[]
Example:
selectedUsers
string[]
Example:
deleted
boolean
Example:

false

Last modified on March 8, 2026