# Test broadcasts

URL: https://docs.hanzo.ai/docs/openapi/marketing/post-marketing-broadcasts-by-id-test

> Sends the broadcast as it stands to up to five addresses, its subject marked [Test], through the same rail and footer the real send takes.

`POST /v1/marketing/broadcasts/{id}/test`

> [Marketing →](https://docs.hanzo.ai/docs/openapi/marketing) · [All API references →](https://docs.hanzo.ai/docs/openapi) · [Get started →](https://docs.hanzo.ai/docs/guides)

|               |                                                          |
| ------------- | -------------------------------------------------------- |
| **Address**   | `https://api.hanzo.ai/v1/marketing/broadcasts/{id}/test` |
| **Method**    | `POST`                                                   |
| **Operation** | `post_marketing_broadcasts_by_id_test`                   |
| **Auth**      | `Authorization: Bearer $HANZO_API_KEY`                   |

Sends the broadcast as it stands to up to five addresses, its
subject marked \[Test], through the same rail and footer the real send takes.

Org admin only.

## Request

3 fields, body `application/json` (required).

| Field | In   | Type      | Required | Description                                        |
| ----- | ---- | --------- | -------- | -------------------------------------------------- |
| `id`  | path | string    | yes      | ID is the broadcast, from the path.                |
| `id`  | body | string    | —        | ID is the broadcast, from the path.                |
| `to`  | body | string\[] | —        | To are at most five addresses to send the test to. |

## Response

| Status    | Body              | Meaning |
| --------- | ----------------- | ------- |
| `200`     | marketing.TestOut | ok      |
| `default` | problem-details   | refused |

`200` body — 3 fields.

| Field       | In   | Type      | Always | Description                                                    |
| ----------- | ---- | --------- | ------ | -------------------------------------------------------------- |
| `refused`   | body | object    | —      | Refused are the addresses the suppression list held, with why. |
| `refused.*` | body | string    | —      |                                                                |
| `sent`      | body | string\[] | —      | Sent are the addresses it went to.                             |

Failure carries the platform error shape — see [Errors](https://docs.hanzo.ai/docs/errors).

## Examples

**CLI**

```bash
hanzo marketing broadcasts test <id>
```

**SDK**

**.ts**

```ts
import { Configuration, MarketingApi } from 'hanzoai';

const api = new MarketingApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.postMarketingBroadcastsByIdTest({ id: 'id', id: "<id>", to: ["<to>"] });
```

**.py**

```python
from hanzoai.cloud import ApiClient, Configuration
from hanzoai.cloud.api import MarketingApi

client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = MarketingApi(client).post_marketing_broadcasts_by_id_test(id='id', id="<id>", to=["<to>"])
```

**.go**

```go
cfg := hanzoai.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := hanzoai.NewAPIClient(cfg)

resp, _, err := client.MarketingAPI.PostMarketingBroadcastsByIdTest(context.Background()).Execute()
if err != nil {
	return err
}
```

**.rs**

```rust
use hanzo_client::apis::{configuration::Configuration, marketing_api};

let mut cfg = Configuration::new();
cfg.bearer_access_token = std::env::var("HANZO_API_KEY").ok();

let result = marketing_api::post_marketing_broadcasts_by_id_test(&cfg, Default::default()).await?;
```

**.java**

```java
import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.MarketingApi;

ApiClient client = new ApiClient();
client.setBearerToken(System.getenv("HANZO_API_KEY"));

var result = new MarketingApi(client).postMarketingBroadcastsByIdTest();
```

The method above is the one at the current release of the document. `hanzoai@8.5.914` (npm) and `hanzoai@8.5.914` (PyPI) were generated from an earlier release, where this operation carried a different id, so it spells the method differently — regenerating the clients is what makes the two agree. [SDKs →](https://docs.hanzo.ai/docs/sdks)

**HTTP**

```bash
curl -X POST https://api.hanzo.ai/v1/marketing/broadcasts/<id>/test \
  -H "Authorization: Bearer $HANZO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
       "id": "<id>",
       "to": [
         "<to>"
       ]
     }'
```

**MCP**

MCP reaches **marketing** through the `marketing` tool, which names its 82 operations with its own verbs — this one among them, under a name only MCP declares. `describe` explains any of them:

```bash
curl -X POST https://api.hanzo.ai/v1/mcp \
  -H "Content-Type: application/json" \
  -d '{
       "jsonrpc": "2.0",
       "id": 1,
       "method": "tools/call",
       "params": {
         "name": "describe",
         "arguments": {
           "op": "list_marketing_audiences"
         }
       }
     }'
```

---

[Marketing API](https://docs.hanzo.ai/docs/openapi/marketing) · [All Hanzo APIs](https://docs.hanzo.ai/docs/openapi) · [Interactive reference](https://docs.hanzo.ai/docs/openapi/reference)