Skip to main content
POST
/
auth
/
login
/
whatsapp
Login with WhatsApp
curl --request POST \
  --url https://staging.api.commercengine.io/api/v1/{store_id}/storefront/auth/login/whatsapp \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "phone": "<string>",
  "country_code": "<unknown>",
  "register_if_not_exists": true
}
'
{
  "message": "<string>",
  "success": true,
  "content": {
    "otp_token": "<string>",
    "otp_action": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

Access token

Headers

​
x-debug-mode
boolean

This param is used to enable debug mode. If debug mode is enabled, the API will return OTP as well. This is only for development and testing purposes.

Body

application/json
​
phone
string
required

10 digit phone number without country code, linked with WhatsApp.

Required string length: 10
Pattern: ^[0-9]{10}$
​
country_code
any

Two-letter code begin with a plus sign prefix that identifies different countries. By default it will be +91 if not provided.

​
register_if_not_exists
boolean

When true, auto-registers the user if the phone number is not found. Defaults to false (OTP sent only to registered users).

Response

OK

​
message
string
required

A descriptive message confirming the success or failure of the Login process.

​
success
boolean
required

Indicates whether the request was successful or failure (true for success, false for failure).

​
content
object
required

An object containing the response content.