Update a note

PATCH /api/v1/notes/{note_id}

Partially update a note's title, body, or pinned status.

Operation ID: update_note_api_v1_notes__note_id__patch · View as markdown · OpenAPI slice

Authentication

Bearer token authentication. Pass your DayZero API token in the Authorization header and the target business UUID in x-business-id.

Parameters

Path

note_id string required

Request body

Schema: NoteUpdateRequest

title string
body string
pinned boolean

Responses

200 Successful Response

Schema: NoteResponse

id string required

title string required

body string

pinned boolean

author_id string required

author_name string

author_email string

created_at string · date-time required

updated_at string · date-time required

attachments array · AttachmentResponse AttachmentResponse

7 fields

id string required
note_id string required
file_name string required
file_size integer required
mime_type string required
uploaded_by string required
created_at string · date-time required

400 Bad Request - Invalid input

401 Unauthorized - Authentication required

403 Forbidden - Insufficient permissions

404 Not Found - Resource does not exist

422 Validation Error

Schema: HTTPValidationError

detail array · ValidationError ValidationError

5 fields

loc array · string | integer required
msg string required
type string required
input object
ctx object

Code samples

PATCH /api/v1/notes/{note_id}

bash

curl -X PATCH 'https://api.ondayzero.com/api/v1/notes/{note_id}' \
  -H 'Authorization: Bearer dz_your_token' \
  -H 'x-business-id: YOUR_BUSINESS_ID' \
  -H 'Content-Type: application/json' \
  -d '{
  "title": "string",
  "body": "string",
  "pinned": false
}'

javascript

const response = await fetch('https://api.ondayzero.com/api/v1/notes/{note_id}', {
  method: 'PATCH',
  headers: {
    Authorization: 'Bearer dz_your_token',
    'x-business-id': 'YOUR_BUSINESS_ID',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
  "title": "string",
  "body": "string",
  "pinned": false
}),
});
const data = await response.json();

python

import httpx

headers = {
    "Authorization": "Bearer dz_your_token",
    "x-business-id": "YOUR_BUSINESS_ID",
}

payload = {
  "title": "string",
  "body": "string",
  "pinned": false
}

response = httpx.patch("https://api.ondayzero.com/api/v1/notes/{note_id}", headers=headers, json=payload)
data = response.json()