Notifications

get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Responses
200

Successful Operation.

application/json
ResponseanyExample: {"statusCode":200,"data":{"categories":[{"id":"b0a600fa-8860-42a6-8a6a-6521e90749b1","name":"Accounts"}]}}
get
/admin/communications/notification-categories
post
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
namestringRequiredExample: Accounts
Responses
post
/admin/communications/notification-categories
get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idstringRequired
Responses
200

Successful Operation.

application/json
ResponseanyExample: {"statusCode":200,"data":{"id":"b0a600fa-8860-42a6-8a6a-6521e90749b1","name":"Accounts"}}
get
/admin/communications/notification-categories/{id}
put
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idstringRequired
Body
namestringRequiredExample: General notifications
Responses
200

Successful Operation.

application/json
ResponseanyExample: {"statusCode":200}
put
/admin/communications/notification-categories/{id}
delete
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idstringRequired
Responses
200

Successful Operation.

application/json
ResponseanyExample: {"statusCode":200}
delete
/admin/communications/notification-categories/{id}
get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idstringRequired
Responses
200

Successful Operation.

application/json
ResponseanyExample: {"statusCode":200,"data":{"notifications":[{"id":"b86ab9b3-ab76-4633-8030-ec990d27a974","name":"Welcome","eventName":"WELCOME_NOTIFICATION","description":"lorem Ipsum is simply dummy text of the printing and typesetting industry","isMandatory":true,"notificationCategoryId":"b0a600fa-8860-42a6-8a6a-6521e90749b1"}]}}
get
/admin/communications/notification-categories/{id}/notifications
get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Responses
200

Successful Operation.

application/json
ResponseanyExample: {"statusCode":200,"data":{"notifications":[{"id":"b86ab9b3-ab76-4633-8030-ec990d27a974","name":"Welcome","eventName":"WELCOME_NOTIFICATION","description":"lorem Ipsum is simply dummy text of the printing and typesetting industry","isMandatory":true,"notificationCategoryId":"b0a600fa-8860-42a6-8a6a-6521e90749b1"}]}}
get
/admin/communications/notifications
post
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
namestringRequiredExample: Welcome
descriptionstringRequiredExample: Lorem Ipsum is simply dummy text of the printing and typesetting industry.
isMandatorybooleanRequiredExample: true
notificationCategoryIdstringRequiredExample: b0a600fa-8860-42a6-8a6a-6521e90749b1
Responses
post
/admin/communications/notifications
get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idstringRequired
Responses
200

Successful Operation.

application/json
ResponseanyExample: {"statusCode":200,"data":{"id":"b86ab9b3-ab76-4633-8030-ec990d27a974","name":"Welcome","eventName":"WELCOME_NOTIFICATION","description":"lorem Ipsum is simply dummy text of the printing and typesetting industry","isMandatory":true,"notificationCategoryId":"b0a600fa-8860-42a6-8a6a-6521e90749b1"}}
get
/admin/communications/notifications/{id}
put
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idstringRequired
Body
namestringOptionalExample: Welcome
descriptionstringOptionalExample: Lorem Ipsum is simply dummy text of the printing and typesetting industry.
isMandatorybooleanOptionalExample: false
notificationCategoryIdstringOptionalExample: b0a600fa-8860-42a6-8a6a-6521e90749b1
Responses
200

Successful Operation.

application/json
ResponseanyExample: {"statusCode":200}
put
/admin/communications/notifications/{id}
delete
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idstringRequired
Responses
200

Successful Operation.

application/json
ResponseanyExample: {"statusCode":200}
delete
/admin/communications/notifications/{id}
get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idstringRequired
Responses
200

Successful Operation.

application/json
ResponseanyExample: {"statusCode":200,"data":{"channels":[{"id":"d44cc91d-0fa7-4cc0-85af-f3dd57fee292","type":"PUSH","template":"ca91d88c-21c1-48da-95ac-8b57fdc62869","isCustomTemplate":false,"notificationId":"b86ab9b3-ab76-4633-8030-ec990d27a974"}]}}
get
/admin/communications/notifications/{id}/channels
get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idstringRequired
Responses
200

Successful Operation.

application/json
get
/admin/communications/channels/{id}
put
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idstringRequired
Body
typestring Β· enumRequiredExample: PUSHPossible values:
templatestringOptionalExample: ca91d88c-21c1-48da-95ac-8b57fdc62869
isCustomTemplatestringOptionalExample: false
notificationIdstringOptionalExample: b86ab9b3-ab76-4633-8030-ec990d27a974
Responses
200

Successful Operation.

application/json
ResponseanyExample: {"statusCode":200}
put
/admin/communications/channels/{id}
delete
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idstringRequired
Responses
200

Successful Operation.

application/json
ResponseanyExample: {"statusCode":200}
delete
/admin/communications/channels/{id}
post
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
typestring Β· enumRequiredExample: PUSHPossible values:
templatestringRequiredExample: ca91d88c-21c1-48da-95ac-8b57fdc62869
isCustomTemplatebooleanOptionalExample: false
notificationIdstringRequiredExample: b86ab9b3-ab76-4633-8030-ec990d27a974
Responses
post
/admin/communications/channels

Last updated

Was this helpful?