Skip to contentSkip to navigationSkip to topbar
Rate this page:
On this page

Update a Sender



API Overview

api-overview page anchor

PATCH/v3/marketing/senders/{id}

Base url: https://api.sendgrid.com

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.


Authentication

authentication page anchor
Property nameTypeRequiredDescription
Authorizationstringrequired
Default: Bearer <<YOUR_API_KEY_HERE>>

on-behalf-ofstringOptional

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.

Property nameTypeRequiredDescription
idintegerrequired

The unique identifier of the Sender.

SchemaExample
Property nameTypeRequiredDescriptionChild properties
nicknamestringOptional

A nickname for the Sender. Not used for sending.


fromobjectOptional

reply_toobjectOptional

addressstringOptional

The physical address of the Sender.


address_2stringOptional

Additional Sender address information.


citystringOptional

The city of the Sender.


statestringOptional

The state of the Sender.


zipstringOptional

The zipcode of the Sender.


countrystringOptional

The country of the Sender.

200400403404
SchemaExample
Property nameTypeRequiredDescriptionChild properties
idinteger

The unique identifier of the Sender.


nicknamestring

A nickname for the Sender. Not used for sending.


fromobject

reply_toobject

addressstring

The physical address of the Sender.


address_2string

Additional Sender address information.


citystring

The city of the Sender.


statestring

The state of the Sender.


zipstring

The zipcode of the Sender.


countrystring

The country of the Sender.


verifiedboolean

A boolean flag indicating whether the Sender is verified or not. Only verified Senders can be used to send email.


lockedboolean

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_atinteger

The time the Sender was last updated.


created_atinteger

The time the Sender was created.

Update a specific Sender

update-a-specific-sender page anchor
Node.js
Python
C#
Java
Go
PHP
Ruby
curl

_36
const client = require('@sendgrid/client');
_36
client.setApiKey(process.env.SENDGRID_API_KEY);
_36
_36
const id = 1;
_36
const data = {
_36
"nickname": "Example Orders",
_36
"from": {
_36
"email": "orders@example.com",
_36
"name": "Example Orders"
_36
},
_36
"reply_to": {
_36
"email": "support@example.com",
_36
"name": "Example Support"
_36
},
_36
"address": "1234 Fake St.",
_36
"address_2": "",
_36
"city": "San Francisco",
_36
"state": "CA",
_36
"zip": "94105",
_36
"country": "United States"
_36
};
_36
_36
const request = {
_36
url: `/v3/marketing/senders/${id}`,
_36
method: 'PATCH',
_36
body: data
_36
}
_36
_36
client.request(request)
_36
.then(([response, body]) => {
_36
console.log(response.statusCode);
_36
console.log(response.body);
_36
})
_36
.catch(error => {
_36
console.error(error);
_36
});


Rate this page: