User-related API environment

Production user-related API docs

These pages describe the Production user-related API stack.

Use production OAuth credentials, production API base URLs, and production app URLs when following this documentation.

Need to test before going live? Switch to the Pre-live docs using the environment switcher above.

Hide a comment

Hide a comment or reply on a post owned by the authenticated user. A hidden root comment also hides its reply thread from other viewers.

Path Parameters

id number required

Unique numeric comment ID to hide

Header Parameters

x-auth-token string required

Authenticated user access token for the documented /v1 route.

Responses

• 200
• 400
• 401
• 404

---

Comment hidden

application/json

Schema

Example (from schema)

hidden

---

Schema

hidden boolean required

Whether the post owner has hidden the comment

{
  "hidden": true
}

Comment hidden by the post owner

{
  "hidden": true
}

Authenticated user does not own the post

application/json

Schema

Example (from schema)

forbidden

---

Schema

success boolean required
name string required
error object required
code string required
message string required
details object nullable

{
  "success": false,
  "name": "string",
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  }
}

User does not own the post

{
  "success": false,
  "name": "ActionNotAllowed",
  "error": {
    "code": "ActionNotAllowed",
    "message": "You can't perform this action now please refresh"
  }
}

User not authenticated

Comment is deleted, already hidden, or unavailable

application/json

Schema

Example (from schema)

unavailable

---

Schema

success boolean required
name string required
error object required
code string required
message string required
details object nullable

{
  "success": false,
  "name": "string",
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  }
}

Comment changed before the action completed

{
  "success": false,
  "name": "COMMENT_NOT_AVAILABLE",
  "error": {
    "code": "COMMENT_NOT_AVAILABLE",
    "message": "This comment is no longer available.",
    "details": {}
  }
}

Loading...