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.
Bearer <<YOUR_API_KEY_HERE>>Optional
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.
The unique identifier of the Sender.
application/jsonOptional
A nickname for the Sender. Not used for sending.
Optional
Optional
Optional
The physical address of the Sender.
Optional
Additional Sender address information.
Optional
The city of the Sender.
Optional
The state of the Sender.
Optional
The zipcode of the Sender.
Optional
The country of the Sender.
The unique identifier of the Sender.
A nickname for the Sender. Not used for sending.
The physical address of the Sender.
Additional Sender address information.
The city of the Sender.
The state of the Sender.
The zipcode of the Sender.
The country of the Sender.
A boolean flag indicating whether the Sender is verified or not. Only verified Senders can be used to send email.
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.
The time the Sender was last updated.
The time the Sender was created.
1const client = require("@sendgrid/client");2client.setApiKey(process.env.SENDGRID_API_KEY);34const id = 1;5const data = {6nickname: "Example Orders",7from: {8email: "orders@example.com",9name: "Example Orders",10},11reply_to: {12email: "support@example.com",13name: "Example Support",14},15address: "1234 Fake St.",16address_2: "",17city: "San Francisco",18state: "CA",19zip: "94105",20country: "United States",21};2223const request = {24url: `/v3/marketing/senders/${id}`,25method: "PATCH",26body: data,27};2829client30.request(request)31.then(([response, body]) => {32console.log(response.statusCode);33console.log(response.body);34})35.catch((error) => {36console.error(error);37});