Add a sequence step

curl --request POST \
  --url https://api.tryfuse.ai/api/v1/business/campaigns/{campaignId}/steps \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "sequenceNumber": 25,
  "daysBetween": 45
}
'

import requests

url = "https://api.tryfuse.ai/api/v1/business/campaigns/{campaignId}/steps"

payload = {
    "sequenceNumber": 25,
    "daysBetween": 45
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({sequenceNumber: 25, daysBetween: 45})
};

fetch('https://api.tryfuse.ai/api/v1/business/campaigns/{campaignId}/steps', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "step": {
    "id": "6a8dce2ef83628aea1088041",
    "channel": "email",
    "type": "manual",
    "sequenceNumber": 1,
    "daysBetween": 2,
    "title": "probe step subject",
    "topic": null,
    "subject": "Following up on BrightPay's finance hiring",
    "body": "<p>Hi {Contact First Name}, circling back on my note last week.</p>",
    "cc": [
      "ops@yourcompany.com"
    ]
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "doc_url": "<string>",
    "request_id": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "doc_url": "<string>",
    "request_id": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "doc_url": "<string>",
    "request_id": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "doc_url": "<string>",
    "request_id": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "doc_url": "<string>",
    "request_id": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "doc_url": "<string>",
    "request_id": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "doc_url": "<string>",
    "request_id": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "doc_url": "<string>",
    "request_id": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "doc_url": "<string>",
    "request_id": "<string>"
  }
}

Campaign steps

Add a sequence step

Adds one sequence step. sequenceNumber is the step’s 0-based slot within its list - the main sequence, or the lane named by parentStepId and branchKey - and must be free (409 STEP_POSITION_TAKEN), except the slot of the list’s closing condition, which adds the step just before it; the whole campaign is then renumbered. A condition step (conditionType invite_accepted or clicked_link, daysBetween as its 1-30 day window, type: manual, no content) closes its list and splits the leads into a yes lane and a no lane; add steps to a lane by passing the condition’s id as parentStepId. An A/B split (conditionType ab_split, daysBetween 0, optional splitArms, 50/50 by default) sends each lead down arm a or arm b in the weights’ proportions, by a fixed hash of the lead and the split, so a lead keeps its arm; it may be the first step; fill an arm with branchKey a or b. Conditions and splits can only be added before the campaign starts (409 SEQUENCE_STRUCTURE_LOCKED). daysBetween is the wait after the previous step (after the campaign start for step 0). type: manual sends your subject/body as written, with tokens and spintax substituted per lead at send time; type: ai_generated writes its own topic and title with AI when the step is created and renders each message per lead (do not send topic); type: ai_reply drafts a reply from the topic you supply and parks it for approval. linkedin_visit and linkedin_like steps carry no message at all. A linkedin_connection step may not follow a linkedin_message step (422 STEP_ORDER_INVALID). Only the token owner may add steps. Rate limit: 30 requests/minute and 1,000/day per token owner, shared by every campaign, scheduled-send, campaign-template and knowledge-hub endpoint.

Errors:

404 CAMPAIGN_NOT_FOUND — No campaign with this id exists, it belongs to another account (including a campaign delegated to you or shared by your team’s visibility settings), or it has been deleted.
409 STEP_POSITION_TAKEN — A step already occupies this slot of its list, and it is not the list’s closing condition.
409 SEQUENCE_BUSY — Another change to this campaign’s steps is still being saved. Retry in a few seconds.
409 SEQUENCE_STRUCTURE_LOCKED — The campaign has started, or leads already walk it, and its sequence has a condition or would gain one: its shape can no longer change.
422 STEP_ORDER_INVALID — A linkedin_connection step would follow a linkedin_message step.
422 CONDITION_NOT_LAST_IN_LIST — The target list ends with a condition step: nothing can be placed after it, so a list holds at most one condition.
422 PARENT_STEP_NOT_A_CONDITION — parentStepId is not the id of a condition step in this campaign.
422 MULTIPLE_CONNECTIONS_ON_PATH — The lead’s path through the sequence already has a linkedin_connection step.
422 MESSAGE_ON_NO_LANE_OF_INVITE_CONDITION — A linkedin_message step was placed in the no lane of an invite_accepted condition, whose leads never connected.
422 CONDITION_ANCHOR_MISSING — The condition has nothing to check on its path: invite_accepted needs an earlier linkedin_connection step, clicked_link an earlier email step.
422 CONDITION_DUPLICATE_ON_PATH — An earlier condition on the same path already checks the same step for the same signal.
422 LANE_BRANCH_KEY_INVALID — branchKey does not name a lane of parentStepId: yes or no under a signal condition, a or b under an ab_split.
422 SPLIT_ARMS_INVALID — splitArms was sent for a step that is not an ab_split, or its arms are not a then b with weights adding up to 100.
422 AB_SPLIT_DISABLED — A/B splits are not available on this account yet.
422 MESSAGE_FIRST_IN_CLICK_LANE — A linkedin_message would open a lane of a clicked_link condition, whose leads may not be connected yet.
422 VALIDATION_FAILED — Unknown key, missing channel/sequenceNumber/daysBetween, a value out of range, a topic on an ai_generated step, a missing topic on an ai_reply step, or content on a linkedin_visit / linkedin_like step; param names the field.
429 RATE_LIMITED — More than 30 campaign requests in a minute, or 1,000 in a day, for this token owner (the bucket is shared by every /business/campaigns, /business/scheduled-sends, /business/campaign-templates and /business/knowledge-hubs call).
500 UNEXPECTED_ERROR — The step could not be stored, or AI topic generation failed for an ai_generated step.

Requires one of the following token scopes: campaigns.

POST

business

campaigns

{campaignId}

steps

Add a sequence step

curl --request POST \
  --url https://api.tryfuse.ai/api/v1/business/campaigns/{campaignId}/steps \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "sequenceNumber": 25,
  "daysBetween": 45
}
'

import requests

url = "https://api.tryfuse.ai/api/v1/business/campaigns/{campaignId}/steps"

payload = {
    "sequenceNumber": 25,
    "daysBetween": 45
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({sequenceNumber: 25, daysBetween: 45})
};

fetch('https://api.tryfuse.ai/api/v1/business/campaigns/{campaignId}/steps', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "step": {
    "id": "6a8dce2ef83628aea1088041",
    "channel": "email",
    "type": "manual",
    "sequenceNumber": 1,
    "daysBetween": 2,
    "title": "probe step subject",
    "topic": null,
    "subject": "Following up on BrightPay's finance hiring",
    "body": "<p>Hi {Contact First Name}, circling back on my note last week.</p>",
    "cc": [
      "ops@yourcompany.com"
    ]
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "doc_url": "<string>",
    "request_id": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "doc_url": "<string>",
    "request_id": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "doc_url": "<string>",
    "request_id": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "doc_url": "<string>",
    "request_id": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "doc_url": "<string>",
    "request_id": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "doc_url": "<string>",
    "request_id": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "doc_url": "<string>",
    "request_id": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "doc_url": "<string>",
    "request_id": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "doc_url": "<string>",
    "request_id": "<string>"
  }
}

Authorizations

Authorization

string

header

required

Your API token (af_…) as the Basic-auth username, with an empty password.

Path Parameters

campaignId

string

required

The campaign's id (24-character hex ObjectId), as returned by POST /business/campaigns or as the campaignId of a GET /business/campaigns row.

Body

application/json

channel

enum<string>

required

Step channel: email, linkedin_connection (connection request), linkedin_message (message to an accepted connection), linkedin_visit (profile visit, no content), linkedin_like (reaction to a recent post, no content), inmail (LinkedIn InMail, consumes InMail credits), dialer (phone-call task for a rep), todo (free-form human task) or condition (a branch point: it waits for conditionType and routes each lead down its yes or no lane; an ab_split routes each lead at once down arm a or arm b, by a fixed hash of the lead and the split, in the weights' proportions). A linkedin_connection step cannot come after a linkedin_message step (422 STEP_ORDER_INVALID).

Available options:

email,

linkedin_connection,

linkedin_message,

linkedin_visit,

linkedin_like,

inmail,

dialer,

todo,

condition

sequenceNumber

integer

required

The step's 0-based slot within its list: the main sequence, or the lane named by parentStepId and branchKey. The slot must be free (409 STEP_POSITION_TAKEN), so send the list's length to append; the one taken slot accepted is that of the list's closing condition, which adds the step just before it. A condition step is always appended to its list, and nothing can be placed after a list's closing condition (422 CONDITION_NOT_LAST_IN_LIST).

Required range: 0 <= x <= 50

daysBetween

integer

required

Whole days to wait after the previous step (or after the campaign start for the first step) before this one is due, 0-90. On a condition step it is the window instead: how many days, 1-30, the condition waits for its signal before routing the lead down the no lane. An ab_split never waits: send 0.

Required range: 0 <= x <= 90

type

enum<string>

default:manual

manual (default) sends your subject/body as written; ai_generated writes a topic and title with AI at creation and renders each message per lead at send time (send no topic; it is generated); ai_reply is an AI-drafted reply that waits for approval and needs a topic. A condition step is always manual.

Available options:

manual,

ai_generated,

ai_reply

subject

string

Subject line for a manual step (up to 500 characters, may be empty); becomes the step title. Rejected on linkedin_visit, linkedin_like and condition steps, which carry no message.

Maximum string length: 500

body

any

Message body for a manual step (up to 20000 characters; {Variable} tokens and spintax substitute at send time). On a linkedin_connection step this is the invitation note, capped at LinkedIn's 200-character limit. Rejected on linkedin_visit, linkedin_like and condition steps, which carry no message.

topic

string

Free text: what this step should say, in your own words — there is no fixed set of topics. 1-500 characters. Required for ai_reply, rejected for ai_generated (which generates its own) and for linkedin_visit / linkedin_like / condition steps. Stored but not rendered on a manual step.

Required string length: 1 - 500

string<email>[]

Accepted values: bare email addresses such as ops@example.com — a display name or angle brackets is rejected, up to 320 characters each. Every address you list is copied on every send of this step, up to 10 addresses. Only an email step actually sends them: on any other channel the value is stored and never used.

Maximum array length: 10

A bare email address, up to 320 characters.

Maximum string length: 320

parentStepId

string | null

The id of the condition step whose lane this step goes into. Omit (or null) for the main sequence. Sent together with branchKey.

branchKey

enum<string> | null

Which lane of parentStepId: yes (the condition's signal arrived in time) or no; under an ab_split, the arm a or b (422 LANE_BRANCH_KEY_INVALID otherwise). Sent together with parentStepId.

Available options:

yes,

no,

a,

b,

null

conditionType

enum<string>

Condition steps only, and required on them: invite_accepted waits for the invite of the nearest earlier linkedin_connection step on the lead's path to be accepted; clicked_link waits for a click on a link in the nearest earlier email step on the path; ab_split waits for nothing and sends each lead down arm a or arm b in the splitArms weights' proportions (a fixed hash of the lead and the split, so a lead keeps its arm), and may be the first step. Conditions can only be added before the campaign starts (409 SEQUENCE_STRUCTURE_LOCKED).

Available options:

invite_accepted,

clicked_link,

ab_split

splitArms

object[]

ab_split steps only: both arms, a then b, each { key, label?, weight }, with whole-percent weights adding up to 100. Omitted means a and b at 50 each. An arm may stay empty to hold leads out.

Show child attributes

Response

Success

step

object

required

Show child attributes

Lists

Custom columns

Smart columns

Exports

Campaigns

Campaign steps

Knowledge hubs

Analytics

Website intent

Account

Data

Prospect search

Scheduled sends

Campaign templates

Agents

Research

Company search

Saved searches

Folders

Contacts

Add a sequence step

Authorizations

Path Parameters

Body

Response