Update a community channel

Update a channel. Every field is optional and independent — omit a field to leave it unchanged; send only what you want to change. Changing mangoes, badges, excludeMangoes, excludeBadges, or visibility triggers an asynchronous refresh of the channel's member list — access changes may take a moment to fully propagate, not apply instantly. Changing features to add or remove messages creates or archives the channel's chat room accordingly (archiving, not deleting — turning messages back on later reuses the same room). See each field's own description for further per-field behavior, including known quirks worth knowing before you rely on this endpoint to clear a value back to blank, or to move an id from an include list to its matching exclude list in one call.

Fails with a 400 if name is given as an empty string, if features is given as an empty array, if this update would leave both mangoes and badges empty, if any id appears in both an include and its matching exclude list (including the case where the include list is being cleared to [] in the same request — see mangoes's own description), or if communityProfilePicture is given without communityProfilePictureType, or if the Community feature is not enabled for this creator. Fails with a 404 if the channel, group, or any mango/badge id given, does not belong to this creator.

Authorization

bearer

AuthorizationBearer <token>

In: header

Header Parameters

x-whitelabel-host*string

Host name of the dashboard, ex: mydomain.tagmango.com

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name?string

New name for the channel. Omit to leave unchanged. If given, must be non-empty — this endpoint rejects an empty string outright rather than silently ignoring it (the internal service's own behavior, which this deliberately tightens for a clearer contract).

description?string

New description for the channel. Omit to leave unchanged. An empty string is accepted by validation but has no effect — the internal update silently ignores it, so there's currently no way to clear the description back to blank via this endpoint.

group?object

Move the channel into a different group. Must already exist and belong to this creator. Omit to leave the channel in its current group.

mangoes?array<>|

Replace the mangoes whose subscribers can access this channel. Omit to leave unchanged; an empty array genuinely clears it (unlike name/description above); an explicit null is treated the same as an empty array, not as an error. Rejected with a 400 if this update would leave both mangoes and badges empty — the same "at least one" rule enforced at creation applies here too. Known quirk: clearing this to [] in the same request that adds one of the just-cleared ids to excludeMangoes is rejected with "You cannot include and exclude the same mango!", even though the two lists never actually overlap once persisted — the overlap check compares against the channel's pre-update mangoes for this specific combination. Split it into two requests instead: clear mangoes first, then add to excludeMangoes in a follow-up call.

badges?array<>|

Replace the badges whose holders can access this channel. See mangoes — omit to leave unchanged, an empty array genuinely clears it, and the combined result can't leave both mangoes and badges empty. The same known quirk documented on mangoes applies here too, for badges/excludeBadges.

excludeMangoes?array<>|

Replace the mangoes specifically excluded from access. Omit to leave unchanged; an empty array clears the exclusion list entirely. See mangoes for a known quirk when adding an id here in the same request that clears it out of mangoes.

excludeBadges?array<>|

Replace the badges specifically excluded from access. Omit to leave unchanged; an empty array clears the exclusion list entirely. See mangoes for a known quirk when adding an id here in the same request that clears it out of badges.

visibility?string

Change who can see that the channel exists. Omit to leave unchanged. public, members_only, or hidden — see the create-channel endpoint for what each one means.

Value in"public" | "hidden" | "members_only"

features?array<>

Replace which capabilities the channel has. Omit to leave unchanged. If given, must include at least one value, same as at creation. Turning messages off archives the channel's chat room (not deleted — turning it back on later un-archives the same room); turning messages on for a channel that never had it creates a new chat room.

communityProfilePicture?string

New channel icon. Omit to leave unchanged. An empty string is accepted by validation but has no effect, same as description. See the create-channel endpoint for the image/emoji distinction — a fresh image URL is registered automatically here too.

communityProfilePictureType?string

Required together with communityProfilePicture when that field is given; ignored otherwise.

Value in"emoji" | "image"

featureSettings?

Per-feature settings. Omitting this whole object leaves every current setting unchanged. If given, feed and messages are each independently replaced whole — omitting one of them from this object leaves that one untouched, but including the other means everything under it (down to the individual sharing toggles) is taken exactly as given, not merged with what was there before; anything left out inside it reverts to off, the same as at creation.

Response Body

`application/json`

curl -X PATCH "https://api-prod-new.tagmango.com/api/v1/external/community/channel-groups/channels/{channelId}" \  -H "x-whitelabel-host: string" \  -H "Content-Type: application/json" \  -d '{}'

{
  "creator": "61e97c146cf2b4d8c68f3a41",
  "visibility": "public",
  "communityProfilePicture": "https://example.com/image.jpg",
  "communityProfilePictureType": "image",
  "featureSettings": {
    "feed": {
      "allowMemberPosts": true
    },
    "messages": {
      "allowEveryoneToMessage": true,
      "allowPeerToPeerMessaging": true,
      "sharingControlSettings": {
        "allowFileSharing": true,
        "allowPhotoSharing": true,
        "allowVideoSharing": true,
        "allowAudioSharing": true,
        "allowPollSharing": true
      }
    }
  },
  "chatRoom": "61e97c146cf2b4d8c68f3a44",
  "_id": "61e97c146cf2b4d8c68f3a40",
  "name": "General",
  "description": "General discussion for all members",
  "features": [
    "feed"
  ],
  "archived": false,
  "createdAt": "2026-01-01T00:00:00.000Z",
  "updatedAt": "2026-01-01T00:00:00.000Z",
  "mangoes": [],
  "badges": [],
  "excludeMangoes": [
    "string"
  ],
  "excludeBadges": [
    "string"
  ],
  "groups": [
    "61e97c146cf2b4d8c68f3a40"
  ]
}

{
  "code": 400,
  "type": "Bad Request",
  "statusMessage": "BAD_REQUEST",
  "success": false,
  "message": "Invalid request",
  "result": "Invalid request"
}

{
  "code": 401,
  "type": "Unauthorized",
  "statusMessage": "UNAUTHORIZED",
  "message": "Invalid token",
  "result": "Invalid token",
  "success": false
}

{
  "code": 403,
  "type": "Forbidden",
  "statusMessage": "FORBIDDEN",
  "errorCode": "WORKSHOP_MANGO_FORBIDDEN",
  "message": "You can not access this api with a TagMango account, only available for whitelabel hosts",
  "result": "You can not access this api with a TagMango account, only available for whitelabel hosts",
  "success": false
}

{
  "code": 429,
  "type": "Too Many Requests",
  "statusMessage": "TOO_MANY_REQUESTS",
  "message": "Request limit exceeded. try after 10 seconds",
  "result": "Request limit exceeded. try after 10 seconds",
  "success": false
}

Update a community channel

Authorization

Header Parameters

Request Body

Response Body

200application/json

400application/json

401application/json

403application/json

429application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`