---
title: "Record a processed workspace-opening checkpoint so later openings show newer activity."
method: POST
path: "/v1/open/acknowledge"
---

# Record a processed workspace-opening checkpoint so later openings show newer activity.

`POST /v1/open/acknowledge`

## Request

- Base URL: `https://api.candor.money`
- URL: `https://api.candor.money/v1/open/acknowledge`
- Auth: HTTP bearer

Record that activity through the exact opening snapshot has been processed. The checkpoint is the opening's data.new_since_checkpoint.checkpoint_candidate, also carried as args.checkpoint on the opening's open.acknowledge next action. An opening with nothing new records its own checkpoint and offers no acknowledgement. Later openings show newer activity; review areas stay until you record what came of them, and attention and due notes remain until resolved.

## Headers

- `Idempotency-Key` string, required

## Request body

- WorkspaceOpenAcknowledgeRequest
  - `checkpoint` string, required: The exact checkpoint returned by an opening you have processed, from its data.new_since_checkpoint.checkpoint_candidate or the args.checkpoint of its open.acknowledge next action. Marks activity through that snapshot as seen across the workspace, without resolving attention or due notes. Later activity remains new.

## Response `200`

Workspace checkpoint acknowledgement envelope.

- ResponseEnvelope
  - `schema_version` string, required
  - `generated_at` string, date-time, required
  - `request_id` string, required
  - `status` 'success' | 'partial_success' | 'action_required' | 'error', required
  - `user_message` string: Optional concise user-safe message the calling agent may adapt.
  - `data_freshness` DataFreshness
    - `balances_last_synced_at` string
    - `coverage` 'complete' | 'partial' | 'stale' | 'unavailable', required
    - `holdings_last_synced_at` string
    - `transactions_last_synced_at` string
  - `metadata` object: Response-level protocol metadata such as package compatibility and workspace opening identity or timing. It is not financial workspace data and must not be treated as attention.
    - `view_url` string, uri: Authenticated dashboard destination related to this response. May open a section rather than reproduce the returned records or filters. Per-record view_url values identify exact supported record views. Use returned URLs instead of constructing paths.
  - `warnings` object[], required
  - `errors` AgentError[], required
    - `code` string, required
    - `expires_at` string
    - `idempotency_key` string: Stable key to reuse when retrying this identical logical operation.
    - `message` string, required
    - `recovery_url` string, uri
    - `required_capability` string
    - `retry_after_seconds` integer: Machine-actionable delay before retrying the identical logical operation.
    - `retryable` boolean, required
    - `suggested_command` string
  - `next_actions` AgentAction[], required
    - `intent` string, required
    - `command` string, required
    - `args` object, required
    - `shell` string, required
  - `action` WorkspaceAction
    - `id` string, required
    - `operation` string, required
    - `reason` string, required
    - `root_action_id` string, required
    - `parent_action_id` string
    - `task_key` string
    - `status` 'started' | 'succeeded' | 'refused' | 'failed', required
    - `created_at` string, date-time, required
    - `completed_at` string, date-time
  - `data` object, nullable, required: Operation-specific result data, or null when the request ends in an error.

## Other responses

- `default`: Structured Candor error envelope with machine-readable codes, recovery guidance, and retry timing when applicable.

---

[API](https://skmtc.dev/candor/apis/candor-api.md) · [All operations](https://skmtc.dev/candor/apis/candor-api/llms.txt) · [OpenAPI document](https://skmtc.dev/candor/apis/candor-api/revisions/6c050f72e956?raw)