Retrieve a subuser's branded link
To serve all of the click-tracked links, opens, and images in your emails from your domain, use Email link branding. This replaces sendgrid.net for Global Email send or eu.sendgrid.net for Regional Email send with your domain. To determine whether the email looks trustworthy, spam filters and recipient servers look at the links within emails. To determine if they can trust the links, these systems check the reputation of the root domain.
To manage link branding, go to the Sender Authentication section of the Twilio SendGrid App.
To learn more, see How to set up link branding.
GET/v3/whitelabel/links/subuser
Base url: https://api.sendgrid.com (for global users and subusers)
Base url: https://api.eu.sendgrid.com (for EU regional subusers)
This endpoint allows you to retrieve the branded link associated with a subuser.
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 then 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 username of the subuser to retrieve associated branded links for.
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 queryParams = { username: "username" };56const request = {7url: `/v3/whitelabel/links/subuser`,8method: "GET",9qs: queryParams,10};1112client13.request(request)14.then(([response, body]) => {15console.log(response.statusCode);16console.log(response.body);17})18.catch((error) => {19console.error(error);20});