> ## Documentation Index
> Fetch the complete documentation index at: https://deepline.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Heyreach Create Workspace Key: Inputs, Cost & CLI Example

> Generating a new API or integration key for a HeyReach workspace. Includes inputs, outputs, pricing notes, Deepline CLI examples, and GTM automation guidance.

## Run in Enrichment Spreadsheet

<Info>
  Use this function as a column step in `deepline enrich`.
</Info>

```bash theme={null}
deepline enrich --input leads.csv --output leads.enriched.csv --with 'result=heyreach_create_workspace_api_key:{"workspace_id":"{{workspace_id}}","api_key_type":"PUBLIC"}' --json
```

<Tip>
  Map payload values to spreadsheet columns with `{{column_name}}` placeholders.
</Tip>

## Input Schema

| Name                   | Type                                               | Required | Default | Description                              |
| ---------------------- | -------------------------------------------------- | -------- | ------- | ---------------------------------------- |
| `payload.workspace_id` | `integer \| string`                                | Yes      |         | Numeric id as integer or numeric string. |
| `payload.api_key_type` | `"PUBLIC" \| "N8N" \| "MAKE" \| "ZAPIER" \| "MCP"` | Yes      |         |                                          |

### Allowed values

| Field                  | Allowed values                           |
| ---------------------- | ---------------------------------------- |
| `payload.api_key_type` | `PUBLIC`, `N8N`, `MAKE`, `ZAPIER`, `MCP` |

<details>
  <summary>Show raw input schema</summary>

  ### Input JSON Schema

  ```json theme={null}
  {
    "type": "object",
    "description": "HeyReach create workspace API key input.",
    "properties": {
      "workspace_id": {
        "description": "Numeric id as integer or numeric string.",
        "anyOf": [
          {
            "type": "integer",
            "minimum": 1
          },
          {
            "type": "string",
            "minLength": 1,
            "pattern": "^\\d+$"
          }
        ]
      },
      "api_key_type": {
        "type": "string",
        "enum": [
          "PUBLIC",
          "N8N",
          "MAKE",
          "ZAPIER",
          "MCP"
        ]
      }
    },
    "required": [
      "workspace_id",
      "api_key_type"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Output Schema

| Name            | Type     | Required | Default | Description |
| --------------- | -------- | -------- | ------- | ----------- |
| `result.status` | `string` | Yes      |         |             |
| `result.result` | `object` | Yes      |         |             |

<details>
  <summary>Show raw output schema</summary>

  ### Output JSON Schema

  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "status": {
        "type": "string"
      },
      "result": {
        "type": "object",
        "properties": {
          "key": {
            "type": "string"
          },
          "previousKeyStatus": {
            "type": "string"
          }
        },
        "required": [
          "key",
          "previousKeyStatus"
        ],
        "additionalProperties": true
      }
    },
    "required": [
      "status",
      "result"
    ],
    "additionalProperties": true
  }
  ```
</details>

## Advanced: Direct CLI

<Info>
  Use direct execution for single payload debugging.
</Info>

```bash theme={null}
deepline tools execute heyreach_create_workspace_api_key --payload '{
  "workspace_id": "integer",
  "api_key_type": "PUBLIC"
}' --json
```

### CLI flags

| Flag                        | Description                                         |
| --------------------------- | --------------------------------------------------- |
| `--json`                    | Print machine-readable output.                      |
| `--wait`                    | Wait for terminal provider status when supported.   |
| `--debug`                   | Enable wait mode with additional status/log output. |
| `--wait-timeout SECONDS`    | Max seconds to wait in wait mode.                   |
| `--poll-interval SECONDS`   | Polling interval in seconds during wait mode.       |
| `--timeout SECONDS`         | Request timeout in seconds.                         |
| `--connect-timeout SECONDS` | Connection timeout in seconds.                      |

## Cost

* Pricing model: `fixed` (per call).
* Estimated Deepline credits: `0` per pricing unit.
* Provider-native pricing may still exist outside Deepline credit billing.
* Billing mode: `no_bill`.