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

# EmailBison: Invite Team Member API Workspaces V1 1 Invite Members

> Invite a new team member by email and role. Includes SDK V2 guidance, input constraints, response fields, and Deepline credit cost.

Invite a new team member by email and role.

> [!NOTE]
>
> Tool ID: `emailbison_invite_team_member_api_workspaces_v1_1_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(
  'emailbison_invite_team_member_api_workspaces_v1_1_invite_members',
  {
    "email": "jane.doe@example.com",
    "role": "admin"
  },
);

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

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute emailbison_invite_team_member_api_workspaces_v1_1_invite_members --input '{
  "email": "jane.doe@example.com",
  "role": "admin"
}' --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"]}}
{
  "data": {
    "data": {
      "id": 123,
      "uuid": "uuid_123",
      "workspace_id": 123
    }
  }
}
```

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

## Input reference

This endpoint allows the authenticated user to invite a new member to their team. The user must provide a valid authentication token in the request header and the email and role of the new team member in the request body.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.email` | `string` | Yes | — | The email of the new team member. |
| `payload.role` | `"admin" \| "editor" \| "client" \| "reseller"` | Yes | — | The role of the new team member. Allowed: `admin`, `editor`, `client`, `reseller`. |

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

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "This endpoint allows the authenticated user to invite a new member to their team. The user must provide a valid authentication token in the request header and the email and role of the new team member in the request body.",
    "properties": {
      "email": {
        "type": "string",
        "description": "The email of the new team member."
      },
      "role": {
        "type": "string",
        "description": "The role of the new team member.",
        "enum": [
          "admin",
          "editor",
          "client",
          "reseller"
        ]
      }
    },
    "required": [
      "email",
      "role"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

Standard tool result payload.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `result.data` | `object` | Yes | — | Provider response payload. |
| `result.data.data` | `object` | No | — | — |
| `result.data.data.id` | `integer` | No | — | — |
| `result.data.data.uuid` | `string` | No | — | — |
| `result.data.data.workspace_id` | `integer` | No | — | — |
| `result.data.data.email` | `string` | No | — | — |
| `result.data.data.role` | `string` | No | — | — |
| `result.data.data.created_at` | `string` | No | — | — |
| `result.data.data.updated_at` | `string` | No | — | — |
| `result.meta` | `object` | No | — | Additional response metadata (status, paging). |

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

  ### Output JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Standard tool result payload.",
    "properties": {
      "data": {
        "type": "object",
        "description": "Provider response payload.",
        "properties": {
          "data": {
            "type": "object",
            "properties": {
              "id": {
                "type": "integer"
              },
              "uuid": {
                "type": "string"
              },
              "workspace_id": {
                "type": "integer"
              },
              "email": {
                "type": "string"
              },
              "role": {
                "type": "string"
              },
              "created_at": {
                "type": "string"
              },
              "updated_at": {
                "type": "string"
              }
            },
            "additionalProperties": false
          }
        },
        "additionalProperties": false
      },
      "meta": {
        "type": "object",
        "description": "Additional response metadata (status, paging).",
        "additionalProperties": true
      }
    },
    "required": [
      "data"
    ],
    "additionalProperties": false
  }
  ```
</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

* [EmailBison provider guide](https://deepline.com/docs/providers/emailbison/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.