decline_data_share · Stop receiving a data share

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.declined
MCP tool: decline_data_share
decision_set: approve, reject
REST: POST https://api.containertradehq.com/v1/cap/decline_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

name	type	required	validation
org_id	org_id	required	tradehq-org-id; 1 to 20 characters The receiving org: the one that has claimed the share's party.
data_share_id	uuid	required	UUID The share, as list_received_data_shares names it.

Response

data_share_id · string · The share.
from_org_id · string · The org that made it.
declined_at · string · When it was declined.
declined_by · string · Who declined 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"
    },
    "from_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"
    },
    "declined_at": {
      "type": "string",
      "format": "date-time",
      "description": "When it was declined.",
      "x-data-class": "operational"
    },
    "declined_by": {
      "type": "string",
      "description": "Who declined it.",
      "x-data-class": "operational"
    }
  },
  "required": [
    "data_share_id",
    "from_org_id",
    "declined_at",
    "declined_by"
  ],
  "additionalProperties": false
}

Refusals

data_share_not_received · 422 · no share by that id is made to the party this org has claimed
data_share_revoked · 422 · the org that made the share revoked it, so it is sent nothing

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

Events

share.declined planned_webhook

preview_data_share, revoke_data_share