Skip to content
UltimateTeam.ai Docs

Capture ROI calculator lead

POST
/api/v1/sales/roi/leads
curl --request POST \
  --url https://api.ultimateteam.ai/api/v1/sales/roi/leads \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <X-API-Key>' \
  --data '{ "company_name": "", "email": "example", "roi_input": { "current_tool_spend": 0, "employee_count": 1, "hours_finance": 5, "hours_marketing": 10, "hours_operations": 8, "industry": "general", "monthly_revenue": 1 }, "roi_projection": { "annual_cost_savings": 1, "annual_revenue_increase": 1, "annual_time_savings_hours": 1, "monthly_cost_savings": 1, "monthly_revenue_increase": 1, "monthly_time_savings_hours": 1, "monthly_time_value": 0, "monthly_tool_savings": 0, "payback_months": 1, "recommended_plan": "example", "recommended_plan_price": 1, "roi_multiple": 1 } }'

Capture a prospect’s email and ROI calculation results, email the ROI report to the prospect, and notify sales. report_delivered is true only when the email provider confirmed acceptance. Public endpoint.

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
LeadCaptureRequest

Lead capture form submission from ROI calculator.

Attributes: email: Prospect email address. company_name: Optional company name. roi_input: The ROI calculation inputs used. roi_projection: The ROI projection results shown.

object
company_name
Company Name

Optional company name

string
""
email
required
Email

Prospect email address

string
roi_input
required
ROIInput

Business metrics input for ROI calculation.

Attributes: monthly_revenue: Current monthly revenue in USD. employee_count: Number of employees. hours_marketing: Weekly hours spent on marketing/sales. hours_finance: Weekly hours spent on finance/accounting. hours_operations: Weekly hours spent on operations/admin. current_tool_spend: Monthly spend on existing SaaS tools in USD. industry: Business industry vertical for benchmark selection.

object
current_tool_spend
Current Tool Spend

Monthly spend on existing SaaS tools in USD

number
0
employee_count
required
Employee Count

Number of employees

integer
> 0
hours_finance
Hours Finance

Weekly hours spent on finance/accounting

number
default: 5
hours_marketing
Hours Marketing

Weekly hours spent on marketing/sales activities

number
default: 10
hours_operations
Hours Operations

Weekly hours spent on operations/admin

number
default: 8
industry
Industry

Business industry vertical (e-commerce, professional_services, saas, restaurant, contractor, general)

string
default: general
monthly_revenue
required
Monthly Revenue

Current monthly revenue in USD

number
> 0
roi_projection
required
ROIProjection

Projected ROI results from UltimateTeam deployment.

Attributes: monthly_revenue_increase: Projected additional monthly revenue in USD. monthly_tool_savings: Cash reduction in existing tool spend in USD (the only component that nets against tool costs). monthly_time_value: Monetized value of hours saved in USD (labor value, never a cash reduction in tool spend). monthly_cost_savings: monthly_tool_savings + monthly_time_value. monthly_time_savings_hours: Projected monthly hours saved. annual_revenue_increase: Projected additional annual revenue in USD. annual_cost_savings: Projected annual cost savings in USD. annual_time_savings_hours: Projected annual hours saved. roi_multiple: Return on investment multiple (annual value / annual cost). payback_months: Months until ROI breaks even. recommended_plan: Suggested pricing plan based on business size. recommended_plan_price: Monthly price of recommended plan in USD.

object
annual_cost_savings
required
Annual Cost Savings
number
annual_revenue_increase
required
Annual Revenue Increase
number
annual_time_savings_hours
required
Annual Time Savings Hours
number
monthly_cost_savings
required
Monthly Cost Savings
number
monthly_revenue_increase
required
Monthly Revenue Increase
number
monthly_time_savings_hours
required
Monthly Time Savings Hours
number
monthly_time_value
Monthly Time Value
number
0
monthly_tool_savings
Monthly Tool Savings
number
0
payback_months
required
Payback Months
number
recommended_plan
required
Recommended Plan
string
recommended_plan_price
required
Recommended Plan Price
number
roi_multiple
required
Roi Multiple
number

Responses

Section titled “ Responses ”

201

Section titled “201”

Successful Response

Media typeapplication/json
LeadCaptureResponse

Response after successful lead capture.

Attributes: success: Whether the lead was captured. lead_id: Unique identifier for the captured lead. report_delivered: True only when the email provider confirmed acceptance of the ROI report; never claimed on failure. message: Confirmation message matching the delivery outcome.

object
lead_id
required
Lead Id
string
message
required
Message
string
report_delivered
Report Delivered
boolean
success
required
Success
boolean
Example
{
  "report_delivered": false
}

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
ctx
Context
object
input
Input
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Examplegenerated
{
  "detail": [
    {
      "ctx": {},
      "input": "example",
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}