> ## 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: Create Userand Add To Workspace

> Create a user on your instance and add them to the current workspace, without an invitation. Includes inputs, outputs, SDK V2 examples, and Deepline cost.

Create a user on your instance and add them to the current workspace, without an invitation.

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

## 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_create_userand_add_to_workspace',
  {
    "name": "Example",
    "password": "YOUR_PASSWORD",
    "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_create_userand_add_to_workspace --input '{
  "name": "Example",
  "password": "YOUR_PASSWORD",
  "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": {
      "name": "Example",
      "email": "jane.doe@example.com",
      "workspace": {
        "id": 123,
        "name": "Example",
        "personal_team": true
      }
    }
  }
}
```

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

## Input reference

This endpoint provides a convenient way to create a new user on your instance, and add them to the current workspace. This provides an alternate flow where you want to mass create users. If you simply want to invite users and have them accept the invitation, or accept it programmatically, consider using the other endpoints.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.name` | `string` | Yes | — | The name of the user |
| `payload.password` | `string` | Yes | — | The password of the user. |
| `payload.email` | `string` | Yes | — | The email of the user. |
| `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 provides a convenient way to create a new user on your instance, and add them to the current workspace. This provides an alternate flow where you want to mass create users. If you simply want to invite users and have them accept the invitation, or accept it programmatically, consider using the other endpoints.",
    "properties": {
      "name": {
        "type": "string",
        "description": "The name of the user"
      },
      "password": {
        "type": "string",
        "description": "The password of the user."
      },
      "email": {
        "type": "string",
        "description": "The email of the user."
      },
      "role": {
        "type": "string",
        "description": "The role of the new team member.",
        "enum": [
          "admin",
          "editor",
          "client",
          "reseller"
        ]
      }
    },
    "required": [
      "name",
      "password",
      "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.name` | `string` | No | — | — |
| `result.data.data.email` | `string` | No | — | — |
| `result.data.data.workspace` | `object` | No | — | — |
| `result.data.data.workspace.id` | `integer` | No | — | — |
| `result.data.data.workspace.name` | `string` | No | — | — |
| `result.data.data.workspace.personal_team` | `boolean` | No | — | — |
| `result.data.data.workspace.main` | `boolean` | No | — | — |
| `result.data.data.workspace.parent_id` | `string` | No | — | — |
| `result.data.data.workspace.warmup_filter_phrase` | `string` | No | — | — |
| `result.data.data.workspace.has_access_to_warmup` | `boolean` | No | — | — |
| `result.data.data.workspace.has_access_to_healthcheck` | `boolean` | No | — | — |
| `result.data.data.workspace.created_at` | `string` | No | — | — |
| `result.data.data.workspace.updated_at` | `string` | No | — | — |
| `result.data.data.profile_photo_path` | `string` | No | — | — |
| `result.data.data.profile_photo_url` | `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": {
              "name": {
                "type": "string"
              },
              "email": {
                "type": "string"
              },
              "workspace": {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "integer"
                  },
                  "name": {
                    "type": "string"
                  },
                  "personal_team": {
                    "type": "boolean"
                  },
                  "main": {
                    "type": "boolean"
                  },
                  "parent_id": {
                    "type": "string"
                  },
                  "warmup_filter_phrase": {
                    "type": "string"
                  },
                  "has_access_to_warmup": {
                    "type": "boolean"
                  },
                  "has_access_to_healthcheck": {
                    "type": "boolean"
                  },
                  "created_at": {
                    "type": "string"
                  },
                  "updated_at": {
                    "type": "string"
                  }
                },
                "additionalProperties": false
              },
              "profile_photo_path": {
                "type": "string"
              },
              "profile_photo_url": {
                "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.