Skip to contentSkip to navigationSkip to topbar
On this page

Import Contacts Status



Operation overview

operation-overview page anchor

GET/v3/marketing/contacts/imports/{id}

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

This endpoint can be used to check the status of a contact import job.

Use the job_id from the "Import Contacts," "Add or Update a Contact," or "Delete Contacts" endpoints as the id in the path parameter.

If there is an error with your PUT request, download the errors_url file and open it to view more details.

The job status field indicates whether the job is pending, completed, errored, or failed.

Pending means not started. Completed means finished without any errors. Errored means finished with some errors. Failed means finished with all errors, or the job was entirely unprocessable: for example, if you attempt to import file format we do not support.

The results object will have fields depending on the job type.

Twilio SendGrid recommends exporting your contacts regularly as a backup to avoid issues or lost data.


Authentication

authentication page anchor
Property nameTypeRequiredDescription
authorizationstring
required
Default: Bearer <<YOUR_API_KEY_HERE>>
Property nameTypeRequiredDescription
idstring
required
200400401403404500
Schema
Property nameTypeRequiredDescriptionChild properties
idstring

Optional

The job ID.


statusstring

Optional

The job state. Allowed values: pending, completed, errored, or failed.


jobTypestring

Optional

The job type. Allowed values: upsert, or delete.


resultsobject

Optional

Result map of the import job.


startedAtstring

Optional

The ISO8601 timestamp when the job was created.


finishedAtstring

Optional

The ISO8601 timestamp when the job was finished.

Import Contacts StatusLink to code sample: Import Contacts Status
1
const client = require("@sendgrid/client");
2
client.setApiKey(process.env.SENDGRID_API_KEY);
3
4
const id = "id";
5
6
const request = {
7
url: `/v3/marketing/contacts/imports/${id}`,
8
method: "GET",
9
};
10
11
client
12
.request(request)
13
.then(([response, body]) => {
14
console.log(response.statusCode);
15
console.log(response.body);
16
})
17
.catch((error) => {
18
console.error(error);
19
});