Skip to main content
POST
Create a signup process

Body

application/json
partner_name
string

The name of the partner.

Example:

"Partner Inc."

URL to the partner's logo.

Example:

"https://partner.com/logo.png"

partner_callback_url
string

Callback URL to receive notifications with the status of the onboarding process.

Example:

"https://partner.com/callback"

partner_client_id
string

Client ID provided by the partner (to identify partner's client in the callback).

Example:

""

partner_finish_url
string

URL for redirection after processing.

Example:

""

phone_number
enum<string>
default:automatic

If manual, you need to provide a phone number during the onboarding process. If automatic, the system will automatically assign a phone number (based on the country code).

Available options:
manual,
automatic
wa_name
string

WhatsApp display/business name.

Example:

"Name"

wa_email
string

Email associated with the WhatsApp account.

Example:

"Email"

wa_website
string

Website address related to the WhatsApp account.

Example:

"https://"

country
string

Country code in ISO alpha-2 format. Mandatory if phone_number is automatic.

Example:

"US"

Response

Signup process created successfully

success
boolean

Success status.

Example:

true

token
string

JWT token for the signup process.

Example:

"eyJhbGciOiJIUzI..."

redirect_url
string

URL for redirection after processing. You have to append the token to the URL and redirect the user to it and put it in to the GET parameter with key name token.

Example:

"https://waba.smsmanager.com/registration/"