Skip to contentSkip to navigationSkip to topbar
On this page

Update a Sender Identity



API Overview

api-overview page anchor
(warning)

Legacy Marketing Campaigns

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

(information)

Info

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.


PATCH/v3/senders/{sender_id}

Base url: https://api.sendgrid.com (The Twilio SendGrid v3 API)

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

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
sender_idintegerrequired

The ID of the sender identity that you want to retrieve.

Encoding type:application/json
SchemaExample
Property nameTypeRequiredDescriptionChild properties
nicknamestringOptional

A nickname for the sender identity. Not used for sending.


fromobjectOptional

reply_toobjectOptional

addressstringOptional

The physical address of the sender identity.


address_2stringOptional

Additional sender identity address information.


citystringOptional

The city of the sender identity.


statestringOptional

The state of the sender identity.


zipstringOptional

The zipcode of the sender identity.


countrystringOptional

The country of the sender identity.

200400403404
SchemaExample
Property nameTypeRequiredDescriptionChild properties
nicknamestring

A nickname for the sender identity. Not used for sending.


fromobject

reply_toobject

addressstring

The physical address of the sender identity.


address_2string

Additional sender identity address information.


citystring

The city of the sender identity.


statestring

The state of the sender identity.


zipstring

The zipcode of the sender identity.


countrystring

The country of the sender identity.


idinteger

The unique identifier of the sender identity.


verifiedboolean

If the sender identity is verified or not. Only verified sender identities can be used to send email.


updated_atinteger

The time the sender identity was last updated.


created_atinteger

The time the sender identity was created.


lockedboolean

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.

Update a Sender IdentityLink to code sample: Update a Sender Identity
1
const client = require('@sendgrid/client');
2
client.setApiKey(process.env.SENDGRID_API_KEY);
3
4
const sender_id = 4900;
5
const data = {
6
"nickname": "My Sender ID",
7
"from": {
8
"email": "from@example.com",
9
"name": "Example INC"
10
},
11
"reply_to": {
12
"email": "replyto@example.com",
13
"name": "Example INC"
14
},
15
"address": "123 Elm St.",
16
"address_2": "Apt. 456",
17
"city": "Denver",
18
"state": "Colorado",
19
"zip": "80202",
20
"country": "United States"
21
};
22
23
const request = {
24
url: `/v3/senders/${sender_id}`,
25
method: 'PATCH',
26
body: data
27
}
28
29
client.request(request)
30
.then(([response, body]) => {
31
console.log(response.statusCode);
32
console.log(response.body);
33
})
34
.catch(error => {
35
console.error(error);
36
});

Need some help?

Terms of service

Copyright © 2024 Twilio Inc.