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.
Bearer <<YOUR_API_KEY_HERE>>
The job ID.
The job state. Allowed values: pending
, completed
, errored
, or failed
.
The job type. Allowed values: upsert
, or delete
.
Result map of the import job.
The ISO8601 timestamp when the job was created.
The ISO8601 timestamp when the job was finished.
1const client = require("@sendgrid/client");2client.setApiKey(process.env.SENDGRID_API_KEY);34const id = "ZGkrHSypTsudrGkmdpJJ";56const request = {7url: `/v3/marketing/contacts/imports/${id}`,8method: "GET",9};1011client12.request(request)13.then(([response, body]) => {14console.log(response.statusCode);15console.log(response.body);16})17.catch((error) => {18console.error(error);19});