Postman collection ​

Use Postman to try the AvenPing API without writing code. The collection matches the endpoints described in the HTTP API v2 docs (overview plus group pages).

Download ​

Use the link below to download the latest collection file to your computer, then import it into Postman.

Download AvenPing API v2 (Postman collection)

The file name is avenping-api.postman_collection.json. Your browser may save it to your Downloads folder.

Import and set up ​

  1. Open Postman (desktop or web) and choose Import.
  2. Drag the downloaded file in, or use Upload Files and select avenping-api.postman_collection.json.
  3. Select the AvenPing API v2 collection, open the Variables tab, and set:
VariableWhat to enter
baseUrlYour API base URL, e.g. https://api.avenping.com (no trailing slash)
apiTokenYour token from the AvenPing app: Settings → API Settings
phoneNumberIdMeta Phone number ID for the line you send from (see below)
templateName, flowId, mediaIdFill in when you run those example requests
  1. To find valid phoneNumberId values, call GET /v2/me with the same token (Bearer or X-API-Token). Copy a phoneNumberId from the phoneNumbers array into the collection variable. If defaultPhoneNumberId is present, you have a single line and can use that value.
  2. Under Public, run Health (GET /v2/health) to confirm baseUrl is correct.
  3. For authenticated requests, the collection uses Bearer auth with . There is also an example request that sends the token as X-API-Token instead—either style works with the API.

Protect your token

Your API token is secret. Do not paste it into public chats, screenshots, or shared collection files. In Postman, prefer a private environment for apiToken so it is not embedded when you export the collection.

Optional: publish your own doc on Postman ​

You can turn this collection into a public documentation page (and optionally a “Run in Postman” button) for your team or customers:

  1. Create or sign in to a Postman account.
  2. Import the collection into a workspace.
  3. Optionally add Environments (for example Production vs staging) with different baseUrl values.
  4. Open the collection, then use View documentation or Publish (the exact label depends on your Postman version).
  5. Follow the steps to get a shareable URL. Anyone with the link can read the docs; they still need their own AvenPing token to call the API.
  6. When AvenPing adds or changes endpoints, download a fresh collection from this page, import it again, and republish so your public doc stays current.

Team accounts can use a Team workspace so several people can maintain the same collection and publishing settings.