Skip to contentSkip to navigationSkip to topbar
On this page

Create Verified Sender Request



API Overview

api-overview page anchor

The Sender Verification API exposes multiple endpoints that allow you to programmatically manage the Sender Identities that are authorized to send email for your account. You can also manage Sender Identities in the SendGrid app by selecting Sender Authentication under Settings in the navigation bar(link takes you to an external page). For full app instructions, see Sender Verification.

The Sender Verification API provides a RESTful interface for creating new Sender Identities, retrieving a list of existing Sender Identities, checking the status of a Sender Identity, updating a Sender Identity, and deleting a Sender Identity.

This API offers additional endpoints to check for domains known to implement DMARC, and resend verification emails to Sender Identities that have yet to complete the verification process.


POST/v3/verified_senders

Base url: https://api.sendgrid.com (for global users and subusers)

Base url: https://api.eu.sendgrid.com (for EU regional subusers)

This endpoint allows you to create a new Sender Identify.

Upon successful submission of a POST request to this endpoint, an identity will be created, and a verification email will be sent to the address assigned to the from_email field. You must complete the verification process using the sent email to fully verify the sender.

If you need to resend the verification email, you can do so with the Resend Verified Sender Request, /resend/{id}, endpoint.

If you need to authenticate a domain rather than a Single Sender, see the Domain Authentication API.


Authentication

authentication page anchor
Property nameTypeRequiredDescription
Authorizationstringrequired
Default: Bearer <<YOUR_API_KEY_HERE>>
Encoding type:application/json
SchemaExample
Property nameTypeRequiredDescriptionChild properties
nicknamestringrequired
Max length: 100

from_emailstring<email>required
Max length: 256

from_namestringOptional
Max length: 256

reply_tostring<email>required
Max length: 256

reply_to_namestringOptional
Max length: 256

addressstringOptional
Max length: 100

address2stringOptional
Max length: 100

statestringOptional
Max length: 2

citystringOptional
Max length: 150

zipstringOptional
Max length: 10

countrystringOptional
Max length: 100
201400401403404500
SchemaExample
Property nameTypeRequiredDescriptionChild properties
idinteger

nicknamestring

from_emailstring

from_namestring

reply_tostring

reply_to_namestring

addressstring

address2string

statestring

citystring

zipstring

countrystring

verifiedboolean

lockedboolean
Create Verified Sender RequestLink to code sample: Create Verified Sender Request
1
const client = require('@sendgrid/client');
2
client.setApiKey(process.env.SENDGRID_API_KEY);
3
4
const data = {
5
"nickname": "Orders",
6
"from_email": "orders@example.com",
7
"from_name": "Example Orders",
8
"reply_to": "orders@example.com",
9
"reply_to_name": "Example Orders",
10
"address": "1234 Fake St",
11
"address2": "PO Box 1234",
12
"state": "CA",
13
"city": "San Francisco",
14
"country": "USA",
15
"zip": "94105"
16
};
17
18
const request = {
19
url: `/v3/verified_senders`,
20
method: 'POST',
21
body: data
22
}
23
24
client.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
});

Need some help?

Terms of service

Copyright © 2024 Twilio Inc.