Get Setup Link | PostNuvia

Build a one-click DNS setup link for the domain via the Domain Connect standard. When the domain’s DNS provider supports Domain Connect and carries the PostNuvia template, the response contains a signed URL: opening it lets the domain owner approve the required DNS records at their provider, which writes them automatically — no copy-paste. When the provider does not support it, supported is false and the domain’s records should be added manually instead.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

domain_idstringRequired

The ID of the domain.

Response

This endpoint returns an object.

supportedboolean

Whether one-click setup is available for this domain. false means the domain's DNS provider does not support Domain Connect (or does not carry the PostNuvia template yet) — add the domain's records manually instead.

provider_namestringOptional

Display name of the domain's DNS provider, for the setup button label.

urlstringOptional

The signed Domain Connect apply URL. Open it in a browser: the domain owner signs in at their DNS provider, reviews the records, and approves — the provider writes them.

widthintegerOptional

Suggested popup width from the provider, in pixels.

heightintegerOptional

Suggested popup height from the provider, in pixels.

statestringOptional

Opaque value echoed back on the provider's redirect. Store it before opening the URL and compare on return to tie the redirect to this request.

conflicting_providerstringOptional

Set when the domain currently has another email provider's MX records (for example Google Workspace). Applying the template would replace them — warn before proceeding.

Errors

404

Not Found Error

409

Conflict Error

422

Unprocessable Error