Actions94
- Action Item Actions
- Assessment Actions
- Assessment Template Actions
- Client Actions
- Contact Actions
- Contract (Core) Actions
- Contract (Lifecycle) Actions
- Goal Actions
- Hardware Asset Actions
- Hardware Lifecycle Actions
- Initiative Actions
- Meeting Actions
- Member Actions
- Note Actions
- Opportunity Actions
- SaaS Actions
- Ticket Actions
Note → Toggle Archive Status
AI-generatedSummary
Toggle a note's archive status by setting its archived state based on the provided boolean value.
Inputs
- Note ID (required) — The ID of the note to update.
- Is Archived (required) — Boolean indicating whether the note should be archived (true) or unarchived (false).
Output shape
a single updated note record
The operation returns the updated note data reflecting the changed archive status. If the note ID is invalid or the update fails, an error is returned.
Examples
Example 1: Archive a note with ID 123
Set Note ID to '123' and Is Archived to true.
Example 2: Unarchive a note with ID 123
Set Note ID to '123' and Is Archived to false.