Skip to Content

Discard a mail history upload

Removes an archive from a queued import and releases its upload. Request: DELETE /v1/mailboxes/{id}/imports/{importId}/uploads/{archiveId}.

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

Removes an archive from a queued import and releases its upload.

Authorization

apiKey
headerx-api-key<token>

Path Parameters

id*string
Match^mbx_[0-9a-hjkmnp-tv-z]{16,24}$
importId*string
archiveId*string
Match^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$
Formatuuid

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.discardImportUpload({
  "id": "example",
  "importId": "example",
  "archiveId": "example"
});
Example Response
{
  "success": true
}

Related documentation