EndpointsCarriers

Disable a carrier organization-wide

Mark this carrier as ineligible for any Ellie 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

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

Request

This endpoint expects an object.
reasonenumRequired

Constrained reason code; see AuditLogReason for the value set.

reason_notestring or nullOptional<=2000 characters

Response

Successful Response
idstringformat: "^car_[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"
namestring
mc_numberstring or null
dot_numberstring or null
emailstring or null
phonestring or null
dispatcher_namestring or null
dispatcher_phonestring or null
dispatcher_emailstring or null
is_activebooleanDefaults to true
providerstring or null
ingestion_methodstring or null
equipment_typeslist of enums or null
insurance_expirationdatetime or null
w9_on_fileboolean or null
authorized_for_hireboolean or null
on_time_pickup_pctdouble or null
on_time_delivery_pctdouble or null
tracking_compliance_pctdouble or null
avg_response_time_mindouble or null
total_loads_hauledinteger or null
is_onboardedbooleanDefaults to false
carrier_rep_user_idstringformat: "^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 null
carrier_rep_emailstring or null
is_verifiedbooleanDefaults to false
verified_datedatetime or null
created_atdatetime or null
updated_atdatetime or null

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
422
Unprocessable Entity Error
429
Too Many Requests Error