> ## 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: Import Leads By Ids

> Add existing leads to a campaign by lead ID. Includes SDK V2 guidance, input constraints, response fields, and Deepline credit cost.

Add existing leads to a campaign by lead ID.

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

## 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(
  'emailbison_import_leads_by_ids',
  {
    "campaign_id": 123,
    "lead_ids": [
      123
    ]
  },
);

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

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute emailbison_import_leads_by_ids --input '{
  "campaign_id": 123,
  "lead_ids": [
    123
  ]
}' --json
```

## Example response

The SDK returns this shape at `result.toolResponse.raw`. The example values illustrate the response.

```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
{
  "data": {
    "data": {
      "success": true,
      "message": "Example message"
    }
  }
}
```

Use `deepline describe emailbison_import_leads_by_ids --json` for the latest machine-readable contract.

## Input reference

This endpoint allows the authenticated user to import leads by their IDs into a campaign. If you are adding leads to an active campaign, we cache them locally, and then sync every 5 minutes to ensure there is no interruption to your sending. **Important:** If you add leads into a "reply followup campaign" using this endpoint, we will just start the conversation from **the last sent reply**. We recommend that you use the more explicit `/replies/id/followup-campaign/push` endpoint to control exactly which conversation you want to follow up on.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.campaign_id` | `integer` | Yes | — | The ID of the campaign. |
| `payload.allow_parallel_sending` | `boolean` | No | — | Force add leads that are "In Sequence" in other campaigns. |
| `payload.lead_ids` | `array` | Yes | — | An array of lead IDs to import. |

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

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "This endpoint allows the authenticated user to import leads by their IDs into a campaign. If you are adding leads to an active campaign, we cache them locally, and then sync every 5 minutes to ensure there is no interruption to your sending. **Important:** If you add leads into a \"reply followup campaign\" using this endpoint, we will just start the conversation from **the last sent reply**. We recommend that you use the more explicit `/replies/id/followup-campaign/push` endpoint to control exactly which conversation you want to follow up on.",
    "properties": {
      "campaign_id": {
        "type": "integer",
        "description": "The ID of the campaign."
      },
      "allow_parallel_sending": {
        "type": "boolean",
        "description": "Force add leads that are \"In Sequence\" in other campaigns."
      },
      "lead_ids": {
        "type": "array",
        "description": "An array of lead IDs to import.",
        "items": {
          "type": "integer"
        }
      }
    },
    "required": [
      "campaign_id",
      "lead_ids"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

Standard tool result payload.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `result.data` | `object` | Yes | — | Provider response payload. |
| `result.data.data` | `object` | No | — | — |
| `result.data.data.success` | `boolean` | No | — | — |
| `result.data.data.message` | `string` | No | — | — |
| `result.meta` | `object` | No | — | Additional response metadata (status, paging). |

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

  ### Output JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Standard tool result payload.",
    "properties": {
      "data": {
        "type": "object",
        "description": "Provider response payload.",
        "properties": {
          "data": {
            "type": "object",
            "properties": {
              "success": {
                "type": "boolean"
              },
              "message": {
                "type": "string"
              }
            },
            "additionalProperties": false
          }
        },
        "additionalProperties": false
      },
      "meta": {
        "type": "object",
        "description": "Additional response metadata (status, paging).",
        "additionalProperties": true
      }
    },
    "required": [
      "data"
    ],
    "additionalProperties": false
  }
  ```
</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

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