---
title: "Set value for a period setting."
method: PATCH
path: "/api/periods/{periodId}/settings/{settingId}"
tags: ["Periods"]
---

# Set value for a period setting.

`PATCH /api/periods/{periodId}/settings/{settingId}`

## Path parameters

- `periodId` string, required
- `settingId` string, required

## Request body

- SetPeriodSettingDto
  - `value` string, required

## Response `200`

Updated period setting

- PeriodSetting
  - `_id` string, required
  - `period` Period, required
    - `_id` string, required
    - `name` string, required
    - `status` 'OPEN' | 'QUANTIFY' | 'CLOSED', required
    - `endDate` string, date-time, required
    - `attestationsTxHash` string, required
    - `createdAt` string, date-time, required
    - `updatedAt` string, date-time, required
  - `setting` Setting, required
    - `_id` string, required
    - `key` string, required
    - `value` string, required
    - `valueRealized` union, required
      - string
      - string[]
      - boolean
      - number
      - number[]
    - `defaultValue` string, required
    - `type` 'Integer' | 'Float' | 'String' | 'Textarea' | 'Boolean' | 'IntegerList' | 'StringList' | 'Image' | 'Radio' | 'JSON', required
    - `label` string, required
    - `description` string, required
    - `group` number, required
    - `options` string, required
    - `subgroup` number, required
    - `periodOverridable` boolean, required
  - `value` string, required
  - `valueRealized` union, required
    - string
    - string[]
    - boolean
    - number
    - number[]

## Changes

- **2023-08-03** `0373dfbf63cd` — 1 info
  - added the required property `period/allOf[#/components/schemas/Period]/attestationsTxHash` to the response with the `200` status
- **2023-06-06** `a856c86b76ec` — 1 breaking, 1 info
  - the `value` response property's maxLength was increased from `255` to `512` for the response status `200`
  - the `value` request property's maxLength was increased from `255` to `512`
- **2023-04-27** `e14b4c818c53` — 1 info
  - endpoint added
- **2023-04-27** `e8ffc3233d9e` — 1 breaking
  - api path removed without deprecation
- **2023-04-04** `aa4804c758aa` — 1 info
  - endpoint added

[Full history](https://skmtc.dev/givepraise/apis/praise-api/changes/api/periods/:periodId/settings/:settingId/patch.md)

---

[API](https://skmtc.dev/givepraise/apis/praise-api.md) · [All operations](https://skmtc.dev/givepraise/apis/praise-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/givepraise/praise-api/revisions/0373dfbf63cd/schema)