update_note
Modify an existing note on HackMD by updating its content, permalink, read, or write permissions using the note ID and new payload.
Instructions
Update an existing note
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| noteId | Yes | Note ID | |
| payload | Yes | Update note options |
Input Schema (JSON Schema)
{
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"noteId": {
"description": "Note ID",
"type": "string"
},
"payload": {
"additionalProperties": false,
"description": "Update note options",
"properties": {
"content": {
"description": "New note content",
"type": "string"
},
"permalink": {
"description": "Custom permalink",
"type": "string"
},
"readPermission": {
"description": "Read permission",
"enum": [
"owner",
"signed_in",
"guest"
],
"type": "string"
},
"writePermission": {
"description": "Write permission",
"enum": [
"owner",
"signed_in",
"guest"
],
"type": "string"
}
},
"type": "object"
}
},
"required": [
"noteId",
"payload"
],
"type": "object"
}