Domain Authentication

With the domain authentication (formerly Whitelabel) API calls, you will be able to retrieve domain authentication settings related to your account.

List

URI Parameter	Required	Requirements	Description
task	Yes	Must be set to `list`	Retieve domain authentication settings
method	Yes	Must be set to `whitelabel`	Provides access to domain authentication functionality

These are Reseller only APIs. For more information, see Reseller Overview.

Call

POST	`https://api.sendgrid.com/apiv2/reseller.manage.json`
POST Data	`api_user=your_sendgrid_username&api_key=your_sendgrid_password&method=whitelabel&task=list`

Response

[
  {
    "mail_domain": "email.sendgrid.com",
    "url_domain": "email.sendgrid.com"
  },
  {
    "mail_domain": "email.example.com",
    "url_domain": "email.example.com"
  }
]

Call

POST	`https://api.sendgrid.com/apiv2/reseller.manage.xml`
POST Data	`api_user=your_sendgrid_username&api_key=your_sendgrid_password&method=whitelabel&task=list`

Response

<whitelabels>
   <whitelabel>
      <mail_domain>email.sendgrid.com</mail_domain>
      <url_domain>email.sendgrid.com</url_domain>
   </whitelabel>
   <whitelabel>
      <mail_domain>email.example.com</mail_domain>
      <url_domain>email.example.com</url_domain>
   </whitelabel>
</whitelabels>

Append

URI Parameter	Required	Requirements	Description
list	Yes	Must be set to `append`	Append domain authentication settings
user	Yes	Subuser must be registered under your account	The user you are appending domain authentication settings to
mail_domain	Yes		Authenticated `mail_domain` used to append a domain authentication record to a subuser
method	Yes	Must be set to `whitelabel`	Provides access to domain authentication functionality

Call

POST	`https://api.sendgrid.com/apiv2/reseller.manage.json`
POST Data	`api_user=your_sendgrid_username&api_key=your_sendgrid_password&method=whitelabel&task=append&user=eexampexample@example.com&mail_domain=email.sendgrid.com=m`

Response

{
  "message": "success"
}

Call

POST	`https://api.sendgrid.com/apiv2/reseller.manage.xml`
POST Data	`api_user=your_sendgrid_username&api_key=your_sendgrid_password&method=whitelabel&task=append&user=eexampexample@example.com&mail_domain=email.sendgrid.com=m`

Response

<result>
   <message>success</message>
</result>

Rate this page:

Need some help?

We all do sometimes; code is hard. Get help now from our support team, or lean on the wisdom of the crowd browsing the SendGrid tag on Stack Overflow.

This documentation is for the SendGrid Web API v2

Need some help?

Thank you for your feedback!

Thanks for your feedback!

Step 1

Step 2

Step 3