Book a demo

set_domain_join_policy

Set a domain's join_policy

act entity tenant-private since 2026-10-01

Decides what a person signing up with an address at one of the org's verified domains may do: invite_only (join only when invited) or request (they are put to the org's admins as a join request to approve or reject; nobody joins without that). The domain must be verified first with verify_domain.

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

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 domain is verified for.
domaintextrequired3 to 253 characters
The verified domain.
join_policyone_ofrequiredone of invite_only, request
invite_only or request.

Response

  • org_id · string · The org claiming it.
  • domain · string · The domain, lower case.
  • status · string · pending until the TXT record is found, then verified.
  • record_name · string · Where to publish the TXT record.
  • record_value · string · What the TXT record carries.
  • verified_at · stringnull · When it was verified.
  • verified_by · stringnull · Who verified it.
  • join_policy · string · invite_only, or request: a person signing up at the domain is put to the org's admins as a join request.
  • created_by · string · Who claimed it.
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 claiming it.",
      "x-data-class": "operational"
    },
    "domain": {
      "type": "string",
      "description": "The domain, lower case.",
      "x-data-class": "operational"
    },
    "status": {
      "type": "string",
      "enum": [
        "pending",
        "verified"
      ],
      "description": "pending until the TXT record is found, then verified.",
      "x-data-class": "operational"
    },
    "record_name": {
      "type": "string",
      "description": "Where to publish the TXT record.",
      "x-data-class": "operational"
    },
    "record_value": {
      "type": "string",
      "description": "What the TXT record carries.",
      "x-data-class": "operational"
    },
    "verified_at": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time",
      "description": "When it was verified.",
      "x-data-class": "operational"
    },
    "verified_by": {
      "type": [
        "string",
        "null"
      ],
      "minLength": 1,
      "maxLength": 20,
      "pattern": "^[A-Za-z0-9_-]{1,20}$",
      "format": "tradehq-user-id",
      "description": "Who verified it.",
      "x-data-class": "operational"
    },
    "join_policy": {
      "type": "string",
      "enum": [
        "invite_only",
        "request"
      ],
      "description": "invite_only, or request: a person signing up at the domain is put to the org's admins as a join request.",
      "x-data-class": "operational"
    },
    "created_by": {
      "type": "string",
      "minLength": 1,
      "maxLength": 20,
      "pattern": "^[A-Za-z0-9_-]{1,20}$",
      "format": "tradehq-user-id",
      "description": "Who claimed it.",
      "x-data-class": "operational"
    }
  },
  "required": [
    "org_id",
    "domain",
    "status",
    "record_name",
    "record_value",
    "verified_at",
    "verified_by",
    "join_policy",
    "created_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 join_policy
  • Outbound: crosses to no counterparty

Events

Related

create_sso_connection, remove_domain, verify_domain