Instantly: Campaign Management

Updating an Instantly campaign with a flexible patch payload.

Tool ID: instantly_patch_campaign

Run this action

Use the TypeScript SDK for a single call. Put ctx.tools.execute(...) inside a Play when the call should be durable, scheduled, or run across a CSV.

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

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 is not detailed enough to generate a reliable example. Use deepline tools get 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.

This input schema is too large to embed without slowing the page. Get the complete live contract with deepline tools get instantly_patch_campaign --json.

Output reference

Raw Instantly patch campaign response. The static output schema is not available. Run deepline tools get instantly_patch_campaign --json for the live contract.

Deepline cost

Pricing model: fixed (per call).
Estimated Deepline credits: 0 per pricing unit.
Provider-native pricing may still exist outside Deepline credit billing.

Getting Started

GTM is code

Features

Deepline SDK beta

Integrations

API Reference

Instantly: Campaign Management

Run this action

CLI

Example response

Input reference

Output reference

Deepline cost

​Run this action

​CLI

​Example response

​Input reference

​Output reference

​Deepline cost

​Related documentation

Run this action

CLI

Example response

Input reference

Output reference

Deepline cost

Related documentation