Menu

Expand
Rate this page:

Sender Identities API

Create a Sender Identity

POST /v3/senders

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

This endpoint allows you to create a new sender identity.

You may create up to 100 unique sender identities.

Authentication

  • API Key

Headers

Authorization
string
default: Bearer <<YOUR_API_KEY_HERE>>
required
on-behalf-of
string
default: The subuser's username. This header generates the API call as if the subuser account was making the call.

Request Body

object
nickname
string

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

required
from
object
reply_to
object
address
string

The physical address of the sender identity.

required
address_2
string

Additional sender identity address information.

city
string

The city of the sender identity.

required
state
string

The state of the sender identity.

zip
string

The zipcode of the sender identity.

country
string

The country of the sender identity.

required
{
  "nickname": "My Sender ID",
  "from": {
    "email": "from@example.com",
    "name": "Example INC"
  },
  "reply_to": {
    "email": "replyto@example.com",
    "name": "Example INC"
  },
  "address": "123 Elm St.",
  "address_2": "Apt. 456",
  "city": "Denver",
  "state": "Colorado",
  "zip": "80202",
  "country": "United States"
}

Responses

object
nickname
string

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

required
from
object
email
string

The email address from which your recipient will receive emails.

name
string

The name appended to the from email field. Typically your name or company name.

reply_to
object
email
string

The email address to which your recipient will reply.

name
string

The name appended to the reply to email field. Typically your name or company name.

address
string

The physical address of the sender identity.

required
address_2
string

Additional sender identity address information.

city
string

The city of the sender identity.

required
state
string

The state of the sender identity.

zip
string

The zipcode of the sender identity.

country
string

The country of the sender identity.

required
id
integer

The unique identifier of the sender identity.

verified
boolean

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

updated_at
integer

The time the sender identity was last updated.

created_at
integer

The time the sender identity was created.

locked
boolean

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.

{
  "id": 1,
  "nickname": "My Sender ID",
  "from": {
    "email": "from@example.com",
    "name": "Example INC"
  },
  "reply_to": {
    "email": "replyto@example.com",
    "name": "Example INC"
  },
  "address": "123 Elm St.",
  "address_2": "Apt. 456",
  "city": "Denver",
  "state": "Colorado",
  "zip": "80202",
  "country": "United States",
  "verified": true,
  "updated_at": 1449872165,
  "created_at": 1449872165,
  "locked": false
}
object
errors
array[object]
message
string
field
string
        
        
        
        Rate this page:

        Need some help?

        We all do sometimes. Get help now from the Twilio SendGrid Support Team.

        Running into a coding hurdle? Lean on the wisdom of the crowd by browsing the SendGrid tag on Stack Overflow or visiting Twilio's Stack Overflow Collective.

              
              
              

              Thank you for your feedback!

              Please select the reason(s) for your feedback. The additional information you provide helps us improve our documentation:

              Sending your feedback...
              🎉 Thank you for your feedback!
              Something went wrong. Please try again.

              Thanks for your feedback!

              Refer us and get $10 in 3 simple steps!

              Step 1

              Get link

              Get a free personal referral link here

              Step 2

              Give $10

              Your user signs up and upgrade using link

              Step 3

              Get $10

              1,250 free SMSes
              OR 1,000 free voice mins
              OR 12,000 chats
              OR more