> ## 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: Add To Campaign

> Add leads to an Instantly campaign, optionally skipping people already in the workspace or campaign. Includes SDK V2 examples, schemas, and cost.

Add leads to an Instantly campaign, optionally skipping people already in the workspace or campaign.

> [!NOTE]
>
> Tool ID: `instantly_add_to_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_add_to_campaign',
  {
    "campaign_id": "campaign_123",
    "leads": [
      {
        "email": "jane.doe@example.com"
      }
    ]
  },
);

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

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute instantly_add_to_campaign --input '{
  "campaign_id": "campaign_123",
  "leads": [
    {
      "email": "jane.doe@example.com"
    }
  ]
}' --json
```

## Example response

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

## Input reference

Instantly add to campaign input.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.campaign_id` | `string` | Yes | — | Minimum length: 1. |
| `payload.leads` | `array` | Yes | — | Minimum items: 1. Maximum items: 1000. |
| `payload.skip_if_in_workspace` | `boolean` | No | — | Skip lead if already in workspace. |
| `payload.skip_if_in_campaign` | `boolean` | No | — | Skip lead if already in this campaign. |

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

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Instantly add to campaign input.",
    "properties": {
      "campaign_id": {
        "type": "string",
        "minLength": 1
      },
      "leads": {
        "type": "array",
        "minItems": 1,
        "maxItems": 1000,
        "items": {
          "type": "object",
          "properties": {
            "email": {
              "type": "string",
              "description": "Lead email address. Will be trimmed and lowercased.",
              "minLength": 1
            },
            "first_name": {
              "type": "string",
              "minLength": 1
            },
            "last_name": {
              "type": "string",
              "minLength": 1
            },
            "company_name": {
              "type": "string",
              "minLength": 1
            },
            "website": {
              "type": "string",
              "minLength": 1
            },
            "linkedin_url": {
              "type": "string",
              "minLength": 1
            },
            "job_title": {
              "type": "string",
              "minLength": 1
            },
            "phone": {
              "type": "string",
              "minLength": 1
            },
            "personalization": {
              "type": "string",
              "minLength": 1,
              "allowsTemplatePlaceholders": true
            },
            "personalized_subject": {
              "type": "string",
              "minLength": 1,
              "allowsTemplatePlaceholders": true
            },
            "custom_variables": {
              "type": "object",
              "additionalProperties": {
                "anyOf": [
                  {
                    "type": "string"
                  },
                  {
                    "type": "number"
                  },
                  {
                    "type": "boolean"
                  }
                ]
              }
            }
          },
          "required": [
            "email"
          ],
          "additionalProperties": false
        }
      },
      "skip_if_in_workspace": {
        "type": "boolean",
        "description": "Skip lead if already in workspace."
      },
      "skip_if_in_campaign": {
        "type": "boolean",
        "description": "Skip lead if already in this campaign."
      }
    },
    "required": [
      "campaign_id",
      "leads"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

Raw Instantly add-to-campaign response.

The static output schema is not available. Run `deepline describe instantly_add_to_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 add-to-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.