Organization API: Customer Portal: Community

Part of Customer Portal.

GET /api/v1/orgs/{org_slug}/portal/community/forum/me

The signed-in member as the forum chrome sees them: handle, role, unread followed threads, and the open report count for staff.

Also the one request a member who only reads makes with their token, so ensure_profile stamping them present here is what keeps Active … ago honest for somebody who never posts; the storefront asks again when its copy is a few minutes old.

POST /api/v1/orgs/{org_slug}/portal/community/forum/moderation/members/{handle}/role

application/json (required)

POST /api/v1/orgs/{org_slug}/portal/community/forum/moderation/members/{handle}/suspend

application/json (required)

GET /api/v1/orgs/{org_slug}/portal/community/forum/moderation/reports

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

Close a report, optionally acting on what it pointed at.

The action and the closing are one request, so the queue cannot end up with a removed post and a report still open against it. Nor can it end up the other way round, which is worse: a dismissed report and content nobody looked at.

application/json (required)

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

Pin, lock, move or mark a thread as a duplicate.

The duplicate marker is the one that matters for search: it takes the newer thread out of the index and leaves the older one holding the ranking, which is the opposite of what happens if you simply delete the repost.

application/json (required)

PUT /api/v1/orgs/{org_slug}/portal/community/forum/posts/{post_id}

application/json (required)

DELETE /api/v1/orgs/{org_slug}/portal/community/forum/posts/{post_id}

POST /api/v1/orgs/{org_slug}/portal/community/forum/posts/{post_id}/react

application/json (required)

POST /api/v1/orgs/{org_slug}/portal/community/forum/posts/{post_id}/vote

application/json (required)

POST /api/v1/orgs/{org_slug}/portal/community/forum/reports

application/json (required)

GET /api/v1/orgs/{org_slug}/portal/community/forum/subscriptions

Threads the member follows, with how many posts they have not seen.

POST /api/v1/orgs/{org_slug}/portal/community/forum/subscriptions/read

POST /api/v1/orgs/{org_slug}/portal/community/forum/threads

application/json (required)

PUT /api/v1/orgs/{org_slug}/portal/community/forum/threads/{thread_id}

application/json (required)

DELETE /api/v1/orgs/{org_slug}/portal/community/forum/threads/{thread_id}

POST /api/v1/orgs/{org_slug}/portal/community/forum/threads/{thread_id}/bump

POST /api/v1/orgs/{org_slug}/portal/community/forum/threads/{thread_id}/posts

application/json (required)

POST /api/v1/orgs/{org_slug}/portal/community/forum/threads/{thread_id}/solution

Accept a reply as the answer.

The reference forum has no such thing, which is why its question boards are thousands of pages that end without one. An accepted answer is the single strongest signal in the relevance score, and the only one that promotes a thread into the assistant-facing export.

DELETE /api/v1/orgs/{org_slug}/portal/community/forum/threads/{thread_id}/solution

POST /api/v1/orgs/{org_slug}/portal/community/forum/threads/{thread_id}/subscription

DELETE /api/v1/orgs/{org_slug}/portal/community/forum/threads/{thread_id}/subscription

Stop following, idempotently. The toggle is wrong for a list of Unfollow buttons, where a double click would follow again.

GET /api/v1/orgs/{org_slug}/portal/community/guides/articles

POST /api/v1/orgs/{org_slug}/portal/community/guides/articles

application/json (required)

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

PUT /api/v1/orgs/{org_slug}/portal/community/guides/articles/{article_id}

application/json (required)

DELETE /api/v1/orgs/{org_slug}/portal/community/guides/articles/{article_id}

The author removing their own guide, whatever state it is in.

A hard delete, on purpose: the author is withdrawing something they wrote, and a row kept around "archived" would still be theirs to find in the library and staff's to stumble over in the queue. Revisions, review history, comments, votes, reports and notifications go with it. The rows are removed in dependency order rather than left to the cascades, because the two article→revision keys were added best-effort and may not exist on an older database.

GET /api/v1/orgs/{org_slug}/portal/community/guides/articles/{article_id}/diff

POST /api/v1/orgs/{org_slug}/portal/community/guides/articles/{article_id}/proposal/withdraw

POST /api/v1/orgs/{org_slug}/portal/community/guides/articles/{article_id}/propose

application/json (required)

GET /api/v1/orgs/{org_slug}/portal/community/guides/moderation

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

Publish a guide's pending proposal as a customer moderator.

The optional note goes to the author in a notification and an email. Send revision_id (the proposed revision you read) to be refused with 409 when the author replaced it meanwhile. Answers the new proposal_status.

application/json

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

Reject a guide's pending proposal as a customer moderator.

reason (3 to 1000 characters) goes to the author. The author may still edit the guide and submit it again. Send revision_id to be refused with 409 when the proposal changed since you read it.

application/json (required)

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

Ask the author of a pending proposal to change it, as a customer moderator.

note (3 to 1000 characters) says what to change. The proposal stays on the guide for the author to edit and submit again. Send revision_id to be refused with 409 when the proposal changed since you read it.

application/json (required)

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

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

application/json (required)

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

Close a report. Without this the queue only ever grew.

GET /api/v1/orgs/{org_slug}/portal/community/guides/notifications

POST /api/v1/orgs/{org_slug}/portal/community/guides/notifications/{notification_id}/read

GET /api/v1/orgs/{org_slug}/portal/community/media

The signed-in member's newest images, and how much of their space they use.

Answers items (the 24 newest images the member added, each with url, preview, width, height, bytes and used), used_bytes, quota_bytes, max_upload_mb and uploads_enabled.

POST /api/v1/orgs/{org_slug}/portal/community/media

Store an image the signed-in member uploads, and answer with its path.

purpose says where it goes: guide_image or guide_cover for a guide, forum_image for a thread, reply or wall post, forum_avatar or forum_banner for their profile. The file is a PNG, JPEG, WebP or GIF of at most the organization's max_upload_mb (10 by default). It is decoded and stored again as WebP, without its camera metadata. Refused with a code the storefront translates: uploads_off when that feature takes no images, suspended for a member suspended or muted in the forum, rate_limited past the hourly or daily limit, quota when the member's images already fill their space, too_large, too_many_pixels or not_an_image for the file itself, blocked for a file the site's staff removed before, and storage_unavailable (503) while storage cannot take it. The same file added twice is one image, except an avatar or banner, which is each member's own.

multipart/form-data (required)

POST /api/v1/orgs/{org_slug}/portal/community/media/link

Copy the image at a link into the organization's storage.

The platform fetches url once (http or https, public addresses only, at most three redirects) and stores it the way an upload is stored, so the image keeps working when the other site deletes it. The answer is the same as an upload's. A link that does not open an image, or that the other site refuses, answers 422 with code link_failed and a detail saying why. The member's upload limits count links too.

application/json (required)

DELETE /api/v1/orgs/{org_slug}/portal/community/media/{token}

Delete one of the member's images that no saved guide, post or profile uses.

Frees its space. An image something already uses stays, and answers 409 with code in_use; the member removes it from that content first, and the site's staff can remove any image. Another member's image, or one already gone, answers 404.

POST /api/v1/orgs/{org_slug}/portal/community/members/{handle}/wall

application/json (required)

GET /api/v1/orgs/{org_slug}/portal/community/profile

PUT /api/v1/orgs/{org_slug}/portal/community/profile

application/json (required)

DELETE /api/v1/orgs/{org_slug}/portal/community/wall/comments/{comment_id}

DELETE /api/v1/orgs/{org_slug}/portal/community/wall/{wall_post_id}

POST /api/v1/orgs/{org_slug}/portal/community/wall/{wall_post_id}/comments

application/json (required)