---
title: "POST /{client-id}/periodic-streaks/"
method: POST
path: "/{client-id}/periodic-streaks/"
---

# POST /{client-id}/periodic-streaks/

`POST /{client-id}/periodic-streaks/`

## Path parameters

- `client-id` string, required

## Request body

- object
  - `name` string, required — Name of the streak
  - `progress_action_key` string, required — The action key
  - `period` 'daily' | 'weekly' | 'monthly', required
  - `timezone` string, required — ISO timezone
  - `action_threshold` string — Number of times a progress_action_key should be performed to increase streak length by 1 in a period
  - `started_at` string — ISO Datetime when the streak will start, if null then streak is started from the day of creation
  - `stopped_at` string — ISO Datetime when the streak will stop being active, if null then streak will never end, unless its archived.
  - `freeze_start` string — ISO Datetime for starting the freeze period for everyone, so that any action performed by user will not result in streak length or any miss will not reset their streak
  - `freeze_until` string — ISO Datetime for ending the freeze period for everyone, so that any action performed by user will not result in streak length or any miss will not reset their streak
  - `freeze_reason` string — Optional reason for freezing the streak, only valid if one of freeze_start or freeze_until is provided
  - `attributes` object[]
    - `key` string — Attribute key, eg. custom_id
    - `value` string — Value of the attribute key.
  - `profile_group_ids` string[] — List of Livelike profile group ids to which this streak will be applicable, if not provided, streak will be available for all.

## Response `200`

## Other responses

- `201` — Created

---

[API](https://skmtc.net/livelike/apis/engagement-suite.md) · [All operations](https://skmtc.net/livelike/apis/engagement-suite/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/livelike/engagement-suite/revisions/f3171d1c30f7/schema)