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

# EmailGuard: Create Inbox Placement Test

> Create an inbox placement test in EmailGuard to see whether your emails land in inbox or spam. Includes inputs, outputs, SDK V2 examples, and Deepline cost.

Create an inbox placement test in EmailGuard to see whether your emails land in inbox or spam.

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

## 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(
  'emailguard_create_inbox_placement_test',
  {
    "name": "Example"
  },
);

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

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute emailguard_create_inbox_placement_test --input '{
  "name": "Example"
}' --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": {
      "uuid": "uuid_123",
      "name": "Example",
      "status": "example"
    }
  }
}
```

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

## Input reference

Create a new inbox placement test

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.name` | `string` | Yes | — | — |

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

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Create a new inbox placement test",
    "properties": {
      "name": {
        "type": "string"
      }
    },
    "required": [
      "name"
    ],
    "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.uuid` | `string` | No | — | — |
| `result.data.data.name` | `string` | No | — | — |
| `result.data.data.status` | `string` | No | — | — |
| `result.data.data.google_workspace_emails_count` | `integer` | No | — | — |
| `result.data.data.microsoft_professional_emails_count` | `integer` | No | — | — |
| `result.data.data.created_at` | `string` | No | — | — |
| `result.data.data.updated_at` | `string` | No | — | — |
| `result.data.data.completed_at` | `string` | No | — | — |
| `result.data.data.overall_score` | `string` | No | — | — |
| `result.data.data.filter_phrase` | `string` | No | — | — |
| `result.data.data.comma_separated_test_email_addresses` | `string` | No | — | — |
| `result.data.data.inbox_placement_test_emails` | `array` | No | — | — |
| `result.data.data.inbox_placement_test_emails[].uuid` | `string` | No | — | — |
| `result.data.data.inbox_placement_test_emails[].email` | `string` | No | — | — |
| `result.data.data.inbox_placement_test_emails[].provider` | `string` | No | — | — |
| `result.data.data.inbox_placement_test_emails[].sender_email_account_address` | `string` | No | — | — |
| `result.data.data.inbox_placement_test_emails[].status` | `string` | No | — | — |
| `result.data.data.inbox_placement_test_emails[].folder` | `string` | No | — | — |
| `result.data.data.inbox_placement_test_emails[].created_at` | `string` | No | — | — |
| `result.data.data.inbox_placement_test_emails[].updated_at` | `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": {
              "uuid": {
                "type": "string"
              },
              "name": {
                "type": "string"
              },
              "status": {
                "type": "string"
              },
              "google_workspace_emails_count": {
                "type": "integer"
              },
              "microsoft_professional_emails_count": {
                "type": "integer"
              },
              "created_at": {
                "type": "string"
              },
              "updated_at": {
                "type": "string"
              },
              "completed_at": {
                "type": "string"
              },
              "overall_score": {
                "type": "string"
              },
              "filter_phrase": {
                "type": "string"
              },
              "comma_separated_test_email_addresses": {
                "type": "string"
              },
              "inbox_placement_test_emails": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "uuid": {
                      "type": "string"
                    },
                    "email": {
                      "type": "string"
                    },
                    "provider": {
                      "type": "string"
                    },
                    "sender_email_account_address": {
                      "type": "string"
                    },
                    "status": {
                      "type": "string"
                    },
                    "folder": {
                      "type": "string"
                    },
                    "created_at": {
                      "type": "string"
                    },
                    "updated_at": {
                      "type": "string"
                    }
                  },
                  "additionalProperties": false
                }
              }
            },
            "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

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