Sendport API▾

Sendport API

Send and receive WhatsApp messages over a REST API. Connect a number with Embedded Signup, then use one key for messaging, templates, broadcasts and webhooks.

The Sendport API is a REST interface over the WhatsApp Business Platform. You connect a phone number once through Meta's Embedded Signup, and from then on every message, template and webhook flows through one key and one base URL.

This documentation runs against a sandbox

Every Try it panel on these pages calls a simulated endpoint that returns canned data. No WhatsApp message is sent, nothing is stored, and every response carries "sandbox": true. See Sandbox.

Start here

Quickstart

Send your first message with curl in three steps.

Authentication

API keys, environments and key rotation.

API reference

Every resource, parameter and response.

Webhooks

Receive inbound messages and status updates.

Channels

Connect, key and migrate a WhatsApp number.

CLI

Send, tail and tunnel from your terminal.

Base URL

Base URL
https://api.sendport.tech/v1

All requests use HTTPS. Request and response bodies are JSON, except media upload which is multipart/form-data. Timestamps are RFC 3339 in UTC.

Resources

ResourceWhat it holds
messagesOutbound and inbound messages, their delivery status and pricing
conversationsOne thread per contact per number, with assignment and session state
contactsPeople you can message, their tags and custom attributes
templatesPre-approved message templates and their Meta review status
mediaImages, documents, audio and video you send or receive
broadcastsBulk template sends with per-recipient reporting
numbersThe WhatsApp numbers connected to your account
webhooksEndpoints Sendport delivers events to

Conventions

  • Phone numbers are always E.164 with a leading +, e.g. +201005550123.
  • Ids are prefixed and opaque: msg_, conv_, ct_, tpl_, bc_. Never parse them.
  • List endpoints return { object: "list", data: [...], has_more, next_cursor }.
  • Every response includes an X-Request-Id header. Quote it in support requests.
NextQuickstart