Skip to content
Documentation/API reference
API · domains

Verify domain

POST /api/v2/domains/{id}/verify

Authorization

Owner/admin user session (use inboxit login). Use the CLI login flow; a workspace API key cannot call this operation.

Parameters

All resource access is checked against the selected workspace and user permissions.

NameTypeContract
idpath · requiredResource UUID

Request

Run inboxit login first. The CLI supplies authenticated user credentials.

Example
inboxit domains verify --id RESOURCE_UUID

Response

HTTP 200. Example values are illustrative; excerpts are marked.

Example
{
  "id": "DOMAIN_UUID",
  "name": "mail.yourbrand.com",
  "status": "verified",
  "checks": {},
  "checked_at": "2026-10-23T12:00:00Z"
}

Behavior & errors

Response excerpt; also returns records and created_at. Resolves ownership and DKIM TXT. DMARC is recommended, not required. Checking within ten seconds returns 429; otherwise failed DNS checks leave status pending. Common errors: 400 invalid input, 401 unauthenticated, 403 insufficient permission, 404 missing/inaccessible resource, 409 conflict, 429 rate/usage limit, 503 service unavailable. See Errors & retries for recovery guidance.