Quickstart

Get up and running with the Popp API.

Prerequisites

Before you begin, make sure you have:

• Your API key and Organization ID (see Authentication)
• Access to the Popp dashboard

Step 1: Create a Campaign in the Dashboard

First, create a campaign using the Popp dashboard:

1. Log in to your Popp dashboard
2. Navigate to Campaigns and click Create Campaign
3. Configure your campaign settings (channel, template, etc.)
4. Save your campaign

Here's a video walkthrough that shows you how:

Step 2: Get Your Campaign ID

Once your campaign is created, grab the Campaign ID from your browser's URL bar:

https://ai.joinpopp.com/campaign/outbound/10fe477c-5a4a-451d-9f18-b8340e2154e8
                                         └──────────────────────────────────┘
                                              Copy this Campaign ID

The Campaign ID is the UUID at the end of the URL (e.g., 10fe477c-5a4a-451d-9f18-b8340e2154e8).

Step 3: Create a Conversation

Now you can use the API to create conversations for your campaign.

For SMS/WhatsApp Campaigns

curl -X POST "https://api.popp.ai/v1/conversations" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "x-organization-id: YOUR_ORGANIZATION_ID" \
  -H "Content-Type: application/json" \
  -d '{
    "firstName": "John",
    "campaignId": "YOUR_CAMPAIGN_ID",
    "phoneNumber": "+1234567890"
  }'

For Email Campaigns

curl -X POST "https://api.popp.ai/v1/conversations" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "x-organization-id: YOUR_ORGANIZATION_ID" \
  -H "Content-Type: application/json" \
  -d '{
    "firstName": "John",
    "campaignId": "YOUR_CAMPAIGN_ID",
    "emailAddress": "[email protected]"
  }'

For Multi-Channel Campaigns

You can provide both phone number and email address:

curl -X POST "https://api.popp.ai/v1/conversations" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "x-organization-id: YOUR_ORGANIZATION_ID" \
  -H "Content-Type: application/json" \
  -d '{
    "firstName": "John",
    "campaignId": "YOUR_CAMPAIGN_ID",
    "phoneNumber": "+1234567890",
    "emailAddress": "[email protected]"
  }'

Response

A successful request returns the created conversation:

{
  "message": "Conversation created"
}

What's Next?

• Learn about Campaigns and how they work
• Understand Conversations and their lifecycle
• Set up Scheduling for automated meeting booking
• Configure Webhooks for real-time updates

API Reference

• Create Conversation - Full API details
• List Conversations - Query and filter conversations
• List Campaigns - Query and filter campaigns