rewards

Milestones Create Create

View as Markdown
Admin only view to create milestones

Request

This endpoint expects an object.
titlestringRequired<=255 characters
descriptionstringRequired
iconstringRequiredformat: "uri"
period_numberintegerRequired-2147483648-2147483647

Period number (day, week, month, etc.)

yearintegerRequired-2147483648-2147483647
Year for this milestone
milestone_typeenumOptional
  • 1 - Daily
  • 2 - Weekly
  • 3 - Monthly
  • 4 - Quarterly
  • 5 - Yearly
  • 6 - Custom
priorityenumOptional
  • 1 - Low
  • 2 - Medium
  • 3 - High
  • 4 - Urgent
Allowed values:
statusenumOptional
  • 1 - Active
  • 2 - Inactive
  • 3 - Archived
Allowed values:
deleted_atdatetime or nullOptional
is_activebooleanOptional
created_bystring or nullOptional<=255 characters
updated_bystring or nullOptional<=255 characters
deleted_bystring or nullOptional<=255 characters
is_recurringbooleanOptional
Whether this milestone repeats
start_datedate or nullOptional
Start date for custom milestones
end_datedate or nullOptional
End date for custom milestones
pointsintegerOptional-2147483648-2147483647
Points awarded for completing this milestone

Response

idintegerRead-only
uidstringRead-onlyformat: "uuid"
created_atdatetimeRead-only
updated_atdatetimeRead-only
titlestring<=255 characters
descriptionstring
iconstringformat: "uri"
period_numberinteger-2147483648-2147483647

Period number (day, week, month, etc.)

yearinteger-2147483648-2147483647
Year for this milestone
milestone_typeenum
  • 1 - Daily
  • 2 - Weekly
  • 3 - Monthly
  • 4 - Quarterly
  • 5 - Yearly
  • 6 - Custom
priorityenum
  • 1 - Low
  • 2 - Medium
  • 3 - High
  • 4 - Urgent
Allowed values:
statusenum
  • 1 - Active
  • 2 - Inactive
  • 3 - Archived
Allowed values:
deleted_atdatetime or null
is_activeboolean
created_bystring or null<=255 characters
updated_bystring or null<=255 characters
deleted_bystring or null<=255 characters
is_recurringboolean
Whether this milestone repeats
start_datedate or null
Start date for custom milestones
end_datedate or null
End date for custom milestones
pointsinteger-2147483648-2147483647
Points awarded for completing this milestone