Create a Periodic Streak

post

https://cf-blast.livelikecdn.com/api/v1/applications/{client-id}/periodic-streaks/

Path Params

client-id

string

required

Body Params

name

string

required

Name of the streak

progress_action_key

string

required

The action key

period

string

enum

required

Allowed:

timezone

string

required

ISO timezone

action_threshold

string

Defaults to 1

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

array of objects

attributes

profile_group_ids

array of strings

List of Livelike profile group ids to which this streak will be applicable, if not provided, streak will be available for all.

profile_group_ids

Responses

200

Language

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201Created