Profile

View your SendGrid Profile

There are no extra parameters required to view your profile information.

Call

1

https://sendgrid.com/api/profile.get.json?api_user=youremail@domain.com&api_key=secureSecret

Response

1
2
3
4
5
6
7
8
9
10
11
12
13
14

{
  "username": "sampleuser@example.com",
  "email": "sampleemail@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"
}

Call

1

https://sendgrid.com/api/profile.get.xml?api_user=youremail@domain.com&api_key=secureSecret

Response

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18

<?xml version="1.0" encoding="ISO-8859-1"?>

<users>
   <user>
      <username>sampleuser@example.com</username>
      <email>sampleemail@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>
</users>

set

Parameter Required Description
first_name No Your first name
last_name No Your last name
address No Company address
city No City where your company is located
state No State where your company is located
country No Country where your company is located
zip No Zipcode where your company is located
phone No Valid phone number where we can reach you
website No Your company’s website

Call

1

https://sendgrid.com/api/profile.set.json?api_user=youremail@domain.com&api_key=secureSecret&first_name=newFirstName&last_name=&newLastName

Response: Success

1
2
3

{
  "message": "success"
}

Response: Error

1
2
3
4
5
6

{
  "message": "error",
  "errors": [
    "...error messages..."
  ]
}

Call

1

https://sendgrid.com/api/profile.set.xml?api_user=youremail@domain.com&api_key=secureSecret&first_name=newFirstName&last_name=&newLastName

Response: Success

1
2
3
4
5

<?xml version="1.0" encoding="ISO-8859-1"?>

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

Response: Error

1
2
3
4
5
6
7
8
9
10
11

<?xml version="1.0" encoding="ISO-8859-1"?>

<result>
   <message>error</message>
   <errors>
      ...
      <error>... error messages ...</error>
      ...
   </errors>
   @nodes
</result>

setPassword

Parameter Required Requirements Description
password Yes Must be at least 6 characters Your new password
confirm_password Yes Must match password parameter and be at least 6 characters long Confrim new password

Call

1

https://sendgrid.com/api/password.set.json?api_user=youremail@domain.com&api_key=secureSecret&password=newPasword&confirm_password=newPassword

Response: Success

1
2
3

{
  "message": "success"
}

Response: Error

1
2
3
4
5
6

{
  "message": "error",
  "errors": [
    "...error messages..."
  ]
}

Call

1

https://sendgrid.com/api/password.set.xml?api_user=youremail@domain.com&api_key=secureSecret&password=newPasword&confirm_password=newPassword

Response: Success

1
2
3
4
5

<?xml version="1.0" encoding="ISO-8859-1"?>

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

Response: Error

1
2
3
4
5
6
7
8

<result>
  <message>error</message>
  <errors>
    ...
    <error>... error messages ...</error>
    ...
  </errors>
@nodes

setUsername

Warning Please note, your account username is used to login to our SMTP server and the website. Changes will take effect immediately.
Parameter Required Requirements Description
username Yes Must not exceed 100 characters. The username cannot be already taken or contain the SendGrid.com domain This is the new username we will be authenticating with our SMTP servers and our website. Changes take effect immediately

Call

1

https://sendgrid.com/api/profile.setUsername.json?api_user=yourusername@domain.com&api_key=secureSecret&username=yournewusername@domain.com

Response: Success

1
2
3

{
  "message": "success"
}

Response: Error

1
2
3
4
5
6

{
  "message": "error",
  "errors": [
    "...error messages..."
  ]
}

Call

1

https://sendgrid.com/api/profile.setUsername.xml?api_user=yourusername@domain.com&api_key=secureSecret&username=yournewusername@domain.com

Response: Success

1
2
3
4
5

<?xml version="1.0" encoding="ISO-8859-1"?>

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

Response: Error

1
2
3
4
5
6
7
8

<result>
  <message>error</message>
  <errors>
    ...
    <error>... error messages ...</error>
    ...
  </errors>
@nodes

setEmail

Info Please note, we send out a confirmation email to the new email account in order to be validated. Your email address changes when you click on the confirmation link.
Parameter Required Requirements Description
email Yes Must be in email format and not more than 100 characters This is the new email address we will be contacting you with. Changes take effect immediately

Call

1

https://sendgrid.com/api/profile.setEmail.json?api_user=yourusername@domain.com&api_key=secureSecret&email=yournewemail@domain.com

Response: Success

1
2
3

{
  "message": "success"
}

Response: Error

1
2
3
4
5
6

{
  "message": "error",
  "errors": [
    "...error messages..."
  ]
}

Call

1

https://sendgrid.com/api/profile.setEmail.xml?api_user=yourusername@domain.com&api_key=secureSecret&email=yournewemail@domain.com

Response: Success

1
2
3

<?xml version="1.0" encoding="ISO-8859-1"?>

<message>success</message>

Response: Error

1
2
3

<?xml version="1.0" encoding="ISO-8859-1"?>

<message>error</message>