These are actions that directly affect your customer. We provide access via XML and JSON.

Create a Customer

URI Parameter Required Requirements Description
username Yes No more than 64 characters The customers new username
password Yes See SendGrid password requirements New password of customer
confirm_password Yes Must match password parameter Confirm new password
email Yes Must be in email format, no more than 64 characters Email address of new customer
first_name Yes No more than 50 characters First name of new customer
last_name Yes No more than 50 characters Last name of new customer
address Yes No more than 100 characters Address of new customer
city Yes No more than 100 characters City of new customer
state Yes No more than 100 characters State of new customer
zip Yes No more than 50 characters Zip of new customer. This field is not validated for correct value. It is up to developer to check for valid zip code.
country Yes No more than 100 characters Country of new customer
phone Yes No more than 50 characters Phone number of new customer
website Yes No more than 255 characters Website of new customer
company Yes No more than 255 characters Company of new customer
package Yes No more than 255 characters Name of the Package to assign to customer. You can view the available package here.
whitelabel Yes No more than 255 characters The domain name for whitelabel. The default one is sendgrid.me
ip_group[] No No more than 255 characters for each ip_group name. It must belong to you. Name of the IP Group you wish to optionally add.
ip[] No Valid ip address that belongs to you. If package allows it, you can optionally add additional IP addresses.
free_user Maybe If the new customer is a free customer, you need to specify this parameter. Either true or false. Create a free customer
billing_date No If the new customers billing
Parameter Value Requirements Description

Call

POST https://api.sendgrid.com/apiv2/reseller.add.json
POST Data api_user=your_sendgrid_username&api_key=your_sendgrid_password&username=newcustomer@example.com&website=example.com&password=samplepassword&confirm_password=samplepassword&first_name=fname&last_name=lname&address=555_anystreet&city=any_city&state=CA&zip=91234&email=newcustomer@example.com&country=US&phone=555-555&free_user=true&company=company&whitelabel=sendgrid.me

Response

1
2
3
{
  "message": "success"
}

Call

POST https://api.sendgrid.com/apiv2/reseller.add.xml
POST Data api_user=your_sendgrid_username&api_key=your_sendgrid_password&username=newcustomer@example.com&website=example.com&password=samplepassword&confirm_password=samplepassword&first_name=fname&last_name=lname&address=555_anystreet&city=any_city&state=CA&zip=91234&email=newcustomer@example.com&country=US&phone=555-555&free_user=true&company=company&whitelabel=sendgrid.me

Response

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

Delete a Customer

Remove a customer from your account. This is not the same as disabling a customer on our system. This is the same thing as closing out a customers account at the end of their billing cycle.

URI Parameter Required Requirements Description
user Yes Must be a customer registered under your account. The customers username you wish to delete.
Parameter Value Requirements Description

Call

POST https://api.sendgrid.com/apiv2/reseller.delete.json
POST Data api_user=your_sendgrid_username&api_key=your_sendgrid_password&user=customer@example.com

Response

1
2
3
{
  "message": "success"
}

Call

POST https://api.sendgrid.com/apiv2/reseller.delete.xml
POST Data api_user=your_sendgrid_username&api_key=your_sendgrid_password&user=customer@example.com

Response

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

Retrieve Customers

Obtain a complete list of all customers.

URI Parameter Required Requirements Description
task Yes Must be set to get in order to retrieve user information
username No Search filter, customer that is registered under you
email No Search filter, email address customer was registered with
first_name No Search filter, first name of customer
last_name No Search filter, last name of customer
address No Search filter, address of customer
city No Search filter, city of customer
state No Search filter, state of customer
country No Search filter, country of customer
zip No Search filter, zipcode of customer
phone No Search filter, phone number of customer
website No Search filter, website of customer
method Yes Must be set to profile
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=profile&task=get

Response

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
[
  {
    "username": "username",
    "email": "example1@example.com",
    "active": "true",
    "first_name": "john",
    "last_name": "doe",
    "address": "555 any street",
    "city": "any city",
    "state": "CA",
    "zip": "91234",
    "country": "US",
    "phone": "555-555-5555",
    "website": "example.com"
  },
  {
    "username": "username",
    "email": "example2@example.com",
    "active": "false",
    "first_name": "jane",
    "last_name": "doe",
    "address": "555 any street",
    "city": "any city",
    "state": "CA",
    "zip": "91234",
    "country": "US",
    "phone": "555-555-5555",
    "website": "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=profile&task=get

Response

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
<users>
   <user>
      <username>user1</username>
      <email>example1@example.com</email>
      <active>true</active>
      <first_name>john</first_name>
      <last_name>doe</last_name>
      <address>
555 any street
</address>
      <city>any city</city>
      <state>CA</state>
      <zip>91234</zip>
      <country>US</country>
      <phone>555-555-5555</phone>
      <website>example.com</website>
   </user>
   <user>
      <username>user2</username>
      <email>example2@example.com</email>
      <active>false</active>
      <first_name>jane</first_name>
      <last_name>doe</last_name>
      <address>
555 any street
</address>
      <city>any city</city>
      <state>CA</state>
      <zip>91234</zip>
      <country>US</country>
      <phone>555-555-5555</phone>
      <website>example.com</website>
   </user>
</users>

Enable a Customer

Enable a customer so they may start sending out emails again. This call will not enable website access.

URI Parameter Required Requirements Description
user Yes Must be a customer registered under your account. The customer you are planning to enabling
method Yes Must be set to enable The customer you are planning to enabling
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=enable&user=customer@example.com

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=enable&user=customer@example.com

Response

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

Disable a Customer

This prevents them from sending out emails with SendGrid.

URI Parameter Required Requirements Description
user Yes Must be a customer registered under your account. The customer you are planning to disabling
method Yes Must be set to disable The customer you are planning to disabling
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=disable&user=customer@example.com

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=disable&user=customer@example.com

Response

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

Enable Website Access To A Customer

Allow a customer to login to the SendGrid.com website. This call will not enable the customer from sending out emails.

URI Parameter Required Requirements Description
user Yes Must be a customer registered under your account. The customer you are planning to grant website access
method Yes Must be set to website_enable The customer you are planning to grant website access
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=website_enable&user=customer@example.com

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=website_enable&user=customer@example.com

Response

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

Disable Website Access To A Customer

Disallow a customer to login to the SendGrid.com website. This call will not prevent them from sending out emails.

URI Parameter Required Requirements Description
user Yes Must be a customer registered under your account. The customer you are planning to disallow website access
method Yes Must be set to website_disable The customer you are planning to disallow website access
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=website_disable&user=customer@example.com

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=website_disable&user=customer@example.com

Response

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

Update Customer Profile

Allows you to update your customers profile information

URI Parameter Required Requirements Description
task Yes Must be set to set in order to update profile information
method Yes Must be set to profile
user Yes Customer that is registered under you
first_name No First name of customer
last_name No Last name of customer
address No Address of customer
city No City of customer
state No State of customer
country No Country of customer
zip No Zipcode of customer
phone No Phone number of customer
website No Website of customer
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=profile&task=set&user=customer@example.com&first_name=newFirstName&last_name=newLastName

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=profile&task=set&user=customer@example.com&first_name=newFirstName&last_name=newLastName

Response

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

Update Customer Password

Passwords are encrypted by default and therefore cannot be retrieved; however, you can reset a customers password.

URI Parameter Required Requirements Description
user Yes Customer must be registered under you The customer you are planning to reset the password
password Yes See SendGrid password requirements New password of customer
confirm_password Yes Must match password parameter Confirm new password
method Yes Must be set to password Allows you to access password functionality
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=password&user=customer@example.com&password=newPasword&confirm_password=newPassword

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=password&user=customer@example.com&password=newPasword&confirm_password=newPassword

Response

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

Update Customer Username

Note that your customer account username is used to login to our SMTP server and the website and changes take effect immediately.

URI Parameter Required Requirements Description
task Yes Must be set to setUsername This will let us know you want to update your customers username. This is the new username your customer will be authenticating with our SMTP servers and to access the website. This update takes effect immediately
user Yes Customer must be registered under your account The user we will be updating their username for
username Yes No more than 64 characters, cannot be already taken and cannot contain SendGrid.com in the domain name This is the new username we will be authenticating with our SMTP servers and to access our site. This update takes effect immediately
method Yes Must be set to profile Allows you to access profile functionality
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=profile&task=setUsername&user=customer@example.com&username=newcustomer@example.com

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=profile&task=setUsername&user=customer@example.com&username=newcustomer@example.com

Response

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

Update Customer Email Address

This is the contact email we use for your customers. Changes take place immediately. It is your responsibility to validate the contact email.

URI Parameter Required Requirements Description
task Yes Must be set to setEmail This will let us know you want to update your customers email address. This update takes effect immediately
user Yes Customer must be registered under your account The user we will be updating their username for
email Yes Must be in email format, not more than 100 characters This is the new email address we will use for contacting customer. This update takes effect immediately
method Yes Must be set to password Allows you to access password functionality
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=profile&task=setEmail&user=customer@example.com&email=newcustomer@example.com

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=profile&task=setEmail&user=customer@example.com&email=newcustomer@example.com

Response

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