Create Campaign

post

https://api.joinpopp.com/v1/campaigns

Creates a campaign in Popp application.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Create Campaign Request

Request to create a new campaign

campaignType

string

enum

required

The type of campaign to create

Allowed:

closingMethod

string

enum

required

How the campaign conversation should be closed. Defaults to CALENDAR_MEETING_INTEGRATION for SCHEDULING campaigns. Each closing method requires its corresponding field: CUSTOM requires customMessage, PHONE_NUMBER requires contactNumber, MEETING_URL requires meetingUrl.

Allowed:

channel

string

enum

required

Communication channel used for the campaign

Allowed:

campaignTitle

string

required

Title of the campaign

campaignDescription

string

required

Detailed description of the campaign

closingMessage

string

required

Message sent when the conversation is completed successfully.

rejectionMessage

string

required

Message sent when a candidate is rejected (fails mandatory/knockout questions).

customMessage

string

Message sent to the candidate when they successfully complete the conversation. Required when closingMethod is CUSTOM.

contactNumber

string

Phone number to share with candidates. Must be a valid phone number in E.164 format.

meetingUrl

uri

URL for candidates to book a meeting.

company

string

Company name for the role.

location

string

Location of the role.

questions

array of objects

length ≥ 1

List of screening questions included in the campaign. Not allowed for SCHEDULING campaigns.

questions

additionalContext

string

Additional context or instructions for the AI agent (minimum 10 characters)

conversationTimeout

integer

≥ 24

Timeout for conversations in hours (minimum 24 hours). Defaults to 48 hours.

owner

string

Email address of the campaign owner. Must be a user in the organization.

campaignStatus

string

enum

Defaults to LIVE

Status of the campaign. DRAFT creates the campaign without sending. Defaults to LIVE.

Allowed:

openingMessageTemplateId

uuid

ID of the opening message template. Must match the specified channel and campaignType. Mutually exclusive with customTemplatedMessage.

customTemplatedMessage

string

Custom opening message template text (minimum 10 characters). Only allowed for SMS and Email channels. Mutually exclusive with openingMessageTemplateId. For SCHEDULING campaigns, must include {{meetingUrl}} and STOP.

customTemplatedSubjectLine

string

length ≤ 200

Subject line for Email campaigns using customTemplatedMessage. Required when using customTemplatedMessage with Email channel. Maximum 200 characters.

agentName

string

required

AI agent name (case-insensitive, Unicode letters only, maximum 3 words). Must be provided together with agentTone.

agentTone

string

enum

required

Tone used by the AI agent. Must be provided together with agentName.

Allowed:

externalId

string

Your unique identifier for the campaign in your external system.

calendarMeetingTemplateId

uuid

ID of the calendar meeting template. Used when closingMethod is CALENDAR_MEETING_INTEGRATION.

disableNudging

boolean

Defaults to false

When true, automatic follow-up messages (nudges) will be disabled for all conversations in this campaign. Defaults to false. Cannot be used together with a non-empty nudgeSettings array.

nudgeSettings

array of objects | null

Custom nudge timing configuration. Each entry represents one follow-up nudge with a delayHours field specifying the wait time since the previous message. The array length determines the total number of nudges. An empty array disables nudging. A non-empty array cannot be used together with disableNudging: true. When omitted, defaults to 3 nudges at 24-hour intervals. Note: for WhatsApp campaigns, nudges are only sent after the candidate replies.

nudgeSettings

Responses

200

400

401

403

404

500