Update note

Notes View as Markdown

PATCH/api/note/{noteId}

Updates a note in the current space.

Parameters

noteIdintegerpathRequired: ID of the note.

Request body

namestring: Title of the note (1 to 255 characters).
parentIdinteger | null: ID of the new parent note, to move the note. null moves it to the top level.
projectIdinteger: ID of the project to move the note to.
descriptionstring | null: Body of the note as Markdown (up to 1,000,000 characters). null clears it.
isWipboolean | null: Marks the note as work in progress.

Responses

200Note updated
400Invalid request payload or move state
401Authentication is required
404Note not found

Request

curl -X PATCH "https://<space>.repsona.com/api/note/{noteId}" \
  -H "Authorization: Bearer $REPSONA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Release checklist (v1)",
    "description": "## Before launch\n\n- Run the full regression suite\n- Confirm the redirect map with marketing\n- Announce the maintenance window\n- Back up the old site",
    "isWip": false
  }'

Example response

{
  "note": {
    "id": 187,
    "parentId": null,
    "projectId": 288,
    "spaceId": 603,
    "name": "Release checklist (v1)",
    "sortOrder": null,
    "isWip": false,
    "createdAt": 1793662619233,
    "updatedAt": 1793662619266,
    "deletedAt": null,
    "tags": []
  },
  "siblings": []
}