Skip to main content
PATCH
/
pg
/
vba
/
notificationgroup
/
{notification_group_name}
Manage Notification Group Status
curl --request PATCH \
  --url https://sandbox.cashfree.com/pg/vba/notificationgroup/{notification_group_name} \
  --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 '
{
  "status": "ACTIVE"
}
'
{
  "notification_group": {
    "notification_group_name": "finance_team",
    "notification_group_emails": [
      "[email protected]"
    ],
    "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"

Path Parameters

​
notification_group_name
string
required

It is the name of the created notification group.

Body

application/json

PG VBA Notification Group Create Request

​
status
enum<string>

It is the status to which you want to modify the created notification group.

Available options:
ACTIVE,
INACTIVE

Response

Success Response.

​
notification_group
object