Preview a move from HeyReach
curl --request POST \
--url https://api.b2bsignals.ai/api/v1/integrations/heyreach/campaigns/{campaign_id}/move-preview \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"sender_map": {},
"confirm_unplaced": false,
"approval_mode": "step",
"name": "<string>"
}
'import requests
url = "https://api.b2bsignals.ai/api/v1/integrations/heyreach/campaigns/{campaign_id}/move-preview"
payload = {
"sender_map": {},
"confirm_unplaced": False,
"approval_mode": "step",
"name": "<string>"
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
sender_map: {},
confirm_unplaced: false,
approval_mode: 'step',
name: '<string>'
})
};
fetch('https://api.b2bsignals.ai/api/v1/integrations/heyreach/campaigns/{campaign_id}/move-preview', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.b2bsignals.ai/api/v1/integrations/heyreach/campaigns/{campaign_id}/move-preview",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'sender_map' => [
],
'confirm_unplaced' => false,
'approval_mode' => 'step',
'name' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.b2bsignals.ai/api/v1/integrations/heyreach/campaigns/{campaign_id}/move-preview"
payload := strings.NewReader("{\n \"sender_map\": {},\n \"confirm_unplaced\": false,\n \"approval_mode\": \"step\",\n \"name\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.b2bsignals.ai/api/v1/integrations/heyreach/campaigns/{campaign_id}/move-preview")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"sender_map\": {},\n \"confirm_unplaced\": false,\n \"approval_mode\": \"step\",\n \"name\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.b2bsignals.ai/api/v1/integrations/heyreach/campaigns/{campaign_id}/move-preview")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"sender_map\": {},\n \"confirm_unplaced\": false,\n \"approval_mode\": \"step\",\n \"name\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"campaign_id": "<string>",
"campaign_name": "<string>",
"campaign_status": "<string>",
"people_total": 123,
"people_continue": 123,
"already_replied": 123,
"finished": 123,
"do_not_contact": 123,
"left_out_no_person": 123,
"unknown_position": 0,
"already_in_other_campaign": 0,
"failed": 0,
"senders": [
{
"heyreach_name": "<string>",
"heyreach_sender_id": "<string>",
"people": 0,
"matched_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"match_by": "none"
}
],
"steps": [
{
"type": "<string>",
"delay": "<string>",
"text": "<string>",
"variants": 0
}
],
"unsupported_steps": [
{
"type": "<string>",
"reason": "<string>",
"delay": "<string>"
}
],
"custom_variables": [
"<string>"
],
"warnings": [
"<string>"
],
"blockers": [
"<string>"
],
"can_move": false,
"already_moved_workflow_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"unfinished_move_workflow_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Integrations
Preview a move from HeyReach
What moving this campaign would do. Nothing is written, here or in HeyReach. The move itself needs a signed-in person, in the app.
POST
/
integrations
/
heyreach
/
campaigns
/
{campaign_id}
/
move-preview
Preview a move from HeyReach
curl --request POST \
--url https://api.b2bsignals.ai/api/v1/integrations/heyreach/campaigns/{campaign_id}/move-preview \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"sender_map": {},
"confirm_unplaced": false,
"approval_mode": "step",
"name": "<string>"
}
'import requests
url = "https://api.b2bsignals.ai/api/v1/integrations/heyreach/campaigns/{campaign_id}/move-preview"
payload = {
"sender_map": {},
"confirm_unplaced": False,
"approval_mode": "step",
"name": "<string>"
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
sender_map: {},
confirm_unplaced: false,
approval_mode: 'step',
name: '<string>'
})
};
fetch('https://api.b2bsignals.ai/api/v1/integrations/heyreach/campaigns/{campaign_id}/move-preview', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.b2bsignals.ai/api/v1/integrations/heyreach/campaigns/{campaign_id}/move-preview",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'sender_map' => [
],
'confirm_unplaced' => false,
'approval_mode' => 'step',
'name' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.b2bsignals.ai/api/v1/integrations/heyreach/campaigns/{campaign_id}/move-preview"
payload := strings.NewReader("{\n \"sender_map\": {},\n \"confirm_unplaced\": false,\n \"approval_mode\": \"step\",\n \"name\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.b2bsignals.ai/api/v1/integrations/heyreach/campaigns/{campaign_id}/move-preview")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"sender_map\": {},\n \"confirm_unplaced\": false,\n \"approval_mode\": \"step\",\n \"name\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.b2bsignals.ai/api/v1/integrations/heyreach/campaigns/{campaign_id}/move-preview")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"sender_map\": {},\n \"confirm_unplaced\": false,\n \"approval_mode\": \"step\",\n \"name\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"campaign_id": "<string>",
"campaign_name": "<string>",
"campaign_status": "<string>",
"people_total": 123,
"people_continue": 123,
"already_replied": 123,
"finished": 123,
"do_not_contact": 123,
"left_out_no_person": 123,
"unknown_position": 0,
"already_in_other_campaign": 0,
"failed": 0,
"senders": [
{
"heyreach_name": "<string>",
"heyreach_sender_id": "<string>",
"people": 0,
"matched_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"match_by": "none"
}
],
"steps": [
{
"type": "<string>",
"delay": "<string>",
"text": "<string>",
"variants": 0
}
],
"unsupported_steps": [
{
"type": "<string>",
"reason": "<string>",
"delay": "<string>"
}
],
"custom_variables": [
"<string>"
],
"warnings": [
"<string>"
],
"blockers": [
"<string>"
],
"can_move": false,
"already_moved_workflow_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"unfinished_move_workflow_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Authorizations
Your workspace's API key. It starts with b2b_sk_.
Path Parameters
Body
application/json
Response
Success
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes