You are viewing the Legacy Marketing Campaigns API reference. For guidance migrating to the current version of Marketing Campaigns, see Migrating from Legacy Marketing Campaigns
For the most up-to-date information on the Sender Identities API, please visit the new Marketing Campaigns Senders API.
To protect your sending reputation and to uphold legitimate sending behavior, Twilio SendGrid requires customers to verify their Sender Identities.
You can verify one or more Sender Identities using either Domain Authentication or Single Sender Verification.
This endpoint allows you to update a sender identity.
Updates to from.email
require re-verification.
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 ID of the sender identity that you want to retrieve.
application/json
Optional
A nickname for the sender identity. Not used for sending.
Optional
Optional
Optional
The physical address of the sender identity.
Optional
Additional sender identity address information.
Optional
The city of the sender identity.
Optional
The state of the sender identity.
Optional
The zipcode of the sender identity.
Optional
The country of the sender identity.
A nickname for the sender identity. Not used for sending.
The physical address of the sender identity.
Additional sender identity address information.
The city of the sender identity.
The state of the sender identity.
The zipcode of the sender identity.
The country of the sender identity.
The unique identifier of the sender identity.
If the sender identity is verified or not. Only verified sender identities can be used to send email.
The time the sender identity was last updated.
The time the sender identity was created.
True when the sender id is associated to a campaign in the Draft, Scheduled, or In Progress status. You cannot update or delete a locked sender identity.
1const client = require("@sendgrid/client");2client.setApiKey(process.env.SENDGRID_API_KEY);34const sender_id = 4900;5const data = {6nickname: "My Sender ID",7from: {8email: "from@example.com",9name: "Example INC",10},11reply_to: {12email: "replyto@example.com",13name: "Example INC",14},15address: "123 Elm St.",16address_2: "Apt. 456",17city: "Denver",18state: "Colorado",19zip: "80202",20country: "United States",21};2223const request = {24url: `/v3/senders/${sender_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});