Check Health

Use this API to check the health status of your partner application. This endpoint provides a quick way to verify if your application is properly configured and operational within the Gupshup partner platform.

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

Rate limit: 10 requests per 60 seconds

Parameters

ParametersValueDescription
Authorization{PARTNER_APP_TOKEN}Access Token for the application
appId{APP_ID}Unique Identifier for Gupshup App

Sample Request

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

Sample Response

{
    "status": "success",
    "healthy": "true"
}

Response Codes

Status CodeResponseComments
Success
200{ "status": "success", "healthy": "true" }
Error
400{ "message": "App is not live.", "status": "error" }If APP is not live
400{ "message": "Waba id not found for the given App", "status": "error" }If the WABA ID is not present in the DB
400{ "message": "WABA id is invalid or given phone is not associated with WABA", "status": "error" }If the WABA ID present in DB is not correct
400{ "message": "Error while getting waba info for given app", "status": "error" }
400{ "message": "Authentication Failed", "status": "error" }
401{ "status": "error", "message": "Unauthorised access to the resource. Please review request parameters and headers and retry" }If Invalid appID/token

Path Params
string
required
Headers
string
Responses

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