Community

Reviews

Update or Create a Review

put

Create or update a user's review for a resource. You cannot create multiple reviews for a single user on a resource. If a user tries to create a second review on a resource it will just update their first review. You must provide a textual review, rating, or both. A 200 status code is returned upon a successful update and a 201 status code is returned on successful creation.

Example:

  curl -X PUT -H "X-Session-ID: 0123456789" -H "Content-Type:application/json" --data @data.json "https://lor.instructure.com/api/resources/9cd972bef89b9fc7de6357a473f845db/reviews/self"
  data.json:
  {
    "body": "I find your lack of faith disturbing",
    "rating": 1
  }
Authorizations
Path parameters
resourceIdstringRequired

The id of the resource to review

Body
bodystring · min: 1 · max: 1000Optional

The text of the review

ratinginteger · min: 1 · max: 5Optional

A numerical quality rating to give to the resource

Responses
200
Review updated successfully
application/json
put
PUT /api/resources/{resourceId}/reviews/self HTTP/1.1
Host: lor.instructure.com
x-session-id: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 58

{
  "body": "I find your lack of faith disturbing",
  "rating": 1
}
{
  "body": "text",
  "createDate": "2025-06-30T21:44:13.128Z",
  "resourceId": "text",
  "rating": 1,
  "updateDate": "2025-06-30T21:44:13.128Z",
  "userAvatarUrl": "text",
  "userFullName": "text",
  "userId": "text",
  "voteCount": 1
}

Get a Review

get

Get a review for the resource that was authored by the current user.

Example:

  curl -X GET -H "X-Session-ID: 0123456789" "https://lor.instructure.com/api/resources/9cd972bef89b9fc7de6357a473f845db/reviews/self"
Authorizations
Path parameters
resourceIdstringRequired

The id of the resource to get the review for

Responses
200
Review found
application/json
get
GET /api/resources/{resourceId}/reviews/self HTTP/1.1
Host: lor.instructure.com
x-session-id: YOUR_API_KEY
Accept: */*

{
  "body": "text",
  "createDate": "2025-06-30T21:44:13.128Z",
  "resourceId": "text",
  "rating": 1,
  "updateDate": "2025-06-30T21:44:13.128Z",
  "userAvatarUrl": "text",
  "userFullName": "text",
  "userId": "text",
  "voteCount": 1
}

Destroy Review by This User

delete

Destroy a user's review for this resource.

Example:

  curl -X DELETE -H "X-Session-ID: 0123456789" "https://lor.instructure.com/api/resources/9cd972bef89b9fc7de6357a473f845db/reviews/self"
Authorizations
Path parameters
resourceIdstringRequired

The id of the resource to delete the review for

Responses
204
Review deleted successfully
delete
DELETE /api/resources/{resourceId}/reviews/self HTTP/1.1
Host: lor.instructure.com
x-session-id: YOUR_API_KEY
Accept: */*

No content

List Reviews for a Resource

get

List reviews for the specified resource.

curl -H "X-Session-ID: 0123456789" "https://lor.instructure.com/api/resources/0123456789/reviews?cursor=abcdefg"

Authorizations
Path parameters
resourceIdstringRequired

The id of the resource to list reviews for

Query parameters
cursorstringOptional

An identifier from a prior query to continue retrieving results for

Responses
200
List of reviews for a resource
application/json
get
GET /api/resources/{resourceId}/reviews HTTP/1.1
Host: lor.instructure.com
x-session-id: YOUR_API_KEY
Accept: */*

{
  "items": [
    {
      "body": "text",
      "createDate": "2025-06-30T21:44:13.128Z",
      "resourceId": "text",
      "rating": 1,
      "updateDate": "2025-06-30T21:44:13.128Z",
      "userAvatarUrl": "text",
      "userFullName": "text",
      "userId": "text",
      "voteCount": 1
    }
  ],
  "meta": {
    "cursor": "text"
  }
}
PreviousResourcesNextSession

Last updated

Was this helpful?