Moderation API reference

Moderation endpoints of the Quackback REST API: paths, parameters, request fields and responses.

JM
James Morton
Written By James MortonLast updated 3 days ago

This is the reference for the Moderation endpoints of the Quackback REST API: every endpoint, its parameters, request fields and response fields. It is generated from the API's OpenAPI description, so it matches what the API accepts.

All paths are relative to /api/v1 on your workspace's address (for example https://feedback.example.com/api/v1). Authenticate with an API key in the Authorization: Bearer qb_... header. For keys, errors, pagination and rate limits, see API overview. Every workspace also serves an interactive reference at /api/v1/docs.

Endpoints

  • GET /moderation/pending: List pending moderation items
  • POST /moderation/posts/{postId}/approve: Approve a post
  • POST /moderation/posts/{postId}/reject: Reject a post
  • POST /moderation/comments/{commentId}/approve: Approve a comment
  • POST /moderation/comments/{commentId}/reject: Reject a comment

List pending moderation items

GET /api/v1/moderation/pending

Returns posts and comments awaiting review. Requires a team-role API key.

Response 200: returns posts, comments.

Approve a post

POST /api/v1/moderation/posts/{postId}/approve

Publish a pending post (pending → published).

Parameters

Name

In

Type

Required

Description

postId

path

string

Yes

Post ID

Response 200: returns ok.

Reject a post

POST /api/v1/moderation/posts/{postId}/reject

Soft-delete a pending post (restoring returns it to the queue).

Parameters

Name

In

Type

Required

Description

postId

path

string

Yes

Post ID

Request body

Field

Type

Required

Description

reason

string

No

Optional rejection reason

Response 200: returns ok.

Approve a comment

POST /api/v1/moderation/comments/{commentId}/approve

Publish a pending comment (pending → published).

Parameters

Name

In

Type

Required

Description

commentId

path

string

Yes

Comment ID

Response 200: returns ok.

Reject a comment

POST /api/v1/moderation/comments/{commentId}/reject

Soft-delete a pending comment (restoring returns it to the queue).

Parameters

Name

In

Type

Required

Description

commentId

path

string

Yes

Comment ID

Request body

Field

Type

Required

Description

reason

string

No

Optional rejection reason

Response 200: returns ok.

Was this helpful?

Your feedback shapes what we write next.