Menu

Expand
Rate this page:

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

Authorization
string
default: Bearer <<YOUR_API_KEY_HERE>>
required
on-behalf-of
string
default: The subuser's username. This header generates the API call as if the subuser account was making the call.

Path Parameters

id
integer

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

default: None
required

Responses

object
id
integer

The ID of the branded link.

required
valid
boolean

Indicates if the link branding is valid.

Allowed Values: true, false
required
validation_results
object

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

required
domain_cname
object

The DNS record generated for the sending domain used for this branded link.

required
valid
boolean

Indicates if this DNS record is valid.

Allowed Values: true, false
required
reason
string or null

Null if the DNS record is valid. If the DNS record is invalid, this will explain why.

required
owner_cname
object

The DNS record created to verify the branded link.

valid
boolean

Indicates if the DNS record is valid.

Allowed Values: true, false
required
reason
string or null

Null if valid. If the DNS record is invalid, this will explain why.

required
object
errors
array[object]

The reasons why the validation failed.

required
message
string

The reason why the link whitelabel could not be validated.

Rate this page:

Need some help?

We all do sometimes; code is hard. Get help now from our support team, or lean on the wisdom of the crowd browsing the SendGrid tag on Stack Overflow.

        
        
        

        Thank you for your feedback!

        Please select the reason(s) for your feedback. The additional information you provide helps us improve our documentation:

        Sending your feedback...
        🎉 Thank you for your feedback!
        Something went wrong. Please try again.

        Thanks for your feedback!

        Refer us and get $10 in 3 simple steps!

        Step 1

        Get link

        Get a free personal referral link here

        Step 2

        Give $10

        Your user signs up and upgrade using link

        Step 3

        Get $10

        1,250 free SMSes
        OR 1,000 free voice mins
        OR 12,000 chats
        OR more