Menu

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.

Update a branded link

PATCH /whitelabel/links/{id}

This endpoint allows you to update a specific branded link. You can use this endpoint to change a branded link's default status.

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.

Request Body

object
default
boolean

Indicates if the branded link is set as the default. When setting a new default, the existing default link branding will have its default status removed automatically.

Allowed Values: true, false
{
  "default": true
}

Path Parameters

id
integer

The ID of the branded link you want to retrieve.

default: None
required

Responses

object
id
integer

The ID of the branded link.

required
domain
string

The root domain of the branded link.

required
subdomain
string

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.

username
string

The username of the account that this link branding is associated with.

required
user_id
integer

The ID of the user that this link branding is associated with.

required
default
boolean

Indicates if this is the default link branding.

Allowed Values: true, false
required
valid
boolean

Indicates if this link branding is valid.

Allowed Values: true, false
required
legacy
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.

Allowed Values: true, false
required
dns
object

The DNS records generated for this link branding.

required
domain_cname
object

The DNS record generated to point to your link branding subdomain.

required
valid
boolean

Indicates if the DNS record is valid.

Allowed Values: true, false
required
type
string

The type of DNS record that was generated.

Allowed Values: cname, txt, mx
required
host
string

The domain that this link branding will use for the links in your email.

required
data
string

The domain that the DNS record points to.

required
owner_cname
object

The DNS record generated to verify who created the link branding.

valid
boolean

Indicates if the DNS record is valid.

Allowed Values: true, false
required
type
string

The type of DNS record generated.

Allowed Values: cname, txt, mx
host
string

Used to verify the link branding. The subdomain of this domain is the ID of the user who created the link branding.

required
data
string

The domain that the DNS record points to.

required
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!

We are always striving to improve our documentation quality, and your feedback is valuable to us. How could this documentation serve you better?

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