Bulk Update (email account)
/api/v1/email-accounts/bulk-updateRequest body
account_idsarray<string>requiredIDs of the mailboxes to act on. Read them from
GET /email-accounts.actionstringrequiredsuspend | activate | deleteWhat to do to every mailbox in
account_ids.settingsobjectOptional. Settings to apply with the action.
storage_quota_mbintegerOptional. This mailbox's storage, in megabytes.
statusstringactive | suspendedactiveorsuspended.
Request
/api/v1/email-accounts/bulk-updatecurl -X POST 'https://app.mailyte.com/api/v1/email-accounts/bulk-update' \
-H 'Authorization: Bearer mk_live_YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{
"account_ids": [
"01JBT8XQ2M9WYC3K4F6R7S8T9V"
],
"action": "suspend"
}'const response = await fetch('https://app.mailyte.com/api/v1/email-accounts/bulk-update', {
method: 'POST',
headers: {
Authorization: 'Bearer mk_live_YOUR_API_KEY',
'Content-Type': 'application/json',
},
body: JSON.stringify({
"account_ids": [
"01JBT8XQ2M9WYC3K4F6R7S8T9V"
],
"action": "suspend"
}),
});
const { data } = await response.json();import requests
response = requests.post(
"https://app.mailyte.com/api/v1/email-accounts/bulk-update",
headers={"Authorization": "Bearer mk_live_YOUR_API_KEY"},
json={
"account_ids": [
"01JBT8XQ2M9WYC3K4F6R7S8T9V"
],
"action": "suspend"
},
)
data = response.json()["data"]<?php
$response = Http::withToken('mk_live_YOUR_API_KEY')
->post('https://app.mailyte.com/api/v1/email-accounts/bulk-update', [
'account_ids' => [
'01JBT8XQ2M9WYC3K4F6R7S8T9V',
],
'action' => 'suspend',
]);
$data = $response->json('data');require "net/http"
require "json"
uri = URI("https://app.mailyte.com/api/v1/email-accounts/bulk-update")
request = Net::HTTP::Post.new(uri)
request["Authorization"] = "Bearer mk_live_YOUR_API_KEY"
request["Content-Type"] = "application/json"
request.body = {
"account_ids": [
"01JBT8XQ2M9WYC3K4F6R7S8T9V"
],
"action": "suspend"
}.to_json
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }Response
Success.
dataobjectobjectstringmailbox_bulk_resultupdatedintegerHow many mailboxes were changed.
failedintegerHow many were not. **A bulk update is not atomic**: a 200 with
failedabove zero means part of your batch did not happen, so check this rather than the status code.errorsarray<object>One entry per failure, and the only place the failures are named. Empty when
failedis 0.mailbox_idstringThe ID of the mailbox that failed, as you sent it in
account_ids.messagestringWhy that mailbox was not updated, for a person to read. Do not match on the text.
Returned inside the standard envelope.
Errors
| Status | When |
|---|---|
401 | The API key is missing, unknown, revoked or expired. All four answer identically, on purpose: distinguishing them would confirm which keys exist. |
403 | The key is valid but may not do this: it lacks the required scope, its IP allowlist does not include you, or this endpoint does not accept API keys. |
404 | No such resource in this organization. |
422 | The request was understood but the values were not acceptable. |
429 | Too many requests, or the organization has spent its sending allowance. `Retry-After` says how long to wait. |
Every status, with what causes it and what to do, is on the error reference.