Business Settings
You can modify some business settings using this API endpoint.
you can edit any of the parameters you wish.
Settings:
URL | |
Method | JSON via PATCH |
Header | Authorization: Bearer {{access_token}} *The access_token can be received from settings->get access token API. |
Body:
Parameter | Description / Example | Maximum length | Remarks |
|---|---|---|---|
onboarding_logo | HTTPS link for WhatsApp onboarding logo to show by default to any onboarding link that was not set specific onboarding logo. The image size should be 200x60 px with png/jpg format | 512 | Full URL here |
onboarding_message | Text to show by default for WhatsApp onboarding link above the onboarding button, in case you did not set any specific text for onboarding link | 200 | Full text here |
onboarding_button | The button text to show by default for WhatsApp onboarding link | 50 | Button text here |
onboarding_success | After the client finished the onboarding process successfully, here you can set the default text to show them | 200 | Text goes here |
onboarding_failed | This text appears if the onboarding was not completed successfully, here you can set the default text to show them | 200 | Text goes here |
Response:
{
"status": "OK",
"reason": 1,
"any of the paramters": "the data you provided"
}
Response-Explain:
Parameter | Description | ||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
status | OK or FAIL "OK" means the request has been sent to Meta. "Fail" means error. | ||||||||||||||||
any of the parameters | The response will return the parameters you provided | ||||||||||||||||
reason | 'reason' is the status explanation in case of FAIL
|
Get the business data
Settings:
URL | |
Method | JSON via GET |
Header | Authorization: Bearer {{access_token}} *The access_token can be received from settings->get access token API. |
Body: nothing, leave it empty.
Response:
{
"status": "OK",
"business_name": "Your business name",
"onboarding_logo": "URL goes here",
"onboarding_message": "message goes here",
"onboarding_button": "button text goes here",
"onboarding_success": "success message goes here",
"onboarding_failed": "failed message goes here",
"reason": 1
}
Response-Explain:
Parameter | Description | ||||||||
|---|---|---|---|---|---|---|---|---|---|
status | OK or FAIL "OK" means the request has been sent to Meta. "Fail" means error. | ||||||||
business_name | The business name, this value can't be changed from the setBusiness API | ||||||||
onboarding_logo | The onboarding HTTPS that is used by default | ||||||||
onboarding_message | The onboarding message that shows by default | ||||||||
onboarding_button | The button text that shows by default | ||||||||
onboarding_success | Success message when onboarding completed successfully | ||||||||
onboarding_failed | Failed message when onboarding failed | ||||||||
reason | 'reason' is the status explanation in case of FAIL
|