Skip to navigation
EndpointsLane Preferences

Restrict a carrier on a specific lane

Mark this carrier as ineligible for the specified lane. Requires a human-readable reason; an audit-log row capturing the actor, reason, and timestamp is written in the same transaction. Idempotent: calling this endpoint when the preference is already restricted 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"
preference_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.
reasonenumRequired

Constrained reason code; see AuditLogReason for the value set.

reason_notestring or nullOptional<=2000 characters

Response

Successful Response
idstringformat: "uuid"
carrier_idstringformat: "uuid"
lane_idstringformat: "uuid"
is_activeboolean
preference_typestring
routing_guide_tierinteger or nullOptional
dnubooleanOptionalDefaults to false
dnu_reasonstring or nullOptional
dnu_set_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