Sign in

Send PIN (WhatsApp)

POST https://{organization}.myguper.com/api/sender/whatsapppin/{pin}

Sends a one-time numeric PIN over WhatsApp — counterpart of Send PIN SMS. Routes the message through the organization's WhatsApp provider settings and the WhatsApp PIN template.

The pin itself travels in the URL path so it never lands in the request body (helps with logging hygiene).

Try-it values populated from environment ACME (Demo)


Authentication

Token

Send your user token in the x-guper-authorization header.

Headers

Name Type Description
x-guper-authorization * string User token issued by Guper.
Content-Type * string Always `application/json` for endpoints that accept a JSON body.

Path parameters

Name Type Description
pin * string 4–6 digit PIN.

Request body

Content-Type: application/json

{
    "cellphone": "5511987654321"
}

Responses

{ "id": "msg_01HXYZ", "channel": "whatsapp", "status": "queued" }
Copied to clipboard