# Bulk Import

Manage contact import jobs

## Import contacts

> Import contacts in bulk with support for custom fields and list management. Existing contacts with matching email addresses will be updated automatically. You can import up to 50,000 contacts per request. The import process runs asynchronously - use the returned import ID to check the status and results.

```json
{"openapi":"3.1.0","info":{"title":"Contacts","version":"2.0.0"},"tags":[{"name":"Bulk Import","description":"Manage contact import jobs"}],"servers":[{"description":"Mailtrap API","url":"https://mailtrap.io"}],"security":[{"HeaderAuth":[]},{"BearerAuth":[]}],"components":{"securitySchemes":{"HeaderAuth":{"type":"apiKey","description":"Pass the API token in the Api-Token","in":"header","name":"Api-Token"},"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"ContactImportRequest":{"title":"Contact Import Request","type":"object","properties":{"contacts":{"type":"array","items":{"type":"object","properties":{"email":{"type":"string"},"fields":{"type":"object","description":"Object of fields in the following format:\n  field_merge_tag: string | integer | float | boolean | date string in ISO-8601 format (yyyy-mm-dd);"},"list_ids_included":{"type":"array","items":{"type":"integer"}},"list_ids_excluded":{"type":"array","items":{"type":"integer"}}}}}}},"ContactImport":{"type":"object","properties":{"id":{"type":"integer"},"status":{"type":"string","enum":["created","started","finished","failed"]},"created_contacts_count":{"type":"integer","description":"_optional_, provided only if __status__ is `finished`"},"updated_contacts_count":{"type":"integer","description":"_optional_, provided only if __status__ is `finished`"},"contacts_over_limit_count":{"type":"integer","description":"_optional_, provided only if __status__ is `finished`"}}},"UnauthenticatedResponse":{"title":"UnauthenticatedResponse","type":"object","properties":{"error":{"type":"string","description":"Error message"}}},"PermissionsDeniedResponse":{"title":"PermissionsDeniedResponse","type":"object","properties":{"errors":{"type":"string","description":"Error message"}}},"ContactImportErrors":{"title":"UnprocessableEntity","type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"email":{"type":"string"},"errors":{"type":"object","properties":{"base":{"type":"array","items":{"type":"string"}},"email":{"type":"array","items":{"type":"string"}},"fields":{"type":"array","items":{"type":"string"}},"field_merge_tag":{"type":"array","items":{"type":"string"}}}}}}}}},"ErrorResponse":{"title":"ErrorResponse","type":"object","properties":{"errors":{"type":"string","description":"Error message"}}}},"responses":{"UNAUTHENTICATED":{"description":"Returns unauthorized error message. Check your credentials.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthenticatedResponse"}}}},"PERMISSION_DENIED":{"description":"Returns forbidden error message. Check your permissions.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PermissionsDeniedResponse"}}}},"INTERNAL_ERROR":{"description":"Internal error. Retry later or contact support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/api/accounts/{account_id}/contacts/imports":{"post":{"description":"Import contacts in bulk with support for custom fields and list management. Existing contacts with matching email addresses will be updated automatically. You can import up to 50,000 contacts per request. The import process runs asynchronously - use the returned import ID to check the status and results.","operationId":"importContacts","summary":"Import contacts","tags":["Bulk Import"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContactImportRequest"}}}},"responses":{"201":{"description":"Contact Import created successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContactImport"}}}},"401":{"$ref":"#/components/responses/UNAUTHENTICATED"},"403":{"$ref":"#/components/responses/PERMISSION_DENIED"},"422":{"description":"Returns validation errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContactImportErrors"}}}},"500":{"$ref":"#/components/responses/INTERNAL_ERROR"}}}}}}
```

## Get Contact Import

> Get Contact Import

```json
{"openapi":"3.1.0","info":{"title":"Contacts","version":"2.0.0"},"tags":[{"name":"Bulk Import","description":"Manage contact import jobs"}],"servers":[{"description":"Mailtrap API","url":"https://mailtrap.io"}],"security":[{"HeaderAuth":[]},{"BearerAuth":[]}],"components":{"securitySchemes":{"HeaderAuth":{"type":"apiKey","description":"Pass the API token in the Api-Token","in":"header","name":"Api-Token"},"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"ContactImport":{"type":"object","properties":{"id":{"type":"integer"},"status":{"type":"string","enum":["created","started","finished","failed"]},"created_contacts_count":{"type":"integer","description":"_optional_, provided only if __status__ is `finished`"},"updated_contacts_count":{"type":"integer","description":"_optional_, provided only if __status__ is `finished`"},"contacts_over_limit_count":{"type":"integer","description":"_optional_, provided only if __status__ is `finished`"}}},"UnauthenticatedResponse":{"title":"UnauthenticatedResponse","type":"object","properties":{"error":{"type":"string","description":"Error message"}}},"PermissionsDeniedResponse":{"title":"PermissionsDeniedResponse","type":"object","properties":{"errors":{"type":"string","description":"Error message"}}},"NotFoundResponse":{"title":"NotFoundResponse","type":"object","properties":{"error":{"type":"string","description":"Error message"}}},"ErrorResponse":{"title":"ErrorResponse","type":"object","properties":{"errors":{"type":"string","description":"Error message"}}}},"responses":{"UNAUTHENTICATED":{"description":"Returns unauthorized error message. Check your credentials.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthenticatedResponse"}}}},"PERMISSION_DENIED":{"description":"Returns forbidden error message. Check your permissions.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PermissionsDeniedResponse"}}}},"NOT_FOUND":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}}},"INTERNAL_ERROR":{"description":"Internal error. Retry later or contact support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/api/accounts/{account_id}/contacts/imports/{import_id}":{"get":{"description":"Get Contact Import","operationId":"getContactImport","summary":"Get Contact Import","tags":["Bulk Import"],"responses":{"200":{"description":"OK.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContactImport"}}}},"401":{"$ref":"#/components/responses/UNAUTHENTICATED"},"403":{"$ref":"#/components/responses/PERMISSION_DENIED"},"404":{"$ref":"#/components/responses/NOT_FOUND"},"500":{"$ref":"#/components/responses/INTERNAL_ERROR"}}}}}}
```
