Skip to main content
POST

Authorizations

​
Authorization
string
header
required

Use your source's API key as the username and API secret as the password. Base64 encode the credentials in the format api_key:api_secret.

Headers

​
X-Partner-Id
string

Public ID of the partner the submission is attributed to. Optional but recommended for any partner-mediated integration.

Example:

"partner_01arz3ndektsv4rrffq69g5fav"

Body

application/json
​
zip
string
required

Postal code. Must be valid for your account's operating countries.

Example:

"33139"

​
ping_id
string<uuid>

Reference to a previous ping request. Include to link this lead to prior pricing.

Example:

"f47ac10b-58cc-4372-a567-0e02b2c3d479"

​
bid_id
string<uuid>

Specific bid to accept from the ping response. Only applicable for internal sources.

Example:

"7c9e6679-7425-40de-944b-e07fc1f90ae7"

​
is_test
boolean
default:false

Mark this lead as test data. Test leads are automatically moved to Audit status and won't be distributed. Only works when test mode is enabled on the source.

Example:

true

​
{key}
any

Additional fields as configured for your source and lead type.

Response

Lead created successfully

​
lead_uuid
string<uuid>
deprecated

Internal UUID for the lead. Prefer lead_public_id for external references.

Example:

"f47ac10b-58cc-4372-a567-0e02b2c3d479"

​
lead_public_id
string

Public identifier for the lead. Use this for display, URLs, and external references.

Required string length: 31
Pattern: ^lead_[0-9a-z]{26}$
Example:

"lead_01arz3ndektsv4rrffq69g5fav"

​
status
enum<string>

Current status of the lead.

Available options:
pending,
assigned,
duplicate,
unassigned,
marketplace,
audit
Example:

"assigned"

​
price
number<float>

Price paid for the lead. Zero if not yet assigned.

Example:

45