Skip to contentSkip to navigationSkip to topbar
Rate this page:
On this page

Profile


(warning)

This documentation is for the SendGrid Web API v2

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

Manage your SendGrid profile settings using our Web API.


Get

get page anchor
JSONXML

Call

GEThttps://api.sendgrid.com/api/profile.get.json
GET Dataapi_user=apikey&api_key=your_sendgrid_api_key

Response


_16
[
_16
{
_16
"username": "sampleuseexampexample@example.com",
_16
"email": "example@example.com",
_16
"active": "true",
_16
"first_name": "john",
_16
"last_name": "doe",
_16
"address": "555 any street",
_16
"city": "any city",
_16
"state": "CA",
_16
"zip": "91234",
_16
"country": "US",
_16
"phone": "555-555-5555",
_16
"website": "example.com"
_16
}
_16
]


URI ParameterRequiredRequirementsDescription
first_nameNoYour first name
last_nameNoYour last name
addressNoCompany address
cityNoCity where your company is located
stateNoState where your company is located
countryNoCountry where your company is located
zipNoZipcode where your company is located
phoneNoValid phone number where we can reach you
websiteNoCompany website
JSONXML
POSThttps://api.sendgrid.com/api/profile.set.json
POST Dataapi_user=apikey&api_key=your_sendgrid_api_key&first_name=newFirstName&last_name=&newLastName

_10
{
_10
"message": "success"
_10
}


URI ParameterRequiredRequirementsDescription
passwordYesPlease see the SendGrid password requirementsYour new password
confirm_passwordYesMust match password parameterConfirm new password
JSONXML
POSThttps://api.sendgrid.com/api/password.set.json
POST Dataapi_user=apikey&api_key=your_sendgrid_api_key&password=newPassword&confirm_password=newPassword

_10
{
_10
"message": "success"
_10
}


(warning)

Warning

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

URI ParameterRequiredRequirementsDescription
usernameYesMust not exceed 100 characters. The username cannot be already taken or contain the SendGrid.com domainThis is the new username we will be authenticating with our SMTP servers and our website. Changes take effect immediately
JSONXML
POSThttps://api.sendgrid.com/api/profile.setUsername.json
POST Dataapi_user=apikey&api_key=your_sendgrid_api_key&username=yournewusername@domain.com

_10
{
_10
"message": "success"
_10
}


(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 ParameterRequiredRequirementsDescription
emailYesMust be in email format and not more than 100 charactersThis is the new email address we will be contacting you with. Changes take effect immediately
JSONXML
POSThttps://api.sendgrid.com/api/profile.setEmail.json
POST Dataapi_user=apikey&api_key=your_sendgrid_api_key&email=yournewemail@domain.com

_10
{
_10
"message": "success"
_10
}


Rate this page: