> ## 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: Update Campaign Settings

> Change an EmailBison campaign's name, daily limits, tracking and plain-text settings. Includes inputs, outputs, SDK V2 examples, and Deepline cost.

Change an EmailBison campaign's name, daily limits, tracking and plain-text settings.

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

## 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_update_campaign_settings',
  {
    "id": 123
  },
);

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

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute emailbison_update_campaign_settings --input '{
  "id": 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": "example"
}
```

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

## Input reference

This endpoint allows the authenticated user to update the settings of a campaign.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.id` | `integer` | Yes | — | The ID of the campaign. |
| `payload.name` | `string` | No | — | The name of the campaign. |
| `payload.max_emails_per_day` | `integer` | No | — | The maximum number of emails that can be sent per day. |
| `payload.max_new_leads_per_day` | `integer` | No | — | The maximum number of new leads that can be added per day. |
| `payload.plain_text` | `boolean` | No | — | Whether the email content should be plain text. If nothing sent, false is assumed. |
| `payload.open_tracking` | `boolean` | No | — | Whether open tracking should be enabled for the campaign. If nothing sent, false is assumed. |
| `payload.reputation_building` | `boolean` | No | — | Spam protection. If nothing sent, false is assumed. |
| `payload.can_unsubscribe` | `boolean` | No | — | Whether recipients can unsubscribe from the campaign using a one-click link. If nothing sent, false is assumed. |
| `payload.include_auto_replies_in_stats` | `boolean` | No | — | If auto replies should be included in the campaign stats. This setting is not retroactive. |
| `payload.sequence_prioritization` | `"followups" \| "new_leads"` | No | — | How the campaign sequence should be prioritized. By default, followups are prioritized. Allowed: `followups`, `new_leads`. |

<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 update the settings of a campaign.",
    "properties": {
      "id": {
        "type": "integer",
        "description": "The ID of the campaign."
      },
      "name": {
        "type": [
          "string",
          "null"
        ],
        "description": "The name of the campaign."
      },
      "max_emails_per_day": {
        "type": [
          "integer",
          "null"
        ],
        "description": "The maximum number of emails that can be sent per day."
      },
      "max_new_leads_per_day": {
        "type": [
          "integer",
          "null"
        ],
        "description": "The maximum number of new leads that can be added per day."
      },
      "plain_text": {
        "type": [
          "boolean",
          "null"
        ],
        "description": "Whether the email content should be plain text. If nothing sent, false is assumed."
      },
      "open_tracking": {
        "type": [
          "boolean",
          "null"
        ],
        "description": "Whether open tracking should be enabled for the campaign. If nothing sent, false is assumed."
      },
      "reputation_building": {
        "type": [
          "boolean",
          "null"
        ],
        "description": "Spam protection. If nothing sent, false is assumed."
      },
      "can_unsubscribe": {
        "type": [
          "boolean",
          "null"
        ],
        "description": "Whether recipients can unsubscribe from the campaign using a one-click link. If nothing sent, false is assumed."
      },
      "include_auto_replies_in_stats": {
        "type": [
          "boolean",
          "null"
        ],
        "description": "If auto replies should be included in the campaign stats. This setting is not retroactive."
      },
      "sequence_prioritization": {
        "type": "string",
        "description": "How the campaign sequence should be prioritized. By default, followups are prioritized.",
        "enum": [
          "followups",
          "new_leads"
        ]
      }
    },
    "required": [
      "id"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

Standard tool result payload.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `result.data` | `string` | 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={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Standard tool result payload.",
    "properties": {
      "data": {
        "type": "string",
        "description": "Provider response payload."
      },
      "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.