Stream product:chat API
The product:chat API from Stream — 194 operation(s) for product:chat.
Stream product:chat API is one of 19 APIs that Stream publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.
Tagged areas include product:chat. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and an AsyncAPI specification.
This API exposes 269 operations across 194 paths, and defines 488 schemas. It is described by OpenAPI 3.2.0, at version v228.3.0.
Requests are made against a single base URL, https://chat.stream-io-api.com.
269 operations
194 paths
488 schemas
37 DELETE68 GET13 PATCH134 POST17 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 3
Stream product:chat API declares
3 security schemes
for authenticating requests.
An API key is passed in the header as Authorization (JWT).
An API key is passed in the query as api_key (api_key).
An API key is passed in the header as Stream-Auth-Type (stream-auth-type).
By default, every request must be authenticated.
JWT— JWT should be always provided when stream-auth-type=jwt. Using JWT auth request could be authenticated as user or as server-side. When using user authenticatio…api_key— Application API key should be always set in order to authenticate the request.stream-auth-type— Stream-Auth-Type should be always set in order to authenticate the request. Possible values: jwt or anonymous. jwt allows you to authenticate as a user. With t…
Paths & Operations 269
Across 194 paths, the API surfaces 269 operations — 37 DELETE, 68 GET, 13 PATCH, 134 POST, 17 PUT. Each is listed below with its method, path, parameters, and response codes.
product:chat 269
GET
/app
Get App Settings
PATCH
/app
Update App Settings
GET
/blocklists
List block lists
POST
/blocklists
Create block list
DELETE
/blocklists/{name}
Delete block list
GET
/blocklists/{name}
Get block list
PUT
/blocklists/{name}
Update block list
POST
/campaigns
Create campaign
DELETE
/campaigns/{id}
Delete campaign
GET
/campaigns/{id}
Get campaign
PUT
/campaigns/{id}
Update campaign
POST
/campaigns/{id}/start
Start/schedule campaign
POST
/campaigns/{id}/stop
Stop campaign
POST
/campaigns/query
Query campaigns
POST
/channels
Query channels
DELETE
/channels/{type}/{id}
Delete channel
PATCH
/channels/{type}/{id}
Partially update channel
POST
/channels/{type}/{id}
Update channel
DELETE
/channels/{type}/{id}/draft
Delete draft
GET
/channels/{type}/{id}/draft
Get draft
POST
/channels/{type}/{id}/event
Send event
DELETE
/channels/{type}/{id}/file
Delete file
POST
/channels/{type}/{id}/file
Upload file
POST
/channels/{type}/{id}/hide
Hide channel
DELETE
/channels/{type}/{id}/image
Delete image
POST
/channels/{type}/{id}/image
Upload image
PATCH
/channels/{type}/{id}/member
Partially channel member update
POST
/channels/{type}/{id}/message
Send new message
GET
/channels/{type}/{id}/messages
Get many messages
POST
/channels/{type}/{id}/query
Get or create channel
POST
/channels/{type}/{id}/read
Mark read
POST
/channels/{type}/{id}/show
Show channel
POST
/channels/{type}/{id}/truncate
Truncate channel
POST
/channels/{type}/{id}/unread
Mark unread
POST
/channels/{type}/query
Get or create channel
PUT
/channels/batch
Update channels in batch
POST
/channels/delete
Deletes channels asynchronously
POST
/channels/delivered
Mark channel message delivery status
POST
/channels/grouped
Grouped query channels
POST
/channels/read
Mark channels as read
GET
/channeltypes
List channel types
POST
/channeltypes
Create channel type
DELETE
/channeltypes/{name}
Delete channel type
GET
/channeltypes/{name}
Get channel type
PUT
/channeltypes/{name}
Update channel type
POST
/check_push
Check push
POST
/check_sns
Check SNS
POST
/check_sqs
Check SQS
GET
/commands
List commands
POST
/commands
Create command
DELETE
/commands/{name}
Delete command
GET
/commands/{name}
Get command
PUT
/commands/{name}
Update command
DELETE
/devices
Delete device
GET
/devices
List devices
POST
/devices
Create device
POST
/drafts/query
Query draft messages
POST
/export/users
Export users
POST
/export_channels
Export channels
GET
/external_storage
List external storage
POST
/external_storage
Create external storage
DELETE
/external_storage/{name}
Delete external storage
PUT
/external_storage/{name}
Update External Storage
GET
/external_storage/{name}/check
Check External Storage
POST
/guest
Create Guest
POST
/import_urls
Create import URL
GET
/imports
Get import
POST
/imports
Create import
GET
/imports/{id}
Get import
GET
/imports/v2
List import v2 tasks
POST
/imports/v2
Create import v2 task
DELETE
/imports/v2/{id}
Delete import v2 task
GET
/imports/v2/{id}
Get import v2 task
DELETE
/imports/v2/external-storage
Delete external storage
GET
/imports/v2/external-storage
Get external storage
PUT
/imports/v2/external-storage
Upsert external storage
POST
/imports/v2/external-storage/validate
Validate external storage
GET
/members
Query members
DELETE
/messages/{id}
Delete message
GET
/messages/{id}
Get message
POST
/messages/{id}
Update message
PUT
/messages/{id}
Partially message update
POST
/messages/{id}/action
Run message command action
POST
/messages/{id}/commit
Commit message
PATCH
/messages/{id}/ephemeral
Ephemeral message update
POST
/messages/{id}/reaction
Send reaction
DELETE
/messages/{id}/reaction/{type}
Delete reaction
GET
/messages/{id}/reactions
Get reactions
POST
/messages/{id}/reactions
Get reactions on a message
POST
/messages/{id}/translate
Translate message
POST
/messages/{id}/undelete
Undelete message
POST
/messages/{message_id}/polls/{poll_id}/vote
Cast vote
DELETE
/messages/{message_id}/polls/{poll_id}/vote/{vote_id}
Delete vote
DELETE
/messages/{message_id}/reminders
Delete reminder
PATCH
/messages/{message_id}/reminders
Updates Reminder
POST
/messages/{message_id}/reminders
Create reminder
GET
/messages/{parent_id}/replies
Get replies
POST
/messages/history
Query message history
DELETE
/moderation/ban
Unban user
POST
/moderation/ban
Ban user
POST
/moderation/flag
Flag
GET
/moderation/flags/message
Query Message Flags
POST
/moderation/mute
Mute user
POST
/moderation/mute/channel
Mute channel
POST
/moderation/unmute
Unmute user
POST
/moderation/unmute/channel
Unmute channel
GET
/og
Get OG
GET
/permissions
List permissions
GET
/permissions/{id}
Get permission
POST
/polls
Create poll
PUT
/polls
Update poll
DELETE
/polls/{poll_id}
Delete poll
GET
/polls/{poll_id}
Get poll
PATCH
/polls/{poll_id}
Partial update poll
POST
/polls/{poll_id}/options
Create poll option
PUT
/polls/{poll_id}/options
Update poll option
DELETE
/polls/{poll_id}/options/{option_id}
Delete poll option
GET
/polls/{poll_id}/options/{option_id}
Get poll option
POST
/polls/{poll_id}/votes
Query votes
POST
/polls/query
Query polls
POST
/push_preferences
Push notification preferences
GET
/push_providers
List push providers
POST
/push_providers
Upsert a push provider
DELETE
/push_providers/{type}/{name}
Delete a push provider
GET
/push_templates
Get push notification templates
POST
/push_templates
Upsert a push notification template
GET
/query_banned_users
Query Banned Users
GET
/query_future_channel_bans
Query Future Channel Bans
GET
/rate_limits
Get rate limits
POST
/reminders/query
Query reminders
GET
/retention_policy
Get retention policy
POST
/retention_policy
Set retention policy
POST
/retention_policy/delete
Delete retention policy
POST
/retention_policy/runs
Get retention policy runs
GET
/roles
List roles
POST
/roles
Create role
DELETE
/roles/{name}
Delete role
GET
/search
Search messages
DELETE
/segments/{id}
Delete segment
GET
/segments/{id}
Get segment
POST
/segments/{id}/deletetargets
Delete targets from a segment
GET
/segments/{id}/target/{target_id}
Check whether a target exists in a segment
POST
/segments/{id}/targets/query
Query segment targets
POST
/segments/query
Query segments
POST
/stats/team_usage
Query Team Usage Statistics
GET
/tasks/{id}
Get status of a task
POST
/threads
Query Threads
GET
/threads/{message_id}
Get Thread
PATCH
/threads/{message_id}
Partially update thread
GET
/unread
Unread counts
POST
/unread_batch
Batch unread counts
DELETE
/uploads/file
Delete file
POST
/uploads/file
Upload file
DELETE
/uploads/image
Delete image
POST
/uploads/image
Upload image
GET
/usergroups
List user groups
POST
/usergroups
Create user group
DELETE
/usergroups/{id}
Delete user group
GET
/usergroups/{id}
Get user group
PUT
/usergroups/{id}
Update user group
POST
/usergroups/{id}/members
Add user group members
POST
/usergroups/{id}/members/delete
Remove user group members
GET
/usergroups/search
Search user groups
GET
/users
Query users
PATCH
/users
Partially update user
POST
/users
Upsert users
POST
/users/{user_id}/deactivate
Deactivate user
POST
/users/{user_id}/event
Send user event
GET
/users/{user_id}/export
Export user
POST
/users/{user_id}/reactivate
Reactivate user
GET
/users/block
Get list of blocked Users
POST
/users/block
Block user
POST
/users/deactivate
Deactivate users
POST
/users/delete
Delete Users
GET
/users/live_locations
Get user live locations
PUT
/users/live_locations
Update live location
POST
/users/reactivate
Reactivate users
POST
/users/restore
Restore users
POST
/users/unblock
Unblock user
POST
/api/v2/chat/campaigns
Create campaign
DELETE
/api/v2/chat/campaigns/{id}
Delete campaign
GET
/api/v2/chat/campaigns/{id}
Get campaign
PUT
/api/v2/chat/campaigns/{id}
Update campaign
POST
/api/v2/chat/campaigns/{id}/start
Start/schedule campaign
POST
/api/v2/chat/campaigns/{id}/stop
Stop campaign
POST
/api/v2/chat/campaigns/query
Query campaigns
POST
/api/v2/chat/channels
Query channels
DELETE
/api/v2/chat/channels/{type}/{id}
Delete channel
PATCH
/api/v2/chat/channels/{type}/{id}
Partially update channel
POST
/api/v2/chat/channels/{type}/{id}
Update channel
DELETE
/api/v2/chat/channels/{type}/{id}/draft
Delete draft
GET
/api/v2/chat/channels/{type}/{id}/draft
Get draft
POST
/api/v2/chat/channels/{type}/{id}/event
Send event
DELETE
/api/v2/chat/channels/{type}/{id}/file
Delete file
POST
/api/v2/chat/channels/{type}/{id}/file
Upload file
POST
/api/v2/chat/channels/{type}/{id}/hide
Hide channel
DELETE
/api/v2/chat/channels/{type}/{id}/image
Delete image
POST
/api/v2/chat/channels/{type}/{id}/image
Upload image
PATCH
/api/v2/chat/channels/{type}/{id}/member
Partially channel member update
POST
/api/v2/chat/channels/{type}/{id}/message
Send new message
GET
/api/v2/chat/channels/{type}/{id}/messages
Get many messages
POST
/api/v2/chat/channels/{type}/{id}/query
Get or create channel
POST
/api/v2/chat/channels/{type}/{id}/read
Mark read
POST
/api/v2/chat/channels/{type}/{id}/show
Show channel
POST
/api/v2/chat/channels/{type}/{id}/truncate
Truncate channel
POST
/api/v2/chat/channels/{type}/{id}/unread
Mark unread
POST
/api/v2/chat/channels/{type}/query
Get or create channel
PUT
/api/v2/chat/channels/batch
Update channels in batch
POST
/api/v2/chat/channels/delete
Deletes channels asynchronously
POST
/api/v2/chat/channels/delivered
Mark channel message delivery status
POST
/api/v2/chat/channels/grouped
Grouped query channels
POST
/api/v2/chat/channels/read
Mark channels as read
GET
/api/v2/chat/channeltypes
List channel types
POST
/api/v2/chat/channeltypes
Create channel type
DELETE
/api/v2/chat/channeltypes/{name}
Delete channel type
GET
/api/v2/chat/channeltypes/{name}
Get channel type
PUT
/api/v2/chat/channeltypes/{name}
Update channel type
GET
/api/v2/chat/commands
List commands
POST
/api/v2/chat/commands
Create command
DELETE
/api/v2/chat/commands/{name}
Delete command
GET
/api/v2/chat/commands/{name}
Get command
PUT
/api/v2/chat/commands/{name}
Update command
POST
/api/v2/chat/drafts/query
Query draft messages
POST
/api/v2/chat/export_channels
Export channels
GET
/api/v2/chat/members
Query members
DELETE
/api/v2/chat/messages/{id}
Delete message
GET
/api/v2/chat/messages/{id}
Get message
POST
/api/v2/chat/messages/{id}
Update message
PUT
/api/v2/chat/messages/{id}
Partially message update
POST
/api/v2/chat/messages/{id}/action
Run message command action
POST
/api/v2/chat/messages/{id}/commit
Commit message
PATCH
/api/v2/chat/messages/{id}/ephemeral
Ephemeral message update
POST
/api/v2/chat/messages/{id}/reaction
Send reaction
DELETE
/api/v2/chat/messages/{id}/reaction/{type}
Delete reaction
GET
/api/v2/chat/messages/{id}/reactions
Get reactions
POST
/api/v2/chat/messages/{id}/reactions
Get reactions on a message
POST
/api/v2/chat/messages/{id}/translate
Translate message
POST
/api/v2/chat/messages/{id}/undelete
Undelete message
POST
/api/v2/chat/messages/{message_id}/polls/{poll_id}/vote
Cast vote
DELETE
/api/v2/chat/messages/{message_id}/polls/{poll_id}/vote/{vote_id}
Delete vote
DELETE
/api/v2/chat/messages/{message_id}/reminders
Delete reminder
PATCH
/api/v2/chat/messages/{message_id}/reminders
Updates Reminder
POST
/api/v2/chat/messages/{message_id}/reminders
Create reminder
GET
/api/v2/chat/messages/{parent_id}/replies
Get replies
POST
/api/v2/chat/messages/history
Query message history
GET
/api/v2/chat/moderation/flags/message
Query Message Flags
POST
/api/v2/chat/moderation/mute/channel
Mute channel
POST
/api/v2/chat/moderation/unmute/channel
Unmute channel
GET
/api/v2/chat/query_banned_users
Query Banned Users
GET
/api/v2/chat/query_future_channel_bans
Query Future Channel Bans
POST
/api/v2/chat/reminders/query
Query reminders
GET
/api/v2/chat/retention_policy
Get retention policy
POST
/api/v2/chat/retention_policy
Set retention policy
POST
/api/v2/chat/retention_policy/delete
Delete retention policy
POST
/api/v2/chat/retention_policy/runs
Get retention policy runs
GET
/api/v2/chat/search
Search messages
DELETE
/api/v2/chat/segments/{id}
Delete segment
GET
/api/v2/chat/segments/{id}
Get segment
POST
/api/v2/chat/segments/{id}/deletetargets
Delete targets from a segment
GET
/api/v2/chat/segments/{id}/target/{target_id}
Check whether a target exists in a segment
POST
/api/v2/chat/segments/{id}/targets/query
Query segment targets
POST
/api/v2/chat/segments/query
Query segments
POST
/api/v2/chat/stats/team_usage
Query Team Usage Statistics
POST
/api/v2/chat/threads
Query Threads
GET
/api/v2/chat/threads/{message_id}
Get Thread
PATCH
/api/v2/chat/threads/{message_id}
Partially update thread
GET
/api/v2/chat/unread
Unread counts
POST
/api/v2/chat/unread_batch
Batch unread counts
POST
/api/v2/chat/users/{user_id}/event
Send user event
Schemas 488
The contract defines 488 schemas that model the data the API accepts and returns. The most detailed are AppResponseFields (56 properties), UpdateAppRequest (51 properties), MessageWithChannelResponse (49 properties), SearchResultMessage (49 properties). Each schema is shown below with its type and property counts.
UpdateUsersRequest
objectnull
1 property
1 required
PaginationParams
object
2 properties
SearchResultMessage
object
49 properties
23 required
LimitInfoResponse
object
3 properties
3 required
FeedsPreferencesResponse
object
8 properties
QueryUsersPayload
object
8 properties
1 required
DeleteRetentionPolicyRequest
objectnull
1 property
1 required
GroupedQueryChannelsRequest
objectnull
3 properties
WebhookFailoverConfig
object
4 properties
APIError
objectnull
8 properties
6 required
ImportV2TaskSettings
object
6 properties
GeofenceSettings
object
1 property
1 required
RestoreUsersRequest
objectnull
1 property
1 required
ReactionResponse
object
8 properties
8 required
QueryMessageFlagsPayload
object
7 properties
UpsertExternalStorageAWSS3Request
object
4 properties
3 required
ReadStateResponse
object
6 properties
3 required
MessagePaginationParams
object
11 properties
GroupedChannelsBucket
object
2 properties
1 required
UploadChannelFileRequest
objectnull
2 properties
AutomodDetailsResponse
object
5 properties
SearchUserGroupsResponse
objectnull
Response for searching user groups
2 properties
2 required
UpdatePollOptionRequest
objectnull
5 properties
2 required
UnmuteResponse
objectnull
2 properties
1 required
MuteChannelResponse
objectnull
4 properties
1 required
QueryChannelsRequest
objectnull
12 properties
CreateBlockListRequest
objectnull
Block list contains restricted words
6 properties
2 required
APNConfig
object
10 properties
QueryChannelsResponse
objectnull
3 properties
2 required
PushProviderRequest
object
24 properties
1 required
QuerySegmentTargetsResponse
objectnull
4 properties
2 required
UpdateChannelResponse
objectnull
4 properties
2 required
ThreadParticipant_2
objectnull
Represents a user that is participating in a thread.
10 properties
5 required
UpdateExternalStorageResponse
objectnull
Basic response information
5 properties
5 required
GetCustomPermissionResponse
objectnull
Basic response information
2 properties
2 required
HuaweiConfig
object
3 properties
BanResponse
objectnull
7 properties
1 required
ReadStateResponse_2
object
6 properties
3 required
UnblockUsersResponse
objectnull
1 property
1 required
UpsertPushProviderResponse
objectnull
Basic response information
2 properties
2 required
FirebaseConfig
object
6 properties
UpdateUsersResponse
objectnull
3 properties
3 required
LabelResponse
object
3 properties
1 required
SetRetentionPolicyResponse
objectnull
Basic response information
2 properties
2 required
UpsertPushPreferencesResponse
objectnull
3 properties
3 required
BlockListOptions
object
2 properties
2 required
StartCampaignRequest
objectnull
2 properties
RemoveUserGroupMembersResponse
objectnull
Response for removing members from a user group
2 properties
1 required
EventResponse
objectnull
Basic response information
2 properties
2 required
OwnUserResponse
object
30 properties
17 required
ImageData
object
5 properties
5 required
ChannelInput
object
13 properties
TeamUsageStats
object
Usage statistics for a single team containing all 16 metrics
17 properties
17 required
FlagMessageResponse
objectnull
3 properties
2 required
QueryFutureChannelBansResponse
objectnull
2 properties
2 required
DeactivateUsersRequest
objectnull
Deactivate users request
4 properties
1 required
MuteChannelRequest
objectnull
4 properties
QueryDraftsRequest
objectnull
7 properties
CreateExternalStorageResponse
objectnull
Basic response information
1 property
1 required
AddUserGroupMembersRequest
objectnull
Request body for adding members to a user group
3 properties
1 required
ListChannelTypesResponse
objectnull
2 properties
2 required
ChannelConfigWithInfo_2
object
37 properties
28 required
StopCampaignRequest
objectnull
UpdatePollPartialRequest
objectnull
4 properties
DeleteCommandResponse
objectnull
2 properties
2 required
UploadChannelResponse
objectnull
5 properties
1 required
UnreadCountsChannel
object
3 properties
3 required
MessageResponse_2
object
Represents any chat message
48 properties
23 required
QueryPollsResponse
objectnull
4 properties
2 required
EventNotificationSettings
object
3 properties
3 required
APNConfigFields
object
10 properties
2 required
DataDogInfo
object
3 properties
GetThreadResponse
objectnull
2 properties
2 required
PollOptionRequest
objectnull
3 properties
1 required
FlagMessageDetailsResponse
object
4 properties
GetExternalStorageAWSS3Response
object
4 properties
3 required
UpdateChannelRequest
objectnull
18 properties
BlockUsersResponse
objectnull
4 properties
4 required
ImportV2TaskSettingsS3
object
3 properties
DeviceErrorInfo
object
3 properties
3 required
CreateCampaignResponse
objectnull
Basic response information
3 properties
1 required
UserRequest
object
User request object
10 properties
1 required
UpdateUserGroupRequest
objectnull
Request body for updating a user group
3 properties
CheckSQSRequest
objectnull
3 properties
CallSettings
object
16 properties
GetBlockListResponse
objectnull
Response for get block list
2 properties
1 required
ListDevicesResponse
objectnull
List devices response
2 properties
2 required
PendingMessageResponse
objectnull
4 properties
PollVotesResponse
objectnull
4 properties
2 required
UploadChannelFileResponse
objectnull
4 properties
1 required
RecordSettings
object
4 properties
1 required
FlagDetailsResponse
object
3 properties
1 required
UpdateCampaignRequest
objectnull
14 properties
2 required
ReactivateUserRequest
objectnull
3 properties
QuerySegmentsRequest
objectnull
5 properties
1 required
IngressAudioEncodingOptions
object
3 properties
3 required
ChannelPushPreferencesResponse_2
objectnull
3 properties
ExportChannelsResponse
objectnull
2 properties
2 required
GetOGResponse
objectnull
23 properties
2 required
MarkChannelsReadRequest
objectnull
3 properties
CreateRoleResponse
objectnull
Basic response information
2 properties
2 required
CheckPushRequest
objectnull
Check push request
10 properties
GetRetentionPolicyResponse
objectnull
Basic response information
2 properties
2 required
ShowChannelRequest
objectnull
2 properties
MessageRequest_2
object
Message data for creating or updating a message
24 properties
PollVoteResponse
objectnull
3 properties
1 required
PushNotificationSettingsResponse
object
2 properties
ThreadStateResponse_2
objectnull
19 properties
10 required
ImportTaskHistory
objectnull
3 properties
3 required
ParsedPredefinedFilterResponse
object
3 properties
2 required
UnreadCountsChannelType
object
3 properties
3 required
DeleteImportV2TaskResponse
objectnull
Basic response information
1 property
1 required
DeleteReactionResponse
objectnull
Basic response information
3 properties
3 required
PagerResponse
object
2 properties
UnreadCountsResponse
objectnull
6 properties
5 required
ListRolesResponse
objectnull
Basic response information
2 properties
2 required
CampaignResponse_2
object
23 properties
18 required
UndeleteMessageResponse
objectnull
Basic response information
2 properties
2 required
UpdateThreadPartialRequest
objectnull
4 properties
ImportTask
object
8 properties
7 required
IngressVideoLayer
objectnull
5 properties
5 required
UserMuteResponse
objectnull
5 properties
2 required
QueryBannedUsersPayload
object
7 properties
1 required
UpdateMemberPartialRequest
objectnull
2 properties
SendMessageRequest
objectnull
7 properties
1 required
QuerySegmentTargetsRequest
objectnull
5 properties
CreateUserGroupResponse
objectnull
Response for creating a user group
2 properties
1 required
PollResponseData
object
21 properties
18 required
FlagResponse
object
14 properties
3 required
CreatePollRequest
objectnull
Contains all information needed to create a new poll
13 properties
1 required
Command_2
objectnull
Represents custom chat command
6 properties
4 required
ReminderResponseData
object
9 properties
5 required
PushNotificationFields
object
7 properties
6 required
UpdateChannelTypeResponse
objectnull
39 properties
31 required
DeleteChannelsResponse
objectnull
3 properties
1 required
DeactivateUserResponse
objectnull
2 properties
1 required
QueryReactionsRequest
object
7 properties
FileUploadConfig
object
5 properties
1 required
QueryThreadsResponse
objectnull
4 properties
2 required
UpdateReminderResponse
objectnull
Basic response information
2 properties
2 required
UndeleteMessageRequest
objectnull
1 property
1 required
VoteData
object
2 properties
IngressVideoEncodingOptions
object
2 properties
1 required
CreateGuestResponse
objectnull
3 properties
3 required
PushProviderResponse
object
28 properties
4 required
ListUserGroupsResponse
objectnull
Response for listing user groups
2 properties
2 required
PolicyRequest
object
Policy request
6 properties
6 required
SearchWarning
object
4 properties
2 required
UnreadCountsThread
object
4 properties
4 required
CreateImportResponse
objectnull
Basic response information
2 properties
1 required
ChannelResponse_2
object
Represents channel in chat
28 properties
8 required
DraftResponse
object
7 properties
3 required
ChannelStateResponse_2
objectnull
16 properties
5 required
MuteUserRequest
objectnull
4 properties
1 required
CreateImportV2TaskRequest
objectnull
Client request
4 properties
2 required
ChannelBatchUpdateRequest
objectnull
4 properties
2 required
MarkUnreadRequest
objectnull
5 properties
RawRecordSettings
object
2 properties
1 required
UserGroupMember
objectnull
5 properties
5 required
FileUploadResponse
objectnull
3 properties
1 required
ChannelMute
objectnull
5 properties
2 required
DeleteCampaignResponse
objectnull
Basic response information
1 property
1 required
QueryRemindersResponse
objectnull
4 properties
2 required
CreateImportURLResponse
objectnull
Basic response information
3 properties
3 required
ImageSize
object
4 properties
ReactionGroupResponse
objectnull
ReactionGroupResponse contains all information about a reaction of the same type.
5 properties
5 required
DeleteSegmentTargetsRequest
objectnull
1 property
1 required
BroadcastSettings
object
3 properties
1 required
FCM
object
1 property
DeleteMessageResponse
objectnull
Basic response information
2 properties
2 required
QueryPollVotesRequest
objectnull
5 properties
BlockUsersRequest
objectnull
3 properties
1 required
BlockedUserResponse
objectnull
5 properties
5 required
FutureChannelBanResponse
objectnull
6 properties
1 required
UserResponse
object
User response object
25 properties
12 required
CreateImportURLRequest
objectnull
1 property
TranslateMessageRequest
objectnull
1 property
1 required
ChannelDataUpdate
object
7 properties
ListCommandsResponse
objectnull
2 properties
2 required
QueryRemindersRequest
objectnull
7 properties
SpeechSegmentConfig
object
2 properties
MessageFlagResponse
objectnull
14 properties
3 required
UserResponseCommonFields
object
18 properties
10 required
SendMessageResponse
objectnull
3 properties
2 required
TargetResolution
object
3 properties
3 required
UpdateReminderRequest
objectnull
3 properties
ChannelBatchUpdateResponse
objectnull
Basic response information
2 properties
1 required
ExportUserResponse
objectnull
4 properties
1 required
DeleteUsersResponse
objectnull
2 properties
2 required
ExportUsersRequest
objectnull
1 property
1 required
Permission
object
10 properties
9 required
UpdateChannelRequest_2
objectnull
18 properties
AudioSettings
object
8 properties
7 required
StartCampaignRequest_2
objectnull
2 properties
XiaomiConfigFields
object
3 properties
1 required
GetChannelTypeResponse
objectnull
Basic response information
39 properties
31 required
Role
object
5 properties
5 required
AsyncModerationConfiguration
object
2 properties
QueryTeamUsageStatsResponse
objectnull
Response containing team-level usage statistics
3 properties
2 required
UnmuteUserResponse
objectnull
2 properties
1 required
FileUploadRequest
objectnull
2 properties
GetReactionsResponse
objectnull
2 properties
2 required
ModerationV2Response
object
8 properties
2 required
ThumbnailsSettings
object
1 property
1 required
DeliveryReceiptsResponse
object
1 property
1 required
UpdateChannelTypeRequest
objectnull
35 properties
3 required
TranslationSettings
object
2 properties
2 required
TranscriptionSettings
object
5 properties
4 required
SessionSettings
object
1 property
1 required
UpsertExternalStorageResponse
objectnull
Basic response information
1 property
1 required
CreateDeviceRequest
objectnull
Create device request
6 properties
2 required
Action
objectnull
5 properties
3 required
NoiseCancellationSettings
object
1 property
1 required
MessageWithChannelResponse
object
Represents any chat message
49 properties
24 required
ShowChannelResponse
objectnull
Basic response information
1 property
1 required
SharedLocation_2
object
4 properties
2 required
CheckSNSResponse
objectnull
4 properties
2 required
MessageUpdate
object
2 properties
RetentionPolicy
object
4 properties
4 required
HideChannelRequest
objectnull
3 properties
SearchResult
object
1 property
DeactivateUserRequest
objectnull
2 properties
QueryMembersPayload
object
9 properties
2 required
TruncateChannelRequest_2
objectnull
7 properties
PushTemplate
objectnull
5 properties
4 required
QueryTeamUsageStatsRequest
objectnull
Request payload for querying team-level usage statistics from the warehouse database
5 properties
PollOptionResponse
objectnull
2 properties
2 required
MetricStats
object
Statistics for a single metric with optional daily breakdown
2 properties
1 required
IngressSource
object
3 properties
3 required
ReminderResponseData_2
object
9 properties
5 required
UnblockUsersRequest
objectnull
3 properties
1 required
UpdateThreadPartialResponse
objectnull
2 properties
2 required
PollOptionResponseData
objectnull
3 properties
3 required
CheckExternalStorageResponse
objectnull
Basic response information
2 properties
2 required
MarkReadResponseEvent
object
11 properties
5 required
OverviewDashboardConfig
object
2 properties
GroupedQueryChannelsResponse
objectnull
2 properties
2 required
UpdateMemberPartialResponse
objectnull
2 properties
1 required
FeedsPreferences
object
8 properties
MessageModerationResult
object
Result of the message moderation
11 properties
6 required
SendReactionResponse
objectnull
Basic response information
3 properties
3 required
UploadChannelRequest
objectnull
3 properties
SetRetentionPolicyRequest
objectnull
2 properties
2 required
MessageActionRequest
objectnull
3 properties
1 required
AzureRequest
object
Config for creating Azure Blob Storage storage
4 properties
4 required
CastPollVoteRequest
objectnull
3 properties
ChannelBatchMemberRequest
objectnull
2 properties
1 required
FullUserResponse
object
31 properties
19 required
QueryCampaignsRequest
objectnull
6 properties
RunStats
object
2 properties
UpdateUsersPartialRequest
objectnull
1 property
1 required
CreateImportV2TaskResponse
objectnull
Basic response information
8 properties
8 required
WSEvent
object
Represents an BaseEvent that happened in Stream Chat
27 properties
3 required
UpdateCommandResponse
objectnull
2 properties
1 required
ListBlockListResponse
objectnull
Basic response information
2 properties
2 required
UpdateChannelPartialResponse
objectnull
3 properties
2 required
PollResponseData_2
object
21 properties
18 required
UnreadCountsBatchRequest
objectnull
1 property
1 required
ScreensharingSettings
object
3 properties
2 required
DeleteChannelsResultResponse
objectnull
2 properties
1 required
QueryDraftsResponse
objectnull
4 properties
2 required
GetSegmentResponse
objectnull
2 properties
1 required
UpsertPushTemplateRequest
objectnull
5 properties
2 required
UpdateReminderRequest_2
objectnull
3 properties
CampaignStatsResponse
object
7 properties
7 required
UpdateUserGroupResponse
objectnull
Response for updating a user group
2 properties
1 required
UpdateAppRequest
objectnull
51 properties
RingSettings
object
3 properties
3 required
GetTaskResponse
objectnull
7 properties
5 required
CommitMessageRequest
objectnull
CreateExternalStorageRequest
objectnull
Create external storage
7 properties
3 required
Segment
objectnull
12 properties
8 required
UpsertPushPreferencesRequest
objectnull
1 property
1 required
PrivacySettingsResponse
object
3 properties
GeofenceResponse
objectnull
4 properties
1 required
CampaignChannelTemplate
object
6 properties
1 required
CreatePollOptionRequest
objectnull
4 properties
1 required
CreateGuestRequest
objectnull
1 property
1 required
ModerationDashboardPreferences
object
11 properties
GetImportResponse
objectnull
Basic response information
2 properties
1 required
SortParamRequest
objectnull
3 properties
ChannelConfigWithInfo
object
37 properties
28 required
ConfigOverridesRequest
object
Channel configuration overrides
16 properties
ValidateExternalStorageResponse
objectnull
Basic response information
1 property
1 required
CreateCommandResponse
objectnull
2 properties
1 required
CreateReminderRequest_2
objectnull
3 properties
SharedLocation
object
4 properties
2 required
ReactionRequest
object
Represents user reaction to a message
7 properties
1 required
SharedLocationsResponse
objectnull
2 properties
2 required
GetRetentionPolicyRunsRequest
objectnull
5 properties
UpdateExternalStorageRequest
objectnull
External storage
6 properties
2 required
CampaignResponse
object
23 properties
18 required
PollVoteResponseData_2
objectnull
9 properties
5 required
QueryPollsRequest
objectnull
5 properties
UpdateMessagePartialRequest
objectnull
6 properties
DeviceResponse
objectnull
Response for Device
8 properties
4 required
GetApplicationResponse
objectnull
Basic response information
2 properties
2 required
DraftResponse_2
object
7 properties
3 required
FrameRecordSettings
object
3 properties
2 required
NotificationSettings
object
6 properties
6 required
ListImportsResponse
objectnull
Basic response information
2 properties
2 required
UpdateMessageResponse
objectnull
Basic response information
3 properties
2 required
ReactivateUsersRequest
objectnull
Reactivate users in batches
4 properties
1 required
FirebaseConfigFields
object
6 properties
1 required
ImageUploadRequest
objectnull
3 properties
OnlyUserID
object
1 property
1 required
ReactionResponse_2
object
8 properties
8 required
CheckSNSRequest
objectnull
3 properties
StartCampaignResponse
objectnull
Basic response information
3 properties
1 required
IndividualRecordSettings
object
2 properties
1 required
ChatPreferencesResponse
object
7 properties
GetImportV2TaskResponse
objectnull
Basic response information
9 properties
8 required
GetChannelTypeResponse_2
objectnull
Basic response information
39 properties
31 required
MarkUnreadRequest_2
objectnull
5 properties
SearchResponse
objectnull
5 properties
2 required
MarkDeliveredRequest
objectnull
1 property
ExternalStorageResponse
object
4 properties
4 required
MessageHistoryEntryResponse
objectnull
7 properties
7 required
ChannelStateResponseFields
object
15 properties
4 required
ImageUploadResponse
objectnull
4 properties
1 required
UpdateBlockListResponse
objectnull
Basic response information
2 properties
1 required
Field
objectnull
3 properties
3 required
GetRetentionPolicyRunsResponse
objectnull
Basic response information
4 properties
2 required
CreateBlockListResponse
objectnull
Basic response information
2 properties
1 required
GetManyMessagesResponse
objectnull
2 properties
2 required
Policy
object
8 properties
8 required
GetPushTemplatesResponse
objectnull
Basic response information
2 properties
2 required
S3Request
object
Config for creating Amazon S3 storage.
4 properties
1 required
DeleteRetentionPolicyResponse
objectnull
Basic response information
1 property
1 required
UpdateBlockListRequest
objectnull
4 properties
CreateUserGroupRequest
objectnull
Request body for creating a user group
5 properties
1 required
DraftPayloadResponse
object
Contains the draft message content
13 properties
3 required
SharedLocationResponseData_2
object
11 properties
8 required
PushPreferencesResponse
object
6 properties
ChannelConfig
object
Channel configuration overrides
16 properties
ReactionGroupResponse_2
objectnull
ReactionGroupResponse contains all information about a reaction of the same type.
5 properties
5 required
ChannelGetOrCreateRequest
objectnull
7 properties
ListPermissionsResponse
objectnull
Basic response information
2 properties
2 required
CreateImportRequest
objectnull
3 properties
2 required
BlockListResponse
object
Block list contains restricted words
9 properties
5 required
RTMPLocation
object
3 properties
3 required
UserCustomEventRequest
object
2 properties
1 required
PushProvider
objectnull
28 properties
4 required
PushNotificationSettingsResponse_2
object
2 properties
PollOptionInput
objectnull
2 properties
PushConfig
object
2 properties
1 required
QueryThreadsRequest
objectnull
10 properties
PolicyConfig
object
1 property
1 required
ThreadParticipant
objectnull
Represents a user that is participating in a thread.
10 properties
5 required
UserGroupResponse
object
8 properties
4 required
ChannelResponse
object
Represents channel in chat
28 properties
8 required
ChannelMemberRequest
objectnull
4 properties
1 required
ReactionGroupUserResponse_2
object
Contains information about a user who reacted with this reaction type.
3 properties
2 required
ImportV2TaskItem
object
8 properties
7 required
QueryMessageFlagsResponse
objectnull
Query message flags response
2 properties
2 required
ListExternalStorageResponse
objectnull
Basic response information
2 properties
2 required
Command
objectnull
Represents custom chat command
6 properties
4 required
ThreadStateResponse
objectnull
19 properties
10 required
QueryUsersResponse
objectnull
2 properties
2 required
SharedLocationResponseData
object
11 properties
8 required
MessageChangeSet
object
9 properties
9 required
SegmentTargetResponse
objectnull
4 properties
4 required
WrappedUnreadCountsResponse
objectnull
Basic response information
7 properties
6 required
QuerySegmentsResponse
objectnull
4 properties
2 required
QueryReactionsResponse
object
Basic response information
4 properties
2 required
MessageOptions
object
1 property
UnmuteUserRequest
objectnull
3 properties
UpdateChannelPartialRequest
objectnull
4 properties
ReactivateUserResponse
objectnull
2 properties
1 required
DeleteExternalStorageResponse
objectnull
Basic response information
1 property
1 required
XiaomiConfig
object
3 properties
BackstageSettings
object
2 properties
1 required
GetRepliesResponse
objectnull
Basic response information
2 properties
2 required
UpdateCommandRequest
objectnull
3 properties
1 required
ListPushProvidersResponse
objectnull
Basic response information
2 properties
2 required
Segment_2
objectnull
12 properties
8 required
MarkReadRequest
objectnull
4 properties
GetBlockedUsersResponse
objectnull
2 properties
2 required
UpdateMessageRequest
objectnull
3 properties
1 required
APNS
object
6 properties
2 required
ChatPreferences
object
8 properties
ChannelTypeConfig
objectnull
38 properties
30 required
ReadReceiptsResponse
object
1 property
1 required
PollVoteResponseData
objectnull
9 properties
5 required
SendEventRequest
objectnull
1 property
1 required
CreateRoleRequest
objectnull
1 property
1 required
AsyncModerationCallbackConfig
object
2 properties
CreateChannelTypeResponse
objectnull
39 properties
31 required
EventHook
objectnull
25 properties
SendUserCustomEventRequest
objectnull
1 property
1 required
DeviceResponse_2
objectnull
Response for Device
8 properties
4 required
ChannelExport
object
5 properties
RetentionRunResponse
object
4 properties
4 required
MembersResponse
objectnull
2 properties
2 required
UnmuteChannelRequest
objectnull
4 properties
SegmentResponse
object
11 properties
11 required
QueryMessageHistoryRequest
objectnull
5 properties
1 required
QueryBannedUsersResponse
objectnull
2 properties
2 required
ReactivateUsersResponse
objectnull
Basic response information
2 properties
2 required
HuaweiConfigFields
object
3 properties
1 required
CreateCampaignRequest
objectnull
14 properties
2 required
GetExternalStorageResponse
objectnull
Basic response information
5 properties
4 required
CreateCommandRequest
objectnull
Create a new command
4 properties
2 required
GetUserGroupResponse
objectnull
Response for getting a user group
2 properties
1 required
IngressSettings
object
3 properties
1 required
LabelThresholds
object
2 properties
PushPreferenceInput
objectnull
9 properties
GetCommandResponse
objectnull
7 properties
5 required
FlagFeedbackResponse
object
3 properties
3 required
GetCommandResponse_2
objectnull
7 properties
5 required
UserResponse_2
object
User response object
25 properties
12 required
CreateChannelTypeResponse_2
objectnull
39 properties
31 required
CampaignChannelMember
objectnull
3 properties
1 required
QueryFutureChannelBansPayload
object
6 properties
DeleteReminderResponse
objectnull
Basic response information
1 property
1 required
ChannelPushPreferencesResponse
object
2 properties
AddUserGroupMembersResponse
objectnull
Response for adding members to a user group
2 properties
1 required
DeleteChannelsRequest
objectnull
2 properties
1 required
ErrorResult
object
4 properties
2 required
Response
objectnull
Basic response information
1 property
1 required
GetMessageResponse
objectnull
Basic response information
3 properties
2 required
TypingIndicatorsResponse
object
1 property
1 required
UpdateChannelTypeResponse_2
objectnull
39 properties
31 required
MessageActionResponse
objectnull
Basic response information
2 properties
1 required
UpdateMessagePartialResponse
objectnull
3 properties
1 required
ModerationResponse
object
4 properties
5 required
MessageRequest
object
Message data for creating or updating a message
24 properties
ChannelInputRequest
object
10 properties
ChannelStateResponse
objectnull
16 properties
5 required
AppResponseFields
object
56 properties
48 required
VideoSettings
object
5 properties
5 required
QueryCampaignsResponse
objectnull
Basic response information
4 properties
2 required
EventRequest
object
5 properties
1 required
FlagDetails
object
2 properties
1 required
CheckPushResponse
objectnull
8 properties
1 required
QueryMessageHistoryResponse
objectnull
4 properties
2 required
HLSSettings
object
4 properties
3 required
SendReactionRequest
objectnull
3 properties
1 required
TruncateChannelResponse
objectnull
3 properties
1 required
UpsertPushTemplateResponse
objectnull
Basic response information
2 properties
1 required
CallType
objectnull
8 properties
6 required
RTMPSettings
object
4 properties
1 required
MarkDeliveredResponse
objectnull
Basic response information
1 property
1 required
GetCampaignResponse
objectnull
Basic response information
3 properties
1 required
FlagRequest
objectnull
6 properties
UpdatePollRequest
objectnull
13 properties
2 required
HideChannelResponse
objectnull
Basic response information
1 property
1 required
Attachment
objectnull
An attachment is a message object that represents a file uploaded by a user.
22 properties
1 required
GetDraftResponse
objectnull
Basic response information
2 properties
2 required
CampaignStatsResponse_2
object
7 properties
7 required
MuteUserResponse
objectnull
5 properties
1 required
UpsertExternalStorageRequest
objectnull
2 properties
1 required
CreateReminderRequest
objectnull
3 properties
UpdateUserPartialRequest
object
3 properties
1 required
Images
object
7 properties
7 required
SearchPayload
object
10 properties
1 required
BanRequest
objectnull
13 properties
1 required
PollResponse
objectnull
2 properties
2 required
ReactionGroupUserResponse
object
Contains information about a user who reacted with this reaction type.
3 properties
2 required
LayoutSettings
object
5 properties
3 required
LimitsSettings
object
4 properties
1 required
ChannelMemberResponse
object
2 properties
2 required
RemoveUserGroupMembersRequest
objectnull
Request body for removing members from a user group
2 properties
1 required
DeliveredMessagePayload
object
2 properties
ListImportV2TasksResponse
objectnull
Basic response information
4 properties
2 required
ExportChannelsRequest
objectnull
6 properties
1 required
ThreadResponse
object
16 properties
9 required
DeleteChannelResponse
objectnull
Basic response information
2 properties
1 required
MessageResponse
object
Represents any chat message
48 properties
23 required
ChannelMemberResponse_2
objectnull
20 properties
7 required
PushTemplateResponse
object
6 properties
5 required
DeactivateUsersResponse
objectnull
Basic response information
2 properties
2 required
ChatPreferencesInput
object
7 properties
ChannelOwnCapability
string
All possibility of string to use
CheckSQSResponse
objectnull
4 properties
2 required
DeleteUsersRequest
objectnull
8 properties
1 required
UpdateLiveLocationRequest
objectnull
4 properties
1 required
UpsertPushProviderRequest
objectnull
1 property
MarkReadResponse
objectnull
2 properties
1 required
SharedLocationResponse
objectnull
12 properties
9 required
UnreadCountsBatchResponse
objectnull
Basic response information
2 properties
2 required
DailyValue
object
Metric value for a specific date
2 properties
2 required
CampaignMessageTemplate
object
5 properties
1 required
ExportUsersResponse
objectnull
Basic response information
2 properties
2 required
TruncateChannelRequest
objectnull
7 properties
GetRateLimitsResponse
objectnull
5 properties
1 required
Thresholds
object
Sets thresholds for AI moderation
3 properties
CreateChannelTypeRequest
objectnull
33 properties
4 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Stream 12
Other APIs Stream publishes across the network.
Stream Activity Feeds API
Stream Video and Audio API
Stream Application API
Stream Campaigns API
Stream Channels API
Stream Devices API
Stream Members API
Stream Messages API
Stream Moderation API
Stream Permissions API
Stream Reactions API
Stream Roles API
#product:chat
Where this information came from
This is an independent, third-party profile of Stream product:chat API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.