POST/api/crm/v1/intake-review-commands

Apply an authorized, idempotent intake-review command

The approved contract does not provide a longer purpose statement for this operation.

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

Purpose and use cases

Apply an authorized, idempotent intake-review command

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

Business use cases and out-of-scope behavior are not yet declared in the approved OpenAPI description.

Request

POST /api/crm/v1/intake-review-commands

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:intake:review

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

This operation declares no path or query parameters.

Request body

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

FieldTypeRulesDescription
schemaVersion"vision-crm-intake-review-command.v1"requiredNot described in the contract.
intakeReferencestringrequired; pattern ^IN-[A-F0-9]{12}$Not described in the contract.
expectedRecordVersionintegerrequired; minimum 1Not described in the contract.
idempotencyKeystringrequired; minimum length 16; maximum length 160Not described in the contract.
actionaccept_create | accept_connect | dismiss | leave_pending | request_information | retryrequiredNot described in the contract.

Runnable examples

cURL
curl '${APP_BASE_URL}/api/crm/v1/intake-review-commands' \
  --request POST \
  --header 'authorization: Bearer ${ACCESS_TOKEN}' \
  --header 'accept: application/json' \
  --header 'content-type: application/json' \
  --data '{
    "schemaVersion": "vision-crm-intake-review-command.v1",
    "intakeReference": "<intakeReference>",
    "expectedRecordVersion": 1,
    "idempotencyKey": "<idempotencyKey>",
    "action": "accept_create"
  }'
JavaScript (server-side)
const response = await fetch('${APP_BASE_URL}/api/crm/v1/intake-review-commands', {
  method: 'POST',
  headers: {
    authorization: `Bearer ${ACCESS_TOKEN}`,
    accept: 'application/json',
    'content-type': 'application/json',
  },
  body: JSON.stringify({
  "schemaVersion": "vision-crm-intake-review-command.v1",
  "intakeReference": "<intakeReference>",
  "expectedRecordVersion": 1,
  "idempotencyKey": "<idempotencyKey>",
  "action": "accept_create"
}),
}

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/intake-review-commands',
    data=json.dumps({"schemaVersion":"vision-crm-intake-review-command.v1","intakeReference":"<intakeReference>","expectedRecordVersion":1,"idempotencyKey":"<idempotencyKey>","action":"accept_create"}).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
200An exact replay returned its durable resultobject
201The review command committedobject
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
409Invalid state, stale version, or idempotency conflictobject
503The CRM dependency or authenticated API configuration is unavailableobject

Success response schema

FieldTypeRulesDescription
schemaVersion"vision-crm-intake-review-result.v1"requiredNot described in the contract.
commandReferencestringrequired; pattern ^CMD-[A-F0-9]{12}$Not described in the contract.
intakeReferencestringrequired; pattern ^IN-[A-F0-9]{12}$Not described in the contract.
dispositionaccepted | dismissed | pending | information_requested | retry_requestedrequiredNot described in the contract.
resultingRecordVersionintegerrequired; minimum 1Not described in the contract.
linkedRecordsobjectrequiredNot described in the contract.
replayedbooleanrequiredNot described in the contract.
200 illustrative response
{
  "schemaVersion": "vision-crm-intake-review-result.v1",
  "commandReference": "<commandReference>",
  "intakeReference": "<intakeReference>",
  "disposition": "accepted",
  "resultingRecordVersion": 1,
  "linkedRecords": {},
  "replayed": 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 Invalid state, stale version, or idempotency conflict
  • 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 detailed operation description.
  • No stable operation ID (legacy exception).
  • No direct server URL; gateway routing is unresolved here.
  • 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

  • Contract version: 3.0.0
  • Approved snapshot SHA-256: d882d1017797e0731eee99b9a53bde41bcd39e601524cd89e2028da7f7e04ea2
  • Approval: Anthony Anderson, 2026-08-21T21:22:26.555Z (crm-presentation-20260821)
  • Download the authoritative OpenAPI 3.1 snapshot