v1

latestOpenAPI 3.1.02026-07-2617125852.3 KB
DFYEmailAccountOrder

Cancel dfy email accounts

This endpoint will cancel the DFY email accounts based on the provided email addresses. Cancelling permanently deletes all Unibox emails and conversations associated with the cancelled accounts. This cannot be undone.

Requires one of the following scopes: dfy_email_account_orders:delete, dfy_email_account_orders:all, all:delete, all:all

post/api/v2/dfy-email-account-orders/accounts/cancel

Request body

accountsstring[] required

List of emails to cancel the DFY email accounts for.

Example request

{
  "accounts": [
    "test@test.com"
  ]
}

Response

Default Response

Example response

{
  "items": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "domain": "example.com",
      "email": "user@example.com",
      "email_provider": 1,
      "first_name": "John",
      "last_name": "Doe",
      "is_pre_warmed_up": true,
      "timestamp_cancelled": "2025-01-01T00:00:00.000Z",
      "timestamp_created": "2025-01-01T00:00:00.000Z"
    }
  ]
}