---
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
    - `startDate` string, date-time, required
    - `endDate` string, date-time, required
    - `attestationsTxHash` string
    - `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-09-22** `89707aed2e4e` — 1 breaking
  - the response property `period/allOf[#/components/schemas/Period]/attestationsTxHash` became optional for the status `200`
- **2023-08-23** `990e717b779e` — 1 info
  - endpoint added
- **2023-08-23** `abdaebb919d2` — 1 breaking
  - api path removed without deprecation
- **2023-08-11** `00d037b830a5` — 2 breaking
  - removed the required property `period/allOf[#/components/schemas/Period]/attestationsTxHash` from the response with the `200` status
  - removed the required property `period/allOf[#/components/schemas/Period]/startDate` from the response with the `200` status
- **2023-08-06** `a1650a3ffd3f` — 1 info
  - added the required property `period/allOf[#/components/schemas/Period]/startDate` to the response with the `200` status

[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/d960746392e5/schema)