Milestones Create Create | AISquare Studio

curl -X POST /api/v1/rewards/milestones/create/ \
     -H "Content-Type: application/json" \
     -d '{
  "title": "Quarterly Sales Target",
  "description": "Achieve the sales target for Q2 2024",
  "icon": "https://example.com/icons/sales-target.png",
  "period_number": 2,
  "year": 2024
}'

{
  "id": 1024,
  "uid": "a3f1c9e2-7b4d-4f8a-9c2e-5d6b7e8f9a01",
  "created_at": "2024-01-15T09:30:00Z",
  "updated_at": "2024-01-15T09:30:00Z",
  "title": "Quarterly Sales Target",
  "description": "Achieve the sales target for Q2 2024",
  "icon": "https://example.com/icons/sales-target.png",
  "period_number": 2,
  "year": 2024,
  "milestone_type": 4,
  "priority": 3,
  "status": 1,
  "deleted_at": "2024-06-01T00:00:00Z",
  "is_active": true,
  "created_by": "admin_user",
  "updated_by": "admin_user",
  "deleted_by": "system",
  "is_recurring": false,
  "start_date": "2024-04-01",
  "end_date": "2024-06-30",
  "points": 500
}

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

* `1` - Daily * `2` - Weekly * `3` - Monthly * `4` - Quarterly * `5` - Yearly * `6` - Custom

priorityenumOptional

1 - Low
2 - Medium
3 - High
4 - Urgent

* `1` - Low * `2` - Medium * `3` - High * `4` - Urgent

Allowed values:

statusenumOptional

1 - Active
2 - Inactive
3 - Archived

* `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

* `1` - Daily * `2` - Weekly * `3` - Monthly * `4` - Quarterly * `5` - Yearly * `6` - Custom

priorityenum

1 - Low
2 - Medium
3 - High
4 - Urgent

* `1` - Low * `2` - Medium * `3` - High * `4` - Urgent

Allowed values:

statusenum

1 - Active
2 - Inactive
3 - Archived

* `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