Documentation

Achievements

Create achievement

Log a win or milestone for a key result

ProductionStagingUAT
POSThttps://ankiren.com/api/me/okr/key-results/{id}/achievements

Parameters

Path Parameters

  • idintegerpathRequired

    Key result ID

Request Body

Bắt buộc.

  • titlestringRequired

    Achievement title

  • descriptionstring

    Optional detailed description

  • achievedAtstring<date-time>

    When the achievement occurred

    format: date-time
application/json
{
  "title": "Completed first 10km run",
  "description": "string",
  "achievedAt": "2026-01-01T00:00:00.000Z"
}

Responses

201 · Achievement created

  • achievementOkrAchievement
    • idinteger
    • keyResultIdinteger
    • userIdstring
    • titlestring
    • descriptionstring?
    • achievedAtstring<date-time>?
      format: date-time
    • createdAtstring<date-time>
      format: date-time
application/json
{
  "achievement": {
    "id": 0,
    "keyResultId": 0,
    "userId": "string",
    "title": "string",
    "description": "string",
    "achievedAt": "2026-01-01T00:00:00.000Z",
    "createdAt": "2026-01-01T00:00:00.000Z"
  }
}

Sample Code

Đổi ngôn ngữ ở ô Language trên thanh Documentation.

cURL
curl -X POST 'https://ankiren.com/api/me/okr/key-results/{id}/achievements' \
  -H 'Authorization: Bearer <token>' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "title": "Completed first 10km run",
  "description": "string",
  "achievedAt": "2026-01-01T00:00:00.000Z"
}'