Skip to main content
PUT
/
api
/
lead-management
/
{id}
Update a lead management configuration
curl --request PUT \
  --url https://your-instance.example.com/api/lead-management/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "isAutopilot": false,
  "costPerLead": 15,
  "status": "inactive"
}
'
{
  "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.

Path Parameters

​
id
string
required

Body

application/json
​
configurationName
string

Internal identifier for the Lead Management config.

​
name
string

Human-friendly display name surfaced in the UI.

​
description
string

Free-form notes describing this lead routing setup.

​
source
string

Lead source label attached to contacts matched by this config (e.g. Facebook Lead Ad).

​
inboundEmail
string<email>

Inbox address that ingests external emails for this configuration.

​
initialStage
string

Pipeline stage _id new leads enter when matched.

​
defaultProcess
string

Prompt _id used to drive the AI on matched leads.

​
isAutopilot
boolean

When true, the AI runs autonomously without rep approval on new leads.

​
allowRecontact
boolean

When true, allow re-contacting leads already in the system.

​
starterMessage
string

First outbound message sent on lead match; supports placeholders.

​
costPerLead
number

Cost (USD) attributed to each lead; powers the outreach metrics dashboard.

Required range: x >= 0
​
status
enum<string>

Whether this config is currently routing leads.

Available options:
active,
inactive
​
pipelineId
string

Pipeline _id matched contacts are placed into.

​
pipelineStage
string

Pipeline stage matched contacts are placed into.

​
createApplication
boolean

When true, also creates an Application alongside the contact.

​
applicationName
string

Display name for the auto-created application.

​
applicationStatus
string

Initial status for the auto-created application.

​
applicationPipelineId
string

Pipeline _id the auto-created application is placed into.

​
applicationPipelineStage
string

Pipeline stage the auto-created application enters.

​
forwardToOutreach
boolean

When true, forwards leads to the outreach trigger pipeline.

​
useWorkflowOnly
boolean

When true, only execute matching workflows; skip the legacy autopilot path.

Response

Configuration updated

​
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