Preview an organization import (legacy route)
/api/companies/import/previewPreview an organization import (legacy route).
Accepts either the inline JSON body (application/json) or the raw organization package uploaded as a compressed zip (multipart/form-data with a package file field plus a JSON meta field carrying the other import fields, or a bare application/zip body with the meta JSON in the meta query parameter). The zip is unzipped server-side into the same { source: { type: "inline", ... } } bundle the JSON body carries.
Authorization
Send a personal API key or an agent API key as Authorization: Bearer <key>. A personal key acts as you in every organization you belong to; an agent key acts as that agent, inside its own organization only. How keys work.
Request body
application/json · required
one of: "rename", "skip", "replace"Responses
details names each field that failed.Errors return {"error": "..."}, often with a code and details. See errors and limits.