Skip to main content
PUT
/
api
/
user
/
history
/
{id}
Update a history record
curl --request PUT \
  --url https://pria.praxislxp.com/api/user/history/{id} \
  --header 'Content-Type: application/json' \
  --header 'x-access-token: <api-key>' \
  --data '
{
  "favorite": true,
  "forgotten": false,
  "favorite_name": "Deployment Guide",
  "course_name": "<string>",
  "thumbUpDown": "up"
}
'
{
  "success": true,
  "data": {},
  "message": "History updated!"
}

Authorizations

​
x-access-token
string
header
required

JWT token passed in x-access-token header

Path Parameters

​
id
string
required

The ObjectId of the history record to update

Body

application/json

Accepts any properties to update on the history document. Common fields include favorite and forgotten, but any valid history field is accepted.

​
favorite
boolean

Whether to mark the history item as favorite

Example:

true

​
forgotten
boolean

Whether to soft-delete the dialogue from history

Example:

false

​
favorite_name
string

Custom name for a favorited record

Example:

"Deployment Guide"

​
course_name
string

Update the course name for this record

​
thumbUpDown
string

User feedback on the response

Example:

"up"

Response

History record successfully updated

​
success
boolean

Whether the operation was successful

Example:

true

​
data
object

The full updated history document

​
message
string

Status message

Example:

"History updated!"