Skip to contentSkip to navigationSkip to topbar
Rate this page:
On this page

Disassociate an Authenticated Domain from a Subuser with Multiple Domains



API Overview

api-overview page anchor

An authenticated domain allows you to remove the "via" or "sent on behalf of" message that your recipients see when they read your emails. Authenticating a domain allows you to replace sendgrid.net with your personal sending domain. You will be required to create a subdomain so that SendGrid can generate the DNS records which you must give to your host provider. If you choose to use Automated Security, SendGrid will provide you with 3 CNAME records. If you turn Automated Security off, you will get 2 TXT records and 1 MX record.

Domain Authentication was formerly called "Domain Whitelabel".

For more information, please see How to set up domain authentication.

(information)

Info

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.


DELETE/v3/whitelabel/domains/{domain_id}/subuser

Base url: https://api.sendgrid.com

This endpoint allows you to disassociate a specific authenticated domain from a subuser, for users with up to five associated domains.

This functionality allows subusers to send mail using their parent's domain. Authenticated domains can be associated with (i.e. assigned to) subusers kknt, and a subuser can have up to five associated authenticated domains.

You can dissociate an authenticated domain from any subuser that has one or more authenticated domains using this endpoint.


Authentication

authentication page anchor
Property nameTypeRequiredDescription
Authorizationstringrequired
Default: Bearer <<YOUR_API_KEY_HERE>>
Property nameTypeRequiredDescription
domain_idintegerrequired

ID of the authenticated domain to be disassociated with the subuser.

Property nameTypeRequiredDescription
usernamestringOptional

Username for the subuser to find associated authenticated domain.

204
Schema
Property nameTypeRequiredDescriptionChild properties

No properties defined

Disassociate an authenticated domain from a subuser.

disassociate-an-authenticated-domain-from-a-subuser page anchor
Node.js
Python
C#
Java
Go
PHP
Ruby
curl

_22
const client = require('@sendgrid/client');
_22
client.setApiKey(process.env.SENDGRID_API_KEY);
_22
_22
const domain_id = 4900;
_22
const queryParams = {
_22
"username": "test"
_22
};
_22
_22
const request = {
_22
url: `/v3/whitelabel/domains/${domain_id}/subuser`,
_22
method: 'DELETE',
_22
qs: queryParams
_22
}
_22
_22
client.request(request)
_22
.then(([response, body]) => {
_22
console.log(response.statusCode);
_22
console.log(response.body);
_22
})
_22
.catch(error => {
_22
console.error(error);
_22
});


Rate this page: