Skip to contentSkip to navigationSkip to topbar
Rate this page:
On this page

Retrieve the default branded link



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. 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.


GET/v3/whitelabel/links/default

Base url: https://api.sendgrid.com

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:

  • The validated branded link marked as default (set when you call the "Create a branded link" endpoint or by calling the "Update a branded link" endpoint on an existing link)
  • Legacy branded links (migrated from the whitelabel wizard)
  • Default SendGrid-branded links (i.e., 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.


Authentication

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

on-behalf-ofstringOptional

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.

Property nameTypeRequiredDescription
domainstringOptional

The domain to match against when finding the default branded link.

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.

retrieve-the-default-branded-link page anchor
Node.js
Python
C#
Java
Go
PHP
Ruby
curl

_18
const client = require('@sendgrid/client');
_18
client.setApiKey(process.env.SENDGRID_API_KEY);
_18
_18
_18
const request = {
_18
url: `/v3/whitelabel/links/default`,
_18
method: 'GET',
_18
_18
}
_18
_18
client.request(request)
_18
.then(([response, body]) => {
_18
console.log(response.statusCode);
_18
console.log(response.body);
_18
})
_18
.catch(error => {
_18
console.error(error);
_18
});


Rate this page: