Skip to main content
POST
/
api
/
lead-management
Create a lead management configuration
curl --request POST \
  --url https://your-instance.example.com/api/lead-management \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "configurationName": "Facebook Lead Ad Funnel",
  "source": "Facebook Lead Ad",
  "inboundEmail": "leads+fb@inbound.example.com",
  "initialStage": "New Lead",
  "defaultProcess": "64eea1110000000000000001",
  "isAutopilot": true,
  "starterMessage": "Hi {{firstName}}, thanks for your interest!",
  "costPerLead": 12.5,
  "status": "active",
  "forwardToOutreach": true
}
'
{
  "success": true,
  "message": "Lead management configuration created",
  "data": {
    "_id": "665f1a0c0e0a4b001a2c9f40",
    "configurationName": "Facebook Lead Ad Funnel",
    "status": "active"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.tetherai.ca/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
configurationName
string
required
​
initialStage
string
required
​
defaultProcess
string
required

Prompt ID (must exist).

​
name
string
​
description
string
​
source
string
default:Unassigned
​
inboundEmail
string<email>
​
isAutopilot
boolean
default:false
​
allowRecontact
boolean
default:false
​
starterMessage
string
​
costPerLead
number
default:0
Required range: x >= 0
​
status
enum<string>
default:active
Available options:
active,
inactive
​
pipelineId
string
​
pipelineStage
string
​
createApplication
boolean
default:false
​
applicationName
string
​
applicationStatus
string
​
applicationPipelineId
string
​
applicationPipelineStage
string
​
forwardToOutreach
boolean
default:true
​
useWorkflowOnly
boolean
default:false

Response

Configuration created

​
success
boolean
required
​
data
object
required
Example:
{
  "_id": "665f1a0c0e0a4b001a2c9f40",
  "organizationId": "64ee9a8b1e7f2a0011223344",
  "userId": "64ee9a8b1e7f2a0011223399",
  "configurationName": "Facebook Lead Ad Funnel",
  "name": "FB Lead Ad",
  "description": "Routes Facebook Lead Ad submissions through the warm-up sequence.",
  "source": "Facebook Lead Ad",
  "inboundEmail": "leads+fb@inbound.example.com",
  "initialStage": "New Lead",
  "defaultProcess": "64eea1110000000000000001",
  "isAutopilot": true,
  "allowRecontact": false,
  "starterMessage": "Hi {{firstName}}, thanks for your interest!",
  "costPerLead": 12.5,
  "status": "active",
  "pipelineId": "64eea1110000000000000010",
  "pipelineStage": "New Lead",
  "createApplication": false,
  "forwardToOutreach": true,
  "useWorkflowOnly": false,
  "createdAt": "2026-05-01T09:00:00.000Z",
  "updatedAt": "2026-05-10T15:23:00.000Z"
}
​
message
string