Sign in

v1

latestOpenAPI 3.1.02026-07-2670105729.6 KB
Domains

Update domain settings

Updates sender defaults (defaultSenderName, defaultFromEmail, defaultReplyToEmail) — at least one required. Verification is its own action: POST /v1/domains/{domainId}/verify. Returns the bare updated row.

patch/v1/domains/{domainId}

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.

Request body

defaultSenderNamestring
defaultFromEmailstring email
defaultReplyToEmailstring email

Response

Updated.

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