Archive Note

Archive a note by setting its archived status to true

PATCH /api/notes/:id/archive

Archive Note

cURL

curl --request PATCH \
  --url https://arfan-notes.val.run/api/notes/:id/archive

import requests

url = "https://arfan-notes.val.run/api/notes/:id/archive"

response = requests.patch(url)

print(response.text)

const options = {method: 'PATCH'};

fetch('https://arfan-notes.val.run/api/notes/:id/archive', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://arfan-notes.val.run/api/notes/:id/archive",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://arfan-notes.val.run/api/notes/:id/archive"

	req, _ := http.NewRequest("PATCH", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://arfan-notes.val.run/api/notes/:id/archive")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://arfan-notes.val.run/api/notes/:id/archive")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)

response = http.request(request)
puts response.read_body

Success Response

{
  "id": 23,
  "title": "Advanced CSS Techniques",
  "content": "Modern CSS techniques including Grid, Flexbox, and custom properties...",
  "category": "css",
  "group": "first",
  "color": "primary",
  "archived": true,
  "createdAt": "2024-01-25T14:30:00Z",
  "updatedAt": "2024-01-25T17:20:00Z"
}

{
  "error": "Note with ID 23 not found"
}

{
  "error": "Note is already archived"
}

Archive Note

Archive a note by setting its archived status to true. Archived notes are hidden from regular views but can still be retrieved with filters.

Path Parameters

id · integer · required

The unique identifier of the note to archive

Examples

cURL

curl -X PATCH "https://arfan-notes.val.run/api/notes/23/archive" \
  -H "Content-Type: application/json"

const noteId = 23;

const response = await fetch(`https://arfan-notes.val.run/api/notes/${noteId}/archive`, {
  method: 'PATCH',
  headers: {
    'Content-Type': 'application/json'
  }
});

const archivedNote = await response.json();
console.log(archivedNote);

import requests

note_id = 23

response = requests.patch(
    f'https://arfan-notes.val.run/api/notes/{note_id}/archive',
    headers={'Content-Type': 'application/json'}
)

archived_note = response.json()
print(archived_note)

Response

Success Response

{
  "id": 23,
  "title": "Advanced CSS Techniques",
  "content": "Modern CSS techniques including Grid, Flexbox, and custom properties...",
  "category": "css",
  "group": "first",
  "color": "primary",
  "archived": true,
  "createdAt": "2024-01-25T14:30:00Z",
  "updatedAt": "2024-01-25T17:20:00Z"
}

{
  "error": "Note with ID 23 not found"
}

{
  "error": "Note is already archived"
}

Behavior

• Sets the archived field to true
• Updates the updatedAt timestamp
• Returns the complete updated note object
• Archived notes can still be retrieved using the filtered endpoint with archived=true

Use Cases

• Content Management: Remove outdated notes from active views
• Organization: Keep historical notes without cluttering the main interface
• Soft Delete: Archive instead of permanently deleting notes
• Workflow Management: Mark completed or obsolete notes as archived

Related Endpoints

• Use Unarchive Note to restore an archived note
• Use Get Filtered Notes with archived=true to retrieve archived notes
• Use Get Filtered Notes with archived=false to exclude archived notes