Forgive

Forgives a failed assessment attempt, marking it as passed regardless of the learner's original score

Forgives a failed assessment attempt, marking it as passed regardless of the learner's original score.

PUThttps://example.thoughtindustries.com/incoming/v2/assessmentAttempts/:id/forgive

Example request

curl -X PUT "https://example.thoughtindustries.com/incoming/v2/assessmentAttempts/:id/forgive" \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{}'

Parameters

Name	Type	Required	Location	Description
`id`	`uuid`	Yes	path	The unique identifier of the assessment attempt to forgive.

Example response

{
  "id": "00000000-0000-0000-0000-000000000000",
  "user": {
    "id": "00000000-0000-0000-0000-000000000000",
    "email": "string",
    "firstName": "string",
    "lastName": "string",
    "externalCustomerId": "00000000-0000-0000-0000-000000000000"
  },
  "course": {
    "id": "00000000-0000-0000-0000-000000000000",
    "title": "string"
  },
  "assessment": {
    "id": "00000000-0000-0000-0000-000000000000",
    "type": "string",
    "title": "string"
  },
  "grade": 0,
  "passed": true,
  "forgiven": true
}

Response fields

Field	Type	Description
`id`	`uuid`	Unique identifier of the assessment attempt.
`user`	`User`	User who made the attempt.
`user.id`	`uuid`	Unique identifier of the user.
`user.email`	`string`	Email address of the user.
`user.firstName`	`string`	First name of the user.
`user.lastName`	`string`	Last name of the user.
`user.externalCustomerId`	`uuid`	External customer identifier associated with the user.
`course`	`Course`	Course the assessment attempt belongs to.
`course.id`	`uuid`	Unique identifier of the course.
`course.title`	`string`	Title of the course.
`assessment`	`Assessment`	Assessment the attempt belongs to.
`assessment.id`	`uuid`	Unique identifier of the assessment.
`assessment.type`	`string`	Type of the assessment.
`assessment.title`	`string`	Title of the assessment.
`grade`	`integer`	Grade recorded for the attempt.
`passed`	`boolean`	Indicates whether the attempt passed.
`forgiven`	`boolean`	Indicates whether the attempt was forgiven.