DeliverabilityTestController

Create deliverability simulation job

Create and start a simulation job for a running load test. Only one active simulation job is allowed per user.

post/test/deliverability/{testId}/simulation-jobs

Request

  • Base URL: https://api.mailslurp.com
  • URL: https://api.mailslurp.com/test/deliverability/{testId}/simulation-jobs
  • Auth: API key in header x-api-key

Path parameters

testIdstring uuid required

Request body

senderInboxIdstring uuid nullable

Sender inbox ID for INBOX scope tests

senderPhoneIdstring uuid nullable

Sender phone ID for PHONE scope tests

delayMsinteger nullable

Delay between individual sends in milliseconds

batchSizeinteger nullable

Maximum sends processed per scheduler batch

sendsPerTargetinteger nullable

Optional fixed sends per target. If omitted this is derived from test expectations.

Example request

{
  "delayMs": 250,
  "batchSize": 10,
  "sendsPerTarget": 1
}

Response

OK

Changes

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