Skip to contentSkip to navigationSkip to topbar
Rate this page:
On this page

Create a Sender



API Overview

api-overview page anchor

POST/v3/marketing/senders

Base url: https://api.sendgrid.com

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.


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.

SchemaExample
Property nameTypeRequiredDescriptionChild properties
nicknamestringrequired

A nickname for the Sender. Not used for sending.


fromobjectrequired

reply_toobjectrequired

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.

201401403404500
SchemaExample
Property nameTypeRequiredDescriptionChild properties
idinteger

The unique identifier of the Sender.


nicknamestring

A nickname for the Sender. Not used for sending.


fromobject

reply_toobject

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

create-a-sender page anchor
Node.js
Python
C#
Java
Go
PHP
Ruby
curl

_35
const client = require('@sendgrid/client');
_35
client.setApiKey(process.env.SENDGRID_API_KEY);
_35
_35
const data = {
_35
"nickname": "Example Orders",
_35
"from": {
_35
"email": "orders@example.com",
_35
"name": "Example Orders"
_35
},
_35
"reply_to": {
_35
"email": "support@example.com",
_35
"name": "Example Support"
_35
},
_35
"address": "1234 Fake St.",
_35
"address_2": "",
_35
"city": "San Francisco",
_35
"state": "CA",
_35
"zip": "94105",
_35
"country": "United States"
_35
};
_35
_35
const request = {
_35
url: `/v3/marketing/senders`,
_35
method: 'POST',
_35
body: data
_35
}
_35
_35
client.request(request)
_35
.then(([response, body]) => {
_35
console.log(response.statusCode);
_35
console.log(response.body);
_35
})
_35
.catch(error => {
_35
console.error(error);
_35
});


Rate this page: