> ## 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: Inputs, Cost &

> 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

## 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=emailbison_create_userand_add_to_workspace:{"name":"{{name}}","password":"{{password}}","email":"{{email}}","role":"admin"}' --json
```

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

## Input Schema

| Name               | Type                                            | Required | Default | Description                      |
| ------------------ | ----------------------------------------------- | -------- | ------- | -------------------------------- |
| `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 values

| Field          | Allowed values                          |
| -------------- | --------------------------------------- |
| `payload.role` | `admin`, `editor`, `client`, `reseller` |

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

  ### Input JSON Schema

  ```json theme={null}
  {
    "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 Schema

| Name          | Type     | Required | Default | Description                                    |
| ------------- | -------- | -------- | ------- | ---------------------------------------------- |
| `result.data` | `object` | Yes      |         | Provider response payload.                     |
| `result.meta` | `object` | No       |         | Additional response metadata (status, paging). |

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

  ### Output JSON Schema

  ```json theme={null}
  {
    "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>

## Advanced: Direct CLI

<Info>
  Use direct execution for single payload debugging.
</Info>

```bash theme={null}
deepline tools execute emailbison_create_userand_add_to_workspace --payload '{
  "name": "string",
  "password": "string",
  "email": "string",
  "role": "admin"
}' --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`.
