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

Remove an IP from an authenticated domain.



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/{id}/ips/{ip}

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

This endpoint allows you to remove an IP address from that domain's authentication.


Authentication

authentication page anchor
Authorizationstringrequired
Default: Bearer <<YOUR_API_KEY_HERE>>

on-behalf-ofstring

The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id <account-id>). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: <subuser-username>). See On Behalf Of for more information.

idintegerrequired

ID of the domain to delete the IP from.


ipstringrequired

IP to remove from the domain.

200
SchemaExample
idinteger

The ID of the authenticated domain.


domainstring

The domain authenticated.


subdomainstring

The subdomain that was used to create this authenticated domain.


usernamestring

The username of the account that this authenticated domain is associated with.


user_idinteger

The user_id of the account that this authenticated domain is associated with.


ipsarray

The IP addresses that are included in the SPF record for this authenticated domain.


custom_spfboolean

Indicates if this authenticated domain uses custom SPF.


defaultboolean

Indicates if this is the default domain.


legacyboolean

Indicates if this authenticated domain was created using the legacy whitelabel tool. If it is a legacy whitelabel, it will still function, but you'll need to create a new authenticated domain if you need to update it.


automatic_securityboolean

Indicates if this authenticated domain uses automated security.


validboolean

Indicates if this is a valid authenticated domain .


dnsobject

The DNS records for this authenticated domain.

Remove an IP from an authenticated domain.

remove-an-ip-from-an-authenticated-domain page anchor
Node.js
Python
C#
Java
Go
PHP
Ruby
curl

_20
const client = require('@sendgrid/client');
_20
client.setApiKey(process.env.SENDGRID_API_KEY);
_20
_20
const id = 4900;
_20
const ip = "ZGkrHSypTsudrGkmdpJJ";
_20
_20
const request = {
_20
url: `/v3/whitelabel/domains/${id}/ips/${ip}`,
_20
method: 'DELETE',
_20
_20
}
_20
_20
client.request(request)
_20
.then(([response, body]) => {
_20
console.log(response.statusCode);
_20
console.log(response.body);
_20
})
_20
.catch(error => {
_20
console.error(error);
_20
});


Rate this page: