Link Branding
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.
For more information, please see our Link Branding documentation.
Validate a branded link
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
- API Key
Headers
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.
Path Parameters
The ID of the branded link that you want to validate.
default: NoneResponses
The ID of the branded link.
Indicates if the link branding is valid.
Allowed Values: true, falseThe individual validation results for each of the DNS records associated with this branded link.
The DNS record generated for the sending domain used for this branded link.
Indicates if this DNS record is valid.
Allowed Values: true, falseNull if the DNS record is valid. If the DNS record is invalid, this will explain why.
The DNS record created to verify the branded link.
Indicates if the DNS record is valid.
Allowed Values: true, falseNull if valid. If the DNS record is invalid, this will explain why.
The reasons why the validation failed.
The reason why the link whitelabel could not be validated.
Need some help?
We all do sometimes. Get help now from the Twilio SendGrid Support Team.
Running into a coding hurdle? Lean on the wisdom of the crowd by browsing the SendGrid tag on Stack Overflow or visiting Twilio's Stack Overflow Collective.