Skip to contentSkip to navigationSkip to topbar
On this page

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


POST/v3/whitelabel/links/{id}/validate

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 validate a branded link.

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
idintegerrequired

The ID of the branded link that you want to validate.

200500
SchemaExample
Property nameTypeRequiredDescriptionChild properties
idinteger

The ID of the branded link.


validenum<boolean>

Indicates if the link branding is valid.

Possible values:
truefalse

validation_resultsobject

The individual validation results for each of the DNS records associated with this branded link.

Validate a branded linkLink to code sample: Validate a branded link
1
const client = require("@sendgrid/client");
2
client.setApiKey(process.env.SENDGRID_API_KEY);
3
4
const id = 4900;
5
6
const request = {
7
url: `/v3/whitelabel/links/${id}/validate`,
8
method: "POST",
9
};
10
11
client
12
.request(request)
13
.then(([response, body]) => {
14
console.log(response.statusCode);
15
console.log(response.body);
16
})
17
.catch((error) => {
18
console.error(error);
19
});

Need some help?

Terms of service

Copyright © 2024 Twilio Inc.