Who is this API for?
If you are an ISV, reseller, or platform builder integrating WhatsApp messaging into a product you offer to your own customers, this API is for you. Rather than directing each client through a manual sign-up process, you initiate registration on their behalf, redirect them to a SmsManager-hosted flow where they complete the WhatsApp Business Account (WABA) registration, and then use the management endpoints to look up their account details once onboarding is complete. Everything runs under your partner account — your clients never need direct access to SmsManager.Base URL
Authentication
All endpoints require your API key in thex-api-key request header.
Onboarding flow
- POST /whatsapp/signup — Send your client’s details to SmsManager. You receive a
redirect_urland a short-lived JWTtoken. - Redirect your client — Append the token as a query parameter and send the client’s browser to
redirect_url?token=<JWT>. SmsManager serves the hosted registration UI. - Client completes registration — The client follows the WhatsApp Business registration steps in the SmsManager-hosted flow. No coding required on their end.
- Receive callback — SmsManager posts onboarding status notifications to the
partner_callback_urlyou supplied in step 1. Listen for the completion event. - Retrieve the WABA ID — Call
POST /whatsapp/accounts/listto get the new account’swhatsapp_id(WABA ID). - Manage phone numbers and templates — Use the WABA ID with
POST /whatsapp/phone_numbers/listandPOST /whatsapp/templates/listto retrieve the resources you need for sending messages.
Endpoints summary
Individual endpoints — with parameters, request bodies, and examples — are listed in this section’s sidebar, generated directly from the OpenAPI specification.