Skip to main content
POST
This endpoint is deprecated and frozen. Build new integrations on Submit a Ping, and see Migrating from the legacy API for how to move over.
The response has one of two shapes. Non-vendor sources get ping_id, message and bids when the ping went through matching or used a test-mode zip. Vendor sources always get message, price and ping_id, and so does any ping answered before matching (duplicate, quota reached, or rejected).

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 message for the outcome.

Non-vendor sources, when the ping went through matching or used a test-mode zip.

ping_id
string<uuid>

The ping's ID. Send it as ping_id when you post the lead.

Example:

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

message
enum<string>

Result of the ping. Duplicate and Rejected only appear here for test-mode zips.

Available options:
Match found,
No match found,
Duplicate,
Rejected
bids
Bid (legacy) · object[]

Bids for this lead. Empty when there's no match.