Create a streak by external Id

Allows a user (via partner backend with API key) to create a streak. ExternalId identifies the originating entity (e.g. stable). CreatedByUserKey is auto-set from the route. Streaks are private by definition — TargetedProperties is required.

curl --location 'https://api-stg.98s.studio/api/v1/user//streaks/create' \ --header 'Content-Type: application/json' \ --data '{ "name": "Morning Ride Streak", "description": "Complete a ride every day to keep your streak alive.", "localizedContent": { "ar": { "name": "سلسلة ركوب الصباح", "description": "أكمل ركوبًا كل يوم للحفاظ على سلسلتك." } }, "startDate": "2026-06-10T00:00:00Z", "endDate": "2026-07-10T00:00:00Z", "occurrence": "DAILY", "scoreGoal": 100, "externalId": "stable-streak-2026-06-001", "targetedProperties": { "gender": 2, "minAge": 18, "maxAge": 45, "country": ["SA", "AE"], "city": ["SA-riyadh", "AE-dubai"], "segment": ["premium"] }, "hasReward": true, "rewards": [ { "rewardType": "POINTS", "rewardId": "reward-points-500", "amount": 500 } ] }'

{ "id": "3f2504e0-4f89-41d3-9a0c-0305e82c3301", "name": "Morning Ride Streak", "description": "Complete a ride every day to keep your streak alive.", "supportedLanguages": ["ar"], "localizedContent": { "ar": { "name": "سلسلة ركوب الصباح", "description": "أكمل ركوبًا كل يوم للحفاظ على سلسلتك." } }, "startDate": "2026-06-10T00:00:00Z", "endDate": "2026-07-10T00:00:00Z", "occurrence": "DAILY", "status": "ACTIVE", "scoreGoal": 100, "isPublic": false, "targetedProperties": { "gender": 2, "minAge": 18, "maxAge": 45, "country": ["SA", "AE"], "city": ["SA-riyadh", "AE-dubai"], "segment": ["premium"] }, "externalId": "stable-streak-2026-06-001", "hasReward": true, "rewards": [ { "rewardType": "POINTS", "rewardId": "reward-points-500", "amount": 500 } ] }

Create a streak by external Id

Request

Responses