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

# Salesforge: Patch Workspaces Workspaceid Mailboxes Mailboxid

> Update the operational settings of a sending mailbox in Salesforge. Includes SDK V2 guidance, input constraints, response fields, and Deepline credit cost.

Update the operational settings of a sending mailbox in Salesforge.

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

## 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(
  'salesforge_patch_workspaces_workspaceid_mailboxes_mailboxid',
  {
    "workspaceID": "workspace_123",
    "mailboxID": "mailbox_123"
  },
);

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

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute salesforge_patch_workspaces_workspaceid_mailboxes_mailboxid --input '{
  "workspaceID": "workspace_123",
  "mailboxID": "mailbox_123"
}' --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": {
    "address": "example",
    "dailyEmailLimit": 123,
    "disconnectReason": "example"
  }
}
```

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

## Input reference

Update mailbox operational settings.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.workspaceID` | `string` | Yes | — | Workspace ID |
| `payload.mailboxID` | `string` | Yes | — | Mailbox ID |

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

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Update mailbox operational settings.",
    "properties": {
      "workspaceID": {
        "type": "string",
        "description": "Workspace ID"
      },
      "mailboxID": {
        "type": "string",
        "description": "Mailbox ID"
      }
    },
    "required": [
      "workspaceID",
      "mailboxID"
    ],
    "additionalProperties": true
  }
  ```
</details>

## Output reference

Standard tool result payload.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `result.data` | `object` | Yes | — | Provider response payload. |
| `result.data.address` | `string` | No | — | — |
| `result.data.dailyEmailLimit` | `integer` | No | — | — |
| `result.data.disconnectReason` | `string` | No | — | — |
| `result.data.firstName` | `string` | No | — | — |
| `result.data.id` | `string` | No | — | — |
| `result.data.lastName` | `string` | No | — | — |
| `result.data.mailboxProvider` | `"gmail" \| "outlook" \| "smtp"` | No | — | Allowed: `gmail`, `outlook`, `smtp`. |
| `result.data.signature` | `string` | No | — | — |
| `result.data.status` | `"active" \| "frozen" \| "access_lost" \| "deleted" \| "inactive" \| "pending" \| "suspended"` | No | — | Allowed: `active`, `frozen`, `access_lost`, `deleted`, `inactive`, `pending`, `suspended`. |
| `result.data.trackingDomain` | `string` | No | — | — |
| `result.data.trackingDomainStatus` | `"active" \| "pending"` | No | — | Allowed: `active`, `pending`. |
| `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": {
          "address": {
            "type": "string"
          },
          "dailyEmailLimit": {
            "type": "integer"
          },
          "disconnectReason": {
            "type": "string"
          },
          "firstName": {
            "type": "string"
          },
          "id": {
            "type": "string"
          },
          "lastName": {
            "type": "string"
          },
          "mailboxProvider": {
            "type": "string",
            "enum": [
              "gmail",
              "outlook",
              "smtp"
            ]
          },
          "signature": {
            "type": "string"
          },
          "status": {
            "type": "string",
            "enum": [
              "active",
              "frozen",
              "access_lost",
              "deleted",
              "inactive",
              "pending",
              "suspended"
            ]
          },
          "trackingDomain": {
            "type": "string"
          },
          "trackingDomainStatus": {
            "type": "string",
            "enum": [
              "active",
              "pending"
            ]
          }
        },
        "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

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