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

idstring required

Headers

X-Shipmail-Organizationstring

OAuth access tokens only. The organization ID this request acts on. Required when the OAuth connection was approved for several organizations (400 validation_error without it); optional with one. An organization the connection was not approved for returns 403 authorization_error. Ignored for API keys, which belong to one organization.

Request body

recipient_emailstring email required

Response

Send a newsletter test.

object'newsletter_test_send' required
idstring required
newsletter_idstring required
message_idstring nullable
recipient_emailstring email required
status'pending' | 'sent' | 'failed' required
last_errorstring nullable
sent_atstring date-time nullable
created_atstring date-time required

Changes

No recorded changes to this operation across all 1 revision of this API.