System Configuration

Update a system configuration.

Update a system configuration by its code name. The params object is merged with the existing configuration.

post/configs/system/{name}

Request

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

Path parameters

namestring required

Configuration code name.

Request body

namestring nullable

Display name.

paramsobject nullable

JSON-encoded configuration parameters.

codestring nullable

Unique configuration key code.

Response

OK

namestring nullable

Display name.

paramsobject nullable

JSON-encoded configuration parameters.

codestring nullable

Unique configuration key code.

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.