Disable a carrier organization-wide
Mark this carrier as ineligible for any AI-agent workflow on this org. Requires a human-readable reason; an audit-log row capturing the actor, reason, and timestamp is written in the same transaction. Idempotent: calling this when the carrier is already disabled returns the current row unchanged and writes no audit entry. Admin-only — requires OWNER or ADMIN role on the organization.
Authentication: Bearer token required.
Authentication
Bearer authentication of the form Bearer <token>, where token is your auth token.
Path parameters
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
Constrained reason code; see AuditLogReason for the value set.
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.