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 retrieve the default branded link.
The default branded link is the actual URL to be used when sending messages. If you have more than one branded link, the default is determined by the following order:
default (set when you call the "Create a branded link" endpoint or by calling the "Update a branded link" endpoint on an existing link)100.ct.sendgrid.net)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>>Optional
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.
Optional
The domain to match against when finding the default branded link.
Optional
The ID of the branded link.
Optional
The root domain of the branded link.
Optional
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.
Optional
The username of the account that this link branding is associated with.
Optional
The ID of the user that this link branding is associated with.
Optional
Indicates if this is the default link branding.
truefalseOptional
Indicates if this link branding is valid.
truefalseOptional
Indicates 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.
truefalseOptional
The DNS records generated for this link branding.
1const client = require("@sendgrid/client");2client.setApiKey(process.env.SENDGRID_API_KEY);34const request = {5url: `/v3/whitelabel/links/default`,6method: "GET",7};89client10.request(request)11.then(([response, body]) => {12console.log(response.statusCode);13console.log(response.body);14})15.catch((error) => {16console.error(error);17});