/documents/links/{documentLinkId}/actions

DocumentLink actions: 'create-link', 'delete-link', 'edit-link'.
For 'create-link', provide documentId in the request body to create a new link for an existing document.
For 'delete-link' and 'edit-link', the documentLinkId in the path identifies the link to modify.
slotType values are lowercase (e.g., 'general', 'proof'); display uses Proper Case.
Linking/unlinking may trigger OST chain propagation/unpropagation per business rules.

Access Rules:

  • If no accessRules are provided when creating a link, all visibility fields default to 'visible' (shipperVisibility, operatorVisibility, carrierVisibility).
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

For 'create-link': use 'new' (new link gets auto-generated ID). For 'delete-link' and 'edit-link': the ID of the existing link to modify.

Body Params

DocumentLink action request (create-link | delete-link | edit-link). For 'create-link', documentId is required in the body.

string
enum
required
Allowed:
string
required

Id of the document to link.

string
required

Id of the entity to link to; interpret it using targetEntityType.

string
enum
required
string
enum
required
Allowed:
slotContext

Slot-specific context. For a shipment proof/stop_document pass stopType ('pickup'|'dropoff') and stopIndex is auto-derived; for a tour pass a 0-based stopIndex; for 'property' pass propertyId; empty for 'general'.

string

Free-text document category shown in the UI.

accessRules
object
Responses

400

bad request

401

unauthorized

404

document not found (for create-link) or document link not found (for delete-link/edit-link)

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json