# Create a Sender Identity ## API Overview > \[!WARNING] > > This covers the obsolete Legacy Marketing Campaigns API. > \[!NOTE] > > To learn more about the Sender Identities API, see the [Marketing Campaigns Senders API][]. To protect your sending reputation and to uphold legitimate sending behavior, Twilio SendGrid requires customers to verify their [Sender Identities][]. Use either [Domain Authentication][] or Single Sender Verification. [Marketing Campaigns Senders API]: /docs/sendgrid/api-reference/senders [Sender Identities]: /docs/sendgrid/for-developers/sending-email/sender-identity [Domain Authentication]: /docs/sendgrid/ui/account-and-settings/how-to-set-up-domain-authentication ## Operation overview ```json {"path":"https://api.sendgrid.com/v3/senders","method":"post","servers":[{"url":"https://api.sendgrid.com","description":"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 ```json [{"in":"header","name":"Authorization","required":true,"default":"Bearer <>","schema":{"type":"string"}},{"name":"on-behalf-of","in":"header","description":"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 `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](/docs/sendgrid/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.","required":false,"schema":{"type":"string"},"refName":"#/components/parameters/OnBehalfOf","modelName":"__components_parameters_OnBehalfOf"}] ``` ### Request body ```json {"schema":{"example":{"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"},"type":"object","required":["address","city","country","nickname"],"properties":{"nickname":{"type":"string","description":"A nickname for the sender identity. Not used for sending."},"from":{"type":"object","required":["email"]},"reply_to":{"type":"object","required":["email"]},"address":{"type":"string","description":"The physical address of the sender identity."},"address_2":{"type":"string","description":"Additional sender identity address information."},"city":{"type":"string","description":"The city of the sender identity."},"state":{"type":"string","description":"The state of the sender identity."},"zip":{"type":"string","description":"The zipcode of the sender identity."},"country":{"type":"string","description":"The country of the sender identity."}}},"encodingType":"application/json"} ``` ### Responses ```json [{"responseCode":"201","schema":{"description":"","content":{"application/json":{"schema":{"title":"Sender ID","example":{"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},"type":"object","required":["address","city","country","nickname"],"refName":"SenderId","modelName":"SenderId","properties":{"nickname":{"type":"string","description":"A nickname for the sender identity. Not used for sending."},"from":{"type":"object","properties":{"email":{"type":"string","description":"The email address from which your recipient will receive emails."},"name":{"type":"string","description":"The name appended to the from email field. Typically your name or company name."}}},"reply_to":{"type":"object","properties":{"email":{"type":"string","description":"The email address to which your recipient will reply."},"name":{"type":"string","description":"The name appended to the reply to email field. Typically your name or company name."}}},"address":{"type":"string","description":"The physical address of the sender identity."},"address_2":{"type":"string","description":"Additional sender identity address information."},"city":{"type":"string","description":"The city of the sender identity."},"state":{"type":"string","description":"The state of the sender identity."},"zip":{"type":"string","description":"The zipcode of the sender identity."},"country":{"type":"string","description":"The country of the sender identity."},"id":{"type":"integer","description":"The unique identifier of the sender identity."},"verified":{"type":"boolean","description":"If the sender identity is verified or not. Only verified sender identities can be used to send email."},"updated_at":{"type":"integer","description":"The time the sender identity was last updated."},"created_at":{"type":"integer","description":"The time the sender identity was created."},"locked":{"type":"boolean","description":"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."}}},"examples":{"response":{"value":{"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}}}}}}},{"responseCode":"400","schema":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"message":{"type":"string"},"field":{"type":"string"}}}}}},"examples":{"response":{"value":{"errors":[{"message":"The JSON you have submitted cannot be parsed.","field":""},{"message":"You've reached your limit of 100 sender identities. Please delete one or more and try again.","field":""},{"message":"nickname is required.","field":"nickname"},{"message":"You already have a sender identity with the same nickname.","field":"nickname"},{"message":"from_name is required.","field":"from_name"},{"message":"from_email is required.","field":"from_email"},{"message":"From email is not a valid email address.","field":"from_email"},{"message":"reply_to is required.","field":"reply_to"},{"message":"Reply to email is not a valid email address.","field":"reply_to"},{"message":"address is required.","field":"address"},{"message":"city is required.","field":"city"},{"message":"country is required.","field":"country"}]}}}}}}}] ``` Create a Sender Identity ```js const client = require("@sendgrid/client"); client.setApiKey(process.env.SENDGRID_API_KEY); const data = { 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", }; const request = { url: `/v3/senders`, method: "POST", body: data, }; client .request(request) .then(([response, body]) => { console.log(response.statusCode); console.log(response.body); }) .catch((error) => { console.error(error); }); ``` ```python import os from sendgrid import SendGridAPIClient sg = SendGridAPIClient(os.environ.get("SENDGRID_API_KEY")) data = { "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", } response = sg.client.senders.post(request_body=data) print(response.status_code) print(response.body) print(response.headers) ``` ```csharp using System; using System.Collections.Generic; using System.Threading.Tasks; using SendGrid; public class Program { public static async Task Main() { string apiKey = Environment.GetEnvironmentVariable("SENDGRID_API_KEY"); var client = new SendGridClient(apiKey); var data = @"{ ""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"" }"; var response = await client.RequestAsync( method: SendGridClient.Method.POST, urlPath: "senders", requestBody: data); Console.WriteLine(response.StatusCode); Console.WriteLine(response.Body.ReadAsStringAsync().Result); Console.WriteLine(response.Headers.ToString()); } } ``` ```java import com.sendgrid.*; import java.io.IOException; import org.json.JSONObject; import java.util.HashMap; import java.util.Arrays; public class Example { public static void main(String[] args) throws IOException { try { SendGrid sg = new SendGrid(System.getenv("SENDGRID_API_KEY")); Request request = new Request(); request.setMethod(Method.POST); request.setEndpoint("/senders"); request.setBody(new JSONObject(new HashMap() { { put("nickname", "My Sender ID"); put("from", new HashMap() { { put("email", "from@example.com"); put("name", "Example INC"); } }); put("reply_to", new HashMap() { { put("email", "replyto@example.com"); put("name", "Example INC"); } }); put("address", "123 Elm St."); put("address_2", "Apt. 456"); put("city", "Denver"); put("state", "Colorado"); put("zip", "80202"); put("country", "United States"); } }).toString()); Response response = sg.api(request); System.out.println(response.getStatusCode()); System.out.println(response.getBody()); System.out.println(response.getHeaders()); } catch (IOException ex) { throw ex; } } } ``` ```go package main import ( "fmt" "github.com/sendgrid/sendgrid-go" "os" ) func main() { apiKey := os.Getenv("SENDGRID_API_KEY") host := "https://api.sendgrid.com" request := sendgrid.GetRequest(apiKey, "/v3/senders", host) request.Method = "POST" request.Body = []byte(`{ "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" }`) response, err := sendgrid.API(request) if err != nil { fmt.Println(err.Error()) os.Exit(1) } else { fmt.Println(response.StatusCode) fmt.Println(response.Body) fmt.Println(response.Headers) } } ``` ```php /sendgrid-php.php'; $apiKey = getenv("SENDGRID_API_KEY"); $sg = new \SendGrid($apiKey); $request_body = json_decode('{ "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" }'); try { $response = $sg->client->senders()->post($request_body); print $response->statusCode() . "\n"; print_r($response->headers()); print $response->body() . "\n"; } catch (Exception $ex) { echo "Caught exception: " . $ex->getMessage(); } ``` ```ruby require 'sendgrid-ruby' include SendGrid sg = SendGrid::API.new(api_key: ENV['SENDGRID_API_KEY']) data = JSON.parse('{ "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" }') response = sg.client.senders.post(request_body: data) puts response.status_code puts response.headers puts response.body ``` ```bash curl -X POST "https://api.sendgrid.com/v3/senders" \ --header "Authorization: Bearer $SENDGRID_API_KEY" \ --header "Content-Type: application/json" \ --data '{"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"}' ```