Sendbird/joinAChannel

Online calls unavailable · details below

SendbirdSendbird Chat Platform server-side API v3

PUT/v3/group_channels/{channel_url}/join

Join a public group channel

Lets a user join a public group channel identified by channel_url; only channels with is_public set to true can be joined this way. A single user can join up to 2,000 group channels and cannot join a new one once at capacity.

Manage users, group channels, open channels, messages, metadata, moderation, bots, and announcements through the official Sendbird Chat Platform API v3. The complete boundary is the 83 REST endpoints reconstructed from a pinned official generated SDK revision; client realtime protocols and Chat SDKs are not part of this collection. Application data is the caller's private content, so Pontx does not proxy, cache, or aggregate it and callers use the local SDK/CLI directly.

Request

operationId
joinAChannel
Server
https://api-{app_id}.sendbird.com
Authentication
apiTokenAuth

Request parameters

channel_url

pathstringrequired

Channel URL.

group_channel_123

Request body

JoinAChannelRequest

Properties: access_codeuser_id

Responses

200

SendbirdGroupChannelDetailapplication/json

Request succeeded.

Properties: channelchannel_urlcover_urlcreated_atcreated_bycustom_typedatadelivery_receiptdisappearing_messagefreezehas_ai_bothas_botidignore_profanity_filteris_access_code_requiredis_broadcastis_discoverableis_distinctis_ephemeralis_publicis_superjoined_member_countlast_messagemax_length_messagemember_countmembersmessage_survival_secondsnameoperatorsread_receiptsms_fallbackunread_mention_countunread_message_count

400

SendbirdApiErrorapplication/json

Request parameters are invalid.

Properties: codemessage

401

SendbirdApiErrorapplication/json

Unauthenticated or the API token is invalid.

Properties: codemessage

403

SendbirdApiErrorapplication/json

Access to the resource is forbidden.

Properties: codemessage

404

SendbirdApiErrorapplication/json

The requested resource was not found.

Properties: codemessage

429

SendbirdApiErrorapplication/json

Rate limited; retry later.

Properties: codemessage

500

SendbirdApiErrorapplication/json

Upstream internal error.

Properties: codemessage

{
  "channel_url": "group_channel_123",
  "cover_url": "https://example.com/avatar.png",
  "created_at": 1,
  "created_by": {
    "is_active": true,
    "is_blocked_by_me": true,
    "nickname": "Alice",
    "profile_url": "https://example.com/avatar.png",
    "require_auth_for_profile_image": true,
    "role": "none",
    "user_id": "user_id_123"
  },
  "custom_type": "default",
  "data": "{\"key\":\"value\"}",
  "delivery_receipt": {}
}