Sign in

v1

latestOpenAPI 3.1.02026-07-2670105729.6 KB
Domains

Verify a domain

Re-checks the DNS records with the provider and refreshes the row. Empty body. Safe to poll — keep calling until sendable: true (DNS propagation can take minutes to hours). Returns the bare refreshed row.

post/v1/domains/{domainId}/verify

Path parameters

domainIdstring required

Domain id (opaque Convex document id) returned by POST /v1/domains and listed by GET /v1/domains.

Example:kx7bkh53hasmfeh5kd7sqgykt187g8ww

Domain id (opaque Convex document id) returned by POST /v1/domains and listed by GET /v1/domains.

Headers

Idempotency-Keystring

Optional idempotency key for safe retries. Reusing the same key with the same request body returns the original response for 24 hours.

Response

The refreshed domain row.

domainIdstring required
domainUrlstring uri required
namestring required
regionstring required
status'not_started' | 'pending' | 'verified' | 'failed' | 'temporary_failure' | 'partially_verified' | 'partially_failed' required
sendingEnabledboolean required
sendableboolean required
openTrackingboolean
clickTrackingboolean
createdAtstring date-time required
updatedAtstring date-time required
verifiedAtstring date-time