Book a demo

rename_org

Rename an org

act entity tenant-private since 2026-10-01

Renames an org, and its test twin with it (the twin is the name and " (test)"). The org's Linear customer takes the new name after the next customer sync, which this call asks for at once. Renaming to the name it already has changes nothing. A test twin is renamed through its live org, and a system org's name is declared in code. Trade HQ staff only.

Contract

shape
entity
authority
act
evidence
none
subscription
false
permission
any one of: staff.provision (the staff role staff_provision held in the Internal org, tradehq_role.staff_role); a deactivated caller is refused first
idempotency
natural
emits
org.renamed
MCP tool
rename_org
decision_set
approve, reject, escalate
REST
POST https://api.containertradehq.com/v1/cap/rename_org

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.
namenamerequired1 to 120 characters
The org's new name: the legal entity's, as customers know it.

Response

  • org_id · string · The org.
  • name · string · The org's name now.
  • previous · string · The name it had before the call; the same as name when nothing changed.
Full JSON Schema 
{
  "type": "object",
  "properties": {
    "org_id": {
      "type": "string",
      "minLength": 1,
      "maxLength": 20,
      "pattern": "^[A-Za-z0-9_-]{1,20}$",
      "format": "tradehq-org-id",
      "description": "The org.",
      "x-data-class": "operational"
    },
    "name": {
      "type": "string",
      "description": "The org's name now.",
      "x-data-class": "operational"
    },
    "previous": {
      "type": "string",
      "description": "The name it had before the call; the same as name when nothing changed.",
      "x-data-class": "operational"
    }
  },
  "required": [
    "org_id",
    "name",
    "previous"
  ],
  "additionalProperties": false
}

Refusals

  • org_is_twin · 422 · a test twin is named after its live org; rename the live org
  • org_is_system · 422 · a system org's name is declared in db/tradehq/orgs.json, and every tradehq apply puts it back
  • org_has_no_type · 422 · the org has no type row: a ported org nothing has typed yet
  • org_purged · 422 · the org is purged; only its tombstone is left

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 an org's name
  • Outbound: crosses to no counterparty

Events

Related

create_access_review, create_sso_connection, invite_user, update_sso_connection