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.
Regional Email allows subusers to send emails using EU infrastructure. EU subusers can only use branded links for the EU.
This endpoint allows you to associate a branded link with a subuser account.
Link branding can be associated with subusers from the parent account. This functionality allows subusers to send mail using their parent's link branding. To associate link branding, the parent account must first create a branded link and validate it. The parent may then associate that branded link with a subuser via the API or the Subuser Management page of the Twilio SendGrid App.
Bearer <<YOUR_API_KEY_HERE>>The ID of the branded link you want to associate.
application/jsonOptional
The username of the subuser account that you want to associate the branded link with.
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.
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 link_id = 4900;5const data = {6username: "jane@example.com",7};89const request = {10url: `/v3/whitelabel/links/${link_id}/subuser`,11method: "POST",12body: data,13};1415client16.request(request)17.then(([response, body]) => {18console.log(response.statusCode);19console.log(response.body);20})21.catch((error) => {22console.error(error);23});