Menu

Expand

This documentation is for the SendGrid Web API v2

To access all the latest features and upcoming developments, please see our v3 API.

Rate this page:

Profile

Manage your SendGrid profile settings using our Web API.

Get

Call

GET https://api.sendgrid.com/api/profile.get.json
GET Data api_user=apikey&api_key=your_sendgrid_api_key

Response

[
  {
    "username": "sampleuseexampexample@example.com",
    "email": "example@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

GET https://api.sendgrid.com/api/profile.get.xml
GET Data api_user=apikey&api_key=your_sendgrid_api_key

Response

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

URI Parameter Required Requirements 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 Company website

Call

POST https://api.sendgrid.com/api/profile.set.json
POST Data api_user=apikey&api_key=your_sendgrid_api_key&first_name=newFirstName&last_name=&newLastName

Response

{
  "message": "success"
}

Call

POST https://api.sendgrid.com/api/profile.set.xml
POST Data api_user=apikey&api_key=your_sendgrid_api_key&first_name=newFirstName&last_name=&newLastName

Response

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

setPassword

URI Parameter Required Requirements Description
password Yes Please see the SendGrid password requirements Your new password
confirm_password Yes Must match password parameter Confirm new password

Call

POST https://api.sendgrid.com/api/password.set.json
POST Data api_user=apikey&api_key=your_sendgrid_api_key&password=newPassword&confirm_password=newPassword

Response

{
  "message": "success"
}

Call

POST https://api.sendgrid.com/api/password.set.xml
POST Data api_user=apikey&api_key=your_sendgrid_api_key&password=newPassword&confirm_password=newPassword

Response

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

setUsername

Please note, your account username is used to login to our SMTP server and the website. Changes will take effect immediately.

URI 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

POST https://api.sendgrid.com/api/profile.setUsername.json
POST Data api_user=apikey&api_key=your_sendgrid_api_key&username=yournewusername@domain.com

Response

{
  "message": "success"
}

Call

POST https://api.sendgrid.com/api/profile.setUsername.xml
POST Data api_user=apikey&api_key=your_sendgrid_api_key&username=yournewusername@domain.com

Response

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

setEmail

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.

URI 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

POST https://api.sendgrid.com/api/profile.setEmail.json
POST Data api_user=apikey&api_key=your_sendgrid_api_key&email=yournewemail@domain.com

Response

{
  "message": "success"
}

Call

POST https://api.sendgrid.com/api/profile.setEmail.xml
POST Data api_user=apikey&api_key=your_sendgrid_api_key&email=yournewemail@domain.com

Response

<result>
   <message>success</message>
</result>
Rate this page:
        
        
        

        Thank you for your feedback!

        We are always striving to improve our documentation quality, and your feedback is valuable to us. Please select the reason(s) for your feedback or provide additional information about how we can improve:

        Sending your feedback...
        🎉 Thank you for your feedback!
        Something went wrong. Please try again.

        Thanks for your feedback!

        Refer us and get $10 in 3 simple steps!

        Step 1

        Get link

        Get a free personal referral link here

        Step 2

        Give $10

        Your user signs up and upgrade using link

        Step 3

        Get $10

        1,250 free SMSes
        OR 1,000 free voice mins
        OR 12,000 chats
        OR more