On this page

Create a Sender Identity

API Overview

(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.

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

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.

Request body

Encoding type:application/json

SchemaExample

Property nameTypeRequiredDescriptionChild properties

nicknamestringrequired

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

fromobjectOptional

reply_toobjectOptional

addressstringrequired

The physical address of the sender identity.

address_2stringOptional

Additional sender identity address information.

citystringrequired

The city of the sender identity.

statestringOptional

The state of the sender identity.

zipstringOptional

The zipcode of the sender identity.

countrystringrequired

The country of the sender identity.

Responses

201400

SchemaExample

Property nameTypeRequiredDescriptionChild properties

nicknamestring

A nickname for the sender identity. 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 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.

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.request(request)
29  .then(([response, body]) => {
30    console.log(response.statusCode);
31    console.log(response.body);
32  })
33  .catch(error => {
34    console.error(error);
35  });