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

# Lemlist Campaign Management: Inputs, Cost & CLI Example

> Updating Lemlist campaign settings. Includes inputs, outputs, pricing notes, Deepline CLI examples, and GTM automation guidance.

## 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=lemlist_update_campaign:{"campaign_id":"{{campaign_id}}"}' --json
```

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

## Input Schema

| Name                             | Type      | Required | Default | Description                               |
| -------------------------------- | --------- | -------- | ------- | ----------------------------------------- |
| `payload.campaign_id`            | `string`  | Yes      |         | Campaign ID                               |
| `payload.name`                   | `string`  | No       |         | New campaign name                         |
| `payload.stop_on_email_replied`  | `boolean` | No       |         |                                           |
| `payload.stop_on_meeting_booked` | `boolean` | No       |         |                                           |
| `payload.stop_on_link_clicked`   | `boolean` | No       |         |                                           |
| `payload.disable_track_open`     | `boolean` | No       |         | Disable open tracking.                    |
| `payload.disable_track_click`    | `boolean` | No       |         | Disable click tracking.                   |
| `payload.disable_track_reply`    | `boolean` | No       |         | Disable reply tracking.                   |
| `payload.disable_out_of_office`  | `boolean` | No       |         | Disable out-of-office detection.          |
| `payload.sequence_sharing`       | `boolean` | No       |         | Enable sequence sharing.                  |
| `payload.auto_lead_interest`     | `boolean` | No       |         | Enable automatic lead interest detection. |
| `payload.send_user_ids`          | `array`   | No       |         | Sender user IDs to assign.                |

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

  ### Input JSON Schema

  ```json theme={null}
  {
    "type": "object",
    "description": "Update Lemlist campaign settings.",
    "properties": {
      "campaign_id": {
        "type": "string",
        "description": "Campaign ID",
        "minLength": 1
      },
      "name": {
        "type": "string",
        "description": "New campaign name"
      },
      "stop_on_email_replied": {
        "type": "boolean"
      },
      "stop_on_meeting_booked": {
        "type": "boolean"
      },
      "stop_on_link_clicked": {
        "type": "boolean"
      },
      "disable_track_open": {
        "type": "boolean",
        "description": "Disable open tracking."
      },
      "disable_track_click": {
        "type": "boolean",
        "description": "Disable click tracking."
      },
      "disable_track_reply": {
        "type": "boolean",
        "description": "Disable reply tracking."
      },
      "disable_out_of_office": {
        "type": "boolean",
        "description": "Disable out-of-office detection."
      },
      "sequence_sharing": {
        "type": "boolean",
        "description": "Enable sequence sharing."
      },
      "auto_lead_interest": {
        "type": "boolean",
        "description": "Enable automatic lead interest detection."
      },
      "send_user_ids": {
        "type": "array",
        "description": "Sender user IDs to assign.",
        "items": {
          "type": "string"
        }
      }
    },
    "required": [
      "campaign_id"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Output Schema

| Name            | Type     | Required | Default | Description |
| --------------- | -------- | -------- | ------- | ----------- |
| `result.status` | `string` | Yes      |         |             |
| `result.result` | `object` | Yes      |         |             |

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

  ### Output JSON Schema

  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "status": {
        "type": "string"
      },
      "result": {
        "type": "object",
        "properties": {
          "data": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string"
              },
              "name": {
                "type": "string"
              },
              "status": {
                "type": "string"
              }
            },
            "required": [
              "id",
              "name",
              "status"
            ],
            "additionalProperties": true
          }
        },
        "required": [
          "data"
        ],
        "additionalProperties": true
      }
    },
    "required": [
      "status",
      "result"
    ],
    "additionalProperties": true
  }
  ```
</details>

## Advanced: Direct CLI

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

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

## Provider API Context

<details>
  <summary>Show provider reference (optional)</summary>

  ```md theme={null}
  > Updates the settings and configuration of an existing campaign.

  # Update Campaign

  export const SnippetObjectReference = ({objectName, objectPath = null}) => {
    const lowerCaseObjectName = objectName.toLowerCase();
    if (lowerCaseObjectName === 'lead' || lowerCaseObjectName === 'leads') {
      return &lt;Note>
          This endpoint uses the &lt;a href={`/api-reference/objects-definitions/${objectPath}`}>{objectName} object&lt;/a>. Make sure to also check the &lt;a href={`/api-reference/objects-definitions/${lowerCaseObjectName === 'lead' ? 'contact' : 'lead'}`}>{lowerCaseObjectName === 'lead' ? 'Contact' : 'Lead'} object&lt;/a> to understand the distinction between the two.
        &lt;/Note>;
    }
    return &lt;Note>
        This endpoint uses the &lt;a href={`/api-reference/objects-definitions/${objectPath}`}>{objectName} object&lt;/a>.
      &lt;/Note>;
  };

  &lt;SnippetObjectReference objectName="Campaign" objectPath="campaign" />

  ## 16. Create Company Note

  Source: https://developer.lemlist.com/api-reference/endpoints/companies/create-company-note.md
  ```
</details>

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