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

# Emailguard Update Workspace: Inputs, Cost & CLI Example

> Update Workspace. Emailguard Emailguard Update Workspace docs include request fields, response shape, pricing notes, and Deepline CLI examples.

## 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=emailguard_update_workspace:{"team_id":"{{team_id}}","name":"{{name}}"}' --json
```

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

## Input Schema

| Name              | Type      | Required | Default | Description              |
| ----------------- | --------- | -------- | ------- | ------------------------ |
| `payload.team_id` | `integer` | Yes      |         | The ID of the workspace. |
| `payload.name`    | `string`  | Yes      |         | The new workspace name.  |

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

  ### Input JSON Schema

  ```json theme={null}
  {
    "type": "object",
    "description": "This endpoint allows the authenticated user to update their workspace information, specifically the workspace name. The user must provide a valid authentication token in the request header and the ID of the target workspace, along with the details of the new workspace in the request body to access this endpoint.",
    "properties": {
      "team_id": {
        "type": "integer",
        "description": "The ID of the workspace."
      },
      "name": {
        "type": "string",
        "description": "The new workspace name."
      }
    },
    "required": [
      "team_id",
      "name"
    ],
    "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"
              },
              "remaining_email_accounts": {
                "type": "integer"
              },
              "total_email_accounts": {
                "type": "integer"
              },
              "remaining_domains": {
                "type": "integer"
              },
              "total_domains": {
                "type": "integer"
              },
              "remaining_inbox_placement_tests": {
                "type": "integer"
              },
              "total_inbox_placement_tests": {
                "type": "integer"
              },
              "remaining_email_tests": {
                "type": "integer"
              },
              "total_email_tests": {
                "type": "integer"
              },
              "remaining_content_spam_checks": {
                "type": "integer"
              },
              "total_content_spam_checks": {
                "type": "integer"
              },
              "remaining_hosted_domain_redirects": {
                "type": "integer"
              },
              "total_hosted_domain_redirects": {
                "type": "integer"
              }
            },
            "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 emailguard_update_workspace --payload '{
  "team_id": "integer",
  "name": "string"
}' --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`.