Skip to main content

Postman Collections

Import our ready-to-use Postman collections to start testing the API immediately. Each collection includes pre-configured requests with examples for every endpoint.

How to import​

  1. Download the .json file for the collection you need
  2. Open Postman and click Import (top left)
  3. Drag the file or click Upload Files
  4. Set the X-Api-Key variable in your environment
Tip

Create a Postman Environment with variable baseUrl set to https://api.qlara.ai/api and apiKey set to your API key. This way all requests will use the correct values automatically.

Available collections​

CollectionEndpointsDownload
Qlara PlatformContacts, Lists, Campaigns, Webhooks, Exports, Inbox, Media, SubscriptionDownload JSON
SMS UniversalSend SMS (modern format)Download JSON
SMS LegacySend SMS (backward-compatible format)Download JSON
RCS SendSend RCS messagesDownload JSON
RCS TemplatesCreate, update, delete RCS templatesDownload JSON
WhatsAppSend messages, manage templates and phone numbersDownload JSON

Setting up authentication​

After importing, configure authentication for all requests at once:

  1. Click on the collection name in the sidebar
  2. Go to the Authorization tab
  3. Select API Key as type
  4. Set Key to X-Api-Key
  5. Set Value to your API key
  6. Set Add to to Header

All requests in the collection will inherit this authentication.