Book a demo

revoke_data_share

Revoke a data share

act entity controlled-share since 2026-10-01

Revokes one explicit data share: its counterparty is sent nothing more and no longer sees it. The share's record stays. The documents on which the party holds a seat are not a share and are not revoked here. Revoking a revoked share changes nothing. A share its counterparty declined sends nothing already and is refused.

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`); a deactivated caller is refused first
idempotency
natural
emits
share.revoked
MCP tool
revoke_data_share
decision_set
approve, reject
REST
POST https://api.containertradehq.com/v1/cap/revoke_data_share

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 that made the share.
data_share_iduuidrequiredUUID
The share, as list_data_shares names it.

Response

  • data_share_id · string · The share.
  • org_id · string · The org that made it.
  • party_id · string · The counterparty.
  • query · string · The saved query it shared.
  • revoked_at · string · When it was revoked.
  • revoked_by · string · Who revoked it.
Full JSON Schema 
{
  "type": "object",
  "properties": {
    "data_share_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 share.",
      "x-data-class": "operational"
    },
    "org_id": {
      "type": "string",
      "minLength": 1,
      "maxLength": 20,
      "pattern": "^[A-Za-z0-9_-]{1,20}$",
      "format": "tradehq-org-id",
      "description": "The org that made it.",
      "x-data-class": "operational"
    },
    "party_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 counterparty.",
      "x-data-class": "operational"
    },
    "query": {
      "type": "string",
      "enum": [
        "vendor_bill_request",
        "vendor_forecast",
        "vendor_sell_through"
      ],
      "description": "The saved query it shared.",
      "x-data-class": "operational"
    },
    "revoked_at": {
      "type": "string",
      "format": "date-time",
      "description": "When it was revoked.",
      "x-data-class": "operational"
    },
    "revoked_by": {
      "type": "string",
      "description": "Who revoked it.",
      "x-data-class": "operational"
    }
  },
  "required": [
    "data_share_id",
    "org_id",
    "party_id",
    "query",
    "revoked_at",
    "revoked_by"
  ],
  "additionalProperties": false
}

Refusals

not yet declared

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 revocation
  • Outbound: a revocation sends nothing; it stops what the share sent

Events

Related

decline_data_share, preview_data_share