Skip to content
View as Markdown

POST Import Contacts from CSV​

POST
/import/csv-import

Import contacts from a previously uploaded CSV file. Processes records in batches (default 100 per request). Supports pagination for large files -- call repeatedly with incrementing importing_page until has_more is false. Assigns tags, lists, and status to imported contacts.

Authorizations​

ApplicationPasswords

WordPress Application Passwords — use Basic auth with your WordPress username and an application password in the format: username:application_password

Type
API Key (header: Authorization)

Request Body​

application/json
JSON
{
"file": "string",
"map": [
{
"csv": "string",
"table": "string"
}
],
"tags": [
0
],
"lists": [
0
],
"update": "string",
"new_status": "string",
"double_optin_email": "string",
"import_silently": "string",
"force_update_status": "string",
"delimiter": "comma",
"importing_page": 1
}

Responses​

Batch import result. Check has_more to determine if additional batches remain.

application/json
JSON
{
"total": 0,
"completed": 0,
"total_page": 0,
"skipped": 0,
"invalid_contacts": [
{
}
],
"skipped_contacts": [
{
}
],
"invalid_email_counts": 0,
"inserted": 0,
"updated": 0,
"has_more": true,
"last_page": 0,
"tags": [
0
],
"lists": [
0
],
"offset": 0
}

Playground​

Authorization
Body

Samples​

Powered by VitePress OpenAPI