Skip to content
RouteDeskDevelopers

Lead intake API

Testing your integration

There is no sandbox. Every accepted request creates a real lead in a real broker's account, so test with the broker.

A safe way to test

  1. Ask the broker for a test lead source. A separate source gets its own key, and the broker can switch it off when you are done. After that the test key gets 403 and can never create another lead.
  2. Label every test lead. Put TEST in the first name, so the broker can find and delete them.
  3. Use contact details you own. The broker's account may call, text or email new leads automatically. Never test with a real customer's phone number or email.
  4. Send one lead and compare. Ask the broker to open it and check every value you sent arrived where you expected.
  5. Switch to the real key. Once a test lead looks right, the broker gives you the key for the live lead source.

What the broker can see

In Settings → Lead sources, each source lists its recent submissions: every request made with that source's key, whether the lead was created, rejected or failed, and the body as it arrived.

A request whose key is missing, wrong, or belongs to a switched-off source cannot be matched to a source, so it does not appear there. If the broker sees nothing, check the response you got first.

Common mistakes

  • 401 Auth Key is required with a key set. The header must read Bearer with a capital B, then a space, then the key.
  • 422 with an error under _. The body was not sent as JSON. Set Content-Type: application/json.
  • shipDate must be ISO-8601. The standard format takes YYYY-MM-DD only. 12/01/2026 is a legacy-format date.
  • Expected boolean, received number on vehicles. inoperable takes true or false, not 1 or 0.
  • A value is missing from the lead, but the request succeeded. A misspelled field name is ignored rather than rejected. Compare your names with the field reference.
  • Errors name fields you did not send. You mixed the two formats. See how the format is chosen.