# Send a test notice email

<div class="api-op" data-api-operation>
<div class="api-op__main">

<p class="api-endpoint"><span class="method method-post">POST</span> <code>/v1/email_events/test</code></p>

Mails a sample of one customer-facing notice, with sample data and "[Test]" in the subject, to an owner or admin of the environment's account, through OhAuthCat's mail with the environment's support email as reply-to. At most 5 test emails per environment per hour; more answer rate_limited. The send shows in GET /v1/email_events as kind `test_<kind>`.

<dl class="api-facts"><div><dt>Scope</dt><dd><code>environment:write</code></dd></div><div><dt>Auth</dt><dd>Secret key (<code>sk_…</code>)</dd></div><div><dt>Since</dt><dd>1.0</dd></div></dl>

## Headers

<ul class="api-fields">
<li class="api-field">
<p class="api-field__head"><code class="api-field__name">OhAuthCat-Version</code> <span class="api-field__type">string</span></p>
Minor version; defaults to the environment's pin.
</li>
</ul>

## Request body

<ul class="api-fields">
<li class="api-field">
<p class="api-field__head"><code class="api-field__name">kind</code> <span class="api-field__type">string</span> <span class="api-field__required">Required</span></p>

<p class="api-field__chips">one of <code>cert_expiry</code>, <code>connection_error</code>, <code>domain_record_missing</code>, <code>scim_auth_failure</code></p>
</li>
<li class="api-field">
<p class="api-field__head"><code class="api-field__name">to</code> <span class="api-field__type">string</span> <span class="api-field__required">Required</span></p>
An owner's or admin's email of the environment's account.

<p class="api-field__chips">max length 320</p>
</li>
</ul>

## Responses

<ul class="api-responses">
<li class="api-response"><span class="api-status api-status--ok">202</span> <span>Sent. <span class="api-field__type">TestEmail</span></span></li>
<li class="api-response"><span class="api-status api-status--bad">400</span> <span>Invalid request. Codes: <a href="/errors/parameter_invalid/">parameter_invalid</a>, <a href="/errors/parameter_missing/">parameter_missing</a>, <a href="/errors/version_unsupported/">version_unsupported</a> and resource-specific codes from the catalogue. <span class="api-field__type">Error</span></span></li>
<li class="api-response"><span class="api-status api-status--bad">401</span> <span>Codes: <a href="/errors/authentication_required/">authentication_required</a>, <a href="/errors/api_key_invalid/">api_key_invalid</a>. <span class="api-field__type">Error</span></span></li>
<li class="api-response"><span class="api-status api-status--bad">403</span> <span>Codes: <a href="/errors/api_key_scope_missing/">api_key_scope_missing</a>, <a href="/errors/ip_not_allowed/">ip_not_allowed</a>, <a href="/errors/plan_limit_reached/">plan_limit_reached</a>. <span class="api-field__type">Error</span></span></li>
<li class="api-response"><span class="api-status api-status--bad">429</span> <span>Code: <a href="/errors/rate_limited/">rate_limited</a>. Retry-After is set. <span class="api-field__type">Error</span></span></li>
<li class="api-response"><span class="api-status api-status--bad">503</span> <span>Code: <a href="/errors/service_unavailable/">service_unavailable</a>. Retry-After is set; writes are paused. <span class="api-field__type">Error</span></span></li>
<li class="api-response"><span class="api-status api-status--neutral">default</span> <span>Any other error, including <a href="/errors/internal_error/">internal_error</a>. Every code is in the error catalogue. <span class="api-field__type">Error</span></span></li>
</ul>

Errors share one shape; see the [error code catalogue](/errors/).

</div>
<div class="api-op__code">

**curl**

```sh wrap
curl -X POST \
  "https://api.ohauthcat.com/v1/email_events/test" \
  -H "Authorization: Bearer $OHAUTHCAT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "kind": "cert_expiry",
  "to": "example_to"
}'
```

**Node**

```javascript wrap
const response = await fetch("https://api.ohauthcat.com/v1/email_events/test", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.OHAUTHCAT_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    kind: "cert_expiry",
    to: "example_to",
  }),
});
const data = await response.json();
```

**Python**

```python wrap
import os
import requests

response = requests.post(
    "https://api.ohauthcat.com/v1/email_events/test",
    headers={"Authorization": f"Bearer {os.environ['OHAUTHCAT_API_KEY']}"},
    json={
        "kind": "cert_expiry",
        "to": "example_to",
    },
)
data = response.json()
```

```json title="Response 202" wrap
{
  "object": "test_email",
  "kind": "default",
  "status": "sent"
}
```

</div>
</div>
