> ## Documentation Index > Fetch the complete documentation index at: https://docs.usejuiced.com/llms.txt > Use this file to discover all available pages before exploring further. # Submit a Ping > Check pricing and match potential before submitting a full lead. ## OpenAPI ````yaml POST /ping openapi: 3.1.0 info: title: Juiced API description: API for submitting and managing leads in Juiced. version: 1.0.0 servers: - url: https://usejuiced.com/api description: Production server security: - Basic Auth: [] - Bearer Token: [] tags: - name: Ping description: Check for matching bids before submitting a full lead. - name: Leads description: Submit complete leads for processing and assignment. paths: /ping: post: tags: - Ping summary: Submit a ping description: >- Submits partial lead data to check for matching bids before sending the full lead. Use this to determine pricing and availability before committing to a full lead submission. The response varies based on your source type: - **Internal sources** receive a list of matching bids with customer details - **Vendor sources** receive a single aggregated price operationId: createPing parameters: - $ref: '#/components/parameters/PartnerIdHeader' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/PingRequest' examples: minimal: summary: Minimal ping (zip only) value: zip: '90210' withState: summary: Ping with state value: zip: '90210' state: CA detailed: summary: Detailed ping value: zip: '33139' state: FL urgency: high intent: purchase testPing: summary: Test ping value: is_test: true zip: '00002' responses: '200': description: Ping processed successfully content: application/json: schema: oneOf: - $ref: '#/components/schemas/PingResponseInternal' - $ref: '#/components/schemas/PingResponseVendor' examples: matchFound: summary: Match found (internal source) value: 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 matchFoundVendor: summary: Match found (vendor source) value: ping_id: f47ac10b-58cc-4372-a567-0e02b2c3d479 message: Match found price: 45 noMatch: summary: No match found value: ping_id: f47ac10b-58cc-4372-a567-0e02b2c3d479 message: No match found bids: [] duplicate: summary: Duplicate detected value: ping_id: f47ac10b-58cc-4372-a567-0e02b2c3d479 message: Duplicate bids: [] '401': $ref: '#/components/responses/Unauthorized' '422': $ref: '#/components/responses/ValidationError' components: parameters: PartnerIdHeader: name: X-Partner-Id in: header required: false description: >- Public ID of the partner the submission is attributed to. Optional but recommended for any partner-mediated integration. schema: type: string example: partner_01arz3ndektsv4rrffq69g5fav schemas: PingRequest: title: Ping Request type: object required: - zip properties: zip: type: string description: Postal code. Must be valid for your account's operating countries. example: '90210' is_test: type: boolean description: >- Mark this ping as test data. Test pings won't affect production metrics and return deterministic responses based on zip code. Only works when test mode is enabled on the source. default: false example: true additionalProperties: description: Additional fields as configured for your source and lead type. PingResponseInternal: title: Internal type: object description: Response for internal source types properties: ping_id: type: string description: >- Unique identifier for this ping. Use this when submitting the full lead. example: f47ac10b-58cc-4372-a567-0e02b2c3d479 message: type: string enum: - Match found - No match found - Duplicate - Rejected description: Result of the ping request. bids: type: array description: Available bids for this lead. Empty if no match or duplicate. items: $ref: '#/components/schemas/Bid' PingResponseVendor: title: Vendor type: object description: Response for vendor source types properties: ping_id: type: string description: >- Unique identifier for this ping. Use this when submitting the full lead. example: f47ac10b-58cc-4372-a567-0e02b2c3d479 message: type: string enum: - Match found - No match found - Duplicate - Rejected description: Result of the ping request. price: type: number format: float description: Aggregated price offered for this lead. example: 45 Bid: title: Bid type: object properties: id: type: string description: >- Unique identifier for this bid. Include as `bid_id` when submitting the lead to select this specific buyer. example: 7c9e6679-7425-40de-944b-e07fc1f90ae7 price: type: number format: float description: Price offered for this lead. example: 45 tcpa_name: type: string description: Customer name for TCPA consent language. example: Juiceversal Pictures customer_id: type: integer description: Internal customer identifier. example: 123 UnauthorizedError: title: Unauthorized Error type: object properties: message: type: string example: Unauthorized ValidationError: title: Validation Error type: object properties: message: type: string example: The given data was invalid. errors: type: object additionalProperties: type: array items: type: string example: email: - The email field must be a valid email address. responses: Unauthorized: description: Authentication credentials are missing or invalid. content: application/json: schema: $ref: '#/components/schemas/UnauthorizedError' ValidationError: description: Request validation failed. content: application/json: schema: $ref: '#/components/schemas/ValidationError' securitySchemes: Basic Auth: type: http scheme: basic description: >- 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`. Bearer Token: type: http scheme: bearer description: Use a bearer token generated for your source. ````