OMomnisend
Campaigns

Send campaign test email

Render the campaign draft and email it to up to 5 recipients so the merchant (or their AI tool) can preview it without leaving the API. The test uses the campaign's saved subject, sender, and content; only email campaigns are supported.

Scopes: campaigns.write

Rate Limiting: This endpoint is rate limited to 400 requests per minute.

post/campaigns/{id}/test-email

Request

  • Base URL
    https://api.omnisend.com/api
  • URL
    https://api.omnisend.com/api/campaigns/{id}/test-email
  • Auth
    • OAuth 2
      Client credentials
      Token URL: https://app.omnisend.com/oauth2/token scopes: campaigns.write
    • or API key in header Authorization

Path parameters

idstring required

Campaign ID (24 character hexadecimal)

Headers

Omnisend-Versionstring required

API version that specifies the response format and behaviour

Request body

recipientsstring[] required

Email addresses that receive the test send. Between 1 and 5 addresses.

Example request

{
  "recipients": [
    "merchant@example.com",
    "teammate@example.com"
  ]
}

Response

Test email queued for delivery

Changes

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