On this page

Update a Sender

API Overview

Operation overview

PATCH/v3/marketing/senders/{id}

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

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.

Operation details

Authentication

API Key

Headers

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.

Path parameters

Property nameTypeRequiredDescription

idintegerrequired

The unique identifier of the Sender.

Request body

Encoding type:application/json

SchemaExample

Property nameTypeRequiredDescriptionChild properties

nicknamestringOptional

A nickname for the Sender. Not used for sending.

fromobjectOptional

Show child properties for from

reply_toobjectOptional

Show child properties for reply_to

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.

Responses

200400403404

SchemaExample

Property nameTypeRequiredDescriptionChild properties

idinteger

The unique identifier of the Sender.

nicknamestring

A nickname for the Sender. Not used for sending.

fromobject

Show child properties for from

reply_toobject

Show child properties for reply_to

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

1const client = require("@sendgrid/client");
2client.setApiKey(process.env.SENDGRID_API_KEY);
3
4const id = 1;
5const data = {
6  nickname: "Example Orders",
7  from: {
8    email: "orders@example.com",
9    name: "Example Orders",
10  },
11  reply_to: {
12    email: "support@example.com",
13    name: "Example Support",
14  },
15  address: "1234 Fake St.",
16  address_2: "",
17  city: "San Francisco",
18  state: "CA",
19  zip: "94105",
20  country: "United States",
21};
22
23const request = {
24  url: `/v3/marketing/senders/${id}`,
25  method: "PATCH",
26  body: data,
27};
28
29client
30  .request(request)
31  .then(([response, body]) => {
32    console.log(response.statusCode);
33    console.log(response.body);
34  })
35  .catch((error) => {
36    console.error(error);
37  });