Skip to main content
POST
Resume Campaign

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

campaign_id
string<uuid>
required

Response

Successful Response

Response model for campaign.

campaign_id
string<uuid>
required

Unique campaign identifier

user_id
string<uuid>
required

Owner user ID

dataset_id
string<uuid>
required

Associated dataset ID

name
string
required

Campaign name

type
string
required

Campaign type (email, linkedin, mixed)

status
enum<string>
required

Current campaign status

Available options:
draft,
launching,
scheduled,
active,
draining,
paused,
completed,
failed
launch_type
enum<string>
required

Launch type

Available options:
immediate,
scheduled
daily_limit
integer
required

Max actions per day

sending_window_start
string<time>
required

Daily sending window start

sending_window_end
string<time>
required

Daily sending window end

min_interval_seconds
integer
required

Min seconds between actions

timezone
string
required

Timezone for sending window

steps_config
CampaignStepConfig · object[]
required

Steps configuration

send_days
string[]
required

Days of week to send

created_at
string<date-time>
required

Creation timestamp

updated_at
string<date-time>
required

Last update timestamp

description
string | null

Campaign description

start_date
string<date-time> | null

Scheduled start date

alias_ids
string[] | null

Bavimail alias IDs

connected_account_id
string<uuid> | null

Connected account for LinkedIn

total_leads
integer | null

Total leads in campaign

processed_leads
integer
default:0

Leads not in pending/active status

launch_job_id
string | null

ARQ job ID for background launch

launch_requested_at
string<date-time> | null

When launch was requested

launch_error
string | null

Error message if launch failed

system_prompt
string | null

Campaign-level personalization prompt override (migration 108).

unreviewed_launch_policy
enum<string>
default:launch_default

Policy for scheduled launch without playground review (migration 108).

Available options:
launch_default,
hold,
cancel
paused_reason
string | null

Reason the campaign is paused, e.g. 'pending_personalization_review' (migration 108).

playground_discovery_dismissed_at
string<date-time> | null

When the owner dismissed the playground discovery banner (migration 108).