With the whitelabel API calls you will be able to retrieve whitelabel settings related to your account.


List

Parameter Required Requirements Description
list Yes Must be set to list
method Yes Must be set to whitelabel
Parameter Value Requirements Description

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

1
2
3
4
5
6
7
8
9
10
[
  {
    "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

1
2
3
4
5
6
7
8
9
10
<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

Parameter Required Requirements Description
list Yes Must be set to append
user Yes Subuser must be registered under your account
mail_domain Yes Whitelabel mail_domain used to append a whitelabel record to a subuser
method Yes Must be set to whitelabel
Parameter Value Requirements Description

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=customer@example.com&mail_domain=email.sendgrid.com=m

Response

1
2
3
{
  "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=customer@example.com&mail_domain=email.sendgrid.com=m

Response

1
2
3
<result>
   <message>success</message>
</result>