Start or resume a campaign

Starts a campaign, or resumes a paused one. Messages can go out after this, following the campaign’s approval settings. Answers 403 when the campaign uses a loose approval setting, such as approving a whole sequence at once, First message only, or an auto-approve timer: a signed-in person has to start those.

POST /workflows/{workflow_id}/activate

Start or resume a campaign

cURL

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

200

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "status": "<string>",
  "graph": {},
  "version": 123,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "daily_intake_cap": 123,
  "auto_join": "<string>",
  "one_per_company": true,
  "pause_reason": "<string>",
  "pause_info": {},
  "default_connected_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "autopilot": false,
  "approval_mode": "step",
  "send_mode": "auto",
  "auto_reply_mode": "off",
  "sender_account_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "schedule": {},
  "exclusions": {},
  "runs_count": 123,
  "connections_sent": 123,
  "not_started": 123,
  "in_progress": 123,
  "finished": 123,
  "failed": 123,
  "stopped": 123,
  "accept_rate": 123,
  "reply_rate": 123,
  "people_written_to": 123,
  "has_sent": true,
  "campaign_type": "<string>",
  "people_from": "<string>",
  "pattern_summary": "<string>",
  "sender": {
    "account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "display_name": "<string>"
  },
  "senders": [
    {
      "account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "display_name": "<string>"
    }
  ],
  "activation_summary": {},
  "phase": "<string>",
  "phase_detail": "<string>",
  "finished_at": "2023-11-07T05:31:56Z",
  "replied_count": 123,
  "needs_you": {
    "to_approve": 0,
    "to_approve_blocked": 0,
    "to_send_by_hand": 0,
    "invites_waiting": 0,
    "replies": 0,
    "failed": 0,
    "sender_problem": {
      "account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "state": "<string>",
      "display_name": "<string>"
    },
    "primary": "<string>"
  }
}

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

200

application/json

Success

id · string<uuid> · required

name · string · required

status · string · required

graph · object · required

version · integer · required

created_at · string<date-time> · required

updated_at · string<date-time> · required

daily_intake_cap · integer | null · required

auto_join · string · required · read-only

one_per_company · boolean · required · read-only

pause_reason · string | null · required

pause_info · object | null · required

default_connected_account_id · string<uuid> | null

autopilot · boolean · default: false

approval_mode · string · default: step

send_mode · string · default: auto

auto_reply_mode · string · default: off

sender_account_ids · string<uuid>[] | null

schedule · object | null

exclusions · object | null

runs_count · integer | null

connections_sent · integer | null

not_started · integer | null

in_progress · integer | null

finished · integer | null

failed · integer | null

stopped · integer | null

accept_rate · number | null

reply_rate · number | null

people_written_to · integer | null

has_sent · boolean | null

campaign_type · string | null

people_from · string | null

pattern_summary · string | null

sender · object | null

Show child attributes

senders · object[] | null

Show child attributes

activation_summary · object | null

phase · string | null

phase_detail · string | null

finished_at · string<date-time> | null

replied_count · integer | null

needs_you · object | null

Show child attributes