# Update a user's profile ## API Overview 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.](/docs/sendgrid/ui/account-and-settings/account/) ## Operation overview ```json {"path":"https://api.sendgrid.com/v3/user/profile","method":"patch","servers":[{"url":"https://api.sendgrid.com","description":"for global users and subusers"},{"url":"https://api.eu.sendgrid.com","description":"for EU regional subusers"}]} ``` **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. ## Operation details ### Authentication API Key ### Headers ```json [{"in":"header","name":"Authorization","required":true,"default":"Bearer <>","schema":{"type":"string"}},{"name":"on-behalf-of","in":"header","description":"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 `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](/docs/sendgrid/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.","required":false,"schema":{"type":"string"},"refName":"#/components/parameters/OnBehalfOf","modelName":"__components_parameters_OnBehalfOf"}] ``` ### Request body ```json {"schema":{"title":"User: Profile","type":"object","example":{"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"},"refName":"UserProfile","modelName":"UserProfile","properties":{"address":{"type":"string","description":"The street address for this user profile."},"address2":{"type":"string","description":"An optional second line for the street address of this user profile."},"city":{"type":"string","description":"The city for the user profile."},"company":{"type":"string","description":"That company that this user profile is associated with."},"country":{"type":"string","description":"Th country of this user profile."},"first_name":{"type":"string","description":"The first name of the user."},"last_name":{"type":"string","description":"The last name of the user."},"phone":{"type":"string","description":"The phone number for the user."},"state":{"type":"string","description":"The state for this user."},"website":{"type":"string","description":"The website associated with this user."},"zip":{"type":"string","description":"The zip code for this user."}}},"encodingType":"application/json"} ``` ### Responses ```json [{"responseCode":"200","schema":{"description":"","content":{"application/json":{"schema":{"title":"User: Profile","type":"object","example":{"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"},"refName":"UserProfile","modelName":"UserProfile","properties":{"address":{"type":"string","description":"The street address for this user profile."},"address2":{"type":"string","description":"An optional second line for the street address of this user profile."},"city":{"type":"string","description":"The city for the user profile."},"company":{"type":"string","description":"That company that this user profile is associated with."},"country":{"type":"string","description":"Th country of this user profile."},"first_name":{"type":"string","description":"The first name of the user."},"last_name":{"type":"string","description":"The last name of the user."},"phone":{"type":"string","description":"The phone number for the user."},"state":{"type":"string","description":"The state for this user."},"website":{"type":"string","description":"The website associated with this user."},"zip":{"type":"string","description":"The zip code for this user."}}},"examples":{"response":{"value":{"address":"814 West Chapman Avenue","address2":"","city":"Orange","company":"SendGrid","country":"US","first_name":"Example","last_name":"User","phone":"555-555-5555","state":"CA","website":"http://www.sendgrid.com","zip":"92868"}}}}}}},{"responseCode":"401","schema":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{"errors":[{"field":"field_name","message":"error message"}]},"refName":"ErrorResponse","modelName":"ErrorResponse","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"message":{"type":"string","description":"An error message."},"field":{"description":"When applicable, this property value will be the field that generated the error.","nullable":true,"type":"string"},"help":{"type":"object","description":"When applicable, this property value will be helper text or a link to documentation to help you troubleshoot the error."}}}},"id":{"type":"string","description":"When applicable, this property value will be an error ID."}}},"examples":{"response":{"value":{"errors":[{"field":null,"message":"authorization required"}]}}}}}}}] ``` Update a user's profile ```js const client = require("@sendgrid/client"); client.setApiKey(process.env.SENDGRID_API_KEY); const data = { 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", }; const request = { url: `/v3/user/profile`, method: "PATCH", body: data, }; client .request(request) .then(([response, body]) => { console.log(response.statusCode); console.log(response.body); }) .catch((error) => { console.error(error); }); ``` ```python import os from sendgrid import SendGridAPIClient sg = SendGridAPIClient(os.environ.get("SENDGRID_API_KEY")) data = { "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", } response = sg.client.user.profile.patch(request_body=data) print(response.status_code) print(response.body) print(response.headers) ``` ```csharp using System; using System.Collections.Generic; using System.Threading.Tasks; using SendGrid; public class Program { public static async Task Main() { string apiKey = Environment.GetEnvironmentVariable("SENDGRID_API_KEY"); var client = new SendGridClient(apiKey); var data = @"{ ""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"" }"; var response = await client.RequestAsync( method: SendGridClient.Method.PATCH, urlPath: "user/profile", requestBody: data); Console.WriteLine(response.StatusCode); Console.WriteLine(response.Body.ReadAsStringAsync().Result); Console.WriteLine(response.Headers.ToString()); } } ``` ```java import com.sendgrid.*; import java.io.IOException; import org.json.JSONObject; import java.util.HashMap; public class Example { public static void main(String[] args) throws IOException { try { SendGrid sg = new SendGrid(System.getenv("SENDGRID_API_KEY")); Request request = new Request(); request.setMethod(Method.PATCH); request.setEndpoint("/user/profile"); request.setBody(new JSONObject(new HashMap() { { put("address", "1451 Larimer Street, 3rd floor"); put("address2", ""); put("city", "Denver, CO"); put("company", "SendGrid"); put("country", "US"); put("first_name", "Matthew"); put("last_name", "Bernier"); put("phone", "7208788003"); put("state", "CO"); put("website", "http://sendgrid.com"); put("zip", "80202"); } }).toString()); Response response = sg.api(request); System.out.println(response.getStatusCode()); System.out.println(response.getBody()); System.out.println(response.getHeaders()); } catch (IOException ex) { throw ex; } } } ``` ```go package main import ( "fmt" "github.com/sendgrid/sendgrid-go" "os" ) func main() { apiKey := os.Getenv("SENDGRID_API_KEY") host := "https://api.sendgrid.com" request := sendgrid.GetRequest(apiKey, "/v3/user/profile", host) request.Method = "PATCH" request.Body = []byte(`{ "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" }`) response, err := sendgrid.API(request) if err != nil { fmt.Println(err.Error()) os.Exit(1) } else { fmt.Println(response.StatusCode) fmt.Println(response.Body) fmt.Println(response.Headers) } } ``` ```php /sendgrid-php.php'; $apiKey = getenv("SENDGRID_API_KEY"); $sg = new \SendGrid($apiKey); $request_body = json_decode('{ "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" }'); try { $response = $sg->client ->user() ->profile() ->patch($request_body); print $response->statusCode() . "\n"; print_r($response->headers()); print $response->body() . "\n"; } catch (Exception $ex) { echo "Caught exception: " . $ex->getMessage(); } ``` ```ruby require 'sendgrid-ruby' include SendGrid sg = SendGrid::API.new(api_key: ENV['SENDGRID_API_KEY']) data = JSON.parse('{ "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" }') response = sg.client.user.profile.patch(request_body: data) puts response.status_code puts response.headers puts response.body ``` ```bash curl -X PATCH "https://api.sendgrid.com/v3/user/profile" \ --header "Authorization: Bearer $SENDGRID_API_KEY" \ --header "Content-Type: application/json" \ --data '{"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"}' ```