Leads

Create a lead

Add a lead from your own system, for example a form on another site. It shows up in the portal and is pushed to your CRM like any other lead.

Send callback to have the AI call the person back straight away (speed-to-lead). The key then also needs the outbound:write scope. It needs outbound calling switched on, an active Pro plan and an AI receptionist, and is not available in HIPAA mode. The call still follows calling hours, Do Not Call lists and daily limits; the queued call is returned as callback.

post/leads

Request

Base URL: https://vocenya.com/api/public/v1
URL: https://vocenya.com/api/public/v1/leads
Auth: HTTP bearer

Request body

namestring nullable

phone_numberstring nullable

A US phone number in any common format. Needed for a callback.

emailstring email nullable

reasonstring required

Why they got in touch.

urgencystring nullable

detailsstring[] nullable

Any extra fields you want to keep with the lead (up to 50 keys).

Example request

{
  "name": "Maria Rivera",
  "email": "maria@example.com",
  "reason": "Wants a quote for a water heater replacement",
  "urgency": "high",
  "callback": {
    "consent_text": "I agree to receive an automated AI phone call from Rivera Plumbing about my request."
  }
}

Response

The lead, and the AI callback when one was requested.

Example response

{
  "data": {
    "name": "Maria Rivera",
    "phone_number": "+15125550123",
    "email": "maria@example.com",
    "urgency": "high"
  },
  "callback": {
    "contact_name": "Maria Rivera",
    "phone_number": "+15125550123"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.