API reference
Domain Setup API
Complete the guided domain workflow, DNS checks, sender identity and setup history.
Connect the hostname you want customers to use
Start with /api/developer/brand/domain/start using rootDomain and optional storefrontSubdomain (@ for the root). The current interface automatically prepares the hosting and email providers through POST /api/developer/brand/domain/prepare, then displays their actual DNS records. Add available records while the remaining values are retrieved; do not substitute guessed provider targets.
These are developer-account management calls with domains.view/domains.manage and all-products workspace scope. A product plugin key cannot manage DNS. The platform handles supported routing and SSL provisioning after readiness checks; DNS propagation and certificate timing are not guaranteed.
Progress is not verification
check inspects required or non-skipped DNS records and can return a cooldown. check-step checks one record when a nonempty stepKey is supplied; omitting it or sending an empty key checks all applicable records, not only currentStep. advance selects the next incomplete step, while skip-step only skips optional records. Read record status and SSL readiness instead of treating HTTP 200 as a completed connection.
reset resets saved setup progress. It does not remove records from the DNS provider, revoke a certificate or guarantee that an existing domain connection is disconnected.
Sender identity has its own readiness
email-identity saves sender name, support/reply-to addresses, supported sender addresses and footer text. sender-profiles chooses local parts for licensing, notifications and marketing on the active sending domain. Neither save substitutes for domain verification or permission to send.
Preparation and provider activation are writes
POST /prepare registers or refreshes the saved hostname and sending domain with the configured providers, then checks readiness. Send retry:true for an explicit forced retry. Without it, a recent preparation can return the current state during the 30-second cooldown; a concurrent preparation can also return current state without starting another job. Re-read needsPreparation, currentStep and readiness rather than treating a returned wizard as success.
POST /email-providers creates a missing sending-domain registration or refreshes the existing one. POST /storefront-provider does the same for the saved storefront hostname. These two calls read no body fields. Both can contact providers and persist setup state; none of these POSTs is a read-only health check. They do not edit DNS at your registrar or move your incoming inbox mail.
Preparation can return HTTP 200 with provider failures recorded in currentStep.errorMessage and setup events. A failed direct provider operation can instead return an error. Investigate the returned state and use a deliberate retry; do not repeatedly reset the domain or replace unrelated DNS records.
SoundSync
Read the readiness object
| Field | What it proves |
|---|---|
| needsPreparation | Some provider records are still missing. Available records remain usable; only missing values stay blocked. Inspect providerPreparation.missingRecords and currentStep, then refresh remaining records when needed. |
| readiness.dns | All four required DNS groups have nonempty verified records. It does not prove provider activation. |
| readiness.storefront | The intended saved hostname matches a verified hosting connection with active DNS and SSL. |
| readiness.transactional / marketing | The matching active sending domain has the relevant provider verification and required DKIM records. |
| readiness.tracking | Marketing tracking is ready and its tracking certificate is ready; this is not GA4. |
| readiness.senders / identity | Licensing, notification and marketing sender local parts and a valid support identity are configured for the domain. |
| readiness.ready | The combined DNS, storefront, sending/tracking and identity checks pass. allRequiredVerified alone is not the complete readiness contract. |
SoundSync
Prepare, then read the current result
Illustrative permitted developer requests; preparation has side effects
curl --fail-with-body -sS -X POST "$SOUNDSYNC_API_BASE/api/developer/brand/domain/prepare" \
-H "Authorization: Bearer $DEVELOPER_TOKEN" \
-H "Content-Type: application/json" \
--data '{}'
curl --fail-with-body -sS "$SOUNDSYNC_API_BASE/api/developer/brand/domain" \
-H "Authorization: Bearer $DEVELOPER_TOKEN"
# Only for an intentional forced retry, send {"retry":true} to POST /prepare.
# These calls require the effective developer workspace and matching domain permissions.SoundSync
Start and inspect setup
SoundSync
Requests and responses
POST
/api/developer/brand/domain/prepare
Prepare provider records and verify domain readiness
- Auth
- Account Bearer JWT
- Scope
- domains.view + domains.manage and all-products workspace scope.
- Request fields
- retry: boolean
- Returns
- HTTP 200: domain, providerDetection, currentStep, current_step, wizardProgress, records, featureSummaries, events, allRequiredVerified, providerSupport, branding, storefrontDomain, emailDomains, emailDomainSettings, needsPreparation, automaticProviderSetup, emailProvidersConfigured, emailProvidersReady, providerPreparation, readiness.
- Notes
- Requires domains.view, domains.manage and all-products workspace scope. Starts or refreshes hosting/email provider registration and verification; this is a write, not a health probe. retry:true forces preparation; otherwise a recent attempt can return current state during the 30-second preparation cooldown. Concurrent preparation is serialized. Inspect currentStep, needsPreparation, provider errors and readiness; HTTP 200 can still mean incomplete setup. No DNS-provider records are edited by this call. domains.view + domains.manage and all-products workspace scope. Selected-product teammates cannot use this workspace-wide domain wizard.
Request, response and error reference
Request (application/json)
{
"type": "object",
"properties": {
"retry": {
"type": "boolean"
}
},
"additionalProperties": true
}HTTP 200 response (application/json)
{
"type": "object",
"properties": {
"domain": {
"type": [
"object",
"null"
],
"properties": {
"id": {
"type": "integer",
"minimum": 1
},
"domain": {
"type": "string"
},
"status": {
"type": "string"
},
"verified": {
"type": "boolean"
},
"dnsRecords": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"name": {
"type": "string"
},
"value": {
"type": "string"
}
},
"additionalProperties": true
}
},
"sslStatus": {
"type": "string"
},
"rootDomain": {
"type": "string"
},
"storefrontSubdomain": {
"type": "string"
},
"setupStatus": {
"type": "string"
},
"currentStepKey": {
"type": "string"
}
},
"additionalProperties": true
},
"providerDetection": {
"type": [
"object",
"null"
],
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
},
"currentStep": {
"type": [
"object",
"null"
],
"properties": {
"id": {
"type": [
"integer",
"null"
]
},
"developerDomainId": {
"type": [
"integer",
"null"
]
},
"stepKey": {
"type": "string"
},
"step_key": {
"type": "string"
},
"featureKey": {
"type": "string"
},
"feature_key": {
"type": "string"
},
"title": {
"type": "string"
},
"description": {
"type": "string"
},
"warning": {
"type": "string"
},
"purpose": {
"type": "string"
},
"required": {
"type": "boolean"
},
"status": {
"type": "string"
},
"action": {
"type": "string",
"description": "Non-DNS step: prepare-domains, storefront-provider, email-providers or email-identity. Do not add it as a DNS row."
},
"type": {
"type": "string",
"description": "DNS type returned by the provider, such as A, CNAME, TXT or MX; absent on action steps."
},
"host": {
"type": "string"
},
"name": {
"type": "string"
},
"value": {
"type": "string"
},
"ttl": {
"type": [
"string",
"integer"
]
},
"priority": {
"type": "integer",
"description": "MX priority, entered separately from exchange."
},
"exchange": {
"type": "string"
},
"copyBlocked": {
"type": "boolean",
"description": "Missing provider value cannot be copied. Also respect copyPlan.mode=blocked."
},
"copyPlan": {
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": [
"create",
"replace",
"preserve",
"blocked"
]
},
"value": {
"type": "string"
},
"previousValue": {
"type": "string"
},
"message": {
"type": "string"
}
},
"required": [
"mode"
],
"additionalProperties": true,
"description": "Use value for create/replace, keep existing policy for preserve, and resolve message before copying for blocked."
},
"errorMessage": {
"type": "string"
},
"error_message": {
"type": "string"
},
"lastCheckedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"verifiedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"createdAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"updatedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"additionalProperties": true
},
"current_step": {
"type": [
"object",
"null"
],
"properties": {
"id": {
"type": [
"integer",
"null"
]
},
"developerDomainId": {
"type": [
"integer",
"null"
]
},
"stepKey": {
"type": "string"
},
"step_key": {
"type": "string"
},
"featureKey": {
"type": "string"
},
"feature_key": {
"type": "string"
},
"title": {
"type": "string"
},
"description": {
"type": "string"
},
"warning": {
"type": "string"
},
"purpose": {
"type": "string"
},
"required": {
"type": "boolean"
},
"status": {
"type": "string"
},
"action": {
"type": "string",
"description": "Non-DNS step: prepare-domains, storefront-provider, email-providers or email-identity. Do not add it as a DNS row."
},
"type": {
"type": "string",
"description": "DNS type returned by the provider, such as A, CNAME, TXT or MX; absent on action steps."
},
"host": {
"type": "string"
},
"name": {
"type": "string"
},
"value": {
"type": "string"
},
"ttl": {
"type": [
"string",
"integer"
]
},
"priority": {
"type": "integer",
"description": "MX priority, entered separately from exchange."
},
"exchange": {
"type": "string"
},
"copyBlocked": {
"type": "boolean",
"description": "Missing provider value cannot be copied. Also respect copyPlan.mode=blocked."
},
"copyPlan": {
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": [
"create",
"replace",
"preserve",
"blocked"
]
},
"value": {
"type": "string"
},
"previousValue": {
"type": "string"
},
"message": {
"type": "string"
}
},
"required": [
"mode"
],
"additionalProperties": true,
"description": "Use value for create/replace, keep existing policy for preserve, and resolve message before copying for blocked."
},
"errorMessage": {
"type": "string"
},
"error_message": {
"type": "string"
},
"lastCheckedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"verifiedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"createdAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"updatedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"additionalProperties": true
},
"wizardProgress": {
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string"
},
"label": {
"type": "string"
},
"status": {
"type": "string"
},
"completeCount": {
"type": "integer"
},
"totalCount": {
"type": "integer"
}
},
"additionalProperties": true
}
},
"records": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": [
"integer",
"null"
]
},
"developerDomainId": {
"type": [
"integer",
"null"
]
},
"stepKey": {
"type": "string"
},
"step_key": {
"type": "string"
},
"featureKey": {
"type": "string"
},
"feature_key": {
"type": "string"
},
"title": {
"type": "string"
},
"description": {
"type": "string"
},
"warning": {
"type": "string"
},
"purpose": {
"type": "string"
},
"required": {
"type": "boolean"
},
"status": {
"type": "string"
},
"action": {
"type": "string",
"description": "Non-DNS step: prepare-domains, storefront-provider, email-providers or email-identity. Do not add it as a DNS row."
},
"type": {
"type": "string",
"description": "DNS type returned by the provider, such as A, CNAME, TXT or MX; absent on action steps."
},
"host": {
"type": "string"
},
"name": {
"type": "string"
},
"value": {
"type": "string"
},
"ttl": {
"type": [
"string",
"integer"
]
},
"priority": {
"type": "integer",
"description": "MX priority, entered separately from exchange."
},
"exchange": {
"type": "string"
},
"copyBlocked": {
"type": "boolean",
"description": "Missing provider value cannot be copied. Also respect copyPlan.mode=blocked."
},
"copyPlan": {
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": [
"create",
"replace",
"preserve",
"blocked"
]
},
"value": {
"type": "string"
},
"previousValue": {
"type": "string"
},
"message": {
"type": "string"
}
},
"required": [
"mode"
],
"additionalProperties": true,
"description": "Use value for create/replace, keep existing policy for preserve, and resolve message before copying for blocked."
},
"errorMessage": {
"type": "string"
},
"error_message": {
"type": "string"
},
"lastCheckedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"verifiedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"createdAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"updatedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"additionalProperties": true
}
},
"featureSummaries": {
"type": "array",
"items": {
"type": "object",
"properties": {
"featureKey": {
"type": "string"
},
"feature_key": {
"type": "string"
},
"label": {
"type": "string"
},
"status": {
"type": "string"
},
"completeCount": {
"type": "integer"
},
"requiredCount": {
"type": "integer"
},
"totalCount": {
"type": "integer"
},
"records": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": [
"integer",
"null"
]
},
"developerDomainId": {
"type": [
"integer",
"null"
]
},
"stepKey": {
"type": "string"
},
"step_key": {
"type": "string"
},
"featureKey": {
"type": "string"
},
"feature_key": {
"type": "string"
},
"title": {
"type": "string"
},
"description": {
"type": "string"
},
"warning": {
"type": "string"
},
"purpose": {
"type": "string"
},
"required": {
"type": "boolean"
},
"status": {
"type": "string"
},
"action": {
"type": "string",
"description": "Non-DNS step: prepare-domains, storefront-provider, email-providers or email-identity. Do not add it as a DNS row."
},
"type": {
"type": "string",
"description": "DNS type returned by the provider, such as A, CNAME, TXT or MX; absent on action steps."
},
"host": {
"type": "string"
},
"name": {
"type": "string"
},
"value": {
"type": "string"
},
"ttl": {
"type": [
"string",
"integer"
]
},
"priority": {
"type": "integer",
"description": "MX priority, entered separately from exchange."
},
"exchange": {
"type": "string"
},
"copyBlocked": {
"type": "boolean",
"description": "Missing provider value cannot be copied. Also respect copyPlan.mode=blocked."
},
"copyPlan": {
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": [
"create",
"replace",
"preserve",
"blocked"
]
},
"value": {
"type": "string"
},
"previousValue": {
"type": "string"
},
"message": {
"type": "string"
}
},
"required": [
"mode"
],
"additionalProperties": true,
"description": "Use value for create/replace, keep existing policy for preserve, and resolve message before copying for blocked."
},
"errorMessage": {
"type": "string"
},
"error_message": {
"type": "string"
},
"lastCheckedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"verifiedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"createdAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"updatedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"additionalProperties": true
}
}
},
"additionalProperties": true
}
},
"events": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
},
"status": {
"type": "string"
},
"created_at": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"updated_at": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"additionalProperties": true
}
},
"allRequiredVerified": {
"type": "boolean"
},
"providerSupport": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
},
"branding": {
"type": "object",
"properties": {
"storeName": {
"type": "string"
},
"developerDisplayName": {
"type": "string"
},
"tagline": {
"type": "string"
},
"slug": {
"type": "string"
},
"shortDescription": {
"type": "string"
},
"marketplaceBio": {
"type": "string"
},
"logos": {
"type": "object",
"properties": {
"logoUrl": {
"type": "string"
},
"lightLogoUrl": {
"type": "string"
},
"darkLogoUrl": {
"type": "string"
},
"iconUrl": {
"type": "string"
},
"defaultProductImageUrl": {
"type": "string"
}
},
"additionalProperties": true
},
"colors": {
"type": "object",
"properties": {
"appearance": {
"type": "string",
"enum": [
"light",
"dark",
"system"
]
},
"backgroundColor": {
"type": "string"
},
"brandHighlightColor": {
"type": "string"
},
"accentColor": {
"type": "string"
},
"advancedOverrides": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
},
"additionalProperties": true
},
"support": {
"type": "object",
"properties": {
"supportEmail": {
"type": "string"
},
"supportUrl": {
"type": "string"
},
"documentationUrl": {
"type": "string"
},
"faqUrl": {
"type": "string"
},
"refundPolicyUrl": {
"type": "string"
},
"termsUrl": {
"type": "string"
},
"licenseUrl": {
"type": "string"
}
},
"additionalProperties": true
},
"emailIdentity": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
},
"socialLinks": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
},
"domains": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
},
"metadata": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
},
"additionalProperties": true
},
"storefrontDomain": {
"type": "string"
},
"emailDomains": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
},
"domain": {
"type": "string"
},
"fromLocalPart": {
"type": "string"
},
"senderEmail": {
"type": "string"
},
"status": {
"type": "string"
},
"verified": {
"type": "boolean"
},
"elasticStatus": {
"type": "string"
},
"elasticVerified": {
"type": "boolean"
},
"unifiedVerified": {
"type": "boolean"
},
"dnsRecords": {
"type": "array",
"items": {
"type": "object",
"properties": {
"provider": {
"type": "string"
},
"record": {
"type": "string"
},
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"value": {
"type": "string"
},
"ttl": {
"type": [
"string",
"number"
]
},
"priority": {
"type": [
"number",
"null"
]
},
"status": {
"type": "string"
}
},
"additionalProperties": true
}
},
"providerVerification": {
"type": "object",
"properties": {
"resend": {
"type": "object",
"properties": {
"provider": {
"type": "string"
},
"status": {
"type": "string"
},
"verified": {
"type": "boolean"
},
"dnsRecords": {
"type": "array",
"items": {
"type": "object",
"properties": {
"provider": {
"type": "string"
},
"record": {
"type": "string"
},
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"value": {
"type": "string"
},
"ttl": {
"type": [
"string",
"number"
]
},
"priority": {
"type": [
"number",
"null"
]
},
"status": {
"type": "string"
}
},
"additionalProperties": true
}
},
"verifiedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"lastCheckedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"lastError": {
"type": [
"string",
"null"
]
},
"metadata": {
"type": "object",
"properties": {
"sendingEnabled": {
"type": "boolean"
},
"sendingReady": {
"type": "boolean"
},
"trackingReady": {
"type": "boolean"
},
"trackingCertificateReady": {
"type": "boolean"
},
"certificateExpiresAt": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
},
"elastic": {
"type": "object",
"properties": {
"provider": {
"type": "string"
},
"status": {
"type": "string"
},
"verified": {
"type": "boolean"
},
"dnsRecords": {
"type": "array",
"items": {
"type": "object",
"properties": {
"provider": {
"type": "string"
},
"record": {
"type": "string"
},
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"value": {
"type": "string"
},
"ttl": {
"type": [
"string",
"number"
]
},
"priority": {
"type": [
"number",
"null"
]
},
"status": {
"type": "string"
}
},
"additionalProperties": true
}
},
"verifiedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"lastCheckedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"lastError": {
"type": [
"string",
"null"
]
},
"metadata": {
"type": "object",
"properties": {
"sendingEnabled": {
"type": "boolean"
},
"sendingReady": {
"type": "boolean"
},
"trackingReady": {
"type": "boolean"
},
"trackingCertificateReady": {
"type": "boolean"
},
"certificateExpiresAt": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}
},
"additionalProperties": true
},
"providerReadErrors": {
"type": "object",
"properties": {
"resend": {
"type": "string"
},
"elastic": {
"type": "string"
}
},
"additionalProperties": true
},
"verifiedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"lastCheckedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"lastError": {
"type": [
"string",
"null"
]
}
},
"additionalProperties": true
}
},
"emailDomainSettings": {
"type": "object",
"properties": {
"supportEmail": {
"type": "string"
},
"supportEmailPresent": {
"type": "boolean"
},
"brandDomainOwnershipReady": {
"type": "boolean"
},
"customDomain": {
"type": [
"object",
"null"
],
"properties": {
"id": {
"type": "integer",
"minimum": 1
},
"domain": {
"type": "string"
},
"fromLocalPart": {
"type": "string"
},
"senderEmail": {
"type": "string"
},
"status": {
"type": "string"
},
"verified": {
"type": "boolean"
},
"elasticStatus": {
"type": "string"
},
"elasticVerified": {
"type": "boolean"
},
"unifiedVerified": {
"type": "boolean"
},
"dnsRecords": {
"type": "array",
"items": {
"type": "object",
"properties": {
"provider": {
"type": "string"
},
"record": {
"type": "string"
},
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"value": {
"type": "string"
},
"ttl": {
"type": [
"string",
"number"
]
},
"priority": {
"type": [
"number",
"null"
]
},
"status": {
"type": "string"
}
},
"additionalProperties": true
}
},
"providerVerification": {
"type": "object",
"properties": {
"resend": {
"type": "object",
"properties": {
"provider": {
"type": "string"
},
"status": {
"type": "string"
},
"verified": {
"type": "boolean"
},
"dnsRecords": {
"type": "array",
"items": {
"type": "object",
"properties": {
"provider": {
"type": "string"
},
"record": {
"type": "string"
},
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"value": {
"type": "string"
},
"ttl": {
"type": [
"string",
"number"
]
},
"priority": {
"type": [
"number",
"null"
]
},
"status": {
"type": "string"
}
},
"additionalProperties": true
}
},
"verifiedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"lastCheckedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"lastError": {
"type": [
"string",
"null"
]
},
"metadata": {
"type": "object",
"properties": {
"sendingEnabled": {
"type": "boolean"
},
"sendingReady": {
"type": "boolean"
},
"trackingReady": {
"type": "boolean"
},
"trackingCertificateReady": {
"type": "boolean"
},
"certificateExpiresAt": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
},
"elastic": {
"type": "object",
"properties": {
"provider": {
"type": "string"
},
"status": {
"type": "string"
},
"verified": {
"type": "boolean"
},
"dnsRecords": {
"type": "array",
"items": {
"type": "object",
"properties": {
"provider": {
"type": "string"
},
"record": {
"type": "string"
},
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"value": {
"type": "string"
},
"ttl": {
"type": [
"string",
"number"
]
},
"priority": {
"type": [
"number",
"null"
]
},
"status": {
"type": "string"
}
},
"additionalProperties": true
}
},
"verifiedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"lastCheckedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"lastError": {
"type": [
"string",
"null"
]
},
"metadata": {
"type": "object",
"properties": {
"sendingEnabled": {
"type": "boolean"
},
"sendingReady": {
"type": "boolean"
},
"trackingReady": {
"type": "boolean"
},
"trackingCertificateReady": {
"type": "boolean"
},
"certificateExpiresAt": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}
},
"additionalProperties": true
},
"providerReadErrors": {
"type": "object",
"properties": {
"resend": {
"type": "string"
},
"elastic": {
"type": "string"
}
},
"additionalProperties": true
},
"verifiedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"lastCheckedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"lastError": {
"type": [
"string",
"null"
]
}
},
"additionalProperties": true
},
"domainStatus": {
"type": [
"string",
"null"
]
},
"marketingDomainStatus": {
"type": [
"string",
"null"
]
},
"senderProfiles": {
"type": "object",
"properties": {
"licensing": {
"type": "object",
"properties": {
"purpose": {
"enum": [
"licensing",
"notifications",
"marketing"
]
},
"label": {
"type": "string"
},
"localPart": {
"type": "string"
},
"fromEmail": {
"type": "string"
},
"editable": {
"type": "boolean"
}
},
"additionalProperties": true
},
"notifications": {
"type": "object",
"properties": {
"purpose": {
"enum": [
"licensing",
"notifications",
"marketing"
]
},
"label": {
"type": "string"
},
"localPart": {
"type": "string"
},
"fromEmail": {
"type": "string"
},
"editable": {
"type": "boolean"
}
},
"additionalProperties": true
},
"marketing": {
"type": "object",
"properties": {
"purpose": {
"enum": [
"licensing",
"notifications",
"marketing"
]
},
"label": {
"type": "string"
},
"localPart": {
"type": "string"
},
"fromEmail": {
"type": "string"
},
"editable": {
"type": "boolean"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
},
"customSendingUsable": {
"type": "boolean"
},
"transactionalSendingUsable": {
"type": "boolean"
},
"marketingSendingUsable": {
"type": "boolean"
},
"marketingTrackingUsable": {
"type": "boolean"
},
"trackClicks": {
"type": "boolean"
},
"trackOpens": {
"type": "boolean"
},
"canDisableUnsafeMarketingTracking": {
"type": "boolean"
},
"unifiedDomainVerified": {
"type": "boolean"
},
"providerReadiness": {
"type": "object",
"properties": {
"configured": {
"type": "boolean"
},
"transactional": {
"type": "boolean"
},
"marketing": {
"type": "boolean"
},
"tracking": {
"type": "boolean"
},
"ready": {
"type": "boolean"
}
},
"additionalProperties": true
},
"blockingReasons": {
"type": "array",
"items": {
"type": "string"
}
},
"transactionalBlockingReasons": {
"type": "array",
"items": {
"type": "string"
}
},
"marketingBlockingReasons": {
"type": "array",
"items": {
"type": "string"
}
},
"trackingBlockingReasons": {
"type": "array",
"items": {
"type": "string"
}
},
"fallbackSender": {
"type": "string"
}
},
"additionalProperties": true
},
"needsPreparation": {
"type": "boolean"
},
"automaticProviderSetup": {
"type": "boolean"
},
"emailProvidersConfigured": {
"type": "boolean"
},
"emailProvidersReady": {
"type": "boolean"
},
"providerPreparation": {
"type": "object",
"properties": {
"ready": {
"type": "boolean"
},
"missingRecords": {
"type": "array",
"items": {
"type": "string"
}
},
"errorMessage": {
"type": "string"
}
},
"additionalProperties": true
},
"readiness": {
"type": "object",
"properties": {
"dns": {
"type": "boolean"
},
"storefront": {
"type": "boolean"
},
"email": {
"type": "boolean"
},
"tracking": {
"type": "boolean"
},
"transactional": {
"type": "boolean"
},
"marketing": {
"type": "boolean"
},
"senders": {
"type": "boolean"
},
"identity": {
"type": "boolean"
},
"providersConfigured": {
"type": "boolean"
},
"ready": {
"type": "boolean"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}Documented failures: 400, 401, 403, 404, 409, 500, 503.
Operation errors: BRAND_DOMAIN_NOT_FOUND, DEVELOPER_BRAND_DOMAIN_ERROR, developer_team_permission_denied, developer_team_all_products_scope_required.
POST
/api/developer/brand/domain/email-providers
Connect or refresh the domain with email providers
- Auth
- Account Bearer JWT
- Scope
- domains.view + domains.manage and all-products workspace scope.
- Returns
- HTTP 200: domain, providerDetection, currentStep, current_step, wizardProgress, records, featureSummaries, events, allRequiredVerified, providerSupport, branding, storefrontDomain, emailDomains, emailDomainSettings, needsPreparation, automaticProviderSetup, emailProvidersConfigured, emailProvidersReady, providerPreparation, readiness.
- Notes
- Requires domains.view, domains.manage and all-products workspace scope. No request body fields are read. Creates a missing sending-domain registration or refreshes the existing one, then returns wizard state. Read providerVerification and readiness for transactional, marketing and secure tracking status; HTTP 200 is not activation or delivery proof. Provider failures can return an operation error. Does not change incoming mailbox hosting or registrar DNS. domains.view + domains.manage and all-products workspace scope. Selected-product teammates cannot use this workspace-wide domain wizard.
Request, response and error reference
No request body fields are read by this operation.
HTTP 200 response (application/json)
{
"type": "object",
"properties": {
"domain": {
"type": [
"object",
"null"
],
"properties": {
"id": {
"type": "integer",
"minimum": 1
},
"domain": {
"type": "string"
},
"status": {
"type": "string"
},
"verified": {
"type": "boolean"
},
"dnsRecords": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"name": {
"type": "string"
},
"value": {
"type": "string"
}
},
"additionalProperties": true
}
},
"sslStatus": {
"type": "string"
},
"rootDomain": {
"type": "string"
},
"storefrontSubdomain": {
"type": "string"
},
"setupStatus": {
"type": "string"
},
"currentStepKey": {
"type": "string"
}
},
"additionalProperties": true
},
"providerDetection": {
"type": [
"object",
"null"
],
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
},
"currentStep": {
"type": [
"object",
"null"
],
"properties": {
"id": {
"type": [
"integer",
"null"
]
},
"developerDomainId": {
"type": [
"integer",
"null"
]
},
"stepKey": {
"type": "string"
},
"step_key": {
"type": "string"
},
"featureKey": {
"type": "string"
},
"feature_key": {
"type": "string"
},
"title": {
"type": "string"
},
"description": {
"type": "string"
},
"warning": {
"type": "string"
},
"purpose": {
"type": "string"
},
"required": {
"type": "boolean"
},
"status": {
"type": "string"
},
"action": {
"type": "string",
"description": "Non-DNS step: prepare-domains, storefront-provider, email-providers or email-identity. Do not add it as a DNS row."
},
"type": {
"type": "string",
"description": "DNS type returned by the provider, such as A, CNAME, TXT or MX; absent on action steps."
},
"host": {
"type": "string"
},
"name": {
"type": "string"
},
"value": {
"type": "string"
},
"ttl": {
"type": [
"string",
"integer"
]
},
"priority": {
"type": "integer",
"description": "MX priority, entered separately from exchange."
},
"exchange": {
"type": "string"
},
"copyBlocked": {
"type": "boolean",
"description": "Missing provider value cannot be copied. Also respect copyPlan.mode=blocked."
},
"copyPlan": {
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": [
"create",
"replace",
"preserve",
"blocked"
]
},
"value": {
"type": "string"
},
"previousValue": {
"type": "string"
},
"message": {
"type": "string"
}
},
"required": [
"mode"
],
"additionalProperties": true,
"description": "Use value for create/replace, keep existing policy for preserve, and resolve message before copying for blocked."
},
"errorMessage": {
"type": "string"
},
"error_message": {
"type": "string"
},
"lastCheckedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"verifiedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"createdAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"updatedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"additionalProperties": true
},
"current_step": {
"type": [
"object",
"null"
],
"properties": {
"id": {
"type": [
"integer",
"null"
]
},
"developerDomainId": {
"type": [
"integer",
"null"
]
},
"stepKey": {
"type": "string"
},
"step_key": {
"type": "string"
},
"featureKey": {
"type": "string"
},
"feature_key": {
"type": "string"
},
"title": {
"type": "string"
},
"description": {
"type": "string"
},
"warning": {
"type": "string"
},
"purpose": {
"type": "string"
},
"required": {
"type": "boolean"
},
"status": {
"type": "string"
},
"action": {
"type": "string",
"description": "Non-DNS step: prepare-domains, storefront-provider, email-providers or email-identity. Do not add it as a DNS row."
},
"type": {
"type": "string",
"description": "DNS type returned by the provider, such as A, CNAME, TXT or MX; absent on action steps."
},
"host": {
"type": "string"
},
"name": {
"type": "string"
},
"value": {
"type": "string"
},
"ttl": {
"type": [
"string",
"integer"
]
},
"priority": {
"type": "integer",
"description": "MX priority, entered separately from exchange."
},
"exchange": {
"type": "string"
},
"copyBlocked": {
"type": "boolean",
"description": "Missing provider value cannot be copied. Also respect copyPlan.mode=blocked."
},
"copyPlan": {
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": [
"create",
"replace",
"preserve",
"blocked"
]
},
"value": {
"type": "string"
},
"previousValue": {
"type": "string"
},
"message": {
"type": "string"
}
},
"required": [
"mode"
],
"additionalProperties": true,
"description": "Use value for create/replace, keep existing policy for preserve, and resolve message before copying for blocked."
},
"errorMessage": {
"type": "string"
},
"error_message": {
"type": "string"
},
"lastCheckedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"verifiedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"createdAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"updatedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"additionalProperties": true
},
"wizardProgress": {
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string"
},
"label": {
"type": "string"
},
"status": {
"type": "string"
},
"completeCount": {
"type": "integer"
},
"totalCount": {
"type": "integer"
}
},
"additionalProperties": true
}
},
"records": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": [
"integer",
"null"
]
},
"developerDomainId": {
"type": [
"integer",
"null"
]
},
"stepKey": {
"type": "string"
},
"step_key": {
"type": "string"
},
"featureKey": {
"type": "string"
},
"feature_key": {
"type": "string"
},
"title": {
"type": "string"
},
"description": {
"type": "string"
},
"warning": {
"type": "string"
},
"purpose": {
"type": "string"
},
"required": {
"type": "boolean"
},
"status": {
"type": "string"
},
"action": {
"type": "string",
"description": "Non-DNS step: prepare-domains, storefront-provider, email-providers or email-identity. Do not add it as a DNS row."
},
"type": {
"type": "string",
"description": "DNS type returned by the provider, such as A, CNAME, TXT or MX; absent on action steps."
},
"host": {
"type": "string"
},
"name": {
"type": "string"
},
"value": {
"type": "string"
},
"ttl": {
"type": [
"string",
"integer"
]
},
"priority": {
"type": "integer",
"description": "MX priority, entered separately from exchange."
},
"exchange": {
"type": "string"
},
"copyBlocked": {
"type": "boolean",
"description": "Missing provider value cannot be copied. Also respect copyPlan.mode=blocked."
},
"copyPlan": {
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": [
"create",
"replace",
"preserve",
"blocked"
]
},
"value": {
"type": "string"
},
"previousValue": {
"type": "string"
},
"message": {
"type": "string"
}
},
"required": [
"mode"
],
"additionalProperties": true,
"description": "Use value for create/replace, keep existing policy for preserve, and resolve message before copying for blocked."
},
"errorMessage": {
"type": "string"
},
"error_message": {
"type": "string"
},
"lastCheckedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"verifiedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"createdAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"updatedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"additionalProperties": true
}
},
"featureSummaries": {
"type": "array",
"items": {
"type": "object",
"properties": {
"featureKey": {
"type": "string"
},
"feature_key": {
"type": "string"
},
"label": {
"type": "string"
},
"status": {
"type": "string"
},
"completeCount": {
"type": "integer"
},
"requiredCount": {
"type": "integer"
},
"totalCount": {
"type": "integer"
},
"records": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": [
"integer",
"null"
]
},
"developerDomainId": {
"type": [
"integer",
"null"
]
},
"stepKey": {
"type": "string"
},
"step_key": {
"type": "string"
},
"featureKey": {
"type": "string"
},
"feature_key": {
"type": "string"
},
"title": {
"type": "string"
},
"description": {
"type": "string"
},
"warning": {
"type": "string"
},
"purpose": {
"type": "string"
},
"required": {
"type": "boolean"
},
"status": {
"type": "string"
},
"action": {
"type": "string",
"description": "Non-DNS step: prepare-domains, storefront-provider, email-providers or email-identity. Do not add it as a DNS row."
},
"type": {
"type": "string",
"description": "DNS type returned by the provider, such as A, CNAME, TXT or MX; absent on action steps."
},
"host": {
"type": "string"
},
"name": {
"type": "string"
},
"value": {
"type": "string"
},
"ttl": {
"type": [
"string",
"integer"
]
},
"priority": {
"type": "integer",
"description": "MX priority, entered separately from exchange."
},
"exchange": {
"type": "string"
},
"copyBlocked": {
"type": "boolean",
"description": "Missing provider value cannot be copied. Also respect copyPlan.mode=blocked."
},
"copyPlan": {
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": [
"create",
"replace",
"preserve",
"blocked"
]
},
"value": {
"type": "string"
},
"previousValue": {
"type": "string"
},
"message": {
"type": "string"
}
},
"required": [
"mode"
],
"additionalProperties": true,
"description": "Use value for create/replace, keep existing policy for preserve, and resolve message before copying for blocked."
},
"errorMessage": {
"type": "string"
},
"error_message": {
"type": "string"
},
"lastCheckedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"verifiedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"createdAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"updatedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"additionalProperties": true
}
}
},
"additionalProperties": true
}
},
"events": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
},
"status": {
"type": "string"
},
"created_at": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"updated_at": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"additionalProperties": true
}
},
"allRequiredVerified": {
"type": "boolean"
},
"providerSupport": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
},
"branding": {
"type": "object",
"properties": {
"storeName": {
"type": "string"
},
"developerDisplayName": {
"type": "string"
},
"tagline": {
"type": "string"
},
"slug": {
"type": "string"
},
"shortDescription": {
"type": "string"
},
"marketplaceBio": {
"type": "string"
},
"logos": {
"type": "object",
"properties": {
"logoUrl": {
"type": "string"
},
"lightLogoUrl": {
"type": "string"
},
"darkLogoUrl": {
"type": "string"
},
"iconUrl": {
"type": "string"
},
"defaultProductImageUrl": {
"type": "string"
}
},
"additionalProperties": true
},
"colors": {
"type": "object",
"properties": {
"appearance": {
"type": "string",
"enum": [
"light",
"dark",
"system"
]
},
"backgroundColor": {
"type": "string"
},
"brandHighlightColor": {
"type": "string"
},
"accentColor": {
"type": "string"
},
"advancedOverrides": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
},
"additionalProperties": true
},
"support": {
"type": "object",
"properties": {
"supportEmail": {
"type": "string"
},
"supportUrl": {
"type": "string"
},
"documentationUrl": {
"type": "string"
},
"faqUrl": {
"type": "string"
},
"refundPolicyUrl": {
"type": "string"
},
"termsUrl": {
"type": "string"
},
"licenseUrl": {
"type": "string"
}
},
"additionalProperties": true
},
"emailIdentity": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
},
"socialLinks": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
},
"domains": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
},
"metadata": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
},
"additionalProperties": true
},
"storefrontDomain": {
"type": "string"
},
"emailDomains": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
},
"domain": {
"type": "string"
},
"fromLocalPart": {
"type": "string"
},
"senderEmail": {
"type": "string"
},
"status": {
"type": "string"
},
"verified": {
"type": "boolean"
},
"elasticStatus": {
"type": "string"
},
"elasticVerified": {
"type": "boolean"
},
"unifiedVerified": {
"type": "boolean"
},
"dnsRecords": {
"type": "array",
"items": {
"type": "object",
"properties": {
"provider": {
"type": "string"
},
"record": {
"type": "string"
},
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"value": {
"type": "string"
},
"ttl": {
"type": [
"string",
"number"
]
},
"priority": {
"type": [
"number",
"null"
]
},
"status": {
"type": "string"
}
},
"additionalProperties": true
}
},
"providerVerification": {
"type": "object",
"properties": {
"resend": {
"type": "object",
"properties": {
"provider": {
"type": "string"
},
"status": {
"type": "string"
},
"verified": {
"type": "boolean"
},
"dnsRecords": {
"type": "array",
"items": {
"type": "object",
"properties": {
"provider": {
"type": "string"
},
"record": {
"type": "string"
},
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"value": {
"type": "string"
},
"ttl": {
"type": [
"string",
"number"
]
},
"priority": {
"type": [
"number",
"null"
]
},
"status": {
"type": "string"
}
},
"additionalProperties": true
}
},
"verifiedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"lastCheckedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"lastError": {
"type": [
"string",
"null"
]
},
"metadata": {
"type": "object",
"properties": {
"sendingEnabled": {
"type": "boolean"
},
"sendingReady": {
"type": "boolean"
},
"trackingReady": {
"type": "boolean"
},
"trackingCertificateReady": {
"type": "boolean"
},
"certificateExpiresAt": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
},
"elastic": {
"type": "object",
"properties": {
"provider": {
"type": "string"
},
"status": {
"type": "string"
},
"verified": {
"type": "boolean"
},
"dnsRecords": {
"type": "array",
"items": {
"type": "object",
"properties": {
"provider": {
"type": "string"
},
"record": {
"type": "string"
},
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"value": {
"type": "string"
},
"ttl": {
"type": [
"string",
"number"
]
},
"priority": {
"type": [
"number",
"null"
]
},
"status": {
"type": "string"
}
},
"additionalProperties": true
}
},
"verifiedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"lastCheckedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"lastError": {
"type": [
"string",
"null"
]
},
"metadata": {
"type": "object",
"properties": {
"sendingEnabled": {
"type": "boolean"
},
"sendingReady": {
"type": "boolean"
},
"trackingReady": {
"type": "boolean"
},
"trackingCertificateReady": {
"type": "boolean"
},
"certificateExpiresAt": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}
},
"additionalProperties": true
},
"providerReadErrors": {
"type": "object",
"properties": {
"resend": {
"type": "string"
},
"elastic": {
"type": "string"
}
},
"additionalProperties": true
},
"verifiedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"lastCheckedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"lastError": {
"type": [
"string",
"null"
]
}
},
"additionalProperties": true
}
},
"emailDomainSettings": {
"type": "object",
"properties": {
"supportEmail": {
"type": "string"
},
"supportEmailPresent": {
"type": "boolean"
},
"brandDomainOwnershipReady": {
"type": "boolean"
},
"customDomain": {
"type": [
"object",
"null"
],
"properties": {
"id": {
"type": "integer",
"minimum": 1
},
"domain": {
"type": "string"
},
"fromLocalPart": {
"type": "string"
},
"senderEmail": {
"type": "string"
},
"status": {
"type": "string"
},
"verified": {
"type": "boolean"
},
"elasticStatus": {
"type": "string"
},
"elasticVerified": {
"type": "boolean"
},
"unifiedVerified": {
"type": "boolean"
},
"dnsRecords": {
"type": "array",
"items": {
"type": "object",
"properties": {
"provider": {
"type": "string"
},
"record": {
"type": "string"
},
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"value": {
"type": "string"
},
"ttl": {
"type": [
"string",
"number"
]
},
"priority": {
"type": [
"number",
"null"
]
},
"status": {
"type": "string"
}
},
"additionalProperties": true
}
},
"providerVerification": {
"type": "object",
"properties": {
"resend": {
"type": "object",
"properties": {
"provider": {
"type": "string"
},
"status": {
"type": "string"
},
"verified": {
"type": "boolean"
},
"dnsRecords": {
"type": "array",
"items": {
"type": "object",
"properties": {
"provider": {
"type": "string"
},
"record": {
"type": "string"
},
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"value": {
"type": "string"
},
"ttl": {
"type": [
"string",
"number"
]
},
"priority": {
"type": [
"number",
"null"
]
},
"status": {
"type": "string"
}
},
"additionalProperties": true
}
},
"verifiedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"lastCheckedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"lastError": {
"type": [
"string",
"null"
]
},
"metadata": {
"type": "object",
"properties": {
"sendingEnabled": {
"type": "boolean"
},
"sendingReady": {
"type": "boolean"
},
"trackingReady": {
"type": "boolean"
},
"trackingCertificateReady": {
"type": "boolean"
},
"certificateExpiresAt": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
},
"elastic": {
"type": "object",
"properties": {
"provider": {
"type": "string"
},
"status": {
"type": "string"
},
"verified": {
"type": "boolean"
},
"dnsRecords": {
"type": "array",
"items": {
"type": "object",
"properties": {
"provider": {
"type": "string"
},
"record": {
"type": "string"
},
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"value": {
"type": "string"
},
"ttl": {
"type": [
"string",
"number"
]
},
"priority": {
"type": [
"number",
"null"
]
},
"status": {
"type": "string"
}
},
"additionalProperties": true
}
},
"verifiedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"lastCheckedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"lastError": {
"type": [
"string",
"null"
]
},
"metadata": {
"type": "object",
"properties": {
"sendingEnabled": {
"type": "boolean"
},
"sendingReady": {
"type": "boolean"
},
"trackingReady": {
"type": "boolean"
},
"trackingCertificateReady": {
"type": "boolean"
},
"certificateExpiresAt": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}
},
"additionalProperties": true
},
"providerReadErrors": {
"type": "object",
"properties": {
"resend": {
"type": "string"
},
"elastic": {
"type": "string"
}
},
"additionalProperties": true
},
"verifiedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"lastCheckedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"lastError": {
"type": [
"string",
"null"
]
}
},
"additionalProperties": true
},
"domainStatus": {
"type": [
"string",
"null"
]
},
"marketingDomainStatus": {
"type": [
"string",
"null"
]
},
"senderProfiles": {
"type": "object",
"properties": {
"licensing": {
"type": "object",
"properties": {
"purpose": {
"enum": [
"licensing",
"notifications",
"marketing"
]
},
"label": {
"type": "string"
},
"localPart": {
"type": "string"
},
"fromEmail": {
"type": "string"
},
"editable": {
"type": "boolean"
}
},
"additionalProperties": true
},
"notifications": {
"type": "object",
"properties": {
"purpose": {
"enum": [
"licensing",
"notifications",
"marketing"
]
},
"label": {
"type": "string"
},
"localPart": {
"type": "string"
},
"fromEmail": {
"type": "string"
},
"editable": {
"type": "boolean"
}
},
"additionalProperties": true
},
"marketing": {
"type": "object",
"properties": {
"purpose": {
"enum": [
"licensing",
"notifications",
"marketing"
]
},
"label": {
"type": "string"
},
"localPart": {
"type": "string"
},
"fromEmail": {
"type": "string"
},
"editable": {
"type": "boolean"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
},
"customSendingUsable": {
"type": "boolean"
},
"transactionalSendingUsable": {
"type": "boolean"
},
"marketingSendingUsable": {
"type": "boolean"
},
"marketingTrackingUsable": {
"type": "boolean"
},
"trackClicks": {
"type": "boolean"
},
"trackOpens": {
"type": "boolean"
},
"canDisableUnsafeMarketingTracking": {
"type": "boolean"
},
"unifiedDomainVerified": {
"type": "boolean"
},
"providerReadiness": {
"type": "object",
"properties": {
"configured": {
"type": "boolean"
},
"transactional": {
"type": "boolean"
},
"marketing": {
"type": "boolean"
},
"tracking": {
"type": "boolean"
},
"ready": {
"type": "boolean"
}
},
"additionalProperties": true
},
"blockingReasons": {
"type": "array",
"items": {
"type": "string"
}
},
"transactionalBlockingReasons": {
"type": "array",
"items": {
"type": "string"
}
},
"marketingBlockingReasons": {
"type": "array",
"items": {
"type": "string"
}
},
"trackingBlockingReasons": {
"type": "array",
"items": {
"type": "string"
}
},
"fallbackSender": {
"type": "string"
}
},
"additionalProperties": true
},
"needsPreparation": {
"type": "boolean"
},
"automaticProviderSetup": {
"type": "boolean"
},
"emailProvidersConfigured": {
"type": "boolean"
},
"emailProvidersReady": {
"type": "boolean"
},
"providerPreparation": {
"type": "object",
"properties": {
"ready": {
"type": "boolean"
},
"missingRecords": {
"type": "array",
"items": {
"type": "string"
}
},
"errorMessage": {
"type": "string"
}
},
"additionalProperties": true
},
"readiness": {
"type": "object",
"properties": {
"dns": {
"type": "boolean"
},
"storefront": {
"type": "boolean"
},
"email": {
"type": "boolean"
},
"tracking": {
"type": "boolean"
},
"transactional": {
"type": "boolean"
},
"marketing": {
"type": "boolean"
},
"senders": {
"type": "boolean"
},
"identity": {
"type": "boolean"
},
"providersConfigured": {
"type": "boolean"
},
"ready": {
"type": "boolean"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}Documented failures: 400, 401, 403, 404, 409, 500, 503.
Operation errors: BRAND_DOMAIN_NOT_FOUND, DEVELOPER_BRAND_DOMAIN_ERROR, developer_team_permission_denied, developer_team_all_products_scope_required.
POST
/api/developer/brand/domain/storefront-provider
Connect or refresh the storefront hosting provider
- Auth
- Account Bearer JWT
- Scope
- domains.view + domains.manage and all-products workspace scope.
- Returns
- HTTP 200: domain, providerDetection, currentStep, current_step, wizardProgress, records, featureSummaries, events, allRequiredVerified, providerSupport, branding, storefrontDomain, emailDomains, emailDomainSettings, needsPreparation, automaticProviderSetup, emailProvidersConfigured, emailProvidersReady, providerPreparation, readiness.
- Notes
- Requires domains.view, domains.manage and all-products workspace scope. No request body fields are read. Registers a missing saved apex/subdomain with hosting or refreshes its existing connection. Routing verification and active SSL are separate readiness requirements; inspect currentStep and readiness.storefront. HTTP 200 alone does not prove the connection is ready. This write does not edit registrar DNS or promise certificate timing. domains.view + domains.manage and all-products workspace scope. Selected-product teammates cannot use this workspace-wide domain wizard.
Request, response and error reference
No request body fields are read by this operation.
HTTP 200 response (application/json)
{
"type": "object",
"properties": {
"domain": {
"type": [
"object",
"null"
],
"properties": {
"id": {
"type": "integer",
"minimum": 1
},
"domain": {
"type": "string"
},
"status": {
"type": "string"
},
"verified": {
"type": "boolean"
},
"dnsRecords": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"name": {
"type": "string"
},
"value": {
"type": "string"
}
},
"additionalProperties": true
}
},
"sslStatus": {
"type": "string"
},
"rootDomain": {
"type": "string"
},
"storefrontSubdomain": {
"type": "string"
},
"setupStatus": {
"type": "string"
},
"currentStepKey": {
"type": "string"
}
},
"additionalProperties": true
},
"providerDetection": {
"type": [
"object",
"null"
],
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
},
"currentStep": {
"type": [
"object",
"null"
],
"properties": {
"id": {
"type": [
"integer",
"null"
]
},
"developerDomainId": {
"type": [
"integer",
"null"
]
},
"stepKey": {
"type": "string"
},
"step_key": {
"type": "string"
},
"featureKey": {
"type": "string"
},
"feature_key": {
"type": "string"
},
"title": {
"type": "string"
},
"description": {
"type": "string"
},
"warning": {
"type": "string"
},
"purpose": {
"type": "string"
},
"required": {
"type": "boolean"
},
"status": {
"type": "string"
},
"action": {
"type": "string",
"description": "Non-DNS step: prepare-domains, storefront-provider, email-providers or email-identity. Do not add it as a DNS row."
},
"type": {
"type": "string",
"description": "DNS type returned by the provider, such as A, CNAME, TXT or MX; absent on action steps."
},
"host": {
"type": "string"
},
"name": {
"type": "string"
},
"value": {
"type": "string"
},
"ttl": {
"type": [
"string",
"integer"
]
},
"priority": {
"type": "integer",
"description": "MX priority, entered separately from exchange."
},
"exchange": {
"type": "string"
},
"copyBlocked": {
"type": "boolean",
"description": "Missing provider value cannot be copied. Also respect copyPlan.mode=blocked."
},
"copyPlan": {
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": [
"create",
"replace",
"preserve",
"blocked"
]
},
"value": {
"type": "string"
},
"previousValue": {
"type": "string"
},
"message": {
"type": "string"
}
},
"required": [
"mode"
],
"additionalProperties": true,
"description": "Use value for create/replace, keep existing policy for preserve, and resolve message before copying for blocked."
},
"errorMessage": {
"type": "string"
},
"error_message": {
"type": "string"
},
"lastCheckedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"verifiedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"createdAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"updatedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"additionalProperties": true
},
"current_step": {
"type": [
"object",
"null"
],
"properties": {
"id": {
"type": [
"integer",
"null"
]
},
"developerDomainId": {
"type": [
"integer",
"null"
]
},
"stepKey": {
"type": "string"
},
"step_key": {
"type": "string"
},
"featureKey": {
"type": "string"
},
"feature_key": {
"type": "string"
},
"title": {
"type": "string"
},
"description": {
"type": "string"
},
"warning": {
"type": "string"
},
"purpose": {
"type": "string"
},
"required": {
"type": "boolean"
},
"status": {
"type": "string"
},
"action": {
"type": "string",
"description": "Non-DNS step: prepare-domains, storefront-provider, email-providers or email-identity. Do not add it as a DNS row."
},
"type": {
"type": "string",
"description": "DNS type returned by the provider, such as A, CNAME, TXT or MX; absent on action steps."
},
"host": {
"type": "string"
},
"name": {
"type": "string"
},
"value": {
"type": "string"
},
"ttl": {
"type": [
"string",
"integer"
]
},
"priority": {
"type": "integer",
"description": "MX priority, entered separately from exchange."
},
"exchange": {
"type": "string"
},
"copyBlocked": {
"type": "boolean",
"description": "Missing provider value cannot be copied. Also respect copyPlan.mode=blocked."
},
"copyPlan": {
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": [
"create",
"replace",
"preserve",
"blocked"
]
},
"value": {
"type": "string"
},
"previousValue": {
"type": "string"
},
"message": {
"type": "string"
}
},
"required": [
"mode"
],
"additionalProperties": true,
"description": "Use value for create/replace, keep existing policy for preserve, and resolve message before copying for blocked."
},
"errorMessage": {
"type": "string"
},
"error_message": {
"type": "string"
},
"lastCheckedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"verifiedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"createdAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"updatedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"additionalProperties": true
},
"wizardProgress": {
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string"
},
"label": {
"type": "string"
},
"status": {
"type": "string"
},
"completeCount": {
"type": "integer"
},
"totalCount": {
"type": "integer"
}
},
"additionalProperties": true
}
},
"records": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": [
"integer",
"null"
]
},
"developerDomainId": {
"type": [
"integer",
"null"
]
},
"stepKey": {
"type": "string"
},
"step_key": {
"type": "string"
},
"featureKey": {
"type": "string"
},
"feature_key": {
"type": "string"
},
"title": {
"type": "string"
},
"description": {
"type": "string"
},
"warning": {
"type": "string"
},
"purpose": {
"type": "string"
},
"required": {
"type": "boolean"
},
"status": {
"type": "string"
},
"action": {
"type": "string",
"description": "Non-DNS step: prepare-domains, storefront-provider, email-providers or email-identity. Do not add it as a DNS row."
},
"type": {
"type": "string",
"description": "DNS type returned by the provider, such as A, CNAME, TXT or MX; absent on action steps."
},
"host": {
"type": "string"
},
"name": {
"type": "string"
},
"value": {
"type": "string"
},
"ttl": {
"type": [
"string",
"integer"
]
},
"priority": {
"type": "integer",
"description": "MX priority, entered separately from exchange."
},
"exchange": {
"type": "string"
},
"copyBlocked": {
"type": "boolean",
"description": "Missing provider value cannot be copied. Also respect copyPlan.mode=blocked."
},
"copyPlan": {
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": [
"create",
"replace",
"preserve",
"blocked"
]
},
"value": {
"type": "string"
},
"previousValue": {
"type": "string"
},
"message": {
"type": "string"
}
},
"required": [
"mode"
],
"additionalProperties": true,
"description": "Use value for create/replace, keep existing policy for preserve, and resolve message before copying for blocked."
},
"errorMessage": {
"type": "string"
},
"error_message": {
"type": "string"
},
"lastCheckedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"verifiedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"createdAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"updatedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"additionalProperties": true
}
},
"featureSummaries": {
"type": "array",
"items": {
"type": "object",
"properties": {
"featureKey": {
"type": "string"
},
"feature_key": {
"type": "string"
},
"label": {
"type": "string"
},
"status": {
"type": "string"
},
"completeCount": {
"type": "integer"
},
"requiredCount": {
"type": "integer"
},
"totalCount": {
"type": "integer"
},
"records": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": [
"integer",
"null"
]
},
"developerDomainId": {
"type": [
"integer",
"null"
]
},
"stepKey": {
"type": "string"
},
"step_key": {
"type": "string"
},
"featureKey": {
"type": "string"
},
"feature_key": {
"type": "string"
},
"title": {
"type": "string"
},
"description": {
"type": "string"
},
"warning": {
"type": "string"
},
"purpose": {
"type": "string"
},
"required": {
"type": "boolean"
},
"status": {
"type": "string"
},
"action": {
"type": "string",
"description": "Non-DNS step: prepare-domains, storefront-provider, email-providers or email-identity. Do not add it as a DNS row."
},
"type": {
"type": "string",
"description": "DNS type returned by the provider, such as A, CNAME, TXT or MX; absent on action steps."
},
"host": {
"type": "string"
},
"name": {
"type": "string"
},
"value": {
"type": "string"
},
"ttl": {
"type": [
"string",
"integer"
]
},
"priority": {
"type": "integer",
"description": "MX priority, entered separately from exchange."
},
"exchange": {
"type": "string"
},
"copyBlocked": {
"type": "boolean",
"description": "Missing provider value cannot be copied. Also respect copyPlan.mode=blocked."
},
"copyPlan": {
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": [
"create",
"replace",
"preserve",
"blocked"
]
},
"value": {
"type": "string"
},
"previousValue": {
"type": "string"
},
"message": {
"type": "string"
}
},
"required": [
"mode"
],
"additionalProperties": true,
"description": "Use value for create/replace, keep existing policy for preserve, and resolve message before copying for blocked."
},
"errorMessage": {
"type": "string"
},
"error_message": {
"type": "string"
},
"lastCheckedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"verifiedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"createdAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"updatedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"additionalProperties": true
}
}
},
"additionalProperties": true
}
},
"events": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
},
"status": {
"type": "string"
},
"created_at": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"updated_at": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"additionalProperties": true
}
},
"allRequiredVerified": {
"type": "boolean"
},
"providerSupport": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
},
"branding": {
"type": "object",
"properties": {
"storeName": {
"type": "string"
},
"developerDisplayName": {
"type": "string"
},
"tagline": {
"type": "string"
},
"slug": {
"type": "string"
},
"shortDescription": {
"type": "string"
},
"marketplaceBio": {
"type": "string"
},
"logos": {
"type": "object",
"properties": {
"logoUrl": {
"type": "string"
},
"lightLogoUrl": {
"type": "string"
},
"darkLogoUrl": {
"type": "string"
},
"iconUrl": {
"type": "string"
},
"defaultProductImageUrl": {
"type": "string"
}
},
"additionalProperties": true
},
"colors": {
"type": "object",
"properties": {
"appearance": {
"type": "string",
"enum": [
"light",
"dark",
"system"
]
},
"backgroundColor": {
"type": "string"
},
"brandHighlightColor": {
"type": "string"
},
"accentColor": {
"type": "string"
},
"advancedOverrides": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
},
"additionalProperties": true
},
"support": {
"type": "object",
"properties": {
"supportEmail": {
"type": "string"
},
"supportUrl": {
"type": "string"
},
"documentationUrl": {
"type": "string"
},
"faqUrl": {
"type": "string"
},
"refundPolicyUrl": {
"type": "string"
},
"termsUrl": {
"type": "string"
},
"licenseUrl": {
"type": "string"
}
},
"additionalProperties": true
},
"emailIdentity": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
},
"socialLinks": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
},
"domains": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
},
"metadata": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
},
"additionalProperties": true
},
"storefrontDomain": {
"type": "string"
},
"emailDomains": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
},
"domain": {
"type": "string"
},
"fromLocalPart": {
"type": "string"
},
"senderEmail": {
"type": "string"
},
"status": {
"type": "string"
},
"verified": {
"type": "boolean"
},
"elasticStatus": {
"type": "string"
},
"elasticVerified": {
"type": "boolean"
},
"unifiedVerified": {
"type": "boolean"
},
"dnsRecords": {
"type": "array",
"items": {
"type": "object",
"properties": {
"provider": {
"type": "string"
},
"record": {
"type": "string"
},
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"value": {
"type": "string"
},
"ttl": {
"type": [
"string",
"number"
]
},
"priority": {
"type": [
"number",
"null"
]
},
"status": {
"type": "string"
}
},
"additionalProperties": true
}
},
"providerVerification": {
"type": "object",
"properties": {
"resend": {
"type": "object",
"properties": {
"provider": {
"type": "string"
},
"status": {
"type": "string"
},
"verified": {
"type": "boolean"
},
"dnsRecords": {
"type": "array",
"items": {
"type": "object",
"properties": {
"provider": {
"type": "string"
},
"record": {
"type": "string"
},
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"value": {
"type": "string"
},
"ttl": {
"type": [
"string",
"number"
]
},
"priority": {
"type": [
"number",
"null"
]
},
"status": {
"type": "string"
}
},
"additionalProperties": true
}
},
"verifiedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"lastCheckedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"lastError": {
"type": [
"string",
"null"
]
},
"metadata": {
"type": "object",
"properties": {
"sendingEnabled": {
"type": "boolean"
},
"sendingReady": {
"type": "boolean"
},
"trackingReady": {
"type": "boolean"
},
"trackingCertificateReady": {
"type": "boolean"
},
"certificateExpiresAt": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
},
"elastic": {
"type": "object",
"properties": {
"provider": {
"type": "string"
},
"status": {
"type": "string"
},
"verified": {
"type": "boolean"
},
"dnsRecords": {
"type": "array",
"items": {
"type": "object",
"properties": {
"provider": {
"type": "string"
},
"record": {
"type": "string"
},
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"value": {
"type": "string"
},
"ttl": {
"type": [
"string",
"number"
]
},
"priority": {
"type": [
"number",
"null"
]
},
"status": {
"type": "string"
}
},
"additionalProperties": true
}
},
"verifiedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"lastCheckedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"lastError": {
"type": [
"string",
"null"
]
},
"metadata": {
"type": "object",
"properties": {
"sendingEnabled": {
"type": "boolean"
},
"sendingReady": {
"type": "boolean"
},
"trackingReady": {
"type": "boolean"
},
"trackingCertificateReady": {
"type": "boolean"
},
"certificateExpiresAt": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}
},
"additionalProperties": true
},
"providerReadErrors": {
"type": "object",
"properties": {
"resend": {
"type": "string"
},
"elastic": {
"type": "string"
}
},
"additionalProperties": true
},
"verifiedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"lastCheckedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"lastError": {
"type": [
"string",
"null"
]
}
},
"additionalProperties": true
}
},
"emailDomainSettings": {
"type": "object",
"properties": {
"supportEmail": {
"type": "string"
},
"supportEmailPresent": {
"type": "boolean"
},
"brandDomainOwnershipReady": {
"type": "boolean"
},
"customDomain": {
"type": [
"object",
"null"
],
"properties": {
"id": {
"type": "integer",
"minimum": 1
},
"domain": {
"type": "string"
},
"fromLocalPart": {
"type": "string"
},
"senderEmail": {
"type": "string"
},
"status": {
"type": "string"
},
"verified": {
"type": "boolean"
},
"elasticStatus": {
"type": "string"
},
"elasticVerified": {
"type": "boolean"
},
"unifiedVerified": {
"type": "boolean"
},
"dnsRecords": {
"type": "array",
"items": {
"type": "object",
"properties": {
"provider": {
"type": "string"
},
"record": {
"type": "string"
},
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"value": {
"type": "string"
},
"ttl": {
"type": [
"string",
"number"
]
},
"priority": {
"type": [
"number",
"null"
]
},
"status": {
"type": "string"
}
},
"additionalProperties": true
}
},
"providerVerification": {
"type": "object",
"properties": {
"resend": {
"type": "object",
"properties": {
"provider": {
"type": "string"
},
"status": {
"type": "string"
},
"verified": {
"type": "boolean"
},
"dnsRecords": {
"type": "array",
"items": {
"type": "object",
"properties": {
"provider": {
"type": "string"
},
"record": {
"type": "string"
},
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"value": {
"type": "string"
},
"ttl": {
"type": [
"string",
"number"
]
},
"priority": {
"type": [
"number",
"null"
]
},
"status": {
"type": "string"
}
},
"additionalProperties": true
}
},
"verifiedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"lastCheckedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"lastError": {
"type": [
"string",
"null"
]
},
"metadata": {
"type": "object",
"properties": {
"sendingEnabled": {
"type": "boolean"
},
"sendingReady": {
"type": "boolean"
},
"trackingReady": {
"type": "boolean"
},
"trackingCertificateReady": {
"type": "boolean"
},
"certificateExpiresAt": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
},
"elastic": {
"type": "object",
"properties": {
"provider": {
"type": "string"
},
"status": {
"type": "string"
},
"verified": {
"type": "boolean"
},
"dnsRecords": {
"type": "array",
"items": {
"type": "object",
"properties": {
"provider": {
"type": "string"
},
"record": {
"type": "string"
},
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"value": {
"type": "string"
},
"ttl": {
"type": [
"string",
"number"
]
},
"priority": {
"type": [
"number",
"null"
]
},
"status": {
"type": "string"
}
},
"additionalProperties": true
}
},
"verifiedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"lastCheckedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"lastError": {
"type": [
"string",
"null"
]
},
"metadata": {
"type": "object",
"properties": {
"sendingEnabled": {
"type": "boolean"
},
"sendingReady": {
"type": "boolean"
},
"trackingReady": {
"type": "boolean"
},
"trackingCertificateReady": {
"type": "boolean"
},
"certificateExpiresAt": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}
},
"additionalProperties": true
},
"providerReadErrors": {
"type": "object",
"properties": {
"resend": {
"type": "string"
},
"elastic": {
"type": "string"
}
},
"additionalProperties": true
},
"verifiedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"lastCheckedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"lastError": {
"type": [
"string",
"null"
]
}
},
"additionalProperties": true
},
"domainStatus": {
"type": [
"string",
"null"
]
},
"marketingDomainStatus": {
"type": [
"string",
"null"
]
},
"senderProfiles": {
"type": "object",
"properties": {
"licensing": {
"type": "object",
"properties": {
"purpose": {
"enum": [
"licensing",
"notifications",
"marketing"
]
},
"label": {
"type": "string"
},
"localPart": {
"type": "string"
},
"fromEmail": {
"type": "string"
},
"editable": {
"type": "boolean"
}
},
"additionalProperties": true
},
"notifications": {
"type": "object",
"properties": {
"purpose": {
"enum": [
"licensing",
"notifications",
"marketing"
]
},
"label": {
"type": "string"
},
"localPart": {
"type": "string"
},
"fromEmail": {
"type": "string"
},
"editable": {
"type": "boolean"
}
},
"additionalProperties": true
},
"marketing": {
"type": "object",
"properties": {
"purpose": {
"enum": [
"licensing",
"notifications",
"marketing"
]
},
"label": {
"type": "string"
},
"localPart": {
"type": "string"
},
"fromEmail": {
"type": "string"
},
"editable": {
"type": "boolean"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
},
"customSendingUsable": {
"type": "boolean"
},
"transactionalSendingUsable": {
"type": "boolean"
},
"marketingSendingUsable": {
"type": "boolean"
},
"marketingTrackingUsable": {
"type": "boolean"
},
"trackClicks": {
"type": "boolean"
},
"trackOpens": {
"type": "boolean"
},
"canDisableUnsafeMarketingTracking": {
"type": "boolean"
},
"unifiedDomainVerified": {
"type": "boolean"
},
"providerReadiness": {
"type": "object",
"properties": {
"configured": {
"type": "boolean"
},
"transactional": {
"type": "boolean"
},
"marketing": {
"type": "boolean"
},
"tracking": {
"type": "boolean"
},
"ready": {
"type": "boolean"
}
},
"additionalProperties": true
},
"blockingReasons": {
"type": "array",
"items": {
"type": "string"
}
},
"transactionalBlockingReasons": {
"type": "array",
"items": {
"type": "string"
}
},
"marketingBlockingReasons": {
"type": "array",
"items": {
"type": "string"
}
},
"trackingBlockingReasons": {
"type": "array",
"items": {
"type": "string"
}
},
"fallbackSender": {
"type": "string"
}
},
"additionalProperties": true
},
"needsPreparation": {
"type": "boolean"
},
"automaticProviderSetup": {
"type": "boolean"
},
"emailProvidersConfigured": {
"type": "boolean"
},
"emailProvidersReady": {
"type": "boolean"
},
"providerPreparation": {
"type": "object",
"properties": {
"ready": {
"type": "boolean"
},
"missingRecords": {
"type": "array",
"items": {
"type": "string"
}
},
"errorMessage": {
"type": "string"
}
},
"additionalProperties": true
},
"readiness": {
"type": "object",
"properties": {
"dns": {
"type": "boolean"
},
"storefront": {
"type": "boolean"
},
"email": {
"type": "boolean"
},
"tracking": {
"type": "boolean"
},
"transactional": {
"type": "boolean"
},
"marketing": {
"type": "boolean"
},
"senders": {
"type": "boolean"
},
"identity": {
"type": "boolean"
},
"providersConfigured": {
"type": "boolean"
},
"ready": {
"type": "boolean"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}Documented failures: 400, 401, 403, 404, 409, 500, 503.
Operation errors: BRAND_DOMAIN_NOT_FOUND, DEVELOPER_BRAND_DOMAIN_ERROR, developer_team_permission_denied, developer_team_all_products_scope_required.
POST
/api/developer/brand/domain/provider
Choose the DNS provider instructions
- Auth
- Account Bearer JWT
- Scope
- domains.view + domains.manage and all-products workspace scope.
- Request fields
- provider: string
- providerKey: string
- Returns
- HTTP 200: domain, providerDetection, currentStep, current_step, wizardProgress, records, featureSummaries, events, allRequiredVerified, providerSupport, branding, storefrontDomain, emailDomains, emailDomainSettings, needsPreparation, automaticProviderSetup, emailProvidersConfigured, emailProvidersReady, providerPreparation, readiness.
- Notes
- Send provider (providerKey/provider_key are aliases). Does not grant provider-account access or automate arbitrary DNS changes. domains.view + domains.manage and all-products workspace scope. Selected-product teammates cannot use this workspace-wide domain wizard.
Request, response and error reference
Request (application/json)
{
"type": "object",
"properties": {
"provider": {
"type": "string"
},
"providerKey": {
"type": "string"
}
},
"additionalProperties": true
}HTTP 200 response (application/json)
{
"type": "object",
"properties": {
"domain": {
"type": [
"object",
"null"
],
"properties": {
"id": {
"type": "integer",
"minimum": 1
},
"domain": {
"type": "string"
},
"status": {
"type": "string"
},
"verified": {
"type": "boolean"
},
"dnsRecords": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"name": {
"type": "string"
},
"value": {
"type": "string"
}
},
"additionalProperties": true
}
},
"sslStatus": {
"type": "string"
},
"rootDomain": {
"type": "string"
},
"storefrontSubdomain": {
"type": "string"
},
"setupStatus": {
"type": "string"
},
"currentStepKey": {
"type": "string"
}
},
"additionalProperties": true
},
"providerDetection": {
"type": [
"object",
"null"
],
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
},
"currentStep": {
"type": [
"object",
"null"
],
"properties": {
"id": {
"type": [
"integer",
"null"
]
},
"developerDomainId": {
"type": [
"integer",
"null"
]
},
"stepKey": {
"type": "string"
},
"step_key": {
"type": "string"
},
"featureKey": {
"type": "string"
},
"feature_key": {
"type": "string"
},
"title": {
"type": "string"
},
"description": {
"type": "string"
},
"warning": {
"type": "string"
},
"purpose": {
"type": "string"
},
"required": {
"type": "boolean"
},
"status": {
"type": "string"
},
"action": {
"type": "string",
"description": "Non-DNS step: prepare-domains, storefront-provider, email-providers or email-identity. Do not add it as a DNS row."
},
"type": {
"type": "string",
"description": "DNS type returned by the provider, such as A, CNAME, TXT or MX; absent on action steps."
},
"host": {
"type": "string"
},
"name": {
"type": "string"
},
"value": {
"type": "string"
},
"ttl": {
"type": [
"string",
"integer"
]
},
"priority": {
"type": "integer",
"description": "MX priority, entered separately from exchange."
},
"exchange": {
"type": "string"
},
"copyBlocked": {
"type": "boolean",
"description": "Missing provider value cannot be copied. Also respect copyPlan.mode=blocked."
},
"copyPlan": {
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": [
"create",
"replace",
"preserve",
"blocked"
]
},
"value": {
"type": "string"
},
"previousValue": {
"type": "string"
},
"message": {
"type": "string"
}
},
"required": [
"mode"
],
"additionalProperties": true,
"description": "Use value for create/replace, keep existing policy for preserve, and resolve message before copying for blocked."
},
"errorMessage": {
"type": "string"
},
"error_message": {
"type": "string"
},
"lastCheckedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"verifiedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"createdAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"updatedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"additionalProperties": true
},
"current_step": {
"type": [
"object",
"null"
],
"properties": {
"id": {
"type": [
"integer",
"null"
]
},
"developerDomainId": {
"type": [
"integer",
"null"
]
},
"stepKey": {
"type": "string"
},
"step_key": {
"type": "string"
},
"featureKey": {
"type": "string"
},
"feature_key": {
"type": "string"
},
"title": {
"type": "string"
},
"description": {
"type": "string"
},
"warning": {
"type": "string"
},
"purpose": {
"type": "string"
},
"required": {
"type": "boolean"
},
"status": {
"type": "string"
},
"action": {
"type": "string",
"description": "Non-DNS step: prepare-domains, storefront-provider, email-providers or email-identity. Do not add it as a DNS row."
},
"type": {
"type": "string",
"description": "DNS type returned by the provider, such as A, CNAME, TXT or MX; absent on action steps."
},
"host": {
"type": "string"
},
"name": {
"type": "string"
},
"value": {
"type": "string"
},
"ttl": {
"type": [
"string",
"integer"
]
},
"priority": {
"type": "integer",
"description": "MX priority, entered separately from exchange."
},
"exchange": {
"type": "string"
},
"copyBlocked": {
"type": "boolean",
"description": "Missing provider value cannot be copied. Also respect copyPlan.mode=blocked."
},
"copyPlan": {
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": [
"create",
"replace",
"preserve",
"blocked"
]
},
"value": {
"type": "string"
},
"previousValue": {
"type": "string"
},
"message": {
"type": "string"
}
},
"required": [
"mode"
],
"additionalProperties": true,
"description": "Use value for create/replace, keep existing policy for preserve, and resolve message before copying for blocked."
},
"errorMessage": {
"type": "string"
},
"error_message": {
"type": "string"
},
"lastCheckedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"verifiedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"createdAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"updatedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"additionalProperties": true
},
"wizardProgress": {
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string"
},
"label": {
"type": "string"
},
"status": {
"type": "string"
},
"completeCount": {
"type": "integer"
},
"totalCount": {
"type": "integer"
}
},
"additionalProperties": true
}
},
"records": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": [
"integer",
"null"
]
},
"developerDomainId": {
"type": [
"integer",
"null"
]
},
"stepKey": {
"type": "string"
},
"step_key": {
"type": "string"
},
"featureKey": {
"type": "string"
},
"feature_key": {
"type": "string"
},
"title": {
"type": "string"
},
"description": {
"type": "string"
},
"warning": {
"type": "string"
},
"purpose": {
"type": "string"
},
"required": {
"type": "boolean"
},
"status": {
"type": "string"
},
"action": {
"type": "string",
"description": "Non-DNS step: prepare-domains, storefront-provider, email-providers or email-identity. Do not add it as a DNS row."
},
"type": {
"type": "string",
"description": "DNS type returned by the provider, such as A, CNAME, TXT or MX; absent on action steps."
},
"host": {
"type": "string"
},
"name": {
"type": "string"
},
"value": {
"type": "string"
},
"ttl": {
"type": [
"string",
"integer"
]
},
"priority": {
"type": "integer",
"description": "MX priority, entered separately from exchange."
},
"exchange": {
"type": "string"
},
"copyBlocked": {
"type": "boolean",
"description": "Missing provider value cannot be copied. Also respect copyPlan.mode=blocked."
},
"copyPlan": {
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": [
"create",
"replace",
"preserve",
"blocked"
]
},
"value": {
"type": "string"
},
"previousValue": {
"type": "string"
},
"message": {
"type": "string"
}
},
"required": [
"mode"
],
"additionalProperties": true,
"description": "Use value for create/replace, keep existing policy for preserve, and resolve message before copying for blocked."
},
"errorMessage": {
"type": "string"
},
"error_message": {
"type": "string"
},
"lastCheckedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"verifiedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"createdAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"updatedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"additionalProperties": true
}
},
"featureSummaries": {
"type": "array",
"items": {
"type": "object",
"properties": {
"featureKey": {
"type": "string"
},
"feature_key": {
"type": "string"
},
"label": {
"type": "string"
},
"status": {
"type": "string"
},
"completeCount": {
"type": "integer"
},
"requiredCount": {
"type": "integer"
},
"totalCount": {
"type": "integer"
},
"records": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": [
"integer",
"null"
]
},
"developerDomainId": {
"type": [
"integer",
"null"
]
},
"stepKey": {
"type": "string"
},
"step_key": {
"type": "string"
},
"featureKey": {
"type": "string"
},
"feature_key": {
"type": "string"
},
"title": {
"type": "string"
},
"description": {
"type": "string"
},
"warning": {
"type": "string"
},
"purpose": {
"type": "string"
},
"required": {
"type": "boolean"
},
"status": {
"type": "string"
},
"action": {
"type": "string",
"description": "Non-DNS step: prepare-domains, storefront-provider, email-providers or email-identity. Do not add it as a DNS row."
},
"type": {
"type": "string",
"description": "DNS type returned by the provider, such as A, CNAME, TXT or MX; absent on action steps."
},
"host": {
"type": "string"
},
"name": {
"type": "string"
},
"value": {
"type": "string"
},
"ttl": {
"type": [
"string",
"integer"
]
},
"priority": {
"type": "integer",
"description": "MX priority, entered separately from exchange."
},
"exchange": {
"type": "string"
},
"copyBlocked": {
"type": "boolean",
"description": "Missing provider value cannot be copied. Also respect copyPlan.mode=blocked."
},
"copyPlan": {
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": [
"create",
"replace",
"preserve",
"blocked"
]
},
"value": {
"type": "string"
},
"previousValue": {
"type": "string"
},
"message": {
"type": "string"
}
},
"required": [
"mode"
],
"additionalProperties": true,
"description": "Use value for create/replace, keep existing policy for preserve, and resolve message before copying for blocked."
},
"errorMessage": {
"type": "string"
},
"error_message": {
"type": "string"
},
"lastCheckedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"verifiedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"createdAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"updatedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"additionalProperties": true
}
}
},
"additionalProperties": true
}
},
"events": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
},
"status": {
"type": "string"
},
"created_at": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"updated_at": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"additionalProperties": true
}
},
"allRequiredVerified": {
"type": "boolean"
},
"providerSupport": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
},
"branding": {
"type": "object",
"properties": {
"storeName": {
"type": "string"
},
"developerDisplayName": {
"type": "string"
},
"tagline": {
"type": "string"
},
"slug": {
"type": "string"
},
"shortDescription": {
"type": "string"
},
"marketplaceBio": {
"type": "string"
},
"logos": {
"type": "object",
"properties": {
"logoUrl": {
"type": "string"
},
"lightLogoUrl": {
"type": "string"
},
"darkLogoUrl": {
"type": "string"
},
"iconUrl": {
"type": "string"
},
"defaultProductImageUrl": {
"type": "string"
}
},
"additionalProperties": true
},
"colors": {
"type": "object",
"properties": {
"appearance": {
"type": "string",
"enum": [
"light",
"dark",
"system"
]
},
"backgroundColor": {
"type": "string"
},
"brandHighlightColor": {
"type": "string"
},
"accentColor": {
"type": "string"
},
"advancedOverrides": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
},
"additionalProperties": true
},
"support": {
"type": "object",
"properties": {
"supportEmail": {
"type": "string"
},
"supportUrl": {
"type": "string"
},
"documentationUrl": {
"type": "string"
},
"faqUrl": {
"type": "string"
},
"refundPolicyUrl": {
"type": "string"
},
"termsUrl": {
"type": "string"
},
"licenseUrl": {
"type": "string"
}
},
"additionalProperties": true
},
"emailIdentity": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
},
"socialLinks": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
},
"domains": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
},
"metadata": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
},
"additionalProperties": true
},
"storefrontDomain": {
"type": "string"
},
"emailDomains": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
},
"domain": {
"type": "string"
},
"fromLocalPart": {
"type": "string"
},
"senderEmail": {
"type": "string"
},
"status": {
"type": "string"
},
"verified": {
"type": "boolean"
},
"elasticStatus": {
"type": "string"
},
"elasticVerified": {
"type": "boolean"
},
"unifiedVerified": {
"type": "boolean"
},
"dnsRecords": {
"type": "array",
"items": {
"type": "object",
"properties": {
"provider": {
"type": "string"
},
"record": {
"type": "string"
},
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"value": {
"type": "string"
},
"ttl": {
"type": [
"string",
"number"
]
},
"priority": {
"type": [
"number",
"null"
]
},
"status": {
"type": "string"
}
},
"additionalProperties": true
}
},
"providerVerification": {
"type": "object",
"properties": {
"resend": {
"type": "object",
"properties": {
"provider": {
"type": "string"
},
"status": {
"type": "string"
},
"verified": {
"type": "boolean"
},
"dnsRecords": {
"type": "array",
"items": {
"type": "object",
"properties": {
"provider": {
"type": "string"
},
"record": {
"type": "string"
},
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"value": {
"type": "string"
},
"ttl": {
"type": [
"string",
"number"
]
},
"priority": {
"type": [
"number",
"null"
]
},
"status": {
"type": "string"
}
},
"additionalProperties": true
}
},
"verifiedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"lastCheckedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"lastError": {
"type": [
"string",
"null"
]
},
"metadata": {
"type": "object",
"properties": {
"sendingEnabled": {
"type": "boolean"
},
"sendingReady": {
"type": "boolean"
},
"trackingReady": {
"type": "boolean"
},
"trackingCertificateReady": {
"type": "boolean"
},
"certificateExpiresAt": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
},
"elastic": {
"type": "object",
"properties": {
"provider": {
"type": "string"
},
"status": {
"type": "string"
},
"verified": {
"type": "boolean"
},
"dnsRecords": {
"type": "array",
"items": {
"type": "object",
"properties": {
"provider": {
"type": "string"
},
"record": {
"type": "string"
},
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"value": {
"type": "string"
},
"ttl": {
"type": [
"string",
"number"
]
},
"priority": {
"type": [
"number",
"null"
]
},
"status": {
"type": "string"
}
},
"additionalProperties": true
}
},
"verifiedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"lastCheckedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"lastError": {
"type": [
"string",
"null"
]
},
"metadata": {
"type": "object",
"properties": {
"sendingEnabled": {
"type": "boolean"
},
"sendingReady": {
"type": "boolean"
},
"trackingReady": {
"type": "boolean"
},
"trackingCertificateReady": {
"type": "boolean"
},
"certificateExpiresAt": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}
},
"additionalProperties": true
},
"providerReadErrors": {
"type": "object",
"properties": {
"resend": {
"type": "string"
},
"elastic": {
"type": "string"
}
},
"additionalProperties": true
},
"verifiedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"lastCheckedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"lastError": {
"type": [
"string",
"null"
]
}
},
"additionalProperties": true
}
},
"emailDomainSettings": {
"type": "object",
"properties": {
"supportEmail": {
"type": "string"
},
"supportEmailPresent": {
"type": "boolean"
},
"brandDomainOwnershipReady": {
"type": "boolean"
},
"customDomain": {
"type": [
"object",
"null"
],
"properties": {
"id": {
"type": "integer",
"minimum": 1
},
"domain": {
"type": "string"
},
"fromLocalPart": {
"type": "string"
},
"senderEmail": {
"type": "string"
},
"status": {
"type": "string"
},
"verified": {
"type": "boolean"
},
"elasticStatus": {
"type": "string"
},
"elasticVerified": {
"type": "boolean"
},
"unifiedVerified": {
"type": "boolean"
},
"dnsRecords": {
"type": "array",
"items": {
"type": "object",
"properties": {
"provider": {
"type": "string"
},
"record": {
"type": "string"
},
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"value": {
"type": "string"
},
"ttl": {
"type": [
"string",
"number"
]
},
"priority": {
"type": [
"number",
"null"
]
},
"status": {
"type": "string"
}
},
"additionalProperties": true
}
},
"providerVerification": {
"type": "object",
"properties": {
"resend": {
"type": "object",
"properties": {
"provider": {
"type": "string"
},
"status": {
"type": "string"
},
"verified": {
"type": "boolean"
},
"dnsRecords": {
"type": "array",
"items": {
"type": "object",
"properties": {
"provider": {
"type": "string"
},
"record": {
"type": "string"
},
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"value": {
"type": "string"
},
"ttl": {
"type": [
"string",
"number"
]
},
"priority": {
"type": [
"number",
"null"
]
},
"status": {
"type": "string"
}
},
"additionalProperties": true
}
},
"verifiedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"lastCheckedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"lastError": {
"type": [
"string",
"null"
]
},
"metadata": {
"type": "object",
"properties": {
"sendingEnabled": {
"type": "boolean"
},
"sendingReady": {
"type": "boolean"
},
"trackingReady": {
"type": "boolean"
},
"trackingCertificateReady": {
"type": "boolean"
},
"certificateExpiresAt": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
},
"elastic": {
"type": "object",
"properties": {
"provider": {
"type": "string"
},
"status": {
"type": "string"
},
"verified": {
"type": "boolean"
},
"dnsRecords": {
"type": "array",
"items": {
"type": "object",
"properties": {
"provider": {
"type": "string"
},
"record": {
"type": "string"
},
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"value": {
"type": "string"
},
"ttl": {
"type": [
"string",
"number"
]
},
"priority": {
"type": [
"number",
"null"
]
},
"status": {
"type": "string"
}
},
"additionalProperties": true
}
},
"verifiedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"lastCheckedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"lastError": {
"type": [
"string",
"null"
]
},
"metadata": {
"type": "object",
"properties": {
"sendingEnabled": {
"type": "boolean"
},
"sendingReady": {
"type": "boolean"
},
"trackingReady": {
"type": "boolean"
},
"trackingCertificateReady": {
"type": "boolean"
},
"certificateExpiresAt": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}
},
"additionalProperties": true
},
"providerReadErrors": {
"type": "object",
"properties": {
"resend": {
"type": "string"
},
"elastic": {
"type": "string"
}
},
"additionalProperties": true
},
"verifiedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"lastCheckedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"lastError": {
"type": [
"string",
"null"
]
}
},
"additionalProperties": true
},
"domainStatus": {
"type": [
"string",
"null"
]
},
"marketingDomainStatus": {
"type": [
"string",
"null"
]
},
"senderProfiles": {
"type": "object",
"properties": {
"licensing": {
"type": "object",
"properties": {
"purpose": {
"enum": [
"licensing",
"notifications",
"marketing"
]
},
"label": {
"type": "string"
},
"localPart": {
"type": "string"
},
"fromEmail": {
"type": "string"
},
"editable": {
"type": "boolean"
}
},
"additionalProperties": true
},
"notifications": {
"type": "object",
"properties": {
"purpose": {
"enum": [
"licensing",
"notifications",
"marketing"
]
},
"label": {
"type": "string"
},
"localPart": {
"type": "string"
},
"fromEmail": {
"type": "string"
},
"editable": {
"type": "boolean"
}
},
"additionalProperties": true
},
"marketing": {
"type": "object",
"properties": {
"purpose": {
"enum": [
"licensing",
"notifications",
"marketing"
]
},
"label": {
"type": "string"
},
"localPart": {
"type": "string"
},
"fromEmail": {
"type": "string"
},
"editable": {
"type": "boolean"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
},
"customSendingUsable": {
"type": "boolean"
},
"transactionalSendingUsable": {
"type": "boolean"
},
"marketingSendingUsable": {
"type": "boolean"
},
"marketingTrackingUsable": {
"type": "boolean"
},
"trackClicks": {
"type": "boolean"
},
"trackOpens": {
"type": "boolean"
},
"canDisableUnsafeMarketingTracking": {
"type": "boolean"
},
"unifiedDomainVerified": {
"type": "boolean"
},
"providerReadiness": {
"type": "object",
"properties": {
"configured": {
"type": "boolean"
},
"transactional": {
"type": "boolean"
},
"marketing": {
"type": "boolean"
},
"tracking": {
"type": "boolean"
},
"ready": {
"type": "boolean"
}
},
"additionalProperties": true
},
"blockingReasons": {
"type": "array",
"items": {
"type": "string"
}
},
"transactionalBlockingReasons": {
"type": "array",
"items": {
"type": "string"
}
},
"marketingBlockingReasons": {
"type": "array",
"items": {
"type": "string"
}
},
"trackingBlockingReasons": {
"type": "array",
"items": {
"type": "string"
}
},
"fallbackSender": {
"type": "string"
}
},
"additionalProperties": true
},
"needsPreparation": {
"type": "boolean"
},
"automaticProviderSetup": {
"type": "boolean"
},
"emailProvidersConfigured": {
"type": "boolean"
},
"emailProvidersReady": {
"type": "boolean"
},
"providerPreparation": {
"type": "object",
"properties": {
"ready": {
"type": "boolean"
},
"missingRecords": {
"type": "array",
"items": {
"type": "string"
}
},
"errorMessage": {
"type": "string"
}
},
"additionalProperties": true
},
"readiness": {
"type": "object",
"properties": {
"dns": {
"type": "boolean"
},
"storefront": {
"type": "boolean"
},
"email": {
"type": "boolean"
},
"tracking": {
"type": "boolean"
},
"transactional": {
"type": "boolean"
},
"marketing": {
"type": "boolean"
},
"senders": {
"type": "boolean"
},
"identity": {
"type": "boolean"
},
"providersConfigured": {
"type": "boolean"
},
"ready": {
"type": "boolean"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}Documented failures: 400, 401, 403, 404, 409, 500, 503.
Operation errors: developer_team_permission_denied, developer_team_all_products_scope_required.
POST
/api/developer/brand/domain/check
Check the required DNS records
- Auth
- Account Bearer JWT
- Scope
- domains.view + domains.manage and all-products workspace scope.
- Returns
- HTTP 200: domain, providerDetection, currentStep, current_step, wizardProgress, records, featureSummaries, events, allRequiredVerified, providerSupport, branding, storefrontDomain, emailDomains, emailDomainSettings, needsPreparation, automaticProviderSetup, emailProvidersConfigured, emailProvidersReady, providerPreparation, readiness.
- Notes
- Checks required or non-skipped records and writes observed results. The eight-second cooldown returns 429 DNS_CHECK_COOLDOWN. If the saved setup changes during checking, 409 DNS_SETUP_CHANGED requires reloading the current setup before retrying. HTTP success is not proof that every record or SSL certificate is ready. domains.view + domains.manage and all-products workspace scope. Selected-product teammates cannot use this workspace-wide domain wizard.
Request, response and error reference
No request body fields are read by this operation.
HTTP 200 response (application/json)
{
"type": "object",
"properties": {
"domain": {
"type": [
"object",
"null"
],
"properties": {
"id": {
"type": "integer",
"minimum": 1
},
"domain": {
"type": "string"
},
"status": {
"type": "string"
},
"verified": {
"type": "boolean"
},
"dnsRecords": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"name": {
"type": "string"
},
"value": {
"type": "string"
}
},
"additionalProperties": true
}
},
"sslStatus": {
"type": "string"
},
"rootDomain": {
"type": "string"
},
"storefrontSubdomain": {
"type": "string"
},
"setupStatus": {
"type": "string"
},
"currentStepKey": {
"type": "string"
}
},
"additionalProperties": true
},
"providerDetection": {
"type": [
"object",
"null"
],
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
},
"currentStep": {
"type": [
"object",
"null"
],
"properties": {
"id": {
"type": [
"integer",
"null"
]
},
"developerDomainId": {
"type": [
"integer",
"null"
]
},
"stepKey": {
"type": "string"
},
"step_key": {
"type": "string"
},
"featureKey": {
"type": "string"
},
"feature_key": {
"type": "string"
},
"title": {
"type": "string"
},
"description": {
"type": "string"
},
"warning": {
"type": "string"
},
"purpose": {
"type": "string"
},
"required": {
"type": "boolean"
},
"status": {
"type": "string"
},
"action": {
"type": "string",
"description": "Non-DNS step: prepare-domains, storefront-provider, email-providers or email-identity. Do not add it as a DNS row."
},
"type": {
"type": "string",
"description": "DNS type returned by the provider, such as A, CNAME, TXT or MX; absent on action steps."
},
"host": {
"type": "string"
},
"name": {
"type": "string"
},
"value": {
"type": "string"
},
"ttl": {
"type": [
"string",
"integer"
]
},
"priority": {
"type": "integer",
"description": "MX priority, entered separately from exchange."
},
"exchange": {
"type": "string"
},
"copyBlocked": {
"type": "boolean",
"description": "Missing provider value cannot be copied. Also respect copyPlan.mode=blocked."
},
"copyPlan": {
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": [
"create",
"replace",
"preserve",
"blocked"
]
},
"value": {
"type": "string"
},
"previousValue": {
"type": "string"
},
"message": {
"type": "string"
}
},
"required": [
"mode"
],
"additionalProperties": true,
"description": "Use value for create/replace, keep existing policy for preserve, and resolve message before copying for blocked."
},
"errorMessage": {
"type": "string"
},
"error_message": {
"type": "string"
},
"lastCheckedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"verifiedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"createdAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"updatedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"additionalProperties": true
},
"current_step": {
"type": [
"object",
"null"
],
"properties": {
"id": {
"type": [
"integer",
"null"
]
},
"developerDomainId": {
"type": [
"integer",
"null"
]
},
"stepKey": {
"type": "string"
},
"step_key": {
"type": "string"
},
"featureKey": {
"type": "string"
},
"feature_key": {
"type": "string"
},
"title": {
"type": "string"
},
"description": {
"type": "string"
},
"warning": {
"type": "string"
},
"purpose": {
"type": "string"
},
"required": {
"type": "boolean"
},
"status": {
"type": "string"
},
"action": {
"type": "string",
"description": "Non-DNS step: prepare-domains, storefront-provider, email-providers or email-identity. Do not add it as a DNS row."
},
"type": {
"type": "string",
"description": "DNS type returned by the provider, such as A, CNAME, TXT or MX; absent on action steps."
},
"host": {
"type": "string"
},
"name": {
"type": "string"
},
"value": {
"type": "string"
},
"ttl": {
"type": [
"string",
"integer"
]
},
"priority": {
"type": "integer",
"description": "MX priority, entered separately from exchange."
},
"exchange": {
"type": "string"
},
"copyBlocked": {
"type": "boolean",
"description": "Missing provider value cannot be copied. Also respect copyPlan.mode=blocked."
},
"copyPlan": {
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": [
"create",
"replace",
"preserve",
"blocked"
]
},
"value": {
"type": "string"
},
"previousValue": {
"type": "string"
},
"message": {
"type": "string"
}
},
"required": [
"mode"
],
"additionalProperties": true,
"description": "Use value for create/replace, keep existing policy for preserve, and resolve message before copying for blocked."
},
"errorMessage": {
"type": "string"
},
"error_message": {
"type": "string"
},
"lastCheckedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"verifiedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"createdAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"updatedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"additionalProperties": true
},
"wizardProgress": {
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string"
},
"label": {
"type": "string"
},
"status": {
"type": "string"
},
"completeCount": {
"type": "integer"
},
"totalCount": {
"type": "integer"
}
},
"additionalProperties": true
}
},
"records": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": [
"integer",
"null"
]
},
"developerDomainId": {
"type": [
"integer",
"null"
]
},
"stepKey": {
"type": "string"
},
"step_key": {
"type": "string"
},
"featureKey": {
"type": "string"
},
"feature_key": {
"type": "string"
},
"title": {
"type": "string"
},
"description": {
"type": "string"
},
"warning": {
"type": "string"
},
"purpose": {
"type": "string"
},
"required": {
"type": "boolean"
},
"status": {
"type": "string"
},
"action": {
"type": "string",
"description": "Non-DNS step: prepare-domains, storefront-provider, email-providers or email-identity. Do not add it as a DNS row."
},
"type": {
"type": "string",
"description": "DNS type returned by the provider, such as A, CNAME, TXT or MX; absent on action steps."
},
"host": {
"type": "string"
},
"name": {
"type": "string"
},
"value": {
"type": "string"
},
"ttl": {
"type": [
"string",
"integer"
]
},
"priority": {
"type": "integer",
"description": "MX priority, entered separately from exchange."
},
"exchange": {
"type": "string"
},
"copyBlocked": {
"type": "boolean",
"description": "Missing provider value cannot be copied. Also respect copyPlan.mode=blocked."
},
"copyPlan": {
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": [
"create",
"replace",
"preserve",
"blocked"
]
},
"value": {
"type": "string"
},
"previousValue": {
"type": "string"
},
"message": {
"type": "string"
}
},
"required": [
"mode"
],
"additionalProperties": true,
"description": "Use value for create/replace, keep existing policy for preserve, and resolve message before copying for blocked."
},
"errorMessage": {
"type": "string"
},
"error_message": {
"type": "string"
},
"lastCheckedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"verifiedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"createdAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"updatedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"additionalProperties": true
}
},
"featureSummaries": {
"type": "array",
"items": {
"type": "object",
"properties": {
"featureKey": {
"type": "string"
},
"feature_key": {
"type": "string"
},
"label": {
"type": "string"
},
"status": {
"type": "string"
},
"completeCount": {
"type": "integer"
},
"requiredCount": {
"type": "integer"
},
"totalCount": {
"type": "integer"
},
"records": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": [
"integer",
"null"
]
},
"developerDomainId": {
"type": [
"integer",
"null"
]
},
"stepKey": {
"type": "string"
},
"step_key": {
"type": "string"
},
"featureKey": {
"type": "string"
},
"feature_key": {
"type": "string"
},
"title": {
"type": "string"
},
"description": {
"type": "string"
},
"warning": {
"type": "string"
},
"purpose": {
"type": "string"
},
"required": {
"type": "boolean"
},
"status": {
"type": "string"
},
"action": {
"type": "string",
"description": "Non-DNS step: prepare-domains, storefront-provider, email-providers or email-identity. Do not add it as a DNS row."
},
"type": {
"type": "string",
"description": "DNS type returned by the provider, such as A, CNAME, TXT or MX; absent on action steps."
},
"host": {
"type": "string"
},
"name": {
"type": "string"
},
"value": {
"type": "string"
},
"ttl": {
"type": [
"string",
"integer"
]
},
"priority": {
"type": "integer",
"description": "MX priority, entered separately from exchange."
},
"exchange": {
"type": "string"
},
"copyBlocked": {
"type": "boolean",
"description": "Missing provider value cannot be copied. Also respect copyPlan.mode=blocked."
},
"copyPlan": {
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": [
"create",
"replace",
"preserve",
"blocked"
]
},
"value": {
"type": "string"
},
"previousValue": {
"type": "string"
},
"message": {
"type": "string"
}
},
"required": [
"mode"
],
"additionalProperties": true,
"description": "Use value for create/replace, keep existing policy for preserve, and resolve message before copying for blocked."
},
"errorMessage": {
"type": "string"
},
"error_message": {
"type": "string"
},
"lastCheckedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"verifiedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"createdAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"updatedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"additionalProperties": true
}
}
},
"additionalProperties": true
}
},
"events": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
},
"status": {
"type": "string"
},
"created_at": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"updated_at": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"additionalProperties": true
}
},
"allRequiredVerified": {
"type": "boolean"
},
"providerSupport": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
},
"branding": {
"type": "object",
"properties": {
"storeName": {
"type": "string"
},
"developerDisplayName": {
"type": "string"
},
"tagline": {
"type": "string"
},
"slug": {
"type": "string"
},
"shortDescription": {
"type": "string"
},
"marketplaceBio": {
"type": "string"
},
"logos": {
"type": "object",
"properties": {
"logoUrl": {
"type": "string"
},
"lightLogoUrl": {
"type": "string"
},
"darkLogoUrl": {
"type": "string"
},
"iconUrl": {
"type": "string"
},
"defaultProductImageUrl": {
"type": "string"
}
},
"additionalProperties": true
},
"colors": {
"type": "object",
"properties": {
"appearance": {
"type": "string",
"enum": [
"light",
"dark",
"system"
]
},
"backgroundColor": {
"type": "string"
},
"brandHighlightColor": {
"type": "string"
},
"accentColor": {
"type": "string"
},
"advancedOverrides": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
},
"additionalProperties": true
},
"support": {
"type": "object",
"properties": {
"supportEmail": {
"type": "string"
},
"supportUrl": {
"type": "string"
},
"documentationUrl": {
"type": "string"
},
"faqUrl": {
"type": "string"
},
"refundPolicyUrl": {
"type": "string"
},
"termsUrl": {
"type": "string"
},
"licenseUrl": {
"type": "string"
}
},
"additionalProperties": true
},
"emailIdentity": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
},
"socialLinks": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
},
"domains": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
},
"metadata": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
},
"additionalProperties": true
},
"storefrontDomain": {
"type": "string"
},
"emailDomains": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
},
"domain": {
"type": "string"
},
"fromLocalPart": {
"type": "string"
},
"senderEmail": {
"type": "string"
},
"status": {
"type": "string"
},
"verified": {
"type": "boolean"
},
"elasticStatus": {
"type": "string"
},
"elasticVerified": {
"type": "boolean"
},
"unifiedVerified": {
"type": "boolean"
},
"dnsRecords": {
"type": "array",
"items": {
"type": "object",
"properties": {
"provider": {
"type": "string"
},
"record": {
"type": "string"
},
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"value": {
"type": "string"
},
"ttl": {
"type": [
"string",
"number"
]
},
"priority": {
"type": [
"number",
"null"
]
},
"status": {
"type": "string"
}
},
"additionalProperties": true
}
},
"providerVerification": {
"type": "object",
"properties": {
"resend": {
"type": "object",
"properties": {
"provider": {
"type": "string"
},
"status": {
"type": "string"
},
"verified": {
"type": "boolean"
},
"dnsRecords": {
"type": "array",
"items": {
"type": "object",
"properties": {
"provider": {
"type": "string"
},
"record": {
"type": "string"
},
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"value": {
"type": "string"
},
"ttl": {
"type": [
"string",
"number"
]
},
"priority": {
"type": [
"number",
"null"
]
},
"status": {
"type": "string"
}
},
"additionalProperties": true
}
},
"verifiedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"lastCheckedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"lastError": {
"type": [
"string",
"null"
]
},
"metadata": {
"type": "object",
"properties": {
"sendingEnabled": {
"type": "boolean"
},
"sendingReady": {
"type": "boolean"
},
"trackingReady": {
"type": "boolean"
},
"trackingCertificateReady": {
"type": "boolean"
},
"certificateExpiresAt": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
},
"elastic": {
"type": "object",
"properties": {
"provider": {
"type": "string"
},
"status": {
"type": "string"
},
"verified": {
"type": "boolean"
},
"dnsRecords": {
"type": "array",
"items": {
"type": "object",
"properties": {
"provider": {
"type": "string"
},
"record": {
"type": "string"
},
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"value": {
"type": "string"
},
"ttl": {
"type": [
"string",
"number"
]
},
"priority": {
"type": [
"number",
"null"
]
},
"status": {
"type": "string"
}
},
"additionalProperties": true
}
},
"verifiedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"lastCheckedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"lastError": {
"type": [
"string",
"null"
]
},
"metadata": {
"type": "object",
"properties": {
"sendingEnabled": {
"type": "boolean"
},
"sendingReady": {
"type": "boolean"
},
"trackingReady": {
"type": "boolean"
},
"trackingCertificateReady": {
"type": "boolean"
},
"certificateExpiresAt": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}
},
"additionalProperties": true
},
"providerReadErrors": {
"type": "object",
"properties": {
"resend": {
"type": "string"
},
"elastic": {
"type": "string"
}
},
"additionalProperties": true
},
"verifiedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"lastCheckedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"lastError": {
"type": [
"string",
"null"
]
}
},
"additionalProperties": true
}
},
"emailDomainSettings": {
"type": "object",
"properties": {
"supportEmail": {
"type": "string"
},
"supportEmailPresent": {
"type": "boolean"
},
"brandDomainOwnershipReady": {
"type": "boolean"
},
"customDomain": {
"type": [
"object",
"null"
],
"properties": {
"id": {
"type": "integer",
"minimum": 1
},
"domain": {
"type": "string"
},
"fromLocalPart": {
"type": "string"
},
"senderEmail": {
"type": "string"
},
"status": {
"type": "string"
},
"verified": {
"type": "boolean"
},
"elasticStatus": {
"type": "string"
},
"elasticVerified": {
"type": "boolean"
},
"unifiedVerified": {
"type": "boolean"
},
"dnsRecords": {
"type": "array",
"items": {
"type": "object",
"properties": {
"provider": {
"type": "string"
},
"record": {
"type": "string"
},
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"value": {
"type": "string"
},
"ttl": {
"type": [
"string",
"number"
]
},
"priority": {
"type": [
"number",
"null"
]
},
"status": {
"type": "string"
}
},
"additionalProperties": true
}
},
"providerVerification": {
"type": "object",
"properties": {
"resend": {
"type": "object",
"properties": {
"provider": {
"type": "string"
},
"status": {
"type": "string"
},
"verified": {
"type": "boolean"
},
"dnsRecords": {
"type": "array",
"items": {
"type": "object",
"properties": {
"provider": {
"type": "string"
},
"record": {
"type": "string"
},
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"value": {
"type": "string"
},
"ttl": {
"type": [
"string",
"number"
]
},
"priority": {
"type": [
"number",
"null"
]
},
"status": {
"type": "string"
}
},
"additionalProperties": true
}
},
"verifiedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"lastCheckedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"lastError": {
"type": [
"string",
"null"
]
},
"metadata": {
"type": "object",
"properties": {
"sendingEnabled": {
"type": "boolean"
},
"sendingReady": {
"type": "boolean"
},
"trackingReady": {
"type": "boolean"
},
"trackingCertificateReady": {
"type": "boolean"
},
"certificateExpiresAt": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
},
"elastic": {
"type": "object",
"properties": {
"provider": {
"type": "string"
},
"status": {
"type": "string"
},
"verified": {
"type": "boolean"
},
"dnsRecords": {
"type": "array",
"items": {
"type": "object",
"properties": {
"provider": {
"type": "string"
},
"record": {
"type": "string"
},
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"value": {
"type": "string"
},
"ttl": {
"type": [
"string",
"number"
]
},
"priority": {
"type": [
"number",
"null"
]
},
"status": {
"type": "string"
}
},
"additionalProperties": true
}
},
"verifiedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"lastCheckedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"lastError": {
"type": [
"string",
"null"
]
},
"metadata": {
"type": "object",
"properties": {
"sendingEnabled": {
"type": "boolean"
},
"sendingReady": {
"type": "boolean"
},
"trackingReady": {
"type": "boolean"
},
"trackingCertificateReady": {
"type": "boolean"
},
"certificateExpiresAt": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}
},
"additionalProperties": true
},
"providerReadErrors": {
"type": "object",
"properties": {
"resend": {
"type": "string"
},
"elastic": {
"type": "string"
}
},
"additionalProperties": true
},
"verifiedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"lastCheckedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"lastError": {
"type": [
"string",
"null"
]
}
},
"additionalProperties": true
},
"domainStatus": {
"type": [
"string",
"null"
]
},
"marketingDomainStatus": {
"type": [
"string",
"null"
]
},
"senderProfiles": {
"type": "object",
"properties": {
"licensing": {
"type": "object",
"properties": {
"purpose": {
"enum": [
"licensing",
"notifications",
"marketing"
]
},
"label": {
"type": "string"
},
"localPart": {
"type": "string"
},
"fromEmail": {
"type": "string"
},
"editable": {
"type": "boolean"
}
},
"additionalProperties": true
},
"notifications": {
"type": "object",
"properties": {
"purpose": {
"enum": [
"licensing",
"notifications",
"marketing"
]
},
"label": {
"type": "string"
},
"localPart": {
"type": "string"
},
"fromEmail": {
"type": "string"
},
"editable": {
"type": "boolean"
}
},
"additionalProperties": true
},
"marketing": {
"type": "object",
"properties": {
"purpose": {
"enum": [
"licensing",
"notifications",
"marketing"
]
},
"label": {
"type": "string"
},
"localPart": {
"type": "string"
},
"fromEmail": {
"type": "string"
},
"editable": {
"type": "boolean"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
},
"customSendingUsable": {
"type": "boolean"
},
"transactionalSendingUsable": {
"type": "boolean"
},
"marketingSendingUsable": {
"type": "boolean"
},
"marketingTrackingUsable": {
"type": "boolean"
},
"trackClicks": {
"type": "boolean"
},
"trackOpens": {
"type": "boolean"
},
"canDisableUnsafeMarketingTracking": {
"type": "boolean"
},
"unifiedDomainVerified": {
"type": "boolean"
},
"providerReadiness": {
"type": "object",
"properties": {
"configured": {
"type": "boolean"
},
"transactional": {
"type": "boolean"
},
"marketing": {
"type": "boolean"
},
"tracking": {
"type": "boolean"
},
"ready": {
"type": "boolean"
}
},
"additionalProperties": true
},
"blockingReasons": {
"type": "array",
"items": {
"type": "string"
}
},
"transactionalBlockingReasons": {
"type": "array",
"items": {
"type": "string"
}
},
"marketingBlockingReasons": {
"type": "array",
"items": {
"type": "string"
}
},
"trackingBlockingReasons": {
"type": "array",
"items": {
"type": "string"
}
},
"fallbackSender": {
"type": "string"
}
},
"additionalProperties": true
},
"needsPreparation": {
"type": "boolean"
},
"automaticProviderSetup": {
"type": "boolean"
},
"emailProvidersConfigured": {
"type": "boolean"
},
"emailProvidersReady": {
"type": "boolean"
},
"providerPreparation": {
"type": "object",
"properties": {
"ready": {
"type": "boolean"
},
"missingRecords": {
"type": "array",
"items": {
"type": "string"
}
},
"errorMessage": {
"type": "string"
}
},
"additionalProperties": true
},
"readiness": {
"type": "object",
"properties": {
"dns": {
"type": "boolean"
},
"storefront": {
"type": "boolean"
},
"email": {
"type": "boolean"
},
"tracking": {
"type": "boolean"
},
"transactional": {
"type": "boolean"
},
"marketing": {
"type": "boolean"
},
"senders": {
"type": "boolean"
},
"identity": {
"type": "boolean"
},
"providersConfigured": {
"type": "boolean"
},
"ready": {
"type": "boolean"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}Documented failures: 400, 401, 403, 404, 409, 429, 500, 503.
Operation errors: BRAND_DOMAIN_NOT_FOUND, DNS_CHECK_COOLDOWN, DNS_SETUP_CHANGED, developer_team_permission_denied, developer_team_all_products_scope_required.
POST
/api/developer/brand/domain/advance
Advance to the next incomplete DNS setup step
- Auth
- Account Bearer JWT
- Scope
- domains.view + domains.manage and all-products workspace scope.
- Returns
- HTTP 200: domain, providerDetection, currentStep, current_step, wizardProgress, records, featureSummaries, events, allRequiredVerified, providerSupport, branding, storefrontDomain, emailDomains, emailDomainSettings, needsPreparation, automaticProviderSetup, emailProvidersConfigured, emailProvidersReady, providerPreparation, readiness.
- Notes
- domains.view + domains.manage and all-products workspace scope. Selected-product teammates cannot use this workspace-wide domain wizard.
Request, response and error reference
No request body fields are read by this operation.
HTTP 200 response (application/json)
{
"type": "object",
"properties": {
"domain": {
"type": [
"object",
"null"
],
"properties": {
"id": {
"type": "integer",
"minimum": 1
},
"domain": {
"type": "string"
},
"status": {
"type": "string"
},
"verified": {
"type": "boolean"
},
"dnsRecords": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"name": {
"type": "string"
},
"value": {
"type": "string"
}
},
"additionalProperties": true
}
},
"sslStatus": {
"type": "string"
},
"rootDomain": {
"type": "string"
},
"storefrontSubdomain": {
"type": "string"
},
"setupStatus": {
"type": "string"
},
"currentStepKey": {
"type": "string"
}
},
"additionalProperties": true
},
"providerDetection": {
"type": [
"object",
"null"
],
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
},
"currentStep": {
"type": [
"object",
"null"
],
"properties": {
"id": {
"type": [
"integer",
"null"
]
},
"developerDomainId": {
"type": [
"integer",
"null"
]
},
"stepKey": {
"type": "string"
},
"step_key": {
"type": "string"
},
"featureKey": {
"type": "string"
},
"feature_key": {
"type": "string"
},
"title": {
"type": "string"
},
"description": {
"type": "string"
},
"warning": {
"type": "string"
},
"purpose": {
"type": "string"
},
"required": {
"type": "boolean"
},
"status": {
"type": "string"
},
"action": {
"type": "string",
"description": "Non-DNS step: prepare-domains, storefront-provider, email-providers or email-identity. Do not add it as a DNS row."
},
"type": {
"type": "string",
"description": "DNS type returned by the provider, such as A, CNAME, TXT or MX; absent on action steps."
},
"host": {
"type": "string"
},
"name": {
"type": "string"
},
"value": {
"type": "string"
},
"ttl": {
"type": [
"string",
"integer"
]
},
"priority": {
"type": "integer",
"description": "MX priority, entered separately from exchange."
},
"exchange": {
"type": "string"
},
"copyBlocked": {
"type": "boolean",
"description": "Missing provider value cannot be copied. Also respect copyPlan.mode=blocked."
},
"copyPlan": {
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": [
"create",
"replace",
"preserve",
"blocked"
]
},
"value": {
"type": "string"
},
"previousValue": {
"type": "string"
},
"message": {
"type": "string"
}
},
"required": [
"mode"
],
"additionalProperties": true,
"description": "Use value for create/replace, keep existing policy for preserve, and resolve message before copying for blocked."
},
"errorMessage": {
"type": "string"
},
"error_message": {
"type": "string"
},
"lastCheckedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"verifiedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"createdAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"updatedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"additionalProperties": true
},
"current_step": {
"type": [
"object",
"null"
],
"properties": {
"id": {
"type": [
"integer",
"null"
]
},
"developerDomainId": {
"type": [
"integer",
"null"
]
},
"stepKey": {
"type": "string"
},
"step_key": {
"type": "string"
},
"featureKey": {
"type": "string"
},
"feature_key": {
"type": "string"
},
"title": {
"type": "string"
},
"description": {
"type": "string"
},
"warning": {
"type": "string"
},
"purpose": {
"type": "string"
},
"required": {
"type": "boolean"
},
"status": {
"type": "string"
},
"action": {
"type": "string",
"description": "Non-DNS step: prepare-domains, storefront-provider, email-providers or email-identity. Do not add it as a DNS row."
},
"type": {
"type": "string",
"description": "DNS type returned by the provider, such as A, CNAME, TXT or MX; absent on action steps."
},
"host": {
"type": "string"
},
"name": {
"type": "string"
},
"value": {
"type": "string"
},
"ttl": {
"type": [
"string",
"integer"
]
},
"priority": {
"type": "integer",
"description": "MX priority, entered separately from exchange."
},
"exchange": {
"type": "string"
},
"copyBlocked": {
"type": "boolean",
"description": "Missing provider value cannot be copied. Also respect copyPlan.mode=blocked."
},
"copyPlan": {
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": [
"create",
"replace",
"preserve",
"blocked"
]
},
"value": {
"type": "string"
},
"previousValue": {
"type": "string"
},
"message": {
"type": "string"
}
},
"required": [
"mode"
],
"additionalProperties": true,
"description": "Use value for create/replace, keep existing policy for preserve, and resolve message before copying for blocked."
},
"errorMessage": {
"type": "string"
},
"error_message": {
"type": "string"
},
"lastCheckedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"verifiedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"createdAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"updatedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"additionalProperties": true
},
"wizardProgress": {
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string"
},
"label": {
"type": "string"
},
"status": {
"type": "string"
},
"completeCount": {
"type": "integer"
},
"totalCount": {
"type": "integer"
}
},
"additionalProperties": true
}
},
"records": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": [
"integer",
"null"
]
},
"developerDomainId": {
"type": [
"integer",
"null"
]
},
"stepKey": {
"type": "string"
},
"step_key": {
"type": "string"
},
"featureKey": {
"type": "string"
},
"feature_key": {
"type": "string"
},
"title": {
"type": "string"
},
"description": {
"type": "string"
},
"warning": {
"type": "string"
},
"purpose": {
"type": "string"
},
"required": {
"type": "boolean"
},
"status": {
"type": "string"
},
"action": {
"type": "string",
"description": "Non-DNS step: prepare-domains, storefront-provider, email-providers or email-identity. Do not add it as a DNS row."
},
"type": {
"type": "string",
"description": "DNS type returned by the provider, such as A, CNAME, TXT or MX; absent on action steps."
},
"host": {
"type": "string"
},
"name": {
"type": "string"
},
"value": {
"type": "string"
},
"ttl": {
"type": [
"string",
"integer"
]
},
"priority": {
"type": "integer",
"description": "MX priority, entered separately from exchange."
},
"exchange": {
"type": "string"
},
"copyBlocked": {
"type": "boolean",
"description": "Missing provider value cannot be copied. Also respect copyPlan.mode=blocked."
},
"copyPlan": {
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": [
"create",
"replace",
"preserve",
"blocked"
]
},
"value": {
"type": "string"
},
"previousValue": {
"type": "string"
},
"message": {
"type": "string"
}
},
"required": [
"mode"
],
"additionalProperties": true,
"description": "Use value for create/replace, keep existing policy for preserve, and resolve message before copying for blocked."
},
"errorMessage": {
"type": "string"
},
"error_message": {
"type": "string"
},
"lastCheckedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"verifiedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"createdAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"updatedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"additionalProperties": true
}
},
"featureSummaries": {
"type": "array",
"items": {
"type": "object",
"properties": {
"featureKey": {
"type": "string"
},
"feature_key": {
"type": "string"
},
"label": {
"type": "string"
},
"status": {
"type": "string"
},
"completeCount": {
"type": "integer"
},
"requiredCount": {
"type": "integer"
},
"totalCount": {
"type": "integer"
},
"records": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": [
"integer",
"null"
]
},
"developerDomainId": {
"type": [
"integer",
"null"
]
},
"stepKey": {
"type": "string"
},
"step_key": {
"type": "string"
},
"featureKey": {
"type": "string"
},
"feature_key": {
"type": "string"
},
"title": {
"type": "string"
},
"description": {
"type": "string"
},
"warning": {
"type": "string"
},
"purpose": {
"type": "string"
},
"required": {
"type": "boolean"
},
"status": {
"type": "string"
},
"action": {
"type": "string",
"description": "Non-DNS step: prepare-domains, storefront-provider, email-providers or email-identity. Do not add it as a DNS row."
},
"type": {
"type": "string",
"description": "DNS type returned by the provider, such as A, CNAME, TXT or MX; absent on action steps."
},
"host": {
"type": "string"
},
"name": {
"type": "string"
},
"value": {
"type": "string"
},
"ttl": {
"type": [
"string",
"integer"
]
},
"priority": {
"type": "integer",
"description": "MX priority, entered separately from exchange."
},
"exchange": {
"type": "string"
},
"copyBlocked": {
"type": "boolean",
"description": "Missing provider value cannot be copied. Also respect copyPlan.mode=blocked."
},
"copyPlan": {
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": [
"create",
"replace",
"preserve",
"blocked"
]
},
"value": {
"type": "string"
},
"previousValue": {
"type": "string"
},
"message": {
"type": "string"
}
},
"required": [
"mode"
],
"additionalProperties": true,
"description": "Use value for create/replace, keep existing policy for preserve, and resolve message before copying for blocked."
},
"errorMessage": {
"type": "string"
},
"error_message": {
"type": "string"
},
"lastCheckedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"verifiedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"createdAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"updatedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"additionalProperties": true
}
}
},
"additionalProperties": true
}
},
"events": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
},
"status": {
"type": "string"
},
"created_at": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"updated_at": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"additionalProperties": true
}
},
"allRequiredVerified": {
"type": "boolean"
},
"providerSupport": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
},
"branding": {
"type": "object",
"properties": {
"storeName": {
"type": "string"
},
"developerDisplayName": {
"type": "string"
},
"tagline": {
"type": "string"
},
"slug": {
"type": "string"
},
"shortDescription": {
"type": "string"
},
"marketplaceBio": {
"type": "string"
},
"logos": {
"type": "object",
"properties": {
"logoUrl": {
"type": "string"
},
"lightLogoUrl": {
"type": "string"
},
"darkLogoUrl": {
"type": "string"
},
"iconUrl": {
"type": "string"
},
"defaultProductImageUrl": {
"type": "string"
}
},
"additionalProperties": true
},
"colors": {
"type": "object",
"properties": {
"appearance": {
"type": "string",
"enum": [
"light",
"dark",
"system"
]
},
"backgroundColor": {
"type": "string"
},
"brandHighlightColor": {
"type": "string"
},
"accentColor": {
"type": "string"
},
"advancedOverrides": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
},
"additionalProperties": true
},
"support": {
"type": "object",
"properties": {
"supportEmail": {
"type": "string"
},
"supportUrl": {
"type": "string"
},
"documentationUrl": {
"type": "string"
},
"faqUrl": {
"type": "string"
},
"refundPolicyUrl": {
"type": "string"
},
"termsUrl": {
"type": "string"
},
"licenseUrl": {
"type": "string"
}
},
"additionalProperties": true
},
"emailIdentity": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
},
"socialLinks": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
},
"domains": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
},
"metadata": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
},
"additionalProperties": true
},
"storefrontDomain": {
"type": "string"
},
"emailDomains": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
},
"domain": {
"type": "string"
},
"fromLocalPart": {
"type": "string"
},
"senderEmail": {
"type": "string"
},
"status": {
"type": "string"
},
"verified": {
"type": "boolean"
},
"elasticStatus": {
"type": "string"
},
"elasticVerified": {
"type": "boolean"
},
"unifiedVerified": {
"type": "boolean"
},
"dnsRecords": {
"type": "array",
"items": {
"type": "object",
"properties": {
"provider": {
"type": "string"
},
"record": {
"type": "string"
},
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"value": {
"type": "string"
},
"ttl": {
"type": [
"string",
"number"
]
},
"priority": {
"type": [
"number",
"null"
]
},
"status": {
"type": "string"
}
},
"additionalProperties": true
}
},
"providerVerification": {
"type": "object",
"properties": {
"resend": {
"type": "object",
"properties": {
"provider": {
"type": "string"
},
"status": {
"type": "string"
},
"verified": {
"type": "boolean"
},
"dnsRecords": {
"type": "array",
"items": {
"type": "object",
"properties": {
"provider": {
"type": "string"
},
"record": {
"type": "string"
},
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"value": {
"type": "string"
},
"ttl": {
"type": [
"string",
"number"
]
},
"priority": {
"type": [
"number",
"null"
]
},
"status": {
"type": "string"
}
},
"additionalProperties": true
}
},
"verifiedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"lastCheckedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"lastError": {
"type": [
"string",
"null"
]
},
"metadata": {
"type": "object",
"properties": {
"sendingEnabled": {
"type": "boolean"
},
"sendingReady": {
"type": "boolean"
},
"trackingReady": {
"type": "boolean"
},
"trackingCertificateReady": {
"type": "boolean"
},
"certificateExpiresAt": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
},
"elastic": {
"type": "object",
"properties": {
"provider": {
"type": "string"
},
"status": {
"type": "string"
},
"verified": {
"type": "boolean"
},
"dnsRecords": {
"type": "array",
"items": {
"type": "object",
"properties": {
"provider": {
"type": "string"
},
"record": {
"type": "string"
},
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"value": {
"type": "string"
},
"ttl": {
"type": [
"string",
"number"
]
},
"priority": {
"type": [
"number",
"null"
]
},
"status": {
"type": "string"
}
},
"additionalProperties": true
}
},
"verifiedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"lastCheckedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"lastError": {
"type": [
"string",
"null"
]
},
"metadata": {
"type": "object",
"properties": {
"sendingEnabled": {
"type": "boolean"
},
"sendingReady": {
"type": "boolean"
},
"trackingReady": {
"type": "boolean"
},
"trackingCertificateReady": {
"type": "boolean"
},
"certificateExpiresAt": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}
},
"additionalProperties": true
},
"providerReadErrors": {
"type": "object",
"properties": {
"resend": {
"type": "string"
},
"elastic": {
"type": "string"
}
},
"additionalProperties": true
},
"verifiedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"lastCheckedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"lastError": {
"type": [
"string",
"null"
]
}
},
"additionalProperties": true
}
},
"emailDomainSettings": {
"type": "object",
"properties": {
"supportEmail": {
"type": "string"
},
"supportEmailPresent": {
"type": "boolean"
},
"brandDomainOwnershipReady": {
"type": "boolean"
},
"customDomain": {
"type": [
"object",
"null"
],
"properties": {
"id": {
"type": "integer",
"minimum": 1
},
"domain": {
"type": "string"
},
"fromLocalPart": {
"type": "string"
},
"senderEmail": {
"type": "string"
},
"status": {
"type": "string"
},
"verified": {
"type": "boolean"
},
"elasticStatus": {
"type": "string"
},
"elasticVerified": {
"type": "boolean"
},
"unifiedVerified": {
"type": "boolean"
},
"dnsRecords": {
"type": "array",
"items": {
"type": "object",
"properties": {
"provider": {
"type": "string"
},
"record": {
"type": "string"
},
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"value": {
"type": "string"
},
"ttl": {
"type": [
"string",
"number"
]
},
"priority": {
"type": [
"number",
"null"
]
},
"status": {
"type": "string"
}
},
"additionalProperties": true
}
},
"providerVerification": {
"type": "object",
"properties": {
"resend": {
"type": "object",
"properties": {
"provider": {
"type": "string"
},
"status": {
"type": "string"
},
"verified": {
"type": "boolean"
},
"dnsRecords": {
"type": "array",
"items": {
"type": "object",
"properties": {
"provider": {
"type": "string"
},
"record": {
"type": "string"
},
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"value": {
"type": "string"
},
"ttl": {
"type": [
"string",
"number"
]
},
"priority": {
"type": [
"number",
"null"
]
},
"status": {
"type": "string"
}
},
"additionalProperties": true
}
},
"verifiedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"lastCheckedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"lastError": {
"type": [
"string",
"null"
]
},
"metadata": {
"type": "object",
"properties": {
"sendingEnabled": {
"type": "boolean"
},
"sendingReady": {
"type": "boolean"
},
"trackingReady": {
"type": "boolean"
},
"trackingCertificateReady": {
"type": "boolean"
},
"certificateExpiresAt": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
},
"elastic": {
"type": "object",
"properties": {
"provider": {
"type": "string"
},
"status": {
"type": "string"
},
"verified": {
"type": "boolean"
},
"dnsRecords": {
"type": "array",
"items": {
"type": "object",
"properties": {
"provider": {
"type": "string"
},
"record": {
"type": "string"
},
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"value": {
"type": "string"
},
"ttl": {
"type": [
"string",
"number"
]
},
"priority": {
"type": [
"number",
"null"
]
},
"status": {
"type": "string"
}
},
"additionalProperties": true
}
},
"verifiedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"lastCheckedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"lastError": {
"type": [
"string",
"null"
]
},
"metadata": {
"type": "object",
"properties": {
"sendingEnabled": {
"type": "boolean"
},
"sendingReady": {
"type": "boolean"
},
"trackingReady": {
"type": "boolean"
},
"trackingCertificateReady": {
"type": "boolean"
},
"certificateExpiresAt": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}
},
"additionalProperties": true
},
"providerReadErrors": {
"type": "object",
"properties": {
"resend": {
"type": "string"
},
"elastic": {
"type": "string"
}
},
"additionalProperties": true
},
"verifiedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"lastCheckedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"lastError": {
"type": [
"string",
"null"
]
}
},
"additionalProperties": true
},
"domainStatus": {
"type": [
"string",
"null"
]
},
"marketingDomainStatus": {
"type": [
"string",
"null"
]
},
"senderProfiles": {
"type": "object",
"properties": {
"licensing": {
"type": "object",
"properties": {
"purpose": {
"enum": [
"licensing",
"notifications",
"marketing"
]
},
"label": {
"type": "string"
},
"localPart": {
"type": "string"
},
"fromEmail": {
"type": "string"
},
"editable": {
"type": "boolean"
}
},
"additionalProperties": true
},
"notifications": {
"type": "object",
"properties": {
"purpose": {
"enum": [
"licensing",
"notifications",
"marketing"
]
},
"label": {
"type": "string"
},
"localPart": {
"type": "string"
},
"fromEmail": {
"type": "string"
},
"editable": {
"type": "boolean"
}
},
"additionalProperties": true
},
"marketing": {
"type": "object",
"properties": {
"purpose": {
"enum": [
"licensing",
"notifications",
"marketing"
]
},
"label": {
"type": "string"
},
"localPart": {
"type": "string"
},
"fromEmail": {
"type": "string"
},
"editable": {
"type": "boolean"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
},
"customSendingUsable": {
"type": "boolean"
},
"transactionalSendingUsable": {
"type": "boolean"
},
"marketingSendingUsable": {
"type": "boolean"
},
"marketingTrackingUsable": {
"type": "boolean"
},
"trackClicks": {
"type": "boolean"
},
"trackOpens": {
"type": "boolean"
},
"canDisableUnsafeMarketingTracking": {
"type": "boolean"
},
"unifiedDomainVerified": {
"type": "boolean"
},
"providerReadiness": {
"type": "object",
"properties": {
"configured": {
"type": "boolean"
},
"transactional": {
"type": "boolean"
},
"marketing": {
"type": "boolean"
},
"tracking": {
"type": "boolean"
},
"ready": {
"type": "boolean"
}
},
"additionalProperties": true
},
"blockingReasons": {
"type": "array",
"items": {
"type": "string"
}
},
"transactionalBlockingReasons": {
"type": "array",
"items": {
"type": "string"
}
},
"marketingBlockingReasons": {
"type": "array",
"items": {
"type": "string"
}
},
"trackingBlockingReasons": {
"type": "array",
"items": {
"type": "string"
}
},
"fallbackSender": {
"type": "string"
}
},
"additionalProperties": true
},
"needsPreparation": {
"type": "boolean"
},
"automaticProviderSetup": {
"type": "boolean"
},
"emailProvidersConfigured": {
"type": "boolean"
},
"emailProvidersReady": {
"type": "boolean"
},
"providerPreparation": {
"type": "object",
"properties": {
"ready": {
"type": "boolean"
},
"missingRecords": {
"type": "array",
"items": {
"type": "string"
}
},
"errorMessage": {
"type": "string"
}
},
"additionalProperties": true
},
"readiness": {
"type": "object",
"properties": {
"dns": {
"type": "boolean"
},
"storefront": {
"type": "boolean"
},
"email": {
"type": "boolean"
},
"tracking": {
"type": "boolean"
},
"transactional": {
"type": "boolean"
},
"marketing": {
"type": "boolean"
},
"senders": {
"type": "boolean"
},
"identity": {
"type": "boolean"
},
"providersConfigured": {
"type": "boolean"
},
"ready": {
"type": "boolean"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}Documented failures: 400, 401, 403, 404, 409, 500, 503.
Operation errors: developer_team_permission_denied, developer_team_all_products_scope_required.
POST
/api/developer/brand/domain/email-identity
Save domain-linked sender identity
- Auth
- Account Bearer JWT
- Scope
- domains.view + domains.manage and all-products workspace scope.
- Request fields
- emailIdentity: object
- Returns
- HTTP 200: domain, providerDetection, currentStep, current_step, wizardProgress, records, featureSummaries, events, allRequiredVerified, providerSupport, branding, storefrontDomain, emailDomains, emailDomainSettings, needsPreparation, automaticProviderSetup, emailProvidersConfigured, emailProvidersReady, providerPreparation, readiness.
- Notes
- Flat and email_identity forms and supported snake_case fields are accepted. This saves identity, not sending-domain verification or permission to send. domains.view + domains.manage and all-products workspace scope. Selected-product teammates cannot use this workspace-wide domain wizard.
Request, response and error reference
Request (application/json)
{
"type": "object",
"properties": {
"emailIdentity": {
"type": "object",
"properties": {
"defaultSenderName": {
"type": "string"
},
"replyToEmail": {
"type": "string",
"format": "email"
},
"supportEmail": {
"type": "string",
"format": "email"
},
"marketingSenderEmail": {
"type": "string",
"format": "email"
},
"transactionalSenderEmail": {
"type": "string",
"format": "email"
},
"emailFooterText": {
"type": "string"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}HTTP 200 response (application/json)
{
"type": "object",
"properties": {
"domain": {
"type": [
"object",
"null"
],
"properties": {
"id": {
"type": "integer",
"minimum": 1
},
"domain": {
"type": "string"
},
"status": {
"type": "string"
},
"verified": {
"type": "boolean"
},
"dnsRecords": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"name": {
"type": "string"
},
"value": {
"type": "string"
}
},
"additionalProperties": true
}
},
"sslStatus": {
"type": "string"
},
"rootDomain": {
"type": "string"
},
"storefrontSubdomain": {
"type": "string"
},
"setupStatus": {
"type": "string"
},
"currentStepKey": {
"type": "string"
}
},
"additionalProperties": true
},
"providerDetection": {
"type": [
"object",
"null"
],
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
},
"currentStep": {
"type": [
"object",
"null"
],
"properties": {
"id": {
"type": [
"integer",
"null"
]
},
"developerDomainId": {
"type": [
"integer",
"null"
]
},
"stepKey": {
"type": "string"
},
"step_key": {
"type": "string"
},
"featureKey": {
"type": "string"
},
"feature_key": {
"type": "string"
},
"title": {
"type": "string"
},
"description": {
"type": "string"
},
"warning": {
"type": "string"
},
"purpose": {
"type": "string"
},
"required": {
"type": "boolean"
},
"status": {
"type": "string"
},
"action": {
"type": "string",
"description": "Non-DNS step: prepare-domains, storefront-provider, email-providers or email-identity. Do not add it as a DNS row."
},
"type": {
"type": "string",
"description": "DNS type returned by the provider, such as A, CNAME, TXT or MX; absent on action steps."
},
"host": {
"type": "string"
},
"name": {
"type": "string"
},
"value": {
"type": "string"
},
"ttl": {
"type": [
"string",
"integer"
]
},
"priority": {
"type": "integer",
"description": "MX priority, entered separately from exchange."
},
"exchange": {
"type": "string"
},
"copyBlocked": {
"type": "boolean",
"description": "Missing provider value cannot be copied. Also respect copyPlan.mode=blocked."
},
"copyPlan": {
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": [
"create",
"replace",
"preserve",
"blocked"
]
},
"value": {
"type": "string"
},
"previousValue": {
"type": "string"
},
"message": {
"type": "string"
}
},
"required": [
"mode"
],
"additionalProperties": true,
"description": "Use value for create/replace, keep existing policy for preserve, and resolve message before copying for blocked."
},
"errorMessage": {
"type": "string"
},
"error_message": {
"type": "string"
},
"lastCheckedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"verifiedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"createdAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"updatedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"additionalProperties": true
},
"current_step": {
"type": [
"object",
"null"
],
"properties": {
"id": {
"type": [
"integer",
"null"
]
},
"developerDomainId": {
"type": [
"integer",
"null"
]
},
"stepKey": {
"type": "string"
},
"step_key": {
"type": "string"
},
"featureKey": {
"type": "string"
},
"feature_key": {
"type": "string"
},
"title": {
"type": "string"
},
"description": {
"type": "string"
},
"warning": {
"type": "string"
},
"purpose": {
"type": "string"
},
"required": {
"type": "boolean"
},
"status": {
"type": "string"
},
"action": {
"type": "string",
"description": "Non-DNS step: prepare-domains, storefront-provider, email-providers or email-identity. Do not add it as a DNS row."
},
"type": {
"type": "string",
"description": "DNS type returned by the provider, such as A, CNAME, TXT or MX; absent on action steps."
},
"host": {
"type": "string"
},
"name": {
"type": "string"
},
"value": {
"type": "string"
},
"ttl": {
"type": [
"string",
"integer"
]
},
"priority": {
"type": "integer",
"description": "MX priority, entered separately from exchange."
},
"exchange": {
"type": "string"
},
"copyBlocked": {
"type": "boolean",
"description": "Missing provider value cannot be copied. Also respect copyPlan.mode=blocked."
},
"copyPlan": {
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": [
"create",
"replace",
"preserve",
"blocked"
]
},
"value": {
"type": "string"
},
"previousValue": {
"type": "string"
},
"message": {
"type": "string"
}
},
"required": [
"mode"
],
"additionalProperties": true,
"description": "Use value for create/replace, keep existing policy for preserve, and resolve message before copying for blocked."
},
"errorMessage": {
"type": "string"
},
"error_message": {
"type": "string"
},
"lastCheckedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"verifiedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"createdAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"updatedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"additionalProperties": true
},
"wizardProgress": {
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string"
},
"label": {
"type": "string"
},
"status": {
"type": "string"
},
"completeCount": {
"type": "integer"
},
"totalCount": {
"type": "integer"
}
},
"additionalProperties": true
}
},
"records": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": [
"integer",
"null"
]
},
"developerDomainId": {
"type": [
"integer",
"null"
]
},
"stepKey": {
"type": "string"
},
"step_key": {
"type": "string"
},
"featureKey": {
"type": "string"
},
"feature_key": {
"type": "string"
},
"title": {
"type": "string"
},
"description": {
"type": "string"
},
"warning": {
"type": "string"
},
"purpose": {
"type": "string"
},
"required": {
"type": "boolean"
},
"status": {
"type": "string"
},
"action": {
"type": "string",
"description": "Non-DNS step: prepare-domains, storefront-provider, email-providers or email-identity. Do not add it as a DNS row."
},
"type": {
"type": "string",
"description": "DNS type returned by the provider, such as A, CNAME, TXT or MX; absent on action steps."
},
"host": {
"type": "string"
},
"name": {
"type": "string"
},
"value": {
"type": "string"
},
"ttl": {
"type": [
"string",
"integer"
]
},
"priority": {
"type": "integer",
"description": "MX priority, entered separately from exchange."
},
"exchange": {
"type": "string"
},
"copyBlocked": {
"type": "boolean",
"description": "Missing provider value cannot be copied. Also respect copyPlan.mode=blocked."
},
"copyPlan": {
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": [
"create",
"replace",
"preserve",
"blocked"
]
},
"value": {
"type": "string"
},
"previousValue": {
"type": "string"
},
"message": {
"type": "string"
}
},
"required": [
"mode"
],
"additionalProperties": true,
"description": "Use value for create/replace, keep existing policy for preserve, and resolve message before copying for blocked."
},
"errorMessage": {
"type": "string"
},
"error_message": {
"type": "string"
},
"lastCheckedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"verifiedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"createdAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"updatedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"additionalProperties": true
}
},
"featureSummaries": {
"type": "array",
"items": {
"type": "object",
"properties": {
"featureKey": {
"type": "string"
},
"feature_key": {
"type": "string"
},
"label": {
"type": "string"
},
"status": {
"type": "string"
},
"completeCount": {
"type": "integer"
},
"requiredCount": {
"type": "integer"
},
"totalCount": {
"type": "integer"
},
"records": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": [
"integer",
"null"
]
},
"developerDomainId": {
"type": [
"integer",
"null"
]
},
"stepKey": {
"type": "string"
},
"step_key": {
"type": "string"
},
"featureKey": {
"type": "string"
},
"feature_key": {
"type": "string"
},
"title": {
"type": "string"
},
"description": {
"type": "string"
},
"warning": {
"type": "string"
},
"purpose": {
"type": "string"
},
"required": {
"type": "boolean"
},
"status": {
"type": "string"
},
"action": {
"type": "string",
"description": "Non-DNS step: prepare-domains, storefront-provider, email-providers or email-identity. Do not add it as a DNS row."
},
"type": {
"type": "string",
"description": "DNS type returned by the provider, such as A, CNAME, TXT or MX; absent on action steps."
},
"host": {
"type": "string"
},
"name": {
"type": "string"
},
"value": {
"type": "string"
},
"ttl": {
"type": [
"string",
"integer"
]
},
"priority": {
"type": "integer",
"description": "MX priority, entered separately from exchange."
},
"exchange": {
"type": "string"
},
"copyBlocked": {
"type": "boolean",
"description": "Missing provider value cannot be copied. Also respect copyPlan.mode=blocked."
},
"copyPlan": {
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": [
"create",
"replace",
"preserve",
"blocked"
]
},
"value": {
"type": "string"
},
"previousValue": {
"type": "string"
},
"message": {
"type": "string"
}
},
"required": [
"mode"
],
"additionalProperties": true,
"description": "Use value for create/replace, keep existing policy for preserve, and resolve message before copying for blocked."
},
"errorMessage": {
"type": "string"
},
"error_message": {
"type": "string"
},
"lastCheckedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"verifiedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"createdAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"updatedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"additionalProperties": true
}
}
},
"additionalProperties": true
}
},
"events": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
},
"status": {
"type": "string"
},
"created_at": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"updated_at": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"additionalProperties": true
}
},
"allRequiredVerified": {
"type": "boolean"
},
"providerSupport": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
},
"branding": {
"type": "object",
"properties": {
"storeName": {
"type": "string"
},
"developerDisplayName": {
"type": "string"
},
"tagline": {
"type": "string"
},
"slug": {
"type": "string"
},
"shortDescription": {
"type": "string"
},
"marketplaceBio": {
"type": "string"
},
"logos": {
"type": "object",
"properties": {
"logoUrl": {
"type": "string"
},
"lightLogoUrl": {
"type": "string"
},
"darkLogoUrl": {
"type": "string"
},
"iconUrl": {
"type": "string"
},
"defaultProductImageUrl": {
"type": "string"
}
},
"additionalProperties": true
},
"colors": {
"type": "object",
"properties": {
"appearance": {
"type": "string",
"enum": [
"light",
"dark",
"system"
]
},
"backgroundColor": {
"type": "string"
},
"brandHighlightColor": {
"type": "string"
},
"accentColor": {
"type": "string"
},
"advancedOverrides": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
},
"additionalProperties": true
},
"support": {
"type": "object",
"properties": {
"supportEmail": {
"type": "string"
},
"supportUrl": {
"type": "string"
},
"documentationUrl": {
"type": "string"
},
"faqUrl": {
"type": "string"
},
"refundPolicyUrl": {
"type": "string"
},
"termsUrl": {
"type": "string"
},
"licenseUrl": {
"type": "string"
}
},
"additionalProperties": true
},
"emailIdentity": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
},
"socialLinks": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
},
"domains": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
},
"metadata": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
},
"additionalProperties": true
},
"storefrontDomain": {
"type": "string"
},
"emailDomains": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
},
"domain": {
"type": "string"
},
"fromLocalPart": {
"type": "string"
},
"senderEmail": {
"type": "string"
},
"status": {
"type": "string"
},
"verified": {
"type": "boolean"
},
"elasticStatus": {
"type": "string"
},
"elasticVerified": {
"type": "boolean"
},
"unifiedVerified": {
"type": "boolean"
},
"dnsRecords": {
"type": "array",
"items": {
"type": "object",
"properties": {
"provider": {
"type": "string"
},
"record": {
"type": "string"
},
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"value": {
"type": "string"
},
"ttl": {
"type": [
"string",
"number"
]
},
"priority": {
"type": [
"number",
"null"
]
},
"status": {
"type": "string"
}
},
"additionalProperties": true
}
},
"providerVerification": {
"type": "object",
"properties": {
"resend": {
"type": "object",
"properties": {
"provider": {
"type": "string"
},
"status": {
"type": "string"
},
"verified": {
"type": "boolean"
},
"dnsRecords": {
"type": "array",
"items": {
"type": "object",
"properties": {
"provider": {
"type": "string"
},
"record": {
"type": "string"
},
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"value": {
"type": "string"
},
"ttl": {
"type": [
"string",
"number"
]
},
"priority": {
"type": [
"number",
"null"
]
},
"status": {
"type": "string"
}
},
"additionalProperties": true
}
},
"verifiedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"lastCheckedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"lastError": {
"type": [
"string",
"null"
]
},
"metadata": {
"type": "object",
"properties": {
"sendingEnabled": {
"type": "boolean"
},
"sendingReady": {
"type": "boolean"
},
"trackingReady": {
"type": "boolean"
},
"trackingCertificateReady": {
"type": "boolean"
},
"certificateExpiresAt": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
},
"elastic": {
"type": "object",
"properties": {
"provider": {
"type": "string"
},
"status": {
"type": "string"
},
"verified": {
"type": "boolean"
},
"dnsRecords": {
"type": "array",
"items": {
"type": "object",
"properties": {
"provider": {
"type": "string"
},
"record": {
"type": "string"
},
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"value": {
"type": "string"
},
"ttl": {
"type": [
"string",
"number"
]
},
"priority": {
"type": [
"number",
"null"
]
},
"status": {
"type": "string"
}
},
"additionalProperties": true
}
},
"verifiedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"lastCheckedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"lastError": {
"type": [
"string",
"null"
]
},
"metadata": {
"type": "object",
"properties": {
"sendingEnabled": {
"type": "boolean"
},
"sendingReady": {
"type": "boolean"
},
"trackingReady": {
"type": "boolean"
},
"trackingCertificateReady": {
"type": "boolean"
},
"certificateExpiresAt": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}
},
"additionalProperties": true
},
"providerReadErrors": {
"type": "object",
"properties": {
"resend": {
"type": "string"
},
"elastic": {
"type": "string"
}
},
"additionalProperties": true
},
"verifiedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"lastCheckedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"lastError": {
"type": [
"string",
"null"
]
}
},
"additionalProperties": true
}
},
"emailDomainSettings": {
"type": "object",
"properties": {
"supportEmail": {
"type": "string"
},
"supportEmailPresent": {
"type": "boolean"
},
"brandDomainOwnershipReady": {
"type": "boolean"
},
"customDomain": {
"type": [
"object",
"null"
],
"properties": {
"id": {
"type": "integer",
"minimum": 1
},
"domain": {
"type": "string"
},
"fromLocalPart": {
"type": "string"
},
"senderEmail": {
"type": "string"
},
"status": {
"type": "string"
},
"verified": {
"type": "boolean"
},
"elasticStatus": {
"type": "string"
},
"elasticVerified": {
"type": "boolean"
},
"unifiedVerified": {
"type": "boolean"
},
"dnsRecords": {
"type": "array",
"items": {
"type": "object",
"properties": {
"provider": {
"type": "string"
},
"record": {
"type": "string"
},
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"value": {
"type": "string"
},
"ttl": {
"type": [
"string",
"number"
]
},
"priority": {
"type": [
"number",
"null"
]
},
"status": {
"type": "string"
}
},
"additionalProperties": true
}
},
"providerVerification": {
"type": "object",
"properties": {
"resend": {
"type": "object",
"properties": {
"provider": {
"type": "string"
},
"status": {
"type": "string"
},
"verified": {
"type": "boolean"
},
"dnsRecords": {
"type": "array",
"items": {
"type": "object",
"properties": {
"provider": {
"type": "string"
},
"record": {
"type": "string"
},
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"value": {
"type": "string"
},
"ttl": {
"type": [
"string",
"number"
]
},
"priority": {
"type": [
"number",
"null"
]
},
"status": {
"type": "string"
}
},
"additionalProperties": true
}
},
"verifiedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"lastCheckedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"lastError": {
"type": [
"string",
"null"
]
},
"metadata": {
"type": "object",
"properties": {
"sendingEnabled": {
"type": "boolean"
},
"sendingReady": {
"type": "boolean"
},
"trackingReady": {
"type": "boolean"
},
"trackingCertificateReady": {
"type": "boolean"
},
"certificateExpiresAt": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
},
"elastic": {
"type": "object",
"properties": {
"provider": {
"type": "string"
},
"status": {
"type": "string"
},
"verified": {
"type": "boolean"
},
"dnsRecords": {
"type": "array",
"items": {
"type": "object",
"properties": {
"provider": {
"type": "string"
},
"record": {
"type": "string"
},
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"value": {
"type": "string"
},
"ttl": {
"type": [
"string",
"number"
]
},
"priority": {
"type": [
"number",
"null"
]
},
"status": {
"type": "string"
}
},
"additionalProperties": true
}
},
"verifiedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"lastCheckedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"lastError": {
"type": [
"string",
"null"
]
},
"metadata": {
"type": "object",
"properties": {
"sendingEnabled": {
"type": "boolean"
},
"sendingReady": {
"type": "boolean"
},
"trackingReady": {
"type": "boolean"
},
"trackingCertificateReady": {
"type": "boolean"
},
"certificateExpiresAt": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}
},
"additionalProperties": true
},
"providerReadErrors": {
"type": "object",
"properties": {
"resend": {
"type": "string"
},
"elastic": {
"type": "string"
}
},
"additionalProperties": true
},
"verifiedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"lastCheckedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"lastError": {
"type": [
"string",
"null"
]
}
},
"additionalProperties": true
},
"domainStatus": {
"type": [
"string",
"null"
]
},
"marketingDomainStatus": {
"type": [
"string",
"null"
]
},
"senderProfiles": {
"type": "object",
"properties": {
"licensing": {
"type": "object",
"properties": {
"purpose": {
"enum": [
"licensing",
"notifications",
"marketing"
]
},
"label": {
"type": "string"
},
"localPart": {
"type": "string"
},
"fromEmail": {
"type": "string"
},
"editable": {
"type": "boolean"
}
},
"additionalProperties": true
},
"notifications": {
"type": "object",
"properties": {
"purpose": {
"enum": [
"licensing",
"notifications",
"marketing"
]
},
"label": {
"type": "string"
},
"localPart": {
"type": "string"
},
"fromEmail": {
"type": "string"
},
"editable": {
"type": "boolean"
}
},
"additionalProperties": true
},
"marketing": {
"type": "object",
"properties": {
"purpose": {
"enum": [
"licensing",
"notifications",
"marketing"
]
},
"label": {
"type": "string"
},
"localPart": {
"type": "string"
},
"fromEmail": {
"type": "string"
},
"editable": {
"type": "boolean"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
},
"customSendingUsable": {
"type": "boolean"
},
"transactionalSendingUsable": {
"type": "boolean"
},
"marketingSendingUsable": {
"type": "boolean"
},
"marketingTrackingUsable": {
"type": "boolean"
},
"trackClicks": {
"type": "boolean"
},
"trackOpens": {
"type": "boolean"
},
"canDisableUnsafeMarketingTracking": {
"type": "boolean"
},
"unifiedDomainVerified": {
"type": "boolean"
},
"providerReadiness": {
"type": "object",
"properties": {
"configured": {
"type": "boolean"
},
"transactional": {
"type": "boolean"
},
"marketing": {
"type": "boolean"
},
"tracking": {
"type": "boolean"
},
"ready": {
"type": "boolean"
}
},
"additionalProperties": true
},
"blockingReasons": {
"type": "array",
"items": {
"type": "string"
}
},
"transactionalBlockingReasons": {
"type": "array",
"items": {
"type": "string"
}
},
"marketingBlockingReasons": {
"type": "array",
"items": {
"type": "string"
}
},
"trackingBlockingReasons": {
"type": "array",
"items": {
"type": "string"
}
},
"fallbackSender": {
"type": "string"
}
},
"additionalProperties": true
},
"needsPreparation": {
"type": "boolean"
},
"automaticProviderSetup": {
"type": "boolean"
},
"emailProvidersConfigured": {
"type": "boolean"
},
"emailProvidersReady": {
"type": "boolean"
},
"providerPreparation": {
"type": "object",
"properties": {
"ready": {
"type": "boolean"
},
"missingRecords": {
"type": "array",
"items": {
"type": "string"
}
},
"errorMessage": {
"type": "string"
}
},
"additionalProperties": true
},
"readiness": {
"type": "object",
"properties": {
"dns": {
"type": "boolean"
},
"storefront": {
"type": "boolean"
},
"email": {
"type": "boolean"
},
"tracking": {
"type": "boolean"
},
"transactional": {
"type": "boolean"
},
"marketing": {
"type": "boolean"
},
"senders": {
"type": "boolean"
},
"identity": {
"type": "boolean"
},
"providersConfigured": {
"type": "boolean"
},
"ready": {
"type": "boolean"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}Documented failures: 400, 401, 403, 404, 409, 500, 503.
Operation errors: developer_team_permission_denied, developer_team_all_products_scope_required.
POST
/api/developer/brand/domain/sender-profiles
Save sender local parts for the active sending domain
- Auth
- Account Bearer JWT
- Scope
- domains.view + domains.manage and all-products workspace scope.
- Request fields
- senderProfiles: object
- Returns
- HTTP 200: domain, providerDetection, currentStep, current_step, wizardProgress, records, featureSummaries, events, allRequiredVerified, providerSupport, branding, storefrontDomain, emailDomains, emailDomainSettings, needsPreparation, automaticProviderSetup, emailProvidersConfigured, emailProvidersReady, providerPreparation, readiness.
- Notes
- At least one supported purpose is required; flat purpose fields and local_part aliases are accepted. Requires an active custom sending domain. Saving does not bypass sender verification. domains.view + domains.manage and all-products workspace scope. Selected-product teammates cannot use this workspace-wide domain wizard.
Request, response and error reference
Request (application/json)
{
"type": "object",
"properties": {
"senderProfiles": {
"type": "object",
"properties": {
"licensing": {
"oneOf": [
{
"type": "string"
},
{
"type": "object",
"properties": {
"localPart": {
"type": "string"
}
},
"additionalProperties": true
}
]
},
"notifications": {
"oneOf": [
{
"type": "string"
},
{
"type": "object",
"properties": {
"localPart": {
"type": "string"
}
},
"additionalProperties": true
}
]
},
"marketing": {
"oneOf": [
{
"type": "string"
},
{
"type": "object",
"properties": {
"localPart": {
"type": "string"
}
},
"additionalProperties": true
}
]
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}HTTP 200 response (application/json)
{
"type": "object",
"properties": {
"domain": {
"type": [
"object",
"null"
],
"properties": {
"id": {
"type": "integer",
"minimum": 1
},
"domain": {
"type": "string"
},
"status": {
"type": "string"
},
"verified": {
"type": "boolean"
},
"dnsRecords": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"name": {
"type": "string"
},
"value": {
"type": "string"
}
},
"additionalProperties": true
}
},
"sslStatus": {
"type": "string"
},
"rootDomain": {
"type": "string"
},
"storefrontSubdomain": {
"type": "string"
},
"setupStatus": {
"type": "string"
},
"currentStepKey": {
"type": "string"
}
},
"additionalProperties": true
},
"providerDetection": {
"type": [
"object",
"null"
],
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
},
"currentStep": {
"type": [
"object",
"null"
],
"properties": {
"id": {
"type": [
"integer",
"null"
]
},
"developerDomainId": {
"type": [
"integer",
"null"
]
},
"stepKey": {
"type": "string"
},
"step_key": {
"type": "string"
},
"featureKey": {
"type": "string"
},
"feature_key": {
"type": "string"
},
"title": {
"type": "string"
},
"description": {
"type": "string"
},
"warning": {
"type": "string"
},
"purpose": {
"type": "string"
},
"required": {
"type": "boolean"
},
"status": {
"type": "string"
},
"action": {
"type": "string",
"description": "Non-DNS step: prepare-domains, storefront-provider, email-providers or email-identity. Do not add it as a DNS row."
},
"type": {
"type": "string",
"description": "DNS type returned by the provider, such as A, CNAME, TXT or MX; absent on action steps."
},
"host": {
"type": "string"
},
"name": {
"type": "string"
},
"value": {
"type": "string"
},
"ttl": {
"type": [
"string",
"integer"
]
},
"priority": {
"type": "integer",
"description": "MX priority, entered separately from exchange."
},
"exchange": {
"type": "string"
},
"copyBlocked": {
"type": "boolean",
"description": "Missing provider value cannot be copied. Also respect copyPlan.mode=blocked."
},
"copyPlan": {
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": [
"create",
"replace",
"preserve",
"blocked"
]
},
"value": {
"type": "string"
},
"previousValue": {
"type": "string"
},
"message": {
"type": "string"
}
},
"required": [
"mode"
],
"additionalProperties": true,
"description": "Use value for create/replace, keep existing policy for preserve, and resolve message before copying for blocked."
},
"errorMessage": {
"type": "string"
},
"error_message": {
"type": "string"
},
"lastCheckedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"verifiedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"createdAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"updatedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"additionalProperties": true
},
"current_step": {
"type": [
"object",
"null"
],
"properties": {
"id": {
"type": [
"integer",
"null"
]
},
"developerDomainId": {
"type": [
"integer",
"null"
]
},
"stepKey": {
"type": "string"
},
"step_key": {
"type": "string"
},
"featureKey": {
"type": "string"
},
"feature_key": {
"type": "string"
},
"title": {
"type": "string"
},
"description": {
"type": "string"
},
"warning": {
"type": "string"
},
"purpose": {
"type": "string"
},
"required": {
"type": "boolean"
},
"status": {
"type": "string"
},
"action": {
"type": "string",
"description": "Non-DNS step: prepare-domains, storefront-provider, email-providers or email-identity. Do not add it as a DNS row."
},
"type": {
"type": "string",
"description": "DNS type returned by the provider, such as A, CNAME, TXT or MX; absent on action steps."
},
"host": {
"type": "string"
},
"name": {
"type": "string"
},
"value": {
"type": "string"
},
"ttl": {
"type": [
"string",
"integer"
]
},
"priority": {
"type": "integer",
"description": "MX priority, entered separately from exchange."
},
"exchange": {
"type": "string"
},
"copyBlocked": {
"type": "boolean",
"description": "Missing provider value cannot be copied. Also respect copyPlan.mode=blocked."
},
"copyPlan": {
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": [
"create",
"replace",
"preserve",
"blocked"
]
},
"value": {
"type": "string"
},
"previousValue": {
"type": "string"
},
"message": {
"type": "string"
}
},
"required": [
"mode"
],
"additionalProperties": true,
"description": "Use value for create/replace, keep existing policy for preserve, and resolve message before copying for blocked."
},
"errorMessage": {
"type": "string"
},
"error_message": {
"type": "string"
},
"lastCheckedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"verifiedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"createdAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"updatedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"additionalProperties": true
},
"wizardProgress": {
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string"
},
"label": {
"type": "string"
},
"status": {
"type": "string"
},
"completeCount": {
"type": "integer"
},
"totalCount": {
"type": "integer"
}
},
"additionalProperties": true
}
},
"records": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": [
"integer",
"null"
]
},
"developerDomainId": {
"type": [
"integer",
"null"
]
},
"stepKey": {
"type": "string"
},
"step_key": {
"type": "string"
},
"featureKey": {
"type": "string"
},
"feature_key": {
"type": "string"
},
"title": {
"type": "string"
},
"description": {
"type": "string"
},
"warning": {
"type": "string"
},
"purpose": {
"type": "string"
},
"required": {
"type": "boolean"
},
"status": {
"type": "string"
},
"action": {
"type": "string",
"description": "Non-DNS step: prepare-domains, storefront-provider, email-providers or email-identity. Do not add it as a DNS row."
},
"type": {
"type": "string",
"description": "DNS type returned by the provider, such as A, CNAME, TXT or MX; absent on action steps."
},
"host": {
"type": "string"
},
"name": {
"type": "string"
},
"value": {
"type": "string"
},
"ttl": {
"type": [
"string",
"integer"
]
},
"priority": {
"type": "integer",
"description": "MX priority, entered separately from exchange."
},
"exchange": {
"type": "string"
},
"copyBlocked": {
"type": "boolean",
"description": "Missing provider value cannot be copied. Also respect copyPlan.mode=blocked."
},
"copyPlan": {
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": [
"create",
"replace",
"preserve",
"blocked"
]
},
"value": {
"type": "string"
},
"previousValue": {
"type": "string"
},
"message": {
"type": "string"
}
},
"required": [
"mode"
],
"additionalProperties": true,
"description": "Use value for create/replace, keep existing policy for preserve, and resolve message before copying for blocked."
},
"errorMessage": {
"type": "string"
},
"error_message": {
"type": "string"
},
"lastCheckedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"verifiedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"createdAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"updatedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"additionalProperties": true
}
},
"featureSummaries": {
"type": "array",
"items": {
"type": "object",
"properties": {
"featureKey": {
"type": "string"
},
"feature_key": {
"type": "string"
},
"label": {
"type": "string"
},
"status": {
"type": "string"
},
"completeCount": {
"type": "integer"
},
"requiredCount": {
"type": "integer"
},
"totalCount": {
"type": "integer"
},
"records": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": [
"integer",
"null"
]
},
"developerDomainId": {
"type": [
"integer",
"null"
]
},
"stepKey": {
"type": "string"
},
"step_key": {
"type": "string"
},
"featureKey": {
"type": "string"
},
"feature_key": {
"type": "string"
},
"title": {
"type": "string"
},
"description": {
"type": "string"
},
"warning": {
"type": "string"
},
"purpose": {
"type": "string"
},
"required": {
"type": "boolean"
},
"status": {
"type": "string"
},
"action": {
"type": "string",
"description": "Non-DNS step: prepare-domains, storefront-provider, email-providers or email-identity. Do not add it as a DNS row."
},
"type": {
"type": "string",
"description": "DNS type returned by the provider, such as A, CNAME, TXT or MX; absent on action steps."
},
"host": {
"type": "string"
},
"name": {
"type": "string"
},
"value": {
"type": "string"
},
"ttl": {
"type": [
"string",
"integer"
]
},
"priority": {
"type": "integer",
"description": "MX priority, entered separately from exchange."
},
"exchange": {
"type": "string"
},
"copyBlocked": {
"type": "boolean",
"description": "Missing provider value cannot be copied. Also respect copyPlan.mode=blocked."
},
"copyPlan": {
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": [
"create",
"replace",
"preserve",
"blocked"
]
},
"value": {
"type": "string"
},
"previousValue": {
"type": "string"
},
"message": {
"type": "string"
}
},
"required": [
"mode"
],
"additionalProperties": true,
"description": "Use value for create/replace, keep existing policy for preserve, and resolve message before copying for blocked."
},
"errorMessage": {
"type": "string"
},
"error_message": {
"type": "string"
},
"lastCheckedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"verifiedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"createdAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"updatedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"additionalProperties": true
}
}
},
"additionalProperties": true
}
},
"events": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
},
"status": {
"type": "string"
},
"created_at": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"updated_at": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"additionalProperties": true
}
},
"allRequiredVerified": {
"type": "boolean"
},
"providerSupport": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
},
"branding": {
"type": "object",
"properties": {
"storeName": {
"type": "string"
},
"developerDisplayName": {
"type": "string"
},
"tagline": {
"type": "string"
},
"slug": {
"type": "string"
},
"shortDescription": {
"type": "string"
},
"marketplaceBio": {
"type": "string"
},
"logos": {
"type": "object",
"properties": {
"logoUrl": {
"type": "string"
},
"lightLogoUrl": {
"type": "string"
},
"darkLogoUrl": {
"type": "string"
},
"iconUrl": {
"type": "string"
},
"defaultProductImageUrl": {
"type": "string"
}
},
"additionalProperties": true
},
"colors": {
"type": "object",
"properties": {
"appearance": {
"type": "string",
"enum": [
"light",
"dark",
"system"
]
},
"backgroundColor": {
"type": "string"
},
"brandHighlightColor": {
"type": "string"
},
"accentColor": {
"type": "string"
},
"advancedOverrides": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
},
"additionalProperties": true
},
"support": {
"type": "object",
"properties": {
"supportEmail": {
"type": "string"
},
"supportUrl": {
"type": "string"
},
"documentationUrl": {
"type": "string"
},
"faqUrl": {
"type": "string"
},
"refundPolicyUrl": {
"type": "string"
},
"termsUrl": {
"type": "string"
},
"licenseUrl": {
"type": "string"
}
},
"additionalProperties": true
},
"emailIdentity": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
},
"socialLinks": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
},
"domains": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
},
"metadata": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
},
"additionalProperties": true
},
"storefrontDomain": {
"type": "string"
},
"emailDomains": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
},
"domain": {
"type": "string"
},
"fromLocalPart": {
"type": "string"
},
"senderEmail": {
"type": "string"
},
"status": {
"type": "string"
},
"verified": {
"type": "boolean"
},
"elasticStatus": {
"type": "string"
},
"elasticVerified": {
"type": "boolean"
},
"unifiedVerified": {
"type": "boolean"
},
"dnsRecords": {
"type": "array",
"items": {
"type": "object",
"properties": {
"provider": {
"type": "string"
},
"record": {
"type": "string"
},
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"value": {
"type": "string"
},
"ttl": {
"type": [
"string",
"number"
]
},
"priority": {
"type": [
"number",
"null"
]
},
"status": {
"type": "string"
}
},
"additionalProperties": true
}
},
"providerVerification": {
"type": "object",
"properties": {
"resend": {
"type": "object",
"properties": {
"provider": {
"type": "string"
},
"status": {
"type": "string"
},
"verified": {
"type": "boolean"
},
"dnsRecords": {
"type": "array",
"items": {
"type": "object",
"properties": {
"provider": {
"type": "string"
},
"record": {
"type": "string"
},
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"value": {
"type": "string"
},
"ttl": {
"type": [
"string",
"number"
]
},
"priority": {
"type": [
"number",
"null"
]
},
"status": {
"type": "string"
}
},
"additionalProperties": true
}
},
"verifiedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"lastCheckedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"lastError": {
"type": [
"string",
"null"
]
},
"metadata": {
"type": "object",
"properties": {
"sendingEnabled": {
"type": "boolean"
},
"sendingReady": {
"type": "boolean"
},
"trackingReady": {
"type": "boolean"
},
"trackingCertificateReady": {
"type": "boolean"
},
"certificateExpiresAt": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
},
"elastic": {
"type": "object",
"properties": {
"provider": {
"type": "string"
},
"status": {
"type": "string"
},
"verified": {
"type": "boolean"
},
"dnsRecords": {
"type": "array",
"items": {
"type": "object",
"properties": {
"provider": {
"type": "string"
},
"record": {
"type": "string"
},
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"value": {
"type": "string"
},
"ttl": {
"type": [
"string",
"number"
]
},
"priority": {
"type": [
"number",
"null"
]
},
"status": {
"type": "string"
}
},
"additionalProperties": true
}
},
"verifiedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"lastCheckedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"lastError": {
"type": [
"string",
"null"
]
},
"metadata": {
"type": "object",
"properties": {
"sendingEnabled": {
"type": "boolean"
},
"sendingReady": {
"type": "boolean"
},
"trackingReady": {
"type": "boolean"
},
"trackingCertificateReady": {
"type": "boolean"
},
"certificateExpiresAt": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}
},
"additionalProperties": true
},
"providerReadErrors": {
"type": "object",
"properties": {
"resend": {
"type": "string"
},
"elastic": {
"type": "string"
}
},
"additionalProperties": true
},
"verifiedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"lastCheckedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"lastError": {
"type": [
"string",
"null"
]
}
},
"additionalProperties": true
}
},
"emailDomainSettings": {
"type": "object",
"properties": {
"supportEmail": {
"type": "string"
},
"supportEmailPresent": {
"type": "boolean"
},
"brandDomainOwnershipReady": {
"type": "boolean"
},
"customDomain": {
"type": [
"object",
"null"
],
"properties": {
"id": {
"type": "integer",
"minimum": 1
},
"domain": {
"type": "string"
},
"fromLocalPart": {
"type": "string"
},
"senderEmail": {
"type": "string"
},
"status": {
"type": "string"
},
"verified": {
"type": "boolean"
},
"elasticStatus": {
"type": "string"
},
"elasticVerified": {
"type": "boolean"
},
"unifiedVerified": {
"type": "boolean"
},
"dnsRecords": {
"type": "array",
"items": {
"type": "object",
"properties": {
"provider": {
"type": "string"
},
"record": {
"type": "string"
},
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"value": {
"type": "string"
},
"ttl": {
"type": [
"string",
"number"
]
},
"priority": {
"type": [
"number",
"null"
]
},
"status": {
"type": "string"
}
},
"additionalProperties": true
}
},
"providerVerification": {
"type": "object",
"properties": {
"resend": {
"type": "object",
"properties": {
"provider": {
"type": "string"
},
"status": {
"type": "string"
},
"verified": {
"type": "boolean"
},
"dnsRecords": {
"type": "array",
"items": {
"type": "object",
"properties": {
"provider": {
"type": "string"
},
"record": {
"type": "string"
},
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"value": {
"type": "string"
},
"ttl": {
"type": [
"string",
"number"
]
},
"priority": {
"type": [
"number",
"null"
]
},
"status": {
"type": "string"
}
},
"additionalProperties": true
}
},
"verifiedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"lastCheckedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"lastError": {
"type": [
"string",
"null"
]
},
"metadata": {
"type": "object",
"properties": {
"sendingEnabled": {
"type": "boolean"
},
"sendingReady": {
"type": "boolean"
},
"trackingReady": {
"type": "boolean"
},
"trackingCertificateReady": {
"type": "boolean"
},
"certificateExpiresAt": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
},
"elastic": {
"type": "object",
"properties": {
"provider": {
"type": "string"
},
"status": {
"type": "string"
},
"verified": {
"type": "boolean"
},
"dnsRecords": {
"type": "array",
"items": {
"type": "object",
"properties": {
"provider": {
"type": "string"
},
"record": {
"type": "string"
},
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"value": {
"type": "string"
},
"ttl": {
"type": [
"string",
"number"
]
},
"priority": {
"type": [
"number",
"null"
]
},
"status": {
"type": "string"
}
},
"additionalProperties": true
}
},
"verifiedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"lastCheckedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"lastError": {
"type": [
"string",
"null"
]
},
"metadata": {
"type": "object",
"properties": {
"sendingEnabled": {
"type": "boolean"
},
"sendingReady": {
"type": "boolean"
},
"trackingReady": {
"type": "boolean"
},
"trackingCertificateReady": {
"type": "boolean"
},
"certificateExpiresAt": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}
},
"additionalProperties": true
},
"providerReadErrors": {
"type": "object",
"properties": {
"resend": {
"type": "string"
},
"elastic": {
"type": "string"
}
},
"additionalProperties": true
},
"verifiedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"lastCheckedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"lastError": {
"type": [
"string",
"null"
]
}
},
"additionalProperties": true
},
"domainStatus": {
"type": [
"string",
"null"
]
},
"marketingDomainStatus": {
"type": [
"string",
"null"
]
},
"senderProfiles": {
"type": "object",
"properties": {
"licensing": {
"type": "object",
"properties": {
"purpose": {
"enum": [
"licensing",
"notifications",
"marketing"
]
},
"label": {
"type": "string"
},
"localPart": {
"type": "string"
},
"fromEmail": {
"type": "string"
},
"editable": {
"type": "boolean"
}
},
"additionalProperties": true
},
"notifications": {
"type": "object",
"properties": {
"purpose": {
"enum": [
"licensing",
"notifications",
"marketing"
]
},
"label": {
"type": "string"
},
"localPart": {
"type": "string"
},
"fromEmail": {
"type": "string"
},
"editable": {
"type": "boolean"
}
},
"additionalProperties": true
},
"marketing": {
"type": "object",
"properties": {
"purpose": {
"enum": [
"licensing",
"notifications",
"marketing"
]
},
"label": {
"type": "string"
},
"localPart": {
"type": "string"
},
"fromEmail": {
"type": "string"
},
"editable": {
"type": "boolean"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
},
"customSendingUsable": {
"type": "boolean"
},
"transactionalSendingUsable": {
"type": "boolean"
},
"marketingSendingUsable": {
"type": "boolean"
},
"marketingTrackingUsable": {
"type": "boolean"
},
"trackClicks": {
"type": "boolean"
},
"trackOpens": {
"type": "boolean"
},
"canDisableUnsafeMarketingTracking": {
"type": "boolean"
},
"unifiedDomainVerified": {
"type": "boolean"
},
"providerReadiness": {
"type": "object",
"properties": {
"configured": {
"type": "boolean"
},
"transactional": {
"type": "boolean"
},
"marketing": {
"type": "boolean"
},
"tracking": {
"type": "boolean"
},
"ready": {
"type": "boolean"
}
},
"additionalProperties": true
},
"blockingReasons": {
"type": "array",
"items": {
"type": "string"
}
},
"transactionalBlockingReasons": {
"type": "array",
"items": {
"type": "string"
}
},
"marketingBlockingReasons": {
"type": "array",
"items": {
"type": "string"
}
},
"trackingBlockingReasons": {
"type": "array",
"items": {
"type": "string"
}
},
"fallbackSender": {
"type": "string"
}
},
"additionalProperties": true
},
"needsPreparation": {
"type": "boolean"
},
"automaticProviderSetup": {
"type": "boolean"
},
"emailProvidersConfigured": {
"type": "boolean"
},
"emailProvidersReady": {
"type": "boolean"
},
"providerPreparation": {
"type": "object",
"properties": {
"ready": {
"type": "boolean"
},
"missingRecords": {
"type": "array",
"items": {
"type": "string"
}
},
"errorMessage": {
"type": "string"
}
},
"additionalProperties": true
},
"readiness": {
"type": "object",
"properties": {
"dns": {
"type": "boolean"
},
"storefront": {
"type": "boolean"
},
"email": {
"type": "boolean"
},
"tracking": {
"type": "boolean"
},
"transactional": {
"type": "boolean"
},
"marketing": {
"type": "boolean"
},
"senders": {
"type": "boolean"
},
"identity": {
"type": "boolean"
},
"providersConfigured": {
"type": "boolean"
},
"ready": {
"type": "boolean"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}Documented failures: 400, 401, 403, 404, 409, 500, 503.
Operation errors: developer_team_permission_denied, developer_team_all_products_scope_required.
POST
/api/developer/brand/domain/skip-step
Skip a genuinely optional DNS step
- Auth
- Account Bearer JWT
- Scope
- domains.view + domains.manage and all-products workspace scope.
- Request fields
- stepKey: string (required)
- Returns
- HTTP 200: domain, providerDetection, currentStep, current_step, wizardProgress, records, featureSummaries, events, allRequiredVerified, providerSupport, branding, storefrontDomain, emailDomains, emailDomainSettings, needsPreparation, automaticProviderSetup, emailProvidersConfigured, emailProvidersReady, providerPreparation, readiness.
- Notes
- step_key aliases stepKey. Required records cannot be skipped; DNS_STEP_REQUIRED is a failure, not a successful connection. domains.view + domains.manage and all-products workspace scope. Selected-product teammates cannot use this workspace-wide domain wizard.
Request, response and error reference
Request (application/json)
{
"type": "object",
"properties": {
"stepKey": {
"type": "string"
}
},
"required": [
"stepKey"
],
"additionalProperties": true
}HTTP 200 response (application/json)
{
"type": "object",
"properties": {
"domain": {
"type": [
"object",
"null"
],
"properties": {
"id": {
"type": "integer",
"minimum": 1
},
"domain": {
"type": "string"
},
"status": {
"type": "string"
},
"verified": {
"type": "boolean"
},
"dnsRecords": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"name": {
"type": "string"
},
"value": {
"type": "string"
}
},
"additionalProperties": true
}
},
"sslStatus": {
"type": "string"
},
"rootDomain": {
"type": "string"
},
"storefrontSubdomain": {
"type": "string"
},
"setupStatus": {
"type": "string"
},
"currentStepKey": {
"type": "string"
}
},
"additionalProperties": true
},
"providerDetection": {
"type": [
"object",
"null"
],
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
},
"currentStep": {
"type": [
"object",
"null"
],
"properties": {
"id": {
"type": [
"integer",
"null"
]
},
"developerDomainId": {
"type": [
"integer",
"null"
]
},
"stepKey": {
"type": "string"
},
"step_key": {
"type": "string"
},
"featureKey": {
"type": "string"
},
"feature_key": {
"type": "string"
},
"title": {
"type": "string"
},
"description": {
"type": "string"
},
"warning": {
"type": "string"
},
"purpose": {
"type": "string"
},
"required": {
"type": "boolean"
},
"status": {
"type": "string"
},
"action": {
"type": "string",
"description": "Non-DNS step: prepare-domains, storefront-provider, email-providers or email-identity. Do not add it as a DNS row."
},
"type": {
"type": "string",
"description": "DNS type returned by the provider, such as A, CNAME, TXT or MX; absent on action steps."
},
"host": {
"type": "string"
},
"name": {
"type": "string"
},
"value": {
"type": "string"
},
"ttl": {
"type": [
"string",
"integer"
]
},
"priority": {
"type": "integer",
"description": "MX priority, entered separately from exchange."
},
"exchange": {
"type": "string"
},
"copyBlocked": {
"type": "boolean",
"description": "Missing provider value cannot be copied. Also respect copyPlan.mode=blocked."
},
"copyPlan": {
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": [
"create",
"replace",
"preserve",
"blocked"
]
},
"value": {
"type": "string"
},
"previousValue": {
"type": "string"
},
"message": {
"type": "string"
}
},
"required": [
"mode"
],
"additionalProperties": true,
"description": "Use value for create/replace, keep existing policy for preserve, and resolve message before copying for blocked."
},
"errorMessage": {
"type": "string"
},
"error_message": {
"type": "string"
},
"lastCheckedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"verifiedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"createdAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"updatedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"additionalProperties": true
},
"current_step": {
"type": [
"object",
"null"
],
"properties": {
"id": {
"type": [
"integer",
"null"
]
},
"developerDomainId": {
"type": [
"integer",
"null"
]
},
"stepKey": {
"type": "string"
},
"step_key": {
"type": "string"
},
"featureKey": {
"type": "string"
},
"feature_key": {
"type": "string"
},
"title": {
"type": "string"
},
"description": {
"type": "string"
},
"warning": {
"type": "string"
},
"purpose": {
"type": "string"
},
"required": {
"type": "boolean"
},
"status": {
"type": "string"
},
"action": {
"type": "string",
"description": "Non-DNS step: prepare-domains, storefront-provider, email-providers or email-identity. Do not add it as a DNS row."
},
"type": {
"type": "string",
"description": "DNS type returned by the provider, such as A, CNAME, TXT or MX; absent on action steps."
},
"host": {
"type": "string"
},
"name": {
"type": "string"
},
"value": {
"type": "string"
},
"ttl": {
"type": [
"string",
"integer"
]
},
"priority": {
"type": "integer",
"description": "MX priority, entered separately from exchange."
},
"exchange": {
"type": "string"
},
"copyBlocked": {
"type": "boolean",
"description": "Missing provider value cannot be copied. Also respect copyPlan.mode=blocked."
},
"copyPlan": {
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": [
"create",
"replace",
"preserve",
"blocked"
]
},
"value": {
"type": "string"
},
"previousValue": {
"type": "string"
},
"message": {
"type": "string"
}
},
"required": [
"mode"
],
"additionalProperties": true,
"description": "Use value for create/replace, keep existing policy for preserve, and resolve message before copying for blocked."
},
"errorMessage": {
"type": "string"
},
"error_message": {
"type": "string"
},
"lastCheckedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"verifiedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"createdAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"updatedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"additionalProperties": true
},
"wizardProgress": {
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string"
},
"label": {
"type": "string"
},
"status": {
"type": "string"
},
"completeCount": {
"type": "integer"
},
"totalCount": {
"type": "integer"
}
},
"additionalProperties": true
}
},
"records": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": [
"integer",
"null"
]
},
"developerDomainId": {
"type": [
"integer",
"null"
]
},
"stepKey": {
"type": "string"
},
"step_key": {
"type": "string"
},
"featureKey": {
"type": "string"
},
"feature_key": {
"type": "string"
},
"title": {
"type": "string"
},
"description": {
"type": "string"
},
"warning": {
"type": "string"
},
"purpose": {
"type": "string"
},
"required": {
"type": "boolean"
},
"status": {
"type": "string"
},
"action": {
"type": "string",
"description": "Non-DNS step: prepare-domains, storefront-provider, email-providers or email-identity. Do not add it as a DNS row."
},
"type": {
"type": "string",
"description": "DNS type returned by the provider, such as A, CNAME, TXT or MX; absent on action steps."
},
"host": {
"type": "string"
},
"name": {
"type": "string"
},
"value": {
"type": "string"
},
"ttl": {
"type": [
"string",
"integer"
]
},
"priority": {
"type": "integer",
"description": "MX priority, entered separately from exchange."
},
"exchange": {
"type": "string"
},
"copyBlocked": {
"type": "boolean",
"description": "Missing provider value cannot be copied. Also respect copyPlan.mode=blocked."
},
"copyPlan": {
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": [
"create",
"replace",
"preserve",
"blocked"
]
},
"value": {
"type": "string"
},
"previousValue": {
"type": "string"
},
"message": {
"type": "string"
}
},
"required": [
"mode"
],
"additionalProperties": true,
"description": "Use value for create/replace, keep existing policy for preserve, and resolve message before copying for blocked."
},
"errorMessage": {
"type": "string"
},
"error_message": {
"type": "string"
},
"lastCheckedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"verifiedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"createdAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"updatedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"additionalProperties": true
}
},
"featureSummaries": {
"type": "array",
"items": {
"type": "object",
"properties": {
"featureKey": {
"type": "string"
},
"feature_key": {
"type": "string"
},
"label": {
"type": "string"
},
"status": {
"type": "string"
},
"completeCount": {
"type": "integer"
},
"requiredCount": {
"type": "integer"
},
"totalCount": {
"type": "integer"
},
"records": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": [
"integer",
"null"
]
},
"developerDomainId": {
"type": [
"integer",
"null"
]
},
"stepKey": {
"type": "string"
},
"step_key": {
"type": "string"
},
"featureKey": {
"type": "string"
},
"feature_key": {
"type": "string"
},
"title": {
"type": "string"
},
"description": {
"type": "string"
},
"warning": {
"type": "string"
},
"purpose": {
"type": "string"
},
"required": {
"type": "boolean"
},
"status": {
"type": "string"
},
"action": {
"type": "string",
"description": "Non-DNS step: prepare-domains, storefront-provider, email-providers or email-identity. Do not add it as a DNS row."
},
"type": {
"type": "string",
"description": "DNS type returned by the provider, such as A, CNAME, TXT or MX; absent on action steps."
},
"host": {
"type": "string"
},
"name": {
"type": "string"
},
"value": {
"type": "string"
},
"ttl": {
"type": [
"string",
"integer"
]
},
"priority": {
"type": "integer",
"description": "MX priority, entered separately from exchange."
},
"exchange": {
"type": "string"
},
"copyBlocked": {
"type": "boolean",
"description": "Missing provider value cannot be copied. Also respect copyPlan.mode=blocked."
},
"copyPlan": {
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": [
"create",
"replace",
"preserve",
"blocked"
]
},
"value": {
"type": "string"
},
"previousValue": {
"type": "string"
},
"message": {
"type": "string"
}
},
"required": [
"mode"
],
"additionalProperties": true,
"description": "Use value for create/replace, keep existing policy for preserve, and resolve message before copying for blocked."
},
"errorMessage": {
"type": "string"
},
"error_message": {
"type": "string"
},
"lastCheckedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"verifiedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"createdAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"updatedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"additionalProperties": true
}
}
},
"additionalProperties": true
}
},
"events": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
},
"status": {
"type": "string"
},
"created_at": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"updated_at": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"additionalProperties": true
}
},
"allRequiredVerified": {
"type": "boolean"
},
"providerSupport": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
},
"branding": {
"type": "object",
"properties": {
"storeName": {
"type": "string"
},
"developerDisplayName": {
"type": "string"
},
"tagline": {
"type": "string"
},
"slug": {
"type": "string"
},
"shortDescription": {
"type": "string"
},
"marketplaceBio": {
"type": "string"
},
"logos": {
"type": "object",
"properties": {
"logoUrl": {
"type": "string"
},
"lightLogoUrl": {
"type": "string"
},
"darkLogoUrl": {
"type": "string"
},
"iconUrl": {
"type": "string"
},
"defaultProductImageUrl": {
"type": "string"
}
},
"additionalProperties": true
},
"colors": {
"type": "object",
"properties": {
"appearance": {
"type": "string",
"enum": [
"light",
"dark",
"system"
]
},
"backgroundColor": {
"type": "string"
},
"brandHighlightColor": {
"type": "string"
},
"accentColor": {
"type": "string"
},
"advancedOverrides": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
},
"additionalProperties": true
},
"support": {
"type": "object",
"properties": {
"supportEmail": {
"type": "string"
},
"supportUrl": {
"type": "string"
},
"documentationUrl": {
"type": "string"
},
"faqUrl": {
"type": "string"
},
"refundPolicyUrl": {
"type": "string"
},
"termsUrl": {
"type": "string"
},
"licenseUrl": {
"type": "string"
}
},
"additionalProperties": true
},
"emailIdentity": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
},
"socialLinks": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
},
"domains": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
},
"metadata": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
},
"additionalProperties": true
},
"storefrontDomain": {
"type": "string"
},
"emailDomains": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
},
"domain": {
"type": "string"
},
"fromLocalPart": {
"type": "string"
},
"senderEmail": {
"type": "string"
},
"status": {
"type": "string"
},
"verified": {
"type": "boolean"
},
"elasticStatus": {
"type": "string"
},
"elasticVerified": {
"type": "boolean"
},
"unifiedVerified": {
"type": "boolean"
},
"dnsRecords": {
"type": "array",
"items": {
"type": "object",
"properties": {
"provider": {
"type": "string"
},
"record": {
"type": "string"
},
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"value": {
"type": "string"
},
"ttl": {
"type": [
"string",
"number"
]
},
"priority": {
"type": [
"number",
"null"
]
},
"status": {
"type": "string"
}
},
"additionalProperties": true
}
},
"providerVerification": {
"type": "object",
"properties": {
"resend": {
"type": "object",
"properties": {
"provider": {
"type": "string"
},
"status": {
"type": "string"
},
"verified": {
"type": "boolean"
},
"dnsRecords": {
"type": "array",
"items": {
"type": "object",
"properties": {
"provider": {
"type": "string"
},
"record": {
"type": "string"
},
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"value": {
"type": "string"
},
"ttl": {
"type": [
"string",
"number"
]
},
"priority": {
"type": [
"number",
"null"
]
},
"status": {
"type": "string"
}
},
"additionalProperties": true
}
},
"verifiedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"lastCheckedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"lastError": {
"type": [
"string",
"null"
]
},
"metadata": {
"type": "object",
"properties": {
"sendingEnabled": {
"type": "boolean"
},
"sendingReady": {
"type": "boolean"
},
"trackingReady": {
"type": "boolean"
},
"trackingCertificateReady": {
"type": "boolean"
},
"certificateExpiresAt": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
},
"elastic": {
"type": "object",
"properties": {
"provider": {
"type": "string"
},
"status": {
"type": "string"
},
"verified": {
"type": "boolean"
},
"dnsRecords": {
"type": "array",
"items": {
"type": "object",
"properties": {
"provider": {
"type": "string"
},
"record": {
"type": "string"
},
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"value": {
"type": "string"
},
"ttl": {
"type": [
"string",
"number"
]
},
"priority": {
"type": [
"number",
"null"
]
},
"status": {
"type": "string"
}
},
"additionalProperties": true
}
},
"verifiedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"lastCheckedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"lastError": {
"type": [
"string",
"null"
]
},
"metadata": {
"type": "object",
"properties": {
"sendingEnabled": {
"type": "boolean"
},
"sendingReady": {
"type": "boolean"
},
"trackingReady": {
"type": "boolean"
},
"trackingCertificateReady": {
"type": "boolean"
},
"certificateExpiresAt": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}
},
"additionalProperties": true
},
"providerReadErrors": {
"type": "object",
"properties": {
"resend": {
"type": "string"
},
"elastic": {
"type": "string"
}
},
"additionalProperties": true
},
"verifiedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"lastCheckedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"lastError": {
"type": [
"string",
"null"
]
}
},
"additionalProperties": true
}
},
"emailDomainSettings": {
"type": "object",
"properties": {
"supportEmail": {
"type": "string"
},
"supportEmailPresent": {
"type": "boolean"
},
"brandDomainOwnershipReady": {
"type": "boolean"
},
"customDomain": {
"type": [
"object",
"null"
],
"properties": {
"id": {
"type": "integer",
"minimum": 1
},
"domain": {
"type": "string"
},
"fromLocalPart": {
"type": "string"
},
"senderEmail": {
"type": "string"
},
"status": {
"type": "string"
},
"verified": {
"type": "boolean"
},
"elasticStatus": {
"type": "string"
},
"elasticVerified": {
"type": "boolean"
},
"unifiedVerified": {
"type": "boolean"
},
"dnsRecords": {
"type": "array",
"items": {
"type": "object",
"properties": {
"provider": {
"type": "string"
},
"record": {
"type": "string"
},
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"value": {
"type": "string"
},
"ttl": {
"type": [
"string",
"number"
]
},
"priority": {
"type": [
"number",
"null"
]
},
"status": {
"type": "string"
}
},
"additionalProperties": true
}
},
"providerVerification": {
"type": "object",
"properties": {
"resend": {
"type": "object",
"properties": {
"provider": {
"type": "string"
},
"status": {
"type": "string"
},
"verified": {
"type": "boolean"
},
"dnsRecords": {
"type": "array",
"items": {
"type": "object",
"properties": {
"provider": {
"type": "string"
},
"record": {
"type": "string"
},
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"value": {
"type": "string"
},
"ttl": {
"type": [
"string",
"number"
]
},
"priority": {
"type": [
"number",
"null"
]
},
"status": {
"type": "string"
}
},
"additionalProperties": true
}
},
"verifiedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"lastCheckedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"lastError": {
"type": [
"string",
"null"
]
},
"metadata": {
"type": "object",
"properties": {
"sendingEnabled": {
"type": "boolean"
},
"sendingReady": {
"type": "boolean"
},
"trackingReady": {
"type": "boolean"
},
"trackingCertificateReady": {
"type": "boolean"
},
"certificateExpiresAt": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
},
"elastic": {
"type": "object",
"properties": {
"provider": {
"type": "string"
},
"status": {
"type": "string"
},
"verified": {
"type": "boolean"
},
"dnsRecords": {
"type": "array",
"items": {
"type": "object",
"properties": {
"provider": {
"type": "string"
},
"record": {
"type": "string"
},
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"value": {
"type": "string"
},
"ttl": {
"type": [
"string",
"number"
]
},
"priority": {
"type": [
"number",
"null"
]
},
"status": {
"type": "string"
}
},
"additionalProperties": true
}
},
"verifiedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"lastCheckedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"lastError": {
"type": [
"string",
"null"
]
},
"metadata": {
"type": "object",
"properties": {
"sendingEnabled": {
"type": "boolean"
},
"sendingReady": {
"type": "boolean"
},
"trackingReady": {
"type": "boolean"
},
"trackingCertificateReady": {
"type": "boolean"
},
"certificateExpiresAt": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}
},
"additionalProperties": true
},
"providerReadErrors": {
"type": "object",
"properties": {
"resend": {
"type": "string"
},
"elastic": {
"type": "string"
}
},
"additionalProperties": true
},
"verifiedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"lastCheckedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"lastError": {
"type": [
"string",
"null"
]
}
},
"additionalProperties": true
},
"domainStatus": {
"type": [
"string",
"null"
]
},
"marketingDomainStatus": {
"type": [
"string",
"null"
]
},
"senderProfiles": {
"type": "object",
"properties": {
"licensing": {
"type": "object",
"properties": {
"purpose": {
"enum": [
"licensing",
"notifications",
"marketing"
]
},
"label": {
"type": "string"
},
"localPart": {
"type": "string"
},
"fromEmail": {
"type": "string"
},
"editable": {
"type": "boolean"
}
},
"additionalProperties": true
},
"notifications": {
"type": "object",
"properties": {
"purpose": {
"enum": [
"licensing",
"notifications",
"marketing"
]
},
"label": {
"type": "string"
},
"localPart": {
"type": "string"
},
"fromEmail": {
"type": "string"
},
"editable": {
"type": "boolean"
}
},
"additionalProperties": true
},
"marketing": {
"type": "object",
"properties": {
"purpose": {
"enum": [
"licensing",
"notifications",
"marketing"
]
},
"label": {
"type": "string"
},
"localPart": {
"type": "string"
},
"fromEmail": {
"type": "string"
},
"editable": {
"type": "boolean"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
},
"customSendingUsable": {
"type": "boolean"
},
"transactionalSendingUsable": {
"type": "boolean"
},
"marketingSendingUsable": {
"type": "boolean"
},
"marketingTrackingUsable": {
"type": "boolean"
},
"trackClicks": {
"type": "boolean"
},
"trackOpens": {
"type": "boolean"
},
"canDisableUnsafeMarketingTracking": {
"type": "boolean"
},
"unifiedDomainVerified": {
"type": "boolean"
},
"providerReadiness": {
"type": "object",
"properties": {
"configured": {
"type": "boolean"
},
"transactional": {
"type": "boolean"
},
"marketing": {
"type": "boolean"
},
"tracking": {
"type": "boolean"
},
"ready": {
"type": "boolean"
}
},
"additionalProperties": true
},
"blockingReasons": {
"type": "array",
"items": {
"type": "string"
}
},
"transactionalBlockingReasons": {
"type": "array",
"items": {
"type": "string"
}
},
"marketingBlockingReasons": {
"type": "array",
"items": {
"type": "string"
}
},
"trackingBlockingReasons": {
"type": "array",
"items": {
"type": "string"
}
},
"fallbackSender": {
"type": "string"
}
},
"additionalProperties": true
},
"needsPreparation": {
"type": "boolean"
},
"automaticProviderSetup": {
"type": "boolean"
},
"emailProvidersConfigured": {
"type": "boolean"
},
"emailProvidersReady": {
"type": "boolean"
},
"providerPreparation": {
"type": "object",
"properties": {
"ready": {
"type": "boolean"
},
"missingRecords": {
"type": "array",
"items": {
"type": "string"
}
},
"errorMessage": {
"type": "string"
}
},
"additionalProperties": true
},
"readiness": {
"type": "object",
"properties": {
"dns": {
"type": "boolean"
},
"storefront": {
"type": "boolean"
},
"email": {
"type": "boolean"
},
"tracking": {
"type": "boolean"
},
"transactional": {
"type": "boolean"
},
"marketing": {
"type": "boolean"
},
"senders": {
"type": "boolean"
},
"identity": {
"type": "boolean"
},
"providersConfigured": {
"type": "boolean"
},
"ready": {
"type": "boolean"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}Documented failures: 400, 401, 403, 404, 409, 500, 503.
Operation errors: developer_team_permission_denied, developer_team_all_products_scope_required.
GET
/api/developer/brand/domain/events
Read the domain setup event history
- Auth
- Account Bearer JWT
- Scope
- domains.view and all-products workspace scope.
- Returns
- HTTP 200: events.
- Notes
- domains.view and all-products workspace scope. Selected-product teammates cannot use this workspace-wide domain wizard.
Request, response and error reference
No request body fields are read by this operation.
HTTP 200 response (application/json)
{
"type": "object",
"properties": {
"events": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": [
"integer",
"string"
],
"minLength": 1
},
"event_type": {
"type": "string"
},
"message": {
"type": "string"
},
"created_at": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"metadata": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
},
"additionalProperties": true
}
}
},
"additionalProperties": true
}Documented failures: 400, 401, 403, 404, 409, 500, 503.
Operation errors: developer_team_permission_denied, developer_team_all_products_scope_required.
POST
/api/developer/brand/domain/reset
Reset the domain setup progress
- Auth
- Account Bearer JWT
- Scope
- domains.view + domains.manage and all-products workspace scope.
- Returns
- HTTP 200: domain, providerDetection, currentStep, current_step, wizardProgress, records, featureSummaries, events, allRequiredVerified, providerSupport, branding, storefrontDomain, emailDomains, emailDomainSettings, needsPreparation, automaticProviderSetup, emailProvidersConfigured, emailProvidersReady, providerPreparation, readiness.
- Notes
- Resets setup_status/current_step_key. It does not delete DNS records at the provider or guarantee removal of an existing domain or SSL certificate. domains.view + domains.manage and all-products workspace scope. Selected-product teammates cannot use this workspace-wide domain wizard.
Request, response and error reference
No request body fields are read by this operation.
HTTP 200 response (application/json)
{
"type": "object",
"properties": {
"domain": {
"type": [
"object",
"null"
],
"properties": {
"id": {
"type": "integer",
"minimum": 1
},
"domain": {
"type": "string"
},
"status": {
"type": "string"
},
"verified": {
"type": "boolean"
},
"dnsRecords": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"name": {
"type": "string"
},
"value": {
"type": "string"
}
},
"additionalProperties": true
}
},
"sslStatus": {
"type": "string"
},
"rootDomain": {
"type": "string"
},
"storefrontSubdomain": {
"type": "string"
},
"setupStatus": {
"type": "string"
},
"currentStepKey": {
"type": "string"
}
},
"additionalProperties": true
},
"providerDetection": {
"type": [
"object",
"null"
],
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
},
"currentStep": {
"type": [
"object",
"null"
],
"properties": {
"id": {
"type": [
"integer",
"null"
]
},
"developerDomainId": {
"type": [
"integer",
"null"
]
},
"stepKey": {
"type": "string"
},
"step_key": {
"type": "string"
},
"featureKey": {
"type": "string"
},
"feature_key": {
"type": "string"
},
"title": {
"type": "string"
},
"description": {
"type": "string"
},
"warning": {
"type": "string"
},
"purpose": {
"type": "string"
},
"required": {
"type": "boolean"
},
"status": {
"type": "string"
},
"action": {
"type": "string",
"description": "Non-DNS step: prepare-domains, storefront-provider, email-providers or email-identity. Do not add it as a DNS row."
},
"type": {
"type": "string",
"description": "DNS type returned by the provider, such as A, CNAME, TXT or MX; absent on action steps."
},
"host": {
"type": "string"
},
"name": {
"type": "string"
},
"value": {
"type": "string"
},
"ttl": {
"type": [
"string",
"integer"
]
},
"priority": {
"type": "integer",
"description": "MX priority, entered separately from exchange."
},
"exchange": {
"type": "string"
},
"copyBlocked": {
"type": "boolean",
"description": "Missing provider value cannot be copied. Also respect copyPlan.mode=blocked."
},
"copyPlan": {
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": [
"create",
"replace",
"preserve",
"blocked"
]
},
"value": {
"type": "string"
},
"previousValue": {
"type": "string"
},
"message": {
"type": "string"
}
},
"required": [
"mode"
],
"additionalProperties": true,
"description": "Use value for create/replace, keep existing policy for preserve, and resolve message before copying for blocked."
},
"errorMessage": {
"type": "string"
},
"error_message": {
"type": "string"
},
"lastCheckedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"verifiedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"createdAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"updatedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"additionalProperties": true
},
"current_step": {
"type": [
"object",
"null"
],
"properties": {
"id": {
"type": [
"integer",
"null"
]
},
"developerDomainId": {
"type": [
"integer",
"null"
]
},
"stepKey": {
"type": "string"
},
"step_key": {
"type": "string"
},
"featureKey": {
"type": "string"
},
"feature_key": {
"type": "string"
},
"title": {
"type": "string"
},
"description": {
"type": "string"
},
"warning": {
"type": "string"
},
"purpose": {
"type": "string"
},
"required": {
"type": "boolean"
},
"status": {
"type": "string"
},
"action": {
"type": "string",
"description": "Non-DNS step: prepare-domains, storefront-provider, email-providers or email-identity. Do not add it as a DNS row."
},
"type": {
"type": "string",
"description": "DNS type returned by the provider, such as A, CNAME, TXT or MX; absent on action steps."
},
"host": {
"type": "string"
},
"name": {
"type": "string"
},
"value": {
"type": "string"
},
"ttl": {
"type": [
"string",
"integer"
]
},
"priority": {
"type": "integer",
"description": "MX priority, entered separately from exchange."
},
"exchange": {
"type": "string"
},
"copyBlocked": {
"type": "boolean",
"description": "Missing provider value cannot be copied. Also respect copyPlan.mode=blocked."
},
"copyPlan": {
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": [
"create",
"replace",
"preserve",
"blocked"
]
},
"value": {
"type": "string"
},
"previousValue": {
"type": "string"
},
"message": {
"type": "string"
}
},
"required": [
"mode"
],
"additionalProperties": true,
"description": "Use value for create/replace, keep existing policy for preserve, and resolve message before copying for blocked."
},
"errorMessage": {
"type": "string"
},
"error_message": {
"type": "string"
},
"lastCheckedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"verifiedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"createdAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"updatedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"additionalProperties": true
},
"wizardProgress": {
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string"
},
"label": {
"type": "string"
},
"status": {
"type": "string"
},
"completeCount": {
"type": "integer"
},
"totalCount": {
"type": "integer"
}
},
"additionalProperties": true
}
},
"records": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": [
"integer",
"null"
]
},
"developerDomainId": {
"type": [
"integer",
"null"
]
},
"stepKey": {
"type": "string"
},
"step_key": {
"type": "string"
},
"featureKey": {
"type": "string"
},
"feature_key": {
"type": "string"
},
"title": {
"type": "string"
},
"description": {
"type": "string"
},
"warning": {
"type": "string"
},
"purpose": {
"type": "string"
},
"required": {
"type": "boolean"
},
"status": {
"type": "string"
},
"action": {
"type": "string",
"description": "Non-DNS step: prepare-domains, storefront-provider, email-providers or email-identity. Do not add it as a DNS row."
},
"type": {
"type": "string",
"description": "DNS type returned by the provider, such as A, CNAME, TXT or MX; absent on action steps."
},
"host": {
"type": "string"
},
"name": {
"type": "string"
},
"value": {
"type": "string"
},
"ttl": {
"type": [
"string",
"integer"
]
},
"priority": {
"type": "integer",
"description": "MX priority, entered separately from exchange."
},
"exchange": {
"type": "string"
},
"copyBlocked": {
"type": "boolean",
"description": "Missing provider value cannot be copied. Also respect copyPlan.mode=blocked."
},
"copyPlan": {
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": [
"create",
"replace",
"preserve",
"blocked"
]
},
"value": {
"type": "string"
},
"previousValue": {
"type": "string"
},
"message": {
"type": "string"
}
},
"required": [
"mode"
],
"additionalProperties": true,
"description": "Use value for create/replace, keep existing policy for preserve, and resolve message before copying for blocked."
},
"errorMessage": {
"type": "string"
},
"error_message": {
"type": "string"
},
"lastCheckedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"verifiedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"createdAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"updatedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"additionalProperties": true
}
},
"featureSummaries": {
"type": "array",
"items": {
"type": "object",
"properties": {
"featureKey": {
"type": "string"
},
"feature_key": {
"type": "string"
},
"label": {
"type": "string"
},
"status": {
"type": "string"
},
"completeCount": {
"type": "integer"
},
"requiredCount": {
"type": "integer"
},
"totalCount": {
"type": "integer"
},
"records": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": [
"integer",
"null"
]
},
"developerDomainId": {
"type": [
"integer",
"null"
]
},
"stepKey": {
"type": "string"
},
"step_key": {
"type": "string"
},
"featureKey": {
"type": "string"
},
"feature_key": {
"type": "string"
},
"title": {
"type": "string"
},
"description": {
"type": "string"
},
"warning": {
"type": "string"
},
"purpose": {
"type": "string"
},
"required": {
"type": "boolean"
},
"status": {
"type": "string"
},
"action": {
"type": "string",
"description": "Non-DNS step: prepare-domains, storefront-provider, email-providers or email-identity. Do not add it as a DNS row."
},
"type": {
"type": "string",
"description": "DNS type returned by the provider, such as A, CNAME, TXT or MX; absent on action steps."
},
"host": {
"type": "string"
},
"name": {
"type": "string"
},
"value": {
"type": "string"
},
"ttl": {
"type": [
"string",
"integer"
]
},
"priority": {
"type": "integer",
"description": "MX priority, entered separately from exchange."
},
"exchange": {
"type": "string"
},
"copyBlocked": {
"type": "boolean",
"description": "Missing provider value cannot be copied. Also respect copyPlan.mode=blocked."
},
"copyPlan": {
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": [
"create",
"replace",
"preserve",
"blocked"
]
},
"value": {
"type": "string"
},
"previousValue": {
"type": "string"
},
"message": {
"type": "string"
}
},
"required": [
"mode"
],
"additionalProperties": true,
"description": "Use value for create/replace, keep existing policy for preserve, and resolve message before copying for blocked."
},
"errorMessage": {
"type": "string"
},
"error_message": {
"type": "string"
},
"lastCheckedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"verifiedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"createdAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"updatedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"additionalProperties": true
}
}
},
"additionalProperties": true
}
},
"events": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
},
"status": {
"type": "string"
},
"created_at": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"updated_at": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"additionalProperties": true
}
},
"allRequiredVerified": {
"type": "boolean"
},
"providerSupport": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
},
"branding": {
"type": "object",
"properties": {
"storeName": {
"type": "string"
},
"developerDisplayName": {
"type": "string"
},
"tagline": {
"type": "string"
},
"slug": {
"type": "string"
},
"shortDescription": {
"type": "string"
},
"marketplaceBio": {
"type": "string"
},
"logos": {
"type": "object",
"properties": {
"logoUrl": {
"type": "string"
},
"lightLogoUrl": {
"type": "string"
},
"darkLogoUrl": {
"type": "string"
},
"iconUrl": {
"type": "string"
},
"defaultProductImageUrl": {
"type": "string"
}
},
"additionalProperties": true
},
"colors": {
"type": "object",
"properties": {
"appearance": {
"type": "string",
"enum": [
"light",
"dark",
"system"
]
},
"backgroundColor": {
"type": "string"
},
"brandHighlightColor": {
"type": "string"
},
"accentColor": {
"type": "string"
},
"advancedOverrides": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
},
"additionalProperties": true
},
"support": {
"type": "object",
"properties": {
"supportEmail": {
"type": "string"
},
"supportUrl": {
"type": "string"
},
"documentationUrl": {
"type": "string"
},
"faqUrl": {
"type": "string"
},
"refundPolicyUrl": {
"type": "string"
},
"termsUrl": {
"type": "string"
},
"licenseUrl": {
"type": "string"
}
},
"additionalProperties": true
},
"emailIdentity": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
},
"socialLinks": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
},
"domains": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
},
"metadata": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
},
"additionalProperties": true
},
"storefrontDomain": {
"type": "string"
},
"emailDomains": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
},
"domain": {
"type": "string"
},
"fromLocalPart": {
"type": "string"
},
"senderEmail": {
"type": "string"
},
"status": {
"type": "string"
},
"verified": {
"type": "boolean"
},
"elasticStatus": {
"type": "string"
},
"elasticVerified": {
"type": "boolean"
},
"unifiedVerified": {
"type": "boolean"
},
"dnsRecords": {
"type": "array",
"items": {
"type": "object",
"properties": {
"provider": {
"type": "string"
},
"record": {
"type": "string"
},
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"value": {
"type": "string"
},
"ttl": {
"type": [
"string",
"number"
]
},
"priority": {
"type": [
"number",
"null"
]
},
"status": {
"type": "string"
}
},
"additionalProperties": true
}
},
"providerVerification": {
"type": "object",
"properties": {
"resend": {
"type": "object",
"properties": {
"provider": {
"type": "string"
},
"status": {
"type": "string"
},
"verified": {
"type": "boolean"
},
"dnsRecords": {
"type": "array",
"items": {
"type": "object",
"properties": {
"provider": {
"type": "string"
},
"record": {
"type": "string"
},
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"value": {
"type": "string"
},
"ttl": {
"type": [
"string",
"number"
]
},
"priority": {
"type": [
"number",
"null"
]
},
"status": {
"type": "string"
}
},
"additionalProperties": true
}
},
"verifiedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"lastCheckedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"lastError": {
"type": [
"string",
"null"
]
},
"metadata": {
"type": "object",
"properties": {
"sendingEnabled": {
"type": "boolean"
},
"sendingReady": {
"type": "boolean"
},
"trackingReady": {
"type": "boolean"
},
"trackingCertificateReady": {
"type": "boolean"
},
"certificateExpiresAt": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
},
"elastic": {
"type": "object",
"properties": {
"provider": {
"type": "string"
},
"status": {
"type": "string"
},
"verified": {
"type": "boolean"
},
"dnsRecords": {
"type": "array",
"items": {
"type": "object",
"properties": {
"provider": {
"type": "string"
},
"record": {
"type": "string"
},
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"value": {
"type": "string"
},
"ttl": {
"type": [
"string",
"number"
]
},
"priority": {
"type": [
"number",
"null"
]
},
"status": {
"type": "string"
}
},
"additionalProperties": true
}
},
"verifiedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"lastCheckedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"lastError": {
"type": [
"string",
"null"
]
},
"metadata": {
"type": "object",
"properties": {
"sendingEnabled": {
"type": "boolean"
},
"sendingReady": {
"type": "boolean"
},
"trackingReady": {
"type": "boolean"
},
"trackingCertificateReady": {
"type": "boolean"
},
"certificateExpiresAt": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}
},
"additionalProperties": true
},
"providerReadErrors": {
"type": "object",
"properties": {
"resend": {
"type": "string"
},
"elastic": {
"type": "string"
}
},
"additionalProperties": true
},
"verifiedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"lastCheckedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"lastError": {
"type": [
"string",
"null"
]
}
},
"additionalProperties": true
}
},
"emailDomainSettings": {
"type": "object",
"properties": {
"supportEmail": {
"type": "string"
},
"supportEmailPresent": {
"type": "boolean"
},
"brandDomainOwnershipReady": {
"type": "boolean"
},
"customDomain": {
"type": [
"object",
"null"
],
"properties": {
"id": {
"type": "integer",
"minimum": 1
},
"domain": {
"type": "string"
},
"fromLocalPart": {
"type": "string"
},
"senderEmail": {
"type": "string"
},
"status": {
"type": "string"
},
"verified": {
"type": "boolean"
},
"elasticStatus": {
"type": "string"
},
"elasticVerified": {
"type": "boolean"
},
"unifiedVerified": {
"type": "boolean"
},
"dnsRecords": {
"type": "array",
"items": {
"type": "object",
"properties": {
"provider": {
"type": "string"
},
"record": {
"type": "string"
},
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"value": {
"type": "string"
},
"ttl": {
"type": [
"string",
"number"
]
},
"priority": {
"type": [
"number",
"null"
]
},
"status": {
"type": "string"
}
},
"additionalProperties": true
}
},
"providerVerification": {
"type": "object",
"properties": {
"resend": {
"type": "object",
"properties": {
"provider": {
"type": "string"
},
"status": {
"type": "string"
},
"verified": {
"type": "boolean"
},
"dnsRecords": {
"type": "array",
"items": {
"type": "object",
"properties": {
"provider": {
"type": "string"
},
"record": {
"type": "string"
},
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"value": {
"type": "string"
},
"ttl": {
"type": [
"string",
"number"
]
},
"priority": {
"type": [
"number",
"null"
]
},
"status": {
"type": "string"
}
},
"additionalProperties": true
}
},
"verifiedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"lastCheckedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"lastError": {
"type": [
"string",
"null"
]
},
"metadata": {
"type": "object",
"properties": {
"sendingEnabled": {
"type": "boolean"
},
"sendingReady": {
"type": "boolean"
},
"trackingReady": {
"type": "boolean"
},
"trackingCertificateReady": {
"type": "boolean"
},
"certificateExpiresAt": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
},
"elastic": {
"type": "object",
"properties": {
"provider": {
"type": "string"
},
"status": {
"type": "string"
},
"verified": {
"type": "boolean"
},
"dnsRecords": {
"type": "array",
"items": {
"type": "object",
"properties": {
"provider": {
"type": "string"
},
"record": {
"type": "string"
},
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"value": {
"type": "string"
},
"ttl": {
"type": [
"string",
"number"
]
},
"priority": {
"type": [
"number",
"null"
]
},
"status": {
"type": "string"
}
},
"additionalProperties": true
}
},
"verifiedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"lastCheckedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"lastError": {
"type": [
"string",
"null"
]
},
"metadata": {
"type": "object",
"properties": {
"sendingEnabled": {
"type": "boolean"
},
"sendingReady": {
"type": "boolean"
},
"trackingReady": {
"type": "boolean"
},
"trackingCertificateReady": {
"type": "boolean"
},
"certificateExpiresAt": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}
},
"additionalProperties": true
},
"providerReadErrors": {
"type": "object",
"properties": {
"resend": {
"type": "string"
},
"elastic": {
"type": "string"
}
},
"additionalProperties": true
},
"verifiedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"lastCheckedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"lastError": {
"type": [
"string",
"null"
]
}
},
"additionalProperties": true
},
"domainStatus": {
"type": [
"string",
"null"
]
},
"marketingDomainStatus": {
"type": [
"string",
"null"
]
},
"senderProfiles": {
"type": "object",
"properties": {
"licensing": {
"type": "object",
"properties": {
"purpose": {
"enum": [
"licensing",
"notifications",
"marketing"
]
},
"label": {
"type": "string"
},
"localPart": {
"type": "string"
},
"fromEmail": {
"type": "string"
},
"editable": {
"type": "boolean"
}
},
"additionalProperties": true
},
"notifications": {
"type": "object",
"properties": {
"purpose": {
"enum": [
"licensing",
"notifications",
"marketing"
]
},
"label": {
"type": "string"
},
"localPart": {
"type": "string"
},
"fromEmail": {
"type": "string"
},
"editable": {
"type": "boolean"
}
},
"additionalProperties": true
},
"marketing": {
"type": "object",
"properties": {
"purpose": {
"enum": [
"licensing",
"notifications",
"marketing"
]
},
"label": {
"type": "string"
},
"localPart": {
"type": "string"
},
"fromEmail": {
"type": "string"
},
"editable": {
"type": "boolean"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
},
"customSendingUsable": {
"type": "boolean"
},
"transactionalSendingUsable": {
"type": "boolean"
},
"marketingSendingUsable": {
"type": "boolean"
},
"marketingTrackingUsable": {
"type": "boolean"
},
"trackClicks": {
"type": "boolean"
},
"trackOpens": {
"type": "boolean"
},
"canDisableUnsafeMarketingTracking": {
"type": "boolean"
},
"unifiedDomainVerified": {
"type": "boolean"
},
"providerReadiness": {
"type": "object",
"properties": {
"configured": {
"type": "boolean"
},
"transactional": {
"type": "boolean"
},
"marketing": {
"type": "boolean"
},
"tracking": {
"type": "boolean"
},
"ready": {
"type": "boolean"
}
},
"additionalProperties": true
},
"blockingReasons": {
"type": "array",
"items": {
"type": "string"
}
},
"transactionalBlockingReasons": {
"type": "array",
"items": {
"type": "string"
}
},
"marketingBlockingReasons": {
"type": "array",
"items": {
"type": "string"
}
},
"trackingBlockingReasons": {
"type": "array",
"items": {
"type": "string"
}
},
"fallbackSender": {
"type": "string"
}
},
"additionalProperties": true
},
"needsPreparation": {
"type": "boolean"
},
"automaticProviderSetup": {
"type": "boolean"
},
"emailProvidersConfigured": {
"type": "boolean"
},
"emailProvidersReady": {
"type": "boolean"
},
"providerPreparation": {
"type": "object",
"properties": {
"ready": {
"type": "boolean"
},
"missingRecords": {
"type": "array",
"items": {
"type": "string"
}
},
"errorMessage": {
"type": "string"
}
},
"additionalProperties": true
},
"readiness": {
"type": "object",
"properties": {
"dns": {
"type": "boolean"
},
"storefront": {
"type": "boolean"
},
"email": {
"type": "boolean"
},
"tracking": {
"type": "boolean"
},
"transactional": {
"type": "boolean"
},
"marketing": {
"type": "boolean"
},
"senders": {
"type": "boolean"
},
"identity": {
"type": "boolean"
},
"providersConfigured": {
"type": "boolean"
},
"ready": {
"type": "boolean"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}Documented failures: 400, 401, 403, 404, 409, 500, 503.
Operation errors: developer_team_permission_denied, developer_team_all_products_scope_required.
GET
/api/developer/storefront-domain
Read website routing and SSL readiness
- Auth
- Account Bearer JWT
- Scope
- domains.view and all-products scope.
- Returns
- HTTP 200: domain, settings.
- Notes
- A legacy verified record with no saved check can trigger provider verification and persist a fresh complete result. This GET is not guaranteed zero-write. Inspect DNS, SSL and routing checks independently, not only the top-level saved status.
Request, response and error reference
No request body fields are read by this operation.
HTTP 200 response (application/json)
{
"type": "object",
"properties": {
"domain": {
"type": [
"object",
"null"
],
"properties": {
"id": {
"type": "integer",
"minimum": 1
},
"developerUserId": {
"type": "integer",
"minimum": 1
},
"domain": {
"type": "string"
},
"status": {
"type": "string"
},
"verified": {
"type": "boolean"
},
"dnsStatus": {
"type": "string"
},
"sslStatus": {
"type": "string"
},
"hostResolutionStatus": {
"type": "string"
},
"apiRoutingStatus": {
"type": "string"
},
"customerLoginStatus": {
"type": "string"
},
"libraryAccessStatus": {
"type": "string"
},
"checkoutReturnStatus": {
"type": "string"
},
"dnsRecords": {
"type": "array",
"items": {
"type": "object",
"properties": {
"record": {
"type": "string"
},
"type": {
"type": "string"
},
"name": {
"type": "string"
},
"value": {
"type": "string"
},
"ttl": {
"type": "string"
},
"status": {
"type": "string"
}
},
"additionalProperties": true
}
},
"provider": {
"type": "string"
},
"lastCheckedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"verifiedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"additionalProperties": true
},
"settings": {
"type": "object",
"properties": {
"target": {
"type": "string"
},
"proxyHost": {
"type": "string"
},
"expectedDnsRecords": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
},
"checklist": {
"type": "array",
"items": {
"type": "object",
"properties": {
"label": {
"type": "string"
},
"status": {
"type": "string"
}
},
"additionalProperties": true
}
},
"ready": {
"type": "boolean"
},
"checkoutReturnPath": {
"type": "string"
},
"customerLoginPath": {
"type": "string"
},
"libraryAccessPath": {
"type": "string"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}Documented failures: 400, 401, 403, 404, 409, 500, 503.
POST
/api/developer/storefront-domain
Connect an apex or subdomain for the storefront
- Auth
- Account Bearer JWT
- Scope
- domains.view, domains.manage and all-products scope.
- Request fields
- domain: string
- storefrontDomain: string
- customDomain: string
- Returns
- HTTP 201: domain, settings.
- Notes
- Send domain or the supported aliases. Requires domain/DNS control. Records and provider setup come from the response; do not hard-code provider DNS targets. External registration/checks can occur. This website-specific workflow does not verify email sending.
Request, response and error reference
Request (application/json)
{
"type": "object",
"properties": {
"domain": {
"type": "string"
},
"storefrontDomain": {
"type": "string"
},
"customDomain": {
"type": "string"
}
},
"additionalProperties": true
}HTTP 201 response (application/json)
{
"type": "object",
"properties": {
"domain": {
"type": [
"object",
"null"
],
"properties": {
"id": {
"type": "integer",
"minimum": 1
},
"developerUserId": {
"type": "integer",
"minimum": 1
},
"domain": {
"type": "string"
},
"status": {
"type": "string"
},
"verified": {
"type": "boolean"
},
"dnsStatus": {
"type": "string"
},
"sslStatus": {
"type": "string"
},
"hostResolutionStatus": {
"type": "string"
},
"apiRoutingStatus": {
"type": "string"
},
"customerLoginStatus": {
"type": "string"
},
"libraryAccessStatus": {
"type": "string"
},
"checkoutReturnStatus": {
"type": "string"
},
"dnsRecords": {
"type": "array",
"items": {
"type": "object",
"properties": {
"record": {
"type": "string"
},
"type": {
"type": "string"
},
"name": {
"type": "string"
},
"value": {
"type": "string"
},
"ttl": {
"type": "string"
},
"status": {
"type": "string"
}
},
"additionalProperties": true
}
},
"provider": {
"type": "string"
},
"lastCheckedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"verifiedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"additionalProperties": true
},
"settings": {
"type": "object",
"properties": {
"target": {
"type": "string"
},
"proxyHost": {
"type": "string"
},
"expectedDnsRecords": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
},
"checklist": {
"type": "array",
"items": {
"type": "object",
"properties": {
"label": {
"type": "string"
},
"status": {
"type": "string"
}
},
"additionalProperties": true
}
},
"ready": {
"type": "boolean"
},
"checkoutReturnPath": {
"type": "string"
},
"customerLoginPath": {
"type": "string"
},
"libraryAccessPath": {
"type": "string"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}Documented failures: 400, 401, 403, 404, 409, 500, 503.
POST
/api/developer/storefront-domain/{domainId}/refresh
Refresh website DNS, routing and SSL checks
- Auth
- Account Bearer JWT
- Scope
- domains.view, domains.manage and all-products scope.
- Returns
- HTTP 200: domain, settings.
- Notes
- Domain ID must belong to the effective developer. Performs provider/DNS checks and persists the result. Read settings.ready and the individual states; no propagation or certificate completion time is guaranteed.
Request, response and error reference
No request body fields are read by this operation.
HTTP 200 response (application/json)
{
"type": "object",
"properties": {
"domain": {
"type": [
"object",
"null"
],
"properties": {
"id": {
"type": "integer",
"minimum": 1
},
"developerUserId": {
"type": "integer",
"minimum": 1
},
"domain": {
"type": "string"
},
"status": {
"type": "string"
},
"verified": {
"type": "boolean"
},
"dnsStatus": {
"type": "string"
},
"sslStatus": {
"type": "string"
},
"hostResolutionStatus": {
"type": "string"
},
"apiRoutingStatus": {
"type": "string"
},
"customerLoginStatus": {
"type": "string"
},
"libraryAccessStatus": {
"type": "string"
},
"checkoutReturnStatus": {
"type": "string"
},
"dnsRecords": {
"type": "array",
"items": {
"type": "object",
"properties": {
"record": {
"type": "string"
},
"type": {
"type": "string"
},
"name": {
"type": "string"
},
"value": {
"type": "string"
},
"ttl": {
"type": "string"
},
"status": {
"type": "string"
}
},
"additionalProperties": true
}
},
"provider": {
"type": "string"
},
"lastCheckedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"verifiedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"additionalProperties": true
},
"settings": {
"type": "object",
"properties": {
"target": {
"type": "string"
},
"proxyHost": {
"type": "string"
},
"expectedDnsRecords": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
},
"checklist": {
"type": "array",
"items": {
"type": "object",
"properties": {
"label": {
"type": "string"
},
"status": {
"type": "string"
}
},
"additionalProperties": true
}
},
"ready": {
"type": "boolean"
},
"checkoutReturnPath": {
"type": "string"
},
"customerLoginPath": {
"type": "string"
},
"libraryAccessPath": {
"type": "string"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}Documented failures: 400, 401, 403, 404, 409, 500, 503.
GET
/api/developer/email-domains
List sending domains and current sender readiness
- Auth
- Account Bearer JWT
- Scope
- domains.view and all-products workspace scope; effective developer ownership.
- Returns
- HTTP 200: domains, settings.
- Notes
- Reads bounded, cached provider status without creating domains, starting verification or writing provider results to the application database; surrounding settings reads can initialize default sender profiles. This is not a zero-write probe. providerReadErrors distinguishes lookup errors from a DNS mismatch. Inspect transactional, marketing and tracking readiness separately; a website SSL certificate does not verify email DNS.
Request, response and error reference
No request body fields are read by this operation.
HTTP 200 response (application/json)
{
"type": "object",
"properties": {
"domains": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
},
"domain": {
"type": "string"
},
"fromLocalPart": {
"type": "string"
},
"senderEmail": {
"type": "string"
},
"status": {
"type": "string"
},
"verified": {
"type": "boolean"
},
"elasticStatus": {
"type": "string"
},
"elasticVerified": {
"type": "boolean"
},
"unifiedVerified": {
"type": "boolean"
},
"dnsRecords": {
"type": "array",
"items": {
"type": "object",
"properties": {
"provider": {
"type": "string"
},
"record": {
"type": "string"
},
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"value": {
"type": "string"
},
"ttl": {
"type": [
"string",
"number"
]
},
"priority": {
"type": [
"number",
"null"
]
},
"status": {
"type": "string"
}
},
"additionalProperties": true
}
},
"providerVerification": {
"type": "object",
"properties": {
"resend": {
"type": "object",
"properties": {
"provider": {
"type": "string"
},
"status": {
"type": "string"
},
"verified": {
"type": "boolean"
},
"dnsRecords": {
"type": "array",
"items": {
"type": "object",
"properties": {
"provider": {
"type": "string"
},
"record": {
"type": "string"
},
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"value": {
"type": "string"
},
"ttl": {
"type": [
"string",
"number"
]
},
"priority": {
"type": [
"number",
"null"
]
},
"status": {
"type": "string"
}
},
"additionalProperties": true
}
},
"verifiedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"lastCheckedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"lastError": {
"type": [
"string",
"null"
]
},
"metadata": {
"type": "object",
"properties": {
"sendingEnabled": {
"type": "boolean"
},
"sendingReady": {
"type": "boolean"
},
"trackingReady": {
"type": "boolean"
},
"trackingCertificateReady": {
"type": "boolean"
},
"certificateExpiresAt": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
},
"elastic": {
"type": "object",
"properties": {
"provider": {
"type": "string"
},
"status": {
"type": "string"
},
"verified": {
"type": "boolean"
},
"dnsRecords": {
"type": "array",
"items": {
"type": "object",
"properties": {
"provider": {
"type": "string"
},
"record": {
"type": "string"
},
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"value": {
"type": "string"
},
"ttl": {
"type": [
"string",
"number"
]
},
"priority": {
"type": [
"number",
"null"
]
},
"status": {
"type": "string"
}
},
"additionalProperties": true
}
},
"verifiedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"lastCheckedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"lastError": {
"type": [
"string",
"null"
]
},
"metadata": {
"type": "object",
"properties": {
"sendingEnabled": {
"type": "boolean"
},
"sendingReady": {
"type": "boolean"
},
"trackingReady": {
"type": "boolean"
},
"trackingCertificateReady": {
"type": "boolean"
},
"certificateExpiresAt": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}
},
"additionalProperties": true
},
"providerReadErrors": {
"type": "object",
"properties": {
"resend": {
"type": "string"
},
"elastic": {
"type": "string"
}
},
"additionalProperties": true
},
"verifiedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"lastCheckedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"lastError": {
"type": [
"string",
"null"
]
}
},
"additionalProperties": true
}
},
"settings": {
"type": "object",
"properties": {
"supportEmail": {
"type": "string"
},
"supportEmailPresent": {
"type": "boolean"
},
"brandDomainOwnershipReady": {
"type": "boolean"
},
"customDomain": {
"type": [
"object",
"null"
],
"properties": {
"id": {
"type": "integer",
"minimum": 1
},
"domain": {
"type": "string"
},
"fromLocalPart": {
"type": "string"
},
"senderEmail": {
"type": "string"
},
"status": {
"type": "string"
},
"verified": {
"type": "boolean"
},
"elasticStatus": {
"type": "string"
},
"elasticVerified": {
"type": "boolean"
},
"unifiedVerified": {
"type": "boolean"
},
"dnsRecords": {
"type": "array",
"items": {
"type": "object",
"properties": {
"provider": {
"type": "string"
},
"record": {
"type": "string"
},
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"value": {
"type": "string"
},
"ttl": {
"type": [
"string",
"number"
]
},
"priority": {
"type": [
"number",
"null"
]
},
"status": {
"type": "string"
}
},
"additionalProperties": true
}
},
"providerVerification": {
"type": "object",
"properties": {
"resend": {
"type": "object",
"properties": {
"provider": {
"type": "string"
},
"status": {
"type": "string"
},
"verified": {
"type": "boolean"
},
"dnsRecords": {
"type": "array",
"items": {
"type": "object",
"properties": {
"provider": {
"type": "string"
},
"record": {
"type": "string"
},
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"value": {
"type": "string"
},
"ttl": {
"type": [
"string",
"number"
]
},
"priority": {
"type": [
"number",
"null"
]
},
"status": {
"type": "string"
}
},
"additionalProperties": true
}
},
"verifiedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"lastCheckedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"lastError": {
"type": [
"string",
"null"
]
},
"metadata": {
"type": "object",
"properties": {
"sendingEnabled": {
"type": "boolean"
},
"sendingReady": {
"type": "boolean"
},
"trackingReady": {
"type": "boolean"
},
"trackingCertificateReady": {
"type": "boolean"
},
"certificateExpiresAt": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
},
"elastic": {
"type": "object",
"properties": {
"provider": {
"type": "string"
},
"status": {
"type": "string"
},
"verified": {
"type": "boolean"
},
"dnsRecords": {
"type": "array",
"items": {
"type": "object",
"properties": {
"provider": {
"type": "string"
},
"record": {
"type": "string"
},
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"value": {
"type": "string"
},
"ttl": {
"type": [
"string",
"number"
]
},
"priority": {
"type": [
"number",
"null"
]
},
"status": {
"type": "string"
}
},
"additionalProperties": true
}
},
"verifiedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"lastCheckedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"lastError": {
"type": [
"string",
"null"
]
},
"metadata": {
"type": "object",
"properties": {
"sendingEnabled": {
"type": "boolean"
},
"sendingReady": {
"type": "boolean"
},
"trackingReady": {
"type": "boolean"
},
"trackingCertificateReady": {
"type": "boolean"
},
"certificateExpiresAt": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}
},
"additionalProperties": true
},
"providerReadErrors": {
"type": "object",
"properties": {
"resend": {
"type": "string"
},
"elastic": {
"type": "string"
}
},
"additionalProperties": true
},
"verifiedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"lastCheckedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"lastError": {
"type": [
"string",
"null"
]
}
},
"additionalProperties": true
},
"domainStatus": {
"type": [
"string",
"null"
]
},
"marketingDomainStatus": {
"type": [
"string",
"null"
]
},
"senderProfiles": {
"type": "object",
"properties": {
"licensing": {
"type": "object",
"properties": {
"purpose": {
"enum": [
"licensing",
"notifications",
"marketing"
]
},
"label": {
"type": "string"
},
"localPart": {
"type": "string"
},
"fromEmail": {
"type": "string"
},
"editable": {
"type": "boolean"
}
},
"additionalProperties": true
},
"notifications": {
"type": "object",
"properties": {
"purpose": {
"enum": [
"licensing",
"notifications",
"marketing"
]
},
"label": {
"type": "string"
},
"localPart": {
"type": "string"
},
"fromEmail": {
"type": "string"
},
"editable": {
"type": "boolean"
}
},
"additionalProperties": true
},
"marketing": {
"type": "object",
"properties": {
"purpose": {
"enum": [
"licensing",
"notifications",
"marketing"
]
},
"label": {
"type": "string"
},
"localPart": {
"type": "string"
},
"fromEmail": {
"type": "string"
},
"editable": {
"type": "boolean"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
},
"customSendingUsable": {
"type": "boolean"
},
"transactionalSendingUsable": {
"type": "boolean"
},
"marketingSendingUsable": {
"type": "boolean"
},
"marketingTrackingUsable": {
"type": "boolean"
},
"trackClicks": {
"type": "boolean"
},
"trackOpens": {
"type": "boolean"
},
"canDisableUnsafeMarketingTracking": {
"type": "boolean"
},
"unifiedDomainVerified": {
"type": "boolean"
},
"providerReadiness": {
"type": "object",
"properties": {
"configured": {
"type": "boolean"
},
"transactional": {
"type": "boolean"
},
"marketing": {
"type": "boolean"
},
"tracking": {
"type": "boolean"
},
"ready": {
"type": "boolean"
}
},
"additionalProperties": true
},
"blockingReasons": {
"type": "array",
"items": {
"type": "string"
}
},
"transactionalBlockingReasons": {
"type": "array",
"items": {
"type": "string"
}
},
"marketingBlockingReasons": {
"type": "array",
"items": {
"type": "string"
}
},
"trackingBlockingReasons": {
"type": "array",
"items": {
"type": "string"
}
},
"fallbackSender": {
"type": "string"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}Documented failures: 400, 401, 403, 404, 500, 503.
GET
/api/developer/email-domains/settings
Read active sending identity and blocking reasons
- Auth
- Account Bearer JWT
- Scope
- domains.view and all-products workspace scope; effective developer ownership.
- Returns
- HTTP 200: settings.
- Notes
- Can initialize default sender profiles. Use transactionalBlockingReasons or marketingBlockingReasons for the intended purpose, not the legacy combined blockingReasons alone. With marketingTrackingUsable:false, trackClicks/trackOpens are false. Marketing may be usable without tracking only when the configured provider supports disabling unsafe tracking; otherwise it remains blocked. No public call in this guide changes that provider capability. Full wizard readiness is stricter than a single sending purpose. HTTP 200 does not mean sending is enabled.
Request, response and error reference
No request body fields are read by this operation.
HTTP 200 response (application/json)
{
"type": "object",
"properties": {
"settings": {
"type": "object",
"properties": {
"supportEmail": {
"type": "string"
},
"supportEmailPresent": {
"type": "boolean"
},
"brandDomainOwnershipReady": {
"type": "boolean"
},
"customDomain": {
"type": [
"object",
"null"
],
"properties": {
"id": {
"type": "integer",
"minimum": 1
},
"domain": {
"type": "string"
},
"fromLocalPart": {
"type": "string"
},
"senderEmail": {
"type": "string"
},
"status": {
"type": "string"
},
"verified": {
"type": "boolean"
},
"elasticStatus": {
"type": "string"
},
"elasticVerified": {
"type": "boolean"
},
"unifiedVerified": {
"type": "boolean"
},
"dnsRecords": {
"type": "array",
"items": {
"type": "object",
"properties": {
"provider": {
"type": "string"
},
"record": {
"type": "string"
},
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"value": {
"type": "string"
},
"ttl": {
"type": [
"string",
"number"
]
},
"priority": {
"type": [
"number",
"null"
]
},
"status": {
"type": "string"
}
},
"additionalProperties": true
}
},
"providerVerification": {
"type": "object",
"properties": {
"resend": {
"type": "object",
"properties": {
"provider": {
"type": "string"
},
"status": {
"type": "string"
},
"verified": {
"type": "boolean"
},
"dnsRecords": {
"type": "array",
"items": {
"type": "object",
"properties": {
"provider": {
"type": "string"
},
"record": {
"type": "string"
},
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"value": {
"type": "string"
},
"ttl": {
"type": [
"string",
"number"
]
},
"priority": {
"type": [
"number",
"null"
]
},
"status": {
"type": "string"
}
},
"additionalProperties": true
}
},
"verifiedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"lastCheckedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"lastError": {
"type": [
"string",
"null"
]
},
"metadata": {
"type": "object",
"properties": {
"sendingEnabled": {
"type": "boolean"
},
"sendingReady": {
"type": "boolean"
},
"trackingReady": {
"type": "boolean"
},
"trackingCertificateReady": {
"type": "boolean"
},
"certificateExpiresAt": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
},
"elastic": {
"type": "object",
"properties": {
"provider": {
"type": "string"
},
"status": {
"type": "string"
},
"verified": {
"type": "boolean"
},
"dnsRecords": {
"type": "array",
"items": {
"type": "object",
"properties": {
"provider": {
"type": "string"
},
"record": {
"type": "string"
},
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"value": {
"type": "string"
},
"ttl": {
"type": [
"string",
"number"
]
},
"priority": {
"type": [
"number",
"null"
]
},
"status": {
"type": "string"
}
},
"additionalProperties": true
}
},
"verifiedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"lastCheckedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"lastError": {
"type": [
"string",
"null"
]
},
"metadata": {
"type": "object",
"properties": {
"sendingEnabled": {
"type": "boolean"
},
"sendingReady": {
"type": "boolean"
},
"trackingReady": {
"type": "boolean"
},
"trackingCertificateReady": {
"type": "boolean"
},
"certificateExpiresAt": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}
},
"additionalProperties": true
},
"providerReadErrors": {
"type": "object",
"properties": {
"resend": {
"type": "string"
},
"elastic": {
"type": "string"
}
},
"additionalProperties": true
},
"verifiedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"lastCheckedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"lastError": {
"type": [
"string",
"null"
]
}
},
"additionalProperties": true
},
"domainStatus": {
"type": [
"string",
"null"
]
},
"marketingDomainStatus": {
"type": [
"string",
"null"
]
},
"senderProfiles": {
"type": "object",
"properties": {
"licensing": {
"type": "object",
"properties": {
"purpose": {
"enum": [
"licensing",
"notifications",
"marketing"
]
},
"label": {
"type": "string"
},
"localPart": {
"type": "string"
},
"fromEmail": {
"type": "string"
},
"editable": {
"type": "boolean"
}
},
"additionalProperties": true
},
"notifications": {
"type": "object",
"properties": {
"purpose": {
"enum": [
"licensing",
"notifications",
"marketing"
]
},
"label": {
"type": "string"
},
"localPart": {
"type": "string"
},
"fromEmail": {
"type": "string"
},
"editable": {
"type": "boolean"
}
},
"additionalProperties": true
},
"marketing": {
"type": "object",
"properties": {
"purpose": {
"enum": [
"licensing",
"notifications",
"marketing"
]
},
"label": {
"type": "string"
},
"localPart": {
"type": "string"
},
"fromEmail": {
"type": "string"
},
"editable": {
"type": "boolean"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
},
"customSendingUsable": {
"type": "boolean"
},
"transactionalSendingUsable": {
"type": "boolean"
},
"marketingSendingUsable": {
"type": "boolean"
},
"marketingTrackingUsable": {
"type": "boolean"
},
"trackClicks": {
"type": "boolean"
},
"trackOpens": {
"type": "boolean"
},
"canDisableUnsafeMarketingTracking": {
"type": "boolean"
},
"unifiedDomainVerified": {
"type": "boolean"
},
"providerReadiness": {
"type": "object",
"properties": {
"configured": {
"type": "boolean"
},
"transactional": {
"type": "boolean"
},
"marketing": {
"type": "boolean"
},
"tracking": {
"type": "boolean"
},
"ready": {
"type": "boolean"
}
},
"additionalProperties": true
},
"blockingReasons": {
"type": "array",
"items": {
"type": "string"
}
},
"transactionalBlockingReasons": {
"type": "array",
"items": {
"type": "string"
}
},
"marketingBlockingReasons": {
"type": "array",
"items": {
"type": "string"
}
},
"trackingBlockingReasons": {
"type": "array",
"items": {
"type": "string"
}
},
"fallbackSender": {
"type": "string"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}Documented failures: 400, 401, 403, 404, 500, 503.
POST
/api/developer/email-domains
Register or reuse a developer sending domain
- Auth
- Account Bearer JWT
- Scope
- domains.view plus domains.manage and all-products workspace scope; effective developer ownership.
- Request fields
- domain: string
- emailDomain: string
- sendingDomain: string
- fromLocalPart: string
- from_local_part: string
- Returns
- HTTP 201: domain, settings, reusedResendDomain, resendError, elasticError.
- Notes
- emailDomain/sendingDomain alias domain; from_local_part aliases fromLocalPart. Local-part input is only the prefix, not an email address. Activating a different domain disables older active sending-domain rows for this developer. Provider creation and DNS checks have side effects; inspect error flags even on 201. Reusing a domain does not guarantee verified DNS or authorize marketing.
Request, response and error reference
Request (application/json)
{
"type": "object",
"properties": {
"domain": {
"type": "string"
},
"emailDomain": {
"type": "string"
},
"sendingDomain": {
"type": "string"
},
"fromLocalPart": {
"type": "string"
},
"from_local_part": {
"type": "string"
}
},
"additionalProperties": true,
"anyOf": [
{
"required": [
"domain"
]
},
{
"required": [
"emailDomain"
]
},
{
"required": [
"sendingDomain"
]
}
]
}HTTP 201 response (application/json)
{
"type": "object",
"properties": {
"domain": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
},
"domain": {
"type": "string"
},
"fromLocalPart": {
"type": "string"
},
"senderEmail": {
"type": "string"
},
"status": {
"type": "string"
},
"verified": {
"type": "boolean"
},
"elasticStatus": {
"type": "string"
},
"elasticVerified": {
"type": "boolean"
},
"unifiedVerified": {
"type": "boolean"
},
"dnsRecords": {
"type": "array",
"items": {
"type": "object",
"properties": {
"provider": {
"type": "string"
},
"record": {
"type": "string"
},
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"value": {
"type": "string"
},
"ttl": {
"type": [
"string",
"number"
]
},
"priority": {
"type": [
"number",
"null"
]
},
"status": {
"type": "string"
}
},
"additionalProperties": true
}
},
"providerVerification": {
"type": "object",
"properties": {
"resend": {
"type": "object",
"properties": {
"provider": {
"type": "string"
},
"status": {
"type": "string"
},
"verified": {
"type": "boolean"
},
"dnsRecords": {
"type": "array",
"items": {
"type": "object",
"properties": {
"provider": {
"type": "string"
},
"record": {
"type": "string"
},
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"value": {
"type": "string"
},
"ttl": {
"type": [
"string",
"number"
]
},
"priority": {
"type": [
"number",
"null"
]
},
"status": {
"type": "string"
}
},
"additionalProperties": true
}
},
"verifiedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"lastCheckedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"lastError": {
"type": [
"string",
"null"
]
},
"metadata": {
"type": "object",
"properties": {
"sendingEnabled": {
"type": "boolean"
},
"sendingReady": {
"type": "boolean"
},
"trackingReady": {
"type": "boolean"
},
"trackingCertificateReady": {
"type": "boolean"
},
"certificateExpiresAt": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
},
"elastic": {
"type": "object",
"properties": {
"provider": {
"type": "string"
},
"status": {
"type": "string"
},
"verified": {
"type": "boolean"
},
"dnsRecords": {
"type": "array",
"items": {
"type": "object",
"properties": {
"provider": {
"type": "string"
},
"record": {
"type": "string"
},
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"value": {
"type": "string"
},
"ttl": {
"type": [
"string",
"number"
]
},
"priority": {
"type": [
"number",
"null"
]
},
"status": {
"type": "string"
}
},
"additionalProperties": true
}
},
"verifiedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"lastCheckedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"lastError": {
"type": [
"string",
"null"
]
},
"metadata": {
"type": "object",
"properties": {
"sendingEnabled": {
"type": "boolean"
},
"sendingReady": {
"type": "boolean"
},
"trackingReady": {
"type": "boolean"
},
"trackingCertificateReady": {
"type": "boolean"
},
"certificateExpiresAt": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}
},
"additionalProperties": true
},
"providerReadErrors": {
"type": "object",
"properties": {
"resend": {
"type": "string"
},
"elastic": {
"type": "string"
}
},
"additionalProperties": true
},
"verifiedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"lastCheckedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"lastError": {
"type": [
"string",
"null"
]
}
},
"additionalProperties": true
},
"settings": {
"type": "object",
"properties": {
"supportEmail": {
"type": "string"
},
"supportEmailPresent": {
"type": "boolean"
},
"brandDomainOwnershipReady": {
"type": "boolean"
},
"customDomain": {
"type": [
"object",
"null"
],
"properties": {
"id": {
"type": "integer",
"minimum": 1
},
"domain": {
"type": "string"
},
"fromLocalPart": {
"type": "string"
},
"senderEmail": {
"type": "string"
},
"status": {
"type": "string"
},
"verified": {
"type": "boolean"
},
"elasticStatus": {
"type": "string"
},
"elasticVerified": {
"type": "boolean"
},
"unifiedVerified": {
"type": "boolean"
},
"dnsRecords": {
"type": "array",
"items": {
"type": "object",
"properties": {
"provider": {
"type": "string"
},
"record": {
"type": "string"
},
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"value": {
"type": "string"
},
"ttl": {
"type": [
"string",
"number"
]
},
"priority": {
"type": [
"number",
"null"
]
},
"status": {
"type": "string"
}
},
"additionalProperties": true
}
},
"providerVerification": {
"type": "object",
"properties": {
"resend": {
"type": "object",
"properties": {
"provider": {
"type": "string"
},
"status": {
"type": "string"
},
"verified": {
"type": "boolean"
},
"dnsRecords": {
"type": "array",
"items": {
"type": "object",
"properties": {
"provider": {
"type": "string"
},
"record": {
"type": "string"
},
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"value": {
"type": "string"
},
"ttl": {
"type": [
"string",
"number"
]
},
"priority": {
"type": [
"number",
"null"
]
},
"status": {
"type": "string"
}
},
"additionalProperties": true
}
},
"verifiedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"lastCheckedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"lastError": {
"type": [
"string",
"null"
]
},
"metadata": {
"type": "object",
"properties": {
"sendingEnabled": {
"type": "boolean"
},
"sendingReady": {
"type": "boolean"
},
"trackingReady": {
"type": "boolean"
},
"trackingCertificateReady": {
"type": "boolean"
},
"certificateExpiresAt": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
},
"elastic": {
"type": "object",
"properties": {
"provider": {
"type": "string"
},
"status": {
"type": "string"
},
"verified": {
"type": "boolean"
},
"dnsRecords": {
"type": "array",
"items": {
"type": "object",
"properties": {
"provider": {
"type": "string"
},
"record": {
"type": "string"
},
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"value": {
"type": "string"
},
"ttl": {
"type": [
"string",
"number"
]
},
"priority": {
"type": [
"number",
"null"
]
},
"status": {
"type": "string"
}
},
"additionalProperties": true
}
},
"verifiedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"lastCheckedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"lastError": {
"type": [
"string",
"null"
]
},
"metadata": {
"type": "object",
"properties": {
"sendingEnabled": {
"type": "boolean"
},
"sendingReady": {
"type": "boolean"
},
"trackingReady": {
"type": "boolean"
},
"trackingCertificateReady": {
"type": "boolean"
},
"certificateExpiresAt": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}
},
"additionalProperties": true
},
"providerReadErrors": {
"type": "object",
"properties": {
"resend": {
"type": "string"
},
"elastic": {
"type": "string"
}
},
"additionalProperties": true
},
"verifiedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"lastCheckedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"lastError": {
"type": [
"string",
"null"
]
}
},
"additionalProperties": true
},
"domainStatus": {
"type": [
"string",
"null"
]
},
"marketingDomainStatus": {
"type": [
"string",
"null"
]
},
"senderProfiles": {
"type": "object",
"properties": {
"licensing": {
"type": "object",
"properties": {
"purpose": {
"enum": [
"licensing",
"notifications",
"marketing"
]
},
"label": {
"type": "string"
},
"localPart": {
"type": "string"
},
"fromEmail": {
"type": "string"
},
"editable": {
"type": "boolean"
}
},
"additionalProperties": true
},
"notifications": {
"type": "object",
"properties": {
"purpose": {
"enum": [
"licensing",
"notifications",
"marketing"
]
},
"label": {
"type": "string"
},
"localPart": {
"type": "string"
},
"fromEmail": {
"type": "string"
},
"editable": {
"type": "boolean"
}
},
"additionalProperties": true
},
"marketing": {
"type": "object",
"properties": {
"purpose": {
"enum": [
"licensing",
"notifications",
"marketing"
]
},
"label": {
"type": "string"
},
"localPart": {
"type": "string"
},
"fromEmail": {
"type": "string"
},
"editable": {
"type": "boolean"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
},
"customSendingUsable": {
"type": "boolean"
},
"transactionalSendingUsable": {
"type": "boolean"
},
"marketingSendingUsable": {
"type": "boolean"
},
"marketingTrackingUsable": {
"type": "boolean"
},
"trackClicks": {
"type": "boolean"
},
"trackOpens": {
"type": "boolean"
},
"canDisableUnsafeMarketingTracking": {
"type": "boolean"
},
"unifiedDomainVerified": {
"type": "boolean"
},
"providerReadiness": {
"type": "object",
"properties": {
"configured": {
"type": "boolean"
},
"transactional": {
"type": "boolean"
},
"marketing": {
"type": "boolean"
},
"tracking": {
"type": "boolean"
},
"ready": {
"type": "boolean"
}
},
"additionalProperties": true
},
"blockingReasons": {
"type": "array",
"items": {
"type": "string"
}
},
"transactionalBlockingReasons": {
"type": "array",
"items": {
"type": "string"
}
},
"marketingBlockingReasons": {
"type": "array",
"items": {
"type": "string"
}
},
"trackingBlockingReasons": {
"type": "array",
"items": {
"type": "string"
}
},
"fallbackSender": {
"type": "string"
}
},
"additionalProperties": true
},
"reusedResendDomain": {
"type": "boolean"
},
"resendError": {
"type": "boolean"
},
"elasticError": {
"type": "boolean"
}
},
"additionalProperties": true
}Documented failures: 400, 401, 403, 500, 502, 503.
Operation errors: INVALID_EMAIL_DOMAIN, RESERVED_EMAIL_DOMAIN, RESEND_NOT_CONFIGURED, RESEND_DOMAIN_CREATE_FAILED.
PATCH
/api/developer/email-domains/sender-profiles
Update selected purpose-specific sender prefixes
- Auth
- Account Bearer JWT
- Scope
- domains.view plus domains.manage and all-products workspace scope; effective developer ownership.
- Request fields
- senderProfiles: object
- licensing: value
- notifications: value
- marketing: value
- Returns
- HTTP 200: settings.
- Notes
- At least one supported purpose must be provided. The same purpose fields are also accepted at the body root. PUT and PATCH share this sparse-update handler; omitted purposes remain unchanged. An active custom domain is required. Saving a sender profile does not verify DNS or send a message.
Request, response and error reference
Request (application/json)
{
"type": "object",
"properties": {
"senderProfiles": {
"type": "object",
"properties": {
"licensing": {
"anyOf": [
{
"type": "string"
},
{
"type": "object",
"properties": {
"localPart": {
"type": "string"
}
},
"required": [
"localPart"
],
"additionalProperties": true
},
{
"type": "object",
"properties": {
"local_part": {
"type": "string"
}
},
"required": [
"local_part"
],
"additionalProperties": true
}
]
},
"notifications": {
"anyOf": [
{
"type": "string"
},
{
"type": "object",
"properties": {
"localPart": {
"type": "string"
}
},
"required": [
"localPart"
],
"additionalProperties": true
},
{
"type": "object",
"properties": {
"local_part": {
"type": "string"
}
},
"required": [
"local_part"
],
"additionalProperties": true
}
]
},
"marketing": {
"anyOf": [
{
"type": "string"
},
{
"type": "object",
"properties": {
"localPart": {
"type": "string"
}
},
"required": [
"localPart"
],
"additionalProperties": true
},
{
"type": "object",
"properties": {
"local_part": {
"type": "string"
}
},
"required": [
"local_part"
],
"additionalProperties": true
}
]
}
},
"additionalProperties": true
},
"licensing": {
"anyOf": [
{
"type": "string"
},
{
"type": "object",
"properties": {
"localPart": {
"type": "string"
}
},
"required": [
"localPart"
],
"additionalProperties": true
},
{
"type": "object",
"properties": {
"local_part": {
"type": "string"
}
},
"required": [
"local_part"
],
"additionalProperties": true
}
]
},
"notifications": {
"anyOf": [
{
"type": "string"
},
{
"type": "object",
"properties": {
"localPart": {
"type": "string"
}
},
"required": [
"localPart"
],
"additionalProperties": true
},
{
"type": "object",
"properties": {
"local_part": {
"type": "string"
}
},
"required": [
"local_part"
],
"additionalProperties": true
}
]
},
"marketing": {
"anyOf": [
{
"type": "string"
},
{
"type": "object",
"properties": {
"localPart": {
"type": "string"
}
},
"required": [
"localPart"
],
"additionalProperties": true
},
{
"type": "object",
"properties": {
"local_part": {
"type": "string"
}
},
"required": [
"local_part"
],
"additionalProperties": true
}
]
}
},
"additionalProperties": true,
"anyOf": [
{
"required": [
"senderProfiles"
]
},
{
"required": [
"licensing"
]
},
{
"required": [
"notifications"
]
},
{
"required": [
"marketing"
]
}
]
}HTTP 200 response (application/json)
{
"type": "object",
"properties": {
"settings": {
"type": "object",
"properties": {
"supportEmail": {
"type": "string"
},
"supportEmailPresent": {
"type": "boolean"
},
"brandDomainOwnershipReady": {
"type": "boolean"
},
"customDomain": {
"type": [
"object",
"null"
],
"properties": {
"id": {
"type": "integer",
"minimum": 1
},
"domain": {
"type": "string"
},
"fromLocalPart": {
"type": "string"
},
"senderEmail": {
"type": "string"
},
"status": {
"type": "string"
},
"verified": {
"type": "boolean"
},
"elasticStatus": {
"type": "string"
},
"elasticVerified": {
"type": "boolean"
},
"unifiedVerified": {
"type": "boolean"
},
"dnsRecords": {
"type": "array",
"items": {
"type": "object",
"properties": {
"provider": {
"type": "string"
},
"record": {
"type": "string"
},
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"value": {
"type": "string"
},
"ttl": {
"type": [
"string",
"number"
]
},
"priority": {
"type": [
"number",
"null"
]
},
"status": {
"type": "string"
}
},
"additionalProperties": true
}
},
"providerVerification": {
"type": "object",
"properties": {
"resend": {
"type": "object",
"properties": {
"provider": {
"type": "string"
},
"status": {
"type": "string"
},
"verified": {
"type": "boolean"
},
"dnsRecords": {
"type": "array",
"items": {
"type": "object",
"properties": {
"provider": {
"type": "string"
},
"record": {
"type": "string"
},
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"value": {
"type": "string"
},
"ttl": {
"type": [
"string",
"number"
]
},
"priority": {
"type": [
"number",
"null"
]
},
"status": {
"type": "string"
}
},
"additionalProperties": true
}
},
"verifiedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"lastCheckedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"lastError": {
"type": [
"string",
"null"
]
},
"metadata": {
"type": "object",
"properties": {
"sendingEnabled": {
"type": "boolean"
},
"sendingReady": {
"type": "boolean"
},
"trackingReady": {
"type": "boolean"
},
"trackingCertificateReady": {
"type": "boolean"
},
"certificateExpiresAt": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
},
"elastic": {
"type": "object",
"properties": {
"provider": {
"type": "string"
},
"status": {
"type": "string"
},
"verified": {
"type": "boolean"
},
"dnsRecords": {
"type": "array",
"items": {
"type": "object",
"properties": {
"provider": {
"type": "string"
},
"record": {
"type": "string"
},
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"value": {
"type": "string"
},
"ttl": {
"type": [
"string",
"number"
]
},
"priority": {
"type": [
"number",
"null"
]
},
"status": {
"type": "string"
}
},
"additionalProperties": true
}
},
"verifiedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"lastCheckedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"lastError": {
"type": [
"string",
"null"
]
},
"metadata": {
"type": "object",
"properties": {
"sendingEnabled": {
"type": "boolean"
},
"sendingReady": {
"type": "boolean"
},
"trackingReady": {
"type": "boolean"
},
"trackingCertificateReady": {
"type": "boolean"
},
"certificateExpiresAt": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}
},
"additionalProperties": true
},
"providerReadErrors": {
"type": "object",
"properties": {
"resend": {
"type": "string"
},
"elastic": {
"type": "string"
}
},
"additionalProperties": true
},
"verifiedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"lastCheckedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"lastError": {
"type": [
"string",
"null"
]
}
},
"additionalProperties": true
},
"domainStatus": {
"type": [
"string",
"null"
]
},
"marketingDomainStatus": {
"type": [
"string",
"null"
]
},
"senderProfiles": {
"type": "object",
"properties": {
"licensing": {
"type": "object",
"properties": {
"purpose": {
"enum": [
"licensing",
"notifications",
"marketing"
]
},
"label": {
"type": "string"
},
"localPart": {
"type": "string"
},
"fromEmail": {
"type": "string"
},
"editable": {
"type": "boolean"
}
},
"additionalProperties": true
},
"notifications": {
"type": "object",
"properties": {
"purpose": {
"enum": [
"licensing",
"notifications",
"marketing"
]
},
"label": {
"type": "string"
},
"localPart": {
"type": "string"
},
"fromEmail": {
"type": "string"
},
"editable": {
"type": "boolean"
}
},
"additionalProperties": true
},
"marketing": {
"type": "object",
"properties": {
"purpose": {
"enum": [
"licensing",
"notifications",
"marketing"
]
},
"label": {
"type": "string"
},
"localPart": {
"type": "string"
},
"fromEmail": {
"type": "string"
},
"editable": {
"type": "boolean"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
},
"customSendingUsable": {
"type": "boolean"
},
"transactionalSendingUsable": {
"type": "boolean"
},
"marketingSendingUsable": {
"type": "boolean"
},
"marketingTrackingUsable": {
"type": "boolean"
},
"trackClicks": {
"type": "boolean"
},
"trackOpens": {
"type": "boolean"
},
"canDisableUnsafeMarketingTracking": {
"type": "boolean"
},
"unifiedDomainVerified": {
"type": "boolean"
},
"providerReadiness": {
"type": "object",
"properties": {
"configured": {
"type": "boolean"
},
"transactional": {
"type": "boolean"
},
"marketing": {
"type": "boolean"
},
"tracking": {
"type": "boolean"
},
"ready": {
"type": "boolean"
}
},
"additionalProperties": true
},
"blockingReasons": {
"type": "array",
"items": {
"type": "string"
}
},
"transactionalBlockingReasons": {
"type": "array",
"items": {
"type": "string"
}
},
"marketingBlockingReasons": {
"type": "array",
"items": {
"type": "string"
}
},
"trackingBlockingReasons": {
"type": "array",
"items": {
"type": "string"
}
},
"fallbackSender": {
"type": "string"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}Documented failures: 400, 401, 403, 404, 500, 503.
Operation errors: CUSTOM_SENDING_DOMAIN_REQUIRED, NO_SENDER_PROFILE_UPDATES, INVALID_SENDER_LOCAL_PART.
PUT
/api/developer/email-domains/sender-profiles
Update selected purpose-specific sender prefixes
- Auth
- Account Bearer JWT
- Scope
- domains.view plus domains.manage and all-products workspace scope; effective developer ownership.
- Request fields
- senderProfiles: object
- licensing: value
- notifications: value
- marketing: value
- Returns
- HTTP 200: settings.
- Notes
- At least one supported purpose must be provided. The same purpose fields are also accepted at the body root. PUT and PATCH share this sparse-update handler; omitted purposes remain unchanged. An active custom domain is required. Saving a sender profile does not verify DNS or send a message.
Request, response and error reference
Request (application/json)
{
"type": "object",
"properties": {
"senderProfiles": {
"type": "object",
"properties": {
"licensing": {
"anyOf": [
{
"type": "string"
},
{
"type": "object",
"properties": {
"localPart": {
"type": "string"
}
},
"required": [
"localPart"
],
"additionalProperties": true
},
{
"type": "object",
"properties": {
"local_part": {
"type": "string"
}
},
"required": [
"local_part"
],
"additionalProperties": true
}
]
},
"notifications": {
"anyOf": [
{
"type": "string"
},
{
"type": "object",
"properties": {
"localPart": {
"type": "string"
}
},
"required": [
"localPart"
],
"additionalProperties": true
},
{
"type": "object",
"properties": {
"local_part": {
"type": "string"
}
},
"required": [
"local_part"
],
"additionalProperties": true
}
]
},
"marketing": {
"anyOf": [
{
"type": "string"
},
{
"type": "object",
"properties": {
"localPart": {
"type": "string"
}
},
"required": [
"localPart"
],
"additionalProperties": true
},
{
"type": "object",
"properties": {
"local_part": {
"type": "string"
}
},
"required": [
"local_part"
],
"additionalProperties": true
}
]
}
},
"additionalProperties": true
},
"licensing": {
"anyOf": [
{
"type": "string"
},
{
"type": "object",
"properties": {
"localPart": {
"type": "string"
}
},
"required": [
"localPart"
],
"additionalProperties": true
},
{
"type": "object",
"properties": {
"local_part": {
"type": "string"
}
},
"required": [
"local_part"
],
"additionalProperties": true
}
]
},
"notifications": {
"anyOf": [
{
"type": "string"
},
{
"type": "object",
"properties": {
"localPart": {
"type": "string"
}
},
"required": [
"localPart"
],
"additionalProperties": true
},
{
"type": "object",
"properties": {
"local_part": {
"type": "string"
}
},
"required": [
"local_part"
],
"additionalProperties": true
}
]
},
"marketing": {
"anyOf": [
{
"type": "string"
},
{
"type": "object",
"properties": {
"localPart": {
"type": "string"
}
},
"required": [
"localPart"
],
"additionalProperties": true
},
{
"type": "object",
"properties": {
"local_part": {
"type": "string"
}
},
"required": [
"local_part"
],
"additionalProperties": true
}
]
}
},
"additionalProperties": true,
"anyOf": [
{
"required": [
"senderProfiles"
]
},
{
"required": [
"licensing"
]
},
{
"required": [
"notifications"
]
},
{
"required": [
"marketing"
]
}
]
}HTTP 200 response (application/json)
{
"type": "object",
"properties": {
"settings": {
"type": "object",
"properties": {
"supportEmail": {
"type": "string"
},
"supportEmailPresent": {
"type": "boolean"
},
"brandDomainOwnershipReady": {
"type": "boolean"
},
"customDomain": {
"type": [
"object",
"null"
],
"properties": {
"id": {
"type": "integer",
"minimum": 1
},
"domain": {
"type": "string"
},
"fromLocalPart": {
"type": "string"
},
"senderEmail": {
"type": "string"
},
"status": {
"type": "string"
},
"verified": {
"type": "boolean"
},
"elasticStatus": {
"type": "string"
},
"elasticVerified": {
"type": "boolean"
},
"unifiedVerified": {
"type": "boolean"
},
"dnsRecords": {
"type": "array",
"items": {
"type": "object",
"properties": {
"provider": {
"type": "string"
},
"record": {
"type": "string"
},
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"value": {
"type": "string"
},
"ttl": {
"type": [
"string",
"number"
]
},
"priority": {
"type": [
"number",
"null"
]
},
"status": {
"type": "string"
}
},
"additionalProperties": true
}
},
"providerVerification": {
"type": "object",
"properties": {
"resend": {
"type": "object",
"properties": {
"provider": {
"type": "string"
},
"status": {
"type": "string"
},
"verified": {
"type": "boolean"
},
"dnsRecords": {
"type": "array",
"items": {
"type": "object",
"properties": {
"provider": {
"type": "string"
},
"record": {
"type": "string"
},
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"value": {
"type": "string"
},
"ttl": {
"type": [
"string",
"number"
]
},
"priority": {
"type": [
"number",
"null"
]
},
"status": {
"type": "string"
}
},
"additionalProperties": true
}
},
"verifiedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"lastCheckedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"lastError": {
"type": [
"string",
"null"
]
},
"metadata": {
"type": "object",
"properties": {
"sendingEnabled": {
"type": "boolean"
},
"sendingReady": {
"type": "boolean"
},
"trackingReady": {
"type": "boolean"
},
"trackingCertificateReady": {
"type": "boolean"
},
"certificateExpiresAt": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
},
"elastic": {
"type": "object",
"properties": {
"provider": {
"type": "string"
},
"status": {
"type": "string"
},
"verified": {
"type": "boolean"
},
"dnsRecords": {
"type": "array",
"items": {
"type": "object",
"properties": {
"provider": {
"type": "string"
},
"record": {
"type": "string"
},
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"value": {
"type": "string"
},
"ttl": {
"type": [
"string",
"number"
]
},
"priority": {
"type": [
"number",
"null"
]
},
"status": {
"type": "string"
}
},
"additionalProperties": true
}
},
"verifiedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"lastCheckedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"lastError": {
"type": [
"string",
"null"
]
},
"metadata": {
"type": "object",
"properties": {
"sendingEnabled": {
"type": "boolean"
},
"sendingReady": {
"type": "boolean"
},
"trackingReady": {
"type": "boolean"
},
"trackingCertificateReady": {
"type": "boolean"
},
"certificateExpiresAt": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}
},
"additionalProperties": true
},
"providerReadErrors": {
"type": "object",
"properties": {
"resend": {
"type": "string"
},
"elastic": {
"type": "string"
}
},
"additionalProperties": true
},
"verifiedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"lastCheckedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"lastError": {
"type": [
"string",
"null"
]
}
},
"additionalProperties": true
},
"domainStatus": {
"type": [
"string",
"null"
]
},
"marketingDomainStatus": {
"type": [
"string",
"null"
]
},
"senderProfiles": {
"type": "object",
"properties": {
"licensing": {
"type": "object",
"properties": {
"purpose": {
"enum": [
"licensing",
"notifications",
"marketing"
]
},
"label": {
"type": "string"
},
"localPart": {
"type": "string"
},
"fromEmail": {
"type": "string"
},
"editable": {
"type": "boolean"
}
},
"additionalProperties": true
},
"notifications": {
"type": "object",
"properties": {
"purpose": {
"enum": [
"licensing",
"notifications",
"marketing"
]
},
"label": {
"type": "string"
},
"localPart": {
"type": "string"
},
"fromEmail": {
"type": "string"
},
"editable": {
"type": "boolean"
}
},
"additionalProperties": true
},
"marketing": {
"type": "object",
"properties": {
"purpose": {
"enum": [
"licensing",
"notifications",
"marketing"
]
},
"label": {
"type": "string"
},
"localPart": {
"type": "string"
},
"fromEmail": {
"type": "string"
},
"editable": {
"type": "boolean"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
},
"customSendingUsable": {
"type": "boolean"
},
"transactionalSendingUsable": {
"type": "boolean"
},
"marketingSendingUsable": {
"type": "boolean"
},
"marketingTrackingUsable": {
"type": "boolean"
},
"trackClicks": {
"type": "boolean"
},
"trackOpens": {
"type": "boolean"
},
"canDisableUnsafeMarketingTracking": {
"type": "boolean"
},
"unifiedDomainVerified": {
"type": "boolean"
},
"providerReadiness": {
"type": "object",
"properties": {
"configured": {
"type": "boolean"
},
"transactional": {
"type": "boolean"
},
"marketing": {
"type": "boolean"
},
"tracking": {
"type": "boolean"
},
"ready": {
"type": "boolean"
}
},
"additionalProperties": true
},
"blockingReasons": {
"type": "array",
"items": {
"type": "string"
}
},
"transactionalBlockingReasons": {
"type": "array",
"items": {
"type": "string"
}
},
"marketingBlockingReasons": {
"type": "array",
"items": {
"type": "string"
}
},
"trackingBlockingReasons": {
"type": "array",
"items": {
"type": "string"
}
},
"fallbackSender": {
"type": "string"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}Documented failures: 400, 401, 403, 404, 500, 503.
Operation errors: CUSTOM_SENDING_DOMAIN_REQUIRED, NO_SENDER_PROFILE_UPDATES, INVALID_SENDER_LOCAL_PART.
POST
/api/developer/email-domains/{domainId}/refresh
Refresh provider verification for an owned sending domain
- Auth
- Account Bearer JWT
- Scope
- domains.view plus domains.manage and all-products workspace scope; effective developer ownership.
- Returns
- HTTP 200: domain, settings, reusedResendDomain, resendError, elasticError.
- Notes
- Triggers provider verification and persists the observed results. A disabled domain cannot be refreshed. Can recreate a missing provider domain; inspect resendError, elasticError and settings rather than assuming HTTP success means ready. No DNS propagation time is promised.
Request, response and error reference
No request body fields are read by this operation.
HTTP 200 response (application/json)
{
"type": "object",
"properties": {
"domain": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
},
"domain": {
"type": "string"
},
"fromLocalPart": {
"type": "string"
},
"senderEmail": {
"type": "string"
},
"status": {
"type": "string"
},
"verified": {
"type": "boolean"
},
"elasticStatus": {
"type": "string"
},
"elasticVerified": {
"type": "boolean"
},
"unifiedVerified": {
"type": "boolean"
},
"dnsRecords": {
"type": "array",
"items": {
"type": "object",
"properties": {
"provider": {
"type": "string"
},
"record": {
"type": "string"
},
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"value": {
"type": "string"
},
"ttl": {
"type": [
"string",
"number"
]
},
"priority": {
"type": [
"number",
"null"
]
},
"status": {
"type": "string"
}
},
"additionalProperties": true
}
},
"providerVerification": {
"type": "object",
"properties": {
"resend": {
"type": "object",
"properties": {
"provider": {
"type": "string"
},
"status": {
"type": "string"
},
"verified": {
"type": "boolean"
},
"dnsRecords": {
"type": "array",
"items": {
"type": "object",
"properties": {
"provider": {
"type": "string"
},
"record": {
"type": "string"
},
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"value": {
"type": "string"
},
"ttl": {
"type": [
"string",
"number"
]
},
"priority": {
"type": [
"number",
"null"
]
},
"status": {
"type": "string"
}
},
"additionalProperties": true
}
},
"verifiedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"lastCheckedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"lastError": {
"type": [
"string",
"null"
]
},
"metadata": {
"type": "object",
"properties": {
"sendingEnabled": {
"type": "boolean"
},
"sendingReady": {
"type": "boolean"
},
"trackingReady": {
"type": "boolean"
},
"trackingCertificateReady": {
"type": "boolean"
},
"certificateExpiresAt": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
},
"elastic": {
"type": "object",
"properties": {
"provider": {
"type": "string"
},
"status": {
"type": "string"
},
"verified": {
"type": "boolean"
},
"dnsRecords": {
"type": "array",
"items": {
"type": "object",
"properties": {
"provider": {
"type": "string"
},
"record": {
"type": "string"
},
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"value": {
"type": "string"
},
"ttl": {
"type": [
"string",
"number"
]
},
"priority": {
"type": [
"number",
"null"
]
},
"status": {
"type": "string"
}
},
"additionalProperties": true
}
},
"verifiedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"lastCheckedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"lastError": {
"type": [
"string",
"null"
]
},
"metadata": {
"type": "object",
"properties": {
"sendingEnabled": {
"type": "boolean"
},
"sendingReady": {
"type": "boolean"
},
"trackingReady": {
"type": "boolean"
},
"trackingCertificateReady": {
"type": "boolean"
},
"certificateExpiresAt": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}
},
"additionalProperties": true
},
"providerReadErrors": {
"type": "object",
"properties": {
"resend": {
"type": "string"
},
"elastic": {
"type": "string"
}
},
"additionalProperties": true
},
"verifiedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"lastCheckedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"lastError": {
"type": [
"string",
"null"
]
}
},
"additionalProperties": true
},
"settings": {
"type": "object",
"properties": {
"supportEmail": {
"type": "string"
},
"supportEmailPresent": {
"type": "boolean"
},
"brandDomainOwnershipReady": {
"type": "boolean"
},
"customDomain": {
"type": [
"object",
"null"
],
"properties": {
"id": {
"type": "integer",
"minimum": 1
},
"domain": {
"type": "string"
},
"fromLocalPart": {
"type": "string"
},
"senderEmail": {
"type": "string"
},
"status": {
"type": "string"
},
"verified": {
"type": "boolean"
},
"elasticStatus": {
"type": "string"
},
"elasticVerified": {
"type": "boolean"
},
"unifiedVerified": {
"type": "boolean"
},
"dnsRecords": {
"type": "array",
"items": {
"type": "object",
"properties": {
"provider": {
"type": "string"
},
"record": {
"type": "string"
},
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"value": {
"type": "string"
},
"ttl": {
"type": [
"string",
"number"
]
},
"priority": {
"type": [
"number",
"null"
]
},
"status": {
"type": "string"
}
},
"additionalProperties": true
}
},
"providerVerification": {
"type": "object",
"properties": {
"resend": {
"type": "object",
"properties": {
"provider": {
"type": "string"
},
"status": {
"type": "string"
},
"verified": {
"type": "boolean"
},
"dnsRecords": {
"type": "array",
"items": {
"type": "object",
"properties": {
"provider": {
"type": "string"
},
"record": {
"type": "string"
},
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"value": {
"type": "string"
},
"ttl": {
"type": [
"string",
"number"
]
},
"priority": {
"type": [
"number",
"null"
]
},
"status": {
"type": "string"
}
},
"additionalProperties": true
}
},
"verifiedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"lastCheckedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"lastError": {
"type": [
"string",
"null"
]
},
"metadata": {
"type": "object",
"properties": {
"sendingEnabled": {
"type": "boolean"
},
"sendingReady": {
"type": "boolean"
},
"trackingReady": {
"type": "boolean"
},
"trackingCertificateReady": {
"type": "boolean"
},
"certificateExpiresAt": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
},
"elastic": {
"type": "object",
"properties": {
"provider": {
"type": "string"
},
"status": {
"type": "string"
},
"verified": {
"type": "boolean"
},
"dnsRecords": {
"type": "array",
"items": {
"type": "object",
"properties": {
"provider": {
"type": "string"
},
"record": {
"type": "string"
},
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"value": {
"type": "string"
},
"ttl": {
"type": [
"string",
"number"
]
},
"priority": {
"type": [
"number",
"null"
]
},
"status": {
"type": "string"
}
},
"additionalProperties": true
}
},
"verifiedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"lastCheckedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"lastError": {
"type": [
"string",
"null"
]
},
"metadata": {
"type": "object",
"properties": {
"sendingEnabled": {
"type": "boolean"
},
"sendingReady": {
"type": "boolean"
},
"trackingReady": {
"type": "boolean"
},
"trackingCertificateReady": {
"type": "boolean"
},
"certificateExpiresAt": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}
},
"additionalProperties": true
},
"providerReadErrors": {
"type": "object",
"properties": {
"resend": {
"type": "string"
},
"elastic": {
"type": "string"
}
},
"additionalProperties": true
},
"verifiedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"lastCheckedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"lastError": {
"type": [
"string",
"null"
]
}
},
"additionalProperties": true
},
"domainStatus": {
"type": [
"string",
"null"
]
},
"marketingDomainStatus": {
"type": [
"string",
"null"
]
},
"senderProfiles": {
"type": "object",
"properties": {
"licensing": {
"type": "object",
"properties": {
"purpose": {
"enum": [
"licensing",
"notifications",
"marketing"
]
},
"label": {
"type": "string"
},
"localPart": {
"type": "string"
},
"fromEmail": {
"type": "string"
},
"editable": {
"type": "boolean"
}
},
"additionalProperties": true
},
"notifications": {
"type": "object",
"properties": {
"purpose": {
"enum": [
"licensing",
"notifications",
"marketing"
]
},
"label": {
"type": "string"
},
"localPart": {
"type": "string"
},
"fromEmail": {
"type": "string"
},
"editable": {
"type": "boolean"
}
},
"additionalProperties": true
},
"marketing": {
"type": "object",
"properties": {
"purpose": {
"enum": [
"licensing",
"notifications",
"marketing"
]
},
"label": {
"type": "string"
},
"localPart": {
"type": "string"
},
"fromEmail": {
"type": "string"
},
"editable": {
"type": "boolean"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
},
"customSendingUsable": {
"type": "boolean"
},
"transactionalSendingUsable": {
"type": "boolean"
},
"marketingSendingUsable": {
"type": "boolean"
},
"marketingTrackingUsable": {
"type": "boolean"
},
"trackClicks": {
"type": "boolean"
},
"trackOpens": {
"type": "boolean"
},
"canDisableUnsafeMarketingTracking": {
"type": "boolean"
},
"unifiedDomainVerified": {
"type": "boolean"
},
"providerReadiness": {
"type": "object",
"properties": {
"configured": {
"type": "boolean"
},
"transactional": {
"type": "boolean"
},
"marketing": {
"type": "boolean"
},
"tracking": {
"type": "boolean"
},
"ready": {
"type": "boolean"
}
},
"additionalProperties": true
},
"blockingReasons": {
"type": "array",
"items": {
"type": "string"
}
},
"transactionalBlockingReasons": {
"type": "array",
"items": {
"type": "string"
}
},
"marketingBlockingReasons": {
"type": "array",
"items": {
"type": "string"
}
},
"trackingBlockingReasons": {
"type": "array",
"items": {
"type": "string"
}
},
"fallbackSender": {
"type": "string"
}
},
"additionalProperties": true
},
"reusedResendDomain": {
"type": "boolean"
},
"resendError": {
"type": "boolean"
},
"elasticError": {
"type": "boolean"
}
},
"additionalProperties": true
}Documented failures: 400, 401, 403, 404, 500, 503.
Operation errors: INVALID_EMAIL_DOMAIN_ID, EMAIL_DOMAIN_NOT_FOUND, EMAIL_DOMAIN_DISABLED, RESEND_NOT_CONFIGURED.
Read each domain setup area separately
The guided setup reports Website / Storefront, Email, Tracking and Verification separately. Tracking here means branded email-link tracking DNS, not optional Google Analytics. Required DNS records must be verified, but overall readiness also needs provider activation, active storefront SSL, secure email-link tracking and a completed sender identity. Four green DNS areas alone do not prove the whole setup is ready.
A required record with an error needs attention. Pending records keep setup in progress; an optional skipped record is not a required verification. The guide returns to the next incomplete required step instead of treating a saved Review step as proof everything is connected. Refresh status when no confirmed next step is shown.
Website DNS, SSL and email are different checks
A working storefront hostname does not prove email authentication, branded tracking or ownership verification is complete. Check the Website / Storefront area and the storefront DNS and SSL status for customer traffic, then review each remaining area for its own purpose. A DNS match does not mean an SSL certificate is already active.
Use the exact hostname and records returned for your apex domain or selected subdomain. SoundSync handles supported hosting and SSL provisioning; you need control of the domain and DNS. Existing DNS, propagation and certificate readiness can affect the connection. Neither a successful save nor an HTTP 200 promises a propagation deadline.
SoundSync
From your domain to a ready connection
-
Choose the hostname
Enter the root domain and choose @ for the main domain or the supported subdomain you want. Keep unrelated website and mail records safe.
-
Let SoundSync prepare the providers
The interface registers the storefront and sending domain and retrieves their exact routing, DKIM, return-path, tracking and ownership records. Preparing your exact DNS records is not a request for your registrar password.
-
Copy the displayed records
Add the available records while SoundSync retrieves any remaining provider records. Only missing values stay unavailable for copying. Use the exact host and value shown; do not invent a target or replace your existing inbox MX records with the sending return-path records.
-
Check DNS and hosting
Follow the current required step. Hosting verification runs while the page is open; DNS matching and SSL issuance can finish at different times.
-
Finish branded sending and tracking
Transactional and marketing verification are separate. Secure email-link tracking also needs its own certificate; a storefront certificate does not activate it.
-
Save the sender identity
Set the support address and the licensing, notification and marketing sender local parts. Use the combined readiness result, not a saved Review step, before announcing completion.
SoundSync
When setup needs another step
| What you see | What to do |
|---|---|
| Preparing your exact DNS records | Add any available records now. Review the missing-record list and use Retry provider setup or Refresh remaining records if preparation needs another attempt. Missing provider records are not fixed by adding a guessed DNS value. |
| Connect and verify your storefront host | Use Retry hosting verification and review the displayed error. The hostname must be registered with hosting and show active DNS and SSL. |
| Waiting for email provider verification | SoundSync polls the existing provider checks after DNS passes instead of restarting verification. Use Check provider status or View provider status to see whether transactional email, marketing or the tracking SSL certificate is pending. Keep the verified DNS records in place; sender addresses do not need separate DNS records. Use View DNS setup instructions only when DNS records are still missing. A tracking certificate can take additional time after DNS verifies. |
| Finish your email sender identity | Save the support address and the three sender purposes for the selected domain. Verified providers alone do not complete this identity step. |
| Waiting for tracking SSL activation | Sending providers can be verified while the tracking certificate is still pending. Keep the tracking DNS record in place and check provider status; do not replace verified email records. When providers are pending, the interface can show View provider status and wait times. These are estimates, not guaranteed completion deadlines. |
| Provider setup still fails | Check the displayed provider error and contact SoundSync with the domain and safe error details. Do not share provider credentials or private verification values in a public report. |
SoundSync
Protect existing email DNS
| Record or copy instruction | Safe setup |
|---|---|
| SPF: one policy per hostname | Keep one v=spf1 TXT policy at each exact hostname. Merge the required include mechanisms before the final ~all or -all; do not paste a second complete policy or duplicate the version/all terms. Review the proposed replacement and previous value before saving. |
| DMARC: preserve your policy | Keep a valid existing DMARC record, including its policy and reporting addresses. Do not create a second record or overwrite it with a generic example. Correct an invalid or conflicting policy before continuing. |
| Copy plan: create / replace / preserve / blocked | Create adds a missing record. Replace proposes the combined value for an existing record. Preserve means keep the existing policy. Blocked means resolve the displayed conflict before copying; do not overwrite DNS blindly. A missing provider value is also unavailable for copying. |
| MX: priority and exchange | Enter the displayed numeric priority separately from the mail-server exchange. A sending return-path MX belongs at its exact return-path host, not at the root inbox hostname. Keep existing inbox delivery records. |
| DKIM and DNS hostnames | Use the exact current provider record type, host and value. DKIM may use TXT, not necessarily CNAME. A DNS console may expect a relative host or a full hostname; avoid adding your domain twice. Never guess a provider target from a screenshot. |
SoundSync
Finish provider and secure tracking verification
Actual current SoundSync domain interface, captured locally with example.com and sanitized sample records. This illustrates the workflow, not a live customer-domain verification.
Separate email-domain management
The sending-domain API at /api/developer/email-domains is separate from the combined Brand Manager wizard and the website storefront-domain API. List/settings require domains.view and all-products scope; creates, refreshes and sender-profile saves additionally require domains.manage. Domain ownership is always resolved from the effective developer workspace.
Inspect providerVerification.resend for transactional sending and providerVerification.elastic for marketing. settings separates transactionalSendingUsable, marketingSendingUsable, marketingTrackingUsable, blockingReasons and trackingBlockingReasons. A website SSL certificate, HTTP 201 or a saved sender prefix does not by itself establish email readiness. Reads can refresh provider state or initialize default profiles; creation can replace the active domain. No DNS propagation or automatic readiness deadline is promised.
Read DNS records and action steps
currentStep may be null, a DNS row, or a provider/sender action. records can contain both DNS rows and action steps. stepKey identifies the check; featureKey groups website, email, tracking or verification. required and status describe progress. action identifies preparation, storefront-provider, email-providers or email-identity work; do not add an action to your DNS zone.
A DNS row supplies type, host/name, value, ttl and, for MX, separate priority and exchange. Follow copyPlan.mode before copying: create adds a missing policy, replace uses the merged value with previousValue for review, preserve keeps the existing policy, and blocked requires resolving message first. copyBlocked also disables a missing provider value. A returned record.value is not permission to overwrite an existing SPF or DMARC policy.
Inspect errorMessage, lastCheckedAt and verifiedAt with the current readiness result. Records can be incomplete during provider preparation; optional fields and conditional MX/copy-plan fields are not present on every step. Never infer SSL, provider verification or sender identity from a successful DNS-copy action.
SoundSync
DNS check outcomes
| Response | Meaning and recovery |
|---|---|
| Nonempty stepKey on POST /check-step | Checks that record. step_key is an alias; copy the key from current returned records. |
| Omitted or empty key on POST /check-step | Checks all required or non-skipped records, not only currentStep. Supply a key for one-record checking. |
| 429 DNS_CHECK_COOLDOWN | Checks have an eight-second cooldown. Wait before retrying; do not loop or restart provider setup. |
| 409 DNS_SETUP_CHANGED | The saved setup changed during the check. Reload GET /api/developer/brand/domain, review current records, then deliberately retry. |
| 404 DNS_STEP_NOT_FOUND | The supplied key is absent from current setup. Reload rather than guessing another key. |
| 200 with pending/error records | Observed results were saved, not necessarily verified. DNS, provider activation, tracking SSL and identity are separate checks. |
SoundSync
Check one DNS record deliberately
Use a stepKey from current records; checking persists observations
curl --fail-with-body -sS -X POST "$SOUNDSYNC_API_BASE/api/developer/brand/domain/check-step" \
-H "Authorization: Bearer $DEVELOPER_TOKEN" \
-H "Content-Type: application/json" \
--data '{"stepKey":"website_storefront_cname"}'Sending readiness is specific to the email purpose
Use transactionalSendingUsable and transactionalBlockingReasons for receipts/licensing notices; use marketingSendingUsable and marketingBlockingReasons for campaigns and Growth Flows. Legacy combined blockingReasons can include the other provider. A transactional-provider problem alone does not prove verified marketing sending is blocked.
marketingTrackingUsable is separate from sending. If tracking TLS is not ready, the service sets trackClicks:false and trackOpens:false. Marketing can proceed without that tracking only when the configured provider supports explicitly disabling it; otherwise sending remains blocked. A local checkbox cannot bypass provider TLS checks. This guide does not enable or change provider configuration.
Full Brand Domain readiness still requires complete DNS, website SSL, email/tracking and identity checks. A usable single sending purpose is not completion of the whole wizard. A tracking certificate must be trusted and unexpired; missing certificate status is not readiness. Email tracking is separate from GA4.
A provider lookup failure is not a missing DNS record
Read customDomain.providerReadErrors.resend and .elastic with providerVerification, lastError and lastCheckedAt. A timeout or mismatched provider domain is a lookup problem, not proof that existing DNS must be replaced. Retained prior observations are not a new verification result.
Provider reads are bounded and cached. The read helper uses GET without creating domains, starting verification or persisting provider results. Surrounding settings reads can initialize sender profiles, so the endpoint is not a zero-write health probe. Explicit prepare/refresh operations are separate writes. Keep credentials private and retry the intended status read before resetting a working domain.
SoundSync
Domain wizard permissions
| Operation | Required workspace access |
|---|---|
| Read wizard state or events | domains.view and all-products scope. Domain configuration belongs to the workspace, not one assigned product. |
| Start, prepare, provider connection, record checking, identity/sender saves, progression or reset | domains.view + domains.manage and all-products scope. A selected-product role cannot write workspace-wide DNS configuration. |
| 403 developer_team_permission_denied / developer_team_all_products_scope_required | Ask the workspace owner for the appropriate existing access. Retrying with another product ID does not change workspace scope. |