Delete specific subscription of an app

This API endpoint enables partners to delete a specific webhook subscription by its unique subscription ID. Unlike the general delete subscription endpoint that removes all subscriptions for an app, this endpoint provides granular control to remove individual subscriptions when multiple webhook configurations exist. This is particularly useful for managing multi-environment setups, removing deprecated webhooks, or cleaning up test subscriptions.

Request Parameters

KeyValueDescriptionData TypesRequire/OptionalConstraints
Authorization{{PARTNER_APP_TOKEN}}Partner app access token issued post partner loginStringRequiredShould be a valid Partner app access token belonging to the passed appId
appId{{App_ID}}App ID for the app to be deletedStringRequiredValid app ID
SUBSCRIPTION_ID2xxxxSubscription IDStringRequiredId of the subscription to be deleted

Sample Request

curl --location --request DELETE 'https://partner.gupshup.io/partner/app/{{APP_ID}}/subscription/{{SUBSCRIPTION_ID}}' \
--header 'Authorization: {{PARTNER_APP_TOKEN}}'

Sample Response

Status Codes

Status Code

Response

Comments

Success

204

Success when subscriptions are deleted. No content.

Error

400

{
"status": "error",
"message": "API key is not associated with partner"
}

Error with respect to API Key

429

{
"status": "error",
"message": "Too Many Requests"
}

Rate limit exceeded

Language
Click Try It! to start a request and see the response here!