Request Parameters

Key	Description	Value	Data type	Required/Optional	Constraints
Authorization	Partner app access token issued post partner login	{{PARTNER_APP_TOKEN}}	String	Required	Should be a valid Partner app access token belonging to the passed app ID.
appId	App ID to fetch the access token	{{APP_ID}}	String	Required	Valid app ID
region	Data Localization Region for the app			Optional	Default is IN.

Sample Request

curl --location 'https://partner.gupshup.io/partner/app/:appId/onboarding/register' \
--header 'Authorization: {{PARTNER_APP_TOKEN}}' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'region=IN'

Sample Response

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

Status Codes

Status Code	Response	Comments
Success
200	{ "status": "success", "success": true }
Error
400	{ "status":"error", "message/data":"<Specific to API>" }	Error with respect to API
401	{ "status":"error", "message":"Unauthorized Access" }	When authentication fails
429	Too Many Requests	When rate limit is hit
500	{ "status": "error", "message": "Internal Server Error" }	For any Internal Error