join_product #

View this page as Markdown

Generated automatically from the published contract sources.

Build metadata: Registered in this build. Registration describes the default dispatcher in this build. It does not guarantee that a caller has the required credential or grant, that a tool is listed for that connection, or that the required service is configured.

A script calls this action over HTTPS at POST https://turnzero.ai/api/v1/actions/join_product, with a bearer credential and the action's payload as the JSON body.

Contract description #

Add tzCloud to this account, the act the account page's Enable control makes. Name `product` as `cloud`. The join takes one of Cloud's open places and is refused `realm_creation_ceiling` while none is open; an invitation that names Cloud adds it whatever the count. An account that already holds Cloud answers `joined: false` with nothing changed. Refused `account_door_not_yet_served` on an estate whose operator has not lifted the account door. tzTeam comes by invitation; no other product is joined here.

Access and action metadata #

{
  "name": "join_product",
  "resource": "account",
  "tier": "reversible",
  "clients": [
    "bearer",
    "browser_session"
  ],
  "summary": "Add tzCloud to the acting account, the account page's join: `product` names `cloud`, the one product a join adds at this revision; the grant counts against the operator's ceiling on open sign-ups and is refused `realm_creation_ceiling` where the open sign-ups stand at it, recorded on the operator's side; an account already holding the product answers `joined: false` with nothing changed. Refused `account_door_not_yet_served` while the estate's ACCOUNT_DOOR_PRODUCTS setting reads off. tzTeam comes by invitation; no other product is joined here, each refused `invalid_request`.",
  "annotations": {
    "readOnlyHint": false,
    "destructiveHint": false,
    "openWorldHint": false,
    "idempotentHint": true
  }
}

MCP catalog entry #

{
  "name": "join_product",
  "title": "Enable tzCloud",
  "tier": "reversible",
  "scenario": "CHI-L0-04",
  "summary": "Add tzCloud to this account, the act the account page's Enable control makes. Name `product` as `cloud`. The join takes one of Cloud's open places and is refused `realm_creation_ceiling` while none is open; an invitation that names Cloud adds it whatever the count. An account that already holds Cloud answers `joined: false` with nothing changed. Refused `account_door_not_yet_served` on an estate whose operator has not lifted the account door. tzTeam comes by invitation; no other product is joined here.",
  "owners": [
    "ACB-L0-76",
    "ACB-L0-77",
    "WEB-L0-21"
  ]
}

request #

JSON pointer Description and constraints
"" (root) Type: object
Required fields: ["product"]
Additional properties: false
/properties/product The product to join, `cloud` at this revision: tzTeam comes by invitation; no other product is joined here, each refused `invalid_request`.

Allowed values: ["cloud"]

response #

JSON pointer Description and constraints
"" (root) Type: object
Required fields: ["contract_version","account","product","joined"]
Additional properties: false
/properties/contract_version Required value: 1
/properties/account Type: object
Required fields: ["id","created_at","standing","synthetic"]
Additional properties: false
/properties/account/properties/id Type: string
/properties/account/properties/created_at Type: string
/properties/account/properties/standing Allowed values: ["active","suspended"]
/properties/account/properties/synthetic Type: boolean
/properties/product The profile name the call named.

Type: string
/properties/joined true where the account lacked the product and now holds it; false where it already held it, nothing changed, and a repeat answers the same.

Type: boolean
/properties/detail Type: string

Complete payload contract #

{
  "request": {
    "type": "object",
    "required": [
      "product"
    ],
    "properties": {
      "product": {
        "enum": [
          "cloud"
        ],
        "description": "The product to join, `cloud` at this revision: tzTeam comes by invitation; no other product is joined here, each refused `invalid_request`."
      }
    },
    "additionalProperties": false
  },
  "response": {
    "type": "object",
    "required": [
      "contract_version",
      "account",
      "product",
      "joined"
    ],
    "properties": {
      "contract_version": {
        "const": 1
      },
      "account": {
        "type": "object",
        "required": [
          "id",
          "created_at",
          "standing",
          "synthetic"
        ],
        "properties": {
          "id": {
            "type": "string"
          },
          "created_at": {
            "type": "string"
          },
          "standing": {
            "enum": [
              "active",
              "suspended"
            ]
          },
          "synthetic": {
            "type": "boolean"
          }
        },
        "additionalProperties": false
      },
      "product": {
        "type": "string",
        "description": "The profile name the call named."
      },
      "joined": {
        "type": "boolean",
        "description": "true where the account lacked the product and now holds it; false where it already held it, nothing changed, and a repeat answers the same."
      },
      "detail": {
        "type": "string"
      }
    },
    "additionalProperties": false
  }
}

Shared contracts #