Sendbird/inviteAsMembers

Online calls unavailable · details below

SendbirdSendbird Chat Platform server-side API v3

POST/v3/group_channels/{channel_url}/invite

Invite users as members

Invites one or more users as members to the group channel identified by channel_url. Invited users join immediately without accepting the invitation; configure invitation preferences if users should be able to accept or decline.

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
inviteAsMembers
Server
https://api-{app_id}.sendbird.com
Authentication
apiTokenAuth

Request parameters

channel_url

pathstringrequired

Channel URL.

group_channel_123

Request body

InviteAsMembersRequest

Properties: hidden_statusinvitation_statusinviter_iduser_ids

Responses

200

InviteAsMembersResponseapplication/json

Request succeeded.

Properties: channel_urlcount_preferencecover_urlcreated_atcreated_bycustom_typedatadelivery_receiptdisappearing_messagefreezehas_ai_bothas_bothidden_stateignore_profanity_filterinvited_atinviteris_access_code_requiredis_broadcastis_discoverableis_distinctis_ephemeralis_exclusiveis_hiddenis_mutedis_publicis_push_enabledis_superjoined_member_countjoined_tslast_messagemax_length_messagemember_countmember_statemembersmessage_survival_secondsmetadatamy_rolenameoperatorspush_trigger_optionread_receiptsms_fallbackts_message_offsetunread_mention_countunread_message_countuser_last_read

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",
  "count_preference": "false",
  "cover_url": "https://example.com/avatar.png",
  "created_at": 1,
  "custom_type": "default",
  "data": "{\"key\":\"value\"}"
}