Skip to navigation
EndpointsAPI

Post or unpost loads

Set Envoy’s internal is_posted flag for one or more loads. Best-effort: load ids that are unknown or belong to another organization are returned in skipped. This mirrors the individual load Posted toggle; it does not publish or remove postings on external load boards.

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 post or unpost (prefixed or raw UUIDs).

is_postedbooleanRequired
True to post the loads, False to unpost them.

Response

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

Loads whose is_posted flag 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