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

> Invite people by email as admins of your HeyReach organization. Includes SDK V2 guidance, input constraints, response fields, and Deepline credit cost.

Invite people by email as admins of your HeyReach organization.

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

## 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_admins',
  {
    "inviter_email": "jane.doe@example.com",
    "emails": [
      "jane.doe@example.com"
    ]
  },
);

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

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute heyreach_invite_admins --input '{
  "inviter_email": "jane.doe@example.com",
  "emails": [
    "jane.doe@example.com"
  ]
}' --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": [
    {
      "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_admins --json` for the latest machine-readable contract.

## Input reference

HeyReach invite admins input.

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

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

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "HeyReach invite admins input.",
    "properties": {
      "inviter_email": {
        "type": "string",
        "minLength": 1,
        "maxLength": 320
      },
      "emails": {
        "type": "array",
        "minItems": 1,
        "items": {
          "type": "string",
          "minLength": 1,
          "maxLength": 320
        }
      }
    },
    "required": [
      "inviter_email",
      "emails"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `result.status` | `string` | Yes | — | — |
| `result.result` | `array` | Yes | — | — |
| `result.result[].success` | `boolean` | Yes | — | — |
| `result.result[].errorCode` | `string` | Yes | — | — |
| `result.result[].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": {
            "success": {
              "type": "boolean"
            },
            "errorCode": {
              "type": "string"
            },
            "errorMessage": {
              "type": "null"
            },
            "invitationId": {
              "type": "integer"
            },
            "invitationStatus": {
              "type": "string"
            },
            "invitationUrl": {
              "type": "string"
            },
            "invitationExpirationTime": {
              "type": "string"
            },
            "emailAddress": {
              "type": "string"
            }
          },
          "required": [
            "success",
            "errorCode",
            "errorMessage",
            "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.