Plan a campaign - Revcenter API

POST

/

api

/

campaigns

/

plan

Plan a campaign

curl --request POST \
  --url https://api.revcenter.ai/api/campaigns/plan \
  --header 'Content-Type: application/json' \
  --cookie session= \
  --data '
{
  "prompt": "Four-touch LinkedIn sequence for the Lévis clinic managers, warm and short, two days apart.",
  "scanIds": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ]
}
'

const options = {
  method: 'POST',
  headers: {cookie: 'session=', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    prompt: 'Four-touch LinkedIn sequence for the Lévis clinic managers, warm and short, two days apart.',
    scanIds: ['3c90c3cc-0d44-4b50-8888-8dd25736052a']
  })
};

fetch('https://api.revcenter.ai/api/campaigns/plan', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.revcenter.ai/api/campaigns/plan"

payload = {
    "prompt": "Four-touch LinkedIn sequence for the Lévis clinic managers, warm and short, two days apart.",
    "scanIds": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"]
}
headers = {
    "cookie": "session=",
    "Content-Type": "application/json"
}

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

print(response.text)

{
  "spec": {
    "platform": "smartlead",
    "name": "<string>",
    "steps": [
      {
        "subject": "<string>",
        "body": "<string>",
        "delayDays": 123
      }
    ]
  },
  "totalLeads": 123,
  "eligibleLeads": 123,
  "withEmail": 123,
  "withLinkedIn": 123,
  "issues": [
    "<string>"
  ]
}

Authorizations

session

string

cookie

required

A signed-in workspace session, sent as a browser cookie. Requests must include credentials, and act on the session's active workspace.

Body

application/json

prompt

string

required

What the campaign should do, in plain language.

Example:

"Four-touch LinkedIn sequence for the Lévis clinic managers, warm and short, two days apart."

scanIds

string<uuid>[]

required

The searches to draw leads from. Searches outside your workspace are ignored.

Minimum array length: 1

model

enum<string>

Which model extracts criteria. Anything outside this allowlist is rejected. Omit to use the workspace default.

Available options:

claude-haiku-4-5,

claude-sonnet-5,

claude-opus-5

Response

The proposed spec and its eligibility preview.

spec

object

The reviewable campaign plan. Produced by the plan endpoint, sent back verbatim to publish.

Show child attributes

totalLeads

integer

Unique leads across the selected searches.

eligibleLeads

integer

Leads reachable on the chosen platform — with an email for Smartlead, a LinkedIn URL for HeyReach.

withEmail

integer

withLinkedIn

integer

issues

string[]

Blocking setup problems, in plain language. Empty means the campaign is publishable.

Plan a campaign

curl --request POST \
  --url https://api.revcenter.ai/api/campaigns/plan \
  --header 'Content-Type: application/json' \
  --cookie session= \
  --data '
{
  "prompt": "Four-touch LinkedIn sequence for the Lévis clinic managers, warm and short, two days apart.",
  "scanIds": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ]
}
'

const options = {
  method: 'POST',
  headers: {cookie: 'session=', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    prompt: 'Four-touch LinkedIn sequence for the Lévis clinic managers, warm and short, two days apart.',
    scanIds: ['3c90c3cc-0d44-4b50-8888-8dd25736052a']
  })
};

fetch('https://api.revcenter.ai/api/campaigns/plan', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.revcenter.ai/api/campaigns/plan"

payload = {
    "prompt": "Four-touch LinkedIn sequence for the Lévis clinic managers, warm and short, two days apart.",
    "scanIds": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"]
}
headers = {
    "cookie": "session=",
    "Content-Type": "application/json"
}

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

print(response.text)

{
  "spec": {
    "platform": "smartlead",
    "name": "<string>",
    "steps": [
      {
        "subject": "<string>",
        "body": "<string>",
        "delayDays": 123
      }
    ]
  },
  "totalLeads": 123,
  "eligibleLeads": 123,
  "withEmail": 123,
  "withLinkedIn": 123,
  "issues": [
    "<string>"
  ]
}