PUT/spaces/api/v1/requiredreading/spaces/{spaceID}/pages/{pageID}/status.json

Updates the users read state of a page.

Updating a users read status can either set it to read or unread.

Path Params

  • Name
    spaceID
    Type
    integer
    required
    Description
  • Name
    pageID
    Type
    integer
    required
    Description

Body Params

    • Name
      requiredReading
      Type
      object
      Description
      ReadUpdate is used to update a users read status.

    Responses

    • Code
      200
      Type
      object
      Schema
      Description
      200 OK
    • Code
      400
      Type
      object
      Schema
      Description
      400 Bad Request
    • Code
      500
      Type
      object
      Schema
      Description
      500 Internal Server Error

    Examples

    200 OK

    Read
    {
      "requiredReading": {
        "latestVersion": 0,
        "readVersion": 0,
        "state": "read"
      }
    }