Entri Sell enables your users to easily purchase a domain that is immediately configured to work with your application.
dnsRecords
object.
successCallbackUrl
: The URL to which the user will be redirected after a successful domain purchase.exitCallbackUrl
: The URL to which the user will be redirected if they select Close (X) before completing the purchase flow.purchaseDomain
method with your configuration object to open the Entri Purchase Domain Flow.
setupType
will be set to purchase
.
entri.purchaseDomain
method.
applicationId
(string):
A unique identifier for your application, available in the Entri dashboard.
Example: "12345"
token
(string):
A JWT token used for authentication and authorization.
Example: "JWT_TOKEN"
sellVersion
(string) (required):
The version of the domain purchase flow that should be shown. Setting this to "v3"
will activate the latest version with enhanced features.
Example: "v3"
successCallbackUrl
(string):
The URL to which the user will be redirected after a successful domain purchase.
The purchased domain will be added as a domain
query string parameter to the success callback URL.
Example: "https://myapplication.com/success"
(redirects to https://myapplication.com/success?domain=mydomain.com
)
exitCallbackUrl
(string):
The URL to which the user will be redirected if they select Close (X) before completing the purchase flow.
Example: "https://myapplication.com/exit"
dnsRecords
(array of objects):
An array containing DNS record objects. These records will applied after a successful domain purchase.
Example:
whiteLabel
(object):
Options for customizing the appearance of the domain purchase flow to match your brand.
theme
(object):
Customizes the colors used in the purchase flow.
primary
(string):
Main color used in your theme. It’s usually the most recognizable color in the interface.
Example: "#012939"
onPrimary
(string):
Color used for text and icons that appear on top of the primary color.
Example: "#ffffff"
secondary
(string):
Color that complements the primary color and is used for secondary UI elements.
Example: "#012939"
onSecondary
(string):
Color used for text and icons that appear on top of the secondary color.
Example: "#ffffff"
headerBackground
(string) (optional):
Background color of the header. Accepts any valid CSS color code (e.g., hex, rgb). If not defined, it will default to the primary color value.
Example: "#123456"
interactive
(string) (optional):
Color for interactive elements such as radio buttons. Accepts any valid CSS color code (e.g., hex, rgb).
Example: "#ffcc00"
premiumBadge
(string) (optional):
Background color of premium badge components. Accepts any valid CSS color code (e.g., hex, rgb).
Example: "#00ffcc"
onPremiumBadge
(string) (optional):
Text color on the premium badge. Accepts any valid CSS color code (e.g., hex, rgb).
Example: "#ffffff"
priceBadge
(string) (optional):"#ff6600"
onPriceBadge
(string) (optional):"#ffffff"
activating
(string) (optional):
Background color of the “Search Domain” button. Accepts any valid CSS color code (e.g., hex, rgb).
Example: "#ff4500"
onActivating
(string) (optional):
Text color on the “Search Domain” button. Accepts any valid CSS color code (e.g., hex, rgb).
Example: "#000000"
hideEntriLogo
(boolean):
Hide the Entri logo in the purchase flow.
Example: true
hideCompanyLogo
(boolean):
Hide the company logo in the purchase flow.
Example: true
hideCompanyName
(boolean):
Hide the company name in the purchase flow.
Example: true
customCopy
(object):
Custom text to be displayed in the purchase flow.
initialScreen.title.{locale}
(object):
Title text that appears on the initial screen of the domain purchase flow, localized by language.
Example: "Search for your domain"
initialScreen.marketingCopy.{locale}
(object):
Marketing copy that appears below the domain input field, localized by language.
Example: "Your website will look even better with a custom domain!"
whiteLabel.sell
(object):
Contains information specific to the cobranding and user data prefill in the domain purchase flow.
flowTarget
(string):
The target location where the purchase flow window will be displayed. If _blank is specified, the flow will open in a new browser tab.
Example: "_blank"
overlayScreenHeight
(string):
The percentage of the viewport height allocated to the search domain screen overlay.
Example: "80%"
partnerLogo
(string):
The URL of the partner’s logo, which will be displayed prominently in the cobranded header.
Example: "https://cdn.goentri.com/mylogo.svg"
partnerIcon
(string):
The URL of the partner’s icon, which will appear in the floating cart at the bottom of the page.
Example: "https://cdn.goentri.com/myicon.svg"
partnerName
(string):
The name of the partner company, displayed within the purchase flow.
Example: "My Company name"
contact
(object):
Prefilled user data to be used in the contact information form during domain creation. The following fields are supported:
firstName
(string): User’s first name.
Example: "John"
lastName
(string): User’s last name.
Example: "Doe"
email
(string): User’s email address.
Example: "john.doe@example.com"
phone
(string): User’s phone number.
Example: "+1234567890"
address
(string): User’s street address.
Example: "123 Main St"
zip
(string): User’s ZIP or postal code.
Example: "12345"
city
(string): User’s city.
Example: "Exampleville"
state
(string): User’s state or province.
Example: "EX"
postalCode
(string): User’s postal code.
Example: "12345"
country
(string): User’s country.
Example: "US"
freeDomain
(boolean):
Indicates whether the domain price should be set to $0. Should only be used on paid users at the customer’s platform.
Example: true
locale
(string):
The language/locale to be used in the domain purchase flow.
Example: "en"
freeDomain
freeDomain:false
or freeDomain:true
when you create the JWT. This way, the user gets explicit authorization for running the free domain flow.
If the client tries to use a config that doesn’t match the one hashed in the JWT, it will return an error. Here’s an example of how to use this when generating the JWT:
Property | Type | Required | Default | Description |
---|---|---|---|---|
freeDomain | boolean | No | N/A | When set to true , it will only allow Entri to run under the freeDomain flow. |
disableMailUpsell:true
in your configuration.
Example Configuration:
entri.purchaseDomain
functionality and would like to migrate to the new version, follow these steps to ensure a smooth transition:
sellVersion
sellVersion
Key:
Ensure that your configuration includes the sellVersion
key set to "v3"
. This will activate the new version of the domain purchase flow.
successCallbackUrl
and exitCallbackUrl
:
Define where users should be redirected after the domain purchase flow is completed, whether successfully or due to an error.
onSecondary
and secondary
keys, which control the colors of interactive elements like buttons.
sell
Object (Optional)sell
object with your partner branding and prefilled user data. This includes fields like partnerLogo
, partnerIcon
, partnerName
, and the contact
object.
entri.purchaseDomain
, unlocking enhanced customization and a better overall user experience.
debugMode: true
. This will allow you to avoid purchasing unnecessary domains while testing it. Keep in mind that you have to use a domain that was previously purchased via IONOS to use the DebugMode.
Please find more details on our /api-reference#entri-purchasedomain-config.