Skip to main content
PATCH
/
ap-readiness
/
goals
/
{goalId}
Update an AP readiness goal
curl --request PATCH \
  --url https://api.alpha-1edtech.ai/ap-readiness/goals/{goalId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "courseIds": [
    "<string>"
  ],
  "practiceTestCourseIds": [
    "<string>"
  ],
  "endDate": "<string>"
}
'
{
  "goal": {
    "sourcedId": "<string>",
    "status": "active",
    "dateLastModified": "<string>",
    "studentSourcedId": "<string>",
    "subject": "AP Biology",
    "goalType": "<string>",
    "targetValue": "<string>",
    "targetMetric": "<string>",
    "paceType": "<string>",
    "startDate": "<string>",
    "endDate": "<string>",
    "goalStatus": "active",
    "goalCreatedAt": "<string>",
    "courseIds": [
      "<string>"
    ],
    "metadata": {
      "practice_test_course_ids": [
        "<string>"
      ]
    },
    "curriculumCourseIds": [
      "<string>"
    ]
  }
}

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

​
goalId
string
required

AP readiness goal sourcedId

Body

application/json
​
courseIds
string[]

Replace full list of curriculum course IDs

Minimum array length: 1
Minimum string length: 1
​
practiceTestCourseIds
string[]

Replace full list of practice test course IDs

Minimum string length: 1
​
endDate
string

Update AP exam date

Pattern: ^\d{4}-\d{2}-\d{2}$

Response

AP readiness goal updated

​
goal
object
required