- Returning.AI
- APIs
- Authentication
- System API
- Application API
- Integration API
- Users
- Messages
- Channels
- Xp Settings
- Gamifications
- Analysis API
- Redemption Transactions
- Streak Logs
- Mini games
- Community Analytics
- Streaks
- Channels
- Events
- Widgets
- Features
- APIs
- Schemas
- Analysis
- UpdateAnalysisRequest
- AppendDrawingsRequest
- CreateAnalysisResponse
- GetAnalysisResponse
- UpdateAnalysisResponse
- AppendDrawingsResponse
- AnalysisMetadata
- Expiry
- Levels
- LevelEntry
- Drawing
- HorizontalLineDrawing
- LineDrawing
- RectangleDrawing
- ParallelDrawing
- FibonacciRetracementDrawing
- Coordinate
- DrawingStyle
- AnalysisDetail
- AnalysisSummary
- CreateAnalysisRequest
- ListAnalysesResponse
- Sample Schemas
- Schemas
- ValidationError
- NotFoundError
- InternalServerError
- NotImplementedError
- CreateUserFieldHistoryResponse
- CreateUserFieldHistorySuccessResponse
- UserFieldHistoryItem
- GetUserFieldHistoriesResponse
- UserFieldHistoriesValidationError
- UserFieldHistoriesMetaWithValidation
- UserFieldHistoriesMetaWithPagination
- GetUserFieldHistoriesSuccessResponse
- CreateUserFieldResponse
- CreateUserFieldSuccessResponse
- DeleteUserFieldResponse
- DeleteUserFieldSuccessResponse
- UserFieldCreator
- GetUserFieldResponse
- GetUserFieldSuccessResponse
- ValidationErrorItem
- GetUserFieldsMetaResponse
- CreatorInfo
- UserFieldResponse
- GetUserFieldsSuccessResponse
- UpdateUserFieldResponse
- UpdateUserFieldPayload
- UpdateUserFieldSuccessResponse
- MetaResponse
- GetUserResponse
- GetUserSuccessResponse
- Outgoing webhooks
Create Streak
Developing
POST
/apis/v1/streaks
Request
Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.Example:
Authorization: Bearer ********************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": "123456789",
"action": "messages",
"value": 1,
"isCustomField": false
}
]
},
"activeDaysType": "custom",
"activeDays": [
"Monday",
"Tuesday",
"Wednesday",
"Thursday",
"Friday",
"Saturday",
"Sunday"
]
}Request Code Samples
Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST '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": "123456789",
"action": "messages",
"value": 1,
"isCustomField": false
}
]
},
"activeDaysType": "custom",
"activeDays": [
"Monday",
"Tuesday",
"Wednesday",
"Thursday",
"Friday",
"Saturday",
"Sunday"
]
}'Responses
🟢200Success
application/json
Body
Example
{
"status": "success",
"data": {
"activeDays": [
"Monday",
"Tuesday",
"Wednesday",
"Thursday",
"Friday"
],
"_id": "69d4dc71cab401c37ba243df",
"communityId": "621ecbccc548eb5c7e0d5c57",
"name": "Daily Activity Streak",
"timezone": "utc_gmt",
"startDate": "2026-04-07T00:00:00.000Z",
"timeframe": {
"value": "daily",
"count": 1
},
"action": {
"operator": "and",
"conditions": [
{
"_id": "action_001",
"action": "messages",
"value": 1,
"isCustomField": false
}
]
},
"activeDaysType": "custom",
"createdAt": "2026-04-07T10:29:05.982Z",
"updatedAt": "2026-04-07T10:29:05.982Z",
"__v": 0
}
}Modified at 2026-04-07 10:28:02