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 for Global Email send or eu.sendgrid.net for Regional Email send. 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.
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.
Bearer <<YOUR_API_KEY_HERE>>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.
application/jsonThe 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.
truefalseThe region of the IP address. Can be eu or us.
usPossible values: euusThe 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.
truefalseIndicates if this link branding is valid.
truefalseIndicates 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.
truefalseThe DNS records generated for this link branding.
1const client = require('@sendgrid/client');2client.setApiKey(process.env.SENDGRID_API_KEY);34const data = {5"domain": "example.com",6"subdomain": "mail",7"default": true8};910const request = {11url: `/v3/whitelabel/links`,12method: 'POST',13body: data14}1516client.request(request)17.then(([response, body]) => {18console.log(response.statusCode);19console.log(response.body);20})21.catch(error => {22console.error(error);23});