Check if a campaign can start

curl --request GET \
  --url https://api.b2bsignals.ai/api/v1/workflows/{workflow_id}/readiness \
  --header 'X-API-Key: <api-key>'

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api.b2bsignals.ai/api/v1/workflows/{workflow_id}/readiness', 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}/readiness",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "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"
	"net/http"
	"io"
)

func main() {

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

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.b2bsignals.ai/api/v1/workflows/{workflow_id}/readiness")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'

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

{
  "leads": {
    "source": "<string>",
    "list_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "list_name": "<string>",
    "count": 123
  },
  "sender_connected": true,
  "errors": [
    {
      "message": "<string>",
      "node_id": "<string>"
    }
  ],
  "sender_names": [
    "<string>"
  ],
  "fallback_sender_name": "<string>",
  "notices": [
    "<string>"
  ]
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

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

GET

workflows

{workflow_id}

readiness

Check if a campaign can start

curl --request GET \
  --url https://api.b2bsignals.ai/api/v1/workflows/{workflow_id}/readiness \
  --header 'X-API-Key: <api-key>'

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api.b2bsignals.ai/api/v1/workflows/{workflow_id}/readiness', 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}/readiness",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "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"
	"net/http"
	"io"
)

func main() {

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

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.b2bsignals.ai/api/v1/workflows/{workflow_id}/readiness")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'

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

{
  "leads": {
    "source": "<string>",
    "list_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "list_name": "<string>",
    "count": 123
  },
  "sender_connected": true,
  "errors": [
    {
      "message": "<string>",
      "node_id": "<string>"
    }
  ],
  "sender_names": [
    "<string>"
  ],
  "fallback_sender_name": "<string>",
  "notices": [
    "<string>"
  ]
}

{
  "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

Response

Success

leads

object

required

Show child attributes

sender_connected

boolean

required

errors

object[]

Show child attributes

sender_names

string[]

fallback_sender_name

string | null

notices

string[]

Build on B2B Signals

API reference

Check if a campaign can start

Authorizations

Path Parameters

Response