Submit a Lead
Submit a complete lead for validation, distribution, and assignment.
Authorizations
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
Public ID of the partner the submission is attributed to. Optional but recommended for any partner-mediated integration.
"partner_01arz3ndektsv4rrffq69g5fav"
Body
Postal code. Must be valid for your account's operating countries.
"33139"
Reference to a previous ping request. Include to link this lead to prior pricing.
"f47ac10b-58cc-4372-a567-0e02b2c3d479"
Specific bid to accept from the ping response. Only applicable for internal sources.
"7c9e6679-7425-40de-944b-e07fc1f90ae7"
Mark this lead as test data. Test leads are automatically moved to Audit status and won't be distributed. Only works when test mode is enabled on the source.
true
Additional fields as configured for your source and lead type.
Response
Lead created successfully
Internal UUID for the lead. Prefer lead_public_id for external references.
"f47ac10b-58cc-4372-a567-0e02b2c3d479"
Public identifier for the lead. Use this for display, URLs, and external references.
31^lead_[0-9a-z]{26}$"lead_01arz3ndektsv4rrffq69g5fav"
Current status of the lead.
pending, assigned, duplicate, unassigned, marketplace, audit "assigned"
Price paid for the lead. Zero if not yet assigned.
45

