Update Subscription

Testing Env

PUT

/webhooks/subscriptions

Update a webhook subscription. The supplied eventTypes array replaces the full stored set — events not present in the request are unsubscribed. To stop receiving events entirely, use DELETE /subscriptions rather than sending an empty list.

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Query Params

Header Params

Body Params application/jsonRequired

Examples

Responses

🟢200Success

application/json

Successful Response

Bodyapplication/json

🟠400Not Found

🟠401Bad Request

🟠403Unprocessable Entity

🟠404Unauthorised

🟠422Forbidden

🔴500

Request Example

Shell

JavaScript

Java

Swift

curl --location --request PUT '/webhooks/subscriptions?subscriptionId=undefined' \
--header 'x-api-version;' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "url": "http://example.com",
    "eventTypes": [
        "corporate.status.activated"
    ],
    "authKey": "string",
    "isEnabled": true,
    "maxRetries": 3,
    "retryDelayMinutes": 5
}'

Response Example

200 - Example 1

{
    "message": "string",
    "data": {
        "createdAt": "2019-08-24T14:15:22.123Z",
        "updatedAt": "2019-08-24T14:15:22.123Z",
        "id": "string",
        "url": "string",
        "eventTypes": [
            "string"
        ],
        "authKey": "string",
        "isEnabled": true,
        "maxRetries": 0,
        "retryDelayMinutes": 0
    }
}

Modified at 2026-06-04 17:27:13

Create Subscription

Get Subscription By Id