Update Streak

Developing

PUT

/apis/v1/streaks/{id}

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

Body Params application/jsonRequired

Example

{
  "name": "Daily Activity Streak",
  "timezone": "utc_gmt",
  "startDate": "2026-04-07",
  "timeframe": {
    "value": "daily",
    "count": 1
  },
  "action": {
    "operator": "and",
    "conditions": [
      {
        "_id": "1234",
        "action": "messages",
        "value": 1,
        "isCustomField": false
      }
    ]
  },
  "activeDaysType": "custom",
  "activeDays": ["Monday", "Tuesday", "Wednesday", "Thursday", "Friday"]
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request PUT 'https://integration.returning.ai/apis/v1/streaks/' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
  "name": "Daily Activity Streak",
  "timezone": "utc_gmt",
  "startDate": "2026-04-07",
  "timeframe": {
    "value": "daily",
    "count": 1
  },
  "action": {
    "operator": "and",
    "conditions": [
      {
        "_id": "1234",
        "action": "messages",
        "value": 1,
        "isCustomField": false
      }
    ]
  },
  "activeDaysType": "custom",
  "activeDays": ["Monday", "Tuesday", "Wednesday", "Thursday", "Friday"]
}'

Responses

🟢200Success

application/json

Body

Example

{}

Modified at 2026-04-07 10:54:52

Create Streak

Delete Streak