/photos/photo1.jpg
description: >-
Asset URLs of the images to delete. Preferred over the legacy
`s3ImageUrls`.
type: array
items:
type: string
s3ImageUrls:
example:
- https://s3.amazonaws.com/bucket/photo1.jpg
description: Deprecated alias for `assetUrls`.
type: array
items:
type: string
required:
- eventId
FaceSearchDto:
type: object
properties:
eventId:
type: string
example: uuid-of-event
description: Event UUID
sensitivity:
type: number
example: 0.6
description: Sensitivity for face matching (0.0 - 1.0)
required:
- eventId
FillDeclarationVariablesDto:
type: object
properties:
variables:
type: object
description: Object containing variable key-value pairs
example:
organizerName: John Doe
panNumber: ABCDE1234F
address: 123 Main Street
city: Mumbai
state: Maharashtra
pincode: '400001'
required:
- variables
TemplateVariableDto:
type: object
properties:
key:
type: string
description: Variable key used in template (e.g., organizerName)
type:
type: string
description: Variable type
enum:
- text
- date
- number
required:
type: boolean
description: Whether this field is required
label:
type: string
description: Display label for the field
placeholder:
type: string
description: Placeholder text for input
pattern:
type: string
description: Validation regex pattern
errorMessage:
type: string
description: Error message for validation failure
required:
- key
- type
- required
CreateGstDeclarationTemplateDto:
type: object
properties:
name:
type: string
description: Template name
description:
type: string
description: Template description
htmlContent:
type: string
description: HTML template content with {{variable}} placeholders
variables:
description: Array of template variables
type: array
items:
$ref: '#/components/schemas/TemplateVariableDto'
isActive:
type: boolean
description: Whether this template is active
default: false
headerLogo:
type: string
description: Header logo URL
footerText:
type: string
description: Footer text for PDF
cssStyles:
type: string
description: CSS styles for template
required:
- name
- htmlContent
- variables
UpdateGstDeclarationTemplateDto:
type: object
properties:
name:
type: string
description: Template name
description:
type: string
description: Template description
htmlContent:
type: string
description: HTML template content with {{variable}} placeholders
variables:
description: Array of template variables
type: array
items:
$ref: '#/components/schemas/TemplateVariableDto'
isActive:
type: boolean
description: Whether this template is active
default: false
headerLogo:
type: string
description: Header logo URL
footerText:
type: string
description: Footer text for PDF
cssStyles:
type: string
description: CSS styles for template
CreateNotificationCategoryDto:
type: object
properties:
name:
type: string
example: promotion
description:
type: string
example: Promotional notifications
type:
type: string
enum: &ref_631
- system
- marketing
default: marketing
example: marketing
required:
- name
UpdateNotificationCategoryDto:
type: object
properties:
name:
type: string
example: promotion
description:
type: string
example: Promotional notifications
type:
type: string
enum: *ref_631
default: marketing
example: marketing
isActive:
type: boolean
example: true
description: Toggle the category active/inactive.
CreateSmsTemplateDto:
type: object
properties:
name:
type: string
example: Event Registration SMS
msg91TemplateId:
type: string
example: '1234567890'
dltTemplateId:
type: string
example: DLT-123456
content:
type: string
example: Dear {#name#}, your registration for {#event#} is confirmed.
variables:
type: array
items:
$ref: '#/components/schemas/TemplateVariableDto'
approvalStatus:
type: string
enum: &ref_632
- pending
- approved
- rejected
visibility:
type: string
enum: &ref_633
- admin_only
- organizer
freeForOrganizer:
type: boolean
example: false
pricePerUnit:
type: number
example: 0.25
categoryId:
type: string
required:
- name
- msg91TemplateId
- dltTemplateId
- content
UpdateSmsTemplateDto:
type: object
properties:
name:
type: string
example: Event Registration SMS
msg91TemplateId:
type: string
example: '1234567890'
dltTemplateId:
type: string
example: DLT-123456
content:
type: string
example: Dear {#name#}, your registration for {#event#} is confirmed.
variables:
type: array
items:
$ref: '#/components/schemas/TemplateVariableDto'
approvalStatus:
type: string
enum: *ref_632
visibility:
type: string
enum: *ref_633
freeForOrganizer:
type: boolean
example: false
pricePerUnit:
type: number
example: 0.25
categoryId:
type: string
CreateSmsViaMsg91Dto:
type: object
properties:
name:
type: string
example: Event Registration SMS
content:
type: string
example: 'Dear ##name##, your registration for ##event## is confirmed.'
description: 'SMS content. Use ##VAR## syntax for variables.'
senderId:
type: string
example: RACEAB
description: Sender ID registered with MSG91
dltTemplateId:
type: string
example: '1234567890123456789'
description: DLT Template ID from TRAI/operator for Indian SMS
smsType:
type: string
example: NORMAL
enum:
- NORMAL
- TRANSACTIONAL
- PROMOTIONAL
description: SMS type. Defaults to NORMAL.
variables:
type: array
items:
$ref: '#/components/schemas/TemplateVariableDto'
visibility:
type: string
enum:
- admin_only
- organizer
freeForOrganizer:
type: boolean
example: false
pricePerUnit:
type: number
example: 0.25
categoryId:
type: string
required:
- name
- content
- senderId
- dltTemplateId
AddSmsTemplateVersionDto:
type: object
properties:
content:
type: string
example: 'Dear ##name##, your updated registration for ##event## is confirmed.'
description: 'New SMS content for this version. Use ##VAR## syntax for variables.'
senderId:
type: string
example: RACEAB
description: Sender ID registered with MSG91
dltTemplateId:
type: string
example: '1234567890123456789'
description: DLT Template ID from TRAI/operator for Indian SMS
required:
- content
- senderId
- dltTemplateId
UpdateTemplatePricingDto:
type: object
properties:
pricePerUnit:
type: number
example: 0.25
freeForOrganizer:
type: boolean
example: false
required:
- pricePerUnit
CreateEmailTemplateDto:
type: object
properties:
name:
type: string
example: Event Registration Email
msg91TemplateId:
type: string
example: msg91-template-id-123
subject:
type: string
example: Your event registration is confirmed
description:
type: string
example: Email template for event registration confirmation
variables:
type: array
items:
$ref: '#/components/schemas/TemplateVariableDto'
visibility:
type: string
enum: &ref_634
- admin_only
- organizer
freeForOrganizer:
type: boolean
example: false
pricePerUnit:
type: number
example: 0.1
categoryId:
type: string
required:
- name
- msg91TemplateId
CreateEmailViaMsg91Dto:
type: object
properties:
name:
type: string
example: Event Registration Confirmation
subject:
type: string
example: Your event registration is confirmed!
htmlContent:
type: string
example: >-
Hi {{name}}, your registration for {{event}} is
confirmed.
description: HTML content of the email template
fromName:
type: string
example: RaceAbove
fromEmail:
type: string
example: no-reply@raceabove.com
description:
type: string
example: Email template for event registration
variables:
type: array
items:
$ref: '#/components/schemas/TemplateVariableDto'
visibility:
type: string
enum:
- admin_only
- organizer
freeForOrganizer:
type: boolean
example: false
pricePerUnit:
type: number
example: 0.1
categoryId:
type: string
required:
- name
- subject
- htmlContent
UpdateEmailTemplateDto:
type: object
properties:
name:
type: string
example: Event Registration Email
msg91TemplateId:
type: string
example: msg91-template-id-123
subject:
type: string
example: Your event registration is confirmed
description:
type: string
example: Email template for event registration confirmation
variables:
type: array
items:
$ref: '#/components/schemas/TemplateVariableDto'
visibility:
type: string
enum: *ref_634
freeForOrganizer:
type: boolean
example: false
pricePerUnit:
type: number
example: 0.1
categoryId:
type: string
CreateWhatsappTemplateDto:
type: object
properties:
name:
type: string
example: Event Reminder WhatsApp
metaTemplateId:
type: string
example: event_reminder_template
language:
type: string
example: en
content:
type: string
example: Hi {{1}}, your event {{2}} starts tomorrow.
headerType:
type: string
example: text
headerContent:
type: string
footerContent:
type: string
buttons:
type: array
items:
type: string
variables:
type: array
items:
$ref: '#/components/schemas/TemplateVariableDto'
approvalStatus:
type: string
enum: &ref_635
- pending
- approved
- rejected
metaApprovalStatus:
type: string
visibility:
type: string
enum: &ref_636
- admin_only
- organizer
freeForOrganizer:
type: boolean
example: false
pricePerUnit:
type: number
example: 0.5
categoryId:
type: string
required:
- name
- metaTemplateId
UpdateWhatsappTemplateDto:
type: object
properties:
name:
type: string
example: Event Reminder WhatsApp
metaTemplateId:
type: string
example: event_reminder_template
language:
type: string
example: en
content:
type: string
example: Hi {{1}}, your event {{2}} starts tomorrow.
headerType:
type: string
example: text
headerContent:
type: string
footerContent:
type: string
buttons:
type: array
items:
type: string
variables:
type: array
items:
$ref: '#/components/schemas/TemplateVariableDto'
approvalStatus:
type: string
enum: *ref_635
metaApprovalStatus:
type: string
visibility:
type: string
enum: *ref_636
freeForOrganizer:
type: boolean
example: false
pricePerUnit:
type: number
example: 0.5
categoryId:
type: string
CreatePushTemplateDto:
type: object
properties:
name:
type: string
example: New device login alert
slug:
type: string
description: >-
Stable machine key, lowercase kebab-case. Used to reference and
re-seed the template idempotently.
example: user-new-device-login
title:
type: string
description: >-
Notification title. Supports {{variable}} placeholders filled from
the dispatch variables.
example: New device login
body:
type: string
description: Notification body. Supports {{variable}} placeholders.
example: Hi {{user_name}}, we noticed a login from {{device_name}}.
description:
type: string
deepLink:
type: object
description: >-
In-app destination. String leaves are placeholder-interpolated, so
params can reference the triggering entity.
example: &ref_637
screen: EventDetail
params:
id: '{{event_id}}'
pushType:
type: string
description: Client-side type tag (drives icon + grouping on the device).
example: GENERAL
imageUrl:
type: string
description: Rich-notification image URL.
variables:
description: >-
Declared placeholders. `required: true` ones are reported in the
dispatch log when a trigger fails to supply them.
example: &ref_638
- key: user_name
required: true
label: Athlete name
type: array
items:
type: string
visibility:
type: string
enum: &ref_639
- admin_only
- organizer
freeForOrganizer:
type: boolean
pricePerUnit:
type: number
categoryId:
type: string
required:
- name
- slug
- title
- body
UpdatePushTemplateDto:
type: object
properties:
name:
type: string
example: New device login alert
slug:
type: string
description: >-
Stable machine key, lowercase kebab-case. Used to reference and
re-seed the template idempotently.
example: user-new-device-login
title:
type: string
description: >-
Notification title. Supports {{variable}} placeholders filled from
the dispatch variables.
example: New device login
body:
type: string
description: Notification body. Supports {{variable}} placeholders.
example: Hi {{user_name}}, we noticed a login from {{device_name}}.
description:
type: string
deepLink:
type: object
description: >-
In-app destination. String leaves are placeholder-interpolated, so
params can reference the triggering entity.
example: *ref_637
pushType:
type: string
description: Client-side type tag (drives icon + grouping on the device).
example: GENERAL
imageUrl:
type: string
description: Rich-notification image URL.
variables:
description: >-
Declared placeholders. `required: true` ones are reported in the
dispatch log when a trigger fails to supply them.
example: *ref_638
type: array
items:
type: string
visibility:
type: string
enum: *ref_639
freeForOrganizer:
type: boolean
pricePerUnit:
type: number
categoryId:
type: string
AdjustOrganizerWalletDto:
type: object
properties:
amount:
type: number
example: 100
type:
type: string
enum:
- credit
- debit
- refund
- adjustment
description:
type: string
example: Manual top-up by admin
required:
- amount
- type
ManualRecipientDto:
type: object
properties: {}
ParticipationCriteriaDto:
type: object
properties:
minEvents:
type: number
minimum: 1
description: Positive integer
lastEventAfter:
type: string
description: ISO-8601 date / date-time
lastEventBefore:
type: string
description: ISO-8601 date / date-time
dormantOnly:
type: boolean
description: Server-resolved dormant cohort shorthand
cohortTag:
type: string
enum:
- DORMANT
- REPEAT
- FIRST_TIME
description: First-class audience-tag activation
AudienceSpecDto:
type: object
properties:
kind:
type: string
enum:
- event_registrants
- past_participants
- organizer_followers
eventId:
type: string
participationCriteria:
$ref: '#/components/schemas/ParticipationCriteriaDto'
required:
- kind
SendNotificationDto:
type: object
properties:
channel:
type: string
enum:
- sms
- email
- whatsapp
- push
templateId:
type: string
eventId:
type: string
recipientSource:
type: string
enum:
- event_participants
- csv_upload
- manual
recipientFileUrl:
type: string
manualRecipients:
type: array
items:
$ref: '#/components/schemas/ManualRecipientDto'
variables:
type: object
audienceSpec:
$ref: '#/components/schemas/AudienceSpecDto'
scheduledAt:
type: string
required:
- channel
- templateId
- recipientSource
CreateSystemNotificationMappingDto:
type: object
properties:
event:
type: string
enum:
- event_approved
- event_rejected
- event_registered
- event_cancelled
- event_announcement
- event_reminder
- challenge_approved
- challenge_rejected
- challenge_announcement
- challenge_completed
- challenge_reward
- payment_success
- payment_failed
- refund_initiated
- refund_completed
- welcome
- new_follower
- kyc_pending_admin
- kyc_approved
- kyc_rejected
- organizer_registration_confirmation
- subscription_renewal
- team_invite
- event_assignment_invited
- assignment_responded
- crew_role_changed
- shift_reminder
- attendance_approval_needed
- attendance_decided
example: event_approved
channel:
type: string
enum:
- sms
- email
- whatsapp
- push
default: email
emailTemplateId:
type: string
description: UUID of the EmailTemplate to map
enabled:
type: boolean
default: true
description:
type: string
example: Email sent when an event is approved
required:
- event
- emailTemplateId
UpdateSystemNotificationMappingDto:
type: object
properties:
emailTemplateId:
type: string
description: UUID of the EmailTemplate to map
enabled:
type: boolean
description:
type: string
SendPromotionDto:
type: object
properties:
promotionTemplateId:
type: string
channels:
type: array
items:
type: string
enum:
- sms
- email
- whatsapp
- push
audienceSpec:
$ref: '#/components/schemas/AudienceSpecDto'
variables:
type: object
scheduledAt:
type: string
required:
- promotionTemplateId
- audienceSpec
AudiencePreviewDto:
type: object
properties: {}
TopUpWalletDto:
type: object
properties:
amount:
type: number
example: 500
required:
- amount
PromotionChannelTemplateIdsDto:
type: object
properties: {}
CreatePromotionTemplateDto:
type: object
properties:
name:
type: string
example: Event launch announcement
description:
type: string
eligiblePartnerTypes:
type: array
items: &ref_640
type: string
enum:
- organizer
- brand
- club
channelTemplateIds:
example: &ref_641
sms: 019...
email: 019...
whatsapp: 019...
push: 019...
allOf:
- $ref: '#/components/schemas/PromotionChannelTemplateIdsDto'
variables:
example: &ref_642
- key: event_name
required: true
label: Event name
type: array
items:
type: string
consentCategory:
type: string
default: marketing
enabled:
type: boolean
default: true
required:
- name
- eligiblePartnerTypes
- channelTemplateIds
UpdatePromotionTemplateDto:
type: object
properties:
name:
type: string
example: Event launch announcement
description:
type: string
eligiblePartnerTypes:
type: array
items: *ref_640
channelTemplateIds:
example: *ref_641
allOf:
- $ref: '#/components/schemas/PromotionChannelTemplateIdsDto'
variables:
example: *ref_642
type: array
items:
type: string
consentCategory:
type: string
default: marketing
enabled:
type: boolean
default: true
PromotionStudioSendDto:
type: object
properties:
promotionTemplateId:
type: string
channels:
type: array
items:
type: string
enum:
- sms
- email
- whatsapp
- push
audienceKind:
type: string
enum:
- all_users
- connected_audience
- event_registrants
- past_participants
- organizer_followers
eventId:
type: string
variables:
type: object
scheduledAt:
type: string
required:
- promotionTemplateId
CreateTemplateDto:
type: object
properties:
name:
type: string
example: KYC Pending Email V1
channel:
type: string
enum: &ref_643
- push
- email
- sms
- whatsapp
example: email
provider:
type: string
enum: &ref_644
- fcm
- msg91
- meta
example: msg91
templateId:
type: string
example: tpl_abc123
description: Provider template ID
description:
type: string
example: Email sent when KYC is pending review
sampleContent:
type: string
example: Hi {{organizer_name}}, your KYC is under review.
required:
- name
- channel
- provider
- templateId
UpdateTemplateDto:
type: object
properties:
name:
type: string
example: KYC Pending Email V1
channel:
type: string
enum: *ref_643
example: email
provider:
type: string
enum: *ref_644
example: msg91
templateId:
type: string
example: tpl_abc123
description: Provider template ID
description:
type: string
example: Email sent when KYC is pending review
sampleContent:
type: string
example: Hi {{organizer_name}}, your KYC is under review.
CreateMappingDto:
type: object
properties:
stepId:
type: string
example: ADMIN_KYC_SUBMITTED
description: Notification step ID
channel:
type: string
enum:
- push
- email
- sms
- whatsapp
example: email
templateId:
type: string
description: UUID of notification_templates row
required:
- stepId
- channel
- templateId
BulkCreateMappingDto:
type: object
properties:
mappings:
type: array
items:
$ref: '#/components/schemas/CreateMappingDto'
required:
- mappings
UpdateMappingDto:
type: object
properties:
templateId:
type: string
description: UUID of notification_templates row
isActive:
type: boolean
default: true
required:
- templateId
UpdateJourneyStepDto:
type: object
properties:
journeyPhase:
type: string
example: Event lifecycle
journeyOrder:
type: number
example: 120
recipientDescription:
type: string
example: The organizer who owns the event
CreateClubDto:
type: object
properties:
termsAccepted:
type: boolean
description: >-
Must be true. Confirms the creator accepted the current
platform-authored Club creation terms.
example: true
termsVersion:
type: number
description: Version returned by GET /v2/settings/public
example: 1
name:
type: string
example: Bangalore Runners
slug:
type: string
example: bangalore-runners
description:
type: string
logoUrl:
type: string
description: Logo image URL (http/https only)
bannerUrl:
type: string
description: Banner image URL (http/https only)
city:
type: string
country:
type: string
sports:
description: Sport ids (uuid array, max 12)
type: array
items:
type: string
isPublic:
type: boolean
requiresApproval:
type: boolean
membershipRequiresPayment:
type: boolean
description: >-
When true, POST /:id/join refuses a bare join (no tierId) — a caller
must pick one of this club's active tiers and pay before becoming a
member at all. Independent of requiresApproval.
foundedDate:
type: string
tagline:
type: string
description: One-line subtitle for cards/headers.
colorTheme:
type: string
description: Hex color (#RRGGBB).
example: '#0EA5E9'
mission:
type: string
description: Long-form mission statement.
rules:
type: string
description: Long-form rules document.
memberExpectations:
type: string
description: Long-form member-expectations.
onboardingMessage:
type: string
description: Greeting copy after join.
required:
- termsAccepted
- termsVersion
- name
- slug
RsvpClubRunDto:
type: object
properties:
response:
type: string
enum:
- GOING
- MAYBE
- NOT_GOING
occurrenceStart:
type: string
required:
- response
SubmitOrganizerClubSetupDto:
type: object
properties: {}
RefundPolicyInput:
type: object
properties: {}
UpdateClubDto:
type: object
properties:
termsAccepted:
type: boolean
description: >-
Must be true. Confirms the creator accepted the current
platform-authored Club creation terms.
example: true
termsVersion:
type: number
description: Version returned by GET /v2/settings/public
example: 1
name:
type: string
example: Bangalore Runners
slug:
type: string
example: bangalore-runners
description:
type: string
logoUrl:
type: string
description: Logo image URL (http/https only)
bannerUrl:
type: string
description: Banner image URL (http/https only)
city:
type: string
country:
type: string
sports:
description: Sport ids (uuid array, max 12)
type: array
items:
type: string
isPublic:
type: boolean
requiresApproval:
type: boolean
membershipRequiresPayment:
type: boolean
description: >-
When true, POST /:id/join refuses a bare join (no tierId) — a caller
must pick one of this club's active tiers and pay before becoming a
member at all. Independent of requiresApproval.
foundedDate:
type: string
tagline:
type: string
description: One-line subtitle for cards/headers.
colorTheme:
type: string
description: Hex color (#RRGGBB).
example: '#0EA5E9'
mission:
type: string
description: Long-form mission statement.
rules:
type: string
description: Long-form rules document.
memberExpectations:
type: string
description: Long-form member-expectations.
onboardingMessage:
type: string
description: Greeting copy after join.
monetizationAdminOverride:
type: boolean
refundPolicy:
$ref: '#/components/schemas/RefundPolicyInput'
CreateClubAnnouncementDto:
type: object
properties:
title:
type: string
body:
type: string
type:
type: string
enum:
- ROUTINE
- IMPORTANT
- URGENT
pinned:
type: boolean
description: Pin to top of feed.
push:
type: boolean
description: Send push notification (default true).
sendEmail:
type: boolean
description: >-
Send email blast in addition to push. Routed through the
notifications engine; if no email provider is configured the flag is
logged and ignored.
scheduledFor:
type: string
description: ISO timestamp; if set the announcement is scheduled for this time.
required:
- title
- body
CreateClubRunDto:
type: object
properties:
name:
type: string
description:
type: string
startDateTime:
type: string
example: '2026-05-01T06:00:00Z'
endDateTime:
type: string
locationCoordinate:
type: object
example: &ref_645
type: Point
coordinates:
- 77.5946
- 12.9716
meetingAddress:
type: string
sportId:
type: string
distanceMeters:
type: number
paceTargetSecPerKm:
type: number
recurrenceRule:
type: string
example: FREQ=WEEKLY;BYDAY=SU
paceGroup:
type: string
enum: &ref_646
- BEGINNER
- INTERMEDIATE
- ADVANCED
requiredGear:
example: &ref_647
- Hydration pack
- Headlamp
type: array
items:
type: string
capacity:
type: number
description: RSVP cap; null = unlimited
paceCapacities:
type: object
description: >-
Per-pace-band caps, e.g. { "BEGINNER": 30, "INTERMEDIATE": 50,
"ADVANCED": 20 }. Sum must not exceed capacity.
example: &ref_648
BEGINNER: 30
INTERMEDIATE: 50
ADVANCED: 20
feeMinor:
type: number
description: Fee in minor units (paise/cents).
feeCurrency:
type: string
example: INR
routeId:
type: string
required:
- name
- startDateTime
UpdateClubRunDto:
type: object
properties:
name:
type: string
description:
type: string
startDateTime:
type: string
example: '2026-05-01T06:00:00Z'
endDateTime:
type: string
locationCoordinate:
type: object
example: *ref_645
meetingAddress:
type: string
sportId:
type: string
distanceMeters:
type: number
paceTargetSecPerKm:
type: number
recurrenceRule:
type: string
example: FREQ=WEEKLY;BYDAY=SU
paceGroup:
type: string
enum: *ref_646
requiredGear:
example: *ref_647
type: array
items:
type: string
capacity:
type: number
description: RSVP cap; null = unlimited
paceCapacities:
type: object
description: >-
Per-pace-band caps, e.g. { "BEGINNER": 30, "INTERMEDIATE": 50,
"ADVANCED": 20 }. Sum must not exceed capacity.
example: *ref_648
feeMinor:
type: number
description: Fee in minor units (paise/cents).
feeCurrency:
type: string
example: INR
routeId:
type: string
RequestClubOwnershipTransferDto:
type: object
properties: {}
CreateClubTierDto:
type: object
properties:
name:
type: string
example: Gold
description:
type: string
priceAmount:
type: number
description: Major currency units, e.g. 499 for ₹499
currency:
type: string
example: INR
billingPeriod:
type: string
enum: &ref_649
- MONTHLY
- QUARTERLY
- ANNUAL
default: MONTHLY
benefits:
description: Max 20 entries, 200 chars each
type: array
items:
type: string
maxMembers:
type: number
trialDays:
type: number
description: Free trial window in days, 0..365
annualDiscountPct:
type: number
description: Annual pre-pay discount pct, 0..100
required:
- name
- priceAmount
UpdateClubTierDto:
type: object
properties:
name:
type: string
example: Gold
description:
type: string
priceAmount:
type: number
description: Major currency units, e.g. 499 for ₹499
currency:
type: string
example: INR
billingPeriod:
type: string
enum: *ref_649
default: MONTHLY
benefits:
description: Max 20 entries, 200 chars each
type: array
items:
type: string
maxMembers:
type: number
description: Member cap; null clears it.
trialDays:
type: number
description: Free trial window in days, 0..365
annualDiscountPct:
type: number
description: Annual pre-pay discount pct, 0..100
isActive:
type: boolean
AdminDeactivateClubDto:
type: object
properties:
reason:
type: string
description: >-
Required ops-supplied reason. Stored on the club, returned to the
club owner by the admin status endpoint, and recorded on the
club.deactivated audit entry.
minLength: 3
maxLength: 500
required:
- reason
AdminCreateClubMembershipDto:
type: object
properties:
userId:
type: string
description: Target user UUID
status:
type: string
enum: &ref_650
- ACTIVE
- PENDING
- REMOVED
- LEFT
- MUTED
- BANNED
tierId:
type: string
description: Paid-tier UUID (optional)
role:
type: string
description: Free-form role hint (e.g. FOUNDER)
required:
- userId
AdminUpdateClubMembershipDto:
type: object
properties:
userId:
type: string
description: Target user UUID
status:
type: string
enum: *ref_650
tierId:
type: string
description: Paid-tier UUID (optional)
role:
type: string
description: Free-form role hint (e.g. FOUNDER)
AdminCreateClubAnnouncementDto:
type: object
properties:
title:
type: string
body:
type: string
visibility:
type: string
enum:
- PUBLIC
- MEMBERS_ONLY
- STAFF_ONLY
description: Audience gate. Forwarded to entity when schema lands.
pinUntil:
type: string
description: ISO timestamp — pin until. Forwarded when schema lands.
required:
- title
- body
HideClubContentDto:
type: object
properties:
reason:
type: string
description: >-
Why this content is being hidden. Sent verbatim to the author and
shown back to the club on the hidden-content list. Must not identify
a reporter.
minLength: 5
maxLength: 300
example: Off-topic promotion of a paid product.
required:
- reason
ClubSetupWizardDto:
type: object
properties:
tagline:
type: string
colorTheme:
type: string
example: '#0EA5E9'
mission:
type: string
rules:
type: string
memberExpectations:
type: string
onboardingMessage:
type: string
name:
type: string
description: Club name (2–150 chars)
slug:
type: string
description: Public Club URL slug
description:
type: string
description: Long-form about/description text
logoUrl:
type: string
description: Logo image URL (http/https only)
bannerUrl:
type: string
description: Banner image URL (http/https only)
city:
type: string
description: City
country:
type: string
description: Country
sports:
description: Sport ids (uuid array, max 12)
type: array
items:
type: string
isPublic:
type: boolean
description: Public discovery flag (false = members-only club)
requiresApproval:
type: boolean
description: Approval gate (true = gated, applications need admin approval)
membershipRequiresPayment:
type: boolean
description: >-
When true, a bare /join (no tierId) is refused — membership itself
requires paying for one of this club's active tiers.
refundPolicy:
$ref: '#/components/schemas/RefundPolicyInput'
pickupLocation:
type: string
description: >-
Shiprocket pickup location name, as registered in the club’s own
Shiprocket dashboard (Settings → Pickup Addresses). Used when this
club ships goodies via Shiprocket.
CreateClubInviteDto:
type: object
properties:
email:
type: string
description: >-
Invitee email. Supply at most one of email / phoneNumber; supply
neither for a shareable link invite.
phoneNumber:
type: string
description: Invitee phone (E.164 or digits). Mutually exclusive with email.
expiresInDays:
type: number
description: >-
Days until a LINK invite expires. Ignored for targeted invites,
which name a recipient and so carry no forwarding risk.
minimum: 1
maximum: 365
inviteRole:
type: string
description: >-
Club role granted the moment this invite is accepted. Omit for a
plain member. ADMIN may only be issued by an OWNER, mirroring the
promote endpoint. OWNER is never accepted — use transfer-ownership.
Role-bearing invites must name a recipient (email or phone); a
forwardable link cannot carry a role.
enum:
- ADMIN
- MODERATOR
role:
type: string
deprecated: true
description: Legacy no-op. Only "MEMBER" was ever valid. Use inviteRole.
enum:
- MEMBER
RejectClubDto:
type: object
properties: {}
DeactivateClubDto:
type: object
properties:
reason:
type: string
description: >-
Optional owner-supplied reason, recorded on the club.deactivated
audit entry.
maxLength: 500
PreviewClubTierBreakdownDto:
type: object
properties:
priceAmount:
type: number
description: Major currency units, e.g. 499 for ₹499
billingPeriod:
type: string
enum: *ref_649
default: MONTHLY
currency:
type: string
example: INR
required:
- priceAmount
AcceptClubOwnershipTransferDto:
type: object
properties: {}
AdminSetTierCommissionDto:
type: object
properties:
commissionPct:
type: number
description: >-
Per-tier platform commission percent. Send null to clear the
override.
minimum: 0
maximum: 100
nullable: true
AdminSetClubCommissionDto:
type: object
properties:
tierCommissionPct:
type: number
description: >-
Club-wide platform commission percent for paid membership tiers.
Send null to clear the override.
minimum: 0
maximum: 100
nullable: true
VerifyClubKycBankDto:
type: object
properties:
accountNumber:
type: string
description: Bank account number — digits only, 4–30 characters.
example: '50100123456789'
minLength: 4
maxLength: 30
ifsc:
type: string
description: >-
IFSC code — exactly 11 characters: 4 letters, a 0, then 6
alphanumerics.
example: HDFC0000123
minLength: 11
maxLength: 11
required:
- accountNumber
- ifsc
ReviewClubKycDto:
type: object
properties:
reason:
type: string
description: Reason shown to the club (10–500 chars)
example: The uploaded PAN card is illegible. Please re-upload a clear scan.
minLength: 10
maxLength: 500
required:
- reason
CreateClubRcGrantRequestDto:
type: object
properties:
requestedRc:
type: number
description: RC Coins the club is asking for. Positive, at most 2 decimal places.
example: 5000
minimum: 1
maximum: 10000000
reason:
type: string
description: Why the club needs the coins. Shown verbatim to the reviewing admin.
example: Seeding RC Coin prize slabs for our monsoon 10K series.
minLength: 10
maxLength: 1000
required:
- requestedRc
ApproveClubRcGrantDto:
type: object
properties:
approvedRc:
type: number
description: >-
RC Coins actually granted. Defaults to the full requested amount.
May be lower than requested, never higher.
example: 2500
minimum: 1
maximum: 10000000
decisionReason:
type: string
description: >-
Context for the decision — required in practice when the granted
amount is trimmed, so the club can see why.
example: Approving 2,500 of the 5,000 requested until first payout lands.
minLength: 10
maxLength: 1000
RejectClubRcGrantDto:
type: object
properties:
decisionReason:
type: string
description: Reason shown to the club (10-1000 chars).
example: >-
Club KYC is not approved yet. Re-request once settlement details are
verified.
minLength: 10
maxLength: 1000
required:
- decisionReason
ReviewDecisionDto:
type: object
properties:
decision:
type: string
enum:
- VALID
- INVALID
- PARTIAL_CREDIT
- ESCALATE
- REQUEST_INFO
notes:
type: string
escalationReason:
type: string
description: >-
§71.11 — required-ish for ESCALATE; surfaced to the senior reviewer
queue.
requestedInfoPrompt:
type: string
description: >-
§71.11 — REQUEST_INFO prompt shown to athlete (e.g. "upload Strava
raw .fit").
requestedInfoDueAt:
type: string
description: §71.11 — REQUEST_INFO deadline (ISO 8601).
required:
- decision
AppealDecisionDto:
type: object
properties:
decision:
type: string
enum:
- UPHELD
- REJECTED
resolutionNotes:
type: string
required:
- decision
PostLiveSignalsDto:
type: object
properties: {}
AppealEvidenceItemDto:
type: object
properties:
type:
type: string
enum:
- URL
- EXTERNAL_SYNC
- SCREENSHOT
value:
type: string
required:
- type
- value
SubmitAppealDto:
type: object
properties:
reason:
type: string
description: >-
Athlete's reason for appeal. PRD §71.12 requires substantive
reasoning — minimum 10 chars (legacy per-flag route) / minimum 30
chars (per-activity wrapper) per the Wave 1 brief. Stored verbatim
on the appeal record.
evidence:
type: array
items:
$ref: '#/components/schemas/AppealEvidenceItemDto'
required:
- reason
SubmitFlagInfoResponseDto:
type: object
properties:
message:
type: string
minLength: 10
maxLength: 2000
attachmentUrls:
description: >-
Optional already-uploaded absolute http(s) URLs (max 8 per
response).
type: array
items:
type: string
required:
- message
ScanQrDto:
type: object
properties:
qrPayload:
type: string
description: Signed QR payload previously issued to a participant.
required:
- qrPayload
SyncBatchCheckInActionDto:
type: object
properties:
clientActionId:
type: string
description: >-
Stable client-generated id for this action. Same id replayed N times
→ 1 server-side check-in. Use a UUID v4 or any unique 8-64 char
token.
example: c8a7b1f0-3a2e-4b6d-9f12-2a8e1c4f7d51
type:
type: string
description: >-
Type of scan: SCAN_QR (qrPayload required) or SCAN_BIB (bibNumber
required).
enum:
- SCAN_QR
- SCAN_BIB
qrPayload:
type: string
description: QR payload (when type=SCAN_QR).
bibNumber:
type: string
description: Bib number (when type=SCAN_BIB).
stationId:
type: string
description: >-
Volunteer-station identifier (e.g., "gate-A", "tent-1"). Stamped on
the audit log so admins can see which station scanned first when
conflicts surface.
example: gate-A
localTimestamp:
type: string
description: >-
Client-clock ISO timestamp at the moment the volunteer captured the
scan. Diverges from server `scannedAt` when an offline scan replays
minutes/hours later.
example: '2026-05-06T14:23:45.123Z'
required:
- clientActionId
- type
SyncBatchCheckInDto:
type: object
properties:
actions:
description: Batch of queued offline scan actions to replay.
type: array
items:
$ref: '#/components/schemas/SyncBatchCheckInActionDto'
required:
- actions
BibAssignmentItemDto:
type: object
properties: {}
BulkAssignBibsDto:
type: object
properties:
assignments:
type: array
items:
$ref: '#/components/schemas/BibAssignmentItemDto'
required:
- assignments
AutoAssignBibsDto:
type: object
properties:
strategy:
type: string
enum:
- MANUAL
- AUTO_BY_REGISTRATION
- AUTO_BY_TICKET_TYPE
- AUTO_BY_DISTANCE
- AUTO_BY_WAVE
startingNumber:
type: number
default: 1
dryRun:
type: boolean
description: When true, returns a preview without persisting.
default: true
required:
- strategy
UpdateBibDto:
type: object
properties:
bibNumber:
type: string
required:
- bibNumber
StartHybridRaceDto:
type: object
properties:
localRouteId:
type: string
description: Optional client-picked local route id (from /suggest).
startCoordinate:
type: object
description: Optional client start coordinate { lat, lng }.
registeredCityLatLng:
type: object
description: >-
Athlete-registered city coordinates from onboarding ({ lat, lng }).
PRD §21.3 + §21.8 city-radius gate.
acknowledgeAdventurerOverride:
type: boolean
description: >-
Acknowledge "Adventurer" override when starting outside registered
city radius (PRD §21.8).
isResume:
type: boolean
description: >-
Set true when resuming an interrupted race (post-crash /
post-restart). Default false → fresh start; backend rejects with
EC7_DUPLICATE_START if an in-progress race exists.
CheckpointDto:
type: object
properties:
t:
type: string
lat:
type: number
lng:
type: number
distanceM:
type: number
required:
- t
- lat
- lng
SubmitCheckpointsDto:
type: object
properties:
checkpoints:
type: array
items:
$ref: '#/components/schemas/CheckpointDto'
required:
- checkpoints
LivePositionPointDto:
type: object
properties:
lat:
type: number
description: WGS84 latitude
lng:
type: number
description: WGS84 longitude
ts:
type: number
description: Sample timestamp (UTC ms epoch)
accuracy:
type: number
description: Horizontal accuracy radius (meters)
minimum: 0
maximum: 10000
required:
- lat
- lng
- ts
- accuracy
PushLivePositionDto:
type: object
properties:
resultId:
type: string
description: Caller’s in-flight HybridRaceResult id
points:
description: Batch of GPS samples, max 60 per call (~30s of 1Hz capture).
type: array
items:
$ref: '#/components/schemas/LivePositionPointDto'
clientTelemetry:
type: object
additionalProperties: true
required:
- resultId
- points
FinishHybridRaceDto:
type: object
properties:
distanceMeters:
type: number
durationSeconds:
type: number
elevationGainM:
type: number
activityId:
type: string
clientTelemetry:
type: object
description: >-
Optional device telemetry for the §70.10 edge-case observation
ledger.
required:
- distanceMeters
- durationSeconds
SuggestLocalRouteQueryDto:
type: object
properties:
lat:
type: number
lng:
type: number
InitPhotoCheckQueryDto:
type: object
properties:
photoCheckId:
type: string
SubmitPhotoCheckDto:
type: object
properties:
capturedAt:
type: string
capturedLat:
type: number
capturedLng:
type: number
capturedAccuracyM:
type: number
imageS3Key:
type: string
required:
- capturedAt
- capturedLat
- capturedLng
- imageS3Key
SkipPhotoCheckDto:
type: object
properties:
acknowledgment:
type: string
required:
- acknowledgment
AppealPhotoCheckDto:
type: object
properties:
capturedAt:
type: string
capturedLat:
type: number
capturedLng:
type: number
imageS3Key:
type: string
reason:
type: string
mlTrainingConsent:
type: boolean
default: false
required:
- capturedAt
- capturedLat
- capturedLng
- imageS3Key
HybridConfigInputDto:
type: object
properties:
pricePct:
type: number
minimum: 0
maximum: 200
windowStart:
type: string
description: ISO-8601 timestamp — start of hybrid participation window
windowEnd:
type: string
description: ISO-8601 timestamp — end of hybrid participation window
raceStartTime:
type: string
description: Synchronised global race-start moment (ISO-8601 UTC)
merchIncluded:
type: boolean
description: Whether hybrid registration includes merch.
validationLevel:
type: string
enum:
- standard
- strict
- elite
leaderboardMode:
type: string
enum:
- separate
- unified
UpdateHybridConfigDto:
type: object
properties:
hybridEnabled:
type: boolean
description: Enable/disable hybrid race participation entirely.
hybridConfig:
description: Structured hybrid-race configuration block.
allOf:
- $ref: '#/components/schemas/HybridConfigInputDto'
leaderboardPolicy:
type: string
enum:
- RANKED
- ALL_FINISHERS_MEDAL
- DEGRADED_MEDAL
description: >-
Per-event leaderboard policy. RANKED keeps the classic competitive
board.
FlagResultForReviewDto:
type: object
properties:
dqReasonCode:
type: string
enum: &ref_651
- NO_ACTIVITY
- GPS_GAP
- ELEVATION_MISMATCH
- DISTANCE_MISMATCH
- EXTERNAL_SOURCE_DISALLOWED
- DEVICE_UNVERIFIED
- ANTI_CHEAT_FLAGGED
- TIER_MISMATCH
- MANUAL_ORGANIZER_REVIEW
- NOT_VALID
notes:
type: string
ResolveReviewDto:
type: object
properties:
outcome:
type: string
enum:
- VERIFIED
- REJECTED
dqReasonCode:
type: string
enum: *ref_651
notes:
type: string
required:
- outcome
UploadPhysicalResultItem:
type: object
properties: {}
UploadPhysicalResultsDto:
type: object
properties:
results:
type: array
items:
$ref: '#/components/schemas/UploadPhysicalResultItem'
required:
- results
UpdateMerchShipmentDto:
type: object
properties:
weight:
type: number
description: Package weight (≥ 0).
weightUnit:
type: string
enum:
- kg
- g
- lb
length:
type: number
description: Length (≥ 0).
width:
type: number
description: Width (≥ 0).
height:
type: number
description: Height (≥ 0).
dimensionUnit:
type: string
enum:
- cm
- in
shipFromAddress:
type: string
description: Origin address the parcel ships from.
CreateSigningSessionDto:
type: object
properties:
eventId:
type: string
description: Hybrid race event id
resultId:
type: string
description: In-flight HybridRaceResult id
routeType:
type: string
enum:
- HYBRID
- RANKED_ACTIVITY
- FREE_WORKOUT
description: Route type the signing session will protect.
appBuild:
type: string
description: >-
Format `ios:1.4.0+482` or `android:1.4.0+482`. Used by the
rollout-mode app-version gate.
platform:
type: string
enum:
- ios
- android
deviceMetadataSummary:
type: object
description: >-
Privacy-safe device metadata summary (no IMEI / no advertising id /
no installed-app list — see §70.4 / privacy minimization).
additionalProperties: true
attestationToken:
type: string
description: >-
Optional Apple App Attest / Google Play Integrity token. When
absent, Stage 6 device-integrity status records `unavailable`.
required:
- eventId
- resultId
- routeType
- appBuild
- platform
DecideReportAppealDto:
type: object
properties:
decision:
type: string
enum:
- APPROVED
- REJECTED
decisionNotes:
type: string
required:
- decision
CreateReportDto:
type: object
properties:
targetType:
type: string
enum:
- ACTIVITY
- CLUB
- CLUB_POST
- CLUB_DM_MESSAGE
- CHALLENGE
- EVENT
- USER
- FEED_COMMENT
- CLUB_POST_COMMENT
- ROUTE
- USER_DM_MESSAGE
- FEED_POST
- STORY
targetId:
type: string
reason:
type: string
notes:
type: string
evidenceUrls:
type: array
items:
type: string
required:
- targetType
- targetId
- reason
SubmitReportAppealDto:
type: object
properties:
reason:
type: string
required:
- reason
DestructiveActionDto:
type: object
properties:
reason:
type: string
description: >-
Free-text justification for the destructive action. 10–500 chars
after trim. Stored as audit metadata length only — the raw text is
NEVER stored in the audit log.
minLength: 10
maxLength: 500
required:
- reason
UpdateOrganizerEazrTagDto:
type: object
properties:
enabled:
type: boolean
description: Whether Eazr API-key clients may access the event catalogue
required:
- enabled
AddEvidenceDto:
type: object
properties: {}
SaveDefenseDraftDto:
type: object
properties: {}
TerminalReasonDto:
type: object
properties: {}
UnblockIpDto:
type: object
properties: {}
HealthActivityDeletionsDto:
type: object
properties:
externalIds:
description: Platform record UUIDs removed from the device health store
type: array
items:
type: string
required:
- externalIds
StartTrackingSessionDto:
type: object
properties: {}
AppendTrackingPointsDto:
type: object
properties: {}
FinishTrackingSessionDto:
type: object
properties: {}
AbandonTrackingSessionDto:
type: object
properties: {}
CreateLiveTrackingShareRecipientDto:
type: object
properties:
kind:
type: string
enum:
- PHONE
- EMAIL
- REPEAK_USER
description: >-
Identity type for this recipient. Exactly one of phone / email /
userId must be provided, matching this enum value.
phone:
type: string
description: Required when kind=PHONE. E.164 format recommended.
maxLength: 20
email:
type: string
description: Required when kind=EMAIL.
maxLength: 255
userId:
type: string
description: >-
Required when kind=REPEAK_USER. UUID of the recipient Repeak
account.
name:
type: string
description: Display name shown to the athlete + on the recipient page.
maxLength: 120
relation:
type: string
description: >-
Optional relation tag (e.g. "Spouse" / "Parent" / "Coach" /
"Friend"). Mirrors EventParticipant.emergencyContact.relation.
maxLength: 40
required:
- kind
- name
CreateLiveTrackingShareDto:
type: object
properties:
recipients:
description: >-
Recipients for this live-tracking share. 1–5 entries; each carries
exactly one identity (phone / email / userId).
minItems: 1
maxItems: 5
type: array
items:
$ref: '#/components/schemas/CreateLiveTrackingShareRecipientDto'
ttlHours:
type: number
description: >-
Time-to-live for this share, in hours. Default 4. Hard maximum 12
(server clamps).
minimum: 1
maximum: 12
default: 4
required:
- recipients
CancelLiveTrackingShareDto:
type: object
properties:
reason:
type: string
description: Free-text reason for cancellation. Stored in audit trail.
maxLength: 500
SendMessageDto:
type: object
properties:
body:
type: string
description: Message text body (max 4000 chars)
mediaUrl:
type: string
description: GCS public URL of attached media
mediaType:
type: string
description: 'Media type: IMAGE | VIDEO | AUDIO'
enum:
- IMAGE
- VIDEO
- AUDIO
messageType:
type: string
description: Special message type — "event_share" to share an event card
enum:
- event_share
eventId:
type: string
description: Event id or slug — required when messageType is "event_share"
MediaUploadDto:
type: object
properties:
mimeType:
type: string
description: MIME type of the file to upload (e.g. image/jpeg, video/mp4)
required:
- mimeType
CreateLinkDto:
type: object
properties:
targetPath:
type: string
description: >-
Canonical PATH on the public web domain (leading slash). e.g.
/events/mumbai-marathon-2026, /@salman, /r/CODE. Never a full URL.
example: /events/mumbai-marathon-2026
campaign:
type: string
utmSource:
type: string
utmMedium:
type: string
utmCampaign:
type: string
expiresAt:
type: string
description: ISO8601 expiry. After this, the link resolves as expired.
required:
- targetPath
SelectTierBody:
type: object
properties: {}
CreatePricingTierBody:
type: object
properties: {}
UpdatePricingTierBody:
type: object
properties: {}
CreateMarketplaceEconomicsBody:
type: object
properties: {}
UpdateMarketplaceEconomicsBody:
type: object
properties: {}
ShareEventDto:
type: object
properties:
surface:
type: string
enum: &ref_652
- HYBRID_RACE_RESULT
- ACTIVITY
- YEAR_IN_SPORT
- REPEAK_ID
- FEED_EVENT
- EVENT
- CHALLENGE
- ROUTE
- POST
- EDITION
- CLUB
- BRAND
- REFERRAL
subjectId:
type: string
channel:
type: string
enum:
- NATIVE_SHEET
- WHATSAPP
- INSTAGRAM
- COPY_LINK
- UNKNOWN
utm:
type: object
description: utm tags; server normalises source/medium/campaign
example:
source: repeak_share
medium: mobile
campaign: race
required:
- surface
- subjectId
ShareLinkOpenedDto:
type: object
properties:
surface:
type: string
enum: *ref_652
subjectId:
type: string
utmSource:
type: string
utmMedium:
type: string
utmCampaign:
type: string
required:
- surface
- subjectId
InstallAttributedDto:
type: object
properties:
surface:
type: string
enum: *ref_652
utmSource:
type: string
utmMedium:
type: string
utmCampaign:
type: string
CreateAdaptivePlanDto:
type: object
properties:
targetDistance:
type: string
enum:
- TEN_K
- HALF
targetEventId:
type: string
goalTimeSeconds:
type: number
description: Goal finish time in seconds
startDate:
type: string
description: ISO date
targetDate:
type: string
description: ISO date; must be after startDate
weeklyRunDays:
type: number
description: Weekly run days 3..6
baselineWeeklyKm:
type: number
description: Athlete's honest recent weekly km
baselineActivityId:
type: string
required:
- targetDistance
- startDate
- targetDate
- weeklyRunDays
LaunchSessionDto:
type: object
properties:
executionSource:
type: string
enum: &ref_653
- APPLE_WATCH
- PHONE_GUIDED
- MANUAL
required:
- executionSource
CompleteSessionDto:
type: object
properties:
completedActivityId:
type: string
notes:
type: string
executionSource:
type: string
enum: *ref_653
actualDurationSeconds:
type: number
actualDistanceMeters:
type: number
avgPaceSecPerKm:
type: number
avgHeartRateBpm:
type: number
AbandonSessionDto:
type: object
properties:
reason:
type: string
executionSource:
type: string
enum: *ref_653
completedIntervalCount:
type: number
CreateRouteDto:
type: object
properties:
name:
type: string
city:
type: string
country:
type: string
default: IN
distanceMeters:
type: number
distanceBucket:
type: string
enum: &ref_654
- 5K
- 10K
- 15K
- HALF
elevationGainMeters:
type: number
surface:
type: string
enum: &ref_655
- ROAD
default: ROAD
terrain:
type: string
enum: &ref_656
- FLAT
- ROLLING
- HILLY
default: FLAT
startLat:
type: number
startLng:
type: number
polyline:
type: string
description: JSON-encoded array of [lat,lng] pairs.
notes:
type: string
source:
type: string
enum: &ref_657
- CURATED_V1
- COMMUNITY
default: CURATED_V1
sport:
type: string
enum: &ref_658
- RUN
- CYCLE
- WALK
- HIKE
default: RUN
description: >-
Sport this route is designed for. Wire codes: RUN | CYCLE | WALK |
HIKE.
required:
- name
- city
- distanceMeters
- distanceBucket
- startLat
- startLng
- polyline
UpdateRouteDto:
type: object
properties:
name:
type: string
city:
type: string
country:
type: string
default: IN
distanceMeters:
type: number
distanceBucket:
type: string
enum: *ref_654
elevationGainMeters:
type: number
surface:
type: string
enum: *ref_655
default: ROAD
terrain:
type: string
enum: *ref_656
default: FLAT
startLat:
type: number
startLng:
type: number
polyline:
type: string
description: JSON-encoded array of [lat,lng] pairs.
notes:
type: string
source:
type: string
enum: *ref_657
default: CURATED_V1
sport:
type: string
enum: *ref_658
default: RUN
description: >-
Sport this route is designed for. Wire codes: RUN | CYCLE | WALK |
HIKE.
SubmitVirtualRunDto:
type: object
properties: {}
SetSingleConsentDto:
type: object
properties: {}
SetBulkConsentDto:
type: object
properties: {}
DataErasureRequestDto:
type: object
properties: {}
DataErasureCancelDto:
type: object
properties: {}
AdminErasureRejectDto:
type: object
properties: {}
CreatePrizeTaxDto:
type: object
properties: {}
AggregateForm16ADto:
type: object
properties: {}
GenerateForm16ADto:
type: object
properties: {}
PreviewMergeDto:
type: object
properties: {}
ProposeMergeDto:
type: object
properties: {}
CancelMergeDto:
type: object
properties: {}
NotifyWinnerDto:
type: object
properties: {}
RevealSafetyProfileDto:
type: object
properties:
justification:
type: string
description: >-
Required justification for the medical-info reveal. Examples: "bib
42 — heat exhaustion suspected", "incident #42 paramedic on scene".
Stored on the medical_info_access_logs row.
emergency:
type: boolean
description: >-
Set true when the reveal is in active emergency context (paramedic
on scene, athlete unresponsive). Switches the access log reason to
EMERGENCY_REVEAL.
default: false
required:
- justification
CreateMedicalIncidentDto:
type: object
properties:
incidentType:
type: string
enum:
- DEHYDRATION
- CRAMPING
- CHEST_PAIN
- ALLERGIC_REACTION
- COLLAPSE
- INJURY
- HEAT_EXHAUSTION
- GI_DISTRESS
- OTHER
severity:
type: string
enum: &ref_659
- MILD
- MODERATE
- SEVERE
- CRITICAL
description:
type: string
description: What happened, interventions taken so far.
athleteResponsive:
type: boolean
default: true
ambulanceDispatched:
type: boolean
default: false
hospitalTransferred:
type: boolean
default: false
location:
type: string
description: On-course location / checkpoint.
required:
- incidentType
- severity
- description
UpdateMedicalIncidentDto:
type: object
properties:
status:
type: string
enum:
- OPEN
- UNDER_OBSERVATION
- ESCALATED
- TRANSFERRED
- CLOSED
severity:
type: string
enum: *ref_659
description:
type: string
athleteResponsive:
type: boolean
ambulanceDispatched:
type: boolean
hospitalTransferred:
type: boolean
location:
type: string
resolutionNotes:
type: string
description: Notes for the incident timeline.
hospitalName:
type: string
description: >-
Destination hospital name. Required when status transitions to
TRANSFERRED (server enforces).
ambulanceReference:
type: string
description: >-
Ambulance dispatch / transport reference number. Required when
status transitions to TRANSFERRED.
CloseMedicalIncidentDto:
type: object
properties:
resolutionNotes:
type: string
description: Required closing note for audit trail.
required:
- resolutionNotes
RiskActionDto:
type: object
properties:
note:
type: string
description: Optional admin note attached to the audit log row. Max 1000 chars.
QuoteSubscriptionDto:
type: object
properties:
planPriceId:
type: string
description: Chosen plan price row id
couponCode:
type: string
description: Coupon code as typed by the user
countryCode:
type: string
description: ISO-3166 alpha-2, e.g. IN
providerKey:
type: string
enum:
- CASHFREE
- RAZORPAY
- STRIPE
required:
- planPriceId
CreatePlanDto:
type: object
properties:
code:
type: string
example: ATHLETE_PASSPORT
audience:
type: string
enum: &ref_662
- ATHLETE
- ORGANIZER
- BRAND
- CLUB
name:
type: string
displayName:
type: string
description:
type: string
tagline:
type: string
badgeText:
type: string
example: Most Popular
themeColor:
type: string
example: '#0C656D'
iconUrl:
type: string
bannerUrl:
type: string
sortOrder:
type: number
default: 0
priority:
type: number
default: 0
description: Tier rank; higher = better. Infers upgrade/downgrade direction.
isRecommended:
type: boolean
default: false
isDefaultPlan:
type: boolean
default: false
description: The plan free users resolve to. Exactly one per audience.
visibility:
type: string
enum: &ref_660
- PUBLISHED
- HIDDEN
- DRAFT
- INVITE_ONLY
- INTERNAL
- BETA
- ARCHIVED
status:
type: string
enum: &ref_661
- ACTIVE
- DRAFT
- DISABLED
- ARCHIVED
- SCHEDULED
visibilityFlagKey:
type: string
description: >-
Delegates BETA / INVITE_ONLY visibility to the existing feature-flag
engine
required:
- code
- audience
- name
UpdatePlanDto:
type: object
properties:
name:
type: string
displayName:
type: string
description:
type: string
tagline:
type: string
badgeText:
type: string
themeColor:
type: string
iconUrl:
type: string
bannerUrl:
type: string
sortOrder:
type: number
priority:
type: number
isRecommended:
type: boolean
isDefaultPlan:
type: boolean
visibility:
type: string
enum: *ref_660
status:
type: string
enum: *ref_661
visibilityFlagKey:
type: string
MintVersionDto:
type: object
properties:
changeNote:
type: string
description: Why this version exists — shows in the diff view
required:
- changeNote
UpdateVersionDto:
type: object
properties:
trialEnabled:
type: boolean
trialDays:
type: number
trialPolicy:
type: string
enum:
- NONE
- ONE_TIME_PER_USER
- ONE_TIME_PER_PLAN
- REPEATABLE
paymentMethodRequired:
type: boolean
autoRenewDefault:
type: boolean
taxCategoryId:
type: string
effectiveFrom:
format: date-time
type: string
effectiveTo:
format: date-time
type: string
changeNote:
type: string
UpsertPriceDto:
type: object
properties:
billingCycle:
type: string
enum:
- MONTHLY
- QUARTERLY
- HALF_YEARLY
- YEARLY
- LIFETIME
- CUSTOM_DAYS
- PER_EVENT
currency:
type: string
example: INR
amountMinor:
type: number
example: 19900
description: Minor units (paise)
customDays:
type: number
countryCode:
type: string
description: ISO-3166 alpha-2. Mutually exclusive with regionCode.
regionCode:
type: string
description: Mutually exclusive with countryCode.
compareAtAmountMinor:
type: number
description: Strike-through anchor, minor units
taxBehavior:
type: string
enum:
- INCLUSIVE
- EXCLUSIVE
default: EXCLUSIVE
required:
- billingCycle
- currency
- amountMinor
PublishVersionDto:
type: object
properties:
allowUnsyncedProvider:
type: boolean
default: false
description: >-
Publish for display/entitlement before a payment provider is wired.
Checkout still refuses to sell it.
CreateFeatureDto:
type: object
properties:
code:
type: string
example: ai_queries
name:
type: string
description:
type: string
categoryCode:
type: string
parentFeatureCode:
type: string
defaultLimitUnit:
type: string
example: QUERIES
isVisible:
type: boolean
default: true
description: false = backend-only gate
sortOrder:
type: number
required:
- code
- name
SetPlanFeatureDto:
type: object
properties:
featureCode:
type: string
example: ai_queries
enabled:
type: boolean
limitValue:
type: number
description: null / omitted = unlimited
limitUnit:
type: string
limitPeriod:
type: string
enum:
- DAY
- WEEK
- MONTH
- BILLING_PERIOD
- LIFETIME
resetPolicy:
type: string
enum:
- CALENDAR
- ROLLING
- BILLING_ANCHOR
default: CALENDAR
graceValue:
type: number
description: Soft overage before a hard block
overagePolicy:
type: string
enum:
- BLOCK
- WARN
- ALLOW_BILLABLE
default: BLOCK
metadata:
type: object
description: 'Feature-scoped config, e.g. {"historyDays": 90}'
required:
- featureCode
- enabled
SimulateEntitlementsDto:
type: object
properties:
userId:
type: string
audience:
type: string
enum: *ref_662
planVersionId:
type: string
planPriceId:
type: string
couponCode:
type: string
countryCode:
type: string
CouponScopeDto:
type: object
properties:
scopeType:
type: string
enum:
- PLAN
- PLAN_VERSION
- BILLING_CYCLE
- COUNTRY
- CURRENCY
- PROVIDER
- AUDIENCE
- USER_SEGMENT
scopeValue:
type: string
isExclusion:
type: boolean
default: false
required:
- scopeType
- scopeValue
BulkCouponTemplateDto:
type: object
properties:
discountType:
type: string
enum: *ref_663
percentValue:
type: number
description: PERCENT only — whole percent 1–100
flatAmountMinor:
type: number
description: FLAT only — minor units
currency:
type: string
description: Required for FLAT
maxDiscountMinor:
type: number
description: PERCENT cap, minor units
minPurchaseMinor:
type: number
description: Minimum order, minor units
freePeriodCount:
type: number
description: FREE_PERIOD only — cycles free
trialExtensionDays:
type: number
description: TRIAL_EXTENSION only — extra days
appliesToRenewals:
type: boolean
default: true
description: >-
false = first cycle only. Requires a provider that supports a first
charge differing from the mandate amount, or the discount silently
repeats on every renewal.
newSubscribersOnly:
type: boolean
default: false
maxRedemptions:
type: number
description: Total redemptions; null = unlimited
maxRedemptionsPerUser:
type: number
description: Per-user redemptions; null = unlimited
stackable:
type: boolean
default: false
startsAt:
format: date-time
type: string
endsAt:
format: date-time
type: string
publicDescription:
type: string
description: Shown to the user when the code is rejected
internalNote:
type: string
scopes:
type: array
items:
$ref: '#/components/schemas/CouponScopeDto'
name:
type: string
description: Label applied to every coupon in the batch
example: Ambassador programme
required:
- discountType
BulkGenerateCouponsDto:
type: object
properties:
prefix:
type: string
example: AMBASSADOR
count:
type: number
example: 50
batchTag:
type: string
template:
$ref: '#/components/schemas/BulkCouponTemplateDto'
required:
- prefix
- count
- batchTag
- template
PreviewCouponDto:
type: object
properties:
planPriceId:
type: string
countryCode:
type: string
userId:
type: string
description: Simulate for a specific user
providerKey:
type: string
enum:
- CASHFREE
- RAZORPAY
- STRIPE
isRenewal:
type: boolean
default: false
required:
- planPriceId
UpsertRegionDto:
type: object
properties:
code:
type: string
example: EU
name:
type: string
example: Europe
countryCodes:
example:
- DE
- FR
- ES
description: ISO-3166 alpha-2. A country may belong to only one region.
type: array
items:
type: string
defaultCurrency:
type: string
example: EUR
required:
- code
- name
- countryCodes
- defaultCurrency
UpsertTaxCategoryDto:
type: object
properties:
code:
type: string
example: GST_18
name:
type: string
example: India GST 18%
computation:
type: string
enum:
- PERCENT
- NONE
- COMPOUND
required:
- code
- name
AddTaxRateDto:
type: object
properties:
taxCategoryId:
type: string
percentBasis:
type: number
example: 1800
description: BASIS POINTS — 1800 means 18%. Never a decimal percentage.
countryCode:
type: string
description: ISO alpha-2; omit for a global rate
stateCode:
type: string
description: Sub-national code, e.g. an Indian state
hsnSacCode:
type: string
effectiveFrom:
format: date-time
type: string
description: Defaults to now. Supersedes the open rate for this scope.
required:
- taxCategoryId
- percentBasis
UpsertProviderDto:
type: object
properties:
providerKey:
type: string
example: CASHFREE
displayName:
type: string
example: Cashfree Payments
enabled:
type: boolean
default: false
description: Rejected unless an adapter for this key is compiled in.
supportsRecurring:
type: boolean
supportsMandates:
type: boolean
supportsRefunds:
type: boolean
supportsFirstChargeOverride:
type: boolean
description: >-
Whether a first charge may differ from the mandate amount. FALSE
means first-cycle-only coupons are impossible on this provider — the
discount would repeat on every renewal.
supportedCurrencies:
type: array
items:
type: string
supportedCountries:
type: array
items:
type: string
priority:
type: number
required:
- providerKey
- displayName
UpsertProviderRefDto:
type: object
properties:
planPriceId:
type: string
providerKey:
type: string
enum:
- CASHFREE
- RAZORPAY
- STRIPE
providerPlanId:
type: string
description: The provider-side plan identifier
syncStatus:
type: string
enum:
- PENDING
- SYNCED
- FAILED
description: A paid price cannot be published until this is SYNCED.
lastError:
type: string
required:
- planPriceId
- providerKey
AddFeatureDependencyDto:
type: object
properties:
featureCode:
type: string
example: ai_queries
requiresFeatureCode:
type: string
example: ai
description: Must be enabled wherever `featureCode` is enabled
required:
- featureCode
- requiresFeatureCode
SubmitPurchaseDto:
type: object
properties:
store:
type: string
description: Which store the purchase happened on.
enum:
- APP_STORE
- PLAY_STORE
purchaseToken:
type: string
description: >-
Apple: originalTransactionId. Google: the purchase token. Both are
the store's stable lineage key.
transactionId:
type: string
description: This period's transaction id, when the client has it.
productId:
type: string
description: Store product id, used only for logging when lookup fails.
required:
- store
- purchaseToken
UpdateSubscriptionSettingsDto:
type: object
properties:
subscriptionsEnabled:
type: boolean
description: >-
Master switch. False hides the paywall everywhere, refuses quotes,
and makes all feature gates inert. Never revokes existing
subscribers.
enforcementEnabled:
type: boolean
description: >-
Whether feature gates actually deny. False = shadow mode (log only).
Forced false while subscriptionsEnabled is false.
iapEnabled:
type: boolean
description: Offer store purchases in the mobile app.
webCheckoutEnabled:
type: boolean
description: Offer web checkout on web surfaces.
renewalToleranceHours:
type: number
description: >-
Hours past a period end before a missing renewal is treated as
lapsed. Covers store notification latency — too low revokes access
from paying subscribers over a queue delay, too high leaks free
access. 0–720.
minimum: 0
maximum: 720
example: 48
dunningGraceDays:
type: number
description: >-
Days a lapsed subscriber keeps access while the store retries the
charge. Applies to FAILED RENEWALS only — a deliberate cancellation
never receives grace. 0 disables dunning. 0–90.
minimum: 0
maximum: 90
example: 3
note:
type: string
description: >-
Operator note explaining the current posture. Shown beside the
switch.
ExtendSubscriptionDto:
type: object
properties:
days:
type: number
description: >-
Days to add. Additive only — the period end moves forward and is
never shortened.
minimum: 1
maximum: 3650
example: 30
reason:
type: string
description: Why. Shown in the audit trail; a support ticket reference is ideal.
example: 'Ticket #4821 — charged but entitlement never applied'
required:
- days
- reason
RevokeSubscriptionDto:
type: object
properties:
reason:
type: string
description: >-
Why access is being withdrawn. Recorded on the subscription and in
the audit log.
example: Chargeback received from issuing bank
required:
- reason
UpsertStoreProductRefDto:
type: object
properties:
planPriceId:
type: string
description: Plan price row this store product bills
storeKey:
type: string
enum:
- APP_STORE
- PLAY_STORE
storeProductId:
type: string
description: >-
Apple product identifier, or Google subscription product id. Must be
unique per store.
storeBasePlanId:
type: string
description: Google only — base plan id within the subscription product.
storeOfferId:
type: string
description: Intro / promotional offer id.
storeAmountMinor:
type: number
description: >-
Price the STORE charges, in minor units. Recorded to detect drift
against our catalog price.
storeCurrency:
type: string
description: ISO-4217, e.g. INR
markSynced:
type: boolean
description: >-
Assert the product exists and is live in the store console. Required
before the price becomes purchasable on mobile.
required:
- planPriceId
- storeKey
- storeProductId
MintCohortLinkDto:
type: object
properties: {}
VerifyCohortLinkDto:
type: object
properties: {}
CreateTrainingProgramDto:
type: object
properties:
name:
type: string
maxLength: 200
description:
type: string
sport:
type: string
description: Sport key (e.g., "running", "cycling").
maxLength: 40
totalDurationWeeks:
type: number
minimum: 1
maximum: 52
eventId:
type: string
description: >-
Optional event scope — when set, anchors the template to a specific
event the organizer owns.
required:
- name
- sport
- totalDurationWeeks
UpdateTrainingProgramDto:
type: object
properties:
name:
type: string
maxLength: 200
description:
type: string
sport:
type: string
description: Sport key (e.g., "running", "cycling").
maxLength: 40
totalDurationWeeks:
type: number
minimum: 1
maximum: 52
eventId:
type: string
description: >-
Optional event scope — when set, anchors the template to a specific
event the organizer owns.
status:
type: string
enum:
- DRAFT
- PUBLISHED
- ARCHIVED
AddWorkoutDto:
type: object
properties:
weekNumber:
type: number
minimum: 1
maximum: 52
dayNumber:
type: number
minimum: 1
maximum: 7
workoutType:
type: string
enum:
- EASY
- TEMPO
- INTERVALS
- HILL_REPEATS
- LONG
- RECOVERY
- CROSS_TRAIN
- REST
distanceMeters:
type: number
durationMinutes:
type: number
intensityZone:
type: string
maxLength: 40
description:
type: string
audioCuesConfig:
type: object
sourceLibraryWorkoutId:
type: string
required:
- weekNumber
- dayNumber
- workoutType
UpdateWorkoutDto:
type: object
properties:
completionStatus:
type: string
description: Workout completion status
enum:
- pending
- completed
- partial
- missed
- exceeded
example: completed
actualActivityId:
type: string
description: Actual activity ID if linked to an activity
actualDistanceKm:
type: number
description: Actual distance completed in kilometers
example: 5.5
actualDurationMinutes:
type: number
description: Actual duration in minutes
example: 35
actualPace:
type: string
description: Actual pace achieved
example: 6:30 min/km
performanceNotes:
type: string
description: Performance notes or comments
example: Felt great, maintained consistent pace
CustomizeFromLibraryDto:
type: object
properties:
libraryWorkoutId:
type: string
description: Library workout id (e.g., "lib-easy-30min-z2").
weekNumber:
type: number
minimum: 1
maximum: 52
dayNumber:
type: number
minimum: 1
maximum: 7
required:
- libraryWorkoutId
- weekNumber
- dayNumber
AssignProgramDto:
type: object
properties:
eventId:
type: string
athleteUserId:
type: string
notes:
type: string
required:
- eventId
- athleteUserId
BulkAssignProgramDto:
type: object
properties:
eventId:
type: string
athleteUserIds:
type: array
items:
type: string
required:
- eventId
- athleteUserIds
SaveOnboardingInterestsDto:
type: object
properties:
sportIds:
minItems: 1
maxItems: 8
type: array
items:
type: string
topicIds:
maxItems: 40
type: array
items:
type: string
subtopicIds:
maxItems: 80
type: array
items:
type: string
required:
- sportIds
- topicIds
- subtopicIds
CreateUserAlbumDto:
type: object
properties:
name:
type: string
description: Album name
description:
type: string
type:
type: string
enum:
- RACE_DAY
- TRAINING
- CLUB
- CUSTOM
description: >-
Album type — defaults to CUSTOM. RACE_DAY requires eventId; CLUB
requires clubId.
eventId:
type: string
clubId:
type: string
required:
- name
UpdateUserAlbumDto:
type: object
properties:
name:
type: string
description:
type: string
coverPhotoId:
type: string
CreateUserPhotoDto:
type: object
properties:
fileUrl:
type: string
description: S3 URL of the uploaded photo
caption:
type: string
albumId:
type: string
activityId:
type: string
eventId:
type: string
widthPx:
type: number
heightPx:
type: number
privacy:
type: string
description: 'Privacy scope: public | followers | private'
required:
- fileUrl
UpdateUserPhotoDto:
type: object
properties:
caption:
type: string
albumId:
type: string
description: Move photo to a different album
privacy:
type: string
UpdateEditionDto:
type: object
properties:
minimumDistanceKm:
type: number
description: >-
Minimum GPS distance (km) an athlete must cover to receive a
finisher certificate. Stored as proofRules.minimumDistance in
meters.
example: 5
certificateTemplateUrl:
type: string
description: URL of the finisher certificate template issued for this edition.
example: https://cdn.repeak.co/certificates/marathon-2026.png
BulkEventActionDto:
type: object
properties: {}
MoveParticipationToWaveDto:
type: object
properties: {}
SeedWavesDto:
type: object
properties: {}
UpdateSelfServiceConfigDto:
type: object
properties: {}
AcceptEventGoodieDto:
type: object
properties:
segmentId:
type: string
rankStart:
type: number
example: 1
rankEnd:
type: number
example: 1
EventRankWinnerDto:
type: object
properties:
rank:
type: number
example: 1
description: Finishing rank (1 = winner).
userId:
type: string
description: >-
The announced participant (userId) — the payable account credited on
distribution.
participantId:
type: string
description: >-
The specific EventParticipant the organizer picked as this rank's
winner — for a group booking, the actual finisher may differ from
the paying account (userId). Omit for a solo booking where the
account holder is themself the finisher.
required:
- rank
- userId
EventSegmentResultsDto:
type: object
properties:
segmentId:
type: string
description: Prize leaderboard (segment) id.
winners:
type: array
items:
$ref: '#/components/schemas/EventRankWinnerDto'
required:
- segmentId
- winners
AnnounceEventResultsDto:
type: object
properties:
segments:
type: array
items:
$ref: '#/components/schemas/EventSegmentResultsDto'
required:
- segments
ProposeEventGoodieDto:
type: object
properties:
segmentId:
type: string
description: Target segment (leaderboard) id; omit to let the organizer route it.
rankStart:
type: number
example: 1
rankEnd:
type: number
example: 3
goodieName:
type: string
example: Branded hydration pack
goodieDescription:
type: string
imageUrl:
type: string
description: Goodie image URL.
quantity:
type: number
example: 1
required:
- goodieName
CreateEventBadgeDto:
type: object
properties: {}
EventGeographicRestrictionsDto:
type: object
properties: {}
CouponApplicableTicketDto:
type: object
properties:
couponId:
type: string
description: Coupon ID
example: 123e4567-e89b-12d3-a456-426614174000
ticketIds:
description: Array of ticket IDs that this coupon applies to
example:
- 123e4567-e89b-12d3-a456-426614174001
- 123e4567-e89b-12d3-a456-426614174002
type: array
items:
type: string
required:
- couponId
- ticketIds
GeoJsonPointDto:
type: object
properties:
type:
type: string
description: The type of geometry
example: Point
enum:
- Point
coordinates:
example:
- 72.8777
- 19.076
type: array
items:
type: string
required:
- type
- coordinates
CreateEventLocationDto:
type: object
properties:
id:
type: string
description: Event Location Id
example: 123e4567-e89b-12d3-a456-426614174000
city:
type: string
description: The city of the event location
example: Mumbai
state:
type: string
description: The state of the event location
example: Maharashtra
address:
type: string
description: The address of the event location
example: 123 Main Street, City, Country
coordinate:
description: The geographical coordinates of the event location
allOf:
- $ref: '#/components/schemas/GeoJsonPointDto'
platform:
type: string
description: Virtual event platform name
example: Zoom
link:
type: string
description: Virtual event meeting link
example: https://zoom.us/j/1234567890
password:
type: string
description: Virtual event meeting password
example: password123
additionalInstructions:
type: string
description: Virtual event meeting password
example: password123
isActive:
type: boolean
description: The is active of the event location
example: true
isProvisional:
type: boolean
description: >-
TRUE when the address/coordinate are an auto-filled placeholder
(e.g. a city centroid) rather than a confirmed venue. Template flow
sends true; send false once the organizer confirms a real venue.
example: false
required:
- id
CreateEventTicketDto:
type: object
properties:
id:
type: string
description: Event Ticket Id
example: 123e4567-e89b-12d3-a456-426614174000
name:
type: string
description: Name of the ticket
description:
type: string
description: Description of the ticket
saleStartDateTime:
type: string
description: Start date and time of the event
example: '2024-12-25T09:00:00.000Z'
saleEndDateTime:
type: string
description: End date and time of the event
example: '2024-12-25T17:00:00.000Z'
type:
type: string
enum:
- free
- paid
- donation
default: paid
description: Type of ticket
ticketCategory:
type: string
enum:
- individual
- group
default: individual
description: 'Ticket category: individual or group'
groupSize:
type: number
description: Number of participants per ticket (applicable for group tickets)
default: 1
minimum: 1
minAge:
type: number
description: Minimum age required for this ticket
minimum: 0
maxAge:
type: number
description: Maximum age allowed for this ticket
minimum: 0
minPerBooking:
type: number
description: Minimum tickets per booking
default: 1
maxPerBooking:
type: number
description: Maximum tickets per booking
default: 10
price:
type: number
description: Price required for this ticket
minimum: 0
discountedPrice:
type: number
description: Optional discounted price. Empty, null, and zero mean no discount.
minimum: 0
nullable: true
quantity:
type: number
description: Quantity required for this ticket
minimum: 0
isActive:
type: boolean
description: Whether the event ticket is active
example: true
default: true
required:
- id
- name
- saleStartDateTime
- saleEndDateTime
- type
- minPerBooking
- maxPerBooking
CreateEventSlotDto:
type: object
properties:
id:
type: string
description: Event Slot Id
example: 123e4567-e89b-12d3-a456-426614174000
name:
type: string
description: Name of the event slot
example: Morning slot
startDateTime:
type: string
description: Start time of the event slot in HH:mm format
example: '09:00'
endDateTime:
type: string
description: End time of the event slot in HH:mm format
example: '17:00'
eventTickets:
description: Event tickets for this slot
type: array
items:
$ref: '#/components/schemas/CreateEventTicketDto'
isActive:
type: boolean
description: Whether the event slot is active
example: true
default: true
required:
- id
- name
- startDateTime
- endDateTime
- eventTickets
CreateEventAddOnDto:
type: object
properties:
id:
type: string
description: Event Add On Id
example: 123e4567-e89b-12d3-a456-426614174000
productId:
type: string
description: Product ID for the add-on
example: 123e4567-e89b-12d3-a456-426614174000
quantity:
type: number
description: Quantity available for this add-on
example: 100
minimum: 0
default: 0
isActive:
type: boolean
description: Whether the add-on is active
example: true
default: true
required:
- id
- productId
CreateEventDto:
type: object
properties:
ownerOrganizerId:
type: string
description: >-
Admin-only target organizer. Ignored for non-admin callers and
validated server-side.
desktopVideoUploadKey:
type: string
description: >-
Temporary owned object key returned by POST /v2/events/video-uploads
for the desktop cover video.
desktopVideoCrop:
type: string
description: JSON crop/trim settings for the 16:9 desktop cover video.
promoVideoUploadKey:
type: string
description: >-
Temporary owned object key returned by POST /v2/events/video-uploads
for the mobile cover video.
promoVideoCrop:
type: string
description: JSON crop/trim settings for the 4:5 mobile cover video.
removeDesktopVideo:
type: boolean
description: Remove the saved desktop cover video.
removePromoVideo:
type: boolean
description: Remove the saved mobile cover video.
galleryVideoCrop:
type: string
description: JSON crop/trim settings for the optional 4:5 gallery video.
removeGalleryVideo:
type: boolean
description: Remove the currently saved gallery video.
listingMode:
type: string
enum: &ref_664
- REPEAK_TICKETING
- INFORMATION_ONLY
default: REPEAK_TICKETING
description: >-
Organizer event publishing model. INFORMATION_ONLY requires an
active Organizer Official Partner agreement.
premiumPageEnabled:
type: boolean
default: true
raceInformation:
type: object
description: Race guide and event-day logistics shown on the premium event page.
eventBadge:
description: Optional participation badge submitted with the event.
allOf:
- $ref: '#/components/schemas/CreateEventBadgeDto'
brandPartners:
description: Optional partners shown on an information-only event page.
type: array
items:
type: string
title:
type: string
description: Title of the event
example: Annual Marathon 2024
maxLength: 250
description:
type: string
description: Description of the event
example: >-
Join us for the most exciting marathon event of the year with
amazing prizes and challenges.
startDateTime:
type: string
description: Start date and time of the event
example: '2024-12-25T09:00:00.000Z'
endDateTime:
type: string
description: End date and time of the event
example: '2024-12-25T17:00:00.000Z'
registrationOpensAt:
type: string
description: >-
When public registration opens. Omit for "open immediately", which
is how every event behaves by default. Subscribers whose plan
includes early access may register a configured number of hours
before this time.
example: '2024-11-01T10:00:00.000Z'
type:
type: string
description: Type of the event
enum: &ref_665
- virtual
- in_person
- hybrid
example: in_person
themeColor:
type: string
description: >-
Per-event override for theme color (#RRGGBB). When omitted, cascades
from organizer brand-page default. PRD §44.2.
example: '#FF6B35'
currency:
type: string
description: >-
ISO 4217 currency code for ticket prices. Defaults to INR. Cascades
from organizer brand-page default at creation.
example: INR
organizerLogoUrl:
type: string
description: >-
Per-event override for organizer logo URL. When omitted, cascades
from organizer brand-page default. PRD §44.2.
example: https://cdn.acme.com/logo.png
standardFieldsConfig:
type: object
description: >-
Per-event override for standard-fields config blob. When omitted,
cascades from organizer brand-page default. PRD §44.2.
clubId:
type: string
description: >-
When set, the event is floated on behalf of this club instead of the
calling organizer. The organizer must own the club. Vision §1 —
clubs are first-class event creators.
example: 123e4567-e89b-12d3-a456-426614174000
sponsorId:
type: string
description: >-
When set, the event is floated on behalf of this sponsor brand. The
calling user must have an ACTIVE SponsorAccount for the brand.
Vision §1 — sponsors are first-class event hosts.
example: 123e4567-e89b-12d3-a456-426614174000
eventGeographicRestrictions:
description: >-
Limit who can register by country / city. When openGlobally is true
the lists are ignored. Mostly used for hybrid races.
allOf:
- $ref: '#/components/schemas/EventGeographicRestrictionsDto'
couponApplicableTicket:
description: >-
Array of coupon-ticket mappings specifying which coupons apply to
which tickets
example: &ref_666
- couponId: 123e4567-e89b-12d3-a456-426614174000
ticketIds:
- 123e4567-e89b-12d3-a456-426614174001
- 123e4567-e89b-12d3-a456-426614174002
type: array
items:
$ref: '#/components/schemas/CouponApplicableTicketDto'
location:
description: Location details of the event
allOf:
- $ref: '#/components/schemas/CreateEventLocationDto'
couponIds:
description: Array of coupon IDs for event discounts
example: &ref_667
- 123e4567-e89b-12d3-a456-426614174000
- 987fcdeb-51a2-43d1-b456-426614174000
type: array
items:
type: string
coinsDiscountPercentage:
type: number
description: Coins discount percentage (0-100 with 2 decimal places)
example: 15.25
minimum: 0
maximum: 100
slots:
description: Event slots with their tickets
type: array
items:
$ref: '#/components/schemas/CreateEventSlotDto'
addOns:
description: Array of add-on products with quantities
example: &ref_668
- productId: 123e4567-e89b-12d3-a456-426614174000
quantity: 50
isActive: true
type: array
items:
$ref: '#/components/schemas/CreateEventAddOnDto'
frequentlyAskedQuestionsIds:
description: Array of frequently asked questions IDs
example: &ref_669
- 123e4567-e89b-12d3-a456-426614174000
type: array
items:
type: string
termsAndConditionsId:
type: string
description: Terms and conditions ID
example: 123e4567-e89b-12d3-a456-426614174000
privacyPolicyId:
type: string
description: Privacy policy ID
example: 123e4567-e89b-12d3-a456-426614174000
isActive:
type: boolean
description: Whether the event is active
example: true
default: true
hybridEnabled:
type: boolean
description: Whether hybrid race participation is enabled for this event.
default: false
hybridConfig:
type: object
description: Structured hybrid-race configuration.
leaderboardPolicy:
type: string
description: >-
Per-event leaderboard policy: RANKED | ALL_FINISHERS_MEDAL |
DEGRADED_MEDAL.
enum: &ref_670
- RANKED
- ALL_FINISHERS_MEDAL
- DEGRADED_MEDAL
medalPolicy:
type: object
description: >-
Medal artwork policy. `useSystemDefault=true` (default) uses the
platform template; Pro-tier partners can set false and supply custom
image URLs.
bibIssueWindow:
type: string
description: >-
Pre-event window in which digital bibs are auto-issued: TEN_DAYS |
SEVEN_DAYS | TWO_DAYS | CUSTOM.
enum: &ref_671
- TEN_DAYS
- SEVEN_DAYS
- TWO_DAYS
- CUSTOM
bibIssueWindowCustomDays:
type: number
description: Custom pre-event window in days when bibIssueWindow=CUSTOM.
courseGpxUrl:
type: string
description: URL of uploaded GPX course file (S3).
elevationProfile:
type: object
description: >-
Elevation profile derived from the course GPX (distance → elevation
sample series).
totalElevationGainM:
type: number
description: Total elevation gain (meters) of the course.
courseDistanceM:
type: number
description: >-
Target distance in metres for virtual/hybrid events. Used by the
athlete app to compute progress percentage. For hybrid events this
is auto-populated when a GPX is uploaded; set it manually here when
there is no GPX. For virtual events this is the distance athletes
must cover to complete the event.
example: 10000
refundPolicy:
description: >-
Structured refund policy tiers (ordered). Existing
`settings.refundPolicy` free-text field is retained.
example: &ref_672
- daysBefore: 30
refundPct: 100
- daysBefore: 7
refundPct: 50
type: array
items:
type: string
sportId:
type: string
description: >-
Primary sport for this event (FK admins_v2.sports.id). Required
going forward for explore/filter/analytics; nullable for backwards
compatibility with pre-49 drafts.
example: 123e4567-e89b-12d3-a456-426614174000
sportIds:
description: >-
Full sport set for multi-discipline events (triathlon, duathlon,
aquabike). For a single-sport event, omit or repeat `sportId`.
example: &ref_673
- 123e4567-e89b-12d3-a456-426614174000
- 123e4567-e89b-12d3-a456-426614174001
type: array
items:
type: string
allowedParticipationModes:
type: array
description: >-
Participation modes this event sells simultaneously. One event can
sell PHYSICAL + HYBRID + VIRTUAL at once (vision §1). If omitted,
the server infers from the legacy `type` scalar for backwards
compatibility.
example: &ref_674
- PHYSICAL
- VIRTUAL
items: &ref_675
type: string
enum:
- PHYSICAL
- HYBRID
- VIRTUAL
- BOTH
virtualWindowStart:
type: string
description: >-
When the virtual-run submission window opens. Required if
`allowedParticipationModes` includes VIRTUAL. Before this moment
virtual activity submissions are rejected with 400.
example: '2026-05-01T00:00:00Z'
virtualWindowEnd:
type: string
description: >-
Soft close of the virtual-run window. New registrations for VIRTUAL
mode are rejected after this instant; already-registered users can
still submit up to `virtualSubmissionDeadline`.
example: '2026-05-07T23:59:59Z'
virtualSubmissionDeadline:
type: string
description: >-
Hard deadline past which the server rejects any virtual activity
submission. Defaults to `virtualWindowEnd` when omitted. Use a later
value to extend a grace window.
example: '2026-05-08T23:59:59Z'
isTestMode:
type: boolean
description: >-
Mark the event as TEST MODE — visible inside the org, surfaces a
TEST MODE badge across operator surfaces. (Sandbox payment routing
is a separate Cashfree-credentials follow-up.)
example: false
certificateEnabled:
type: boolean
description: >-
Enable finisher certificates for this event. Gates the Certificates
page (design + publish) — actual issuance still only fires manually,
after the event is COMPLETED.
example: false
certificateMode:
type: string
description: >-
Certificate rendering mode. COMMON distributes the same artwork;
DYNAMIC personalizes the certificate with participant and result
variables.
enum: &ref_676
- COMMON
- DYNAMIC
default: DYNAMIC
scheduledPublishAt:
type: string
description: >-
Schedule auto-publish: when set in the future and status is DRAFT,
the EventScheduler cron promotes status → PUBLISHED at this instant.
ISO 8601.
example: '2026-06-01T08:00:00Z'
parentEventId:
type: string
description: >-
Optional parent event ID for series / multi-day umbrella linkage.
Each event still owns its own ticketing / refunds — the link only
renders the "part of" badge + the parent's "Linked events" panel.
example: 01957001-0001-4000-8000-000000000020
marketingTags:
type: object
description: >-
Marketing tags / pixels: { metaPixelId, gaMeasurementId,
gtmContainerId, utmDefaults: { source, medium, campaign } }.
required:
- title
- description
- startDateTime
- endDateTime
- type
- location
- coinsDiscountPercentage
- slots
- frequentlyAskedQuestionsIds
- termsAndConditionsId
- privacyPolicyId
UpdateFeaturedEventsDto:
type: object
properties:
eventIds:
description: Array of event IDs to update featured status
example:
- 019985cc-10e2-75f8-cea4-181c6e558eab
- 019985cc-10e2-75f8-cea4-181c6e558eac
type: array
items:
type: string
isFeatured:
type: boolean
description: Set featured status (true to feature, false to unfeature)
default: true
required:
- eventIds
UpdateEventDto:
type: object
properties:
ownerOrganizerId:
type: string
description: >-
Admin-only target organizer. Ignored for non-admin callers and
validated server-side.
desktopVideoUploadKey:
type: string
description: >-
Temporary owned object key returned by POST /v2/events/video-uploads
for the desktop cover video.
desktopVideoCrop:
type: string
description: JSON crop/trim settings for the 16:9 desktop cover video.
promoVideoUploadKey:
type: string
description: >-
Temporary owned object key returned by POST /v2/events/video-uploads
for the mobile cover video.
promoVideoCrop:
type: string
description: JSON crop/trim settings for the 4:5 mobile cover video.
removeDesktopVideo:
type: boolean
description: Remove the saved desktop cover video.
removePromoVideo:
type: boolean
description: Remove the saved mobile cover video.
galleryVideoCrop:
type: string
description: JSON crop/trim settings for the optional 4:5 gallery video.
removeGalleryVideo:
type: boolean
description: Remove the currently saved gallery video.
listingMode:
type: string
enum: *ref_664
default: REPEAK_TICKETING
description: >-
Organizer event publishing model. INFORMATION_ONLY requires an
active Organizer Official Partner agreement.
premiumPageEnabled:
type: boolean
default: true
raceInformation:
type: object
description: Race guide and event-day logistics shown on the premium event page.
eventBadge:
description: Optional participation badge submitted with the event.
allOf:
- $ref: '#/components/schemas/CreateEventBadgeDto'
brandPartners:
description: Optional partners shown on an information-only event page.
type: array
items:
type: string
title:
type: string
description: Title of the event
example: Annual Marathon 2024
maxLength: 250
description:
type: string
description: Description of the event
example: >-
Join us for the most exciting marathon event of the year with
amazing prizes and challenges.
startDateTime:
type: string
description: Start date and time of the event
example: '2024-12-25T09:00:00.000Z'
endDateTime:
type: string
description: End date and time of the event
example: '2024-12-25T17:00:00.000Z'
registrationOpensAt:
type: string
description: >-
When public registration opens. Omit for "open immediately", which
is how every event behaves by default. Subscribers whose plan
includes early access may register a configured number of hours
before this time.
example: '2024-11-01T10:00:00.000Z'
type:
type: string
description: Type of the event
enum: *ref_665
example: in_person
themeColor:
type: string
description: >-
Per-event override for theme color (#RRGGBB). When omitted, cascades
from organizer brand-page default. PRD §44.2.
example: '#FF6B35'
currency:
type: string
description: >-
ISO 4217 currency code for ticket prices. Defaults to INR. Cascades
from organizer brand-page default at creation.
example: INR
organizerLogoUrl:
type: string
description: >-
Per-event override for organizer logo URL. When omitted, cascades
from organizer brand-page default. PRD §44.2.
example: https://cdn.acme.com/logo.png
standardFieldsConfig:
type: object
description: >-
Per-event override for standard-fields config blob. When omitted,
cascades from organizer brand-page default. PRD §44.2.
clubId:
type: string
description: >-
When set, the event is floated on behalf of this club instead of the
calling organizer. The organizer must own the club. Vision §1 —
clubs are first-class event creators.
example: 123e4567-e89b-12d3-a456-426614174000
sponsorId:
type: string
description: >-
When set, the event is floated on behalf of this sponsor brand. The
calling user must have an ACTIVE SponsorAccount for the brand.
Vision §1 — sponsors are first-class event hosts.
example: 123e4567-e89b-12d3-a456-426614174000
eventGeographicRestrictions:
description: >-
Limit who can register by country / city. When openGlobally is true
the lists are ignored. Mostly used for hybrid races.
allOf:
- $ref: '#/components/schemas/EventGeographicRestrictionsDto'
couponApplicableTicket:
description: >-
Array of coupon-ticket mappings specifying which coupons apply to
which tickets
example: *ref_666
type: array
items:
$ref: '#/components/schemas/CouponApplicableTicketDto'
location:
description: Location details of the event
allOf:
- $ref: '#/components/schemas/CreateEventLocationDto'
couponIds:
description: Array of coupon IDs for event discounts
example: *ref_667
type: array
items:
type: string
coinsDiscountPercentage:
type: number
description: Coins discount percentage (0-100 with 2 decimal places)
example: 15.25
minimum: 0
maximum: 100
slots:
description: Event slots with their tickets
type: array
items:
$ref: '#/components/schemas/CreateEventSlotDto'
addOns:
description: Array of add-on products with quantities
example: *ref_668
type: array
items:
$ref: '#/components/schemas/CreateEventAddOnDto'
frequentlyAskedQuestionsIds:
description: Array of frequently asked questions IDs
example: *ref_669
type: array
items:
type: string
termsAndConditionsId:
type: string
description: Terms and conditions ID
example: 123e4567-e89b-12d3-a456-426614174000
privacyPolicyId:
type: string
description: Privacy policy ID
example: 123e4567-e89b-12d3-a456-426614174000
isActive:
type: boolean
description: Whether the event is active
example: true
default: true
hybridEnabled:
type: boolean
description: Whether hybrid race participation is enabled for this event.
default: false
hybridConfig:
type: object
description: Structured hybrid-race configuration.
leaderboardPolicy:
type: string
description: >-
Per-event leaderboard policy: RANKED | ALL_FINISHERS_MEDAL |
DEGRADED_MEDAL.
enum: *ref_670
medalPolicy:
type: object
description: >-
Medal artwork policy. `useSystemDefault=true` (default) uses the
platform template; Pro-tier partners can set false and supply custom
image URLs.
bibIssueWindow:
type: string
description: >-
Pre-event window in which digital bibs are auto-issued: TEN_DAYS |
SEVEN_DAYS | TWO_DAYS | CUSTOM.
enum: *ref_671
bibIssueWindowCustomDays:
type: number
description: Custom pre-event window in days when bibIssueWindow=CUSTOM.
courseGpxUrl:
type: string
description: URL of uploaded GPX course file (S3).
elevationProfile:
type: object
description: >-
Elevation profile derived from the course GPX (distance → elevation
sample series).
totalElevationGainM:
type: number
description: Total elevation gain (meters) of the course.
courseDistanceM:
type: number
description: >-
Target distance in metres for virtual/hybrid events. Used by the
athlete app to compute progress percentage. For hybrid events this
is auto-populated when a GPX is uploaded; set it manually here when
there is no GPX. For virtual events this is the distance athletes
must cover to complete the event.
example: 10000
refundPolicy:
description: >-
Structured refund policy tiers (ordered). Existing
`settings.refundPolicy` free-text field is retained.
example: *ref_672
type: array
items:
type: string
sportId:
type: string
description: >-
Primary sport for this event (FK admins_v2.sports.id). Required
going forward for explore/filter/analytics; nullable for backwards
compatibility with pre-49 drafts.
example: 123e4567-e89b-12d3-a456-426614174000
sportIds:
description: >-
Full sport set for multi-discipline events (triathlon, duathlon,
aquabike). For a single-sport event, omit or repeat `sportId`.
example: *ref_673
type: array
items:
type: string
allowedParticipationModes:
type: array
description: >-
Participation modes this event sells simultaneously. One event can
sell PHYSICAL + HYBRID + VIRTUAL at once (vision §1). If omitted,
the server infers from the legacy `type` scalar for backwards
compatibility.
example: *ref_674
items: *ref_675
virtualWindowStart:
type: string
description: >-
When the virtual-run submission window opens. Required if
`allowedParticipationModes` includes VIRTUAL. Before this moment
virtual activity submissions are rejected with 400.
example: '2026-05-01T00:00:00Z'
virtualWindowEnd:
type: string
description: >-
Soft close of the virtual-run window. New registrations for VIRTUAL
mode are rejected after this instant; already-registered users can
still submit up to `virtualSubmissionDeadline`.
example: '2026-05-07T23:59:59Z'
virtualSubmissionDeadline:
type: string
description: >-
Hard deadline past which the server rejects any virtual activity
submission. Defaults to `virtualWindowEnd` when omitted. Use a later
value to extend a grace window.
example: '2026-05-08T23:59:59Z'
isTestMode:
type: boolean
description: >-
Mark the event as TEST MODE — visible inside the org, surfaces a
TEST MODE badge across operator surfaces. (Sandbox payment routing
is a separate Cashfree-credentials follow-up.)
example: false
certificateEnabled:
type: boolean
description: >-
Enable finisher certificates for this event. Gates the Certificates
page (design + publish) — actual issuance still only fires manually,
after the event is COMPLETED.
example: false
certificateMode:
type: string
description: >-
Certificate rendering mode. COMMON distributes the same artwork;
DYNAMIC personalizes the certificate with participant and result
variables.
enum: *ref_676
default: DYNAMIC
scheduledPublishAt:
type: string
description: >-
Schedule auto-publish: when set in the future and status is DRAFT,
the EventScheduler cron promotes status → PUBLISHED at this instant.
ISO 8601.
example: '2026-06-01T08:00:00Z'
parentEventId:
type: string
description: >-
Optional parent event ID for series / multi-day umbrella linkage.
Each event still owns its own ticketing / refunds — the link only
renders the "part of" badge + the parent's "Linked events" panel.
example: 01957001-0001-4000-8000-000000000020
marketingTags:
type: object
description: >-
Marketing tags / pixels: { metaPixelId, gaMeasurementId,
gtmContainerId, utmDefaults: { source, medium, campaign } }.
SendEventAnnouncementDto:
type: object
properties:
title:
type: string
description: Title of the announcement
example: 'Event Update: New Schedule'
maxLength: 128
content:
type: string
description: Content/body of the announcement
example: >-
Dear participants, we have updated the event schedule. Please check
the new timings.
maxLength: 1024
required:
- title
- content
CancelEventDto:
type: object
properties:
customReason:
type: string
description: >-
Custom reason for cancelling the event (sent to participants in
notification)
example: Event cancelled due to unforeseen circumstances
maxLength: 500
CreateSlotDto:
type: object
properties:
name:
type: string
description: Name of the event slot
example: Morning slot
startDateTime:
type: string
description: Start date time of the event slot in ISO format
example: '2024-12-25T09:00:00.000Z'
endDateTime:
type: string
description: End date time of the event slot in ISO format
example: '2024-12-25T17:00:00.000Z'
eventTickets:
description: Event tickets for this slot (optional)
type: array
items:
$ref: '#/components/schemas/CreateEventTicketDto'
isActive:
type: boolean
description: Whether the event slot is active
example: true
default: true
required:
- name
- startDateTime
- endDateTime
UpdateSlotDto:
type: object
properties:
name:
type: string
description: Name of the event slot
example: Morning slot
startDateTime:
type: string
description: Start date time of the event slot in ISO format
example: '2024-12-25T09:00:00.000Z'
endDateTime:
type: string
description: End date time of the event slot in ISO format
example: '2024-12-25T17:00:00.000Z'
isActive:
type: boolean
description: Whether the event slot is active
example: true
eventTickets:
description: >-
Event tickets for this slot (accepted but managed via the tickets
endpoints)
type: array
items:
$ref: '#/components/schemas/CreateEventTicketDto'
CreateTicketDto:
type: object
properties:
name:
type: string
description: Name of the ticket
description:
type: string
description: Description of the ticket
saleStartDateTime:
type: string
description: Sale start date and time
example: '2024-12-25T09:00:00.000Z'
saleEndDateTime:
type: string
description: Sale end date and time
example: '2024-12-25T17:00:00.000Z'
type:
type: string
enum:
- free
- paid
- donation
default: paid
description: Type of ticket
ticketCategory:
type: string
enum:
- individual
- group
default: individual
description: 'Ticket category: individual or group'
groupSize:
type: number
description: Number of participants per ticket (applicable for group tickets)
default: 1
minimum: 1
minAge:
type: number
description: Minimum age required for this ticket
minimum: 0
maxAge:
type: number
description: Maximum age allowed for this ticket
minimum: 0
minPerBooking:
type: number
description: Minimum tickets per booking
default: 1
maxPerBooking:
type: number
description: Maximum tickets per booking
default: 10
price:
type: number
description: Price of the ticket
minimum: 0
discountedPrice:
type: number
description: Optional discounted price. Empty, null, and zero mean no discount.
minimum: 0
nullable: true
quantity:
type: number
description: Total quantity of tickets available
minimum: 1
isActive:
type: boolean
description: Whether the ticket is active
example: true
default: true
required:
- name
- saleStartDateTime
- saleEndDateTime
- type
- price
- quantity
UpdateTicketDto:
type: object
properties:
name:
type: string
description: Name of the ticket
description:
type: string
description: Description of the ticket
saleStartDateTime:
type: string
description: Sale start date and time
example: '2024-12-25T09:00:00.000Z'
saleEndDateTime:
type: string
description: Sale end date and time
example: '2024-12-25T17:00:00.000Z'
type:
type: string
enum:
- free
- paid
- donation
description: Type of ticket
ticketCategory:
type: string
enum:
- individual
- group
description: 'Ticket category: individual or group'
groupSize:
type: number
description: Number of participants per ticket (applicable for group tickets)
minimum: 1
minAge:
type: number
description: Minimum age required for this ticket
maxAge:
type: number
description: Maximum age allowed for this ticket
minPerBooking:
type: number
description: Minimum tickets per booking
maxPerBooking:
type: number
description: Maximum tickets per booking
price:
type: number
description: Price of the ticket
discountedPrice:
type: number
description: Optional discounted price. Send null or zero to clear a discount.
nullable: true
quantity:
type: number
description: Total quantity of tickets available
isActive:
type: boolean
description: Whether the ticket is active
FormFieldDto:
type: object
properties: {}
CreateFormDto:
type: object
properties:
formType:
type: string
description: Type of form
example: registration
enum:
- registration
- feedback
- survey
showTiming:
type: string
description: When to show the form
enum:
- before_event
- during_event
- after_event
example: before_event
fields:
description: Form fields
type: array
items:
$ref: '#/components/schemas/FormFieldDto'
isActive:
type: boolean
description: Whether the form is active
example: true
default: true
required:
- formType
- showTiming
- fields
UpdateFormDto:
type: object
properties:
formType:
type: string
description: Type of form
example: registration
enum:
- registration
- feedback
- survey
showTiming:
type: string
description: When to show the form
enum:
- before_event
- during_event
- after_event
fields:
description: Form fields
type: array
items:
$ref: '#/components/schemas/FormFieldDto'
isActive:
type: boolean
description: Whether the form is active
CreateEventWaiverDto:
type: object
properties:
name:
type: string
description: Waiver name
example: Liability Waiver
htmlContent:
type: string
description: >-
HTML with {{key}} placeholders. Every {{key}} must be a registration
form field name (see GET .../waiver/available-variables).
headerLogo:
type: string
description: Header logo URL for the rendered PDF
footerText:
type: string
description: Footer text for the rendered PDF
cssStyles:
type: string
description: CSS applied to the waiver HTML
requireAcceptance:
type: boolean
description: Block registration until the participant accepts.
default: true
acceptanceLabel:
type: string
description: Acceptance checkbox label shown at registration.
example: I have read and accept the liability waiver
required:
- name
- htmlContent
UpdateEventWaiverDto:
type: object
properties:
name:
type: string
description: Waiver name
example: Liability Waiver
htmlContent:
type: string
description: >-
HTML with {{key}} placeholders. Every {{key}} must be a registration
form field name (see GET .../waiver/available-variables).
headerLogo:
type: string
description: Header logo URL for the rendered PDF
footerText:
type: string
description: Footer text for the rendered PDF
cssStyles:
type: string
description: CSS applied to the waiver HTML
requireAcceptance:
type: boolean
description: Block registration until the participant accepts.
default: true
acceptanceLabel:
type: string
description: Acceptance checkbox label shown at registration.
example: I have read and accept the liability waiver
CreateEventCertificateDto:
type: object
properties:
name:
type: string
description: Certificate name
example: Finisher Certificate
htmlContent:
type: string
description: >-
HTML with {{key}} placeholders. Every {{key}} must be an available
variable (see GET .../certificates/variables).
headerLogo:
type: string
description: Header logo URL for the rendered PDF
footerText:
type: string
description: Footer text for the rendered PDF
cssStyles:
type: string
description: CSS applied to the certificate HTML
backgroundImageUrl:
type: string
description: >-
Full-bleed background design (the organizer-designed certificate
art) the dynamic text fields render on top of.
orientation:
type: string
description: Page orientation for the rendered PDF.
enum: &ref_677
- portrait
- landscape
default: landscape
required:
- name
- htmlContent
UpdateEventCertificateDto:
type: object
properties:
name:
type: string
description: Certificate name
example: Finisher Certificate
htmlContent:
type: string
description: >-
HTML with {{key}} placeholders. Every {{key}} must be an available
variable (see GET .../certificates/variables).
headerLogo:
type: string
description: Header logo URL for the rendered PDF
footerText:
type: string
description: Footer text for the rendered PDF
cssStyles:
type: string
description: CSS applied to the certificate HTML
backgroundImageUrl:
type: string
description: >-
Full-bleed background design (the organizer-designed certificate
art) the dynamic text fields render on top of.
orientation:
type: string
description: Page orientation for the rendered PDF.
enum: *ref_677
default: landscape
CreateAddOnDto:
type: object
properties:
productId:
type: string
description: Product ID for the add-on
example: 123e4567-e89b-12d3-a456-426614174000
quantity:
type: number
description: Quantity available for this add-on
example: 100
minimum: 0
default: 0
isActive:
type: boolean
description: Whether the add-on is active
example: true
default: true
required:
- productId
UpdateAddOnDto:
type: object
properties:
quantity:
type: number
description: Quantity available for this add-on
example: 100
minimum: 0
isActive:
type: boolean
description: Whether the add-on is active
example: true
AttachCouponDto:
type: object
properties:
couponId:
type: string
description: Coupon ID to attach to the event
example: 123e4567-e89b-12d3-a456-426614174000
ticketIds:
description: >-
List of ticket IDs this coupon applies to. If not provided, coupon
applies to all tickets.
example:
- 123e4567-e89b-12d3-a456-426614174000
type: array
items:
type: string
required:
- couponId
UpdateCouponTicketsDto:
type: object
properties:
ticketIds:
description: List of ticket IDs this coupon applies to
example:
- 123e4567-e89b-12d3-a456-426614174000
type: array
items:
type: string
required:
- ticketIds
AttachFaqDto:
type: object
properties:
faqId:
type: string
description: FAQ ID to attach to the event
example: 123e4567-e89b-12d3-a456-426614174000
required:
- faqId
AttachMultipleFaqsDto:
type: object
properties:
faqIds:
description: List of FAQ IDs to attach to the event
example:
- 123e4567-e89b-12d3-a456-426614174000
type: array
items:
type: string
required:
- faqIds
CancelWholeBookingDto:
type: object
properties:
reason:
type: string
description: Reason for canceling the entire booking
enum:
- ORGANIZER_CANCELLATION
- EVENT_CANCELLED
- SLOT_CANCELLED
- TICKET_CANCELLED
- CAPACITY_REDUCED
- PARTICIPANT_MISCONDUCT
- DUPLICATE_BOOKING
- PAYMENT_ISSUE
- ORGANIZER_OTHER
example: ORGANIZER_CANCELLATION
customReason:
type: string
description: >-
Custom reason for cancellation (required if reason is
ORGANIZER_OTHER)
example: Event has been rescheduled
maxLength: 500
required:
- reason
BulkCancelParticipantsDto:
type: object
properties:
participationIds:
description: Array of participation (booking) IDs to cancel.
example:
- uuid-1
- uuid-2
type: array
items:
type: string
reason:
type: string
description: >-
Shared reason that auto-fills every cancellation. Per-row overrides
via `overrides` take precedence.
enum:
- ORGANIZER_CANCELLATION
- EVENT_CANCELLED
- SLOT_CANCELLED
- TICKET_CANCELLED
- CAPACITY_REDUCED
- PARTICIPANT_MISCONDUCT
- DUPLICATE_BOOKING
- PAYMENT_ISSUE
- ORGANIZER_OTHER
example: ORGANIZER_CANCELLATION
customReason:
type: string
description: >-
Custom reason that accompanies the shared reason. Visible to
athletes.
maxLength: 500
overrides:
type: object
description: >-
Per-participation reason overrides. Keys are participation IDs;
values mirror {reason, customReason}.
example:
uuid-1:
reason: PARTICIPANT_MISCONDUCT
customReason: DQ ruling on hybrid leg
required:
- participationIds
- reason
CancelParticipantDto:
type: object
properties:
reason:
type: string
description: Reason for canceling the participant booking
enum:
- ORGANIZER_CANCELLATION
- TICKET_CANCELLED
- CAPACITY_REDUCED
- PARTICIPANT_MISCONDUCT
- DUPLICATE_BOOKING
- PAYMENT_ISSUE
- ORGANIZER_OTHER
example: ORGANIZER_CANCELLATION
customReason:
type: string
description: >-
Custom reason for cancellation (required if reason is
ORGANIZER_OTHER)
example: Participant violated event guidelines
maxLength: 500
required:
- reason
UpdateParticipantDetailsDto:
type: object
properties:
formFields:
type: string
description: Updated form fields JSON for the participant
example: >-
[{"label":"Full
Name","name":"full_name","type":"text","values":"John Doe"}]
bibNumber:
type: string
description: >-
Bib number for this participant. Pass an empty string or null to
clear.
example: A101
maxLength: 50
nullable: true
ToggleBookingCheckInDto:
type: object
properties:
isCheckedIn:
type: boolean
description: Target check-in state for every active participant in the booking.
example: true
required:
- isCheckedIn
CreateCourseWaypointDto:
type: object
properties:
type:
type: string
enum: &ref_678
- START
- FINISH
- WATER_STOP
- AID_STATION
- TOILET
- VIEWING_AREA
- LANDMARK
description: PRD §33.1 step 5 waypoint taxonomy.
name:
type: string
maxLength: 120
latitude:
type: number
description: WGS-84 latitude.
longitude:
type: number
description: WGS-84 longitude.
distanceFromStartM:
type: number
description: Cumulative metres along the GPX track from start.
sequenceIndex:
type: number
description: Render order on the partner UI. Defaults to 0.
notes:
type: string
required:
- type
- latitude
- longitude
UpdateCourseWaypointDto:
type: object
properties:
type:
type: string
enum: *ref_678
description: PRD §33.1 step 5 waypoint taxonomy.
name:
type: string
maxLength: 120
latitude:
type: number
description: WGS-84 latitude.
longitude:
type: number
description: WGS-84 longitude.
distanceFromStartM:
type: number
description: Cumulative metres along the GPX track from start.
sequenceIndex:
type: number
description: Render order on the partner UI. Defaults to 0.
notes:
type: string
CreateEventCommunicationTemplateDto:
type: object
properties:
trigger:
type: string
enum: &ref_679
- REGISTRATION_CONFIRMATION
- REMINDER_T_MINUS_7_DAYS
- REMINDER_T_MINUS_3_DAYS
- REMINDER_T_MINUS_1_DAY
- RACE_DAY
- POST_RACE_THANK_YOU
- POST_RACE_RESULTS
- POST_RACE_PHOTOS
- POST_RACE_SURVEY
description: Lifecycle moment that fires this template.
channel:
type: string
enum: &ref_680
- EMAIL
- SMS
- PUSH
description: Channel — EMAIL / SMS / PUSH.
subject:
type: string
maxLength: 200
description: Required for EMAIL, ignored for SMS/PUSH.
body:
type: string
description: >-
Template body. Use {{variable}} placeholders (athleteName,
eventTitle, startDate, bibNumber, ...).
scheduleOffsetMinutes:
type: number
description: >-
Minutes relative to trigger anchor (negative = before, positive =
after). Ignored for REGISTRATION_CONFIRMATION.
enabled:
type: boolean
required:
- trigger
- channel
- body
UpdateEventCommunicationTemplateDto:
type: object
properties:
trigger:
type: string
enum: *ref_679
description: Lifecycle moment that fires this template.
channel:
type: string
enum: *ref_680
description: Channel — EMAIL / SMS / PUSH.
subject:
type: string
maxLength: 200
description: Required for EMAIL, ignored for SMS/PUSH.
body:
type: string
description: >-
Template body. Use {{variable}} placeholders (athleteName,
eventTitle, startDate, bibNumber, ...).
scheduleOffsetMinutes:
type: number
description: >-
Minutes relative to trigger anchor (negative = before, positive =
after). Ignored for REGISTRATION_CONFIRMATION.
enabled:
type: boolean
PreviewCommunicationTemplateDto:
type: object
properties:
context:
type: object
description: >-
Optional template-render context. Variables not present here resolve
to empty string.
CreateBundleFromEventDto:
type: object
properties: {}
ApplyBundleDto:
type: object
properties: {}
PremiumEventImportPreviewDto:
type: object
properties: {}
PremiumEventImportCommitDto:
type: object
properties: {}
UpdateAppVersionPolicyDto:
type: object
properties:
minSupportedVersion:
type: string
example: 1.2.0
description: Floor; below this = force.
latestVersion:
type: string
example: 1.4.0
description: Latest shipping version.
storeUrl:
type: string
description: Per-platform store URL. Null/empty clears it.
releaseNotes:
type: string
description: Soft-prompt release notes.
forceMessage:
type: string
description: Hard-block copy override.
maintenanceEnabled:
type: boolean
description: Temporarily block this platform.
maintenanceMessage:
type: string
description: Copy shown while maintenance is active.
required:
- minSupportedVersion
- latestVersion
UpdateProfileDto:
type: object
properties:
name:
type: string
email:
type: string
tshirtSize:
type: string
skills:
type: array
items:
type: string
RespondDto:
type: object
properties:
accept:
type: boolean
reason:
type: string
required:
- accept
CreateVolunteerDto:
type: object
properties:
name:
type: string
phone:
type: string
email:
type: string
role:
type: string
headId:
type: string
tshirtSize:
type: string
required:
- phone
- role
InviteMemberDto:
type: object
properties:
name:
type: string
phone:
type: string
email:
type: string
role:
type: string
tshirtSize:
type: string
required:
- role
RateDto:
type: object
properties:
stars:
type: number
tags:
type: array
items:
type: string
required:
- stars
CrewLifecycleReasonDto:
type: object
properties:
reason:
type: string
maxLength: 500
CreateVolunteerHeadDto:
type: object
properties:
name:
type: string
phone:
type: string
email:
type: string
tshirtSize:
type: string
required:
- phone
SetHeadDto:
type: object
properties:
headId:
type: string
nullable: true
CreateAssignmentDto:
type: object
properties:
volunteerId:
type: string
crewMemberId:
type: string
roleForEvent:
type: string
shiftId:
type: string
mode:
type: string
enum:
- invite
- direct
required:
- roleForEvent
AttendanceCheckInDto:
type: object
properties:
eventId:
type: string
lat:
type: number
lng:
type: number
clientActionId:
type: string
localTimestamp:
type: string
selfieBase64:
type: string
required:
- eventId
- clientActionId
AttendanceCheckOutDto:
type: object
properties:
sessionId:
type: string
lat:
type: number
lng:
type: number
clientActionId:
type: string
localTimestamp:
type: string
required:
- sessionId
SyncBatchDto:
type: object
properties:
actions:
type: array
items:
type: object
required:
- actions
CreateItemTypeDto:
type: object
properties:
name:
type: string
category:
type: string
requiresSize:
type: boolean
tracksInventory:
type: boolean
totalStock:
type: number
window:
type: string
required:
- name
HandoutDto:
type: object
properties:
itemTypeId:
type: string
eventParticipantId:
type: string
quantity:
type: number
sizeGiven:
type: string
clientActionId:
type: string
required:
- itemTypeId
- eventParticipantId
- clientActionId
CrewSendOtpDto:
type: object
properties:
phoneNumber:
type: string
required:
- phoneNumber
CrewVerifyOtpDto:
type: object
properties:
phoneNumber:
type: string
otp:
type: string
required:
- phoneNumber
- otp
SendCrewEmailOtpDto:
type: object
properties:
email:
type: string
description: Email address to send the 4-digit crew login code to.
required:
- email
VerifyCrewEmailOtpDto:
type: object
properties:
email:
type: string
description: Email address to send the 4-digit crew login code to.
otp:
type: string
description: The 4-digit code emailed to the address.
required:
- email
- otp
RegisterPushTokenDto:
type: object
properties: {}
TestPushDto:
type: object
properties: {}
CreateCrewJoinCodeDto:
type: object
properties: {}
UpdateCrewJoinCodeDto:
type: object
properties: {}
CrewJoinCodeInputDto:
type: object
properties: {}
UpdateBadgeDto:
type: object
properties:
name:
type: string
description: Badge name
example: First Finish
description:
type: string
description: Badge description
example: Attend your first event
iconUrl:
type: string
description: Icon URL
color:
type: string
description: Hex color
example: '#FF5733'
sourceSystem:
type: string
description: Source system
enum: *ref_681
example: event
activityTypeFilter:
type: string
description: Activity type filter
enum: *ref_682
rarity:
type: string
description: Rarity tier
enum: *ref_683
example: bronze
points:
type: number
description: Points value
example: 50
conditions:
description: Conditions array
type: array
items:
$ref: '#/components/schemas/BadgeConditionDto'
conditionLogic:
type: string
description: Condition logic (AND/OR)
enum: *ref_684
default: AND
isHidden:
type: boolean
description: Hidden until earned?
default: false
isRepeatable:
type: boolean
description: Can badge be earned multiple times?
default: false
repeatCooldownDays:
type: number
description: Cooldown days for repeatable badges
isTimeLimited:
type: boolean
description: Is time-limited?
default: false
availableFrom:
format: date-time
type: string
description: Available from date
availableUntil:
format: date-time
type: string
description: Available until date
mappedChallengeId:
type: string
description: Mapped challenge ID
isActive:
type: boolean
description: Is badge active?
default: true
CreateGearDto:
type: object
properties:
userId:
type: string
description: ID of the user who has the gear
example: 23rdwd-23ews3-3wrds-4ewdsf
typeId:
type: string
description: ID of the type of gear
example: 23ews3-3wrds-4ewdsf-23rdwd
sportId:
type: string
description: ID of the default sport for the Gear
example: 4ewdsf-23rdwd-23ews3-3wrds
brand:
type: string
description: Brand of the Gear
example: Adidas
model:
type: string
description: Model of the Gear
example: Adidas Ultraboost
weight:
type: number
description: Weight of the Gear
example: 180
isActive:
type: boolean
description: Indicates if the gear is active or not!
example: true
required:
- userId
- typeId
- sportId
- brand
- model
- weight
UpdateGearDto:
type: object
properties:
userId:
type: string
description: ID of the user who has the gear
example: 23rdwd-23ews3-3wrds-4ewdsf
typeId:
type: string
description: ID of the type of gear
example: 23ews3-3wrds-4ewdsf-23rdwd
sportId:
type: string
description: ID of the default sport for the Gear
example: 4ewdsf-23rdwd-23ews3-3wrds
brand:
type: string
description: Brand of the Gear
example: Adidas
model:
type: string
description: Model of the Gear
example: Adidas Ultraboost
weight:
type: number
description: Weight of the Gear
example: 180
isActive:
type: boolean
description: Indicates if the gear is active or not!
example: true
CreateScheduleDto:
type: object
properties:
name:
type: string
description: Name of the schedule
maxLength: 100
sportId:
type: string
description: UUID of the sport
scheduledAt:
type: string
description: Scheduled date and time in ISO format
isCompleted:
type: boolean
description: Status indicating if the schedule is completed
userId:
type: string
description: UUID of the user
isActive:
type: boolean
description: Status indicating if the schedule is active
required:
- name
- sportId
- scheduledAt
- userId
UpdateScheduleDto:
type: object
properties:
name:
type: string
description: Name of the schedule
maxLength: 100
sportId:
type: string
description: UUID of the sport
scheduledAt:
type: string
description: Scheduled date and time in ISO format
isCompleted:
type: boolean
description: Status indicating if the schedule is completed
userId:
type: string
description: UUID of the user
isActive:
type: boolean
description: Status indicating if the schedule is active
CreateActivityDto:
type: object
properties:
userId:
type: string
description: ID of the user associated with the activity
polyline:
type: string
description: Encoded Polyline Algorithm Format
example: _p~iF~ps|U_ulLnnqC_mqNvxq`@
sportId:
type: string
description: ID of the sport associated with the activity
completedAt:
type: object
description: Date and time when the activity was completed
example: '2024-02-10T10:00:00'
distanceInMeters:
type: number
description: Distance covered in meters
example: 5250
durationInSeconds:
type: number
description: Duration of the activity in seconds
example: 3600
stepsCount:
type: number
description: Number of steps taken during the activity
example: 8000
statistics:
type: string
description: Activity statistics in JSON format
example: '{"calories": 500, "avgPace": 6.2}'
name:
type: string
description: Name of the activity
example: Morning Run
description:
type: string
description: Description of the activity
example: A refreshing morning jog
mapType:
type: string
description: Type of map used
enum: &ref_685
- standard
- satelite
- hybrid
example: standard
gearId:
type: string
description: ID of the gear associated with the activity
hideStatistics:
type: string
description: Whether statistics should be hidden like calories or avgPace
example: calories
exertion:
type: string
description: Exertion level of the activity
enum: &ref_686
- easy
- moderate
- max_effort
example: moderate
elevationGain:
type: number
description: Cumulative uphill elevation climbed in meters
example: 312
elevationLoss:
type: number
description: Cumulative downhill elevation descended in meters
example: 298
isActive:
type: boolean
description: Indicates if the activity is active or not!
example: true
validationStatus:
type: string
description: Validation status (anti-cheat pipeline output).
enum: &ref_687
- VALID
- PENDING
- FLAGGED
- REJECTED
privacy:
type: string
description: Privacy scope for social surfaces.
enum: &ref_688
- PUBLIC
- FOLLOWERS
- PRIVATE
splits:
description: >-
Per-km splits produced by the tracker. `elevationGainM` /
`elevationLossM` are optional and omitted when the device reported
no altitude.
example: &ref_689
- km: 1
timeSeconds: 330
paceSecPerKm: 330
elevationGainM: 4.2
type: array
items:
type: string
source:
type: string
description: Source system that produced the activity.
enum: &ref_690
- REPEAK
- EXTERNAL_SYNC
- MANUAL
deviceSource:
type: string
description: Device identifier / user-agent.
externalId:
type: string
description: External system activity id (e.g. Strava activity id).
challengeId:
type: string
description: Linked challenge id.
eventRegistrationId:
type: string
description: Linked event registration id.
hybridRaceResultId:
type: string
description: Linked hybrid race result id.
validationMetadata:
type: object
description: Validation metadata (ML scores, reasons, etc.).
required:
- userId
- polyline
- sportId
- completedAt
- distanceInMeters
- durationInSeconds
- stepsCount
- statistics
- name
- description
- mapType
- hideStatistics
- exertion
UpdateActivityDto:
type: object
properties:
userId:
type: string
description: ID of the user associated with the activity
polyline:
type: string
description: Encoded Polyline Algorithm Format
example: _p~iF~ps|U_ulLnnqC_mqNvxq`@
sportId:
type: string
description: ID of the sport associated with the activity
completedAt:
type: object
description: Date and time when the activity was completed
example: '2024-02-10T10:00:00'
distanceInMeters:
type: number
description: Distance covered in meters
example: 5250
durationInSeconds:
type: number
description: Duration of the activity in seconds
example: 3600
stepsCount:
type: number
description: Number of steps taken during the activity
example: 8000
statistics:
type: string
description: Activity statistics in JSON format
example: '{"calories": 500, "avgPace": 6.2}'
name:
type: string
description: Name of the activity
example: Morning Run
description:
type: string
description: Description of the activity
example: A refreshing morning jog
mapType:
type: string
description: Type of map used
enum: *ref_685
example: standard
gearId:
type: string
description: ID of the gear associated with the activity
hideStatistics:
type: string
description: Whether statistics should be hidden like calories or avgPace
example: calories
exertion:
type: string
description: Exertion level of the activity
enum: *ref_686
example: moderate
elevationGain:
type: number
description: Cumulative uphill elevation climbed in meters
example: 312
elevationLoss:
type: number
description: Cumulative downhill elevation descended in meters
example: 298
isActive:
type: boolean
description: Indicates if the activity is active or not!
example: true
validationStatus:
type: string
description: Validation status (anti-cheat pipeline output).
enum: *ref_687
privacy:
type: string
description: Privacy scope for social surfaces.
enum: *ref_688
splits:
description: >-
Per-km splits produced by the tracker. `elevationGainM` /
`elevationLossM` are optional and omitted when the device reported
no altitude.
example: *ref_689
type: array
items:
type: string
source:
type: string
description: Source system that produced the activity.
enum: *ref_690
deviceSource:
type: string
description: Device identifier / user-agent.
externalId:
type: string
description: External system activity id (e.g. Strava activity id).
challengeId:
type: string
description: Linked challenge id.
eventRegistrationId:
type: string
description: Linked event registration id.
hybridRaceResultId:
type: string
description: Linked hybrid race result id.
validationMetadata:
type: object
description: Validation metadata (ML scores, reasons, etc.).
UserParticipateInChallengeDto:
type: object
properties:
rcDiscount:
type: number
description: >-
Repeak Coins to apply against the entry fee. Cannot exceed the entry
fee. Cannot be applied to a free challenge.
example: 50
minimum: 0
VerifyChallengePaymentDto:
type: object
properties:
orderId:
type: string
description: >-
The Cashfree order id returned to the app on join / echoed back by
the SDK on payment success.
example: order_104992653GnpgEiOCSgUBccUBR0IBCDczQQ
required:
- orderId
CreateEventParticipantDto:
type: object
properties:
ticketId:
type: string
description: Event Ticket ID
example: 123e4567-e89b-12d3-a456-426614174000
formId:
type: string
description: Form ID
example: 123e4567-e89b-12d3-a456-426614174000
formFields:
type: string
description: Form fields
example: >-
[{"label":"Name","name":"name","type":"text","multiple":false,"required":true,"values":"John
Doe"},
{"label":"Interests","name":"interests","type":"text","multiple":true,"required":true,"values":["Sports",
"Reading", "Traveling"]}]
bibNumber:
type: string
description: Bib number for this participant.
tshirtSize:
type: string
description: T-shirt size for this participant.
enum:
- XS
- S
- M
- L
- XL
- XXL
- XXXL
emergencyContact:
type: object
description: Emergency contact details.
example:
name: Jane Doe
phone: '+919999999999'
relation: Spouse
medicalInfo:
type: object
description: >-
Per-participant medical info. Encrypted at rest; public surfaces
never echo it.
example:
medicalConditions:
- Asthma
allergies:
- Peanuts
bloodGroup: O+
medications: Inhaler PRN
notes: Carry inhaler in race-belt.
waiverAccepted:
type: boolean
description: >-
Participant has accepted the event waiver. Required when the event
has a mandatory waiver.
example: true
required:
- ticketId
- formId
- formFields
PreviewEventParticipationDto:
type: object
properties:
eventId:
type: string
description: Event ID
example: 123e4567-e89b-12d3-a456-426614174000
slotId:
type: string
description: Slot ID
example: 123e4567-e89b-12d3-a456-426614174000
participants:
type: array
items:
$ref: '#/components/schemas/CreateEventParticipantDto'
description: Array of event participants
coinsUsed:
type: number
description: 'Coins used by the user (optional, default: 0)'
example: 50
couponIds:
description: Array of coupon IDs applied by the user
example:
- 2f3e1b40-7fc3-4b0c-8f7a-b6bbee924e1f
- 4c3fbb3e-ded0-4e0d-b420-e4185b2f8799
type: array
items:
type: string
addOns:
description: Array of add-ons IDs applied by the user
example:
- addOnId: 2f3e1b40-7fc3-4b0c-8f7a-b6bbee924e1f
quantity: 2
- addOnId: 4c3fbb3e-ded0-4e0d-b420-e4185b2f8799
quantity: 1
type: array
items:
type: string
required:
- eventId
- slotId
- participants
CreateEventParticipationDto:
type: object
properties:
eventId:
type: string
description: Event ID
example: 123e4567-e89b-12d3-a456-426614174000
slotId:
type: string
description: Slot ID
example: 123e4567-e89b-12d3-a456-426614174000
participants:
type: array
items:
$ref: '#/components/schemas/CreateEventParticipantDto'
description: Array of event participants
amountPaid:
type: number
description: Amount paid by the user (must match server-calculated total)
example: 199.99
coinsUsed:
type: number
description: 'Coins used by the user (optional, default: 0)'
example: 50
couponIds:
description: Array of coupon IDs applied by the user
example:
- 2f3e1b40-7fc3-4b0c-8f7a-b6bbee924e1f
- 4c3fbb3e-ded0-4e0d-b420-e4185b2f8799
type: array
items:
type: string
addOns:
description: Array of add-ons IDs applied by the user
example:
- addOnId: 2f3e1b40-7fc3-4b0c-8f7a-b6bbee924e1f
quantity: 2
- addOnId: 4c3fbb3e-ded0-4e0d-b420-e4185b2f8799
quantity: 1
type: array
items:
type: string
provider:
type: string
description: Payment Provider of the payment (e.g. cashfree, eazr)
enum:
- cashfree
- eazr
- no_provider
default: cashfree
registrationType:
type: string
description: >-
Registration type (PHYSICAL, HYBRID, VIRTUAL, or BOTH). VIRTUAL is
only selectable on events whose allowedParticipationModes include
VIRTUAL; the server rejects with 400 otherwise.
enum:
- PHYSICAL
- HYBRID
- VIRTUAL
- BOTH
default: PHYSICAL
required:
- eventId
- slotId
- participants
- amountPaid
- provider
UploadFormFileDto:
type: object
properties:
fieldName:
type: string
description: >-
The `name` of the file-type field on the registration form this
upload answers (matches FormField.name).
example: government_id_proof
formId:
type: string
description: >-
The registration form id. Optional — when omitted the active form
with formType='registration' for the event is used.
format: uuid
required:
- fieldName
VerifyEventParticipationDto:
type: object
properties:
requestId:
type: string
description: >-
Id of the order in case of cashfree or Id of the payment in case of
eazr pay later
provider:
type: string
enum:
- cashfree
- eazr
- no_provider
description: Provider of the payment (e.g. cashfree, eazr)
required:
- requestId
- provider
CancelEventParticipationDto:
type: object
properties:
reason:
type: string
description: Predefined reason for canceling the event participation
enum:
- USER_CANCELLATION
- SCHEDULE_CONFLICT
- PERSONAL_EMERGENCY
- ILLNESS
- TRAVEL_ISSUES
- FINANCIAL_REASONS
- NO_LONGER_INTERESTED
- FOUND_ALTERNATIVE
- WRONG_BOOKING
- CHANGED_MIND
- OTHER
- ORGANIZER_CANCELLATION
- EVENT_CANCELLED
- TICKET_CANCELLED
- SLOT_CANCELLED
- CAPACITY_REDUCED
- PARTICIPANT_MISCONDUCT
- DUPLICATE_BOOKING
- PAYMENT_ISSUE
- ORGANIZER_OTHER
example: CHANGED_MIND
customReason:
type: string
description: Custom reason for canceling the event participation
example: Unable to attend due to personal reasons
maxLength: 500
TestCheckInDto:
type: object
properties:
participantIds:
description: Array of participant IDs to check-in/check-out
example:
- 0199800c-02fa-61f3-3655-3c5299c10e87
- 01998026-4d78-005c-4825-9884fb6d1183
type: array
items:
type: string
checkIn:
type: boolean
description: Check-in (true) or check-out (false)
default: true
required:
- participantIds
CreateReviewDto:
type: object
properties:
reviewAbout:
type: string
description: What the review is about (challenge or event)
enum: &ref_691
- challenge
- event
example: challenge
reviewAboutId:
type: string
description: ID of the challenge or event being reviewed
example: 550e8400-e29b-41d4-a716-446655440000
rating:
type: number
description: Rating from 1 to 5 stars
example: 5
minimum: 1
maximum: 5
comment:
type: string
description: Optional comment/feedback text
example: Great challenge! Really enjoyed participating.
required:
- reviewAbout
- reviewAboutId
- rating
UpdateReviewDto:
type: object
properties:
reviewAbout:
type: string
description: What the review is about (challenge or event)
enum: *ref_691
example: challenge
reviewAboutId:
type: string
description: ID of the challenge or event being reviewed
example: 550e8400-e29b-41d4-a716-446655440000
rating:
type: number
description: Rating from 1 to 5 stars
example: 5
minimum: 1
maximum: 5
comment:
type: string
description: Optional comment/feedback text
example: Great challenge! Really enjoyed participating.
GenerateTrainingPlanDto:
type: object
properties:
eventId:
type: string
description: Event ID (if registering for RaceAbove event)
example: 123e4567-e89b-12d3-a456-426614174000
eventName:
type: string
description: Event name
example: Mumbai Marathon 2025
eventDescription:
type: string
description: Event description for better AI context
example: Annual marathon event covering scenic routes through Mumbai
eventDate:
type: string
description: Event date (YYYY-MM-DD)
example: '2025-09-30'
planStartDate:
type: string
description: >-
Date when the training plan should start (YYYY-MM-DD). Defaults to
today if not provided.
example: '2025-09-01'
sportType:
type: string
description: >-
Sport type for the training plan (defaults to RUNNING if not
provided)
enum:
- running
- cycling
- swimming
- triathlon
- hiking_trekking
example: running
eventSubType:
type: string
description: Specific event sub-type (e.g., marathon, road_cycling, sprint)
example: half_marathon
duration:
type: string
description: Training plan duration
enum:
- 2_weeks
- 4_weeks
- 8_weeks
example: 4_weeks
eventType:
type: string
description: '[DEPRECATED] Type of event - use sportType and eventSubType instead'
enum:
- 5K
- 10K
- Half Marathon
- Marathon
example: Half Marathon
deprecated: true
eventDistanceKm:
type: number
description: >-
Event distance in kilometers (fetched from event details if not
provided)
example: 21.1
terrain:
type: string
description: Event terrain type
enum:
- Road
- Trail
- Mixed
- Mountain
- Indoor
- Open Water
- Pool
example: Road
goalType:
type: string
description: Goal type for the event (defaults to FINISH if not provided)
enum:
- Finish
- Time Goal
- Personal Best
example: Finish
targetTime:
type: string
description: Target finish time (HH:MM:SS format)
example: '02:30:00'
preferredDays:
type: string
description: Preferred training days (comma-separated or "Flexible")
example: Mon,Wed,Fri,Sat
injuryHistory:
type: string
description: Injury history
example: Knee pain in 2023
foodPreference:
type: string
description: Food preference for nutrition plan (veg/non_veg/vegan)
enum:
- veg
- non_veg
- vegan
example: veg
workoutTimePreference:
type: string
description: Preferred workout time of day
enum:
- early_morning
- morning
- afternoon
- evening
- night
- flexible
example: morning
required:
- eventName
- eventDate
- duration
WeeklySummaryDto:
type: object
properties:
weekNumber:
type: number
weekStartDate:
type: string
weekEndDate:
type: string
totalDistanceKm:
type: number
totalRuns:
type: number
weekFocus:
type: string
isRecoveryWeek:
type: boolean
required:
- weekNumber
- weekStartDate
- weekEndDate
- totalDistanceKm
- totalRuns
- weekFocus
- isRecoveryWeek
CoachNotesDto:
type: object
properties:
planOverview:
type: string
keyWorkouts:
type: array
items:
type: string
injuryPreventionTips:
type: array
items:
type: string
nutritionReminders:
type: array
items:
type: string
raceDayAdvice:
type: string
required:
- planOverview
- keyWorkouts
- injuryPreventionTips
- nutritionReminders
- raceDayAdvice
DailyWorkoutResponseDto:
type: object
properties:
dayNumber:
type: number
date:
type: string
dayOfWeek:
type: string
weekNumber:
type: number
workoutType:
type: string
isRestDay:
type: boolean
distanceKm:
type: number
durationMinutes:
type: number
targetPace:
type: string
intensity:
type: string
heartRateZone:
type: string
workoutDescription:
type: string
warmup:
type: string
cooldown:
type: string
notes:
type: string
alternatives:
type: string
completionStatus:
type: string
required:
- dayNumber
- date
- dayOfWeek
- weekNumber
- workoutType
- isRestDay
- distanceKm
- durationMinutes
- targetPace
- intensity
- heartRateZone
- workoutDescription
- warmup
- cooldown
- notes
- alternatives
- completionStatus
TrainingPlanResponseDto:
type: object
properties:
id:
type: string
userId:
type: string
eventName:
type: string
eventDate:
type: string
status:
type: string
totalDays:
type: number
totalWeeks:
type: number
difficultyLevel:
type: string
weeklyPeakKm:
type: number
taperStartsDay:
type: number
weeklySummary:
type: array
items:
$ref: '#/components/schemas/WeeklySummaryDto'
coachNotes:
$ref: '#/components/schemas/CoachNotesDto'
dailyWorkouts:
type: array
items:
$ref: '#/components/schemas/DailyWorkoutResponseDto'
createdAt:
format: date-time
type: string
updatedAt:
format: date-time
type: string
required:
- id
- userId
- eventName
- eventDate
- status
- totalDays
- totalWeeks
- difficultyLevel
- weeklyPeakKm
- taperStartsDay
- weeklySummary
- coachNotes
- dailyWorkouts
- createdAt
- updatedAt
MatchActivityDto:
type: object
properties:
activityId:
type: string
description: Activity ID from the activities table
example: 01JFXXX...
activityDate:
type: string
description: Activity date (YYYY-MM-DD)
example: '2025-07-09'
activityType:
type: string
description: Type of activity
example: Run
distanceKm:
type: number
description: Distance in kilometers
example: 5.2
durationMinutes:
type: number
description: Duration in minutes
example: 35
avgPace:
type: string
description: Average pace (min/km format)
example: 6:45 min/km
avgHeartRate:
type: number
description: Average heart rate in BPM
example: 145
elevationGainM:
type: number
description: Elevation gain in meters
example: 120
userNotes:
type: string
description: User notes about the activity
example: Felt great today, easy pace
required:
- activityId
- activityDate
- activityType
- distanceKm
- durationMinutes
- avgPace
MatchResultResponseDto:
type: object
properties:
status:
type: string
description: Match status
enum:
- Completed
- Partial
- Exceeded
- Missed
- Wrong Workout Type
- Rest Day Activity
example: Completed
matchConfidence:
type: number
description: Match confidence percentage (0-100)
example: 95
distanceCompletionPercentage:
type: number
description: Distance completion percentage
example: 104
paceVsTarget:
type: string
description: Pace compared to target
enum:
- Slower
- On Target
- Faster
- N/A
example: On Target
intensityAssessment:
type: string
description: Intensity assessment
enum:
- Under
- Appropriate
- Over
- N/A
example: Appropriate
feedbackForUser:
type: string
description: Personalized feedback message for the user
example: >-
Great job! You completed the planned workout perfectly. Your pace
was spot-on!
impactOnPlan:
type: string
description: Impact on training plan
enum:
- None
- Minor Adjustment Recommended
- Rest Recommended
example: None
required:
- status
- matchConfidence
- distanceCompletionPercentage
- paceVsTarget
- intensityAssessment
- feedbackForUser
- impactOnPlan
WorkoutMatchResponseDto:
type: object
properties:
workout:
type: object
description: Updated workout details
matchResult:
description: Match analysis result
allOf:
- $ref: '#/components/schemas/MatchResultResponseDto'
required:
- workout
- matchResult
PlanProgressResponseDto:
type: object
properties:
totalWorkouts:
type: number
description: Total non-rest workouts in plan
example: 60
completed:
type: number
description: Number of completed workouts
example: 45
partial:
type: number
description: Number of partially completed workouts
example: 5
missed:
type: number
description: Number of missed workouts
example: 3
pending:
type: number
description: Number of pending workouts
example: 7
completionRate:
type: number
description: Overall completion rate percentage
example: 79
required:
- totalWorkouts
- completed
- partial
- missed
- pending
- completionRate
AdjustPlanDto:
type: object
properties:
adjustmentType:
type: string
description: Type of adjustment needed
enum:
- missed_workouts
- injury_prevention
- schedule_conflict
- performance_issue
- increase_intensity
- decrease_intensity
- custom
example: missed_workouts
reason:
type: string
description: Detailed reason for adjustment request
example: Missed 3 workouts last week due to work commitments
injuryDetails:
type: string
description: Injury or pain details (required for injury_prevention type)
example: Right knee pain during long runs
preferredDays:
description: Preferred training days (e.g., ["Monday", "Wednesday", "Friday"])
example:
- Monday
- Wednesday
- Friday
- Saturday
type: array
items:
type: string
targetWeeklyDistance:
type: number
description: Target weekly distance in kilometers
example: 30
required:
- adjustmentType
- reason
CurrentProgressDto:
type: object
properties:
completionRate:
type: number
description: Overall completion rate percentage
example: 65
missedWorkouts:
type: number
description: Number of missed workouts
example: 5
recentPerformance:
type: string
description: Recent performance summary
example: 3 completed, 2 missed (last 7 days)
adherenceIssues:
description: List of adherence issues detected
example:
- Multiple missed workouts in last 7 days
- Low overall completion rate
type: array
items:
type: string
required:
- completionRate
- missedWorkouts
- recentPerformance
- adherenceIssues
WorkoutModificationDto:
type: object
properties:
dayNumber:
type: number
description: Day number in the plan
example: 15
currentWorkout:
type: string
description: Original workout description
example: Easy Run - 8km
proposedWorkout:
type: string
description: Modified workout description
example: Easy Run - 5km
reason:
type: string
description: Reason for modification
example: Reduced from 8km due to missed workouts last week
required:
- dayNumber
- currentWorkout
- proposedWorkout
- reason
ScheduleAdjustmentDto:
type: object
properties:
weekNumber:
type: number
description: Week number in the plan
example: 3
change:
type: string
description: Description of the change
example: 25km - Rebuilding base after missed workouts
reason:
type: string
description: Reason for the change
example: Reducing volume to allow proper recovery
required:
- weekNumber
- change
- reason
ProposedChangesDto:
type: object
properties:
workoutModifications:
description: List of workout modifications
type: array
items:
$ref: '#/components/schemas/WorkoutModificationDto'
scheduleAdjustments:
description: Schedule adjustments by week
type: array
items:
$ref: '#/components/schemas/ScheduleAdjustmentDto'
intensityChanges:
type: string
description: Overall intensity changes
example: Reduced weekly volume by 15% and added extra recovery day
required:
- workoutModifications
- scheduleAdjustments
- intensityChanges
AdjustmentAnalysisDto:
type: object
properties:
currentProgress:
description: Current training progress analysis
allOf:
- $ref: '#/components/schemas/CurrentProgressDto'
proposedChanges:
description: Proposed changes to the plan
allOf:
- $ref: '#/components/schemas/ProposedChangesDto'
adjustmentReason:
type: string
description: Primary reason for the adjustment
example: Plan adjusted to account for missed workouts and prevent injury
impactAssessment:
type: string
description: Expected impact of the changes
example: >-
Gradual rebuild of fitness base; reduced injury risk; improved
adherence
required:
- currentProgress
- proposedChanges
- adjustmentReason
- impactAssessment
PlanAdjustmentResponseDto:
type: object
properties:
plan:
type: object
description: Updated training plan
analysis:
description: Detailed adjustment analysis
allOf:
- $ref: '#/components/schemas/AdjustmentAnalysisDto'
required:
- plan
- analysis
AdjustmentSuggestionsResponseDto:
type: object
properties:
suggestions:
description: Automated adjustment suggestions (not applied)
allOf:
- $ref: '#/components/schemas/AdjustmentAnalysisDto'
required:
- suggestions
ConsistencyMetricsDto:
type: object
properties:
completionRate:
type: number
description: Overall completion rate percentage
example: 85
weeklyAdherence:
type: number
description: Weekly adherence percentage (last 4 weeks)
example: 90
longestStreak:
type: number
description: Longest workout completion streak
example: 12
currentStreak:
type: number
description: Current active streak
example: 5
required:
- completionRate
- weeklyAdherence
- longestStreak
- currentStreak
ConsistencyScoreDto:
type: object
properties:
score:
type: number
description: Consistency score (0-100)
example: 88
metrics:
description: Detailed consistency metrics
allOf:
- $ref: '#/components/schemas/ConsistencyMetricsDto'
required:
- score
- metrics
VolumeMetricsDto:
type: object
properties:
weeklyAverageKm:
type: number
description: Weekly average distance in km
example: 35.5
monthlyTotalKm:
type: number
description: Monthly total distance in km
example: 142
volumeTrend:
type: string
description: Volume trend
enum:
- increasing
- stable
- decreasing
example: increasing
comparedToGoal:
type: number
description: Percentage compared to goal volume
example: 85
required:
- weeklyAverageKm
- monthlyTotalKm
- volumeTrend
- comparedToGoal
VolumeScoreDto:
type: object
properties:
score:
type: number
description: Volume score (0-100)
example: 82
metrics:
description: Detailed volume metrics
allOf:
- $ref: '#/components/schemas/VolumeMetricsDto'
required:
- score
- metrics
IntensityMetricsDto:
type: object
properties:
hardWorkoutsPerWeek:
type: number
description: Hard workouts per week average
example: 1.5
easyHardRatio:
type: number
description: Easy to hard workout ratio
example: 2.5
recoveryAdequacy:
type: string
description: Recovery adequacy assessment
enum:
- good
- fair
- poor
example: good
required:
- hardWorkoutsPerWeek
- easyHardRatio
- recoveryAdequacy
IntensityScoreDto:
type: object
properties:
score:
type: number
description: Intensity score (0-100)
example: 75
metrics:
description: Detailed intensity metrics
allOf:
- $ref: '#/components/schemas/IntensityMetricsDto'
required:
- score
- metrics
ProgressionMetricsDto:
type: object
properties:
weekOverWeekImprovement:
type: number
description: Week-over-week improvement percentage
example: 8
peakDistance:
type: number
description: Peak distance completed in km
example: 18.5
longestRunCompleted:
type: number
description: Longest run completed in km
example: 18.5
required:
- weekOverWeekImprovement
- peakDistance
- longestRunCompleted
ProgressionScoreDto:
type: object
properties:
score:
type: number
description: Progression score (0-100)
example: 80
metrics:
description: Detailed progression metrics
allOf:
- $ref: '#/components/schemas/ProgressionMetricsDto'
required:
- score
- metrics
FitnessComponentsDto:
type: object
properties:
consistency:
description: Consistency component
allOf:
- $ref: '#/components/schemas/ConsistencyScoreDto'
volume:
description: Volume component
allOf:
- $ref: '#/components/schemas/VolumeScoreDto'
intensity:
description: Intensity component
allOf:
- $ref: '#/components/schemas/IntensityScoreDto'
progression:
description: Progression component
allOf:
- $ref: '#/components/schemas/ProgressionScoreDto'
required:
- consistency
- volume
- intensity
- progression
ProjectedPerformanceDto:
type: object
properties:
estimatedFinishTime:
type: string
description: Estimated finish time (HH:MM:SS)
example: '02:15:30'
confidenceLevel:
type: string
description: Confidence level in projection
enum:
- high
- medium
- low
example: medium
keyFactors:
description: Key factors influencing projection
example:
- Strong training consistency
- Solid long run base established
type: array
items:
type: string
required:
- confidenceLevel
- keyFactors
FitnessScoreResponseDto:
type: object
properties:
overall:
type: number
description: Overall fitness score (0-100)
example: 82
components:
description: Detailed component scores
allOf:
- $ref: '#/components/schemas/FitnessComponentsDto'
trend:
type: string
description: Fitness trend
enum:
- improving
- stable
- declining
example: improving
insights:
description: Personalized insights
example:
- Excellent consistency! You've completed 85% of workouts.
- >-
Your training volume is increasing - currently averaging
35.5km/week.
type: array
items:
type: string
recommendations:
description: Actionable recommendations
example:
- >-
Focus on completing workouts consistently. Aim for at least 80%
completion rate.
- >-
Consider adding quality workouts (tempo, intervals) to improve
race readiness.
type: array
items:
type: string
readinessScore:
type: number
description: Event readiness score (0-100)
example: 85
projectedPerformance:
description: Projected event performance
allOf:
- $ref: '#/components/schemas/ProjectedPerformanceDto'
required:
- overall
- components
- trend
- insights
- recommendations
- readinessScore
HistoricalFitnessDataDto:
type: object
properties:
date:
type: string
description: Date of the score
example: '2025-07-15'
overallScore:
type: number
description: Overall fitness score
example: 78
consistencyScore:
type: number
description: Consistency score
example: 85
volumeScore:
type: number
description: Volume score
example: 75
intensityScore:
type: number
description: Intensity score
example: 72
progressionScore:
type: number
description: Progression score
example: 80
required:
- date
- overallScore
- consistencyScore
- volumeScore
- intensityScore
- progressionScore
FitnessHistoryResponseDto:
type: object
properties:
history:
description: Historical fitness scores over time
type: array
items:
$ref: '#/components/schemas/HistoricalFitnessDataDto'
weeks:
type: number
description: Number of weeks included
example: 4
required:
- history
- weeks
SendChatMessageDto:
type: object
properties:
message:
type: string
description: User message
example: What should I eat before a long run?
maxLength: 2000
sessionId:
type: string
description: Session ID to continue a conversation
example: uuid-session-id
required:
- message
ChatMessageResponseDto:
type: object
properties:
messageId:
type: string
description: Message ID (same as WebSocket messageId)
example: e85ecc71-e755-44d9-9b40-610cf1c4c7e3
sessionId:
type: string
description: Session ID
example: 5c4b9ba9-2f1c-4199-962f-99d057d94b71
role:
type: string
description: Role (user/assistant)
example: assistant
fullContent:
type: string
description: Full content including markdown formatted training plan
example: That's impressive! To prepare for your event...
category:
type: string
description: Message category
example: event
tokensUsed:
type: number
description: Tokens used for this message
example: 0
actionButton:
type: object
description: Action button for navigation (null if no action)
nullable: true
example:
text: View Training Plan
action: navigate
screen: TrainingPlanDashboardScreen
params:
planId: uuid
required:
- messageId
- sessionId
- role
- fullContent
- category
- tokensUsed
- actionButton
ChatSessionListDto:
type: object
properties:
sessionId:
type: string
description: Session ID
preview:
type: string
description: First message preview
messageCount:
type: number
description: Message count
lastMessageAt:
format: date-time
type: string
description: Last message timestamp
createdAt:
format: date-time
type: string
description: Session created at
required:
- sessionId
- preview
- messageCount
- lastMessageAt
- createdAt
ChatHistoryResponseDto:
type: object
properties:
sessionId:
type: string
description: Session ID
messages:
description: Messages in the session
type: array
items:
$ref: '#/components/schemas/ChatMessageResponseDto'
totalMessages:
type: number
description: Total messages count
required:
- sessionId
- messages
- totalMessages
PlanTierDto:
type: object
properties:
price:
type: number
description: Price in INR
example: 9
isFree:
type: boolean
description: Whether this plan is free
example: false
features:
description: List of features included
example:
- Personalized training schedule
- Daily nutrition tips
type: array
items:
type: string
availableDurations:
description: Available durations for this tier
example:
- 2_weeks
- 4_weeks
- 8_weeks
type: array
items:
type: string
required:
- price
- isFree
- features
- availableDurations
TrainingPlanOfferResponseDto:
type: object
properties:
eligible:
type: boolean
description: Whether user is eligible for training plan
example: true
reason:
type: string
description: Reason for eligibility or ineligibility
example: Eligible for personalized training plan
daysUntilEvent:
type: number
description: Days until the event
example: 45
minDaysRequired:
type: number
description: Minimum days required before event
example: 15
sportType:
type: string
description: Sport type for the event
enum:
- running
- cycling
- swimming
- triathlon
- hiking_trekking
example: running
eventSubType:
type: string
description: Event sub-type (marathon, road_cycling, etc.)
example: marathon
pricing:
type: object
description: Pricing details for all tiers
activePlan:
description: Active (Easy) plan - FREE tier
allOf:
- $ref: '#/components/schemas/PlanTierDto'
athletePlan:
description: Athlete (Medium) plan - Paid tier
allOf:
- $ref: '#/components/schemas/PlanTierDto'
goatPlan:
description: GOAT (Tough) plan - Premium tier with chatbot
allOf:
- $ref: '#/components/schemas/PlanTierDto'
normalPlan:
type: object
description: '[DEPRECATED] Use pricing.activePrice/athletePrice instead'
deprecated: true
advancedPlan:
type: object
description: '[DEPRECATED] Use pricing.goatPrice instead'
deprecated: true
required:
- eligible
- reason
- daysUntilEvent
- minDaysRequired
- sportType
- pricing
- activePlan
- athletePlan
- goatPlan
InitiateTrainingPlanPurchaseDto:
type: object
properties:
eventId:
type: string
description: Event ID for which training plan is being purchased
example: 550e8400-e29b-41d4-a716-446655440000
planStartDate:
type: string
description: >-
Date when the user wants to start the training plan (ISO 8601
format). Defaults to today if not provided.
example: '2026-01-10'
programLevel:
type: string
description: Program level to purchase
enum:
- active
- athlete
- goat
example: athlete
duration:
type: string
description: Duration of the training plan
enum:
- 2_weeks
- 4_weeks
- 8_weeks
example: 4_weeks
sportType:
type: string
description: Sport type (defaults to event sport type)
enum:
- running
- cycling
- swimming
- triathlon
- hiking_trekking
example: running
planType:
type: string
description: '[DEPRECATED] Use programLevel instead'
enum:
- normal
- advanced
deprecated: true
goalType:
type: string
description: Goal type for the training plan
example: finish
targetTime:
type: string
description: Target time for the event
example: '2:00:00'
preferredDays:
type: string
description: Preferred training days
example: weekdays
injuryHistory:
type: string
description: Any injury history to consider
example: knee pain
foodPreference:
type: string
description: Food preference for nutrition plan (veg/non_veg/vegan)
enum:
- veg
- non_veg
- vegan
example: veg
workoutTimePreference:
type: string
description: Preferred workout time of day
enum:
- early_morning
- morning
- afternoon
- evening
- night
- flexible
example: morning
required:
- eventId
- programLevel
- duration
VerifyTrainingPlanPurchaseDto:
type: object
properties:
orderId:
type: string
description: Order ID from Cashfree
example: order_123456
required:
- orderId
VerifyPaymentDto:
type: object
properties:
orderId:
type: string
description: Order ID from Cashfree
example: order_123456
required:
- orderId
VerifyPaymentResponseDto:
type: object
properties:
success:
type: boolean
description: Whether payment verification was successful
example: true
message:
type: string
description: Message describing the payment status
example: Payment verified successfully
paymentStatus:
type: string
description: Payment status from Cashfree
example: PAID
orderAmount:
type: number
description: Order amount in INR
example: 19
programLevel:
type: string
description: Program level for the training plan
enum:
- active
- athlete
- goat
example: athlete
duration:
type: string
description: Duration of the training plan
enum:
- 2_weeks
- 4_weeks
- 8_weeks
example: 4_weeks
eventId:
type: string
description: Event ID associated with the order
example: 550e8400-e29b-41d4-a716-446655440000
eventName:
type: string
description: Event name associated with the order
example: Mumbai Marathon 2026
planAlreadyCreated:
type: boolean
description: Whether a training plan has already been created for this order
example: false
planId:
type: string
description: Plan ID if a plan has already been created
example: 01HQXYZ123456789
required:
- success
- message
- paymentStatus
- orderAmount
- planAlreadyCreated
GenerateTrainingPlanFromOrderDto:
type: object
properties:
orderId:
type: string
description: Order ID from Cashfree (required for paid plans)
example: order_123456
eventId:
type: string
description: Event ID for which training plan is being generated
example: 550e8400-e29b-41d4-a716-446655440000
programLevel:
type: string
description: Program level for the training plan
enum:
- active
- athlete
- goat
example: athlete
duration:
type: string
description: Duration of the training plan
enum:
- 2_weeks
- 4_weeks
- 8_weeks
example: 4_weeks
sportType:
type: string
description: Sport type (defaults to RUNNING)
enum:
- running
- cycling
- swimming
- triathlon
- hiking_trekking
example: running
planStartDate:
type: string
description: >-
Date when the user wants to start the training plan (ISO 8601
format). Defaults to today if not provided.
example: '2026-01-10'
goalType:
type: string
description: Goal type for the training plan
example: finish
targetTime:
type: string
description: Target time for the event
example: '2:00:00'
preferredDays:
type: string
description: Preferred training days
example: weekdays
injuryHistory:
type: string
description: Any injury history to consider
example: knee pain
foodPreference:
type: string
description: Food preference for nutrition plan (veg/non_veg/vegan)
enum:
- veg
- non_veg
- vegan
example: veg
workoutTimePreference:
type: string
description: Preferred workout time of day
enum:
- early_morning
- morning
- afternoon
- evening
- night
- flexible
example: morning
required:
- eventId
- programLevel
- duration
GenerateTrainingPlanResponseDto:
type: object
properties:
success:
type: boolean
description: Whether plan generation was successful
example: true
message:
type: string
description: Message describing the result
example: Training plan created successfully
planId:
type: string
description: Generated training plan ID
example: 01HQXYZ123456789
chatbotEnabled:
type: boolean
description: Whether AI chatbot is enabled for this plan (GOAT only)
example: false
programLevel:
type: string
description: Program level of the created plan
enum:
- active
- athlete
- goat
example: athlete
isFree:
type: boolean
description: Whether this was a free plan
example: false
required:
- success
- message
- isFree
CalendarEventDto:
type: object
properties:
id:
type: string
description: Unique identifier
type:
type: string
enum:
- training_workout
- event_participation
- challenge_participation
- custom_workout
description: Type of calendar event
title:
type: string
description: Event title/name
description:
type: string
description: Event description
startDate:
format: date-time
type: string
description: Start date/time
endDate:
format: date-time
type: string
description: End date/time
allDay:
type: boolean
description: Is this an all-day event
color:
type: string
description: Color code for UI
metadata:
type: object
description: Additional metadata
required:
- id
- type
- title
- startDate
- allDay
CalendarMonthResponseDto:
type: object
properties:
year:
type: number
description: Year
month:
type: number
description: Month (1-12)
events:
description: Events for the month
type: array
items:
$ref: '#/components/schemas/CalendarEventDto'
totalEvents:
type: number
description: Total count of events
required:
- year
- month
- events
- totalEvents
CalendarRangeResponseDto:
type: object
properties:
startDate:
type: string
description: Start date of range
endDate:
type: string
description: End date of range
events:
description: Events in the range
type: array
items:
$ref: '#/components/schemas/CalendarEventDto'
totalEvents:
type: number
description: Total count of events
required:
- startDate
- endDate
- events
- totalEvents
CreateUserWorkoutDto:
type: object
properties:
date:
type: string
description: Workout date
example: '2025-01-15'
title:
type: string
description: Workout title
example: Morning Run
maxLength: 255
description:
type: string
description: Workout description
example: Easy 5km run in the park
workoutType:
type: string
enum: &ref_692
- run
- walk
- cycling
- swimming
- gym
- yoga
- stretching
- cross_training
- rest
- other
description: Type of workout
example: run
intensity:
type: string
enum: &ref_693
- none
- low
- moderate
- high
description: Workout intensity level
example: moderate
distanceKm:
type: number
description: Distance in kilometers
example: 5
durationMinutes:
type: number
description: Duration in minutes
example: 30
targetPace:
type: string
description: Target pace (min/km)
example: '6:00'
calories:
type: number
description: Estimated calories to burn
example: 300
startTime:
type: string
description: Start time (HH:MM)
example: '06:30'
endTime:
type: string
description: End time (HH:MM)
example: '07:00'
location:
type: string
description: Workout location
example: Central Park
notes:
type: string
description: Additional notes
example: Remember to stretch before and after
color:
type: string
description: Color code for calendar display
example: '#4CAF50'
isRecurring:
type: boolean
description: Is this a recurring workout
example: false
recurringPattern:
type: string
description: Recurring pattern (daily, weekly, monthly)
example: weekly
nutritionPlan:
type: object
description: Nutrition plan for this workout
example: &ref_694
waterIntakeLiters: 2.5
preWorkoutMeal: Banana and oats
postWorkoutMeal: Protein shake
notes: Stay hydrated
required:
- date
- title
UpdateUserWorkoutDto:
type: object
properties:
date:
type: string
description: Workout date
example: '2025-01-15'
title:
type: string
description: Workout title
example: Morning Run
maxLength: 255
description:
type: string
description: Workout description
example: Easy 5km run in the park
workoutType:
type: string
enum: *ref_692
description: Type of workout
example: run
intensity:
type: string
enum: *ref_693
description: Workout intensity level
example: moderate
distanceKm:
type: number
description: Distance in kilometers
example: 5
durationMinutes:
type: number
description: Duration in minutes
example: 30
targetPace:
type: string
description: Target pace (min/km)
example: '6:00'
calories:
type: number
description: Estimated calories to burn
example: 300
startTime:
type: string
description: Start time (HH:MM)
example: '06:30'
endTime:
type: string
description: End time (HH:MM)
example: '07:00'
location:
type: string
description: Workout location
example: Central Park
notes:
type: string
description: Additional notes
example: Remember to stretch before and after
color:
type: string
description: Color code for calendar display
example: '#4CAF50'
isRecurring:
type: boolean
description: Is this a recurring workout
example: false
recurringPattern:
type: string
description: Recurring pattern (daily, weekly, monthly)
example: weekly
nutritionPlan:
type: object
description: Nutrition plan for this workout
example: *ref_694
isCompleted:
type: boolean
description: Mark workout as completed
example: true
ChallengeProofRulesDto:
type: object
properties:
gps_required:
type: boolean
description: Whether GPS tracking is required to record the activity
example: true
minimum_distance:
type: number
description: >-
Minimum distance (in the challenge targetUnit) an activity must
cover to qualify. Null means no minimum.
example: 1
nullable: true
route_match:
type: boolean
description: Whether the activity must follow a predefined route
example: false
photo_proof:
type: boolean
description: Whether a photo is required as proof of completion
example: false
device_import:
type: boolean
description: >-
Whether importing from a wearable / third-party device is allowed as
proof
example: true
allowed_devices:
description: >-
Allowlist of device / platform identifiers (e.g. "garmin", "strava",
"apple_health"). Empty array means any device is allowed.
example:
- garmin
- strava
type: array
items:
type: string
PrizeCashDto:
type: object
properties:
amount:
type: number
example: 10000
PrizeCoinDto:
type: object
properties:
coinAmount:
type: number
example: 2000
PrizeProductDto:
type: object
properties:
productName:
type: string
example: Nike Shoes
productDescription:
type: string
example: Nike Air Zoom Pegasus
quantity:
type: number
example: 1
PrizeSlabDto:
type: object
properties:
rankStart:
type: number
example: 1
rankEnd:
type: number
example: 1
cash:
$ref: '#/components/schemas/PrizeCashDto'
rcCoin:
$ref: '#/components/schemas/PrizeCoinDto'
product:
$ref: '#/components/schemas/PrizeProductDto'
ParticipationRewardDto:
type: object
properties:
coinAmount:
type: number
example: 10
description: RC Coins each completer earns.
maxRewardedParticipants:
type: number
example: 500
description: >-
How many completers the reward is funded for. coinAmount × this is
reserved from the creator wallet.
CreateChallengeDto:
type: object
properties:
ownerOrganizerId:
type: string
description: >-
Admin-only target organizer. Ignored for non-admin callers and
validated server-side.
desktopVideoUploadKey:
type: string
description: >-
Temporary owned GCS object key returned by POST
/v2/challenges/video-uploads for a desktop video uploaded directly
by the browser.
desktopVideoCrop:
type: string
description: >-
JSON crop/trim settings for the required 16:9 desktop video
alternative.
promoVideoUploadKey:
type: string
description: >-
Temporary owned GCS object key returned by POST
/v2/challenges/video-uploads for a mobile video uploaded directly by
the browser.
removeDesktopVideo:
type: boolean
description: Remove the currently saved desktop video.
promoVideoCrop:
type: string
description: >-
JSON crop/trim settings for the required 4:5 mobile video
alternative.
removePromoVideo:
type: boolean
description: Remove the currently saved promotional video.
title:
type: string
description: Title of the challenge
maxLength: 256
example: January Running Challenge
challengeType:
type: string
description: Type of the challenge (collective or daily)
enum: &ref_695
- collective
- daily
- distance
- streak
- single_effort
- elevation
- multi_sport
- team
- speed_pace
- frequency
example: collective
startDate:
format: date-time
type: string
description: Start date of the challenge (YYYY-MM-DD)
example: '2025-01-01'
endDate:
format: date-time
type: string
description: End date of the challenge (YYYY-MM-DD)
example: '2025-01-31'
totalDays:
type: number
description: >-
Total duration in days. Optional — the backend always computes the
canonical value from startDate/endDate; if provided, it must match
or the request is rejected. Frontend-supplied values are for UX
display only, never trusted as-is.
example: 30
targetValue:
type: number
description: >-
Target value of the challenge (total for COLLECTIVE, daily for
DAILY). For DAILY challenges this is server-computed
(dailyTargetValue × minActiveDays) and any client-supplied value is
ignored.
example: 5000
dailyTargetValue:
type: number
description: Daily target value (required for DAILY challenges)
example: 1000
minActiveDays:
type: number
description: Minimum active days required to complete DAILY challenges
example: 5
dailyCompletionThreshold:
type: number
description: >-
Percentage of dailyTargetValue required for a day to count as
completed. This is a percentage, not a distance/steps amount
(default 90).
example: 90
requireConsecutiveDays:
type: boolean
description: Whether daily challenges require consecutive days (default true)
example: true
targetUnit:
type: string
description: Target unit of the challenge (steps/km)
enum: &ref_696
- steps
- km
- calories
example: steps
targetDescription:
type: string
description: Target description of the challenge
example: Complete to 5000 km in a month
badgeDescription:
type: string
description: Description shown below the selected challenge badge
example: Complete this challenge to earn your finisher badge.
rewardCoinsInterval:
type: number
description: >-
Legacy: activity interval at which coins are rewarded (in target
unit). No longer used by any current UI.
example: 10000
rewardCoinsPerInterval:
type: number
description: >-
Legacy: number of coins awarded per interval completion. No longer
used by any current UI.
example: 20
rewardCoinsMultiplier:
type: number
description: >-
Legacy: multiplier for reward coins. No longer used by any current
UI.
example: 1.5
reward:
type: string
description: >-
Legacy: free-text reward summary. No longer collected by any current
UI.
example: Digital badge, $100, Merchant Discount
description:
type: string
description: Description of the challenge
example: >-
Fitgo partners with Brodks and challenges you to take part in a 5K.
Find strength in every step you take, feel positive energy.
qualifyingSports:
description: Qualifying activities of the challenge
example: &ref_697
- ca462431-34da-42a7-9b7f-70e9fbcff541
- ca462431-34da-42a7-9k3h-70e9fbcff541
- ca462431-34da-42a7-9u8f-70e9fbcff541
type: array
items:
type: string
isActive:
type: boolean
description: Indicates if the challenge is active or not
example: true
clubId:
type: string
description: >-
When set, the challenge is floated on behalf of this club instead of
the calling organizer. The organizer must own the club. Vision §1 —
clubs are first-class challenge creators.
example: 123e4567-e89b-12d3-a456-426614174000
sponsorId:
type: string
description: >-
When set, the challenge is floated on behalf of this sponsor brand.
The calling user must have an ACTIVE SponsorAccount for the brand.
Vision §1 — sponsors are first-class challenge hosts.
example: 123e4567-e89b-12d3-a456-426614174000
proofRules:
description: >-
Activity verification rules for this challenge. Controls GPS,
distance, route, photo proof, and device import requirements.
allOf:
- $ref: '#/components/schemas/ChallengeProofRulesDto'
accessType:
type: string
description: Whether the challenge is free to join or requires an entry fee.
enum: &ref_698
- free
- paid
example: free
default: free
paymentMethod:
type: string
description: >-
Required when accessType=PAID. RC_COIN charges the RC wallet; MONEY
routes through the existing payment gateway flow.
enum: &ref_699
- rc_coin
- money
example: money
entryFeeCoins:
type: number
description: Entry fee in RC Coins. Required when paymentMethod=RC_COIN.
example: 500
leaveCutoffDaysBeforeStart:
type: number
description: >-
Refund/leave window for PAID challenges: participants may leave and
be refunded only until this many days before startDate. 0 (default)
= allowed right up to the start date. Ignored for FREE challenges
(always leavable, no refund).
example: 0
entryFee:
type: number
description: >-
Entry fee in the challenge currency (INR). Required when
paymentMethod=MONEY.
example: 499
badgeId:
type: string
description: >-
ID of an existing ACTIVE Badge (from the admin-curated badge
library) to award on challenge completion. Replaces the old
per-challenge badge image upload. Leave unset and provide
badgeRequestName/... to raise a draft badge request instead.
prizeSlabs:
description: >-
Rank-wise prize configuration. Unlimited slabs; each rank or rank
range may carry Cash, RC Coin, and/or Product prizes simultaneously.
RC Coin prizes are reserved from the creator’s wallet immediately on
save.
type: array
items:
$ref: '#/components/schemas/PrizeSlabDto'
participationReward:
description: >-
Inclusive participation reward — every athlete who COMPLETES the
challenge earns `coinAmount` RC Coins (paid on completion). Funded +
reserved up front for `maxRewardedParticipants` completers.
`maxRewardCoins` is derived from `coinAmount` (0 when unset).
allOf:
- $ref: '#/components/schemas/ParticipationRewardDto'
required:
- title
- challengeType
- startDate
- endDate
- targetValue
- targetUnit
- targetDescription
- description
- qualifyingSports
- accessType
UpdateChallengeDto:
type: object
properties:
ownerOrganizerId:
type: string
description: >-
Admin-only target organizer. Ignored for non-admin callers and
validated server-side.
desktopVideoUploadKey:
type: string
description: >-
Temporary owned GCS object key returned by POST
/v2/challenges/video-uploads for a desktop video uploaded directly
by the browser.
desktopVideoCrop:
type: string
description: >-
JSON crop/trim settings for the required 16:9 desktop video
alternative.
promoVideoUploadKey:
type: string
description: >-
Temporary owned GCS object key returned by POST
/v2/challenges/video-uploads for a mobile video uploaded directly by
the browser.
removeDesktopVideo:
type: boolean
description: Remove the currently saved desktop video.
promoVideoCrop:
type: string
description: >-
JSON crop/trim settings for the required 4:5 mobile video
alternative.
removePromoVideo:
type: boolean
description: Remove the currently saved promotional video.
title:
type: string
description: Title of the challenge
maxLength: 256
example: January Running Challenge
challengeType:
type: string
description: Type of the challenge (collective or daily)
enum: *ref_695
example: collective
startDate:
format: date-time
type: string
description: Start date of the challenge (YYYY-MM-DD)
example: '2025-01-01'
endDate:
format: date-time
type: string
description: End date of the challenge (YYYY-MM-DD)
example: '2025-01-31'
totalDays:
type: number
description: >-
Total duration in days. Optional — the backend always computes the
canonical value from startDate/endDate; if provided, it must match
or the request is rejected. Frontend-supplied values are for UX
display only, never trusted as-is.
example: 30
targetValue:
type: number
description: >-
Target value of the challenge (total for COLLECTIVE, daily for
DAILY). For DAILY challenges this is server-computed
(dailyTargetValue × minActiveDays) and any client-supplied value is
ignored.
example: 5000
dailyTargetValue:
type: number
description: Daily target value (required for DAILY challenges)
example: 1000
minActiveDays:
type: number
description: Minimum active days required to complete DAILY challenges
example: 5
dailyCompletionThreshold:
type: number
description: >-
Percentage of dailyTargetValue required for a day to count as
completed. This is a percentage, not a distance/steps amount
(default 90).
example: 90
requireConsecutiveDays:
type: boolean
description: Whether daily challenges require consecutive days (default true)
example: true
targetUnit:
type: string
description: Target unit of the challenge (steps/km)
enum: *ref_696
example: steps
targetDescription:
type: string
description: Target description of the challenge
example: Complete to 5000 km in a month
badgeDescription:
type: string
description: Description shown below the selected challenge badge
example: Complete this challenge to earn your finisher badge.
rewardCoinsInterval:
type: number
description: >-
Legacy: activity interval at which coins are rewarded (in target
unit). No longer used by any current UI.
example: 10000
rewardCoinsPerInterval:
type: number
description: >-
Legacy: number of coins awarded per interval completion. No longer
used by any current UI.
example: 20
rewardCoinsMultiplier:
type: number
description: >-
Legacy: multiplier for reward coins. No longer used by any current
UI.
example: 1.5
reward:
type: string
description: >-
Legacy: free-text reward summary. No longer collected by any current
UI.
example: Digital badge, $100, Merchant Discount
description:
type: string
description: Description of the challenge
example: >-
Fitgo partners with Brodks and challenges you to take part in a 5K.
Find strength in every step you take, feel positive energy.
qualifyingSports:
description: Qualifying activities of the challenge
example: *ref_697
type: array
items:
type: string
isActive:
type: boolean
description: Indicates if the challenge is active or not
example: true
clubId:
type: string
description: >-
When set, the challenge is floated on behalf of this club instead of
the calling organizer. The organizer must own the club. Vision §1 —
clubs are first-class challenge creators.
example: 123e4567-e89b-12d3-a456-426614174000
sponsorId:
type: string
description: >-
When set, the challenge is floated on behalf of this sponsor brand.
The calling user must have an ACTIVE SponsorAccount for the brand.
Vision §1 — sponsors are first-class challenge hosts.
example: 123e4567-e89b-12d3-a456-426614174000
proofRules:
description: >-
Activity verification rules for this challenge. Controls GPS,
distance, route, photo proof, and device import requirements.
allOf:
- $ref: '#/components/schemas/ChallengeProofRulesDto'
accessType:
type: string
description: Whether the challenge is free to join or requires an entry fee.
enum: *ref_698
example: free
default: free
paymentMethod:
type: string
description: >-
Required when accessType=PAID. RC_COIN charges the RC wallet; MONEY
routes through the existing payment gateway flow.
enum: *ref_699
example: money
entryFeeCoins:
type: number
description: Entry fee in RC Coins. Required when paymentMethod=RC_COIN.
example: 500
leaveCutoffDaysBeforeStart:
type: number
description: >-
Refund/leave window for PAID challenges: participants may leave and
be refunded only until this many days before startDate. 0 (default)
= allowed right up to the start date. Ignored for FREE challenges
(always leavable, no refund).
example: 0
entryFee:
type: number
description: >-
Entry fee in the challenge currency (INR). Required when
paymentMethod=MONEY.
example: 499
badgeId:
type: string
description: >-
ID of an existing ACTIVE Badge (from the admin-curated badge
library) to award on challenge completion. Replaces the old
per-challenge badge image upload. Leave unset and provide
badgeRequestName/... to raise a draft badge request instead.
prizeSlabs:
description: >-
Rank-wise prize configuration. Unlimited slabs; each rank or rank
range may carry Cash, RC Coin, and/or Product prizes simultaneously.
RC Coin prizes are reserved from the creator’s wallet immediately on
save.
type: array
items:
$ref: '#/components/schemas/PrizeSlabDto'
participationReward:
description: >-
Inclusive participation reward — every athlete who COMPLETES the
challenge earns `coinAmount` RC Coins (paid on completion). Funded +
reserved up front for `maxRewardedParticipants` completers.
`maxRewardCoins` is derived from `coinAmount` (0 when unset).
allOf:
- $ref: '#/components/schemas/ParticipationRewardDto'
isFeatured:
type: boolean
description: Admin-only featured flag. Multipart string booleans are normalized.
SubmitDirectProposalDto:
type: object
properties:
targetType:
type: string
enum:
- EVENT
- CHALLENGE
description: >-
What is being pitched at. CLUB is not addressable this way — a club
is not a dated competition with a leaderboard to put goodies on.
targetId:
type: string
description: Id of the event or challenge. Must not have ended.
proposedValue:
type: number
example: 25000
currency:
type: string
example: INR
default: INR
message:
type: string
description: What the brand is offering, in its own words.
placements:
type: array
items:
type: object
goodiesSummary:
type: string
maxLength: 2000
required:
- targetType
- targetId
- proposedValue
- message
UpdateActivityTrackingPreferencesDto:
type: object
properties: {}
CreateSettingDto:
type: object
properties:
clubDeactivationRefundGraceDays:
type: number
description: >-
Days between Club deactivation and automatic paid-member refunds.
Applies to future deactivations; active grace windows keep their
snapshotted deadline.
example: 15
minimum: 1
maximum: 90
clubCreationTermsContent:
type: string
description: >-
Platform-authored terms a Club owner must accept before creating a
Club. Updating the content publishes a new version automatically.
clubOwnershipTransferConsentDays:
type: number
description: Days User B has to accept a Club ownership-transfer request.
minimum: 1
maximum: 30
default: 7
platformFee:
type: number
description: Platform fee amount
example: 2.5
minimum: 0
paymentGatewayFee:
type: number
description: Payment gateway fee amount
example: 1.5
minimum: 0
platformFeeType:
type: string
description: Type of platform fee (PERCENTAGE or FIXED)
enum: &ref_700
- percentage
- fixed
example: percentage
CGST:
type: number
description: Central Goods and Services Tax (CGST) percentage
example: 9
minimum: 0
SGST:
type: number
description: State Goods and Services Tax (SGST) percentage
example: 9
minimum: 0
UTGST:
type: number
description: Union Territory Goods and Services Tax (UTGST) percentage
example: 9
minimum: 0
IGST:
type: number
description: Integrated Goods and Services Tax (IGST) percentage
example: 18
minimum: 0
coinValueInFiat:
type: number
description: The real-life value of 1 coin in fiat currency (e.g. INR)
example: 5
minimum: 0
trainingPlanNormalPrice:
type: number
description: '[DEPRECATED] Price for Normal training plan in INR'
example: 9
minimum: 0
deprecated: true
trainingPlanAdvancedPrice:
type: number
description: '[DEPRECATED] Price for Advanced training plan in INR'
example: 15
minimum: 0
deprecated: true
trainingPlanActivePrice:
type: number
description: Price for Active (Easy) training plan in INR (0 for free)
example: 0
minimum: 0
trainingPlanAthletePrice:
type: number
description: Price for Athlete (Medium) training plan in INR
example: 9
minimum: 0
trainingPlanGoatPrice:
type: number
description: Price for GOAT (Tough) training plan in INR (includes chatbot)
example: 15
minimum: 0
trainingPlan2WeeksActivePrice:
type: number
description: Price for Active plan - 2 weeks duration (INR)
example: 0
minimum: 0
trainingPlan2WeeksAthletePrice:
type: number
description: Price for Athlete plan - 2 weeks duration (INR)
example: 9
minimum: 0
trainingPlan2WeeksGoatPrice:
type: number
description: Price for GOAT plan - 2 weeks duration (INR)
example: 15
minimum: 0
trainingPlan4WeeksActivePrice:
type: number
description: Price for Active plan - 4 weeks duration (INR)
example: 4
minimum: 0
trainingPlan4WeeksAthletePrice:
type: number
description: Price for Athlete plan - 4 weeks duration (INR)
example: 19
minimum: 0
trainingPlan4WeeksGoatPrice:
type: number
description: Price for GOAT plan - 4 weeks duration (INR)
example: 29
minimum: 0
trainingPlan8WeeksActivePrice:
type: number
description: Price for Active plan - 8 weeks duration (INR)
example: 9
minimum: 0
trainingPlan8WeeksAthletePrice:
type: number
description: Price for Athlete plan - 8 weeks duration (INR)
example: 39
minimum: 0
trainingPlan8WeeksGoatPrice:
type: number
description: Price for GOAT plan - 8 weeks duration (INR)
example: 59
minimum: 0
trainingPlanMinDaysBeforeEvent:
type: number
description: Minimum days before event to be eligible for training plan
example: 15
minimum: 1
cloudStorageGracePeriodDays:
type: number
description: Days after subscription expiry before cloud data deletion
example: 3
minimum: 1
cloudStorageDataRestoreEnabled:
type: boolean
description: Allow organizers to restore data after soft-deletion
example: true
cloudStorageSettlementHours:
type: number
description: >-
Hours after event completion before image earnings are settled to
organizer
example: 24
minimum: 1
challengeUpdateMode:
type: string
description: >-
Challenge update mode: "single" updates only nearest-expiry
challenge, "multiple" updates all eligible challenges
enum: &ref_701
- single
- multiple
example: multiple
moderationWarningTier2RestrictedFeatures:
description: RestrictableFeature keys applied at warning-ladder tier 2
example: &ref_702
- CREATE_CLUB_POST
type: array
items:
type: string
moderationWarningTier3SuspensionDays:
type: number
description: Suspension length (days) applied at warning-ladder tier 3
example: 7
minimum: 1
moderationWarningTier4Permanent:
type: boolean
description: >-
Whether warning-ladder tier 4 is a permanent ban (true) or another
temporary suspension (false)
example: true
moderationFalseReportStrikeThreshold:
type: number
description: False-report strikes before reporting is temporarily disabled
example: 3
minimum: 1
moderationFalseReportDisableDays:
type: number
description: Days reporting stays disabled once the strike threshold is hit
example: 30
minimum: 1
moderationClubInvestigationWindowDays:
type: number
description: >-
Rolling window (days) used for club auto-investigation report
counting
example: 30
minimum: 1
moderationClubInvestigationThresholdPercent:
type: number
description: >-
Share of ACTIVE members (%) that must uniquely report a club within
the window to auto-trigger UNDER_REVIEW
example: 25
minimum: 1
clubTierCommissionPct:
type: number
description: >-
Global default platform commission (%) taken on paid club tier
subscriptions (CLUB stream). Per-club and per-tier overrides take
precedence over this value.
example: 3
minimum: 0
maximum: 30
sponsorshipGstPct:
type: number
description: >-
GST (%) added on top of the sponsorship amount and charged to the
brand at checkout. Collected and remitted by Repeak; not passed
through to the payee.
example: 18
minimum: 0
maximum: 100
sponsorshipCommissionPct:
type: number
description: >-
Platform commission (%) retained from a sponsorship before settling
the organizer or club (SPONSORSHIP stream).
example: 15
minimum: 0
maximum: 100
sponsorshipSettlementDelayHours:
type: number
description: >-
Hours Repeak holds a sponsorship payment before its settlement
matures to ELIGIBLE. Commercial promise is 48. Capped at 30 days.
example: 48
minimum: 0
maximum: 720
required:
- platformFee
- paymentGatewayFee
UpdateSettingDto:
type: object
properties:
clubDeactivationRefundGraceDays:
type: number
description: >-
Days between Club deactivation and automatic paid-member refunds.
Applies to future deactivations; active grace windows keep their
snapshotted deadline.
example: 15
minimum: 1
maximum: 90
clubCreationTermsContent:
type: string
description: >-
Platform-authored terms a Club owner must accept before creating a
Club. Updating the content publishes a new version automatically.
clubOwnershipTransferConsentDays:
type: number
description: Days User B has to accept a Club ownership-transfer request.
minimum: 1
maximum: 30
default: 7
platformFee:
type: number
description: Platform fee amount
example: 2.5
minimum: 0
paymentGatewayFee:
type: number
description: Payment gateway fee amount
example: 1.5
minimum: 0
platformFeeType:
type: string
description: Type of platform fee (PERCENTAGE or FIXED)
enum: *ref_700
example: percentage
CGST:
type: number
description: Central Goods and Services Tax (CGST) percentage
example: 9
minimum: 0
SGST:
type: number
description: State Goods and Services Tax (SGST) percentage
example: 9
minimum: 0
UTGST:
type: number
description: Union Territory Goods and Services Tax (UTGST) percentage
example: 9
minimum: 0
IGST:
type: number
description: Integrated Goods and Services Tax (IGST) percentage
example: 18
minimum: 0
coinValueInFiat:
type: number
description: The real-life value of 1 coin in fiat currency (e.g. INR)
example: 5
minimum: 0
trainingPlanNormalPrice:
type: number
description: '[DEPRECATED] Price for Normal training plan in INR'
example: 9
minimum: 0
deprecated: true
trainingPlanAdvancedPrice:
type: number
description: '[DEPRECATED] Price for Advanced training plan in INR'
example: 15
minimum: 0
deprecated: true
trainingPlanActivePrice:
type: number
description: Price for Active (Easy) training plan in INR (0 for free)
example: 0
minimum: 0
trainingPlanAthletePrice:
type: number
description: Price for Athlete (Medium) training plan in INR
example: 9
minimum: 0
trainingPlanGoatPrice:
type: number
description: Price for GOAT (Tough) training plan in INR (includes chatbot)
example: 15
minimum: 0
trainingPlan2WeeksActivePrice:
type: number
description: Price for Active plan - 2 weeks duration (INR)
example: 0
minimum: 0
trainingPlan2WeeksAthletePrice:
type: number
description: Price for Athlete plan - 2 weeks duration (INR)
example: 9
minimum: 0
trainingPlan2WeeksGoatPrice:
type: number
description: Price for GOAT plan - 2 weeks duration (INR)
example: 15
minimum: 0
trainingPlan4WeeksActivePrice:
type: number
description: Price for Active plan - 4 weeks duration (INR)
example: 4
minimum: 0
trainingPlan4WeeksAthletePrice:
type: number
description: Price for Athlete plan - 4 weeks duration (INR)
example: 19
minimum: 0
trainingPlan4WeeksGoatPrice:
type: number
description: Price for GOAT plan - 4 weeks duration (INR)
example: 29
minimum: 0
trainingPlan8WeeksActivePrice:
type: number
description: Price for Active plan - 8 weeks duration (INR)
example: 9
minimum: 0
trainingPlan8WeeksAthletePrice:
type: number
description: Price for Athlete plan - 8 weeks duration (INR)
example: 39
minimum: 0
trainingPlan8WeeksGoatPrice:
type: number
description: Price for GOAT plan - 8 weeks duration (INR)
example: 59
minimum: 0
trainingPlanMinDaysBeforeEvent:
type: number
description: Minimum days before event to be eligible for training plan
example: 15
minimum: 1
cloudStorageGracePeriodDays:
type: number
description: Days after subscription expiry before cloud data deletion
example: 3
minimum: 1
cloudStorageDataRestoreEnabled:
type: boolean
description: Allow organizers to restore data after soft-deletion
example: true
cloudStorageSettlementHours:
type: number
description: >-
Hours after event completion before image earnings are settled to
organizer
example: 24
minimum: 1
challengeUpdateMode:
type: string
description: >-
Challenge update mode: "single" updates only nearest-expiry
challenge, "multiple" updates all eligible challenges
enum: *ref_701
example: multiple
moderationWarningTier2RestrictedFeatures:
description: RestrictableFeature keys applied at warning-ladder tier 2
example: *ref_702
type: array
items:
type: string
moderationWarningTier3SuspensionDays:
type: number
description: Suspension length (days) applied at warning-ladder tier 3
example: 7
minimum: 1
moderationWarningTier4Permanent:
type: boolean
description: >-
Whether warning-ladder tier 4 is a permanent ban (true) or another
temporary suspension (false)
example: true
moderationFalseReportStrikeThreshold:
type: number
description: False-report strikes before reporting is temporarily disabled
example: 3
minimum: 1
moderationFalseReportDisableDays:
type: number
description: Days reporting stays disabled once the strike threshold is hit
example: 30
minimum: 1
moderationClubInvestigationWindowDays:
type: number
description: >-
Rolling window (days) used for club auto-investigation report
counting
example: 30
minimum: 1
moderationClubInvestigationThresholdPercent:
type: number
description: >-
Share of ACTIVE members (%) that must uniquely report a club within
the window to auto-trigger UNDER_REVIEW
example: 25
minimum: 1
clubTierCommissionPct:
type: number
description: >-
Global default platform commission (%) taken on paid club tier
subscriptions (CLUB stream). Per-club and per-tier overrides take
precedence over this value.
example: 3
minimum: 0
maximum: 30
sponsorshipGstPct:
type: number
description: >-
GST (%) added on top of the sponsorship amount and charged to the
brand at checkout. Collected and remitted by Repeak; not passed
through to the payee.
example: 18
minimum: 0
maximum: 100
sponsorshipCommissionPct:
type: number
description: >-
Platform commission (%) retained from a sponsorship before settling
the organizer or club (SPONSORSHIP stream).
example: 15
minimum: 0
maximum: 100
sponsorshipSettlementDelayHours:
type: number
description: >-
Hours Repeak holds a sponsorship payment before its settlement
matures to ELIGIBLE. Commercial promise is 48. Capped at 30 days.
example: 48
minimum: 0
maximum: 720
SettlementDto:
type: object
properties:
id:
type: string
description: Settlement ID
settlementType:
type: string
description: Settlement type
enum:
- event
- challenge
- photo
- club
- hybrid_race
- sponsorship
- training_program
- brand_challenge
settlementStatus:
type: string
description: Settlement status
enum:
- pending
- eligible
- processing
- completed
- failed
- on_hold
grossAmount:
type: number
description: Gross amount (total revenue)
ticketRevenue:
type: number
description: Revenue from ticket sales
addOnsRevenue:
type: number
description: Revenue from add-ons
platformFee:
type: number
description: Platform fee
gatewayFee:
type: number
description: Gateway fee
gstAmount:
type: number
description: GST amount
platformFeeGst:
type: number
description: GST on platform fee
netAmount:
type: number
description: Net amount to be paid
participantsCount:
type: number
description: Number of participants
successfulPaymentsCount:
type: number
description: Number of successful payments
completedAt:
format: date-time
type: string
description: Event/challenge completion date
eligibleAt:
format: date-time
type: string
description: Date when settlement becomes eligible
processedAt:
format: date-time
type: string
description: Date when payout was processed
transactionId:
type: string
description: Bank transaction ID
transactionDetails:
type: string
description: Transaction details
failureReason:
type: string
description: Failure reason
holdReason:
type: string
description: Hold reason
remarks:
type: string
description: Admin remarks
commissionPercentage:
type: number
description: Commission percentage used
kycStatus:
type: string
description: KYC status at settlement time
enum:
- pending
- approved
- rejected
- suspended
bankDetailsAvailable:
type: boolean
description: Bank details available at settlement time
settlementBlockedReason:
type: string
description: Reason if settlement is blocked
isProcessable:
type: boolean
description: Is settlement processable
settlementMessage:
type: string
description: Settlement message for organizer
createdAt:
format: date-time
type: string
description: Created at
event:
type: object
description: Event details
challenge:
type: object
description: Challenge details
organizer:
type: object
description: Organizer details
required:
- id
- settlementType
- settlementStatus
- grossAmount
- ticketRevenue
- addOnsRevenue
- platformFee
- gatewayFee
- gstAmount
- platformFeeGst
- netAmount
- participantsCount
- successfulPaymentsCount
- commissionPercentage
- bankDetailsAvailable
- isProcessable
- createdAt
SettlementSummaryDto:
type: object
properties:
totalEarnings:
type: number
description: Total earnings (gross amount)
ticketEarnings:
type: number
description: Earnings from ticket sales
addOnsEarnings:
type: number
description: Earnings from add-ons sales
platformFee:
type: number
description: Platform fee deduction
gstOnPlatformFee:
type: number
description: GST on platform fee (18%)
totalDeductions:
type: number
description: Total deductions
netSettlementAmount:
type: number
description: Net settlement amount to be paid
totalParticipants:
type: number
description: Total number of participants
totalPayments:
type: number
description: Total number of successful payments
required:
- totalEarnings
- ticketEarnings
- addOnsEarnings
- platformFee
- gstOnPlatformFee
- totalDeductions
- netSettlementAmount
- totalParticipants
- totalPayments
AddOnBreakdownDto:
type: object
properties:
name:
type: string
description: Add-on name
quantity:
type: number
description: Quantity purchased
unitPrice:
type: number
description: Unit price
totalPrice:
type: number
description: Total price
required:
- name
- quantity
- unitPrice
- totalPrice
TicketBreakdownDto:
type: object
properties:
ticketName:
type: string
description: Ticket name
ticketPrice:
type: number
description: Ticket price
participantName:
type: string
description: Participant name
required:
- ticketName
- ticketPrice
SettlementPaymentDetailDto:
type: object
properties:
id:
type: string
description: Payment detail ID
userId:
type: string
description: User ID
userName:
type: string
description: User name
userPhone:
type: string
description: User phone number
ticketCount:
type: number
description: Number of tickets
ticketAmount:
type: number
description: Ticket amount
addOnsCount:
type: number
description: Number of add-ons
addOnsAmount:
type: number
description: Add-ons amount
totalAmount:
type: number
description: Total amount paid
paymentId:
type: string
description: Payment reference ID
paymentDate:
format: date-time
type: string
description: Payment date
addOnsBreakdown:
description: Add-ons breakdown
type: array
items:
$ref: '#/components/schemas/AddOnBreakdownDto'
ticketsBreakdown:
description: Tickets breakdown
type: array
items:
$ref: '#/components/schemas/TicketBreakdownDto'
required:
- id
- userId
- userName
- ticketCount
- ticketAmount
- addOnsCount
- addOnsAmount
- totalAmount
KycStatusDto:
type: object
properties:
isKycApproved:
type: boolean
description: Is KYC approved
isBankDetailsAvailable:
type: boolean
description: Are bank details available
canProcess:
type: boolean
description: Can the settlement be processed
blockedReason:
type: string
description: Reason if settlement is blocked
message:
type: string
description: Status message for organizer
required:
- isKycApproved
- isBankDetailsAvailable
- canProcess
- message
SettlementDetailResponseDto:
type: object
properties:
settlement:
description: Settlement data
allOf:
- $ref: '#/components/schemas/SettlementDto'
summary:
description: Settlement summary
allOf:
- $ref: '#/components/schemas/SettlementSummaryDto'
paymentsList:
description: List of payment details per user
type: array
items:
$ref: '#/components/schemas/SettlementPaymentDetailDto'
kycStatus:
description: KYC status
allOf:
- $ref: '#/components/schemas/KycStatusDto'
required:
- settlement
- summary
- paymentsList
- kycStatus
UpdateSettlementDto:
type: object
properties:
settlementStatus:
type: string
description: Settlement status
enum:
- pending
- eligible
- processing
- completed
- failed
- on_hold
transactionId:
type: string
description: Transaction ID from bank transfer
transactionDetails:
type: string
description: Transaction details (JSON string)
failureReason:
type: string
description: Reason for failure (if status is FAILED)
holdReason:
type: string
description: Reason for hold (if status is ON_HOLD)
remarks:
type: string
description: Admin remarks/notes
ProcessSettlementDto:
type: object
properties:
transactionId:
type: string
description: Transaction ID from bank transfer
example: TXN123456789
transactionDetails:
type: string
description: Transaction details (additional info about the transfer)
example: Bank transfer via NEFT
required:
- transactionId
HoldSettlementDto:
type: object
properties:
holdReason:
type: string
description: Reason for putting settlement on hold
example: Pending KYC verification
required:
- holdReason
BaselineDriftDto:
type: object
properties:
confirm:
type: boolean
example: true
expectedCount:
type: number
example: 42
minimum: 0
required:
- confirm
- expectedCount
AcceptDriftDto:
type: object
properties:
reason:
type: string
description: Optional human-readable reason
CreateClubOrganizerAccountDto:
type: object
properties:
club:
$ref: '#/components/schemas/CreateClubDto'
organizer:
$ref: '#/components/schemas/CreateOrganizerIfNotExistsDto'
required:
- club
- organizer
RepairClubOrganizerAccountDto:
type: object
properties:
sourceType:
type: string
enum:
- CLUB
- ORGANIZER
sourceId:
type: string
format: uuid
required:
- sourceType
- sourceId
AIConfigResponseDto:
type: object
properties:
id:
type: string
description: Configuration ID
feature:
type: string
enum:
- training_plan
- chatbot
- plan_adjustment
description: AI feature type
primaryProvider:
type: string
enum:
- openai
- gemini
description: Primary AI provider
fallbackProvider:
type: string
enum:
- openai
- gemini
description: Fallback AI provider
useFallback:
type: boolean
description: Whether fallback is enabled
modelName:
type: string
description: Model name
temperature:
type: number
description: Temperature setting
maxTokens:
type: number
description: Max tokens
description:
type: string
description: Configuration description
additionalConfig:
type: object
description: Additional config
createdAt:
format: date-time
type: string
description: Created at
updatedAt:
format: date-time
type: string
description: Updated at
required:
- id
- feature
- primaryProvider
- useFallback
- temperature
- createdAt
- updatedAt
UpdateAIConfigDto:
type: object
properties:
primaryProvider:
type: string
enum:
- openai
- gemini
description: Primary AI provider to use
example: openai
fallbackProvider:
type: string
enum:
- openai
- gemini
description: Fallback AI provider if primary fails
example: gemini
useFallback:
type: boolean
description: Whether to use fallback provider on failure
example: true
modelName:
type: string
description: Specific model name to use (e.g., gpt-4o, gemini-1.5-pro)
example: gpt-4o
temperature:
type: number
description: Temperature for AI responses (0.0 - 1.0)
example: 0.7
maxTokens:
type: number
description: Maximum tokens for response
example: 8192
description:
type: string
description: Description of this configuration
example: Use OpenAI for training plan generation
additionalConfig:
type: object
description: Additional configuration options
example:
responseFormat: json
required:
- primaryProvider
CreateChallengePromoStoryDto:
type: object
properties:
imageUrl:
type: string
description: Public URL of the challenge cover / poster image.
example: https://assets.repeak.app/challenges/banner.jpg
ctaUrl:
type: string
description: >-
Deep-link CTA URL — typically the athlete-app challenge page. Shown
as a tap-through on the story card.
example: >-
https://app.repeak.app/challenges/019ed50b-0b21-285b-ef28-db5c616c8c37
caption:
type: string
description: >-
Short caption rendered on the story card (max 500 chars). Defaults
to the challenge title if omitted.
example: Join 100 Steps Distance Month and win!
ttlHours:
type: number
description: >-
How long (hours) this promo story stays live. Defaults to 24 h; max
72 h.
default: 24
minimum: 1
maximum: 72
required:
- imageUrl
AcceptChallengeGoodieDto:
type: object
properties:
rankStart:
type: number
example: 1
rankEnd:
type: number
example: 1
RejectChallengeGoodieDto:
type: object
properties:
reason:
type: string
example: Rank 1 is already sponsored
ProposeChallengeGoodieDto:
type: object
properties:
rankStart:
type: number
example: 1
rankEnd:
type: number
example: 3
goodieName:
type: string
example: Branded hydration pack
goodieDescription:
type: string
imageUrl:
type: string
description: Goodie image URL.
quantity:
type: number
example: 1
required:
- goodieName
CreateTicketTypeDto:
type: object
properties:
title:
type: string
description: The title of the ticket type
example: VIP Pass
maxLength: 255
description:
type: string
description: The description of the ticket type
example: Access to VIP area with complimentary drinks
isActive:
type: boolean
description: Whether the ticket type is active
example: true
default: true
required:
- title
UpdateTicketTypeDto:
type: object
properties: {}
CreateTicketTemplateDto:
type: object
properties:
name:
type: string
description: Name of the ticket template
description:
type: string
description: Description of the ticket template
type:
type: string
enum:
- free
- paid
- donation
default: paid
description: Type of ticket
minAge:
type: number
description: Minimum age required for this ticket
minimum: 0
maxAge:
type: number
description: Maximum age allowed for this ticket
minimum: 0
minPerBooking:
type: number
description: Minimum tickets per booking
default: 1
maxPerBooking:
type: number
description: Maximum tickets per booking
default: 1
isActive:
type: boolean
description: Is ticket template active?
default: true
required:
- name
- type
- minPerBooking
- maxPerBooking
UpdateTicketTemplateDto:
type: object
properties: {}
CreateFaqDto:
type: object
properties:
question:
type: string
description: The question
example: What is the event start time?
answer:
type: string
description: The answer
example: The event starts at 9 AM.
isActive:
type: boolean
description: Whether the FAQ is active
example: true
required:
- question
- answer
UpdateFaqDto:
type: object
properties: {}
CreateTermsAndConditionDto:
type: object
properties:
content:
type: string
description: Terms and Conditions content
example: All participants must...
isActive:
type: boolean
description: Is active
example: true
required:
- content
UpdateTermsAndConditionDto:
type: object
properties: {}
CreatePrivacyPolicyDto:
type: object
properties:
content:
type: string
description: Privacy Policy content
example: Your data will be protected...
isActive:
type: boolean
description: Is active
example: true
required:
- content
UpdatePrivacyPolicyDto:
type: object
properties: {}
CrossEventBulkNotifyDto:
type: object
properties: {}
CreatePodcastDto:
type: object
properties:
title:
type: string
example: Tech Talks
description: Title of the podcast
description:
type: string
example: Discussion about the latest tech trends
description: Podcast description
speaker:
type: string
example: John Doe
description: Speaker of the podcast
url:
type: string
example: https://example.com/podcast.mp3
description: Podcast URL
isLive:
type: boolean
example: false
description: Is the podcast live?
default: false
scheduleTime:
format: date-time
type: string
example: '2025-03-08T12:00:00Z'
description: Scheduled time for the podcast
isActive:
type: boolean
example: true
description: Is the podcast active?
default: true
required:
- title
- speaker
- isLive
- isActive
UpdatePodcastDto:
type: object
properties:
title:
type: string
example: Tech Talks
description: Title of the podcast
description:
type: string
example: Discussion about the latest tech trends
description: Podcast description
speaker:
type: string
example: John Doe
description: Speaker of the podcast
url:
type: string
example: https://example.com/podcast.mp3
description: Podcast URL
isLive:
type: boolean
example: false
description: Is the podcast live?
default: false
scheduleTime:
format: date-time
type: string
example: '2025-03-08T12:00:00Z'
description: Scheduled time for the podcast
isActive:
type: boolean
example: true
description: Is the podcast active?
default: true
CreateChallengeTemplateDto:
type: object
properties:
name:
type: string
description: Template name shown in the picker.
description:
type: string
description: Optional short description.
config:
type: object
description: >-
Reusable challenge config snapshot (title/type/target/reward/etc.).
Applied client-side on the create form.
additionalProperties: true
required:
- name
- config
FormFieldCreateDto:
type: object
properties:
label:
type: string
description: Label for UI display
type:
type: string
description: Input type
enum:
- text
- number
- email
- select
- multi_select
- radio
- checkbox
- date
- file
- textarea
- password
- url
- phone
options:
description: Options for select, radio, etc.
type: array
items:
type: string
required:
type: boolean
description: Is this field required?
multiple:
type: boolean
description: Allow multiple values?
defaultValue:
type: string
description: Default value if not filled
placeholder:
type: string
description: Placeholder shown in UI
helpText:
type: string
description: Help/hint text for UI
maxLength:
type: number
description: Input max length for strings
min:
type: number
description: Min value for number/date
max:
type: number
description: Max value for number/date
step:
type: number
description: Step for number/date fields
maxSizeMB:
type: number
description: Max upload size (MB) for files
accept:
description: Accepted MIME types (for files)
type: array
items:
type: string
readOnly:
type: boolean
description: Make field readonly
disabled:
type: boolean
description: Disable field in UI
validation:
type: object
description: Validation rules
required:
- label
- type
ReviewApprovalDto:
type: object
properties:
approvalStatus:
type: string
description: Approval status
enum:
- approved
- rejected
reviewReason:
type: string
description: Reason for approval/rejection (required for rejection)
required:
- approvalStatus
ReviewKycDto:
type: object
properties:
approvalStatus:
type: string
description: Approval status
enum:
- approved
- rejected
reviewReason:
type: string
description: Reason for approval/rejection (required for rejection)
required:
- approvalStatus
CreateDeclarationFormTemplateDto:
type: object
properties:
name:
type: string
description: Name of the declaration form template
example: Standard Declaration Form
description:
type: string
description: Description of the template
example: Declaration form for organizers without GST registration
htmlTemplate:
type: string
description: >-
HTML template with variables. Use {{variable_name}} format for
placeholders.
example: >-
Declaration Form
I, {{organizer_name}}, declare
that...
requiredFields:
description: List of required fields that organizer must fill before downloading
example: &ref_703
- pan_number
- address
- business_registration_number
type: array
items:
type: string
headerLogo:
type: string
description: URL of logo to display in header
example: https://example.com/logo.png
footerText:
type: string
description: Text to display in footer
example: RaceAbove - Your Sports Event Partner
isActive:
type: boolean
description: Whether this template is active
example: true
required:
- name
- htmlTemplate
- requiredFields
UpdateDeclarationFormTemplateDto:
type: object
properties:
name:
type: string
description: Name of the declaration form template
example: Standard Declaration Form
description:
type: string
description: Description of the template
example: Declaration form for organizers without GST registration
htmlTemplate:
type: string
description: >-
HTML template with variables. Use {{variable_name}} format for
placeholders.
example: >-
Declaration Form
I, {{organizer_name}}, declare
that...
requiredFields:
description: List of required fields that organizer must fill before downloading
example: *ref_703
type: array
items:
type: string
headerLogo:
type: string
description: URL of logo to display in header
example: https://example.com/logo.png
footerText:
type: string
description: Text to display in footer
example: RaceAbove - Your Sports Event Partner
isActive:
type: boolean
description: Whether this template is active
example: true
UpdatePayoutScheduleDto:
type: object
properties:
schedule:
type: string
enum:
- WEEKLY
- BIWEEKLY
- MONTHLY
- CUSTOM
description: >-
New payout cadence. CUSTOM signals a non-standard cadence — the
settlement scheduler skips CUSTOM organizers and ops handles them
via the manual-process path (PRD §42.4).
required:
- schedule
RespondToChargebackDto:
type: object
properties:
responseText:
type: string
description: >-
Free-text response narrative. Max 5000 chars; min 10 when
submitting.
minLength: 0
maxLength: 5000
evidenceUrls:
description: External URLs pointing at evidence artifacts. Max 10.
type: array
items:
type: string
submit:
type: boolean
description: Submit (DEFENDED) vs save-as-draft.
default: false
required:
- responseText
PostThreadMessageDto:
type: object
properties: {}
CreateSportDto:
type: object
properties:
name:
type: string
description: Name of the sport
maxLength: 100
example: Running
isActive:
type: boolean
description: Indicates if the sport is active or not
example: true
nullable: true
required:
- name
ReorderSportTaxonomyDto:
type: object
properties:
ids:
description: Complete ordered sibling IDs
type: array
items:
type: string
required:
- ids
CreateSportTopicDto:
type: object
properties:
name:
type: string
example: Trail running
maxLength: 80
description:
type: string
maxLength: 180
orderIndex:
type: number
default: 0
minimum: 0
maximum: 999
isActive:
type: boolean
default: true
required:
- name
UpdateSportTopicDto:
type: object
properties:
name:
type: string
example: Trail running
maxLength: 80
description:
type: string
maxLength: 180
orderIndex:
type: number
default: 0
minimum: 0
maximum: 999
isActive:
type: boolean
default: true
CreateSportSubtopicDto:
type: object
properties:
name:
type: string
example: 5K
maxLength: 80
description:
type: string
maxLength: 180
orderIndex:
type: number
default: 0
minimum: 0
maximum: 999
isActive:
type: boolean
default: true
required:
- name
UpdateSportSubtopicDto:
type: object
properties:
name:
type: string
example: 5K
maxLength: 80
description:
type: string
maxLength: 180
orderIndex:
type: number
default: 0
minimum: 0
maximum: 999
isActive:
type: boolean
default: true
UpdateSportDto:
type: object
properties:
name:
type: string
description: Name of the sport
maxLength: 100
example: Running
isActive:
type: boolean
description: Indicates if the sport is active or not
example: true
nullable: true
CreateGearTypeDto:
type: object
properties:
name:
type: string
description: Name of the gear type
example: Bikes
isActive:
type: boolean
description: Indicates if the gear type is active or not
example: true
required:
- name
UpdateGearTypeDto:
type: object
properties:
name:
type: string
description: Name of the gear type
example: Bikes
isActive:
type: boolean
description: Indicates if the gear type is active or not
example: true
CreateProductDto:
type: object
properties:
name:
type: string
description: Name of the product
example: Premium Popcorn
maxLength: 255
description:
type: string
description: Description of the product
example: Delicious buttered popcorn with extra seasoning
maxLength: 255
price:
type: number
description: Price of the product
example: 150.5
categoryId:
type: string
description: Category ID that this product belongs to
example: 123e4567-e89b-12d3-a456-426614174000
isActive:
type: boolean
description: Whether the product is active
example: true
default: true
required:
- name
- description
- price
- categoryId
UpdateProductDto:
type: object
properties:
name:
type: string
description: Name of the product
example: Premium Popcorn
maxLength: 255
description:
type: string
description: Description of the product
example: Delicious buttered popcorn with extra seasoning
maxLength: 255
price:
type: number
description: Price of the product
example: 150.5
categoryId:
type: string
description: Category ID that this product belongs to
example: 123e4567-e89b-12d3-a456-426614174000
isActive:
type: boolean
description: Whether the product is active
example: true
default: true
CreateProductCategoryDto:
type: object
properties:
name:
type: string
description: Name of the product category
example: Food & Beverages
maxLength: 255
description:
type: string
description: Description of the product category
example: Food and beverage items for the event
maxLength: 500
isActive:
type: boolean
description: Whether the category is active
example: true
default: true
required:
- name
UpdateProductCategoryDto:
type: object
properties:
name:
type: string
description: Name of the product category
example: Food & Beverages
maxLength: 255
description:
type: string
description: Description of the product category
example: Food and beverage items for the event
maxLength: 500
isActive:
type: boolean
description: Whether the category is active
example: true
default: true
CreateFormFieldDto:
type: object
properties:
label:
type: string
description: Label for UI display
type:
type: string
description: Input type
enum:
- text
- number
- email
- select
- multi_select
- radio
- checkbox
- date
- file
- textarea
- password
- url
- phone
options:
description: Options for select, radio, etc.
type: array
items:
type: string
required:
type: boolean
description: Is this field required?
multiple:
type: boolean
description: Allow multiple values?
defaultValue:
type: string
description: Default value if not filled
placeholder:
type: string
description: Placeholder shown in UI
helpText:
type: string
description: Help/hint text for UI
maxLength:
type: number
description: Input max length for strings
min:
type: number
description: Min value for number/date
max:
type: number
description: Max value for number/date
step:
type: number
description: Step for number/date fields
maxSizeMB:
type: number
description: Max upload size (MB) for files
accept:
description: Accepted MIME types (for files)
type: array
items:
type: string
readOnly:
type: boolean
description: Make field readonly
disabled:
type: boolean
description: Disable field in UI
validation:
type: object
description: Validation rules
required:
- label
- type
UpdateFormFieldDto:
type: object
properties: {}
CreateEventCategoriesDto:
type: object
properties:
name:
type: string
description: Name of the event category
description:
type: string
description: Optional description
isActive:
type: boolean
description: Is category active?
required:
- name
UpdateEventCategoriesDto:
type: object
properties: {}
CreateFrequentlyAskedQuestionDto:
type: object
properties:
question:
type: string
description: The question
example: What is the event start time?
answer:
type: string
description: The answer
example: The event starts at 9 AM.
required:
- question
- answer
UpdateFrequentlyAskedQuestionDto:
type: object
properties:
question:
type: string
description: The question
example: What is the event start time?
answer:
type: string
description: The answer
example: The event starts at 9 AM.
TrainingPlanOverviewStatsDto:
type: object
properties:
totalPlans:
type: number
description: Total number of training plans generated
example: 1500
freePlans:
type: number
description: Total number of free plans
example: 1000
paidPlans:
type: number
description: Total number of paid plans
example: 500
totalRevenue:
type: number
description: Total revenue from training plans in INR
example: 25000
activePlans:
type: number
description: Active training plans count
example: 300
completedPlans:
type: number
description: Completed training plans count
example: 1100
cancelledPlans:
type: number
description: Cancelled training plans count
example: 100
required:
- totalPlans
- freePlans
- paidPlans
- totalRevenue
- activePlans
- completedPlans
- cancelledPlans
ProgramLevelStatsDto:
type: object
properties:
programLevel:
type: string
description: Program level
enum:
- active
- athlete
- goat
example: athlete
count:
type: number
description: Number of plans at this level
example: 400
revenue:
type: number
description: Revenue from this program level in INR
example: 7600
percentage:
type: number
description: Percentage of total plans
example: 26.67
required:
- programLevel
- count
- revenue
- percentage
SportTypeStatsDto:
type: object
properties:
sportType:
type: string
description: Sport type
enum:
- running
- cycling
- swimming
- triathlon
- hiking_trekking
example: running
count:
type: number
description: Number of plans for this sport
example: 1200
revenue:
type: number
description: Revenue from this sport type in INR
example: 20000
percentage:
type: number
description: Percentage of total plans
example: 80
required:
- sportType
- count
- revenue
- percentage
DurationStatsDto:
type: object
properties:
duration:
type: string
description: Plan duration
enum:
- 2_weeks
- 4_weeks
- 8_weeks
example: 4_weeks
count:
type: number
description: Number of plans with this duration
example: 800
revenue:
type: number
description: Revenue from this duration in INR
example: 15200
percentage:
type: number
description: Percentage of total plans
example: 53.33
required:
- duration
- count
- revenue
- percentage
MonthlyRevenueDto:
type: object
properties:
month:
type: string
description: Month (YYYY-MM format)
example: 2026-01
plansCount:
type: number
description: Total plans generated in this month
example: 150
revenue:
type: number
description: Revenue for this month in INR
example: 2850
freePlans:
type: number
description: Free plans count
example: 100
paidPlans:
type: number
description: Paid plans count
example: 50
required:
- month
- plansCount
- revenue
- freePlans
- paidPlans
TrainingPlanStatsResponseDto:
type: object
properties:
overview:
description: Overview statistics
allOf:
- $ref: '#/components/schemas/TrainingPlanOverviewStatsDto'
byProgramLevel:
description: Stats by program level
type: array
items:
$ref: '#/components/schemas/ProgramLevelStatsDto'
bySportType:
description: Stats by sport type
type: array
items:
$ref: '#/components/schemas/SportTypeStatsDto'
byDuration:
description: Stats by duration
type: array
items:
$ref: '#/components/schemas/DurationStatsDto'
monthlyRevenue:
description: Monthly revenue breakdown
type: array
items:
$ref: '#/components/schemas/MonthlyRevenueDto'
required:
- overview
- byProgramLevel
- bySportType
- byDuration
- monthlyRevenue
UserTrainingPlanStatsDto:
type: object
properties:
userId:
type: string
description: User ID
example: 01HQXYZ123456789
userName:
type: string
description: User name
example: John Doe
phoneNumber:
type: string
description: User phone number
example: '+919876543210'
email:
type: string
description: User email
example: john@example.com
totalPlans:
type: number
description: Total training plans by this user
example: 5
freePlans:
type: number
description: Free plans count
example: 2
paidPlans:
type: number
description: Paid plans count
example: 3
totalRevenue:
type: number
description: Total revenue from this user in INR
example: 57
activePlans:
type: number
description: Active plans count
example: 1
lastPlanDate:
format: date-time
type: string
description: Last plan created date
example: '2026-01-05T10:30:00Z'
required:
- userId
- userName
- phoneNumber
- totalPlans
- freePlans
- paidPlans
- totalRevenue
- activePlans
- lastPlanDate
UserTrainingPlanListResponseDto:
type: object
properties:
users:
description: List of user training plan stats
type: array
items:
$ref: '#/components/schemas/UserTrainingPlanStatsDto'
totalUsers:
type: number
description: Total number of users with training plans
example: 500
page:
type: number
description: Current page number
example: 1
limit:
type: number
description: Items per page
example: 20
totalPages:
type: number
description: Total pages
example: 25
required:
- users
- totalUsers
- page
- limit
- totalPages
TrainingPlanDetailDto:
type: object
properties:
id:
type: string
description: Training plan ID
example: 01HQXYZ123456789
userId:
type: string
description: User ID
example: 01HQABC987654321
userName:
type: string
description: User name
example: John Doe
userPhone:
type: string
description: User phone number
example: '+919876543210'
eventName:
type: string
description: Event name
example: Mumbai Marathon 2026
eventId:
type: string
description: Event ID
example: 01HQEVT123456789
eventDate:
format: date-time
type: string
description: Event date
example: '2026-02-15'
status:
type: string
description: Plan status
enum:
- active
- completed
- cancelled
- expired
example: active
programLevel:
type: string
description: Program level
enum:
- active
- athlete
- goat
example: athlete
duration:
type: string
description: Plan duration
enum:
- 2_weeks
- 4_weeks
- 8_weeks
example: 4_weeks
sportType:
type: string
description: Sport type
enum:
- running
- cycling
- swimming
- triathlon
- hiking_trekking
example: running
pricePaid:
type: number
description: Price paid in INR
example: 19
isPaid:
type: boolean
description: Whether plan is paid
example: true
paymentId:
type: string
description: Payment ID
example: order_123456
transactionId:
type: string
description: Transaction ID
example: txn_123456
totalDays:
type: number
description: Total days in plan
example: 28
totalWeeks:
type: number
description: Total weeks in plan
example: 4
createdAt:
format: date-time
type: string
description: Plan created date
example: '2026-01-05T10:30:00Z'
required:
- id
- userId
- userName
- userPhone
- eventName
- eventDate
- status
- programLevel
- duration
- sportType
- isPaid
- totalDays
- totalWeeks
- createdAt
TrainingPlanListResponseDto:
type: object
properties:
plans:
description: List of training plans
type: array
items:
$ref: '#/components/schemas/TrainingPlanDetailDto'
total:
type: number
description: Total number of training plans
example: 1500
page:
type: number
description: Current page number
example: 1
limit:
type: number
description: Items per page
example: 20
totalPages:
type: number
description: Total pages
example: 75
required:
- plans
- total
- page
- limit
- totalPages
ModerationActionDto:
type: object
properties:
reason:
type: string
description: Reason for the action (audit trail).
UpdateEventStatusDto:
type: object
properties:
status:
type: string
enum:
- draft
- pending_review
- published
- open
- closing_soon
- closed
- in_progress
- live
- completed
- cancelled
- postponed
- suspended
description: >-
New event status. Admin may set: published, suspended, cancelled,
postponed, draft, pending_review.
reason:
type: string
description: Reason for the override (for the audit trail).
required:
- status
RestoreCancelledEventDto:
type: object
properties:
reason:
type: string
description: Why the cancelled event is being restored to published.
minLength: 3
maxLength: 500
required:
- reason
ReplaceEventUuidDto:
type: object
properties:
newEventId:
type: string
description: The new UUID to assign to the event.
confirmCurrentEventId:
type: string
description: Current event UUID, entered again as explicit confirmation.
reason:
type: string
description: Operational reason for replacing the UUID.
minLength: 10
maxLength: 500
required:
- newEventId
- confirmCurrentEventId
- reason
SuspendEventDto:
type: object
properties:
reason:
type: string
description: Why the event is being suspended (required).
minLength: 3
maxLength: 1000
required:
- reason
UpdateEditionStatusDto:
type: object
properties:
status:
type: string
enum:
- draft
- published
- live
- completed
- cancelled
description: New edition status.
reason:
type: string
description: Reason for the override (audit trail).
required:
- status
CreateBadgeRequestDto:
type: object
properties:
badgeName:
type: string
example: Half Marathon Hero
description:
type: string
example: Awarded for completing a half marathon distance.
criteria:
type: string
example: Complete 21.1km cumulative distance within the challenge window.
category:
type: string
example: Distance
challengeId:
type: string
description: Challenge this request was raised from, if any.
required:
- badgeName
- description
- criteria