Skip to content
SHAMPOO

Tool catalogue

scratch_save

Write · Ordinary · Tasks and notes

scratch_save

  • Category: tasks
  • Access: write
  • Audience: ordinary (an ordinary user normally calls this directly)

Purpose

Jot down a private scratch note (owner-only).

Arguments

Required: body.

Optional: label, locale, project.

  • body. Note: Required non-empty opaque body (max 32768).
  • label. Note: Optional label (max 120).
  • locale.
  • project. Note: Optional project context.

Result

JSON object with scratch_id.

Boundaries

Owner-private: owner credential only, no star bypass. Misses and foreign rows read as not found. Project is context, never a sharing scope.

Lifecycle / side effects

Active <-> archived; lifecycle only, no delete verb exists.

Errors

Bad ids/transitions rejected. Failures move nothing (atomic).

Example

{
  "body": "Call dentist Tuesday"
}

Result shape:

{
  "scratch_id": "..."
}

See also

scratch_get, scratch_list.

On this page