Export

Delete export

Cancels a pending export or deletes a completed export. Removes both Redis data and the export file.

delete/v1/account/{account}/export/{exportId}

Request

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

Path parameters

accountstring required

Unique identifier for the email account

Example:user123
exportIdstring required

Export job identifier

Example:exp_abc123def456abc123def456

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. Any partially written export file is removed.

deletedboolean

True if export was deleted

Example response

{
  "deleted": true
}

Changes

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