POST/api/crm/v1/imports/{reference}/undo

Undo the whole import: remove what it created and restore what it changed

Spreadsheet import (Vision Core's module import protocol, vision-module-import.v1). Owners and administrators only. Imports never email, notify or otherwise contact the people in the file. Records changed since the import are kept and counted.

App
CRM
Contract
CRM API 9.12.1
Lifecycle
preview
Runtime
restricted
Operation ID
Not declared (legacy exception)
Canonical origin
Not declared; gateway routing required

Purpose and use cases

Undo the whole import: remove what it created and restore what it changed

The owning App is Vision CRM. CRM owns its records, workflow rules, workspace membership, provenance, and record-level authorization.

Request

POST /api/crm/v1/imports/{reference}/undo

This contract intentionally declares no direct server URL. Obtain the routed App origin before attempting the request.

Authentication and authorization

Send a Vision-issued bearer token for the exact App audience. The token must include the crm entitlement and satisfy the crm workspace required binding.

  • Required scope: crm:people:write

Human roles are not declared in OpenAPI. Record-level and business permission checks remain the owning App's authority.

Headers

  • Authorization: Bearer <access-token> — required.
  • Accept: application/json — recommended where a JSON response is declared.
  • Content-Type: application/json — required for the documented request representation.

Undeclared tracing, idempotency, conditional-request, and version headers are not assumed on this page.

Path and query parameters

NameLocationTypeRulesDescription
referencepathstringrequired; pattern ^IMP-[A-F0-9]{12}$Not described in the contract.

Request body

Media type: application/json. The body is required.

FieldTypeRulesDescription
schemaVersion"vision-module-import.v1"requiredNot described in the contract.
idempotencyKeystringrequired; minimum length 16; maximum length 160; pattern ^[A-Za-z0-9._:-]+$Not described in the contract.

Runnable examples

cURL
curl '${APP_BASE_URL}/api/crm/v1/imports/${REFERENCE}/undo' \
  --request POST \
  --header 'authorization: Bearer ${ACCESS_TOKEN}' \
  --header 'accept: application/json' \
  --header 'content-type: application/json' \
  --data '{
    "schemaVersion": "vision-module-import.v1",
    "idempotencyKey": "<idempotencyKey>"
  }'
JavaScript (server-side)
const response = await fetch('${APP_BASE_URL}/api/crm/v1/imports/${REFERENCE}/undo', {
  method: 'POST',
  headers: {
    authorization: `Bearer ${ACCESS_TOKEN}`,
    accept: 'application/json',
    'content-type': 'application/json',
  },
  body: JSON.stringify({
  "schemaVersion": "vision-module-import.v1",
  "idempotencyKey": "<idempotencyKey>"
}),
}

if (!response.ok) throw new Error(`Vision API ${response.status}`)
const result = await response.json()
Python 3 standard library
import json
import urllib.parse
import urllib.request

request = urllib.request.Request(
    '${APP_BASE_URL}/api/crm/v1/imports/${REFERENCE}/undo',
    data=json.dumps({"schemaVersion":"vision-module-import.v1","idempotencyKey":"<idempotencyKey>"}).encode(),
    headers={
    "Accept": "application/json",
    "Authorization": "Bearer <ACCESS_TOKEN>",
    "Content-Type": "application/json"
},
    method='POST',
)
with urllib.request.urlopen(request, timeout=30) as response:
    result = json.load(response)

The current TypeScript reference client covers Platform token exchange and core reads. No native SDK helper is declared for this operation; use the HTTP contract directly and follow the SDK guidance.

Responses

StatusMeaningSchema
202The import, undoingobject
400The request is invalidobject
401Authentication is missing or invalidobject
403The authenticated actor lacks the CRM capability or workspace bindingobject
404No accessible CRM record was foundobject
409The import cannot take that step in its current state (already started, rows missing, stage unavailable, nothing to undo).object
503The CRM dependency or authenticated API configuration is unavailableobject

Success response schema

FieldTypeRulesDescription
referencestringrequired; pattern ^IMP-[A-F0-9]{12}$Not described in the contract.
fileNamestringrequiredNot described in the contract.
fileKindcsv | xlsxoptionalNot described in the contract.
statusdraft | queued | running | done | failed | undo_queued | undoing | undonerequiredNot described in the contract.
statusLabelstringrequiredNot described in the contract.
statusToneneutral | info | success | warning | dangerrequiredNot described in the contract.
targetstring | nulloptionalNot described in the contract.
targetLabelstring | nulloptionalNot described in the contract.
duplicatePolicystring | nulloptionalNot described in the contract.
totalRowsintegerrequiredNot described in the contract.
stagedRowsintegeroptionalNot described in the contract.
progressobjectrequiredNot described in the contract.
progress.doneintegeroptionalNot described in the contract.
progress.totalintegeroptionalNot described in the contract.
progress.labelstringoptionalNot described in the contract.
countsobjectrequiredNot described in the contract.
failurestring | nulloptionalNot described in the contract.
startedBystring | nulloptionalNot described in the contract.
createdAtstring · date-timeoptionalNot described in the contract.
finishedAtstring | nulloptionalNot described in the contract.
undoneAtstring | nulloptionalNot described in the contract.
canUndobooleanrequiredNot described in the contract.
isRunningbooleanrequiredNot described in the contract.
202 illustrative response
{
  "reference": "<reference>",
  "fileName": "<fileName>",
  "fileKind": "csv",
  "status": "draft",
  "statusLabel": "<statusLabel>",
  "statusTone": "neutral",
  "target": "<target>",
  "targetLabel": "<targetLabel>",
  "duplicatePolicy": "<duplicatePolicy>",
  "totalRows": 1,
  "stagedRows": 1,
  "progress": {
    "done": 1,
    "total": 1,
    "label": "<label>"
  },
  "counts": {},
  "failure": "<failure>",
  "startedBy": "<startedBy>",
  "createdAt": "2026-08-21T18:00:00Z",
  "finishedAt": "<finishedAt>",
  "undoneAt": "<undoneAt>",
  "canUndo": true,
  "isRunning": true
}

Errors and troubleshooting

Error bodies and codes are shown only where the approved contract declares them. Use status, the declared error schema, and any correlation identifier returned by the App; do not infer that two Apps share one envelope.

  • 400 — The request is invalid
  • 401 — Authentication is missing or invalid
  • 403 — The authenticated actor lacks the CRM capability or workspace binding
  • 404 — No accessible CRM record was found
  • 409 — The import cannot take that step in its current state (already started, rows missing, stage unavailable, nothing to undo).
  • 503 — The CRM dependency or authenticated API configuration is unavailable

Collection behavior

Pagination: not declared. Filtering/search: not declared. Sorting: not declared.

Cursor lifetime, cursor binding, stable ordering, maximum traversal, and unknown-filter behavior are not assumed unless stated by a parameter description or schema constraint above.

Operational behavior

  • Rate limit: No operation-specific limit or 429 response is declared.
  • Retry: Retry only when the documented error model or response headers authorize it. Timeout and backoff values are not declared by this operation.
  • Idempotency: No idempotency header or replay window is declared.
  • Concurrency: No ETag, If-Match, or optimistic-version header is declared.

Security and privacy

  • Keep client credentials and bearer tokens on trusted servers.
  • Send only to the exact approved HTTPS origin and audience.
  • Treat response data according to the owning App's classification and retention policy; the OpenAPI contract does not itself grant data access.
  • Do not log credentials, tokens, complete private payloads, or secrets.

Edge cases and known documentation gaps

  • No stable operation ID (legacy exception).
  • No direct server URL; gateway routing is unresolved here.
  • One or more parameters have no field-level description.
  • The request body has no purpose or conditional-rule description.
  • Business roles, timeout, retry budget, rate value, idempotency window, and concurrency behavior are absent unless explicitly stated above.

Contract history and evidence