Bulk Delete (domain)

POST/api/v1/domains/bulk-delete
Requires anorganization API keywith the scopedomains:write

Request

POST/api/v1/domains/bulk-delete
curl -X POST 'https://app.mailyte.com/api/v1/domains/bulk-delete' \
  -H 'Authorization: Bearer mk_live_YOUR_API_KEY'
The key names its own organization, so no X-Organization-ID header is needed.

Response

Success.

  • dataobject
    • objectstringbulk_result
    • actionstringverify | delete | activate | suspend

      What was attempted against every id.

    • requestedinteger

      How many ids were submitted.

    • succeededinteger
    • failedinteger
    • resultsarray<object>

      Every submitted id with its own outcome, in submission order. A bulk call is partial by nature: `succeeded` and `failed` both being non-zero is an ordinary result, not an error.

      • idstring

        The domain id as submitted. Null on a failure the operation could not attribute to one.

      • statusstringsucceeded | failed
      • errorstring

        Why this one failed. Null when it succeeded.

Returned inside the standard envelope.

Errors

StatusWhen
401The API key is missing, unknown, revoked or expired. All four answer identically, on purpose: distinguishing them would confirm which keys exist.
403The 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.
404No such resource in this organization.
422The request was understood but the values were not acceptable.
429Too 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.