Sendbird

Duration in seconds to hide previous messages. Required if hide_existing_messages is true.

List of User IDs to add to the channel.

URL-encoded identifier of the target group channel.

Whether to hide previous messages for new members.

Data from the action execution

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

Duration of the ban in seconds. If omitted, ban is permanent.

ID of the user to ban from the channel.

ID of the admin or moderator performing the ban.

URL-encoded identifier of the group channel to ban the user from.

Reason for the ban in moderation records.

Data from the action execution

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

Custom data for the channel

Name of the channel

True for strict creation; fails if channel exists

True to create a supergroup channel

List of user IDs to invite to the channel (max 100)

URL of the channel cover image

True to create a public channel

Binary content of the cover image for multipart upload

Access code for private channels

Custom URL of the channel; autogenerated if omitted

Custom type identifier for the channel

True to create a distinct channel

True to create an ephemeral channel

List of user IDs to assign as operators

Custom fields object

True to list the channel in search results

True to send system notifications for channel events

Message retention period in seconds

Data from the action execution

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

Unique identifier for the new user

Arbitrary key/value pairs for custom user data

Display name of the user

Whether the user is active upon creation

URL for the user's profile image

User's phone number, E.164 format recommended

Binary content of the user's profile image; use for multipart upload

List of discovery keys for the user

Indicates if the user has ever logged in before

Whether to generate an access token for the user

User's preferred language codes

Data from the action execution

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

The unique URL of the group channel to delete. Example: 'sendbird_group_channel_1234567890abcdef'

Data from the action execution

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

Unique ID of the message to delete; must be a non-negative integer

URL identifier of the group channel containing the message

Data from the action execution

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

Unique ID of the user to delete.

Whether to permanently delete the user and all associated data.

Data from the action execution

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

The unique ID of the user.

URL (identifier) of the group channel.

Data from the action execution

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

Unique ID of the user to fetch channel counts for.

Filter by super or non-super channels, or all.

Filter by public or private channels, or all.

List of custom channel types to filter by.

Return count of distinct, nondistinct channels, or all.

Data from the action execution

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

Unique ID of the user whose unread counts are to be retrieved.

Data from the action execution

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

The unique ID of the user to issue a session token for.

Optional token expiration timestamp in Unix milliseconds. If omitted, the default token lifetime is used.

Data from the action execution

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

Unique ID of the user who will leave group channels.

List of group channel URLs to leave. Ignored if `should_leave_all` is true.

Whether to leave all joined group channels. If true, `channel_urls` is ignored.

Data from the action execution

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

Number of banned members to return per page (1-100). Default is 10.

Pagination token from previous response; omit for first request.

Unique URL of the group channel to list banned members from.

Data from the action execution

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

Filter channels by channel name

Number of results per page (1-100)

Pagination token to retrieve the next page

Whether to include empty channels in the results

Filter by super channel type: all, super, or nonsuper

Filter by public channel type: all, public, or private

Whether to include frozen channels in the results

Filter channels by exact URLs

Filter channels by custom types

Filter channels whose URL contains this substring

List channels created after this timestamp (in milliseconds)

Filter by distinct channel type: all, distinct, or nondistinct

Whether to include channel metadata

List channels created before this timestamp (in milliseconds)

Filter by member state: all, joined_only, invited_only, invited_by_friend, or invited_by_non_friend

Filter channels by member nickname

Whether to include read receipt data

List of user IDs who must all be members of the channel

List of user IDs one of whom must be a member of the channel

Whether to include delivery receipt data

Filter channels whose custom type starts with this prefix

Data from the action execution

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

Maximum number of results to return (1-100)

Sorting order of members list

Pagination token for fetching the next page

Number of results to skip before returning the set (deprecated; use token instead)

Unique URL of the group channel

Filter by operator status

Filter by membership state

Filter by muted status of members

Search members whose nicknames start with this string

Data from the action execution

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

Maximum number of operators to return per page (1-100).

Pagination cursor from a previous call; omit for the first request.

Custom channel type to list operators for.

Data from the action execution

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

Number of operators to return per page (1-100). Default is 10.

Pagination token from previous response; omit for first page

URL of the group channel to retrieve operators from

Data from the action execution

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

Maximum number of operators to return per page (1-100).

Pagination cursor from a previous response; omit for the first request.

URL-encoded unique identifier of the open channel to list operators for.

Data from the action execution

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

Number of users to return per page (1-100). Default is 10.

Sort order: nickname_alphabetical, created_at, or user_id_alphabetical.

Pagination token from previous response; omit for first request.

Exact nickname to filter (case-insensitive substring match).

List of user IDs to filter; sent as comma-separated string.

Filter users by their active status.

Custom type to filter users by.

Metatag key to filter users who have this key.

List of metatag values to filter; requires `metatag_key`.

Substring filter for nicknames (case-insensitive).

Filter users by whether they have ever logged in.

Data from the action execution

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

Unique ID of the user whose messages will be marked as read.

Data from the action execution

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

Mute duration in seconds (0 = indefinite)

ID of the user to mute

URL-encoded identifier of the target group channel

Custom description for the mute action

Data from the action execution

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

Custom channel type identifier

List of user IDs to register as operators (at least one)

Data from the action execution

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

List of user IDs to register as operators

URL-encoded identifier of the group channel

Data from the action execution

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

List of user IDs to register as operators (at least one)

URL-encoded identifier of the open channel

Data from the action execution

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

Unique ID of the user whose session tokens will be revoked.

Data from the action execution

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

Unique ID of the message.

URL-encoded identifier of the group channel.

Whether to include sorted_metaarray arrays in the response.

Custom message data.

Type of the message (MESG, FILE, ADMIN).

User who sent the message.

Error if any occurred during the execution of the action

Open graph metadata if present.

Text content of the message.

List of reactions.

Creation timestamp (ms).

Unique ID of the message.

Whether or not the action execution was successful or not

Update timestamp (ms).

URL of the group channel.

Custom message type.

Thread information if applicable.

Mention type.

Translated texts keyed by language.

Parent message details if threaded.

Users mentioned in the message.

Sorted metadata array.

The unique ID of the user to retrieve.

Data from the action execution

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

Free-form custom data string (often JSON)

Text content of the message. Required when message_type is 'MESG'

Attach an existing poll by its ID

Sender's user ID. Required unless using API token as acting user

Send as silent message (no push notifications)

Array of metadata objects

URL-encoded identifier of the target group channel

Custom message type for classification

Mention scope: 'users' to mention specific users or 'channel' to mention all

Type of message: 'MESG' for text, 'FILE' for file, 'ADMM' for admin message

Reply in a thread to the message with this ID

List of user IDs to mention when mention_type is 'users'

Mark as operator (moderator) message

List of language codes for auto-translation, e.g., ['en', 'es']

Push notification option: 'default', 'suppress', or 'include_offline_user'

Custom data payload

Type of the message

Sender user information

Error if any occurred during the execution of the action

Whether the message is silent

Text content of the message

Timestamp (ms) when message was created

Unique message ID

Whether or not the action execution was successful or not

Timestamp (ms) when message was last updated

URL of the group channel where message was sent

Custom message type

Thread details when message has replies.

Mention type used in the message

Auto-translation results for this message

Whether this is an operator message

Parent message ID if it's a reply

List of user IDs mentioned in the message

The URL of the group channel from which to unban the user.

The unique ID of the banned user to unban.

Data from the action execution

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

URL-encoded identifier of the group channel to unmute the user in.

User ID to unmute from the channel.

Data from the action execution

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

List of user IDs to unregister as operators.

Custom channel type to target. Example: 'my_custom_type'

Data from the action execution

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

The unique ID of the user.

URL identifier of the group channel.

The user's count preference for the channel: one of 'all', 'unread_message_count_only', 'mention_count_only', or 'none'.

Data from the action execution

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

Custom channel data as a JSON-encoded string

New name for the channel

Whether this is a supergroup channel

HTTPS URL for the channel's cover image

Whether this channel is publicly joinable

List of user IDs to assign as channel operators

Access code required for joining this channel

URL identifier of the group channel to update

Custom type label for the channel

Whether this is a distinct channel

Whether this channel is ephemeral

Unread count preference ("unread_message_count_only" or "all_count")

Custom data string for the channel

Name of the channel

Error if any occurred during the execution of the action

True if channel is a supergroup

Cover image URL

True if channel is public

User IDs of channel operators

Whether or not the action execution was successful or not

Access code for channel joining

Unique URL of the group channel

Custom type of the channel

True if channel is distinct

True if channel is ephemeral

Unread count setting

Additional data for the message as a JSON-encoded string

New text content of the message

ID of the user performing the update

Deduplication ID for the message update

Whether the message update should be silent (no push notification)

Unique ID of the message to update

URL identifier of the group channel containing the message

Custom type label for the message

Mention type for the message (e.g., 'users' or 'channel')

Type of the message (e.g., 'MESG' or 'FILE')

APNs bundle ID for iOS push notifications

Sorted metaarray objects for the message

List of user IDs to mention in the message

Push notification delivery option ('default', 'suppress')

Additional data in the message

File object if the message contains a file

Type of the message

User object who sent the message

Error if any occurred during the execution of the action

Open Graph tag information for the message

Content of the message

True if the update was silent

List of reaction objects on the message

Timestamp when the message was created (ms since epoch)

Unique ID of the updated message

Whether or not the action execution was successful or not

Timestamp when the message was last updated (ms since epoch)

URL of the channel containing the message

Custom type of the message

Thread information if part of a thread

Mention type in the message

Translations available for the message

List of mentioned user objects

Sorted metaarray objects for the message

ID of the parent message if this is a reply

True if message is a direct reply to channel

Parent message data if this is a reply

Apple critical alert options for the message

Unique ID of the user to update

Custom key-value store for user metadata

New display name for the user

Set to false to deactivate the user account

URL of the new profile image

Whether to issue a new access token for the user

List of language tags for localization

Data from the action execution

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

URL-encoded identifier of the group channel to retrieve.

Whether to include the channel's member list in the response.

Whether to include channel metadata in the response.

Whether to include read receipt information in the response.

Whether to include migration information in the response.

Whether to include delivery receipt information in the response.

Custom data of the channel.

Name of the channel.

Error if any occurred during the execution of the action

List of members if show_member=true.

Whether the channel is a super group.

Channel metadata if show_metadata=true.

Cover image URL of the channel.

Whether the channel is public.

Whether or not the action execution was successful or not

URL of the group channel.

Custom type of the channel.

Whether the channel is distinct.

Whether the channel is a broadcast channel.

Read receipt mapping (user_id to timestamp) if requested.

Migration information if show_migration_info=true.

Delivery receipt mapping (user_id to count) if requested.

The unique ID of the user to retrieve.

Data from the action execution

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not