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
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
A nickname for the sender identity. Not used for sending.
The physical address of the sender identity.
Additional sender identity address information.
The city of the sender identity.
The state of the sender identity.
The zipcode of the sender identity.
The country of the sender identity.
{
"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
A nickname for the sender identity. Not used for sending.
The email address from which your recipient will receive emails.
The name appended to the from email field. Typically your name or company name.
The email address to which your recipient will reply.
The name appended to the reply to email field. Typically your name or company name.
The physical address of the sender identity.
Additional sender identity address information.
The city of the sender identity.
The state of the sender identity.
The zipcode of the sender identity.
The country of the sender identity.
The unique identifier of the sender identity.
If the sender identity is verified or not. Only verified sender identities can be used to send email.
The time the sender identity was last updated.
The time the sender identity was created.
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
}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.
