---
title: "add_product"
description: "Generated reference for the management action add_product: its description, access metadata, payload contract, and registration status."
slug: /reference/actions/add-product
order: 64
visibility: public
redirects_from: []
---

# add\_product

Generated automatically from the [published contract sources](/reference/about#contract-sources).

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

**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.

## Contract description

Add the `tztrack` product profile to one account, removing the account from that product's revocation list\. Super\-admin \(platform operator\) only\. An account already holding the row gets no second one, and the call returns `held_before: true`, but the account still leaves that product's revocation list\. With `dry_run: true`, nothing is written and the result says whether a real call would add the profile\.

## Access and action metadata

```json
{
  "name": "add_product",
  "resource": "account",
  "tier": "reversible",
  "grant": "super_admin",
  "summary": "Super-admin: add the `tztrack` product profile to one account, removing the account from that product's revocation list. It is the way back after revoke_product removes the profile, and the opening's act over every existing account. An account already holding the row gets no second one, and the call returns `held_before: true`, but the account still leaves that product's revocation list. `dry_run` counts without writing. Any other product is refused `invalid_request`, an unknown account `not_found`.",
  "annotations": {
    "readOnlyHint": false,
    "destructiveHint": false,
    "openWorldHint": false
  }
}
```

## MCP catalog entry

```json
{
  "name": "add_product",
  "title": "Add product",
  "tier": "reversible",
  "scenario": "API-L0-12",
  "summary": "Add the `tztrack` product profile to one account, removing the account from that product's revocation list. Super-admin (platform operator) only. An account already holding the row gets no second one, and the call returns `held_before: true`, but the account still leaves that product's revocation list. With `dry_run: true`, nothing is written and the result says whether a real call would add the profile.",
  "owners": [
    "API-L0-12",
    "MAPI-09",
    "ACB-L0-76"
  ]
}
```

## request

| JSON pointer | Description and constraints |
|---|---|
| "" \(root\) | Type: object<br>Required fields: \["subject\_account","product"\]<br>Additional properties: false |
| /<wbr>properties/<wbr>subject\_account | The account id, from `list_accounts`\.<br><br>Type: string |
| /<wbr>properties/<wbr>product | The product profile to add, as `read_account` lists it under `profiles[].product`: `tztrack`, a row of the plane's product table\. `cloud` comes by creation or `join_product`, and `tzteam` by invitation alone; if you pass either, it is refused invalid\_request\.<br><br>Allowed values: \["tztrack"\] |
| /<wbr>properties/<wbr>dry\_run | true counts without writing: you get back whether a run would add the row; leave it out or pass false to write the row where lacking\.<br><br>Type: boolean |

## response

| JSON pointer | Description and constraints |
|---|---|
| "" \(root\) | Type: object<br>Required fields: \["contract\_version","account","product","dry\_run","held\_before","added","detail"\]<br>Additional properties: false |
| /<wbr>properties/<wbr>contract\_version | Required value: 1 |
| /<wbr>properties/<wbr>account | Type: object<br>Required fields: \["id","created\_at","standing","synthetic"\]<br>Additional properties: false |
| /<wbr>properties/<wbr>account/<wbr>properties/<wbr>id | Type: string |
| /<wbr>properties/<wbr>account/<wbr>properties/<wbr>created\_at | Type: string |
| /<wbr>properties/<wbr>account/<wbr>properties/<wbr>standing | Allowed values: \["active","suspended"\] |
| /<wbr>properties/<wbr>account/<wbr>properties/<wbr>synthetic | Type: boolean |
| /<wbr>properties/<wbr>product | Allowed values: \["tztrack"\] |
| /<wbr>properties/<wbr>dry\_run | whether the call counted without writing<br><br>Type: boolean |
| /<wbr>properties/<wbr>held\_before | whether the account held the row before the call<br><br>Type: boolean |
| /<wbr>properties/<wbr>added | whether this call wrote the row; false on a dry run and on a held row<br><br>Type: boolean |
| /<wbr>properties/<wbr>detail | Type: string |

## Complete payload contract

```json
{
  "request": {
    "type": "object",
    "required": [
      "subject_account",
      "product"
    ],
    "properties": {
      "subject_account": {
        "type": "string",
        "description": "The account id, from `list_accounts`."
      },
      "product": {
        "enum": [
          "tztrack"
        ],
        "description": "The product profile to add, as `read_account` lists it under `profiles[].product`: `tztrack`, a row of the plane's product table. `cloud` comes by creation or `join_product`, and `tzteam` by invitation alone; if you pass either, it is refused invalid_request."
      },
      "dry_run": {
        "type": "boolean",
        "description": "true counts without writing: you get back whether a run would add the row; leave it out or pass false to write the row where lacking."
      }
    },
    "additionalProperties": false
  },
  "response": {
    "type": "object",
    "required": [
      "contract_version",
      "account",
      "product",
      "dry_run",
      "held_before",
      "added",
      "detail"
    ],
    "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": {
        "enum": [
          "tztrack"
        ]
      },
      "dry_run": {
        "type": "boolean",
        "description": "whether the call counted without writing"
      },
      "held_before": {
        "type": "boolean",
        "description": "whether the account held the row before the call"
      },
      "added": {
        "type": "boolean",
        "description": "whether this call wrote the row; false on a dry run and on a held row"
      },
      "detail": {
        "type": "string"
      }
    },
    "additionalProperties": false
  }
}
```

## Shared contracts

- [Refusals](/reference/refusals): every refusal, by surface, with its cause and its remedy
- [schemas/wire\_error\.schema\.json](/reference/sources/schemas/wire-error-schema)
- [schemas/wire\_errors\.json](/reference/sources/schemas/wire-errors)
- [schemas/action\_payloads\.json](/reference/sources/schemas/action-payloads) (includes shared shapes)
- [management\_api\_contract\.md](/reference/sources/management-api-contract)