Skip to main content
Calendar NotificationsVersion: v3

Create notification

POST/calendars/{calendarId}/notifications

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

Authorizations

Authorizationstringheaderrequired

Bearer authentication header of the form Bearer <token>, where <token> is your access token.

Scope:calendars/events.write
Auth methods:OAuthPrivate Integration
Token type:Sub-Account Token

Request​

Headers

Versionstringrequired

API Version

Available optionsv3
Example:v3

Path Parameters

calendarIdstringrequired

Calendar ID

Example:ocQHyuzHvysMo5N5VsXc

Body

application/json
  • Array items
    • receiverTypestringrequired

    notification recipient type

    Available optionscontactguestassignedUseremailsphoneNumbersbusiness
    Example:user
    channelstringrequired

    Notification channel

    Available optionsemailinAppsmswhatsapp
    Example:email
    notificationTypestringrequired

    Notification type

    Available optionsbookedconfirmationcancellationreminderfollowupreschedule
    Example:confirmation
    isActiveboolean

    Is the notification active

    Default:true
    Example:true
    templateIdstring

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

    Example:MwPcayliwcdoUFzvbTok
    bodystring

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

    Example:Your appointment has been confirmed.
    subjectstring

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

    Example:Appointment Confirmation
    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.

    Example:["[email protected]","[email protected]"]
    additionalPhoneNumbersstring[]

    Additional phone numbers to receive notifications.

    Example:["+919876744444","+919876744445"]
    selectedUsersstring[]

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

    Example:["userId1","userId2","sub_account_admin"]
    fromAddressstring

    from address for email notification

    Example:[email protected]
    fromNamestring

    from name for email/sms notification

    Example:Acme Scheduling
    fromNumberstring

    from number for sms notification

    Example:+15551234567

    Response

    application/json

    Successful response

  • Array items
    • _idstring

    Notification ID

    Example:629a5d0a8c3f2b001f3d4e5a
    receiverTypestring

    Notification recipient type

    Available optionscontactguestassignedUseremailsphoneNumbersbusiness
    Example:contact
    additionalEmailIdsstring[]

    Additional email addresses to receive notifications

    Example:["[email protected]","[email protected]"]
    additionalPhoneNumbersstring[]

    Additional phone numbers to receive notifications

    Example:["+919876744444","+919876744445"]
    channelstring

    Notification channel

    Available optionsemailinAppsmswhatsapp
    Example:email
    notificationTypestring

    Notification type

    Available optionsbookedconfirmationcancellationreminderfollowupreschedule
    Example:confirmation
    isActiveboolean

    Whether the notification is active

    Example:true
    additionalWhatsappNumbersstring[]

    Additional WhatsApp numbers to receive notifications

    Example:["+919876744444","+919876744445"]
    templateIdstring

    Template ID for the notification

    Example:0as9d8as0d
    bodystring

    Notification body content

    Example:This is a test notification
    subjectstring

    Notification subject line

    Example:Test Notification
    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

    Example:["user1","user2"]
    deletedboolean

    Whether the notification is deleted

    Example:false