Method: NotesClient#archive_note

Defined in:
lib/lockstep_sdk/clients/notes_client.rb

#archive_note(id:) ⇒ Object

Archives the Note with the unique ID specified.

A note is a customizable text string that can be attached to various account attributes within Lockstep. You can use notes for internal communication, correspondence with clients, or personal reminders. The Note Model represents a note and a number of different metadata attributes related to the creation, storage, and ownership of the note.

See [Extensibility](developer.lockstep.io/docs/extensibility) for more information.

Parameters:

  • id (uuid) —

    Note id to be archived



50
51
52
53
 
# File 'lib/lockstep_sdk/clients/notes_client.rb', line 50

def archive_note(id:)
    path = "/api/v1/Notes/#{id}"
    @connection.request(:delete, path, nil, nil)
end