Returning.AIDevelopers
v1

API reference / Legacy / Channels

.md

Update channel

Update channel

Last updated 26 Sep 2026API v1

Method
PUT
Path
https://api.returning.ai/channels/{id}

Authentication#

Header
Authorization: Bearer <API_KEY>

Behaviour#

Legacy category

This endpoint is retained for compatibility, historical admin tooling, or test workflows. Do not use it as the default choice for new integrations unless the backend team confirms this exact route is still supported for your community.

What it is for

Update channel.

How to use it

Send a PUT request to /channels/{id} with the documented body, query parameters, headers, or multipart fields. Prefer the newer authenticated /v1/... integration API where available.

Successful response

HTTP 2xx. Older endpoints may return a legacy response envelope or a resource-specific payload rather than the newer { status, message, data } wrapper.

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 route or target resource was not found. Several legacy root routes return 404 on https://api.returning.ai; confirm with Returning.AI before using them.
  • 409 duplicate or conflicting state for create/update operations, where applicable.
  • 500 unexpected Returning.AI service error.
Legacy status

Compatibility endpoint retained for older integrations. Do not use this endpoint for new integrations unless Returning.AI specifically tells you to maintain a legacy flow. Prefer the current /v1/... endpoint in the matching non-Legacy category when one exists.

Request#

Path parameters#

id#stringREQUIRED
Resource ID. For bulk update status/details this should be the bulk job ObjectId.

Eg67d04e05f090d20ae5342121

Headers#

Authorization#stringREQUIRED
API key.

RuleBearer <API_KEY>

x-api-key#stringREQUIRED
Legacy server API key header. Prefer Authorization: Bearer <API_KEY> for /v1/... integration APIs.

Eg<API_KEY>

Content-Type#stringREQUIRED
Request body format.

Ruleapplication/json

Body#

topic#stringREQUIRED

Eg"Chit Chat"

channelType#stringREQUIRED

Eg"forum"

curl --request PUT \
  --url 'https://api.returning.ai/channels/<id>' \
  --header 'Authorization: Bearer <API_KEY>' \
  --header 'Content-Type: application/json' \
  --data '{
    "topic": "Chit Chat",
    "channelType": "forum"
  }'

Response#

meta#objectALWAYS

Eg{ ... }

success#booleanALWAYS

Egtrue

message#stringALWAYS

Eg"Channel has been updated successfully"

devMessage#stringALWAYS

Eg"Channel has been updated successfully"

body#objectALWAYS

Eg{ ... }

_id#stringALWAYS

Eg"{_id}"

permissions#string[]ALWAYS

Eg[]

userId#stringALWAYS

Eg"1"

serverId#stringALWAYS

Eg"{_id}"

channelType#stringALWAYS

Eg"open"

createdAt#stringALWAYS

Eg"2024-07-25T16:50:17.610Z"

updatedAt#stringALWAYS

Eg"2024-07-25T16:53:27.739Z"

__v#integerALWAYS

Eg0

title#stringALWAYS
{
  "meta": {
    "success": true,
    "message": "Channel has been updated successfully",
    "devMessage": "Channel has been updated successfully"
  },
  "body": {
    "_id": "{_id}",
    "topic": "Report",
    "permissions": [],
    "userId": "1",
    "serverId": "{_id}",
    "channelType": "open",
    "createdAt": "2024-07-25T16:50:17.610Z",
    "updatedAt": "2024-07-25T16:53:27.739Z",
    "__v": 0
  }
}

Errors#

Fix the request03

400Fix the request
Invalid request. Check required parameters, body fields, file format, pagination values, and ObjectId values.
401Fix the request
Missing, invalid, expired, or insufficient API key/token. Older permission middleware may also return 401 for missing permissions.
403Fix the request
The API key is valid but is not allowed to access this community, channel, user, or resource.

Fix the data01

404Fix the data
The requested resource, route, community, channel, user, API key, status, or job was not found.

Retry with backoff01

500Retry with backoff
Unexpected Returning.AI service error.
{
  "status": "fail",
  "message": "Invalid request. Check required parameters, body fields, file format, pagination values, and ObjectId values."
}

Next step#

Delete channelDELETE/channels/{id}