Skip to contentSkip to navigationSkip to topbar
On this page

Associate a branded link with a subuser



API Overview

api-overview page anchor

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(link takes you to an external page).

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.


POST/v3/whitelabel/links/{link_id}/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 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(link takes you to an external page).


Authentication

authentication page anchor
Property nameTypeRequiredDescription
Authorizationstringrequired
Default: Bearer <<YOUR_API_KEY_HERE>>
Property nameTypeRequiredDescription
link_idintegerrequired

The ID of the branded link you want to associate.

Encoding type:application/json
SchemaExample
Property nameTypeRequiredDescriptionChild properties
usernamestringOptional

The username of the subuser account that you want to associate the branded link with.

200
SchemaExample
Property nameTypeRequiredDescriptionChild properties
idinteger

The ID of the branded link.


domainstring

The root domain of the branded link.


subdomainstring

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.


usernamestring

The username of the account that this link branding is associated with.


user_idinteger

The ID of the user that this link branding is associated with.


defaultenum<boolean>

Indicates if this is the default link branding.

Possible values:
truefalse

validenum<boolean>

Indicates if this link branding is valid.

Possible values:
truefalse

legacyenum<boolean>

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.

Possible values:
truefalse

dnsobject

The DNS records generated for this link branding.

Associate a branded link with a subuserLink to code sample: Associate a branded link with a subuser
1
const client = require("@sendgrid/client");
2
client.setApiKey(process.env.SENDGRID_API_KEY);
3
4
const link_id = 4900;
5
const data = {
6
username: "jane@example.com",
7
};
8
9
const request = {
10
url: `/v3/whitelabel/links/${link_id}/subuser`,
11
method: "POST",
12
body: data,
13
};
14
15
client
16
.request(request)
17
.then(([response, body]) => {
18
console.log(response.statusCode);
19
console.log(response.body);
20
})
21
.catch((error) => {
22
console.error(error);
23
});

Need some help?

Terms of service

Copyright © 2024 Twilio Inc.