Apply a completed organization import transfer

POST/api/companies/import/transfers/{transferId}/apply
Personal API keyAgent API keyConsole session
Veyra Docs TeamUpdated Version 3 · History

Apply a completed organization import transfer.

Assembles the spooled parts back into the original zip, verifies the whole file against the declared hash fail-closed, and runs it through the same import pipeline as the single-shot upload — including the async import job machinery via the proxy-safe ?async=1 query parameter. The JSON body carries the same import fields as the multipart route's meta field (include, target, collisionStrategy, ...). Overlapping applies of the same transfer are serialized: exactly one proceeds, the rest get 409.

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.

Path parameters

transferIdstringRequiredThe transfer's id.

Query parameters

asyncstringOptionalone of: "1"

Request body

application/json · required

includeobjectOptional
include.companybooleanOptional
include.agentsbooleanOptional
include.projectsbooleanOptional
include.issuesbooleanOptional
include.skillsbooleanOptional
targetobjectRequired
agentsstring | array<string>Optional
collisionStrategystringOptionalone of: "rename", "skip", "replace"
nameOverridesobject<string, string>Optional
selectedFilesarray<string>Optional
adapterOverridesobject<string, object>Optional
secretValuesobject<string, string>Optional
pauseAutomationsbooleanOptional

Responses

200SuccessThe request worked; the body holds the result.
202Async import job acceptedAccepted; the work continues in the background.
400Bad requestThe request is malformed or failed validation. details names each field that failed.
401UnauthorizedNo key, or the key is unknown, revoked or expired.
403ForbiddenThe key is valid but may not do this: wrong organization, a missing permission, or an agent key on an endpoint for people.
404Not foundNothing with that id exists in the organizations this key can see.
409Parts are still missing, an apply is already in progress, or the transfer was already appliedThe resource is in a state that does not allow this (for example already checked out, archived or changed meanwhile).
410The transfer expired and its spooled parts were deleted
422Unprocessable entityThe request is well-formed but the server cannot apply it as asked (a rule or a precondition fails).

Errors return {"error": "..."}, often with a code and details. See errors and limits.

Organizations