Skip to Content

Discard a queued mail history import

Discards a queued import and releases all its archive uploads. Request: DELETE /v1/mailboxes/{id}/imports/{importId}. Scope: mailboxes:manage.

DELETE
/v1/mailboxes/{id}/imports/{importId}

Discards a queued import and releases all its archive uploads.

Authorization

apiKey
headerx-api-key<token>

Path Parameters

id*string
Match^mbx_[0-9a-hjkmnp-tv-z]{16,24}$
importId*string

Response Body

SuccessResponse

application/json
  1. response
success*boolean
Example Request
import { createClient } from "samva";

const samva = createClient({ apiKey: process.env.SAMVA_API_KEY! });

const result = await samva.mailboxes.discardImport({
  "id": "example",
  "importId": "example"
});
Example Response
{
  "success": true
}

Related documentation