notes

Update a note's content or pinned state

Update a note's content or pinned state.

patch/v2/notes/{note_id}

Request

  • Base URL
    https://api.stuut.ai (the document declares no server; this is the origin it was published from)
  • Auth
    HTTP bearer

Path parameters

note_idstring required

Request body

contentstring nullable
pinnedboolean nullable

Response

Successful Response

created_atstring date-time required
modified_atstring date-time required
idstring required
contentstring required

The content of the note.

pinnedboolean required

Whether the note is pinned and will show up first.

author_idstring nullable required

The ID of the user who created this note.

partner_idstring nullable required

The ID of the partner this note belongs to.

dispute_idstring nullable required

The ID of the dispute this note belongs to.

invoice_idstring nullable required

The ID of the invoice this note belongs to.

credit_memo_idstring nullable required

The ID of the credit memo this note belongs to.

objectstring required

String representing the object's type. Objects of the same type share the same value.

Changes

No recorded changes to this operation across all 1 revision of this API.