Sign in

v1

latestOpenAPI 3.1.02026-07-2617125852.3 KB
Account

Pause multiple accounts

Pauses up to 100 email accounts in the authenticated workspace. Each unique email is returned in either paused_emails or failed_emails.

Requires one of the following scopes: accounts:update, accounts:all, all:update, all:all

post/api/v2/accounts/pause

Request body

emailsstring[] required

Email addresses to pause. Duplicate values are ignored.

Example request

{
  "emails": [
    "user@example.com"
  ]
}

Response

The result of the bulk pause operation.

paused_emailsstring[] required

Email addresses whose accounts were successfully paused.

failed_emailsstring[] required

Email addresses that were invalid or whose account status was not changed.

Example response

{
  "paused_emails": [
    "paused@example.com"
  ],
  "failed_emails": [
    "failed@example.com"
  ]
}