Menu

Domain Authentication

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.

Associate a authenticated domain with a given user

Associate a authenticated domain with a given user.

POST /whitelabel/domains/{domain_id}/subuser

This endpoint allows you to associate a specific authenticated domain with a 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 authentication. To associate a authenticated domain with a subuser, the parent account must first authenticate and validate the domain. The the parent may then associate the authenticated domain via the subuser management tools.

Authentication

  • API Key

Headers

Authorization
string
default: Bearer <<YOUR_API_KEY_HERE>>
required

Request Body

object
username
string

Username to associate with the authenticated domain.

required
{
  "username": "jdoe"
}

Path Parameters

domain_id
integer

ID of the authenticated domain to associate with the subuser

required

Responses

object
id
integer

The ID of the authenticated domain.

required
domain
string

The domain authenticated.

required
subdomain
string

The subdomain that was used to create this authenticated domain.

username
string

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

required
user_id
integer

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

required
ips
array[]

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

required
custom_spf
boolean

Indicates if this authenticated domain uses custom SPF.

required
default
boolean

Indicates if this is the default domain.

required
legacy
boolean

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.

required
automatic_security
boolean

Indicates if this authenticated domain uses automated security.

required
valid
boolean

Indicates if this is a valid authenticated domain .

required
dns
object

The DNS records for this authenticated domain.

required
mail_server
object

Designates which mail server is responsible for accepting messages from a domain.

required
host
string

The domain sending the messages.

required
type
string

They type of DNS record.

required
data
string

The mail server responsible for accepting messages from the sending domain.

required
valid
boolean

Indicates if this is a valid DNS record.

required
subdomain_spf
object

The SPF record for the subdomain used to create this authenticated domain.

required
host
string

The domain that this SPF record will be used to authenticate.

required
type
string

The type of data in the SPF record.

required
data
string

The SPF record.

required
valid
boolean

Indicates if this is a valid SPF record.

required
domain_spf
object

The SPF record for the root domain.

required
host
string

The root domain that this SPF record will be used to authenticate.

required
type
string

The type of data in the SPF record.

required
data
string

The SPF record.

required
valid
boolean

Indicates if the SPF record is valid.

required
dkim
object

The DKIM record for messages sent using this authenticated domain.

required
host
string

The DNS labels for the DKIM signature.

required
type
string

The type of data in the DKIM record.

required
data
string

The DKIM record.

required
valid
boolean

Indicates if the DKIM record is valid.

required

Need some help?

We all do sometimes; code is hard. Get help now from our support team, or lean on the wisdom of the crowd browsing the SendGrid tag on Stack Overflow.