Skip to main content
POST
If you pinged first, send the ping’s id as ping_id. You can also echo the bids[].id you chose as bid_id. It’s checked, but it doesn’t change who gets the lead. Send a transaction_id so a retry can never create a second lead. See Safe retries for how retries are answered.

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 id returned by POST /v1/ping. Links this lead to the ping's match and pricing. A legacy ping UUID is rejected.

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

"ping_01jbx8k6y2m4n7p9q3r5s8t0vw"

​
bid_id
string

Any bids[].id returned by POST /v1/ping for your account. It is checked but doesn't change who gets the lead.

Pattern: ^(bid|prt|ping)_[0-9a-z]{26}$
Example:

"bid_01h9z3c5e7g9j1k3m5n7p9r1st"

​
{key}
any

Additional fields as configured for your source and lead category.

Response

Lead received. Check data.status for the outcome. A retry with the same transaction_id and payload returns this same response again.

​
data
Lead · object
required
​
version
enum<string>
required

Always v1.

Available options:
v1