beehiiv Developer Documentation

Send a test email for a specific post to one or more email addresses. Returns the number of remaining test sends for the day and the time at which the limit resets.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

publicationIdstringRequiredformat: "^(pub_[0-9a-fA-F\-]+)$"

The prefixed ID of the publication object

postIdstringRequiredformat: "^(post_[0-9a-fA-F\-]+)$"

The prefixed ID of the post object

Request

This endpoint expects an object.

recipient_emailslist of stringsRequired

One or more email addresses to send the test to. Returns 422 if the daily test send limit has been reached.

Response

dataobject

Errors

400

Bad Request Error

403

Forbidden Error

404

Not Found Error

422

Unprocessable Entity Error

429

Too Many Requests Error

500

Internal Server Error

$	curl -X POST https://api.beehiiv.com/v2/publications/pub_00000000-0000-0000-0000-000000000000/posts/post_00000000-0000-0000-0000-000000000000/test_sends \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"recipient_emails": [
>	"[email protected]"
>	]
>	}'

$	curl -X POST https://api.beehiiv.com/v2/publications/pub_00000000-0000-0000-0000-000000000000/posts/post_00000000-0000-0000-0000-000000000000/test_sends \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"recipient_emails": [
>	"[email protected]"
>	]
>	}'

Send test email OAuth Scope: posts

Send test email OAuth Scope: posts

Authentication

Path parameters

Request

Response

Errors

Authentication

Path parameters

Request

Response

Errors

1	{
2	"data": {
3	"remaining_test_sends": 19,
4	"reset_at": 1735689600
5	}
6	}