Skip to main content

Note Workflow Tasks

Note tasks manage notes and note threads attached to entities (orders, contacts, etc.).

Create Note​

task: "Note/Create@1"
name: createNote
inputs:
  entityId: "{{ orderId }}"
  entityType: "Order"
  threadId: "{{ threadId }}"
  content: "Shipment update: package arrived at hub"
  author: "{{ currentUser.name }}"
outputs:
  - name: note
    mapping: "note"

Update Note​

task: "Note/Update@1"
name: updateNote
inputs:
  noteId: "{{ noteId }}"
  content: "Updated note content"

Delete Note​

task: "Note/Delete@1"
name: deleteNote
inputs:
  noteId: "{{ noteId }}"

Import Notes​

Bulk import notes from external data.

task: "Note/Import@1"
name: importNotes
inputs:
  entityId: "{{ orderId }}"
  entityType: "Order"
  notes:
    - content: "Imported note 1"
      author: "System"
      createdDate: "2024-01-15T10:00:00Z"
    - content: "Imported note 2"
      author: "System"
      createdDate: "2024-01-15T11:00:00Z"
outputs:
  - name: importedNotes
    mapping: "notes"

Export Notes​

Export notes for an entity.

task: "Note/Export@1"
name: exportNotes
inputs:
  entityId: "{{ orderId }}"
  entityType: "Order"
outputs:
  - name: notes
    mapping: "notes"

Rename Thread​

Rename an existing note thread.

task: "Note/RenameThread@1"
name: renameThread
inputs:
  threadId: "{{ threadId }}"
  name: "Updated Thread Name"