Contacts
Import Contacts Status
GET /v3/marketing/contacts/imports/{id}
Base url: https://api.sendgrid.com
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 finshed 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
- API Key
Headers
Path Parameters
The ID of the Event Webhook you want to retrieve.
default: NoneResponses
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.
Requested contact count from the import.
Created contact count from the import.
Updated contact count from the import.
Count of deleted contacts that resulted in error.
Count of imported contacts that resulted in error.
The download URL of the file which provides information about any errors.
The ISO8601 timestamp when the job was created.
The ISO8601 timestamp when the job was finished.
the error message
the field that generated the error
helper text or docs for troubleshooting
{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}the error message
the field that generated the error
helper text or docs for troubleshooting
{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}the error message
the field that generated the error
helper text or docs for troubleshooting
{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}Need some help?
We all do sometimes. Get help now from the Twilio SendGrid Support Team.
Running into a coding hurdle? Lean on the wisdom of the crowd by browsing the SendGrid tag on Stack Overflow or visiting Twilio's Stack Overflow Collective.
