An authenticated domain allows you to remove the "via" or "sent on behalf of" message that your recipients see when they read your emails. Authenticating a domain allows you to replace sendgrid.net with your personal sending domain. You will be required to create a subdomain so that SendGrid can generate the DNS records which you must give to your host provider. If you choose to use Automated Security, SendGrid will provide you with 3 CNAME records. If you turn Automated Security off, you will get 2 TXT records and 1 MX record.
Domain Authentication was formerly called "Domain Whitelabel".
For more information, please see How to set up domain authentication.
Each user may have a maximum of 3,000 authenticated domains and 3,000 link brandings. This limit is at the user level, meaning each Subuser belonging to a parent account may have its own 3,000 authenticated domains and 3,000 link brandings.
This endpoint allows you to retrieve all of the authenticated domains that have been assigned to a specific subuser.
Authenticated domains can be associated with (i.e. assigned to) subusers from a parent account. This functionality allows subusers to send mail using their parent's domain. To associate an authenticated domain with a subuser, the parent account must first authenticate and validate the domain. The parent may then associate the authenticated domain via the subuser management tools.
Note that if you used the /v3/whitelabel/domains/{domain_id}/subuser:add endpoint to add multiple domains to the subuser, you can use the /v3/whitelabel/domains/subuser/all endpoint to list those associated domains.
Bearer <<YOUR_API_KEY_HERE>>Username for the subuser to find associated authenticated domain.
The ID of the authenticated domain.
The domain authenticated.
The subdomain that was used to create this authenticated domain.
The username of the account that this authenticated domain is associated with.
The user_id of the account that this authenticated domain is associated with.
The IP addresses that are included in the SPF record for this authenticated domain.
Indicates if this authenticated domain uses custom SPF.
Indicates if this is the default domain.
Indicates if this authenticated domain was created using the legacy whitelabel tool. If it is a legacy whitelabel, it will still function, but you'll need to create a new authenticated domain if you need to update it.
Indicates if this authenticated domain uses automated security.
Indicates if this is a valid authenticated domain .
The DNS records for this authenticated domain.
1const client = require("@sendgrid/client");2client.setApiKey(process.env.SENDGRID_API_KEY);34const queryParams = {5username: "ZGkrHSypTsudrGkmdpJJ",6};78const request = {9url: `/v3/whitelabel/domains/subuser`,10method: "GET",11qs: queryParams,12};1314client15.request(request)16.then(([response, body]) => {17console.log(response.statusCode);18console.log(response.body);19})20.catch((error) => {21console.error(error);22});