OMomnisend
Automations

Send test email

Send the saved email content of a specific email block as a test email to up to 5 recipients. The email is rendered and delivered asynchronously.

Scopes: automations.write

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

post/automations/{id}/blocks/{blockID}/test-email

Request

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

Path parameters

idstring required

Automation workflow ID (24 character hexadecimal)

blockIDstring required

Block identifier

Headers

Omnisend-Versionstring required

API version that specifies the response format and behaviour

Request body

recipientsstring[] required

Email addresses to deliver the test email to (1 to 5 recipients).

Example request

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

Response

Test email accepted for delivery

Changes

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