FEfergus
Notes

POST /notes

Changed on

Creates a new note on an entity (job, customer, quote, etc.).

Request

  • Base URL
    https://api.fergus.com
  • Auth
    • OAuth 2
      Authorization codehttps://auth.fergus.com/oauth2/authorize
      Token URLhttps://auth.fergus.com/oauth2/token
    • or HTTP bearer
  • TypeScript
    A function with typed inputs. Its response is checked against the schema.

Request body

textstring required

The body text of the note

entityName'JOB' | 'CUSTOMER' | 'CUSTOMER_INVOICE' | 'QUOTE' | 'SITE' | 'TASK' | 'ENQUIRY' | 'JOB_PHASE' | 'job' | 'customer' | 'customer_invoice' | 'quote' | 'site' | 'task' | 'enquiry' | 'works_order' required

The type of entity this note belongs to. Accepts the enum key (e.g. JOB, JOB_PHASE). The lowercase internal values (e.g. job, works_order) are also accepted but deprecated and will be removed in a future version.

entityIdnumber required

The ID of the entity this note belongs to

parentIdnumber nullable

Parent note ID for a reply. Omit or set null for top-level notes.

isPinnedboolean

Pin the note on creation. Defaults to false.

Example request

{
  "entityName": "JOB",
  "entityId": 123,
  "parentId": 456
}

Response

Resource created successfully

resultstring required

Changes

  • 05a2805ca4f5Revision changes
    • breaking

      removed subschema #1 subschema #2 subschema #3 subschema #4 subschema #5 subschema #6 subschema #7 subschema #8 from the request property anyOf list

    • breaking

      request property was restricted to a list of enum values

    • breaking

      the request property type changed from no type to string

    • info

      added the new CUSTOMER enum value to the request property

    • info

      added the new CUSTOMER_INVOICE enum value to the request property

    • info

      added the new ENQUIRY enum value to the request property

    • info

      added the new JOB enum value to the request property

    • info

      added the new JOB_PHASE enum value to the request property

    • info

      added the new QUOTE enum value to the request property

    • info

      added the new SITE enum value to the request property

    • info

      added the new TASK enum value to the request property

    • info

      added the new customer enum value to the request property

    • info

      added the new customer_invoice enum value to the request property

    • info

      added the new enquiry enum value to the request property

    • info

      added the new job enum value to the request property

    • info

      added the new quote enum value to the request property

    • info

      added the new site enum value to the request property

    • info

      added the new task enum value to the request property

    • info

      added the new works_order enum value to the request property