Notifications

GET/admin/communications/notification-categories

Authorization

bearer

Response

200401403

Successful Operation.

Body

application/json

any

Request

JavaScriptCurlPython

const response = await fetch('/admin/communications/notification-categories', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Response

200401403

{
  "statusCode": 200,
  "data": {
    "categories": [
      {
        "id": "b0a600fa-8860-42a6-8a6a-6521e90749b1",
        "name": "Accounts"
      }
    ]
  }
}

POST/admin/communications/notification-categories

Authorization

bearer

Body

application/json

name*string

Example: "Accounts"

Response

201400401422

Successful Operation.

Body

application/json

any

Request

JavaScriptCurlPython

const response = await fetch('/admin/communications/notification-categories', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer JWT",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "Accounts"
    }),
});
const data = await response.json();

Response

201400401422

{
  "statusCode": 201
}

GET/admin/communications/notification-categories/{id}

Authorization

bearer

Path parameters

id*string

Response

200400401403422

Successful Operation.

Body

application/json

any

Request

JavaScriptCurlPython

const response = await fetch('/admin/communications/notification-categories/{id}', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Response

200400401403422

{
  "statusCode": 200,
  "data": {
    "id": "b0a600fa-8860-42a6-8a6a-6521e90749b1",
    "name": "Accounts"
  }
}

PUT/admin/communications/notification-categories/{id}

Authorization

bearer

Path parameters

id*string

Body

application/json

name*string

Example: "General notifications"

Response

200400401403422

Successful Operation.

Body

application/json

any

Request

JavaScriptCurlPython

const response = await fetch('/admin/communications/notification-categories/{id}', {
    method: 'PUT',
    headers: {
      "Authorization": "Bearer JWT",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "General notifications"
    }),
});
const data = await response.json();

Response

200400401403422

{
  "statusCode": 200
}

DELETE/admin/communications/notification-categories/{id}

Authorization

bearer

Path parameters

id*string

Response

200400401403422

Successful Operation.

Body

application/json

any

Request

JavaScriptCurlPython

const response = await fetch('/admin/communications/notification-categories/{id}', {
    method: 'DELETE',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Response

200400401403422

{
  "statusCode": 200
}

GET/admin/communications/notification-categories/{id}/notifications

Authorization

bearer

Path parameters

id*string

Response

200400401403422

Successful Operation.

Body

application/json

any

Request

JavaScriptCurlPython

const response = await fetch('/admin/communications/notification-categories/{id}/notifications', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Response

200400401403422

{
  "statusCode": 200,
  "data": {
    "notifications": [
      {
        "id": "b86ab9b3-ab76-4633-8030-ec990d27a974",
        "name": "Welcome",
        "eventName": "WELCOME_NOTIFICATION",
        "description": "<p>lorem Ipsum is simply dummy text of the printing and typesetting industry</p>",
        "isMandatory": true,
        "notificationCategoryId": "b0a600fa-8860-42a6-8a6a-6521e90749b1",
        "__$markdownParsed": true
      }
    ]
  }
}

GET/admin/communications/notifications

Authorization

bearer

Response

200401403

Successful Operation.

Body

application/json

any

Request

JavaScriptCurlPython

const response = await fetch('/admin/communications/notifications', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Response

200401403

{
  "statusCode": 200,
  "data": {
    "notifications": [
      {
        "id": "b86ab9b3-ab76-4633-8030-ec990d27a974",
        "name": "Welcome",
        "eventName": "WELCOME_NOTIFICATION",
        "description": "<p>lorem Ipsum is simply dummy text of the printing and typesetting industry</p>",
        "isMandatory": true,
        "notificationCategoryId": "b0a600fa-8860-42a6-8a6a-6521e90749b1",
        "__$markdownParsed": true
      }
    ]
  }
}

POST/admin/communications/notifications

Authorization

bearer

Body

application/json

name*string

Example: "Welcome"

description*string

Example: "Lorem Ipsum is simply dummy text of the printing and typesetting industry."

isMandatory*boolean

Example: true

notificationCategoryId*string

Example: "b0a600fa-8860-42a6-8a6a-6521e90749b1"

Response

201400401403422500

Successful Operation.

Body

application/json

any

Request

JavaScriptCurlPython

const response = await fetch('/admin/communications/notifications', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer JWT",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "Welcome",
      "description": "Lorem Ipsum is simply dummy text of the printing and typesetting industry.",
      "isMandatory": true,
      "notificationCategoryId": "b0a600fa-8860-42a6-8a6a-6521e90749b1"
    }),
});
const data = await response.json();

Response

201400401403422500

{
  "statusCode": 201
}

GET/admin/communications/notifications/{id}

Authorization

bearer

Path parameters

id*string

Response

200400401403422

Successful Operation.

Body

application/json

any

Request

JavaScriptCurlPython

const response = await fetch('/admin/communications/notifications/{id}', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Response

200400401403422

{
  "statusCode": 200,
  "data": {
    "id": "b86ab9b3-ab76-4633-8030-ec990d27a974",
    "name": "Welcome",
    "eventName": "WELCOME_NOTIFICATION",
    "description": "<p>lorem Ipsum is simply dummy text of the printing and typesetting industry</p>",
    "isMandatory": true,
    "notificationCategoryId": "b0a600fa-8860-42a6-8a6a-6521e90749b1",
    "__$markdownParsed": true
  }
}

PUT/admin/communications/notifications/{id}

Authorization

bearer

Path parameters

id*string

Body

application/json

namestring

Example: "Welcome"

descriptionstring

Example: "Lorem Ipsum is simply dummy text of the printing and typesetting industry."

isMandatoryboolean

Example: false

notificationCategoryIdstring

Example: "b0a600fa-8860-42a6-8a6a-6521e90749b1"

Response

200400401403422

Successful Operation.

Body

application/json

any

Request

JavaScriptCurlPython

const response = await fetch('/admin/communications/notifications/{id}', {
    method: 'PUT',
    headers: {
      "Authorization": "Bearer JWT",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200400401403422

{
  "statusCode": 200
}

DELETE/admin/communications/notifications/{id}

Authorization

bearer

Path parameters

id*string

Response

200400401403422

Successful Operation.

Body

application/json

any

Request

JavaScriptCurlPython

const response = await fetch('/admin/communications/notifications/{id}', {
    method: 'DELETE',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Response

200400401403422

{
  "statusCode": 200
}

GET/admin/communications/notifications/{id}/channels

Authorization

bearer

Path parameters

id*string

Response

200400401403422

Successful Operation.

Body

application/json

any

Request

JavaScriptCurlPython

const response = await fetch('/admin/communications/notifications/{id}/channels', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Response

200400401403422

{
  "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/channels/{id}

Authorization

bearer

Path parameters

id*string

Response

200400401403422

Successful Operation.

Body

application/json

statusCode*number

Example: 200

data*all of

Request

JavaScriptCurlPython

const response = await fetch('/admin/communications/channels/{id}', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Response

200400401403422

{
  "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/admin/communications/channels/{id}

Authorization

bearer

Path parameters

id*string

Body

application/json

type*enum

Example: "PUSH"

PUSHEMAILSMS

templatestring

Example: "ca91d88c-21c1-48da-95ac-8b57fdc62869"

isCustomTemplatestring

Example: false

notificationIdstring

Example: "b86ab9b3-ab76-4633-8030-ec990d27a974"

Response

200400401403422

Successful Operation.

Body

application/json

any

Request

JavaScriptCurlPython

const response = await fetch('/admin/communications/channels/{id}', {
    method: 'PUT',
    headers: {
      "Authorization": "Bearer JWT",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "type": "PUSH"
    }),
});
const data = await response.json();

Response

200400401403422

{
  "statusCode": 200
}

DELETE/admin/communications/channels/{id}

Authorization

bearer

Path parameters

id*string

Response

200400401403422

Successful Operation.

Body

application/json

any

Request

JavaScriptCurlPython

const response = await fetch('/admin/communications/channels/{id}', {
    method: 'DELETE',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Response

200400401403422

{
  "statusCode": 200
}

POST/admin/communications/channels

Authorization

bearer

Body

application/json

type*enum

Example: "PUSH"

PUSHEMAILSMS

template*string

Example: "ca91d88c-21c1-48da-95ac-8b57fdc62869"

isCustomTemplateboolean

Example: false

notificationId*string

Example: "b86ab9b3-ab76-4633-8030-ec990d27a974"

Response

201401403422

Successful Operation.

Body

application/json

any

Request

JavaScriptCurlPython

const response = await fetch('/admin/communications/channels', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer JWT",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "type": "PUSH",
      "template": "ca91d88c-21c1-48da-95ac-8b57fdc62869",
      "notificationId": "b86ab9b3-ab76-4633-8030-ec990d27a974"
    }),
});
const data = await response.json();

Response

201401403422

{
  "statusCode": 201
}