get https://partner.gupshup.io/partner/app//health
Use this API to check the health of the Gupshup App
Attention
This guide is no longer maintained from 31st Jan 2025. Please refer the updated one here.
Parameters
Parameters | Value | Description |
---|---|---|
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 Code | Response | Comments |
---|---|---|
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" } |