Skip to main content
POST
This endpoint is deprecated and frozen. Build new integrations on Submit a Lead, and see Migrating from the legacy API for how to move over.

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.

Body

application/json
​
zip
string
required

Postal code. Must be valid for your account's operating countries. With the source in test mode, zips 00001 to 00005 return fixed outcomes.

Example:

"33139"

​
transaction_id
string

Your own ID for this lead, such as an order or lead number. A retry with the same transaction_id and payload returns the original response instead of creating a second lead. Numbers are accepted and treated as strings.

Maximum string length: 255
Example:

"order-10482"

​
ping_id
string

The ping_id returned by the ping (a UUID), or the ping's ping_… public ID.

Example:

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

​
bid_id
string<uuid>

A bid id from the ping response. It must be a UUID, so a partner's numeric bid id can't be echoed. It doesn't change who gets the lead.

Example:

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

​
{key}
any

Additional fields as configured for your source and lead category.

Response

Lead received. Check status for the outcome.

​
lead_uuid
string<uuid>
deprecated

Internal UUID for the lead. Prefer lead_public_id.

Example:

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

​
lead_public_id
string

The lead's public ID.

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

"lead_01arz3ndektsv4rrffq69g5fav"

​
status
enum<string>

The outcome, decided by the source's status response mapping. By default, success covers leads that were assigned, posted to a partner, placed on the marketplace or parked in the Club; rejected covers Unassigned, Audit and Uncategorized leads; duplicate covers duplicates.

Available options:
success,
rejected,
duplicate
Example:

"success"

​
price
number

What the source earns for the lead, in dollars. Always 0 unless status is success.

Example:

45