provider Link branding GET /whitelabel/links/default
@utdk/sendgrid /whitelabel/links/default
Retrieve the default branded link
**This endpoint allows you to retrieve the default branded link.** The default branded link is the actual URL to be used when sending messages. If you have more than one branded link, the default is determined by the following order: * The validated branded link marked as `default` (set when you call the "Create a branded link" endpoint or by calling the "Update a branded link" endpoint on an existing link) * Legacy branded links (migrated from the whitelabel wizard) * Default SendGrid-branded links (i.e., `100.ct.sendgrid.net`) You can submit this request as one of your subusers if you include their ID in the `on-behalf-of` header in the request.
domain query
The domain to match against when finding the default branded link.
string
on-behalf-of header
string

Try it

Authentication
Configure credentials for Email Activity (beta)
getWhitelabelLinksDefault
GET/whitelabel/links/default
**This endpoint allows you to retrieve the default branded link.** The default branded link is the actual URL to be used when sending messages. If you have more than one branded link, the default is determined by the following order: * The validated branded link marked as `default` (set when you call the "Create a branded link" endpoint or by calling the "Update a branded link" endpoint on an existing link) * Legacy branded links (migrated from the whitelabel wizard) * Default SendGrid-branded links (i.e., `100.ct.sendgrid.net`) You can submit this request as one of your subusers if you include their ID in the `on-behalf-of` header in the request.

The domain to match against when finding the default branded link.

Configure credentials above to enable sending.

Code snippet
Updates live as you fill in the form above.

TypeScript

import sendgrid from '@utdk/sendgrid';

await sendgrid.getWhitelabelLinksDefault({
  "on-behalf-of": "The subuser's username. This header generates the API call as if the subuser account was making the call."
})