Skip to content
View as Markdown

POST Import Companies from CSV​

POST
/companies/csv-import

Import companies from a previously uploaded CSV file. Processes up to 100 records per request for batch importing. Use the importing_page parameter to paginate through large files. Supports field mapping via the map parameter, optional updating of existing companies (matched by name), and automatic owner creation from the CSV data.

Required capability: fcrm_manage_contact_cats

Enforced by CompanyPolicy::verifyRequest(), the policy default for this route group.

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
{
"map": [
{
"csv": "string",
"table": "string"
}
],
"file": "string",
"update": "no",
"create_owner": "no",
"delimiter": "comma",
"importing_page": 1
}

Responses​

Batch import completed.

application/json
JSON
{
"total": 0,
"completed": 0,
"total_page": 0,
"skipped": 0,
"has_more": true,
"last_page": 0,
"offset": 0
}

Playground​

Authorization
Body

Samples​

Powered by VitePress OpenAPI