Skip to main content
PATCH
/
goals
/
{studentId}
/
subjects
/
{subject}
Update a learner-facing subject goal
curl --request PATCH \
  --url https://api.alpha-1edtech.ai/goals/{studentId}/subjects/{subject} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{}'
{
  "subject": {
    "subject": "<string>",
    "baseline": {
      "goalId": "<string>",
      "dailyTargetXP": 123,
      "defaultDailyTargetXP": 123,
      "startDate": "<string>",
      "updatedAt": "<string>"
    },
    "goal": {
      "id": "<string>",
      "startDate": "<string>",
      "updatedAt": "<string>",
      "objective": {
        "value": "<string>"
      },
      "pacing": {
        "endDate": "<string>",
        "dailyTargetXP": 123
      }
    },
    "execution": {
      "stageId": "<string>",
      "courseIds": [
        "<string>"
      ]
    },
    "computed": {
      "xp": {
        "total": 123,
        "earned": 123,
        "remaining": 123,
        "pctComplete": 123
      },
      "pace": {
        "requiredDailyXP": 123,
        "effectiveDailyXP": 123,
        "schoolDaysRemaining": 123
      },
      "projection": {
        "currentGrade": "<string>",
        "daysToNextGrade": 123,
        "gradeTimeline": [
          {
            "grade": "<string>",
            "remainingXP": 123,
            "daysToComplete": 123,
            "projectedDate": "<string>",
            "totalXP": 123,
            "earnedXP": 123,
            "courseIds": [
              "<string>"
            ]
          }
        ]
      },
      "resolution": {
        "resolvedTargetGrade": "<string>",
        "targetRit": 123
      },
      "issue": {
        "message": "<string>",
        "service": "<string>",
        "path": "<string>",
        "status": 123
      }
    }
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.timeback.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

studentId
string
required

Student sourcedId

subject
string
required

Subject identifier

Body

application/json
objective
object
pacing
object

Response

Subject goal updated

subject
object
required