Update community URL metadata

escription

Updates community meta settings for appearance-related public access and link preview behavior.

This endpoint supports partial updates. Send only the fields that need to be changed. Omitted
fields remain unchanged.

The request is authenticated with a community API key. The API key must include the
appearance permission.

Path Params

Name	Type	Required	Description
communityID	string	Yes	Community ID. Must be a valid MongoDB ObjectId.

Headers

Name	Value
Authorization	Bearer
Content-Type	application/json

Request Body

{
"preview": {
"isEnabled": true,
"title": "Returning AI Community",
"description": "Join our community and explore AI-powered trading tools.",
"image": "https://example.com/preview-image.png"
},
"membersListVisible": true,
"guestModeEnabled": false
}

Body Schema

Field	Type	Required	Description
preview	object	No	Link preview settings.
preview.isEnabled	boolean	No	Whether preview is enabled.
preview.title	string	No	Preview title.
preview.description	string	No	Preview description.
preview.image	string | null	No	Preview image URL.
membersListVisible	boolean	No	Whether the community members list is visible.
guestModeEnabled	boolean	No	Whether guest mode access is enabled.

200 Response Example

{
"meta": {
"status": "success",
"statusCode": 200
},
"message": "Update community meta success.",
"data": {
"_id": "6502c9e514a3e564c5c09c0b",
"communityID": "6502c9e514a3e564c5c09c0a",
"preview": {
"isEnabled": true,
"title": "Returning AI Community",
"description": "Join our community and explore AI-powered trading tools.",
"image": "https://example.com/preview-image.png"
},
"membersListVisible": true,
"guestModeEnabled": false,
"createdAt": "2026-04-28T00:00:00.000Z",
"updatedAt": "2026-04-28T00:00:00.000Z"
}
}

Error Responses

Status	Description
400	Invalid input.
401	Invalid or missing API key.
403	API key does not have appearance permission.
404	Community not found.
502	Upstream service is temporarily unavailable.
500	Internal server error.

---

What it is for: Updates SEO/social metadata for the community URL.
How to use it: Send a PUT request to /apis/communities/6502c9e514a3e564c5c09c0a/meta with the request body, query parameters, or multipart fields shown below. Community administration access required. These endpoints are for configuring a community, not for end-user browser calls.
Availability note: source code exposes community appearance through service routes such as /communities/:communityID/appearance; confirm the public gateway route before external use.
Successful response: HTTP 200. The body follows the endpoint schema; many integration endpoints wrap the useful payload under data with status and message.
Common error states:

• 400 invalid request body, query, ObjectId, pagination, file format, or missing required field.
• 401 missing, invalid, expired, or insufficient API key/token.
• 403 key is valid but cannot access this community/channel/user/resource, where supported by the service.
• 404 target resource, route, or community-scoped record was not found.
• 409 duplicate or conflicting state for create/update operations, where applicable.
• 500 unexpected Returning.AI service error.

Source-backed clarification:
Appearance configuration controls community branding rather than user content. Source-backed model includes theme palettes, branding assets, splash images, loading animation settings, and call-to-action settings. The modern service source owns GET /communities/:communityID/appearance and PUT /communities/:communityID/appearance; the routes shown here may be compatibility/admin-facing variants resolved from the API key.