DeliverabilityTestController

Update load test

Update metadata, timeout, and expectations for a non-running non-terminal test.

patch/test/deliverability/{testId}

Request

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

Path parameters

testIdstring uuid required

Request body

namestring nullable

Optional updated name

descriptionstring nullable

Optional updated description

startAtstring date-time nullable

Optional updated receive-window start time. Only applied while test is not terminal.

maxDurationSecondsinteger nullable

Optional updated timeout in seconds

clearMaxDurationboolean nullable

Set true to clear timeout. If true, maxDurationSeconds is ignored for this request.

successThresholdPercentnumber double nullable

Optional updated acceptable success threshold percentage (0,100].

clearSuccessThresholdboolean nullable

Set true to clear success threshold. If true, successThresholdPercent is ignored for this request.

Example request

{
  "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.