Basic Info
Description
Updates the community linked to the provided partner API key.
This endpoint supports partial updates. Send only the fields that need to be changed. The
target community ID is resolved from the API key, so no communityID path parameter is required.
Headers
| Name | Value |
|---|---|
| Authorization | Bearer |
| Content-Type | application/json |
Request Body
{
"name": "Returning AI Community",
"uri": "returning-ai-community",
"domain": "community.returning.ai"
}
Body Schema
| Field | Type | Required | Description |
|---|---|---|---|
| name | string | No | Community display name. |
| uri | string | No | Community URI slug. |
| domain | string | No | Community custom domain. |
200 Response Example
{
"meta": {
"status": "success",
"statusCode": 200
},
"message": "Update community success.",
"data": {
"_id": "6502c9e514a3e564c5c09c0a",
"name": "Returning AI Community",
"uri": "returning-ai-community",
"domain": "community.returning.ai",
"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. |
| 409 | Community name, URI, or domain already exists. |
| 502 | Upstream service is temporarily unavailable. |
| 500 | Internal server error. |
What it is for: Updates the community display name and URL slug.
How to use it: Send a PUT request to /management/communities/6502c9e514a3e564c5c09c0a 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.
curl --location --request PUT 'https://api.returning.ai/management/communities/6502c9e514a3e564c5c09c0a' \
--header 'Content-Type: application/json' \
--data '{
"name": "TR5-new1-Sep",
"uri": "TR5"
}'{}