Create notification

POST 
/calendars/:calendarId/notifications

Create Calendar notifications, either one or multiple. All notification settings must be for single calendar only

Request

Version stringrequired

API Version

Available optionsv3

calendarId stringrequired

Calendar ID

application/json

application/json

Body

Body arrayrequired

• Array [
receiverTypestringrequired
notification recipient type
Available optionscontactguestassignedUseremailsphoneNumbersbusiness
channelstringrequired
Notification channel
Available optionsemailinAppsmswhatsapp
notificationTypestringrequired
Notification type
Available optionsbookedconfirmationcancellationreminderfollowupreschedule
isActiveboolean
Is the notification active
Default value: true
templateIdstring

Template ID for email notification. Not necessary for in-App notification

bodystring

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

subjectstring

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

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.

additionalEmailIdsstring[]

Additional email addresses to receive notifications.

additionalPhoneNumbersstring[]

Additional phone numbers to receive notifications.

selectedUsersstring[]

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

fromAddressstring

from address for email notification

fromNamestring

from name for email/sms notification

fromNumberstring

from number for sms notification

• ]

Example (auto)

[
  {
    "receiverType": "user",
    "channel": "email",
    "notificationType": "confirmation",
    "isActive": true,
    "templateId": "MwPcayliwcdoUFzvbTok",
    "body": "Your appointment has been confirmed.",
    "subject": "Appointment Confirmation",
    "afterTime": [
      {
        "timeOffset": 1,
        "unit": "hours"
      }
    ],
    "beforeTime": [
      {
        "timeOffset": 1,
        "unit": "hours"
      }
    ],
    "additionalEmailIds": [
      "[email protected]",
      "[email protected]"
    ],
    "additionalPhoneNumbers": [
      "+919876744444",
      "+919876744445"
    ],
    "selectedUsers": [
      "userId1",
      "userId2",
      "sub_account_admin"
    ],
    "fromAddress": "[email protected]",
    "fromName": "Acme Scheduling",
    "fromNumber": "+15551234567"
  }
]

application/json

Successful response

application/json

Schema

Schema

• Array [
_idstring

Notification ID

receiverTypestring
Notification recipient type
Available optionscontactguestassignedUseremailsphoneNumbersbusiness
additionalEmailIdsstring[]

Additional email addresses to receive notifications

additionalPhoneNumbersstring[]

Additional phone numbers to receive notifications

channelstring
Notification channel
Available optionsemailinAppsmswhatsapp
notificationTypestring
Notification type
Available optionsbookedconfirmationcancellationreminderfollowupreschedule
isActiveboolean

Whether the notification is active

additionalWhatsappNumbersstring[]

Additional WhatsApp numbers to receive notifications

templateIdstring

Template ID for the notification

bodystring

Notification body content

subjectstring

Notification subject line

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

deletedboolean

Whether the notification is deleted

• ]

Example (auto)

[
  {
    "_id": "629a5d0a8c3f2b001f3d4e5a",
    "receiverType": "contact",
    "additionalEmailIds": [
      "[email protected]",
      "[email protected]"
    ],
    "additionalPhoneNumbers": [
      "+919876744444",
      "+919876744445"
    ],
    "channel": "email",
    "notificationType": "confirmation",
    "isActive": true,
    "additionalWhatsappNumbers": [
      "+919876744444",
      "+919876744445"
    ],
    "templateId": "0as9d8as0d",
    "body": "This is a test notification",
    "subject": "Test Notification",
    "afterTime": [
      {
        "timeOffset": 1,
        "unit": "hours"
      }
    ],
    "beforeTime": [
      {
        "timeOffset": 1,
        "unit": "hours"
      }
    ],
    "selectedUsers": [
      "user1",
      "user2"
    ],
    "deleted": false
  }
]