Show or hide a document on the public profile
PATCH
/org-admin/{slug}/documents/{docId}/public-visibility
Sets the document's public-visibility flag. The public profile (GET /organizations/{id}/documents/public) lists a document only when it is both flagged public and approved, so the flag can be set ahead of review.
Requires permission: org.upload_documents
Authorizations
BearerAuth
In the browser, authentication rides on the httpOnly session cookies set by /cognito/signin or the Google / Apple sign-in at /cognito/oauth/{provider}. For scripts and for Swagger UI testing, paste an API key (fh_live_…, created with POST /api-keys); a Cognito JWT is accepted too. Sign-in does not return a token in its body.
Type
HTTP (bearer)
Parameters
Path Parameters
slug*
The organization's slug (not its UUID).
Type
Requiredstring
Example
"local-food-bank-a1b2c3"Pattern
"^[a-z0-9][a-z0-9-]{0,254}$"docId*
A non-UUID answers 404 Document not found.
Type
Requiredstring
Format
"uuid"Request Body
application/json
JSON
{
"is_publicly_visible": true
}
Responses
Visibility updated
application/json
JSON
{
"data": {
"id": "string",
"is_publicly_visible": true
}
}