On this page

Create a Sender

API Overview

Operation overview

POST/v3/marketing/senders

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

This endpoint allows you to create a new Sender.

You may create up to 100 unique Senders.

Senders are required to be verified before use. If your domain has been authenticated, a new Sender will auto verify on creation. Otherwise an email will be sent to the from.email.

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

Schema

Property nameTypeRequiredDescriptionChild properties

nicknamestringrequired

A nickname for the Sender. Not used for sending.

fromobjectrequired

Show child properties for from

reply_toobjectrequired

Show child properties for reply_to

addressstringrequired

The physical address of the Sender.

address_2stringOptional

Additional Sender address information.

citystringrequired

The city of the Sender.

statestringOptional

The state of the Sender.

zipstringOptional

The zipcode of the Sender.

countrystringrequired

The country of the Sender.

Responses

201401403404500

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.

Create a Sender

1const client = require('@sendgrid/client');
2client.setApiKey(process.env.SENDGRID_API_KEY);
3
4const data = {
5  "nickname": "ZGkrHSypTsudrGkmdpJJ",
6  "from": {
7    "email": "annahamilton@example.org",
8    "name": "Miss Christine Morgan"
9  },
10  "reply_to": {
11    "email": "annahamilton@example.org"
12  },
13  "address": "Unit 3856 Box 3973\nDPO AA 31194",
14  "city": "New Matthew",
15  "country": "Myanmar"
16};
17
18const request = {
19  url: `/v3/marketing/senders`,
20  method: 'POST',
21  body: data
22}
23
24client.request(request)
25  .then(([response, body]) => {
26    console.log(response.statusCode);
27    console.log(response.body);
28  })
29  .catch(error => {
30    console.error(error);
31  });