Get notification

GET 
/calendars/:calendarId/notifications/:notificationId

Find Event notification by notificationId

Request

Version stringrequired

API Version

Available optionsv3

calendarId stringrequired

Calendar ID

notificationId stringrequired

Notification ID

application/json

Successful response

application/json

Schema

Schema

_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
}