---
title: "Send a newsletter test"
method: POST
path: "/newsletters/{id}/test-send"
tags: ["Newsletters"]
---

# Send a newsletter test

`POST /newsletters/{id}/test-send`

## Request

- Base URL: `https://shipmail.to/api/v1`
- URL: `https://shipmail.to/api/v1/newsletters/{id}/test-send`
- Auth: one of:
  - HTTP bearer
  - OAuth 2 (authorization code, authorization URL `https://shipmail.to/api/auth/oauth2/authorize`, token URL `https://shipmail.to/api/auth/oauth2/token`)

## Path parameters

- `id` string, required

## Headers

- `X-Shipmail-Organization` string

## Request body

- SendNewsletterTestRequest
  - `recipient_email` string, email, required

## Response `201`

Send a newsletter test.

- NewsletterTestSend
  - `object` 'newsletter_test_send', required
  - `id` string, required
  - `newsletter_id` string, required
  - `message_id` string, nullable
  - `recipient_email` string, email, required
  - `status` 'pending' | 'sent' | 'failed', required
  - `last_error` string, nullable
  - `sent_at` string, date-time, nullable
  - `created_at` string, date-time, required

## Other responses

- `404`: Resource not found.
- `422`: Validation failed.
- `429`: Rate limit exceeded.

---

[API](https://skmtc.dev/shipmail/apis/shipmail-api.md) · [All operations](https://skmtc.dev/shipmail/apis/shipmail-api/llms.txt) · [OpenAPI document](https://skmtc.dev/shipmail/apis/shipmail-api/revisions/2c23e59d7e30?raw)