Periods

Set value for a period setting.

patch/api/periods/{periodId}/settings/{settingId}

Path parameters

periodIdstring required
settingIdstring required

Request body

valuestring required

Example request

{
  "value": "666"
}

Response

Updated period setting

_idstring required
valuestring required

Example response

{
  "_id": "62291b7ea8b1619f78818524",
  "period": {
    "_id": "621f802b813dbdba9eeaf7d7",
    "name": "June 2021",
    "attestationsTxHash": "0x46164b8581258eec4b4f44d626925953d0d7581514d9fd1335e3bd660d48e07c"
  },
  "setting": {
    "_id": "621f802b813dbdbaddeaf799",
    "key": "SETTING_KEY",
    "value": "666",
    "defaultValue": "555",
    "label": "Quantifiers Per Praise",
    "description": "How many redundant quantifications are assigned to each praise?",
    "periodOverridable": true
  },
  "value": "666"
}

Changes

Changed in 15 of the 50 revisions of this API.98

    • the response property period/allOf[Period]/attestationsTxHash became optional for the status 200

      response-property-became-optional

    • endpoint added

      endpoint-added

    • api path removed without deprecation

      api-path-removed-without-deprecation

    This revision also has 56 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • removed the required property period/allOf[Period]/attestationsTxHash from the response with the 200 status

      response-required-property-removed

    • removed the required property period/allOf[Period]/startDate from the response with the 200 status

      response-required-property-removed

    • added the required property period/allOf[Period]/startDate to the response with the 200 status

      response-required-property-added

    • added the required property period/allOf[Period]/attestationsTxHash to the response with the 200 status

      response-required-property-added

    • the value response property's maxLength was increased from 255 to 512 for the response status 200

      response-property-max-length-increased

    • the value request property's maxLength was increased from 255 to 512

      request-property-max-length-increased

    • endpoint added

      endpoint-added

    • api path removed without deprecation

      api-path-removed-without-deprecation

    This revision also has 52 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • endpoint added

      endpoint-added