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

# Instantly: Patch Campaign

> Update an Instantly campaign's name, schedule, sequence steps, sending accounts, or other settings. Includes SDK V2 examples, schemas, and cost.

Update an Instantly campaign's name, schedule, sequence steps, sending accounts, or other settings.

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

## 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(
  'instantly_patch_campaign',
  {
    "id": "id_123",
    "campaign_id": "campaign_123",
    "updates": {
      "name": "Example",
      "pl_value": 1,
      "is_evergreen": true
    }
  },
);

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

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute instantly_patch_campaign --input '{
  "id": "id_123",
  "campaign_id": "campaign_123",
  "updates": {
    "name": "Example",
    "pl_value": 1,
    "is_evergreen": true
  }
}' --json
```

## Example response

The static output schema lacks the details for a reliable example. Use `deepline describe instantly_patch_campaign --json` for the complete live contract.

## Input reference

Patch an Instantly campaign by id.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.id` | `string` | No | — | Minimum length: 1. |
| `payload.campaign_id` | `string` | No | — | Minimum length: 1. |
| `payload.updates` | `object` | No | — | — |
| `payload.name` | `string` | No | — | Minimum length: 1. |
| `payload.pl_value` | `number` | No | — | — |
| `payload.is_evergreen` | `boolean` | No | — | — |
| `payload.campaign_schedule` | `object` | No | — | — |
| `payload.sequences` | `array` | No | — | Minimum items: 1. |
| `payload.email_list` | `array` | No | — | Minimum items: 1. |
| `payload.email_gap` | `number` | No | — | — |
| `payload.random_wait_max` | `number` | No | — | — |
| `payload.text_only` | `boolean` | No | — | — |
| `payload.first_email_text_only` | `boolean` | No | — | — |
| `payload.stop_on_reply` | `boolean` | No | — | — |
| `payload.stop_on_auto_reply` | `boolean` | No | — | — |
| `payload.daily_limit` | `integer` | No | — | Minimum: 1. |
| `payload.daily_max_leads` | `integer` | No | — | Minimum: 1. |
| `payload.email_tag_list` | `array` | No | — | Minimum items: 1. |
| `payload.cc_list` | `array` | No | — | Minimum items: 1. |
| `payload.bcc_list` | `array` | No | — | Minimum items: 1. |
| `payload.link_tracking` | `boolean` | No | — | — |
| `payload.open_tracking` | `boolean` | No | — | — |
| `payload.prioritize_new_leads` | `boolean` | No | — | — |
| `payload.match_lead_esp` | `boolean` | No | — | — |
| `payload.stop_for_company` | `boolean` | No | — | — |
| `payload.owned_by` | `string` | No | — | Minimum length: 1. |
| `payload.insert_unsubscribe_header` | `boolean` | No | — | — |
| `payload.allow_risky_contacts` | `boolean` | No | — | — |
| `payload.disable_bounce_protect` | `boolean` | No | — | — |
| `payload.auto_variant_select` | `object` | No | — | — |
| `payload.limit_emails_per_company_override` | `object` | No | — | — |
| `payload.provider_routing_rules` | `array` | No | — | Minimum items: 1. |

> [!NOTE]
>
> This input schema is too large for an inline display. Read the complete live contract with `deepline describe instantly_patch_campaign --json`.

## Output reference

Raw Instantly patch campaign response.

The static output schema is not available. Run `deepline describe instantly_patch_campaign --json` for the live contract.

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

  ### Output JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "description": "Raw Instantly patch campaign response."
  }
  ```
</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

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