Skip to contentSkip to navigationSkip to topbar
Rate this page:
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. 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

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
Authorizationstringrequired
Default: Bearer <<YOUR_API_KEY_HERE>>

on-behalf-ofstring

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.

idintegerrequired

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

200500
SchemaExample
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-link page anchor
Node.js
Python
C#
Java
Go
PHP
Ruby
curl

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


Rate this page: