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

# Findymail: Add Excluded Domains

> Add domains to a Findymail exclusion list so they are skipped in searches. Includes SDK V2 examples, input constraints, response fields, and Deepline cost.

Add domains to a Findymail exclusion list so they are skipped in searches.

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

## 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(
  'findymail_add_excluded_domains',
  {
    "domains": [
      "example.com"
    ]
  },
);

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

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute findymail_add_excluded_domains --input '{
  "domains": [
    "example.com"
  ]
}' --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,
    "total": 123,
    "processed_immediately": 123
  }
}
```

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

## Input reference

Adds one or more domains to the user's exclusion list. If list\_id is provided, domains are added to that specific list. For large batches (>50 domains), the first 50 are processed immediately and the rest are queued for background processing.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.domains` | `array` | Yes | — | Array of domain names to exclude (max 10000). |
| `payload.list_id` | `integer` | No | — | Optional list ID to add domains to. If not provided, domains are added as global exclusions. |

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

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Adds one or more domains to the user's exclusion list. If list_id is provided, domains are added to that specific list. For large batches (>50 domains), the first 50 are processed immediately and the rest are queued for background processing.",
    "properties": {
      "domains": {
        "type": "array",
        "description": "Array of domain names to exclude (max 10000).",
        "items": {
          "type": "string"
        }
      },
      "list_id": {
        "type": "integer",
        "description": "Optional list ID to add domains to. If not provided, domains are added as global exclusions."
      }
    },
    "required": [
      "domains"
    ],
    "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.total` | `integer` | No | — | — |
| `result.data.processed_immediately` | `integer` | No | — | — |
| `result.data.queued` | `integer` | No | — | — |
| `result.data.list_id` | `integer` | 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"
          },
          "total": {
            "type": "integer"
          },
          "processed_immediately": {
            "type": "integer"
          },
          "queued": {
            "type": "integer"
          },
          "list_id": {
            "type": "integer"
          }
        },
        "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

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