Name & Uri
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. |
Request
Responses
curl --location --request PUT 'https://api.returning.ai/v1/management/communities/6502c9e514a3e564c5c09c0a' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"name": "TR5-new1-Sep",
"uri": "TR5"
}'{}