Run a batch action on accounts

​

Queues the requested action against the provided account IDs and returns the resulting task. Use GET /tasks/{id} to monitor its progress.

Body·
required
application/json

Run a batch action on accounts

  • account_ids
    Type: array integer[]
    required

    The IDs of the accounts to act on.

  • action
    Type: string
    required

    The action to perform on every provided account. Supported values include reconnect, suspend, delete.

Responses
  • application/json
  • application/json
  • application/json
Request Example for post/v1/accounts/batch
curl http://api.mailreach.co/api/v1/accounts/batch \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: YOUR_SECRET_TOKEN' \
  --data '{
  "account_ids": [
    1234,
    5678
  ],
  "action": "reconnect"
}'

{
  "id": 8421,
  "progress": 0,
  "logs": [],
  "email_workspace_id": 1
}

The task tracking the batch action