Quickstart

Three steps: connect a number, create a key, send a message. Steps 1 and 2 happen once per account.

1. 1

   Connect a WhatsApp number

   Open the dashboard and run Embedded Signup. Sendport reads your WhatsApp Business Accounts and phone numbers from the Graph API and registers the webhook for you. See Embedded Signup.

2. 2

   Create an API key

   Dashboard → API keys → Create key. Test keys start with sp_test_ and only reach the sandbox; live keys start with sp_live_. The secret is shown once.

   Shell

   export SENDPORT_KEY="sp_test_sandbox"

3. 3

   Send a message

   Outside a 24-hour customer service window you must send a template. Inside it, free-form text is allowed.

   cURL

   curl -X POST https://api.sendport.tech/v1/messages \
     -H "Authorization: Bearer $SENDPORT_KEY" \
     -H "Content-Type: application/json" \
     -d '{
       "to": "+201005550123",
       "type": "template",
       "template": {
         "name": "order_shipped",
         "language": "en",
         "components": [
           { "type": "body", "parameters": [
             { "type": "text", "text": "A-4417" },
             { "type": "text", "text": "Tuesday" }
           ]}
         ]
       }
     }'

What comes back

{
  "object": "message",
  "id": "msg_01JZQ3F8X2K7N4B6Y0R9M5TCWA",
  "wamid": "wamid.SEJnTTIwMTAwNTU1MDEyM0ZRSUFFUmdT",
  "conversation_id": "conv_01JZQ3F8X0QG7T2S4N8V1PZAKD",
  "to": "+201005550123",
  "type": "template",
  "status": "accepted",
  "created_at": "2026-09-06T09:14:22.114Z"
}

accepted means Sendport queued it. Delivery is asynchronous — subscribe to message.delivered rather than polling.

Next