Twilio SendGrid Link Branding API
The Twilio SendGrid Link Branding API allows you to configure your domain settings so that all of the click-tracked links, opens, and images in your emails…
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
The Twilio SendGrid Link Branding API allows you to configure your domain settings so that all of the click-tracked links, opens, and images in your emails are served from your domain rather than sendgrid.net. Spam filters and recipient servers look at the links within emails to determine whether the email appear 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 application user interface.
See [How to Set Up Link Branding](https: //sendgrid.com/docs/ui/account-and-settings/how-to-set-up-link-branding/) for more information.
Endpoints 10
Link Branding
- GETRetrieve all branded links
/v3/whitelabel/links?limit=0This endpoint allows you to retrieve all branded links. You can submit this request as one of your subusers if you include their ID in the on-behalf-of header… - POSTCreate a branded link
/v3/whitelabel/linksThis endpoint allows you to create a new branded link. To create the link branding, supply the root domain and, optionally, the subdomain — these go into… - GETRetrieve a branded link
/v3/whitelabel/links/:idThis endpoint allows you to retrieve a specific branded link by providing its ID. You can submit this request as one of your subusers if you include their ID… - DELETEDelete a branded link
/v3/whitelabel/links/:idThis endpoint allows you to delete a branded link. Your request will receive a response with a 204 status code if the deletion was successful. The call does… - PATCHUpdate a branded link
/v3/whitelabel/links/:idThis 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… - POSTValidate a branded link
/v3/whitelabel/links/:id/validateThis 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… - POSTAssociate a branded link with a subuser
/v3/whitelabel/links/:link_id/subuserThis endpoint allows you to associate a branded link with a subuser account. Link branding can be associated with subusers from the parent account. This… - GETRetrieve the default branded link
/v3/whitelabel/links/default?domain=stringThis 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… - GETRetrieve a subuser's branded link
/v3/whitelabel/links/subuser?username=stringThis endpoint allows you to retrieve the branded link associated with a subuser. Link branding can be associated with subusers from the parent account. This… - DELETEDisassociate a branded link from a subuser
/v3/whitelabel/links/subuser?username=stringThis endpoint allows you to take a branded link away from a subuser. Link branding can be associated with subusers from the parent account. This functionality…
API details
- Base URL
https://api.sendgrid.comhttps://api.eu.sendgrid.com- Authentication
- A bearer token in the Authorization header
- Operations
- 10 operations on 6 pathsGET 4POST 3DELETE 2PATCH 1
- Main resources
- Link Branding 10
- Response formats
application/json- Description format
- OpenAPI 3.1.0, API version
1.0.0 - Links
- Documentation · OpenAPI document · Terms of service · Support
How to test the Twilio SendGrid Link Branding API in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Twilio SendGrid Link Branding API collection, without the publisher's secrets.
- Add your credentialsThis API uses A bearer token in the Authorization header. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Retrieve all branded links” (GET /v3/whitelabel/links?limit=0), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Twilio SendGrid Link Branding API?
The Twilio SendGrid Link Branding API allows you to configure your domain settings so that all of the click-tracked links, opens, and images in your emails… It is listed under Communication and has 10 endpoints.
Who publishes the Twilio SendGrid Link Branding API?
It is listed from SendGrid's public API description (an OpenAPI document), not published by SendGrid on Swastik Codes. Anyone who controls sendgrid.com can claim the profile by adding a DNS TXT record.
What is the base URL of the Twilio SendGrid Link Branding API?
Its description lists 2 base URLs: https://api.sendgrid.com, https://api.eu.sendgrid.com. The first is the usual one; the others are typically sandbox or regional servers.
How do I authenticate with the Twilio SendGrid Link Branding API?
With A bearer token in the Authorization header.
How many endpoints does the Twilio SendGrid Link Branding API have?
10 operations on 6 paths (4 GET, 3 POST, 2 DELETE, 1 PATCH). The largest groups are Link Branding.
Is forking the Twilio SendGrid Link Branding API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.