Twilio SendGrid Domain Authentication API
The Twilio SendGrid Domain Authentication API allows you to manage your authenticated domains and their settings. Domain Authentication is a required step…
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 Domain Authentication API allows you to manage your authenticated domains and their settings.
Domain Authentication is a required step when setting up your Twilio SendGrid account because it's essential to ensuring the deliverability of your email. Domain Authentication signals trustworthiness to email inbox providers and your recipients by approving SendGrid to send email on behalf of your domain. For more information, see How to Set Up Domain Authentication.
Each user may have a maximum of 3,000 authenticated domains and 3,000 link brandings. This limit is at the user level, meaning each Subuser belonging to a parent account may have its own 3,000 authenticated domains and 3,000 link brandings.
Endpoints 16
Domain Authentication
- POSTEmail DNS records to a co-worker
/v3/whitelabel/dns/emailThis endpoint is used to share DNS records with a colleagues Use this endpoint to send SendGrid-generated DNS record information to a co-worker so they can… - GETList all authenticated domains
/v3/whitelabel/domains?limit=0&offset=0&exclude_subusers=true&username=string&domain=stringThis endpoint allows you to retrieve a paginated list of all domains you have authenticated. You can use the limit query parameter to set the page size. If… - POSTAuthenticate a domain
/v3/whitelabel/domainsThis endpoint allows you to authenticate a domain. If you are authenticating a domain for a subuser, you have two options: 1. Use the "username" parameter.… - GETRetrieve an authenticated domain
/v3/whitelabel/domains/:domain_idThis endpoint allows you to retrieve a specific authenticated domain. - DELETEDelete an authenticated domain.
/v3/whitelabel/domains/:domain_idThis endpoint allows you to delete an authenticated domain. - PATCHUpdate an authenticated domain
/v3/whitelabel/domains/:domain_idThis endpoint allows you to update the settings for an authenticated domain. - POSTAssociate an authenticated domain with a given user.
/v3/whitelabel/domains/:domain_id/subuserThis endpoint allows you to associate a specific authenticated domain with a subuser. Authenticated domains can be associated with (i.e. assigned to) subusers… - DELETEDisassociate an authenticated domain from a given user for users with up to five associated domains.
/v3/whitelabel/domains/:domain_id/subuser?username=stringThis endpoint allows you to disassociate a specific authenticated domain from a subuser, for users with up to five associated domains. This functionality… - POSTAssociate an authenticated domain with a given user, for up to five domains.
/v3/whitelabel/domains/:domain_id/subuser:addThis endpoint allows you to associate a specific authenticated domain with a subuser. It can be used to associate up to five authenticated domains. This… - POSTAdd an IP to an authenticated domain
/v3/whitelabel/domains/:id/ipsThis endpoint allows you to add an IP address to an authenticated domain. - DELETERemove an IP from an authenticated domain.
/v3/whitelabel/domains/:id/ips/:ipThis endpoint allows you to remove an IP address from that domain's authentication. - POSTValidate a domain authentication.
/v3/whitelabel/domains/:id/validateThis endpoint allows you to validate an authenticated domain. If it fails, it will return an error message describing why the domain could not be validated. - GETGet the default authentication
/v3/whitelabel/domains/default?domain=stringThis endpoint allows you to retrieve the default authentication for a domain. When creating or updating a domain authentication, you can set the domain as a… - GETList the authenticated domain associated with the given user.
/v3/whitelabel/domains/subuser?username=stringThis endpoint allows you to retrieve all of the authenticated domains that have been assigned to a specific subuser. Authenticated domains can be associated… - DELETEDisassociate an authenticated domain from a given user.
/v3/whitelabel/domains/subuser?username=stringThis endpoint allows you to disassociate a specific authenticated domain from a subuser. Authenticated domains can be associated with (i.e. assigned to)… - GETList all the authenticated domains associated with the given user.
/v3/whitelabel/domains/subuser/all?username=stringThis endpoint allows you to retrieve all of the authenticated domains that have been assigned to a specific subuser. This functionality allows subusers to…
API details
- Base URL
https://api.sendgrid.comhttps://api.eu.sendgrid.com- Authentication
- A bearer token in the Authorization header
- Operations
- 16 operations on 11 pathsPOST 6GET 5DELETE 4PATCH 1
- Main resources
- Domain Authentication 16
- 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 Domain Authentication 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 Domain Authentication 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 “Email DNS records to a co-worker” (POST /v3/whitelabel/dns/email), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Twilio SendGrid Domain Authentication API?
The Twilio SendGrid Domain Authentication API allows you to manage your authenticated domains and their settings. Domain Authentication is a required step… It is listed under Communication and has 16 endpoints.
Who publishes the Twilio SendGrid Domain Authentication 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 Domain Authentication 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 Domain Authentication API?
With A bearer token in the Authorization header.
How many endpoints does the Twilio SendGrid Domain Authentication API have?
16 operations on 11 paths (6 POST, 5 GET, 4 DELETE, 1 PATCH). The largest groups are Domain Authentication.
Is forking the Twilio SendGrid Domain Authentication API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.