Skip to main content
POST

Authorizations

X-API-Key
string
header
required

API key for authentication. Keys are prefixed with nxr_live_.

Body

application/json

Create a conversion event. The workflow_id, master_workflow_id, and currency are automatically inherited from the conversion type — you typically do not need to provide them.

conversion_type_id
string<uuid>
required

Conversion type ID. Use GET /conversion-types to list available types. The type's scope (workflow or master workflow) is automatically applied to the event.

Example:

"123e4567-e89b-12d3-a456-426614174100"

lead_id
string<uuid>
required

Lead ID that converted

Example:

"123e4567-e89b-12d3-a456-426614174200"

amount
number<double>
required

Monetary value of the conversion

Example:

85000

workflow_run_id
string<uuid> | null

Optional workflow run ID for granular attribution to a specific run.

Example:

"123e4567-e89b-12d3-a456-426614174400"

currency
string

ISO 4217 currency code. Automatically inherited from the conversion type's currency setting — only provide this to override the default.

Required string length: 3
Example:

"USD"

converted_at
string<date-time>

When the conversion actually occurred (ISO 8601 timestamp). Defaults to the current time if not provided.

Example:

"2026-02-01T15:30:00Z"

metadata
object

Key-value data for this conversion event. Keys should match the fields[].key values defined on the conversion type (use GET /conversion-types to see each type's field definitions). You may also include arbitrary extra keys for external system data.

Example:
notes
string | null

Free-text notes about this conversion event

Example:

"Client paid in cash, expedited closing."

Response

Conversion event created successfully

success
boolean
required
Example:

true

conversion_event
object
required
Last modified on June 18, 2026