Skip to content
View as Markdown

POST Upload CSV for Import​

POST
/import/csv-upload

Upload a CSV file for contact or company import. Returns the parsed CSV headers, mappable subscriber/company fields, and auto-matched column mappings. The uploaded file is stored temporarily for the subsequent import step.

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​

multipart/form-data
object

The CSV file to upload. Must have a valid CSV MIME type.

Format"binary"

CSV delimiter type. comma uses ,, semicolon uses ;.

Valid values"comma""semicolon"
Default"comma"

Type of import. If company, returns company-specific mappable fields.

Valid values"contact""company"

Responses​

CSV parsed successfully. Returns headers, mappable fields, and auto-matched mappings.

application/json
JSON
{
"file": "string",
"headers": [
"string"
],
"fields": {
"additionalProperties": "string"
},
"columns": [
"string"
],
"map": [
{
"csv": "string",
"table": "string"
}
]
}

Playground​

Authorization
Body

Samples​

Powered by VitePress OpenAPI