Notifications
get
Authorizations
Responses
200
Successful Operation.
application/json
ResponseanyExample:
{"statusCode":200,"data":{"categories":[{"id":"b0a600fa-8860-42a6-8a6a-6521e90749b1","name":"Accounts"}]}}
401
Failed because the authentication token was not sent or it has already expired.
application/json
403
The token is correct but you need a specific role to access this endpoint
application/json
get
GET /admin/communications/notification-categories HTTP/1.1
Host:
Authorization: Bearer JWT
Accept: */*
{
"statusCode": 200,
"data": {
"categories": [
{
"id": "b0a600fa-8860-42a6-8a6a-6521e90749b1",
"name": "Accounts"
}
]
}
}
post
Authorizations
Body
namestringRequiredExample:
Accounts
Responses
201
Successful Operation.
application/json
ResponseanyExample:
{"statusCode":201}
400
Error processing the information
application/json
401
Failed because the authentication token was not sent or it has already expired.
application/json
422
Error processing the information
application/json
post
POST /admin/communications/notification-categories HTTP/1.1
Host:
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 19
{
"name": "Accounts"
}
{
"statusCode": 201
}
get
Authorizations
Path parameters
idstringRequired
Responses
200
Successful Operation.
application/json
ResponseanyExample:
{"statusCode":200,"data":{"id":"b0a600fa-8860-42a6-8a6a-6521e90749b1","name":"Accounts"}}
400
Error processing the information
application/json
401
Failed because the authentication token was not sent or it has already expired.
application/json
403
The token is correct but you need a specific role to access this endpoint
application/json
422
Error processing the information
application/json
get
GET /admin/communications/notification-categories/{id} HTTP/1.1
Host:
Authorization: Bearer JWT
Accept: */*
{
"statusCode": 200,
"data": {
"id": "b0a600fa-8860-42a6-8a6a-6521e90749b1",
"name": "Accounts"
}
}
put
Authorizations
Path parameters
idstringRequired
Body
namestringRequiredExample:
General notifications
Responses
200
Successful Operation.
application/json
ResponseanyExample:
{"statusCode":200}
400
Error processing the information
application/json
401
Failed because the authentication token was not sent or it has already expired.
application/json
403
The token is correct but you need a specific role to access this endpoint
application/json
422
Error processing the information
application/json
put
PUT /admin/communications/notification-categories/{id} HTTP/1.1
Host:
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 32
{
"name": "General notifications"
}
{
"statusCode": 200
}
delete
Authorizations
Path parameters
idstringRequired
Responses
200
Successful Operation.
application/json
ResponseanyExample:
{"statusCode":200}
400
Error processing the information
application/json
401
Failed because the authentication token was not sent or it has already expired.
application/json
403
The token is correct but you need a specific role to access this endpoint
application/json
422
Error processing the information
application/json
delete
DELETE /admin/communications/notification-categories/{id} HTTP/1.1
Host:
Authorization: Bearer JWT
Accept: */*
{
"statusCode": 200
}
get
Authorizations
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"}]}}
400
Error processing the information
application/json
401
Failed because the authentication token was not sent or it has already expired.
application/json
403
The token is correct but you need a specific role to access this endpoint
application/json
422
Error processing the information
application/json
get
GET /admin/communications/notification-categories/{id}/notifications HTTP/1.1
Host:
Authorization: Bearer JWT
Accept: */*
{
"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
Authorizations
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"}]}}
401
Failed because the authentication token was not sent or it has already expired.
application/json
403
The token is correct but you need a specific role to access this endpoint
application/json
get
GET /admin/communications/notifications HTTP/1.1
Host:
Authorization: Bearer JWT
Accept: */*
{
"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"
}
]
}
}
post
Authorizations
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
201
Successful Operation.
application/json
ResponseanyExample:
{"statusCode":201}
400
Error processing the information
application/json
401
Failed because the authentication token was not sent or it has already expired.
application/json
403
The token is correct but you need a specific role to access this endpoint
application/json
422
Error processing the information
application/json
500
Internal server error.
application/json
post
POST /admin/communications/notifications HTTP/1.1
Host:
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 192
{
"name": "Welcome",
"description": "Lorem Ipsum is simply dummy text of the printing and typesetting industry.",
"isMandatory": true,
"notificationCategoryId": "b0a600fa-8860-42a6-8a6a-6521e90749b1"
}
{
"statusCode": 201
}
get
Authorizations
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"}}
400
Error processing the information
application/json
401
Failed because the authentication token was not sent or it has already expired.
application/json
403
The token is correct but you need a specific role to access this endpoint
application/json
422
Error processing the information
application/json
get
GET /admin/communications/notifications/{id} HTTP/1.1
Host:
Authorization: Bearer JWT
Accept: */*
{
"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"
}
}
put
Authorizations
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}
400
Error processing the information
application/json
401
Failed because the authentication token was not sent or it has already expired.
application/json
403
The token is correct but you need a specific role to access this endpoint
application/json
422
Error processing the information
application/json
put
PUT /admin/communications/notifications/{id} HTTP/1.1
Host:
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 193
{
"name": "Welcome",
"description": "Lorem Ipsum is simply dummy text of the printing and typesetting industry.",
"isMandatory": false,
"notificationCategoryId": "b0a600fa-8860-42a6-8a6a-6521e90749b1"
}
{
"statusCode": 200
}
delete
Authorizations
Path parameters
idstringRequired
Responses
200
Successful Operation.
application/json
ResponseanyExample:
{"statusCode":200}
400
Error processing the information
application/json
401
Failed because the authentication token was not sent or it has already expired.
application/json
403
The token is correct but you need a specific role to access this endpoint
application/json
422
Error processing the information
application/json
delete
DELETE /admin/communications/notifications/{id} HTTP/1.1
Host:
Authorization: Bearer JWT
Accept: */*
{
"statusCode": 200
}
get
Authorizations
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"}]}}
400
Error processing the information
application/json
401
Failed because the authentication token was not sent or it has already expired.
application/json
403
The token is correct but you need a specific role to access this endpoint
application/json
422
Error processing the information
application/json
get
GET /admin/communications/notifications/{id}/channels HTTP/1.1
Host:
Authorization: Bearer JWT
Accept: */*
{
"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
Authorizations
Path parameters
idstringRequired
Responses
200
Successful Operation.
application/json
400
Error processing the information
application/json
401
Failed because the authentication token was not sent or it has already expired.
application/json
403
The token is correct but you need a specific role to access this endpoint
application/json
422
Error processing the information
application/json
get
GET /admin/communications/channels/{id} HTTP/1.1
Host:
Authorization: Bearer JWT
Accept: */*
{
"statusCode": 200,
"data": {
"id": "d44cc91d-0fa7-4cc0-85af-f3dd57fee292",
"type": "PUSH",
"template": "ca91d88c-21c1-48da-95ac-8b57fdc62869",
"isCustomTemplate": false,
"notificationId": "b86ab9b3-ab76-4633-8030-ec990d27a974"
}
}
put
Authorizations
Path parameters
idstringRequired
Body
typestring · enumRequiredExample:
PUSH
Possible values: templatestringOptionalExample:
ca91d88c-21c1-48da-95ac-8b57fdc62869
isCustomTemplatestringOptionalExample:
false
notificationIdstringOptionalExample:
b86ab9b3-ab76-4633-8030-ec990d27a974
Responses
200
Successful Operation.
application/json
ResponseanyExample:
{"statusCode":200}
400
Error processing the information
application/json
401
Failed because the authentication token was not sent or it has already expired.
application/json
403
The token is correct but you need a specific role to access this endpoint
application/json
422
Error processing the information
application/json
put
PUT /admin/communications/channels/{id} HTTP/1.1
Host:
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 146
{
"type": "PUSH",
"template": "ca91d88c-21c1-48da-95ac-8b57fdc62869",
"isCustomTemplate": false,
"notificationId": "b86ab9b3-ab76-4633-8030-ec990d27a974"
}
{
"statusCode": 200
}
delete
Authorizations
Path parameters
idstringRequired
Responses
200
Successful Operation.
application/json
ResponseanyExample:
{"statusCode":200}
400
Error processing the information
application/json
401
Failed because the authentication token was not sent or it has already expired.
application/json
403
The token is correct but you need a specific role to access this endpoint
application/json
422
Error processing the information
application/json
delete
DELETE /admin/communications/channels/{id} HTTP/1.1
Host:
Authorization: Bearer JWT
Accept: */*
{
"statusCode": 200
}
post
Authorizations
Body
typestring · enumRequiredExample:
PUSH
Possible values: templatestringRequiredExample:
ca91d88c-21c1-48da-95ac-8b57fdc62869
isCustomTemplatebooleanOptionalExample:
false
notificationIdstringRequiredExample:
b86ab9b3-ab76-4633-8030-ec990d27a974
Responses
201
Successful Operation.
application/json
ResponseanyExample:
{"statusCode":201}
401
Failed because the authentication token was not sent or it has already expired.
application/json
403
The token is correct but you need a specific role to access this endpoint
application/json
422
Error processing the information
application/json
post
POST /admin/communications/channels HTTP/1.1
Host:
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 146
{
"type": "PUSH",
"template": "ca91d88c-21c1-48da-95ac-8b57fdc62869",
"isCustomTemplate": false,
"notificationId": "b86ab9b3-ab76-4633-8030-ec990d27a974"
}
{
"statusCode": 201
}
Last updated
Was this helpful?