Skip to navigation
EndpointsAPI

Assign or unassign loads to the AI agent

Assign one or more loads to the AI agent (assigned=true) or unassign them (assigned=false) by toggling the dedicated assigned_to_ai_agent flag — the source of truth for automated outreach, independent of the carrier rep the source TMS syncs. Both assign and unassign are open to any organization member (and any org API key) by design — every change is audited with actor attribution. Best-effort: load ids that are unknown or belong to another organization are returned in skipped.

Authentication: Supports API key and bearer token authentication.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

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.
load_idslist of stringsRequired

Loads to (un)assign to the AI agent (prefixed or raw UUIDs).

assignedbooleanRequired
True to assign the loads to the AI agent, False to unassign them.

Response

Successful Response
assigned_to_ai_agentboolean
The requested state applied to the loads below.
appliedlist of stringsOptional

Loads whose assigned_to_ai_agent now holds the requested state.

skippedlist of objectsOptional

Loads that could not be updated (invalid / cross-org ids).

Errors

401
Unauthorized Error
403
Forbidden Error
409
Conflict Error
422
Unprocessable Entity Error
429
Too Many Requests Error