AvenPing WhatsApp Business API ​

Use the AvenPing HTTP API to send WhatsApp messages, list templates and flows, and download media from your own backends. Access uses credentials linked to your AvenPing workspace.

WhatsApp access is provided through AvenPing, an official Meta Business Partner, using credentials linked to your workspace.

Current version

All endpoints are served under the v2 path prefix (/v2).
The previous v1 base path is fully deprecated; requests to /v1 endpoints are no longer supported and will not return data.

Prerequisites ​

  • An AvenPing workspace on Premium or Enterprise with an active plan
  • A linked WhatsApp Business account in AvenPing
  • An API token from Settings → API Settings — see Authentication

Step-by-step ​

  1. Get your API token
    In the AvenPing app, open Settings → API Settings and copy the access token. Send it as Authorization: Bearer <token> or X-API-Token: <token>.

  2. Confirm routing with GET /v2/health
    Call https://api.avenping.com/v2/health with no token. A live API returns { "success": true, "data": { "ok": true } }.

  3. List phone numbers with GET /v2/me
    Authenticate and call GET /v2/me. Use each object’s phoneNumberId on send and upload routes. See Account.

  4. Call the endpoint group you need
    Use the capability map below (messages, templates, media, forms, webhooks). JSON bodies use Content-Type: application/json and a 2 MB limit.

Where to go next ​

PageWhat you will find
Authentication & requirementsHow to get a token, plan rules, and your first successful request (GET /v2/me)
HTTP API v2 OverviewConventions, auth rules, errors, and links to each endpoint group
Postman collectionImportable collection, variables, and how to publish docs in Postman

Quick facts ​

TopicDetail
Production base URLhttps://api.avenping.com (append paths such as /v2/health)
Public checks (no token)GET /v2/health, GET /v2/version
AuthenticationAuthorization: Bearer <token> or X-API-Token: <token> (from Settings → API Settings)
PlansPremium or Enterprise, subscription active
JSON bodiesContent-Type: application/json, max 2 MB

Capability map (v2) ​

  • Public & meta — GET /, GET /v2/health, GET /v2/version (no token)
  • Account — GET /v2/me for user, linked WABAs, and all phoneNumberId values (plus defaultPhoneNumberId when it can be chosen automatically)
  • Templates — list, fetch by name, send and test-send (with phoneNumberId checks)
  • Forms (flows) — list from Meta, search in AvenPing DB, fetch flow by ID
  • Media — upload (POST /v2/media/upload) and stream download by Meta media ID
  • Messages — text, media, location, interactive, plus smart POST /v2/messages/send
  • Webhooks — set or clear your outbound webhook URL and code (same data as Settings → Webhook Settings)

Start from the HTTP API v2 Overview for global rules, then open the group you need.

FAQ ​

Which plans can use the AvenPing API?

Premium or Enterprise, with an active subscription. See Authentication. Other plans receive 403 DEVELOPER_PLAN_REQUIRED. An expired primary plan returns 403 PLAN_EXPIRED.

How do I authenticate?

Send the token from Settings → API Settings as Authorization: Bearer <token> or X-API-Token: <token>. Public checks (GET /v2/health, GET /v2/version) need no token. Missing or invalid tokens return 401 UNAUTHORIZED.

What is the production base URL?

https://api.avenping.com. All documented REST routes use the /v2 prefix (for example GET /v2/health). The previous /v1 path is deprecated and will not return data.