Get Onboarding list
This API allows you to see all the onboarding accounts that you have created and their status.
Settings:
Body: nothing, leave it empty.
Response:
{
"status": "OK",
"reason": 1
"list": [
{
"create_time": 1739874663,
"whatsapp": "972501234567",
"coexistence": 0
"business_name": "Acme inc",
"business_email": "john@example.com",
"business_id": "1234567",
"business_address": "Grove Street, San Andreas",
"landing_page": "https://my-landing-page.com/44124",
"onboarding_link: "https://onboarding.com/6235",
"display_name": "Acme",
"reference": "123123",
"status": 1
}
]
}
Response-Explain:
Parameter | Description |
|---|
status | OK or FAIL "OK" means the request has been sent to Meta. "Fail" means error. |
list | array of [create_time, whatsapp, business_name, business_email, business_id, business_address, landing_page, onboarding_link, display_name,reference,status] Explanation: create_time | Unix timestamp when the account was created | whatsapp | The WhatsApp number related to this onboarding account in case the 'status' value is 0 and 'coexistence' value is 1, this 'whatsapp' param will show a temporarily number until the client finishes the onboarding. the number you will see starts with 97257... once the client finishes the onboarding(status=1), it will show the real number. | coexistence | 0 - This onboarding link is not coexistence 1 - This onboarding link is coexistence | business_name | The busienss name that was provided by you | business_email | The business email that was provided by you | business_id | The business ID that was provided by you | business_address | The business address that was provided by you | landing_page | The landing page we generated for your client. this can be used inside Facebook to create the WhatsApp onboarding in case your client does not have any website or landing page for his business. | onboarding_link | The onboarding link you should share with your client for him to set up his WhatsApp account | display_name | The display name that will be used, once your client finishes the onboarding process | reference | The reference that was provided by you | status | 0 - the client did not finish the onboarding process 1 - the onboarding process was finished
Important note: you can't remove accounts that the status is 1. |
|
reason | 'reason' is the status explanation in case of FAIL 1 | not FAIL. the status is OK | 2 | Wrong credentials | 3 | Access token does not exist or expired, please generate another one from Settings - Get access token API | 13 | you need to use GET method. |
|
