Menu

Users API

Keeping your user profile up to date helps SendGrid verify who you are and share important communications with you.

You can learn more in the SendGrid Account Details documentation.

Update a user's profile

Update a user's profile

PATCH /user/profile

This endpoint allows you to update your current profile details.

Any one or more of the parameters can be updated via the PATCH /user/profile endpoint. You must include at least one when you PATCH.

Authentication

  • API Key

Headers

Authorization
string
default: Bearer <<YOUR_API_KEY_HERE>>
required
on-behalf-of
string
default: The subuser's username. This header generates the API call as if the subuser account was making the call.

Request Body

object
address
string

The street address for this user profile.

address2
string

An optional second line for the street address of this user profile.

city
string

The city for the user profile.

company
string

That company that this user profile is associated with.

country
string

Th country of this user profile.

first_name
string

The first name of the user.

last_name
string

The last name of the user.

phone
string

The phone number for the user.

state
string

The state for this user.

website
string

The website associated with this user.

zip
string

The zip code for this user.

{
  "address": "1451 Larimer Street, 3rd floor",
  "address2": "",
  "city": "Denver, CO",
  "company": "SendGrid",
  "country": "US",
  "first_name": "Matthew",
  "last_name": "Bernier",
  "phone": "7208788003",
  "state": "CO",
  "website": "http://sendgrid.com",
  "zip": "80202"
}

Responses

object
address
string

The street address for this user profile.

address2
string

An optional second line for the street address of this user profile.

city
string

The city for the user profile.

company
string

That company that this user profile is associated with.

country
string

Th country of this user profile.

first_name
string

The first name of the user.

last_name
string

The last name of the user.

phone
string

The phone number for the user.

state
string

The state for this user.

website
string

The website associated with this user.

zip
string

The zip code for this user.

{
  "address": "1451 Larimer Street, 3rd floor",
  "address2": "",
  "city": "Denver, CO",
  "company": "SendGrid",
  "country": "US",
  "first_name": "Matthew",
  "last_name": "Bernier",
  "phone": "7208788003",
  "state": "CO",
  "website": "http://sendgrid.com",
  "zip": "80202"
}
object
errors
array[object]
message
string

the error message

field
string

the field that generated the error

help
object

helper text or docs for troubleshooting

id
string
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}

Need some help?

We all do sometimes; code is hard. Get help now from our support team, or lean on the wisdom of the crowd browsing the SendGrid tag on Stack Overflow.