Skip to main content

Changelog

The change history of the Navigo Lead Provider API. Update this page on every API change.

v1.1 — 2026​

Public Lead API — simplified location handling

  • State and city are now auto-detected from ZIP codes on POST /public/leads/.
  • origin_zip is required; destination_zip is optional (recommended). Both must be valid US ZIPs.
  • origin_city / destination_city are optional — auto-filled from the ZIP.
  • origin_state / destination_state are deprecated — omit them; they are ignored if sent.
  • Clarified: /api/v1/common/states/ is internal-only (JWT). External API-key callers get 401. No state-ID lookup is needed anymore.
  • vehicle_run (Vehicle) documented as a supported optional Boolean.

Public Lead API — shipping fields

  • Added overseas_type (DOMESTIC / FOREIGN) and ship_via to POST /public/leads/.
  • ship_via values are conditional on overseas_type: domestic → OPEN, ENCLOSED, DRIVE_AWAY; foreign → CONTAINER_20FT, CONTAINER_40FT, SHARED, ROLLON_ROLLOFF. All values are exact, case-sensitive strings.

Authentication

  • API keys can be viewed again in the Navigo CRM — they are no longer one-time-only secrets.

v1.0 — 2026​

The first official release.

Public Lead API

  • POST /api/v1/public/leads/ — submit a lead.
  • GET /api/v1/public/leads/{external_id}/ — get a lead's status.

Management API

  • GET /api/v1/lead_providers/ — list providers.
  • POST /api/v1/lead_providers/create/ — create a provider.
  • GET /api/v1/lead_providers/{id}/ — get a provider.
  • PATCH /api/v1/lead_providers/{id}/ — update a provider.
  • POST /api/v1/lead_providers/{id}/generate_api_key/ — generate an API key.

Authentication

  • Public API: Provider API Key (lp_live_...).
  • Management API: JWT + IsAdminOnlyPosition.
  • Rate limit: 60/min, 2000/day.

:::note Items pending confirmation One item still awaits backend confirmation: the exact create response body for POST /public/leads/. It is marked with :::note TODO: verify on the Create Lead page. (The destination_zip, vehicle_run, and states endpoint questions from v1.0 are now resolved.) :::