Create a Sender Identity

API Overview

(warning)

Legacy Marketing Campaigns

This covers the obsolete Legacy Marketing Campaigns API.

(information)

Use the Sender Identities API

To learn more about the Sender Identities API, see the Marketing Campaigns Senders API.

To protect your sending reputation and to uphold legitimate sending behavior, Twilio SendGrid requires customers to verify their Sender Identities. Use either Domain Authentication or Single Sender Verification.

Operation overview

POST/v3/senders

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

This endpoint allows you to create a new sender identity.

You may create up to 100 unique sender identities.

Operation details

Authentication

API Key

Headers

Property nameTypeRequiredDescription

Authorizationstring

required

Default: Bearer <<YOUR_API_KEY_HERE>>

on-behalf-ofstring

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.

Request body

Encoding type:application/json

SchemaExample

Property nameTypeRequiredDescriptionChild properties

nicknamestring

required

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

fromobject

Optional

reply_toobject

Optional

addressstring

required

The physical address of the sender identity.

address_2string

Optional

Additional sender identity address information.

citystring

required

The city of the sender identity.

statestring

Optional

The state of the sender identity.

zipstring

Optional

The zipcode of the sender identity.

countrystring

required

The country of the sender identity.

Responses

201400

SchemaExample

Property nameTypeRequiredDescriptionChild properties

nicknamestring

Optional

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

fromobject

Optional

Show from properties

reply_toobject

Optional

Show reply_to properties

addressstring

Optional

The physical address of the sender identity.

address_2string

Optional

Additional sender identity address information.

citystring

Optional

The city of the sender identity.

statestring

Optional

The state of the sender identity.

zipstring

Optional

The zipcode of the sender identity.

countrystring

Optional

The country of the sender identity.

idinteger

Optional

The unique identifier of the sender identity.

verifiedboolean

Optional

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

updated_atinteger

Optional

The time the sender identity was last updated.

created_atinteger

Optional

The time the sender identity was created.

lockedboolean

Optional

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.

Create a Sender Identity

1const client = require("@sendgrid/client");
2client.setApiKey(process.env.SENDGRID_API_KEY);
3
4const data = {
5  nickname: "My Sender ID",
6  from: {
7    email: "from@example.com",
8    name: "Example INC",
9  },
10  reply_to: {
11    email: "replyto@example.com",
12    name: "Example INC",
13  },
14  address: "123 Elm St.",
15  address_2: "Apt. 456",
16  city: "Denver",
17  state: "Colorado",
18  zip: "80202",
19  country: "United States",
20};
21
22const request = {
23  url: `/v3/senders`,
24  method: "POST",
25  body: data,
26};
27
28client
29  .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  });