1. Campaigns
Atlas
  • Voice AI
    • Welcome to Atlas!
    • Account Setup
    • Create your first campaign
    • Knowledge
    • Edit Script
    • Advanced Script Options
    • Phone number integration
    • Twilio Integration
    • Call Forwarding
    • Calendar Integration
    • SMS Integration
    • Campaign Details
    • Add Contacts
    • Call Records
    • Account
    • Call Scheduling
    • Testing your outbound campaign
    • Clone Campaign
    • General Walkthrought
    • Atlas Blue Campaigns
      • Atlas Blue
      • Creating a Campaign
      • Phone Number Setup
      • Sending Limits & Queue
      • First Message Rules
      • Message Formatting
      • Conversations & Testing
      • FAQ
    • Calls Enrichment
      • Enriching Calls with External CRM and Data Sources
      • Go High Level - Call Enrichment
      • Pipedrive - Call Enrichment
      • Shopify - Call Enrichment
      • Monday - Call Enrichment
      • Hubspot - Call Enrichment
    • Atlas Actions
      • Atlas Actions triggering
      • HubSpot - Meetings Scheduler Integration
      • GoHighLevel - Calendar Integration
    • Campaigns
      • Create Campaign
      • Campaigns
      • Voice Bubble
    • Integrations
      • Zapier
      • Make
      • Keragon
      • Go High Level
        • Download Atlas App in GHL App Marketplace
        • Import the Atlas Snapshot
        • Triggers and Actions
        • Workflows
          • Workflow 01 - Lead form Submitted Website
          • Workflow 02 - CALL Lead from Website form
          • Workflow 03 - CALL Lead from Meta
          • Workflow 04 - Summary and Recording to Conversations
    • Phone Systems Integrations
      • Dialpad Integration
  • TV Ads
    • Atlas Pixel Tracker
  • API Reference
    • What can you build with the Atlas API?
    • API Keys
    • Campaigns
      • Get all campaigns
        GET
      • Get campaign by ID
        GET
      • Set campaign status
        PUT
      • Update campaign
        PUT
      • Delete campaign
        DELETE
      • Create campaign
        POST
      • Set campaign status
        PUT
      • Update full campaign
        PUT
      • Update chat status
        PUT
      • Get campaign templates
        GET
      • Get template detail
        GET
      • Download campaign data
        POST
      • Get campaign version history
        GET
      • Rollback campaign
        POST
      • Test caller enrichment
        POST
      • Generate AI prompt
        POST
      • Get campaign calendars
        GET
      • Create calendar integration
        POST
      • Delete campaign calendar
        DELETE
    • Statistics
      • Get all campaigns overview statistics
      • Get call records
      • Get campaign statistics
      • Get call record details
      • Delete call record
      • Get campaign statistics
    • Calls
      • Create scheduled call
      • Get scheduled calls
      • Schedule outbound call
      • Get scheduled calls
    • Bookings
      • Get all bookings
      • Get bookings for call
      • Get bookings by call ID
    • Knowledge Base
      • Get all knowledge base files
      • Delete knowledge file
      • Upload knowledge file
      • Extract knowledge from URL
      • Get knowledge files for campaign
      • Attach file to campaign
      • Detach file from campaign
      • Add file to collection
      • Remove file from collection
      • Get file linked campaigns
      • Attach file to campaign
      • Detach file from campaign
    • Agents
      • Get all agents
      • Get agents by campaign
      • Create agent
      • Get agent by ID
      • Update agent
      • Delete agent
    • Contacts
      • Create contact list
      • Create contact manually
      • Get contacts by campaign
      • Get contact by ID
      • Update contact
      • Delete contact
      • Get all global contacts
      • Update global contact
      • Delete global contact
      • Get available tokens
      • Get total contacts count
    • Tools
      • Get all tools
      • Create tool
      • Update tool
      • Delete tool
      • Create tool from template
      • Get tool templates
      • Search tool templates
      • Get template categories
      • Get tool execution metrics
      • Generate tools from OpenAPI spec
    • Phone Numbers
      • Get all phone numbers
      • Get phone number by ID
      • Delete phone number
      • Integrate new phone number
      • Link phone number to campaign
      • Unlink phone number
      • Get Twilio sub-account
    • Voices
      • Get all voices
      • Clone voice
      • Delete voice
      • Get pangram sentences
    • Calendar Settings
      • Get all calendar integrations
      • Create calendar integration
      • Update calendar integration
      • Delete calendar integration
    • Calls Forward
      • Get forwarding rules by campaign
      • Create forwarding rule
      • Delete forwarding rule
    • Events Gateway
      • Get triggers for campaign
    • Dashboard
      • Get dashboard statistics
      • Get deployment statistics
    • Account
      • Get user profile
    • Customer Quota
      • Get quota information
      • Get monthly minutes usage
    • Customer Wallet
      • Get ad wallets
    • Campaign Chat
      • Get chat sessions
      • Initiate web chat
      • Get chat messages
      • Get chat phone numbers
      • Link phone number to campaign
      • Unlink phone number
      • Cancel chat phone number
      • Schedule SMS session
      • Send human agent response
      • Upload media attachments
      • Send voice message
      • Toggle human handoff
    • API Keys
      • Get API keys
      • Create API key
      • Delete API key
  • Schemas
    • CampaignRow
    • CampaignBody
    • CampaignBodyV2
    • Voice
    • AgentRow
    • CreateAgentRequest
    • Statistics
    • CampaignTemplate
    • UpdateAgentRequest
    • CampaignSnapshot
    • TotalStatistics
    • AgentBody
    • AgentEntity
    • CallStatistics
    • ContactInput
    • Template
    • SavedAgent
    • CallRecordBasic
    • CallHistoryResponse
    • ContactEntity
    • Error
    • CallHistoryEntry
    • ContactListResponse
    • CallMessageRole
    • CostBreakdownAnalysis
    • CostBreakdown
    • Analysis
    • Artifact
    • Cost
    • Monitor
    • CallDetails
    • CallRecordDetailed
    • Booking
    • BookingsResponse
    • ScheduledMessage
    • ScheduledCallsResponse
    • BlobFile
    • BlobFileResponse
    • KnowledgeBaseEntry
    • KnowledgeBaseResponse
    • ToolBody
    • ToolEntity
    • ToolTemplate
    • ToolMetric
    • PhoneNumberEntity
    • CalendarSettingsBody
    • CalendarSettingsEntity
    • CallForwardBody
    • CallForwardEntity
    • DashboardStats
    • CategoryStats
    • CustomerQuota
    • WalletTransaction
    • ChatSession
    • ChatMessage
  1. Campaigns

Test caller enrichment

POST
/campaign/caller-enrichment/{provider}
Test caller enrichment for a specific provider

Request

Authorization
API Key
Add parameter in header
api-key
Example:
api-key: ********************
or
Path Params

Responses

🟢200
Enrichment test result
This response does not have a body.
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api.youratlas.com/v1/api/campaign/caller-enrichment/' \
--header 'api-key: <api-key>'
Modified at 2026-04-24 20:51:01
Previous
Rollback campaign
Next
Generate AI prompt
Built with