For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Set a carrier’s global routing-guide priority tier
PUT
/carriers/:carrier_id/routing-guide-tier
Assign (1-4) or clear (null) the carrier's global routing-guide priority tier. When the org enables routing-guide priority, tiered carriers rank ahead of the untiered pool in every carrier-match surface; lane-specific tiers win over this global tier when both are set. An audit-log row recording the before/after tier is written in the same transaction. Idempotent: setting the current tier again returns the row unchanged and writes no audit entry. Admin-only — requires OWNER or ADMIN role on the organization.
**Authentication:** Bearer token required.
Authentication
AuthorizationBearer
Bearer authentication of the form Bearer <token>, where token is your auth token.
Path parameters
carrier_idstringRequiredformat: "uuid"
Headers
X-Organization-IDstring or nullOptional
Idempotency-KeystringOptional<=255 characters
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
This endpoint expects an object.
routing_guide_tierinteger or nullOptional1-4
Priority tier 1 (highest) to 4 (lowest); null clears the tier.
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.
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.
effective_routing_guide_tierinteger or nullOptional1-4
The tier that actually applies: lane_routing_guide_tier when set, else routing_guide_tier. Equal to the global tier on an unfiltered list.
carrier_rep_user_idstring or nullOptionalformat: "^usr_[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"
carrier_rep_namestring or nullOptional
carrier_rep_emailstring or nullOptional
is_verifiedbooleanOptionalDefaults to false
verified_datedatetime or nullOptional
compliance_statusenumOptional
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.
Allowed values:
stop_contact_requested_atdatetime or nullOptional
When the carrier last asked not to be contacted; Envoy stops contacting them
tms_carrier_idstring or nullOptional
The carrier's ID in your TMS
last_verified_atdatetime or nullOptional
last_verified_providerstring or nullOptional
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.
created_atdatetime or nullOptional
updated_atdatetime or nullOptional
Errors
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error
422
Unprocessable Entity Error
429
Too Many Requests Error
Assign (1-4) or clear (null) the carrier’s global routing-guide priority tier. When the org enables routing-guide priority, tiered carriers rank ahead of the untiered pool in every carrier-match surface; lane-specific tiers win over this global tier when both are set. An audit-log row recording the before/after tier is written in the same transaction. Idempotent: setting the current tier again returns the row unchanged and writes no audit entry. Admin-only — requires OWNER or ADMIN role on the organization.
Authentication: Bearer token required.
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.
