Outbox

Remove a message

Remove a message from the outbox

delete/v1/outbox/{queueId}

Request

  • Base URL: https://your-emailengine-host
  • URL: https://your-emailengine-host/v1/outbox/{queueId}
  • Auth: HTTP bearer

Path parameters

queueIdstring required

Queue identifier for scheduled email

Example:d41f0423195f271f

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

Response

Returns a deletion marker. A message already being delivered cannot be removed.

deletedboolean

Was the message deleted

lockedboolean

Present when the message was not deleted because a delivery attempt is running for it right now. Retry once the attempt has finished

Example response

{
  "locked": true
}

Changes

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