On this page

Profile

(warning)

This documentation is for the SendGrid Web API v2

We will deprecate this version on February 10, 2025. To access all the latest features and upcoming developments, please see our v3 API. For assistance with transitioning, refer to our migration guide.

Manage your SendGrid profile settings using our Web API.

Get

JSONXML

Call

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

Response

1[
2  {
3    "username": "sampleuseexampexample@example.com",
4    "email": "example@example.com",
5    "active": "true",
6    "first_name": "john",
7    "last_name": "doe",
8    "address": "555 any street",
9    "city": "any city",
10    "state": "CA",
11    "zip": "91234",
12    "country": "US",
13    "phone": "555-555-5555",
14    "website": "example.com"
15  }
16]

Set

URI 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	Company website

JSONXML

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

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

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

JSONXML

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

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

setUsername

(warning)

Warning

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

JSONXML

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

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

setEmail

(information)

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.

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

JSONXML

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

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