Skip to main content
POST
Create lead conversion
Required scopes: leads.write

Authorizations

Authorization
string
header
required

Use Authorization: Bearer rk_live_....

Headers

Idempotency-Key
string
required

A unique value for each new request, such as a UUID. Send the same value to retry a request safely. The same key and payload replay the first response with Idempotency-Replayed: true.

Required string length: 1 - 160

Path Parameters

lead_id
string
required

Body

application/json
external_event_id
string
required
Required string length: 1 - 200
session_id
string | null
visualization_id
string | null
conversion_url
string<uri> | null
entry
enum<string>

Website entry for this conversion touch. Omitted when unset.

Available options:
button,
embed,
direct
contact_name
string | null
contact_email
string<email> | null
contact_phone
string | null

US-only phone. Invalid or non-US values return VALIDATION_ERROR.

property_address
string | null

Optional property address. Empty, explicit US country, or US state + ZIP formats are accepted; clearly non-US values return VALIDATION_ERROR.

occurred_at
string<date-time>

ISO 8601 date-time with Z or a ±HH:MM offset. Stored as UTC.

lead_type
string

Channel of this touch. Send the key or the current label of a workspace lead type. Defaults to external. An unknown value returns VALIDATION_ERROR.

Required string length: 1 - 100
form_name
string | null

Name of the form that sent this touch.

Maximum string length: 200
form_key
string | null

Stable identifier of the form that sent this touch.

Maximum string length: 500

Response

Existing conversion replayed or returned by external_event_id.

conversion
object
required
created
boolean
required