Organization API: Org Staff Community

Base URL: https://api.coritan.com/api/v1. Paths below are complete.

To try these requests in the browser, open the interactive Organization API reference.

GET /api/v1/orgs/{org_slug}/staff/community/forum/reports

The report queue. quarantined is what Tier 1 hid and Tier 2 has to decide on; each row names the member behind the reported content and whether they are muted.

POST /api/v1/orgs/{org_slug}/staff/community/forum/reports/{report_id}/mute

Mute the member behind a report in the forum and community chat.

Tiers 1 and 2 may mute for up to a week; Tier 3 for up to a year. A mute already running longer is left as it is. The report stays where it is, so the content can still be quarantined or dismissed.

application/json (required)

POST /api/v1/orgs/{org_slug}/staff/community/forum/reports/{report_id}/quarantine

Take the reported post or thread off the forum until Tier 2 decides.

It is marked quarantined and soft-deleted, so every reader that hides deleted content hides it with nothing else to change; restoring undoes both. The report, and any other open report on the same content, waits in the quarantine queue.

application/json

POST /api/v1/orgs/{org_slug}/staff/community/forum/reports/{report_id}/remove

Delete the reported post or thread, quarantined or still up, and close every report on it. It stays in the database for the record, marked removed, and leaves every list and the search index.

POST /api/v1/orgs/{org_slug}/staff/community/forum/reports/{report_id}/resolve

Close a report without touching what it pointed at. A quarantined report is Tier 2's to decide; restore or remove closes it.

application/json (required)

POST /api/v1/orgs/{org_slug}/staff/community/forum/reports/{report_id}/restore

Put quarantined content back: the report was not worth acting on.

POST /api/v1/orgs/{org_slug}/staff/community/forum/threads/{thread_id}/flags

Pin, lock or hide a thread. Hiding soft-deletes it: the posts stay for the record and the thread leaves every list and the search index.

application/json (required)

POST /api/v1/orgs/{org_slug}/staff/community/guides/articles/{article_id}/approve

Publish the guide's pending proposal.

revision_id is the proposed revision you read and note an optional message (up to 1000 characters) for the author, who gets it in a notification and an email. 409 when the author replaced the proposal since you opened it, or when nothing is waiting. Answers the new proposal_status.

application/json (required)

POST /api/v1/orgs/{org_slug}/staff/community/guides/articles/{article_id}/reject

Reject the guide's pending proposal.

reason (3 to 1000 characters) goes to the author in a notification and an email. The author may still edit the guide and submit it again. 409 when the proposal changed since you opened it, or when nothing is waiting.

application/json (required)

POST /api/v1/orgs/{org_slug}/staff/community/guides/articles/{article_id}/request-changes

Ask the author to change the guide's pending proposal.

note (3 to 1000 characters) says what to change and goes to the author in a notification and an email. The proposal stays on the guide for the author to edit and submit again. 409 when the proposal changed since you opened it, or when nothing is waiting.

application/json (required)

GET /api/v1/orgs/{org_slug}/staff/community/guides/articles/{article_id}/review

Everything a reviewer needs to decide on a guide, in one answer.

proposed is the revision waiting for review and live the published one (null for a new guide, where is_new is true). Both carry the rendered, sanitized body_html and the table of contents. field_diff lists the fields that differ, body_diff the lines of the body as equal, insert or delete (empty for a new guide), and reviews the earlier decisions, newest first. 404 for a guide that is not this brand's. Send proposed_revision_id back as revision_id when you decide, so a decision never lands on a version you did not read.

POST /api/v1/orgs/{org_slug}/staff/community/guides/comments/{comment_id}/approve

POST /api/v1/orgs/{org_slug}/staff/community/guides/comments/{comment_id}/reject

application/json (required)

GET /api/v1/orgs/{org_slug}/staff/community/guides/moderators

POST /api/v1/orgs/{org_slug}/staff/community/guides/moderators

application/json (required)

DELETE /api/v1/orgs/{org_slug}/staff/community/guides/moderators/{customer_id}

GET /api/v1/orgs/{org_slug}/staff/community/guides/queue

POST /api/v1/orgs/{org_slug}/staff/community/guides/reports/{report_id}/resolve

GET /api/v1/orgs/{org_slug}/staff/community/listings

Every public server listing the brand's customers made, including the unpublished, the ones staff hid and the ones held for review.

PATCH /api/v1/orgs/{org_slug}/staff/community/listings/{listing_id}

Hide a listing from the public list (the customer's own switch stays as they set it), or (Tier 3) feature it at the top. Hiding or showing a held listing is the decision the hold waited for, so it ends the hold.

application/json (required)

DELETE /api/v1/orgs/{org_slug}/staff/community/listings/{listing_id}

Delete a listing and its ratings. Its owner may list the server again from scratch; one that should stay down is hidden instead. The audit row keeps what the listing said.

POST /api/v1/orgs/{org_slug}/staff/community/listings/{listing_id}/hold

Take a listing off the public list until Tier 2 looks at it. The reason is what the reviewer, and the listing's owner, read.

application/json (required)

POST /api/v1/orgs/{org_slug}/staff/community/listings/{listing_id}/release

The hold was not warranted: the listing goes back as its owner left it.

GET /api/v1/orgs/{org_slug}/staff/community/summary