Skip to main content
POST
/
pg
/
vba
/
notificationgroup
Create Notification Group
curl --request POST \
  --url https://sandbox.cashfree.com/pg/vba/notificationgroup \
  --header 'Content-Type: application/json' \
  --header 'x-api-version: <x-api-version>' \
  --header 'x-client-id: <x-client-id>' \
  --header 'x-client-secret: <x-client-secret>' \
  --data '{
  "notification_group_name": "finance_team",
  "notification_group_emails": [
    "user@cashfree.com"
  ],
  "notification_group_phone_numbers": [
    "9876543210"
  ]
}'
{
  "notification_group": {
    "notification_group_name": "finance_team",
    "notification_group_emails": [
      "user@cashfree.com"
    ],
    "notification_group_phone_numbers": [
      "9876543210"
    ],
    "notification_group_created_on": "2019-08-24T14:15:22Z",
    "notification_group_last_updated_on": "2019-08-24T14:15:22Z"
  }
}

Headers

ā€‹
x-client-id
string
required

client id generated from the merchant dashboard

ā€‹
x-client-secret
string
required

client secret generated from the merchant dashboard

ā€‹
x-api-version
enum<string>
required

API version to be used. The accepted format is YYYY-MM-DD.

Available options:
2024-07-10T00:00:00.000Z
ā€‹
x-request-id
string

Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to Cashfree Payments.

Example:

"4dfb9780-46fe-11ee-be56-0242ac120002"

Body

application/json

PG VBA Notification Group Create Request

ā€‹
notification_group_name
string

It is the name you create to identify the notification group. The parameter allows alphanumeric characters, hyphen (-), and underscore ( _ ).

Example:

"finance_team"

ā€‹
notification_group_emails
string[]

It is the email addresses of the recipients who receive the notifications.

ā€‹
notification_group_phone_numbers
string[]

It is the phone number of the recipients who receive the notifications.

Response

Success Response.

ā€‹
notification_group
object