# Update a Sender ## API Overview ## Operation overview ```json {"path":"https://api.sendgrid.com/v3/marketing/senders/{id}","method":"patch","servers":[{"url":"https://api.sendgrid.com","description":"The Twilio SendGrid v3 API"}]} ``` **This endpoint allows you to update an existing Sender.** Updates to `from.email` require re-verification. If your domain has been authenticated, a new Sender will auto verify on creation. Otherwise, an email will be sent to the `from.email`. Partial updates are allowed, but fields that are marked as "required" in the `POST` (create) endpoint must not be nil if that field is included in the `PATCH` request. ## 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"}] ``` ### Path parameters ```json [{"name":"id","in":"path","description":"The unique identifier of the Sender.","required":true,"schema":{"type":"integer"},"refName":"#/components/parameters/SenderId","modelName":"__components_parameters_SenderId"}] ``` ### Request body ```json {"schema":{"title":"Sender Request","type":"object","example":{"nickname":"Example Orders","from":{"email":"orders@example.com","name":"Example Orders"},"reply_to":{"email":"support@example.com","name":"Example Support"},"address":"1234 Fake St.","address_2":"","city":"San Francisco","state":"CA","zip":"94105","country":"United States"},"refName":"SenderRequest","modelName":"SenderRequest","properties":{"nickname":{"type":"string","description":"A nickname for the Sender. Not used for sending."},"from":{"type":"object","properties":{"email":{"type":"string","description":"The email address from which your recipient will receive emails."},"name":{"type":"string","description":"The name appended to the from email field. Typically your name or company name."}}},"reply_to":{"type":"object","properties":{"email":{"type":"string","description":"The email address to which your recipient will reply."},"name":{"type":"string","description":"The name appended to the reply to email field. Typically your name or company name."}}},"address":{"type":"string","description":"The physical address of the Sender."},"address_2":{"type":"string","description":"Additional Sender address information."},"city":{"type":"string","description":"The city of the Sender."},"state":{"type":"string","description":"The state of the Sender."},"zip":{"type":"string","description":"The zipcode of the Sender."},"country":{"type":"string","description":"The country of the Sender."}}},"encodingType":"application/json"} ``` ### Responses ```json [{"responseCode":"200","schema":{"description":"","content":{"application/json":{"schema":{"title":"Sender","example":{"id":1,"nickname":"Example Orders","from":{"email":"orders@example.com","name":"Example Orders"},"reply_to":{"email":"support@example.com","name":"Example Support"},"address":"1234 Fake St.","address_2":"","city":"San Francisco","state":"CA","zip":"94105","country":"United States","verified":true,"updated_at":1449872165,"created_at":1449872165,"locked":false},"type":"object","required":["address","city","country","created_at","from","id","locked","nickname","reply_to","updated_at","verified"],"refName":"Sender","modelName":"Sender","properties":{"id":{"type":"integer","description":"The unique identifier of the Sender."},"nickname":{"type":"string","description":"A nickname for the Sender. Not used for sending."},"from":{"type":"object","required":["email","name"],"properties":{"email":{"type":"string","description":"The email address from which your recipient will receive emails."},"name":{"type":"string","description":"The name appended to the from email field. Typically your name or company name."}}},"reply_to":{"type":"object","required":["email"],"properties":{"email":{"type":"string","description":"The email address to which your recipient will reply."},"name":{"type":"string","description":"The name appended to the reply to email field. Typically your name or company name."}}},"address":{"type":"string","description":"The physical address of the Sender."},"address_2":{"type":"string","description":"Additional Sender address information."},"city":{"type":"string","description":"The city of the Sender."},"state":{"type":"string","description":"The state of the Sender."},"zip":{"type":"string","description":"The zipcode of the Sender."},"country":{"type":"string","description":"The country of the Sender."},"verified":{"type":"boolean","description":"A boolean flag indicating whether the Sender is verified or not. Only verified Senders can be used to send email."},"locked":{"type":"boolean","description":"A boolean flag that is `true` when the Sender is associated with a campaign in Draft, Scheduled, or In Progress status. You cannot update or delete a locked Sender."},"updated_at":{"type":"integer","description":"The time the Sender was last updated."},"created_at":{"type":"integer","description":"The time the Sender was created."}}}}}}},{"responseCode":"400","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."}}}}},"refName":"#/components/responses/Senders400","modelName":"__components_responses_Senders400"}},{"responseCode":"403","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."}}}}},"refName":"#/components/responses/Senders403","modelName":"__components_responses_Senders403"}},{"responseCode":"404","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."}}}}},"refName":"#/components/responses/Senders404","modelName":"__components_responses_Senders404"}}] ``` Update a specific Sender ```js const client = require("@sendgrid/client"); client.setApiKey(process.env.SENDGRID_API_KEY); const id = 1; const data = { nickname: "Example Orders", from: { email: "orders@example.com", name: "Example Orders", }, reply_to: { email: "support@example.com", name: "Example Support", }, address: "1234 Fake St.", address_2: "", city: "San Francisco", state: "CA", zip: "94105", country: "United States", }; const request = { url: `/v3/marketing/senders/${id}`, 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")) id = 1 data = { "nickname": "Example Orders", "from": {"email": "orders@example.com", "name": "Example Orders"}, "reply_to": {"email": "support@example.com", "name": "Example Support"}, "address": "1234 Fake St.", "address_2": "", "city": "San Francisco", "state": "CA", "zip": "94105", "country": "United States", } response = sg.client.marketing.senders._(id).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 id = 1; var data = @"{ ""nickname"": ""Example Orders"", ""from"": { ""email"": ""orders@example.com"", ""name"": ""Example Orders"" }, ""reply_to"": { ""email"": ""support@example.com"", ""name"": ""Example Support"" }, ""address"": ""1234 Fake St."", ""address_2"": """", ""city"": ""San Francisco"", ""state"": ""CA"", ""zip"": ""94105"", ""country"": ""United States"" }"; var response = await client.RequestAsync( method: SendGridClient.Method.PATCH, urlPath: $"marketing/senders/{id}", 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("/marketing/senders/1"); request.setBody(new JSONObject(new HashMap() { { put("nickname", "Example Orders"); put("from", new HashMap() { { put("email", "orders@example.com"); put("name", "Example Orders"); } }); put("reply_to", new HashMap() { { put("email", "support@example.com"); put("name", "Example Support"); } }); put("address", "1234 Fake St."); put("address_2", ""); put("city", "San Francisco"); put("state", "CA"); put("zip", "94105"); put("country", "United States"); } }).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/marketing/senders/1", host) request.Method = "PATCH" request.Body = []byte(`{ "nickname": "Example Orders", "from": { "email": "orders@example.com", "name": "Example Orders" }, "reply_to": { "email": "support@example.com", "name": "Example Support" }, "address": "1234 Fake St.", "address_2": "", "city": "San Francisco", "state": "CA", "zip": "94105", "country": "United States" }`) 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('{ "nickname": "Example Orders", "from": { "email": "orders@example.com", "name": "Example Orders" }, "reply_to": { "email": "support@example.com", "name": "Example Support" }, "address": "1234 Fake St.", "address_2": "", "city": "San Francisco", "state": "CA", "zip": "94105", "country": "United States" }'); $id = 1; try { $response = $sg->client ->marketing() ->senders() ->_($id) ->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('{ "nickname": "Example Orders", "from": { "email": "orders@example.com", "name": "Example Orders" }, "reply_to": { "email": "support@example.com", "name": "Example Support" }, "address": "1234 Fake St.", "address_2": "", "city": "San Francisco", "state": "CA", "zip": "94105", "country": "United States" }') id = 1 response = sg.client.marketing.senders._(id).patch(request_body: data) puts response.status_code puts response.headers puts response.body ``` ```bash curl -X PATCH "https://api.sendgrid.com/v3/marketing/senders/1" \ --header "Authorization: Bearer $SENDGRID_API_KEY" \ --header "Content-Type: application/json" \ --data '{"nickname": "Example Orders", "from": {"email": "orders@example.com", "name": "Example Orders"}, "reply_to": {"email": "support@example.com", "name": "Example Support"}, "address": "1234 Fake St.", "address_2": "", "city": "San Francisco", "state": "CA", "zip": "94105", "country": "United States"}' ```