/notes

POST /notes

Create a new note

Creates a new note associated with a specific table and row ID

Authentication Required

Authorization: Bearer {token} header string

This header is required to access this endpoint

Request Body

Minimum Required
All Properties

{
  "content": "string",
  "tableName": "string",
  "rowId": "string"
}

{
  "content": "string",
  "tableName": "string",
  "rowId": "string"
}

Try it out

Output:

Responses

Description

Note created successfully

{
  "id": 0,
  "content": "string",
  "createdAt": "string",
  "updatedAt": "string",
  "createdBy": "string",
  "updatedBy": "string",
  "tableName": "string",
  "rowId": "string"
}

References

#/components/schemas/NoteInput #/components/schemas/Note

type: object
properties:
  content:
    type: string
    description: The content of the note
  tableName:
    type: string
    description: The name of the table the note is related to
    enum:
      - leads
      - merchants
      - applications
  rowId:
    type: string
    description: The ID of the row in the table the note is related to
required:
  - content
  - tableName
  - rowId

|
export interface NoteInput {
  /** The content of the note */
  content: string;
  /** The name of the table the note is related to */
  tableName: "leads" | "merchants" | "applications";
  /** The ID of the row in the table the note is related to */
  rowId: string;
}

#/components/schemas/Note

OpenAPI
TypeScript

type: object
properties:
  id:
    type: integer
    readOnly: true
  content:
    type: string
    description: The content of the note
  createdAt:
    type: string
    format: date-time
    readOnly: true
  updatedAt:
    type: string
    format: date-time
    readOnly: true
  createdBy:
    type: string
    readOnly: true
    description: Email of the user who created the note
  updatedBy:
    type: string
    readOnly: true
    description: Email of the user who last updated the note
  tableName:
    type: string
    description: The name of the table the note is related to
    enum:
      - leads
      - merchants
      - applications
  rowId:
    type: string
    description: The ID of the row in the table the note is related to
required:
  - content
  - tableName
  - rowId

|
export interface Note {
  id?: number;
  /** The content of the note */
  content: string;
  createdAt?: Date;
  updatedAt?: Date;
  /** Email of the user who created the note */
  createdBy?: string;
  /** Email of the user who last updated the note */
  updatedBy?: string;
  /** The name of the table the note is related to */
  tableName: "leads" | "merchants" | "applications";
  /** The ID of the row in the table the note is related to */
  rowId: string;
}

Route Source Code

Check out the source code for this route entrypoint here: /notes/route.ts

Or the swagger.yaml spec this documentation was generated from: /notes/swagger.yaml