Menu

Expand
Rate this page:

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

PATCH /v3/user/profile

Base url: https://api.sendgrid.com

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

The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id <account-id>). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: <subuser-username>). See On Behalf Of for more information.

default: None

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

required
field
string or null

the field that generated the error

help
object

helper text or docs for troubleshooting

id
string
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
Loading Code Sample...
        
        

        Update a user's profile

        Rate this page:

        Need some help?

        We all do sometimes. Get help now from the Twilio SendGrid Support Team.

        Running into a coding hurdle? Lean on the wisdom of the crowd by browsing the SendGrid tag on Stack Overflow or visiting Twilio's Stack Overflow Collective.

        Loading Code Sample...
              
              
              

              Thank you for your feedback!

              Please select the reason(s) for your feedback. The additional information you provide helps us improve our documentation:

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

              Thanks for your feedback!

              thanks-feedback-gif