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

> This endpoint allows the authenticated user to update the settings of a campaign. Includes inputs, outputs, costs, and Deepline CLI examples for GTM automation.

## 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_update_campaign_settings:{"id":"{{id}}"}' --json
```

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

## Input Schema

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

| Field                             | Allowed values           |
| --------------------------------- | ------------------------ |
| `payload.sequence_prioritization` | `followups`, `new_leads` |

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

  ### Input JSON Schema

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

| Name          | Type     | Required | Default | Description                                    |
| ------------- | -------- | -------- | ------- | ---------------------------------------------- |
| `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={null}
  {
    "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>

## Advanced: Direct CLI

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

```bash theme={null}
deepline tools execute emailbison_update_campaign_settings --payload '{
  "id": "integer"
}' --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`.