Skip to main content
POST
Create lead

Authorizations

X-API-Key
string
header
required

Your Flozy API key. Starts with flz_live_.

Body

application/json
title
string
required
Required string length: 1 - 200
Example:

"Acme Corp"

status_name
string

Status slug. Auto-created if it does not exist. Use GET /lead-statuses to list existing slugs.

Maximum string length: 100
Example:

"in_progress"

meta_data
object
custom_fields
object

Custom field values for the lead, keyed by the definition's field_key. Empty object when nothing is set.

Value shape per field type:

Send null to clear a field.

Example:

Response

Lead created.