Customer Management

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

Create a Customer

1

2115498447

1
2
3

{
  "message": "success"
}

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.

1

8939501285

1
2
3

{
  "message": "success"
}

1
2
3

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

Retrieve Customers

Obtain a complete list of all customers.

1

3314439857

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

[
  {
    "id": "123",
    "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"
  },
  {
    "id": "124",
    "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"
  }
]

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

<users>
   <user>
      <id>123</id>
      <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>
      <id>124</id>
      <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.

1

6295233144

1
2
3

{
  "message": "success"
}

1
2
3

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

Disable a Customer

This prevents them from sending out emails with SendGrid.

1

1182388647

1
2
3

{
  "message": "success"
}

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.

1

5230602891

1
2
3

{
  "message": "success"
}

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.

1

5409343816

1
2
3

{
  "message": "success"
}

1
2
3

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

Update Customer Profile

Allows you to update your customers profile information

1

897531194

1
2
3

{
  "message": "success"
}

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.

1

8678408394

1
2
3

{
  "message": "success"
}

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.

1

1818573107

1
2
3

{
  "message": "success"
}

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.

1

5033115794

1
2
3

{
  "message": "success"
}

1
2
3

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