Skip to main content
POST
Ingest Live Lead or Scheduled Appointment

Authorizations

x-source-token
string
header
required

Partner source token provided by 3i CRM client.

Headers

Idempotency-Key
string

Unique delivery identifier (e.g. UUID). Prevents duplicate lead records on network retries within 24 hours.

Example:

"vend_lead_9948201_retry_1"

Body

application/json
name
string

Full contact name. Alternatively, provide first_name and last_name.

Example:

"Marcus Vance"

first_name
string

Contact first name.

Example:

"Marcus"

last_name
string

Contact last name.

Example:

"Vance"

phone
string

Primary phone number. Automatically normalized to 10-digit clean format.

Example:

"5125550188"

email
string<email>

Primary email address.

Example:

"m.vance@example.com"

address
string

Street address.

Example:

"1204 Pecan Grove Rd"

city
string

City name.

Example:

"Austin"

state
string

2-letter state code or full state name. Used to automatically detect timezone.

Example:

"TX"

zipcode
string

5-digit postal code.

Example:

"78704"

county
string

County or parish name.

Example:

"Travis"

age
integer

Age of the contact in years.

Required range: 18 <= x <= 120
Example:

63

date_of_birth
string

Date of birth (YYYY-MM-DD or MM/DD/YYYY).

Example:

"1963-04-12"

gender
enum<string>

Contact gender. Normalized automatically to Male or Female.

Available options:
Male,
Female
Example:

"Male"

status
string

Set to Scheduled if the lead has an appointment booked.

Example:

"Scheduled"

scheduled_at
string<date-time>

Canonical UTC ISO-8601 appointment timestamp.

Example:

"2026-09-28T18:00:00.000Z"

appointment_date
string

Split appointment date if UTC ISO is not provided.

Example:

"2026-09-28"

appointment_time
string

Split appointment local time.

Example:

"02:00 PM"

appointment_timezone
string

(Optional) IANA timezone. If omitted, automatically inferred from state or phone area code.

Example:

"America/New_York"

schedule_type
enum<string>
default:appointment

Type of schedule.

Available options:
appointment,
follow_up
Example:

"appointment"

setter_dialer_name
string

Name or ID of the human setter, dialer agent, or scheduling channel.

Example:

"Alexander Hayes (Setter Team Alpha)"

scheduled_call
string

(Optional) Human-readable local date and time string.

Example:

"09/28/2026 02:00 PM EDT"

tags
string[]

Array of tags to attach to the lead.

Example:
notes
string

Appointment notes, qualifying verification details, and briefing text.

Example:

"APPOINTMENT CONFIRMED: 09/28/2026 at 2:00 PM EDT. Setter Alexander verified spouse will be present."

coverage_type
string

Requested insurance policy type.

Example:

"Mortgage Protection"

coverage_amount
string

Requested coverage amount.

Example:

"150000"

current_coverage
string

Existing insurance coverage details.

Example:

"None"

monthly_budget
string

Target monthly budget.

Example:

"$120"

annual_income
string

Household yearly income.

Example:

"$48,000"

occupation
string

Job title or retirement status.

Example:

"Retired Postal Worker"

housing_type
enum<string>

Residence status.

Available options:
Own,
Rent,
Other
Example:

"Own"

mortgage_type
enum<string>

Mortgage loan category.

Available options:
Conventional,
FHA,
VA,
Fixed,
ARM,
USDA,
Jumbo,
Reverse
Example:

"Conventional"

mortgage_length_remaining
string

Remaining term on loan.

Example:

"24 years"

monthly_payment
string

Monthly mortgage payment.

Example:

"$1,450"

smoker
boolean

Tobacco usage flag.

Example:

false

health_conditions
string

High-level health condition summary.

Example:

"Clean, non-smoker, no medications"

health_conditions_detail
string

Specific prescriptions, hospitalizations, or surgery dates.

Example:

"Lisinopril 10mg daily. No hospitalizations."

language
string

Primary language preference.

Example:

"English"

branch_of_service
string

Military branch (for veteran/military campaigns).

Example:

"Army"

military_status
string

(Optional) Military service status (e.g. Disabled Veteran, Active Duty, Spouse / Family Member). For general veteran leads, lead_category and branch_of_service are sufficient.

Example:

"Disabled Veteran"

lead_category
enum<string>

Primary campaign vertical/category. Common abbreviations and synonyms (e.g. fex, vets, military) are mapped automatically.

Available options:
veterans,
final-expense,
mortgage-protection,
nurses,
truckers,
iul,
first-responder,
federal-employee,
senior,
teacher,
generic
Example:

"veterans"

beneficiary
string

Primary beneficiary name.

Example:

"Eleanor Vance"

beneficiary_relationship
string

Relationship of beneficiary.

Example:

"Spouse"

beneficiary_count
string

Number of designated beneficiaries.

Example:

"1"

dependents
string

Number or details of dependent children.

Example:

"2 children"

trusted_form_cert_url
string<uri>

ActiveProspect TrustedForm certificate URL for TCPA verification.

Example:

"https://cert.trustedform.com/0123456789abcdef0123456789abcdef01234567"

ip_address
string

Client IP address at time of submission.

Example:

"172.56.21.89"

Explicit consent flag for SMS messaging.

Example:

true

fbclid
string

Facebook Click ID from ad URL.

Example:

"IwAR3_xV92K..."

fbc
string

First-party Facebook click cookie from browser session.

Example:

"fb.1.1789918126987.IwAR3_xV92K"

fbp
string

First-party Facebook browser tracking cookie.

Example:

"fb.1.1789676905645.579676956563071832"

user_agent
string

Client browser User-Agent string.

Example:

"Mozilla/5.0 (iPhone; CPU iPhone OS 26_6_2 like Mac OS X)..."

leadgen_id
string

Meta Lead Ads native instant form submission ID.

Example:

"491028401928401"

ad_id
string

Facebook Ad ID from campaign URL.

Example:

"12020581920"

utm_source
string

Marketing traffic source.

Example:

"meta_ads"

utm_medium
string

Marketing medium.

Example:

"paid_social"

utm_campaign
string

Marketing campaign name.

Example:

"tx_veterans_fe_q3"

utm_content
string

Ad creative or variant.

Example:

"c-vets-video-1"

utm_term
string

Target keyword or audience.

Example:

"veterans life insurance"

listen
boolean
default:false

Set to true to execute a pre-flight test without writing live leads to the CRM.

idempotency_key
string

Alternative to sending the Idempotency-Key HTTP header.

Example:

"vend_lead_9948201_retry_1"

custom_fields
object

Partner-specific metadata, meeting links, or call recordings. Automatically captured in CRM.

Example:

Response

Lead or appointment successfully ingested or resubmitted.

success
boolean
required
Example:

true

message
string
required
Example:

"Lead created and appointment scheduled successfully"

listen
boolean

Returned and true when request was executed in Listen test mode.

Example:

false

lead_id
string<uuid>

The CRM's primary UUID for the lead. Store this in your database to link records.

Example:

"b3040da5-9bd1-4a4b-8fd3-40e94bb5083f"

agent_id
string<uuid>

UUID of the agent receiving the lead.

Example:

"5170d1fa-fa77-4c7b-b5d1-93c6838a6a12"

status
string
Example:

"Scheduled"

scheduled_at
string<date-time>

Confirmed UTC ISO appointment timestamp.

Example:

"2026-09-28T18:00:00.000Z"

appointment_timezone
string

Confirmed timezone.

Example:

"America/New_York"

schedule_type
string
Example:

"appointment"

resubmit
boolean

Present and true when an existing lead was re-engaged and merged.

Example:

false

idempotent_replay
boolean

Present and true when a cached delivery was safely replayed within 24 hours.

Example:

false