Set Callback Url

Use this API to set callback URL for your Gupshup App

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
🚧

⚠We are going to be deprecating this API soon, we request you that you start using the subscription API, as it provides you with a granular control for event management on your callback URL

Once set you will get DLR events on that callback URL.

Parameters

ParametersValueDescription
Authorization{{PARTNER_APP_TOKEN}}Access Token for the application
appId{{APP_ID}}Unique Identifier for Gupshup App
callbackUrl{{Callback_URL}}Learn how you can successfully set a callback URL for an app.

Sample Request

curl --location --request PUT 'https://partner.gupshup.io/partner/app/{{APP_ID}}/callbackUrl' \
--header 'Authorization: {{PARTNER_APP_TOKEN}}' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'callbackUrl={{CALLBACK_URL}}'

Sample Response

{
  "status": "success"
}   

Status Codes

Status CodeResponseComments
Success
200{ "status": "success" }
Error
429{ "status": "error", "message": "Too Many Requests" }10 Requests per Minute
500{ "status": "error", "message": "Error updating callback URL" }For any Internal Error
Path Params
string
required

Unique identifier of the app.

Form Data
string
Headers
string
required

Your app token, please refer Get access token api to get the token from partner documentation.

Responses

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json