> ## 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 Invite Members: Inputs, Cost & CLI Example

> Inviting member users with workspace permissions to a HeyReach organization. Includes inputs, outputs, costs, and Deepline CLI examples for GTM automation.

## 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_invite_members:{"inviter_email":"{{inviter_email}}","emails":"{{emails}}","workspace_ids":"{{workspace_ids}}","permissions":{}}' --json
```

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

## Input Schema

| Name                    | Type     | Required | Default | Description |
| ----------------------- | -------- | -------- | ------- | ----------- |
| `payload.inviter_email` | `string` | Yes      |         |             |
| `payload.emails`        | `array`  | Yes      |         |             |
| `payload.workspace_ids` | `array`  | Yes      |         |             |
| `payload.permissions`   | `object` | Yes      |         |             |

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

  ### Input JSON Schema

  ```json theme={null}
  {
    "type": "object",
    "description": "HeyReach invite members input.",
    "properties": {
      "inviter_email": {
        "type": "string",
        "minLength": 1,
        "maxLength": 320
      },
      "emails": {
        "type": "array",
        "minItems": 1,
        "items": {
          "type": "string",
          "minLength": 1,
          "maxLength": 320
        }
      },
      "workspace_ids": {
        "type": "array",
        "minItems": 1,
        "items": {
          "description": "Numeric id as integer or numeric string.",
          "anyOf": [
            {
              "type": "integer",
              "minimum": 1
            },
            {
              "type": "string",
              "minLength": 1,
              "pattern": "^\\d+$"
            }
          ]
        }
      },
      "permissions": {
        "type": "object",
        "properties": {
          "viewLinkedInSenders": {
            "type": "boolean"
          },
          "manageLinkedInSendersSettings": {
            "type": "boolean"
          },
          "viewLeadLists": {
            "type": "boolean"
          },
          "importEditManageLeadLists": {
            "type": "boolean"
          },
          "viewMyNetwork": {
            "type": "boolean"
          },
          "viewCampaigns": {
            "type": "boolean"
          },
          "editManageCampaigns": {
            "type": "boolean"
          },
          "viewLinkedInSenderInboxes": {
            "type": "boolean"
          },
          "replyFromLinkedInSenderInboxes": {
            "type": "boolean"
          },
          "viewIntegrations": {
            "type": "boolean"
          },
          "manageIntegrations": {
            "type": "boolean"
          },
          "exportDataToCRMs": {
            "type": "boolean"
          },
          "viewNotifications": {
            "type": "boolean"
          },
          "manageNotifications": {
            "type": "boolean"
          }
        },
        "additionalProperties": false
      }
    },
    "required": [
      "inviter_email",
      "emails",
      "workspace_ids",
      "permissions"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Output Schema

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

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

  ### Output JSON Schema

  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "status": {
        "type": "string"
      },
      "result": {
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "workspaces": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "workspaceId": {
                    "type": "integer"
                  },
                  "success": {
                    "type": "boolean"
                  },
                  "errorCode": {
                    "type": "string"
                  },
                  "errorMessage": {
                    "type": "null"
                  }
                },
                "required": [
                  "workspaceId",
                  "success",
                  "errorCode",
                  "errorMessage"
                ],
                "additionalProperties": true
              }
            },
            "invitationId": {
              "type": "integer"
            },
            "invitationStatus": {
              "type": "string"
            },
            "invitationUrl": {
              "type": "string"
            },
            "invitationExpirationTime": {
              "type": "string"
            },
            "emailAddress": {
              "type": "string"
            }
          },
          "required": [
            "workspaces",
            "invitationId",
            "invitationStatus",
            "invitationUrl",
            "invitationExpirationTime",
            "emailAddress"
          ],
          "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_invite_members --payload '{
  "inviter_email": "string",
  "emails": "array",
  "workspace_ids": "array",
  "permissions": {}
}' --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`.