Link Branding
Email link branding (formerly "Link Whitelabel") allows all of the click-tracked links, opens, and images in your emails to be served from your domain rather than sendgrid.net. Spam filters and recipient servers look at the links within emails to determine whether the email looks trustworthy. They use the reputation of the root domain to determine whether the links can be trusted.
You can also manage link branding in the Sender Authentication section of the Twilio SendGrid App.
For more information, please see our Link Branding documentation.
Create a branded link
POST /v3/whitelabel/links
Base url: https://api.sendgrid.com
This endpoint allows you to create a new branded link.
To create the link branding, supply the root domain and, optionally, the subdomain — these go into separate fields in your request body. The root domain should match your FROM email address. If you provide a subdomain, it must be different from the subdomain you used for authenticating your domain.
You can submit this request as one of your subusers if you include their ID in the on-behalf-of header in the request.
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
The root domain for the subdomain that you are creating the link branding for. This should match your FROM email address.
The subdomain to create the link branding for. Must be different from the subdomain you used for authenticating your domain.
Indicates if you want to use this link branding as the default or fallback. When setting a new default, the existing default link branding will have its default status removed automatically.
Allowed Values: true, falseThe region of the link. Can be either global or eu. (Regional email is in Public Beta and requires SendGrid Pro plan or above.)
{
"domain": "example.com",
"subdomain": "mail",
"default": true
}Responses
The ID of the branded link.
The root domain of the branded link.
The subdomain used to generate the DNS records for this link branding. This subdomain must be different from the subdomain used for your authenticated domain.
The username of the account that this link branding is associated with.
The ID of the user that this link branding is associated with.
Indicates if this is the default link branding.
Allowed Values: true, falseIndicates if this link branding is valid.
Allowed Values: true, falseIndicates if this link branding was created using the legacy whitelabel tool. If it is a legacy whitelabel, it will still function, but you'll need to create new link branding if you need to update it.
Allowed Values: true, falseThe DNS records generated for this link branding.
The DNS record generated to point to your link branding subdomain.
Indicates if the DNS record is valid.
Allowed Values: true, falseThe type of DNS record that was generated.
Allowed Values: cname, txt, mxThe domain that this link branding will use for the links in your email.
The domain that the DNS record points to.
The DNS record generated to verify who created the link branding.
Indicates if the DNS record is valid.
Allowed Values: true, falseThe type of DNS record generated.
Allowed Values: cname, txt, mxUsed to verify the link branding. The subdomain of this domain is the ID of the user who created the link branding.
The domain that the DNS record points to.
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.
