Skip to contentSkip to navigationSkip to topbar
Rate this page:
On this page

Associate an Authenticated Domain with a Subuser (for up to Five Domains)



API Overview

api-overview page anchor

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.

(information)

Info

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.


POST/v3/whitelabel/domains/{domain_id}/subuser:add

Base url: https://api.sendgrid.com

This endpoint allows you to associate a specific authenticated domain with a subuser. It can be used to associate up to five authenticated domains.

This functionality allows subusers to send mail using their parent's domain. Authenticated domains can be associated with (i.e. assigned to) subusers from a parent account. 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.

A subuser can have up to five associated authenticated domains. To see the domains that have already been associated with this user, you can use the API to list the domains currently associated with the subuser.

When selecting a domain to send email from, SendGrid checks for domains in the following order and chooses the first one that appears in the hierarchy:

  1. Domain assigned by the subuser that matches the email's From address domain.
  2. The subuser's default domain.
  3. Domain assigned by the parent user that matches the From address domain.
  4. Parent user's default domain.
  5. sendgrid.net

Authentication

authentication page anchor
Property nameTypeRequiredDescription
Authorizationstringrequired
Default: Bearer <<YOUR_API_KEY_HERE>>
Property nameTypeRequiredDescription
domain_idintegerrequired

ID of the authenticated domain to associate with the subuser.

SchemaExample
Property nameTypeRequiredDescriptionChild properties
usernamestringrequired

Username to associate with the authenticated domain.

201
SchemaExample
Property nameTypeRequiredDescriptionChild properties
idinteger

The ID of the authenticated domain.


domainstring

The domain authenticated.


subdomainstring

The subdomain that was used to create this authenticated domain.


usernamestring

The username of the account that this authenticated domain is associated with.


user_idinteger

The user_id of the account that this authenticated domain is associated with.


ipsarray

The IP addresses that are included in the SPF record for this authenticated domain.


custom_spfboolean

Indicates if this authenticated domain uses custom SPF.


defaultboolean

Indicates if this is the default domain.


legacyboolean

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.


automatic_securityboolean

Indicates if this authenticated domain uses automated security.


validboolean

Indicates if this is a valid authenticated domain .


dnsobject

The DNS records for this authenticated domain.

Associate an authenticated domain with a subuser, for up to five domains

associate-an-authenticated-domain-with-a-subuser-for-up-to-five-domains page anchor
Node.js
Python
C#
Java
Go
PHP
Ruby
curl

_22
const client = require('@sendgrid/client');
_22
client.setApiKey(process.env.SENDGRID_API_KEY);
_22
_22
const domain_id = 4900;
_22
const data = {
_22
"username": "jdoe"
_22
};
_22
_22
const request = {
_22
url: `/v3/whitelabel/domains/${domain_id}/subuser:add`,
_22
method: 'POST',
_22
body: data
_22
}
_22
_22
client.request(request)
_22
.then(([response, body]) => {
_22
console.log(response.statusCode);
_22
console.log(response.body);
_22
})
_22
.catch(error => {
_22
console.error(error);
_22
});


Rate this page: