Skip to main content
POST
/
ping
curl --request POST \
  --url https://usejuiced.com/api/ping \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '{
  "zip": "90210"
}'
{
  "ping_id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
  "message": "Match found",
  "bids": [
    {
      "id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
      "price": 45,
      "tcpa_name": "Nectarflix Entertainment",
      "customer_id": 123
    },
    {
      "id": "a3bb189e-8bf9-3888-9912-ace4e6543002",
      "price": 38.5,
      "tcpa_name": "The Mangolorian Security",
      "customer_id": 456
    }
  ]
}

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.

Example:

"90210"

​
{key}
any

Additional fields as configured for your source and lead type.

Response

Ping processed successfully

Response for internal source types

​
ping_id
string

Unique identifier for this ping. Use this when submitting the full lead.

Example:

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

​
message
enum<string>

Result of the ping request.

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

Available bids for this lead. Empty if no match or duplicate.