Update notification

PUT 
/calendars/:calendarId/notifications/:notificationId

Update Event notification by id

Request

Version stringrequired

API Version

Available optionsv3

calendarId stringrequired

Calendar ID

notificationId stringrequired

Notification ID

application/json

application/json

Body

Bodyrequired

receiverTypestring
Notification recipient type
Available optionscontactguestassignedUseremailsphoneNumbersbusiness
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"

channelstring
Notification channel
Available optionsemailinAppsmswhatsapp
notificationTypestring
Notification type
Available optionsbookedconfirmationcancellationreminderfollowupreschedule
isActiveboolean
Is the notification active
Default value: true
deletedboolean
Marks the notification as deleted (soft delete)
Default value: false
templateIdstring

Template ID for email 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.

fromAddressstring

From address for email notification

fromNumberstring

from number for sms notification

fromNamestring

From name for email/sms notification

Example (auto)

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

application/json

Successful response

application/json

Schema

Schema

messagestringrequired

Result of delete/update operation

Example (auto)

{
  "message": "Notification deleted successfully"
}