cli patch-object
cli patch-object — Micro CLI reference.
Command reference for CLI v1.0.0. Release source.
Patch object
Synopsis
Patch object
cli patch-object [flags]Examples
cli patch-object --team-id e02892d8-39b6-4e01-bdd8-d193f25fde02 --object-type ai_chat_thread --object-id 7d5a55a1-6054-4e9e-86fa-b60e9a64e727Options
--body string Request body as JSON (alternative to individual flags). Can also be provided via stdin.
-b, --body-param string JSON value (one of: { extended: object, default: object, list: object })
-h, --help help for patch-object
--idempotency-key idempotency_key_mismatch A unique key (UUID or any opaque string up to 255 chars) that identifies this logical request. The server caches the first response under this key for 24 hours and replays it on retry — safe to use on every POST/PUT/PATCH to make network retries deterministic. Reusing the same key with a different body returns 409 idempotency_key_mismatch. Replays include the `idempotent-replay: true` response header.
--if-match etag Optimistic concurrency. Pass back the etag header from a previous GET of this record; the write only proceeds if the record hasn't changed since. Mismatch → 412 `precondition_failed`. Use `*` to require the record exists (any ETag accepted).
--object-id string [required]
--object-type string options: deal, identity, ai_chat_thread, ai_chat_message, document, action, event, organization, contact [required]
-t, --team-id string [required]Options inherited from parent commands
--agent-mode Enable structured errors and default TOON output for AI coding agents. Automatically enabled when a known agent environment is detected (CLAUDE_CODE, CURSOR_AGENT, etc.). Use --agent-mode=false to disable.
--api-key x-api-key Public API key generated from Micro settings. Sent as the x-api-key header and validated by AWS API Gateway in front of the service.
--color string Control colored output: auto (color when output is a TTY), always, or never. Respects NO_COLOR and FORCE_COLOR env vars. (default "auto")
-d, --debug Log request and response diagnostics to stderr
--dry-run Preview the request that would be sent without executing it (output to stderr)
-H, --header stringArray Set a custom HTTP request header (format: "Key: Value"). Can be specified multiple times.
--include-headers Include HTTP response headers in the output
-q, --jq string Filter and transform output using a jq expression (e.g., '.name', '.items[] | .id')
--no-interactive Disable all interactive features (auto-prompting, explorer auto-launch, TUI forms)
-o, --output-format string Specify the output format. Options: pretty, json, yaml, table, toon. (default "pretty")
--server string Select a server by index (for indexed servers) or name (for named servers)
--server-url string Override the default server URL
--timeout string HTTP request timeout (e.g., 30s, 5m, 100ms)
--usage Print the CLI Usage schema in KDL formatSEE ALSO
- cli - cli command-line interface