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.
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.
Add an IP to an authenticated domain
POST /v3/whitelabel/domains/{id}/ips
Base url: https://api.sendgrid.com
This endpoint allows you to add an IP address to an authenticated domain.
Authentication
- API Key
Headers
The on-behalf-of
header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id <account-id>
). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: <subuser-username>
). See On Behalf Of for more information.
Request Body
IP to associate with the domain. Used for manually specifying IPs for custom SPF.
{
"ip": "192.168.0.1"
}
Path Parameters
ID of the domain to which you are adding an IP
default: NoneResponses
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.
Designates which mail server is responsible for accepting messages from a domain.
The domain sending the messages.
They type of DNS record.
The mail server responsible for accepting messages from the sending domain.
Indicates if this is a valid DNS record.
The SPF record for the subdomain used to create this authenticated domain.
The domain that this SPF record will be used to authenticate.
The type of data in the SPF record.
The SPF record.
Indicates if this is a valid SPF record.
The SPF record for the root domain.
The root domain that this SPF record will be used to authenticate.
The type of data in the SPF record.
The SPF record.
Indicates if the SPF record is valid.
The DKIM record for messages sent using this authenticated domain.
The DNS labels for the DKIM signature.
The type of data in the DKIM record.
The DKIM record.
Indicates if the DKIM record is valid.
Need some help?
We all do sometimes. Get help now from the Twilio SendGrid Support Team.
Running into a coding hurdle? Lean on the wisdom of the crowd by browsing the SendGrid tag on Stack Overflow or visiting Twilio's Stack Overflow Collective.