Authentication

All developer-facing Ping endpoints use API keys for server-to-server integrations (sending SMS, email, WhatsApp, and other notification APIs).

API keys (developer notification APIs)

For server-to-server integrations, use an API key to authenticate requests to the developer APIs.

Example (send SMS):

Developer API (API Key)

curl -X POST https://api.ping.co.zw/v1/notification/api/sms/send \
  -H "Content-Type: application/json" \
  -H "X-Ping-Api-Key: YOUR_API_KEY" \
  -d '{"sender":"Ping","recipients":["+263771234567"],"message":"Hello from Ping"}'

Optional header: X-Ping-Required-Permission (sms | email | whatsapp | templates | bulk) can be used to surface required permissions for the key.

Required headers (summary)

  • X-Ping-Api-Key: <api key> (developer APIs) +- X-Business-Id: numeric business id for business-scoped requests when not in path

+- Content-Type: application/json + + Want more? Visit our support page at https://docs.ping.co.zw/authentication + +

Was this page helpful?