Skip to contentSkip to navigationSkip to topbar
On this page

Request a Bulk Email Address Validation Upload URL



API Overview

api-overview page anchor

Email Address Validation is available to Email API Pro and Premier level accounts only. An Email Validation API key is required. See the Email Address Validation overview page for more information.

The Email Address Validation API provides detailed information about the validity of email addresses, which helps you create and maintain contact lists and reduce bounce rates.

The Bulk Email Address Validation API facilitates the asynchronous validation of up to one million email addresses.

With the Bulk Email Address Validation API, you can:

  • Request an upload URL for the email list you wish to verify.
  • Get all Bulk Email Address Validation Jobs.
  • Get a specific Bulk Email Address Validation Job.
  • This API reference page should be used in conjunction with the Email Address Validation Overview page and the Bulk Email Validation Integration Guide.

PUT/v3/validations/email/jobs

Base url: https://api.sendgrid.com (The Twilio SendGrid v3 API)

This endpoint returns a presigned URL and request headers. Use this information to upload a list of email addresses for verification.

Note that in a successful response the content-type header value matches the provided file_type parameter in the PUT request.

Once you have an upload_uri and the upload_headers, you're ready to upload your email address list for verification. For the expected format of the email address list and a sample upload request, see the Bulk Email Address Validation Overview page.


Authentication

authentication page anchor
Property nameTypeRequiredDescription
Authorizationstringrequired
Default: Bearer <<YOUR_API_KEY_HERE>>
Encoding type:application/json
SchemaExample
Property nameTypeRequiredDescriptionChild properties
file_typeenum<string>required

The format of the file you wish to upload.

Possible values:
csvzip
200400500

The request was successful. The response contains the URI and headers where you will upload your email address list.

SchemaExample
Property nameTypeRequiredDescriptionChild properties
job_idstring

The unique ID of the Bulk Email Address Validation Job.


upload_uristring

The URI to use for the request to upload your list of email addresses.


upload_headersarray[object]

Array containing headers and header values.

Request a presigned URL and headers to upload a CSV fileLink to code sample: Request a presigned URL and headers to upload a CSV file
1
const client = require('@sendgrid/client');
2
client.setApiKey(process.env.SENDGRID_API_KEY);
3
4
const data = {
5
"file_type": "csv"
6
};
7
8
const request = {
9
url: `/v3/validations/email/jobs`,
10
method: 'PUT',
11
body: data
12
}
13
14
client.request(request)
15
.then(([response, body]) => {
16
console.log(response.statusCode);
17
console.log(response.body);
18
})
19
.catch(error => {
20
console.error(error);
21
});

Need some help?

Terms of service

Copyright © 2024 Twilio Inc.