System Configuration

Save configuration notes.

Batch create or update configuration notes. Replaces all notes for the submitted module.

post/configs/notes

Request

  • Base URL: https://api.floorworks.co.uk/api/v1
  • URL: https://api.floorworks.co.uk/api/v1/configs/notes
  • Auth: OAuth 2 (password, token URL https://api.floorworks.co.uk/api/v1/auth)

Request body

priorityinteger nullable

Display ordering priority.

namestring nullable

Display name.

modulestring nullable

Pipe-separated list of module codes this item applies to.

module_displaystring nullable

Pipe-separated list of modules where this item is displayed.

is_separate_display0 | 1 nullable

Whether this note is shown in a separate display area (1 = yes).

is_alert0 | 1 nullable

Whether this note triggers an alert (1 = yes).

colourstring nullable

Colour value (hex or named colour).

iconstring nullable

Icon identifier or CSS class.

codestring nullable

Uppercase code identifier for this note.

Response

Updated notes

priorityinteger nullable

Display ordering priority.

namestring nullable

Display name.

modulestring nullable

Pipe-separated list of module codes this item applies to.

module_displaystring nullable

Pipe-separated list of modules where this item is displayed.

is_separate_display0 | 1 nullable

Whether this note is shown in a separate display area (1 = yes).

is_alert0 | 1 nullable

Whether this note triggers an alert (1 = yes).

colourstring nullable

Colour value (hex or named colour).

iconstring nullable

Icon identifier or CSS class.

codestring nullable

Uppercase code identifier for this note.

idnumber

ID.

time_createdstring YYYY-MM-DD

Creation date

time_modifiedstring YYYY-MM-DD

Last modification date

Example response

[
  {
    "id": 12345,
    "time_created": "2025-08-17",
    "time_modified": "2025-08-18"
  }
]

Changes

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