Sender Identities API
Update a Sender Identity
PATCH /v3/senders/{sender_id}
Base url: https://api.sendgrid.com
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.
Authentication
- API Key
Headers
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.
Request Body
A nickname for the Sender. Not used for sending.
The email address from which your recipient will receive emails.
The name appended to the from email field. Typically your name or company name.
The email address to which your recipient will reply.
The name appended to the reply to email field. Typically your name or company name.
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.
{
"nickname": "My Sender ID",
"from": {
"email": "from@example.com",
"name": "Example INC"
},
"reply_to": {
"email": "replyto@example.com",
"name": "Example INC"
},
"address": "123 Elm St.",
"address_2": "Apt. 456",
"city": "Denver",
"state": "Colorado",
"zip": "80202",
"country": "United States"
}Path Parameters
The ID of the sender identity that you want to retrieve.
default: NoneResponses
The unique identifier of the Sender.
A nickname for the Sender. Not used for sending.
The email address from which your recipient will receive emails.
The name appended to the from email field. Typically your name or company name.
The email address to which your recipient will reply.
The name appended to the reply to email field. Typically your name or company name.
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.
{
"id": 1,
"nickname": "My Sender ID",
"from": {
"email": "from@example.com",
"name": "Example INC"
},
"reply_to": {
"email": "replyto@example.com",
"name": "Example INC"
},
"address": "123 Elm St.",
"address_2": "Apt. 456",
"city": "Denver",
"state": "Colorado",
"zip": "80202",
"country": "United States",
"verified": true,
"updated_at": 1449872165,
"created_at": 1449872165,
"locked": false
}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.
