Set a campaign's tool

curl --request PUT \
  --url https://api.b2bsignals.ai/api/v1/workflows/{workflow_id}/integrations/{provider} \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "campaign_id": "<string>",
  "campaign_name": "<string>",
  "who": "accepted",
  "fields": [
    "<string>"
  ],
  "target_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'

import requests

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

payload = {
    "campaign_id": "<string>",
    "campaign_name": "<string>",
    "who": "accepted",
    "fields": ["<string>"],
    "target_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    campaign_id: '<string>',
    campaign_name: '<string>',
    who: 'accepted',
    fields: ['<string>'],
    target_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
  })
};

fetch('https://api.b2bsignals.ai/api/v1/workflows/{workflow_id}/integrations/{provider}', 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}/integrations/{provider}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'campaign_id' => '<string>',
    'campaign_name' => '<string>',
    'who' => 'accepted',
    'fields' => [
        '<string>'
    ],
    'target_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
  ]),
  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}/integrations/{provider}"

	payload := strings.NewReader("{\n  \"campaign_id\": \"<string>\",\n  \"campaign_name\": \"<string>\",\n  \"who\": \"accepted\",\n  \"fields\": [\n    \"<string>\"\n  ],\n  \"target_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")

	req, _ := http.NewRequest("PUT", 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.put("https://api.b2bsignals.ai/api/v1/workflows/{workflow_id}/integrations/{provider}")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"campaign_id\": \"<string>\",\n  \"campaign_name\": \"<string>\",\n  \"who\": \"accepted\",\n  \"fields\": [\n    \"<string>\"\n  ],\n  \"target_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Put.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"campaign_id\": \"<string>\",\n  \"campaign_name\": \"<string>\",\n  \"who\": \"accepted\",\n  \"fields\": [\n    \"<string>\"\n  ],\n  \"target_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}"

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

{
  "workflow_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "provider": "<string>",
  "source": "campaign",
  "campaign_id": "<string>",
  "campaign_name": "<string>",
  "who": "accepted",
  "fields": [
    "<string>"
  ],
  "target_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "target_label": "<string>",
  "workspace_default": {
    "connected": false,
    "campaign_id": "<string>",
    "auto_send": false
  },
  "stops_local_run": false,
  "warnings": [
    "<string>"
  ]
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

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

PUT

workflows

{workflow_id}

integrations

{provider}

Set a campaign's tool

curl --request PUT \
  --url https://api.b2bsignals.ai/api/v1/workflows/{workflow_id}/integrations/{provider} \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "campaign_id": "<string>",
  "campaign_name": "<string>",
  "who": "accepted",
  "fields": [
    "<string>"
  ],
  "target_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'

import requests

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

payload = {
    "campaign_id": "<string>",
    "campaign_name": "<string>",
    "who": "accepted",
    "fields": ["<string>"],
    "target_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    campaign_id: '<string>',
    campaign_name: '<string>',
    who: 'accepted',
    fields: ['<string>'],
    target_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
  })
};

fetch('https://api.b2bsignals.ai/api/v1/workflows/{workflow_id}/integrations/{provider}', 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}/integrations/{provider}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'campaign_id' => '<string>',
    'campaign_name' => '<string>',
    'who' => 'accepted',
    'fields' => [
        '<string>'
    ],
    'target_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
  ]),
  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}/integrations/{provider}"

	payload := strings.NewReader("{\n  \"campaign_id\": \"<string>\",\n  \"campaign_name\": \"<string>\",\n  \"who\": \"accepted\",\n  \"fields\": [\n    \"<string>\"\n  ],\n  \"target_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")

	req, _ := http.NewRequest("PUT", 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.put("https://api.b2bsignals.ai/api/v1/workflows/{workflow_id}/integrations/{provider}")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"campaign_id\": \"<string>\",\n  \"campaign_name\": \"<string>\",\n  \"who\": \"accepted\",\n  \"fields\": [\n    \"<string>\"\n  ],\n  \"target_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Put.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"campaign_id\": \"<string>\",\n  \"campaign_name\": \"<string>\",\n  \"who\": \"accepted\",\n  \"fields\": [\n    \"<string>\"\n  ],\n  \"target_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}"

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

{
  "workflow_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "provider": "<string>",
  "source": "campaign",
  "campaign_id": "<string>",
  "campaign_name": "<string>",
  "who": "accepted",
  "fields": [
    "<string>"
  ],
  "target_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "target_label": "<string>",
  "workspace_default": {
    "connected": false,
    "campaign_id": "<string>",
    "auto_send": false
  },
  "stops_local_run": false,
  "warnings": [
    "<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

provider

string

required

Body

application/json

campaign_id

string

required

Required string length: 1 - 64

campaign_name

string | null

Maximum string length: 200

who

enum<string>

default:accepted

Available options:

accepted,

enrolled

fields

string[] | null

Maximum array length: 50

target_id

string<uuid> | null

Response

Success

workflow_id

string<uuid>

required

provider

string

required

source

enum<string>

required

Available options:

campaign,

workspace

campaign_id

string | null

campaign_name

string | null

who

enum<string> | null

Available options:

accepted,

enrolled

fields

string[] | null

target_id

string<uuid> | null

target_label

string | null

workspace_default

object

Show child attributes

stops_local_run

boolean

default:false

warnings

string[]

Build on B2B Signals

API reference

Set a campaign's tool

Authorizations

Path Parameters

Body

Response