Meet the new Scripe, live on October 7.Register

OpenAPI reference · Notes

Update a note

PATCH/notes/{noteId}

Update the note's body and/or move it between folders (folderId: null = root). At least one field is required. The note's calendar placement is not writable here.

Requires the notes:write scope. Honours Idempotency-Key.

Authorization

  • Authorizationstringrequired

    Bearer token in the Authorization header.

    Pass Authorization: Bearer scripe_sk_live_<...> (or scripe_sk_test_<...> for test keys) on every request. Keys are scoped to a single workspace and can be revoked from the Scripe dashboard.

    The same header also accepts an OAuth 2.1 access token (scripe_oat_*); both credentials share one scope vocabulary and every operation below documents the scope it requires. An API key can hold every scope named on this surface except webhooks:manage, which is grantable to OAuth tokens only today — the webhook-endpoint operations answer 403 scope_missing to every API key. Operations that name no scope accept any valid token of the workspace.

Path parameters

  • noteIdstringrequired

Header parameters

  • Scripe-Api-Versionstring

    Pin the API version. Format YYYY-MM-DD. Omit to receive the currently rolling default. Unknown versions return 400 version_unsupported.

Request bodyapplication/json

  • contentstring

    New note body; replaces the existing content.

  • folderIdstring | null

    Move to a folder, or null for the root/inbox.

Responses

  • 200

    The updated note.

  • 400

    Malformed request (bad cursor, bad limit, etc.).

  • 401

    Missing, malformed, expired, or revoked API key.

  • 403

    Plan not eligible, scope missing, or workspace mismatch.

  • 404

    Resource not found in this workspace.

  • 413

    Request body exceeds the size cap.

  • 422

    Body shape was JSON but failed validation (unprocessable).

  • 429

    Sliding-window rate limit exceeded.

Example request

bash
curl --request PATCH \
  --url 'https://api.scripe.io/v1/notes/{noteId}' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "content": "string",
  "folderId": "string"
}'

Example response (200)

json
{
  "data": {
    "id": "note_a1b2c3d4e5f6g7h8",
    "projectId": "string",
    "folderId": "string",
    "content": "string",
    "createdAt": "2026-08-10T09:00:00Z",
    "updatedAt": "2026-08-10T09:00:00Z",
    "slot": {
      "date": "2026-08-10T09:00:00Z",
      "contentType": "PERSONAL"
    }
  }
}