Authentication

The Postman v2 API uses API keys and static IP whitelisting to authenticate incoming requests from your server.

Your API keys carry many privileges, so be sure to keep them secure. Don't share your secret API keys in publicly accessible areas such as GitHub, client-side code, and so forth.

Authentication to the API is performed with HTTP Bearer Auth.

You will first need to Create Campaign on the admin portal before you can generate your campaignId

An example curl request:

curl https://<POSTMAN_V2_API_BASE_URL>/api/v2/campaigns/:campaignId/messages -H "Authorization: Bearer YOUR_API_KEY"

You must make all API calls over HTTPS. Calls that you make over plain HTTP will fail. API requests without authentication will also fail.

If you make a request without authentication, you will receive HTTP 401 and the following in your response body:

{
    "message": "Unauthorized",
    "statusCode": 401
}