Postman Collection

Overview

OutCallerAI offers a workspace-labeled Postman collection that you can download from the dashboard and import into Postman to test supported public API endpoints.

Capabilities

Our Postman collection contains pre-configured requests for every public CRM API capability:

1. Workspace Management: Retrieve current configuration settings.
2. Campaign Control: Create, update, list, and delete outbound dialing campaigns.
3. AI Agent Personas: Set up prompt scripts and agent personas.
4. Lead Lists: Import single or bulk leads into any active campaign.
5. Call Records: List calls for an agent and inspect an individual result.

Prerequisites

• The Postman desktop app or web client.
• An OutCallerAI workspace API key.
• Permission to access the workspace resources you intend to test.

Setup

1. Navigate to Integrations: Go to the Integrations Page inside the OutCallerAI dashboard.
2. Download from the header: Click Download Postman Collection next to View API Keys.
3. Import into Postman:
   • Open your Postman App.
   • Click Import in the top left.
   • Drag and drop or select the downloaded .postman_collection.json file.

How it works

The collection uses collection-level Bearer authentication with an API key variable:

Authorization: Bearer {{outcaller_api_key}}

It is pre-configured with variables under the collection properties:

• base_url: Automatically set to the public OutCallerAI API URL.
• outcaller_api_key: Empty by default. Paste your workspace API key into the variable’s current value after import.
• agent_id, campaign_id, lead_id, call_id: Blank IDs you can fill after creating or finding resources.

[!NOTE] If you regenerate your API key in the Workspace API Setup page, update the value of the outcaller_api_key collection variable to restore authorization for all requests.

[!WARNING] Treat the API key like a password. Do not place it in a shared initial value, exported collection, source control, screenshot, or support message. Use a Postman environment or local current value when the collection is shared with a team.

Verify the integration

Send a read-only list request after setting base_url and outcaller_api_key. Confirm a successful response before running requests that create, update, or delete resources.

Troubleshooting

• 401 response: confirm the current value of outcaller_api_key and replace it if the key was regenerated.
• 404 response: confirm base_url, the request path, and any resource ID variables.
• Wrong workspace data: verify that the API key belongs to the intended workspace.
• Blank path variable: populate the relevant agent_id, campaign_id, lead_id, or call_id.

Disconnect

Remove the API key from the collection or Postman environment. Revoke or regenerate the key from Workspace API Setup if it may have been exposed.