Preview adding people

curl --request POST \
  --url https://api.b2bsignals.ai/api/v1/workflows/{workflow_id}/enroll/preview \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "lead_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "list_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "use_openers": true
}
'

import requests

url = "https://api.b2bsignals.ai/api/v1/workflows/{workflow_id}/enroll/preview"

payload = {
    "lead_ids": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
    "list_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "use_openers": True
}
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({
    lead_ids: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
    list_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    use_openers: true
  })
};

fetch('https://api.b2bsignals.ai/api/v1/workflows/{workflow_id}/enroll/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/workflows/{workflow_id}/enroll/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([
    'lead_ids' => [
        '3c90c3cc-0d44-4b50-8888-8dd25736052a'
    ],
    'list_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'use_openers' => true
  ]),
  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/workflows/{workflow_id}/enroll/preview"

	payload := strings.NewReader("{\n  \"lead_ids\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"list_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"use_openers\": true\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/workflows/{workflow_id}/enroll/preview")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"lead_ids\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"list_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"use_openers\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.b2bsignals.ai/api/v1/workflows/{workflow_id}/enroll/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  \"lead_ids\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"list_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"use_openers\": true\n}"

response = http.request(request)
puts response.read_body

{
  "campaign": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "status": "<string>",
    "approval_mode": "<string>"
  },
  "would_add": 123,
  "skipped_total": 123,
  "start": {
    "label": "<string>",
    "first_at": "2023-11-07T05:31:56Z",
    "per_day": 123
  },
  "skipped": [
    {
      "reason": "<string>",
      "label": "<string>",
      "why": "<string>",
      "count": 123,
      "people": [
        {
          "lead_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "person_name": "<string>"
        }
      ]
    }
  ],
  "waits": [
    {
      "reason": "<string>",
      "label": "<string>",
      "why": "<string>",
      "count": 123,
      "people": [
        {
          "lead_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "person_name": "<string>"
        }
      ]
    }
  ],
  "opener_used": 0,
  "opener_review": "every_message",
  "capped": false
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

POST

workflows

{workflow_id}

enroll

preview

Preview adding people

curl --request POST \
  --url https://api.b2bsignals.ai/api/v1/workflows/{workflow_id}/enroll/preview \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "lead_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "list_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "use_openers": true
}
'

import requests

url = "https://api.b2bsignals.ai/api/v1/workflows/{workflow_id}/enroll/preview"

payload = {
    "lead_ids": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
    "list_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "use_openers": True
}
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({
    lead_ids: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
    list_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    use_openers: true
  })
};

fetch('https://api.b2bsignals.ai/api/v1/workflows/{workflow_id}/enroll/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/workflows/{workflow_id}/enroll/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([
    'lead_ids' => [
        '3c90c3cc-0d44-4b50-8888-8dd25736052a'
    ],
    'list_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'use_openers' => true
  ]),
  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/workflows/{workflow_id}/enroll/preview"

	payload := strings.NewReader("{\n  \"lead_ids\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"list_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"use_openers\": true\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/workflows/{workflow_id}/enroll/preview")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"lead_ids\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"list_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"use_openers\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.b2bsignals.ai/api/v1/workflows/{workflow_id}/enroll/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  \"lead_ids\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"list_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"use_openers\": true\n}"

response = http.request(request)
puts response.read_body

{
  "campaign": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "status": "<string>",
    "approval_mode": "<string>"
  },
  "would_add": 123,
  "skipped_total": 123,
  "start": {
    "label": "<string>",
    "first_at": "2023-11-07T05:31:56Z",
    "per_day": 123
  },
  "skipped": [
    {
      "reason": "<string>",
      "label": "<string>",
      "why": "<string>",
      "count": 123,
      "people": [
        {
          "lead_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "person_name": "<string>"
        }
      ]
    }
  ],
  "waits": [
    {
      "reason": "<string>",
      "label": "<string>",
      "why": "<string>",
      "count": 123,
      "people": [
        {
          "lead_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "person_name": "<string>"
        }
      ]
    }
  ],
  "opener_used": 0,
  "opener_review": "every_message",
  "capped": false
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Authorizations

X-API-Key

string

header

required

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

Path Parameters

workflow_id

string<uuid>

required

Body

application/json

lead_ids

string<uuid>[] | null

Maximum array length: 500

list_id

string<uuid> | null

use_openers

boolean

default:true

Response

Success

campaign

object

required

Show child attributes

would_add

integer

required

skipped_total

integer

required

start

object

required

Show child attributes

skipped

object[]

Show child attributes

waits

object[]

Show child attributes

opener_used

integer

default:0

opener_review

string

default:every_message

capped

boolean

default:false

Build on B2B Signals

API reference

Preview adding people

Authorizations

Path Parameters

Body

Response