Delivery Test

Create delivery test

Initiate a delivery test<br/><br/>Runs as a background job. Follow it either by polling the status endpoint or by waiting for the completion webhook.

post/v1/delivery-test/account/{account}

Request

  • Base URL: https://your-emailengine-host
  • URL: https://your-emailengine-host/v1/delivery-test/account/{account}
  • Auth: HTTP bearer

Path parameters

accountstring required

Unique identifier for the email account

Example:user123

Headers

x-ee-timeoutinteger

Request timeout in milliseconds. Raises the command timeout above the EENGINE_TIMEOUT default for a long-running request; a value below the default has no effect

Example:30000

Request body

Response

Returns the ID of the started deliverability test. Poll the check endpoint for the result.

successboolean

Was the test started. Not present if queueing the test message failed

deliveryTeststring

Test ID. Not present if queueing the test message failed

errorstring

Error message. Only present if queueing the test message failed - in that case success and deliveryTest are not set

Example response

{
  "success": true,
  "deliveryTest": "6420a6ad-7f82-4e4f-8112-82a9dad1f34d",
  "error": "Oops, something went wrong"
}

Changes

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