Download OpenAPI specification:Download
Contains functionality for managing notification data.
For endpoints that support localization the language can be passed either as a query string parameter (using the name 'language') or in the 'accept-language' header.
If no language is passed to such endpoints then the default configured language will be used.
Retrieves a list of enumerations for multiple tables. The tables available are:
NotificationChannel, NotificationRecipientType, SeverityLevel
| Accept-Language | string The ISO 639-1 language to use for localizable data. |
Request data.
| enumerationTypes | Array of strings (EnumerationType) Nullable Items Enum: "NotificationChannel" "NotificationRecipientType" "SeverityLevel" |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "enumerationTypes": [
- "NotificationChannel",
- "NotificationRecipientType",
- "SeverityLevel"
]
}{- "enumerations": [
- {
- "name": "NotificationChannel",
- "values": [
- {
- "id": 1,
- "name": "Realtime",
- "key": "Realtime"
}, - {
- "id": 2,
- "name": "Email",
- "key": "Email"
}, - {
- "id": 3,
- "name": "Message",
- "key": "Message"
}, - {
- "id": 4,
- "name": "SMS",
- "key": "Sms"
}, - {
- "id": 5,
- "name": "Push",
- "key": "Push"
}
]
}
]
}Deletes a notification type by ID.
| notificationTypeId required | integer <int32> The ID of the notification type to retrieve |
| Accept-Language | string The ISO 639-1 language to use for localizable data. |
No Content
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "code": "BadRequest",
- "subCode": "NA",
- "message": "The request was not in the required format",
- "correlationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}Modifies an existing notification type.
| notificationTypeId required | integer <int32> The ID of the notification type to modify |
| Accept-Language | string The ISO 639-1 language to use for localizable data. |
The parameter DTO
| updateProperties | Array of strings Nullable |
| name | string Nullable |
| severityLevelKey | string (SeverityLevelKey) Enum: "Low" "Medium" "High" |
| notificationEventId | string Nullable |
| isActive | boolean |
| customAttributes | string Nullable |
No Content
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "updateProperties": [
- "string"
], - "name": "string",
- "severityLevelKey": "Low",
- "notificationEventId": "string",
- "isActive": true,
- "customAttributes": "string"
}{- "code": "BadRequest",
- "subCode": "NA",
- "message": "The request was not in the required format",
- "correlationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}Removes a notification type and channel pair from ignore list.
| personUId required | string <uuid> Person UId for who the notification type will be removed from the ignored list |
| notificationTypeId required | integer <int32> The ID of the notification type |
| notificationChannelKey required | string (NotificationChannelKey) Enum: "Realtime" "Email" "Message" "Sms" "Push" The notification channel key |
| Accept-Language | string The ISO 639-1 language to use for localizable data. |
No Content
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "code": "BadRequest",
- "subCode": "NA",
- "message": "The request was not in the required format",
- "correlationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}Adds a notification type and channel pair to ignore list.
| personUId required | string <uuid> Person UId for who the notification type and channel pair will be added to the ignored list |
| notificationTypeId required | integer <int32> The ID of the notification type |
| notificationChannelKey required | string (NotificationChannelKey) Enum: "Realtime" "Email" "Message" "Sms" "Push" The notification channel key |
| Accept-Language | string The ISO 639-1 language to use for localizable data. |
No Content
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "code": "BadRequest",
- "subCode": "NA",
- "message": "The request was not in the required format",
- "correlationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}Deletes a channel for a notification type
| notificationTypeId required | integer <int32> The Notification Type Id |
| notificationChannelKey required | string (NotificationChannelKey) Enum: "Realtime" "Email" "Message" "Sms" "Push" The notification channel key |
| recipientTypeKey required | string (NotificationRecipientTypeKey) Enum: "Initiator" "Contact" "Member" "ContactGroup" "Custom" The recipient type key |
| Accept-Language | string The ISO 639-1 language to use for localizable data. |
No Content
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "code": "BadRequest",
- "subCode": "NA",
- "message": "The request was not in the required format",
- "correlationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}Updates a channel for the recipient of a notification type
| notificationTypeId required | integer <int32> The Notification Type Id |
| notificationChannelKey required | string (NotificationChannelKey) Enum: "Realtime" "Email" "Message" "Sms" "Push" The notification channel key |
| recipientTypeKey required | string (NotificationRecipientTypeKey) Enum: "Initiator" "Contact" "Member" "ContactGroup" "Custom" The recipient type key |
| Accept-Language | string The ISO 639-1 language to use for localizable data. |
The request object
| updateProperties | Array of strings Nullable |
| renderTemplateMetadataUId | string <uuid> |
| isPersisted | boolean |
| isActive | boolean |
| appId | string Nullable |
No Content
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "updateProperties": [
- "string"
], - "renderTemplateMetadataUId": "string",
- "isPersisted": true,
- "isActive": true,
- "appId": "string"
}{- "code": "BadRequest",
- "subCode": "NA",
- "message": "The request was not in the required format",
- "correlationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}Gets all notification types.
| Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Internal Server Error
{- "notificationTypes": [
- {
- "id": 0,
- "name": "string",
- "severityLevelKey": "Low",
- "notificationEventId": "string",
- "isActive": true,
- "customAttributes": "string"
}
]
}Creates a new notification type.
| Accept-Language | string The ISO 639-1 language to use for localizable data. |
Properties of the notification type to create
| name | string Nullable |
| severityLevelKey | string (SeverityLevelKey) Enum: "Low" "Medium" "High" |
| notificationEventId | string Nullable |
| isActive | boolean |
| customAttributes | string Nullable |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "name": "string",
- "severityLevelKey": "Low",
- "notificationEventId": "string",
- "isActive": true,
- "customAttributes": "string"
}{- "id": 0
}Gets all ignored notification types.
| personUId required | string <uuid> |
| Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "ignoredNotificationTypes": [
- {
- "notificationTypeId": 0,
- "notificationTypeName": "string",
- "notificationChannelKey": "Realtime"
}
]
}Updates the entire notifications ignore list of the person.
| personUId required | string <uuid> Person UId for who the notification ignore list will be updated |
| Accept-Language | string The ISO 639-1 language to use for localizable data. |
The notification types and notification channels pairs to be updated
| ignoredNotifications | Array of objects (NotificationTypeNotificationChannel) Nullable |
No Content
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "ignoredNotifications": [
- {
- "notificationTypeId": 0,
- "notificationChannelKey": "Realtime"
}
]
}{- "code": "BadRequest",
- "subCode": "NA",
- "message": "The request was not in the required format",
- "correlationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}Gets all the channels configured for a notification type
| notificationTypeId required | integer <int32> The Notification Type Id |
| Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "notificationTypeChannels": [
- {
- "notificationChannelKey": "Realtime",
- "renderTemplateMetadataUId": "string",
- "notificationRecipientTypeKey": "Initiator",
- "isPersisted": true,
- "isActive": true,
- "appId": "string"
}
]
}Creates a new channel for a notification type
| notificationTypeId required | integer <int32> The Notification Type Id |
| Accept-Language | string The ISO 639-1 language to use for localizable data. |
The request object
| notificationChannelKey | string (NotificationChannelKey) Enum: "Realtime" "Email" "Message" "Sms" "Push" |
| renderTemplateMetadataUId | string <uuid> |
| notificationRecipientTypeKey | string (NotificationRecipientTypeKey) Enum: "Initiator" "Contact" "Member" "ContactGroup" "Custom" |
| isPersisted | boolean |
| isActive | boolean |
| appId | string Nullable |
No Content
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "notificationChannelKey": "Realtime",
- "renderTemplateMetadataUId": "string",
- "notificationRecipientTypeKey": "Initiator",
- "isPersisted": true,
- "isActive": true,
- "appId": "string"
}{- "code": "BadRequest",
- "subCode": "NA",
- "message": "The request was not in the required format",
- "correlationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}Gets all the channels configured for a notification type
| notificationTypeId required | integer <int32> The Notification Type Id |
| Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "notificationTypeChannels": [
- {
- "notificationChannelKey": "Realtime",
- "renderTemplateMetadataKey": "string",
- "notificationRecipientTypeKey": "Initiator",
- "isPersisted": true,
- "isActive": true,
- "appId": "string"
}
]
}Creates a new channel for a notification type
| notificationTypeId required | integer <int32> The Notification Type Id |
| Accept-Language | string The ISO 639-1 language to use for localizable data. |
The request object
| notificationChannelKey | string (NotificationChannelKey) Enum: "Realtime" "Email" "Message" "Sms" "Push" |
| renderTemplateMetadataKey | string Nullable |
| notificationRecipientTypeKey | string (NotificationRecipientTypeKey) Enum: "Initiator" "Contact" "Member" "ContactGroup" "Custom" |
| isPersisted | boolean |
| isActive | boolean |
| appId | string Nullable |
No Content
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "notificationChannelKey": "Realtime",
- "renderTemplateMetadataKey": "string",
- "notificationRecipientTypeKey": "Initiator",
- "isPersisted": true,
- "isActive": true,
- "appId": "string"
}{- "code": "BadRequest",
- "subCode": "NA",
- "message": "The request was not in the required format",
- "correlationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}Updates a channel for the recipient of a notification type
| notificationTypeId required | integer <int32> The Notification Type Id |
| notificationChannelKey required | string (NotificationChannelKey) Enum: "Realtime" "Email" "Message" "Sms" "Push" The notification channel key |
| recipientTypeKey required | string (NotificationRecipientTypeKey) Enum: "Initiator" "Contact" "Member" "ContactGroup" "Custom" The recipient type key |
| Accept-Language | string The ISO 639-1 language to use for localizable data. |
The request object
| updateProperties | Array of strings Nullable |
| renderTemplateMetadataKey | string Nullable |
| isPersisted | boolean |
| isActive | boolean |
| appId | string Nullable |
No Content
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "updateProperties": [
- "string"
], - "renderTemplateMetadataKey": "string",
- "isPersisted": true,
- "isActive": true,
- "appId": "string"
}{- "code": "BadRequest",
- "subCode": "NA",
- "message": "The request was not in the required format",
- "correlationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}Returns channels for a given set of parameters
| Accept-Language | string The ISO 639-1 language to use for localizable data. |
The request object
| notificationTypeIds | Array of integers <int32> Nullable |
| notificationChannelKeys | Array of strings (NotificationChannelKey) Nullable Items Enum: "Realtime" "Email" "Message" "Sms" "Push" |
| notificationRecipientTypeKeys | Array of strings (NotificationRecipientTypeKey) Nullable Items Enum: "Initiator" "Contact" "Member" "ContactGroup" "Custom" |
| renderTemplateMetadataUIds | Array of strings <uuid> Nullable |
| appIds | Array of strings Nullable |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "notificationTypeIds": [
- 0
], - "notificationChannelKeys": [
- "Realtime"
], - "notificationRecipientTypeKeys": [
- "Initiator"
], - "renderTemplateMetadataUIds": [
- "string"
], - "appIds": [
- "string"
]
}{- "notificationTypeChannels": [
- {
- "notificationType": {
- "id": 0,
- "name": "string",
- "severityLevelKey": "Low",
- "notificationEventId": "string",
- "isActive": true,
- "customAttributes": "string"
}, - "notificationChannelKey": "Realtime",
- "renderTemplateMetadataUId": "string",
- "notificationRecipientTypeKey": "Initiator",
- "isPersisted": true,
- "isActive": true,
- "appId": "string"
}
]
}Returns channels for a given set of parameters
| Accept-Language | string The ISO 639-1 language to use for localizable data. |
The request object
| notificationTypeIds | Array of integers <int32> Nullable |
| notificationChannelKeys | Array of strings (NotificationChannelKey) Nullable Items Enum: "Realtime" "Email" "Message" "Sms" "Push" |
| notificationRecipientTypeKeys | Array of strings (NotificationRecipientTypeKey) Nullable Items Enum: "Initiator" "Contact" "Member" "ContactGroup" "Custom" |
| renderTemplateMetadataKeys | Array of strings Nullable |
| appIds | Array of strings Nullable |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "notificationTypeIds": [
- 0
], - "notificationChannelKeys": [
- "Realtime"
], - "notificationRecipientTypeKeys": [
- "Initiator"
], - "renderTemplateMetadataKeys": [
- "string"
], - "appIds": [
- "string"
]
}{- "notificationTypeChannels": [
- {
- "notificationType": {
- "id": 0,
- "name": "string",
- "severityLevelKey": "Low",
- "notificationEventId": "string",
- "isActive": true,
- "customAttributes": "string"
}, - "notificationChannelKey": "Realtime",
- "renderTemplateMetadataKey": "string",
- "notificationRecipientTypeKey": "Initiator",
- "isPersisted": true,
- "isActive": true,
- "appId": "string"
}
]
}Enrolls new device for push notifications.
| personUId required | string <uuid> The person unique identifier |
| Accept-Language | string The ISO 639-1 language to use for localizable data. |
Request data.
| deviceToken | string Nullable |
| pushToken | string Nullable |
| platform | string (DevicePlatform) Enum: "iOS" "Android" |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "deviceToken": "string",
- "pushToken": "string",
- "platform": "iOS"
}{- "code": "BadRequest",
- "subCode": "NA",
- "message": "The request was not in the required format",
- "correlationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}