> ## 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: Remove Leads From Acampaign

> Remove selected leads from an EmailBison campaign and stop future sends for those leads. Includes inputs, outputs, SDK V2 examples, and Deepline cost.

Remove selected leads from an EmailBison campaign and stop future sends for those leads.

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

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

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

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute emailbison_remove_leads_from_acampaign --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": {
    "success": true,
    "message": "Example message"
  }
}
```

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

## Input reference

This endpoint allows the authenticated user to remove leads from a campaign. **Hold on. You may not need to remove leads!** Please read carefully before attempting to delete. **I mapped the wrong custom variables for these leads** No problem! Simply re-upload the leads and we'll update the records in place. This is especially useful if you already have lead history like conversations, campaigns, etc. **I don't to email these leads in this campaign anymore** You can simply click "stop future emails" instead. If you want to stop them from being emailed in any campaign, we recommend unsubscribing these leads instead. Bulk select -> Update Status -> Unsubscribe. This way, you can preserve the lead history and stats for future reports. **I want to update these leads with more data** Instead of deleting, simply re-upload the leads. We'll update the records in place. This includes all campaign See the live schema below for the complete notes.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.campaign_id` | `integer` | Yes | — | The ID of the campaign. |
| `payload.lead_ids` | `array` | Yes | — | An array of lead IDs to remove. |

<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 remove leads from a campaign. **Hold on. You may not need to remove leads!** Please read carefully before attempting to delete. **I mapped the wrong custom variables for these leads** No problem! Simply re-upload the leads and we'll update the records in place. This is especially useful if you already have lead history like conversations, campaigns, etc. **I don't to email these leads in this campaign anymore** You can simply click \"stop future emails\" instead. If you want to stop them from being emailed in any campaign, we recommend unsubscribing these leads instead. Bulk select -> Update Status -> Unsubscribe. This way, you can preserve the lead history and stats for future reports. **I want to update these leads with more data** Instead of deleting, simply re-upload the leads. We'll update the records in place. This includes all campaign emails too. If you delete, their history in this campaign will be reset. **If you still want to remove them from the campaign, please read carefully below.** **All future scheduled emails in this campaign will be stopped (for these leads)** Your leads will no longer receive future emails from this campaign **Existing campaign stats (for these leads) will be retained** You will still be able to pull data from this campaign for all past stats (eg. emails sent, replies received, etc.) **Lead conversations will remain** You will still be able continue lead conversations through the master inbox **These leads will no longer be accessible via API (for this campaign)** You will be responsible for your automations if you rely on cached or self-stored values for these leads **Future replies for these leads will not increment stats** **If you emailed these leads and they respond in the future after being removed, stats will not be incremented** **This action is permanent and cannot be reversed** If you removed these leads by accident and try to re-add them, the history will be totally reset. This action is permanent.",
    "properties": {
      "campaign_id": {
        "type": "integer",
        "description": "The ID of the campaign."
      },
      "lead_ids": {
        "type": "array",
        "description": "An array of lead IDs to remove.",
        "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.success` | `boolean` | No | — | — |
| `result.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": {
          "success": {
            "type": "boolean"
          },
          "message": {
            "type": "string"
          }
        },
        "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.