LeadReach AI - POST Start a batch outreach run Docs

POST/v1/campaigns/:id/outreach-runs

Start a batch outreach run

Starts email/call outreach for a campaign. :id is the campaign id (often paired 1:1 with an agent).

Full URL

POST https://api.tryleadreach.com/v1/campaigns/:id/outreach-runs

Headers

X-Api-Key (required): your API key from the app Keys tab.
Content-Type: application/json (required)

Path params (in the URL)

Name	Type	Required	Meaning
id	uuid	Yes	Campaign id.

Query params (after ?)

None

Request body (JSON)

Field	Type	Required	Meaning
targetCount	number	No	How many leads to process.
channels	object	No	e.g. { email: true, call: true }.

Example request (JSON)

What you send: headers, and path / query / body when used.

{
  "headers": {
    "X-Api-Key": "lr_your_key_here",
    "Content-Type": "application/json"
  },
  "path": {
    "id": "c1111111-1111-1111-1111-111111111111"
  },
  "body": {
    "targetCount": 10,
    "channels": {
      "email": true,
      "call": true
    }
  }
}

Example response (JSON)

Typical successful response shape.

{
  "ok": true,
  "run": {
    "id": "r1111111-1111-1111-1111-111111111111",
    "campaignId": "c1111111-1111-1111-1111-111111111111",
    "status": "running"
  }
}

Response

201 with the created outreach run, or 400 on bad state.

Credits

per lead