Skip to main content
PATCH
/
streaks
/
configs
/
{id}
Update a streak config by id
curl --request PATCH \
  --url https://{subdomain}.nudj.cx/api/v2/admin/streaks/configs/{id} \
  --header 'Content-Type: application/json' \
  --header 'x-api-token: <api-key>' \
  --data '
{
  "isEnabled": true
}
'
{
  "id": "<string>",
  "organisationId": "<string>",
  "isEnabled": true,
  "triggerEvents": {
    "platform": [],
    "custom": [
      "<string>"
    ]
  },
  "createdBy": "<string>",
  "updatedBy": "<string>",
  "communityId": "<string>"
}

Authorizations

​
x-api-token
string
header
required

Path Parameters

​
id
string
required

The id of the streak config to update

Pattern: ^[0-9a-fA-F]{24}$

Body

application/json

The input required to update a streak config

​
isEnabled
boolean

Whether the streak is enabled and users can start and extend streaks.

​
triggerEvents
object

Response

Successful response

A streak config

​
id
string
required

The id of the streak config

Pattern: ^[0-9a-fA-F]{24}$
​
organisationId
string
required

The id of the organisation this streak config belongs to

Pattern: ^[0-9a-fA-F]{24}$
​
isEnabled
boolean
required

Whether the streak is enabled and users can start and extend streaks.

​
triggerEvents
object
required
​
createdBy
string
required

The admin user who created this streak config

​
updatedBy
string
required

The admin user who last updated this streak config

​
communityId
string | null

The id of the community this streak config belongs to. No community means this is an organisation level streak config.

Pattern: ^[0-9a-fA-F]{24}$