Notifications

PreviousInterceptor NextOnboardings

Last updated 2 years ago

Was this helpful?

get

/admin/communications/notification-categories

Authorizations

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/admin/communications/notification-categories' \
  --header 'Authorization: Bearer JWT'

200

401

403

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

Successful Operation.

post

/admin/communications/notification-categories

Authorizations

Body

namestringrequired

Example: Accounts

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/admin/communications/notification-categories' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{"name":"Accounts"}'

201

400

401

422

{
  "statusCode": 201
}

Successful Operation.

get

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

Authorizations

Path parameters

idstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/admin/communications/notification-categories/{id}' \
  --header 'Authorization: Bearer JWT'

200

400

401

403

422

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

Successful Operation.

put

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

Authorizations

Path parameters

idstringrequired

Body

namestringrequired

Example: General notifications

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url '/admin/communications/notification-categories/{id}' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{"name":"General notifications"}'

200

400

401

403

422

{
  "statusCode": 200
}

Successful Operation.

delete

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

Authorizations

Path parameters

idstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url '/admin/communications/notification-categories/{id}' \
  --header 'Authorization: Bearer JWT'

200

400

401

403

422

{
  "statusCode": 200
}

Successful Operation.

get

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

Authorizations

Path parameters

idstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/admin/communications/notification-categories/{id}/notifications' \
  --header 'Authorization: Bearer JWT'

200

400

401

403

422

{
  "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",
        "x-gitbook-description-html": "<p>lorem Ipsum is simply dummy text of the printing and typesetting industry</p>"
      }
    ]
  }
}

Successful Operation.

get

/admin/communications/notifications

Authorizations

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/admin/communications/notifications' \
  --header 'Authorization: Bearer JWT'

200

401

403

{
  "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",
        "x-gitbook-description-html": "<p>lorem Ipsum is simply dummy text of the printing and typesetting industry</p>"
      }
    ]
  }
}

Successful Operation.

post

/admin/communications/notifications

Authorizations

Body

namestringrequired

Example: Welcome

descriptionstringrequired

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

isMandatorybooleanrequired

Example: true

notificationCategoryIdstringrequired

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

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/admin/communications/notifications' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{"name":"Welcome","description":"Lorem Ipsum is simply dummy text of the printing and typesetting industry.","isMandatory":true,"notificationCategoryId":"b0a600fa-8860-42a6-8a6a-6521e90749b1"}'

201

400

401

403

422

500

{
  "statusCode": 201
}

Successful Operation.

get

/admin/communications/notifications/{id}

Authorizations

Path parameters

idstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/admin/communications/notifications/{id}' \
  --header 'Authorization: Bearer JWT'

200

400

401

403

422

{
  "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",
    "x-gitbook-description-html": "<p>lorem Ipsum is simply dummy text of the printing and typesetting industry</p>"
  }
}

Successful Operation.

put

/admin/communications/notifications/{id}

Authorizations

Path parameters

idstringrequired

Body

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

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url '/admin/communications/notifications/{id}' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{"name":"Welcome","description":"Lorem Ipsum is simply dummy text of the printing and typesetting industry.","isMandatory":false,"notificationCategoryId":"b0a600fa-8860-42a6-8a6a-6521e90749b1"}'

200

400

401

403

422

{
  "statusCode": 200
}

Successful Operation.

delete

/admin/communications/notifications/{id}

Authorizations

Path parameters

idstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url '/admin/communications/notifications/{id}' \
  --header 'Authorization: Bearer JWT'

200

400

401

403

422

{
  "statusCode": 200
}

Successful Operation.

get

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

Authorizations

Path parameters

idstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/admin/communications/notifications/{id}/channels' \
  --header 'Authorization: Bearer JWT'

200

400

401

403

422

{
  "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"
      }
    ]
  }
}

Successful Operation.

get

/admin/communications/channels/{id}

Authorizations

Path parameters

idstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/admin/communications/channels/{id}' \
  --header 'Authorization: Bearer JWT'

200

400

401

403

422

{
  "statusCode": 200,
  "data": {
    "id": "d44cc91d-0fa7-4cc0-85af-f3dd57fee292",
    "template": "ca91d88c-21c1-48da-95ac-8b57fdc62869",
    "isCustomTemplate": false,
    "notificationId": "b86ab9b3-ab76-4633-8030-ec990d27a974",
    "type": "PUSH"
  }
}

Successful Operation.

put

/admin/communications/channels/{id}

Authorizations

Path parameters

idstringrequired

Body

templatestring

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

isCustomTemplatestring

Example: false

notificationIdstring

Example: b86ab9b3-ab76-4633-8030-ec990d27a974

typestring · enumrequired

Example: PUSH

Options: PUSH, EMAIL, SMS

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url '/admin/communications/channels/{id}' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{"template":"ca91d88c-21c1-48da-95ac-8b57fdc62869","isCustomTemplate":false,"notificationId":"b86ab9b3-ab76-4633-8030-ec990d27a974","type":"PUSH"}'

200

400

401

403

422

{
  "statusCode": 200
}

Successful Operation.

delete

/admin/communications/channels/{id}

Authorizations

Path parameters

idstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url '/admin/communications/channels/{id}' \
  --header 'Authorization: Bearer JWT'

200

400

401

403

422

{
  "statusCode": 200
}

Successful Operation.

post

/admin/communications/channels

Authorizations

Body

templatestringrequired

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

isCustomTemplateboolean

Example: false

notificationIdstringrequired

Example: b86ab9b3-ab76-4633-8030-ec990d27a974

typestring · enumrequired

Example: PUSH

Options: PUSH, EMAIL, SMS

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/admin/communications/channels' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{"template":"ca91d88c-21c1-48da-95ac-8b57fdc62869","isCustomTemplate":false,"notificationId":"b86ab9b3-ab76-4633-8030-ec990d27a974","type":"PUSH"}'

201

401

403

422

{
  "statusCode": 201
}

Successful Operation.