UPupflow
Notes

Update Note

This endpoint can be used to update the contents of a note created via the API.

put/notes/{noteId}

Request

  • Base URL
    https://api.upflow.io/v1
  • Auth
    API key in header X-Api-Key and API key in header X-Api-Secret

Request body

bodyRichTextDocument required

A document in Rich Text JSON format. In the UI, it is rendered with Slate.js.

The document is a nested tree structure composed of the following node types:

Element nodes (blocks)

Block-level elements that structure the document content.

  • type (string): The element type. Supported values: "paragraph".
  • children (array): An array of child nodes, which can be text nodes or inline element nodes.

Text nodes (leaves)

The lowest-level nodes containing the actual text content. Adjacent text segments with different formatting are represented as separate text nodes.

  • text (string): The text content.
  • bold (boolean, optional): Bold formatting.
  • italic (boolean, optional): Italic formatting.
  • underline (boolean, optional): Underline formatting.

Link nodes (inline elements)

Inline elements that wrap text nodes to create hyperlinks.

  • type (string): Always "link".
  • url (string): The link URL.
  • children (array): An array of text nodes representing the link text.

Mention nodes (inline elements)

Inline elements that reference a user.

  • type (string): Always "mention".
  • member (object): The referenced member.
    • id (string, uuid): The member's unique identifier.
    • displayName (string): The display name of the member.
    • email (string): The email address of the member.

Response

Note Updated

idstring uuid required

The Note ID.

createdAtstring date-time required

The date at which the note was created (ISO 8601 format).

updatedAtstring date-time required

The date at which the note was last updated (ISO 8601 format).

modifiedAtstring date-time nullable

The date of the last user edit to the note contents (ISO 8601 format).

bodyRichTextDocument required

A document in Rich Text JSON format. In the UI, it is rendered with Slate.js.

The document is a nested tree structure composed of the following node types:

Element nodes (blocks)

Block-level elements that structure the document content.

  • type (string): The element type. Supported values: "paragraph".
  • children (array): An array of child nodes, which can be text nodes or inline element nodes.

Text nodes (leaves)

The lowest-level nodes containing the actual text content. Adjacent text segments with different formatting are represented as separate text nodes.

  • text (string): The text content.
  • bold (boolean, optional): Bold formatting.
  • italic (boolean, optional): Italic formatting.
  • underline (boolean, optional): Underline formatting.

Link nodes (inline elements)

Inline elements that wrap text nodes to create hyperlinks.

  • type (string): Always "link".
  • url (string): The link URL.
  • children (array): An array of text nodes representing the link text.

Mention nodes (inline elements)

Inline elements that reference a user.

  • type (string): Always "mention".
  • member (object): The referenced member.
    • id (string, uuid): The member's unique identifier.
    • displayName (string): The display name of the member.
    • email (string): The email address of the member.
medium'UI' | 'API'

The medium through which the note was created.

Example response

{
  "id": "00a70b35-2be3-4c43-aefb-397190134655",
  "createdAt": "2015-05-05T12:30:00Z",
  "updatedAt": "2015-05-05T12:30:00Z",
  "modifiedAt": "2015-05-05T12:30:00Z",
  "customer": {
    "id": "00a70b35-2be3-4c43-aefb-397190134655",
    "externalId": "1a2c3b",
    "companyName": "Upflow SAS",
    "accountingRef": "UPFL-SAS"
  },
  "user": {
    "id": "00a70b35-2be3-4c43-aefb-397190134655",
    "firstName": "John",
    "lastName": "Doe",
    "email": "user@email.com"
  },
  "invoice": {
    "id": "00a70b35-2be3-4c43-aefb-397190134655",
    "externalId": "92842AB37",
    "customId": "FAC123"
  },
  "medium": "UI",
  "attachments": [
    {
      "id": "00a70b35-2be3-4c43-aefb-397190134655",
      "mimeType": "image/png",
      "fileName": "document.pdf",
      "createdAt": "2015-05-05T12:30:00Z",
      "fileUrl": "https://example.com/files/document.pdf"
    }
  ]
}

Changes

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