Skip to main content
POST
Create a lead

Authorizations

Authorization
string
header
required

Tenant-issued API key. Format: vapk_live_<48 hex chars> (60 chars total). Issue + manage at /settings/integrations/api-keys in the Vorel dashboard. Each key has a scope set (read, leads:write, appointments:write, offerings:write); endpoints requiring a write scope reject keys without it with a 403 envelope.

Body

application/json
conversation_id
string<uuid>
required
name
string | null
Maximum string length: 200
email
string<email> | null
phone
string | null
Maximum string length: 32
intent
string | null
Maximum string length: 40
timeline
string | null
Maximum string length: 40
qualification_score
integer | null
Required range: 0 <= x <= 100
status
enum<string>
Available options:
new,
qualified,
booked,
converted,
lost
source
string | null
Maximum string length: 40
attributes
object

Response

Lead created. Emits lead.created (and lead.qualified when the create-time status is qualified).

id
string<uuid>
required
conversation_id
string<uuid>
required
attributes
object
required

Vertical-specific JSONB. Real estate emits bedrooms/budget_min/area/etc.; salons emit preferred_stylist/service_history/etc.; clinics emit insurance_provider/symptoms_summary/etc. The shape is determined by the tenant's vertical pack — consult your operator setup for the keys to expect.

status
enum<string>
required
Available options:
new,
qualified,
booked,
converted,
lost
created_at
string<date-time>
required
updated_at
string<date-time>
required
name
string | null
email
string<email> | null
phone
string | null
intent
string | null
timeline
string | null
qualification_score
integer | null
Required range: 0 <= x <= 100
source
string | null