Create a carrier
Create or update one carrier, with compliance and fraud checking. A carrier matching on tms_carrier_id, MC, DOT or name is updated: 201 when the carrier was created, 200 when updated.
Authentication: Supports API key and bearer token authentication.
Authentication
Bearer authentication of the form Bearer <token>, where token is your auth token.
Headers
A unique key (up to 255 printable ASCII characters, e.g. a UUID) that makes a retry of this request safe. Envoy stores the response for 24 hours; a retry with the same key and the same request returns it again with Idempotent-Replayed: true instead of running twice. The same key with a different request returns 422 idempotency_key_reused; while the first request is still running, 409 idempotency_key_in_progress. 5xx and 429 responses are not stored.
Request
Your TMS’s ID for the carrier; Envoy matches updates on it first
Primary phone (any common format, stored as E.164)
Dispatcher phone (any common format, stored as E.164)
On-time delivery percentage (0-100 scale)
On-time pickup percentage (0-100 scale)
Whether the carrier is active. False creates the carrier disabled, or disables it if it already exists (e.g. the source TMS flags it do-not-load). True never re-enables an existing carrier; use the enable endpoint for that.
Carrier status as reported by the source TMS (e.g. DNL). Stored as sent; the latest value wins. Read by the inbound email gate when the organization opts in to operational restriction notices for inactive carriers with this status.
Response
Carrier status as reported by the source TMS (e.g. DNL). Read by the inbound email gate when the organization opts in to operational restriction notices for inactive carriers with this status.
On-time pickup percentage (0-100 scale)
On-time delivery percentage (0-100 scale)
Global routing-guide priority tier (1 = highest, 4 = lowest). None = untiered.
Strongest routing-guide tier this carrier holds on the lane the list was filtered to (1 = highest). Null when the list has no lane filter, or the carrier is untiered on it.
The tier that actually applies: lane_routing_guide_tier when set, else routing_guide_tier. Equal to the global tier on an unfiltered list.
The verdict of Envoy’s most recent compliance check on the carrier: PASSED or BLOCKED, or UNVERIFIED when no check has run yet or the last check could not reach a result.
When the carrier last asked not to be contacted; Envoy stops contacting them
Which compliance provider issued the most recent verification (e.g. Highway or MyCarrierPackets). Distinct from provider, which is the system the carrier record came from. Null when no verification has run, or when the provider was not recorded.