DeliverabilityTestController

Create load test

Create a load test for inboxes or phone numbers using ALL, PATTERN, or EXPLICIT selector scope.

post/test/deliverability

Request

  • Base URL: https://api.mailslurp.com
  • URL: https://api.mailslurp.com/test/deliverability
  • Auth: API key in header x-api-key

Request body

namestring nullable

Optional name for the test

descriptionstring nullable

Optional description

scope'INBOX' | 'PHONE' required

Entity scope to evaluate

startAtstring date-time nullable

UTC instant when the receive window starts. Defaults to now if omitted.

maxDurationSecondsinteger nullable

Optional timeout in seconds after startAt. If not all entities match before timeout the test transitions to FAILED.

successThresholdPercentnumber double nullable

Optional acceptable success threshold percentage (0,100]. If set, a timed-out test can complete successfully when matchedEntities/totalEntities reaches this percentage.

Example request

{
  "name": "Morning smoke load",
  "description": "Load test for signup flow",
  "scope": "INBOX",
  "startAt": "2026-02-24T16:30:00Z",
  "maxDurationSeconds": 900,
  "successThresholdPercent": 90,
  "selector": {
    "type": "PATTERN",
    "pattern": "loadtest-*",
    "phoneCountry": "US",
    "entityIds": [
      "11111111-1111-1111-1111-111111111111"
    ],
    "excludeEntityIds": [
      "22222222-2222-2222-2222-222222222222"
    ],
    "tags": [
      "loadtest",
      "smoke"
    ]
  },
  "expectations": [
    {
      "name": "From system sender",
      "minCount": 1,
      "from": "noreply@example.com",
      "to": "qa+load@example.com",
      "subject": "verification"
    }
  ]
}

Response

OK

Changes

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