Book a demo

delete_role_template

Delete a role template

act entity tenant-private since 2026-10-01

Deletes one of the org's own role templates. A template a member holds, a pending invite will give, or an active invite link hands out is not deleted: give those people another role first. Shipped templates cannot be deleted. You can delete only a template that carries nothing your own role in the org does not. An id the org does not have is refused.

Contract

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

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 the template belongs to.
role_idtextrequired1 to 20 characters
The org's own template to delete: a clone id (RT and twelve characters).

Response

  • role_id · string · The template's id.
  • org_id · string · The org it belonged to.
  • deleted · boolean · True: the org has no template with this id.
Full JSON Schema 
{
  "type": "object",
  "properties": {
    "role_id": {
      "type": "string",
      "description": "The template's id.",
      "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 it belonged to.",
      "x-data-class": "operational"
    },
    "deleted": {
      "type": "boolean",
      "description": "True: the org has no template with this id.",
      "x-data-class": "operational"
    }
  },
  "required": [
    "role_id",
    "org_id",
    "deleted"
  ],
  "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 role
  • Outbound: crosses to no counterparty

Events

Related

get_data_policy, set_data_policy, update_role_template