Create notification

GEThttps://services.leadconnectorhq.com/calendars/{calendarId}/notifications
Create Calendar notifications, either one or multiple. All notification settings must be for single calendar only
Request

Use the Access Token generated with user type as Sub-Account (OR) Private Integration Token of Sub-Account.

Provide your bearer token in the Authorization header when making requests to protected resources.

Example: Authorization: Bearer 123
Path Parameters
calendarId
string
required
Headers
Authorization
string
required

Access Token

Example:
Bearer 9c48df2694a849b6089f9d0d3513efe
Version
string
required

API Version

Allowed value:
2021-04-15
Body
array of:
receiverType
string
required

notification recipient type

Allowed values:
contactguestassignedUseremails
channel
string
required

Notification channel

Allowed values:
emailinApp
notificationType
string
required

Notification type

Allowed values:
bookedconfirmationcancellationreminderfollowupreschedule
isActive
boolean

Is the notification active

Default:
true
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
array[object]

Specifies the time after which the follow-up notification should be sent. This is not required for other notification types.

Example:
[{"timeOffset":1,"unit":"hours"}]
timeOffset
number
unit
string
beforeTime
array[object]

Specifies the time before which the reminder notification should be sent. This is not required for other notification types.

Example:
[{"timeOffset":1,"unit":"hours"}]
timeOffset
number
unit
string
additionalEmailIds
array[string]

Additional email addresses to receive notifications.

Example:
["example1@email.com","example2@email.com"]
selectedUsers
array[string]

selected user for in-App notification

fromAddress
string

from address for email notification

fromName
string

from name for email notification

Responses

Successful response

Body

array of:
_id
string

Notification ID

receiverType
string
Allowed values:
contactguestassignedUseremails
Example:
contact
additionalEmailIds
array[string]
Example:
["example1@email.com","example2@email.com"]
channel
string
Allowed values:
emailinApp
Example:
email
notificationType
string
Allowed values:
bookedconfirmationcancellationreminderfollowupreschedule
Example:
confirmation
isActive
boolean
Example:
true
templateId
string
Example:
0as9d8as0d
body
string
Example:
This is a test notification
subject
string
Example:
Test Notification
afterTime
array[object]
Example:
[{"timeOffset":1,"unit":"hours"}]
timeOffset
number
unit
string
beforeTime
array[object]
Example:
[{"timeOffset":1,"unit":"hours"}]
timeOffset
number
unit
string
selectedUsers
array[string]
Example:
["user1","user2"]
deleted
boolean
Example:
false

Unauthorized

Body

statusCode
number
Example:
401
message
string
Example:
Invalid token: access token is invalid
error
string
Example:
Unauthorized

Bad Request

Body

statusCode
number
Example:
400
message
string
Example:
Bad Request