archive_record
Archive or unarchive any record in Virtuous CRM. Preview changes before confirming, ensuring safe record management.
Instructions
MUTATING: archive (or unarchive) a record via PUT /api/{object_type}/Archive/{id}.
DO NOT call with confirm=true unless the user explicitly approved it. With confirm=false this performs no change and returns a preview.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| confirm | No | Must be true to actually run. Set ONLY after explicit user approval. | |
| record_id | Yes | The id of the record. | |
| unarchive | No | Unarchive instead of archive. | |
| object_type | Yes | Object that supports archiving, e.g. 'Contact', 'ContactAddress'. |