Book a demo

remove_depot_reference

Remove a depot link

act entity tenant-private since 2026-10-01

Removes one of the org's own links to a depot (reference_depot), so its documents that use the org's name or code for the yard stop resolving to that BIC Facility Code until it is linked again. The registry record is not touched. An org admin, or the member who made the link, may remove it. A link that is already gone answers the same, and changes nothing.

Contract

shape
entity
authority
act
evidence
none
subscription
false
permission
any one of: org.admin (carried by the caller's role template in the org `org_id`); org.member (carried by the caller's role template in the org `org_id`); a deactivated caller is refused first
idempotency
natural
emits
depot.unreferenced
MCP tool
remove_depot_reference
decision_set
approve, reject
REST
POST https://api.containertradehq.com/v1/cap/remove_depot_reference

Through MCP this call returns an approval request first; see Approvals.

Idempotency: keyed by the contract's own inputs: the same inputs replay the first call's result

Inputs

nametyperequiredvalidation
org_idorg_idrequiredtradehq-org-id; 1 to 20 characters
The org whose link it is.
depot_reference_iduuidrequiredUUID
The link, from list_depot_references.

Response

  • depot_reference_id · string · The link.
  • removed · boolean · True: the link is gone.
Full JSON Schema 
{
  "type": "object",
  "properties": {
    "depot_reference_id": {
      "type": "string",
      "pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12}$",
      "format": "uuid",
      "description": "The link.",
      "x-data-class": "operational"
    },
    "removed": {
      "type": "boolean",
      "description": "True: the link is gone.",
      "x-data-class": "operational"
    }
  },
  "required": [
    "depot_reference_id",
    "removed"
  ],
  "additionalProperties": false
}

Refusals

The platform refusals apply to every call: version, authentication, authority, validation and rate limits, each in the same envelope.

Surfaces

DesktopF
MobileF
APIF
MCPF*
VoiceD2
PushF
OneBoxN
OutboundN
  • MCP: approval required
  • Voice: degraded: confirmation
  • OneBox: no document originates a depot link
  • Outbound: crosses to no counterparty

Events

Related

None.