Skip to main content
POST
Preview a move from HeyReach

Authorizations

X-API-Key
string
header
required

Your workspace's API key. It starts with b2b_sk_.

Path Parameters

campaign_id
string
required

Body

application/json
sender_map
object
confirm_unplaced
boolean
default:false
approval_mode
enum<string>
default:step
Available options:
step,
sequence
name
string | null
Maximum string length: 200

Response

Success

campaign_id
string
required
campaign_name
string
required
campaign_status
string
required
people_total
integer
required
people_continue
integer
required
already_replied
integer
required
finished
integer
required
do_not_contact
integer
required
left_out_no_person
integer
required
unknown_position
integer
default:0
already_in_other_campaign
integer
default:0
failed
integer
default:0
senders
object[]
steps
object[]
unsupported_steps
object[]
custom_variables
string[]
warnings
string[]
blockers
string[]
can_move
boolean
default:false
already_moved_workflow_id
string<uuid> | null
unfinished_move_workflow_id
string<uuid> | null