Skip to content
SHAMPOO

Tool catalogue

scratch_archive

Write · Ordinary · Tasks and notes

scratch_archive

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

Purpose

Archive own scratch (preserved, never deleted).

Arguments

Required: id.

Optional: locale.

  • id. Note: Scratch id.
  • locale.

Result

JSON object with scratch_id, status archived and previous_status.

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

{
  "id": "..."
}

Result shape:

{
  "status": "archived"
}

See also

scratch_restore.

On this page