Skip to main content
POST
Create Campaign

Authorizations

X-API-Key
string
header
required

API Key for authentication

Body

application/json
ownerId
string<uuid>
required

User ID of the campaign owner. Creating for anyone other than the caller requires the workspace permission to create campaigns for another owner (ADMIN/MANAGER). When creating for a non-managed owner, the acting user is also added as an explicit grantee.

name
string
required

Display name for the campaign.

Minimum string length: 1
type
enum<string>
required

TARGET_USER = Prospects campaign; KEYWORD = Topic campaign. Creating a Topic campaign requires CAN_USE_TOPIC_CAMPAIGNS.

Available options:
TARGET_USER,
KEYWORD
voiceId
string<uuid>
required

Voice ID owned by ownerId. A foreign or missing Voice is rejected.

skipTeammatesLeads
boolean
required

If true, skip prospects that are already in teammates' campaigns in the same team — avoids double outreach to the same person. Applies to TARGET_USER (Prospects) campaigns only (recommended true there); for KEYWORD (Topic) campaigns it does not apply — leave it false.

commenting
object

Optional. Whole comment policy of the campaign. commenting is replaced as a whole, never deep-merged: omit it to leave the stored policy untouched, or state the complete policy you want. A scalar omitted inside a group that IS stated therefore means off/none, not “keep the stored value”. A TARGET_USER (Prospects) campaign states strategy, postFilters, frequency and feedCleanup, and may state indirectCommentingEnabled and publishingPace; a KEYWORD (Topic) campaign states strategy and postFilters only — every other member is People-only and must be omitted. Omit it to start from the campaign type's defaults.

outreach
object

Optional private-outreach settings: the warmUp comment prerequisite, the independent connectionRequests switch, and the directMessages settings. All three subtrees are required when this object is passed; omit the whole object to keep the campaign defaults. Applies to TARGET_USER (Prospects) campaigns only — omit it for KEYWORD (Topic) campaigns.

Response

status
string
required

Response status

Allowed value: "success"
data
object
required
message
string
required

Success message

Example:

"Operation completed successfully"