Module: Community Bot
Base path: /community-bot
Community ID is resolved from the API key token. Do not send communityID in path or body.
Auth:
Authorization: Bearer <api_key_token>
Required API key permission: appearance
PUT /community-bot
Update community bot configuration.
Supports partial updates. Send only the fields you want to change.
Request body schema:
| Field | Type | Required | Description |
|---|---|---|---|
| name | string | No | Bot display name |
| avatar | string | null | No |
What it is for: Updates the community bot profile used in the community UI.
How to use it: Send a PUT request to /community-bot 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/community-bot' \
--header 'Content-Type: application/json' \
--data '{
"name": "server bot edited",
"avatar": "https://d1qp7obm8na1ru.cloudfront.net/57ef33a0-3896-11f1-95a3-399026424a57_appearance.webp"
}'{}