> ## 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

> Invite people by email as members of HeyReach workspaces with chosen permissions. Includes inputs, outputs, SDK V2 examples, and Deepline cost.

Invite people by email as members of HeyReach workspaces with chosen permissions.

> [!NOTE]
>
> Tool ID: `heyreach_invite_members`

## Run this action

Use the TypeScript SDK for one call. Use `ctx.tools.execute(...)` inside a Play for durable calls, scheduled calls, or CSV processing.

```ts theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'heyreach_invite_members',
  {
    "inviter_email": "jane.doe@example.com",
    "emails": [
      "jane.doe@example.com"
    ],
    "workspace_ids": [
      123
    ],
    "permissions": {
      "viewLinkedInSenders": true,
      "manageLinkedInSendersSettings": true,
      "viewLeadLists": true
    }
  },
);

console.log(result.toolResponse.raw);
```

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute heyreach_invite_members --input '{
  "inviter_email": "jane.doe@example.com",
  "emails": [
    "jane.doe@example.com"
  ],
  "workspace_ids": [
    123
  ],
  "permissions": {
    "viewLinkedInSenders": true,
    "manageLinkedInSendersSettings": true,
    "viewLeadLists": true
  }
}' --json
```

## Example response

The SDK returns this shape at `result.toolResponse.raw`. The example values illustrate the response.

```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
{
  "status": "example",
  "result": [
    {
      "workspaces": [
        {
          "workspaceId": 123,
          "success": true,
          "errorCode": "example",
          "errorMessage": null
        }
      ],
      "invitationId": 123,
      "invitationStatus": "example",
      "invitationUrl": "https://example.com",
      "invitationExpirationTime": "example",
      "emailAddress": "jane.doe@example.com"
    }
  ]
}
```

Use `deepline describe heyreach_invite_members --json` for the latest machine-readable contract.

## Input reference

HeyReach invite members input.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.inviter_email` | `string` | Yes | — | Minimum length: 1. Maximum length: 320. |
| `payload.emails` | `array` | Yes | — | Minimum items: 1. |
| `payload.workspace_ids` | `array` | Yes | — | Minimum items: 1. |
| `payload.permissions` | `object` | Yes | — | — |

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

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "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 reference

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `result.status` | `string` | Yes | — | — |
| `result.result` | `array` | Yes | — | — |
| `result.result[].workspaces` | `array` | Yes | — | — |
| `result.result[].workspaces[].workspaceId` | `integer` | Yes | — | — |
| `result.result[].workspaces[].success` | `boolean` | Yes | — | — |
| `result.result[].workspaces[].errorCode` | `string` | Yes | — | — |
| `result.result[].workspaces[].errorMessage` | `null` | Yes | — | — |
| `result.result[].invitationId` | `integer` | Yes | — | — |
| `result.result[].invitationStatus` | `string` | Yes | — | — |
| `result.result[].invitationUrl` | `string` | Yes | — | — |
| `result.result[].invitationExpirationTime` | `string` | Yes | — | — |
| `result.result[].emailAddress` | `string` | Yes | — | — |

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

  ### Output JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "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>

## Deepline cost

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

## Related documentation

* [HeyReach provider guide](https://deepline.com/docs/providers/heyreach/guide.md)
* [SDK V2 quickstart](https://deepline.com/docs/sdk-v2/quickstart.md)
* [SDK reference](https://deepline.com/docs/sdk-v2/sdk-reference.md)
* [Run tools across a CSV](https://deepline.com/docs/sdk-v2/batch-csv.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.