Skip to main content
POST
Vendor sources get a single price, never the bids behind it. Every other source gets the matching bids, each with the buyer’s name for TCPA consent. Every ping that passes validation returns 200 whatever its status, so read data.status for the outcome, and keep data.id to send as ping_id when you post the lead.

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 you're pinging on behalf of. The ping is recorded against that partner when the partner is linked to the source whose credentials you use. Optional but recommended for any partner-mediated integration.

Example:

"prt_01h7x1a3c5e7g9j1k3m5n7q9sv"

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:

"90210"

{key}
any

Additional fields as configured for your source and lead category. Only fields marked required for ping must be sent.

Response

Ping evaluated. Check data.status for the outcome.

data
Ping · object
required
version
enum<string>
required

Always v1.

Available options:
v1