Update community bot profile

PUT

/community-bot

Update community bot profile

Updates the bot profile for the community associated with the bearer API key. No community ID is sent in the path or body.

This endpoint supports partial updates.

Request body

Field	Type	Required	Nullable	Description
name	string	No	No	Bot display name. Maximum 32 characters.
avatar	string	No	Yes	Bot avatar URL. Send null to clear the avatar.

Authentication: Authorization: Bearer <api-key>

A successful update returns HTTP 200.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Body Params application/jsonRequired

Examples

Responses

🟢200OK

application/json

Request completed successfully.

Bodyapplication/json

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found

🔴500Server Error

Request Example

Shell

JavaScript

Java

Swift

curl --location --request PUT 'https://api.returning.ai/v1/community-bot' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "name": "server bot edited",
    "avatar": "https://d1qp7obm8na1ru.cloudfront.net/57ef33a0-3896-11f1-95a3-399026424a57_appearance.webp"
}'

Response Example

200 - Example 1

{
    "meta": {
        "status": "string",
        "statusCode": 0
    },
    "message": "string",
    "data": {
        "property1": "string",
        "property2": "string"
    }
}

Modified at 2026-08-09 18:40:44

Update community theme colors

Update community URL metadata

Update community bot profile