naftiko: 1.0.0-alpha2 info: label: Stream API — product:chat description: 'Stream API — product:chat. 179 operations. Lead operation: Get App Settings. Self-contained Naftiko capability covering one Stream Io business surface.' tags: - Stream Io - product:chat created: '2026-05-19' modified: '2026-05-19' binds: - namespace: env keys: STREAM_IO_API_KEY: STREAM_IO_API_KEY capability: consumes: - type: http namespace: chat-product-chat baseUri: https://chat.stream-io-api.com description: Stream API — product:chat business capability. Self-contained, no shared references. resources: - name: app path: /app operations: - name: getapp method: GET description: Get App Settings outputRawFormat: json outputParameters: - name: result type: object value: $. - name: updateapp method: PATCH description: Update App Settings outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: blocklists path: /blocklists operations: - name: listblocklists method: GET description: List block lists outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: team in: query type: string - name: createblocklist method: POST description: Create block list outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: blocklists-name path: /blocklists/{name} operations: - name: deleteblocklist method: DELETE description: Delete block list outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: name in: path type: string required: true - name: team in: query type: string - name: getblocklist method: GET description: Get block list outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: name in: path type: string required: true - name: team in: query type: string - name: updateblocklist method: PUT description: Update block list outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: name in: path type: string required: true - name: body in: body type: object description: Request body (JSON). required: true - name: campaigns path: /campaigns operations: - name: createcampaign method: POST description: Create campaign outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: campaigns-query path: /campaigns/query operations: - name: querycampaigns method: POST description: Query campaigns outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: campaigns-id path: /campaigns/{id} operations: - name: deletecampaign method: DELETE description: Delete campaign outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: string required: true - name: getcampaign method: GET description: Get campaign outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: string required: true - name: prev in: query type: string - name: next in: query type: string - name: limit in: query type: integer - name: updatecampaign method: PUT description: Update campaign outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: string required: true - name: body in: body type: object description: Request body (JSON). required: true - name: campaigns-id-start path: /campaigns/{id}/start operations: - name: startcampaign method: POST description: Start/schedule campaign outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: string required: true - name: body in: body type: object description: Request body (JSON). required: true - name: campaigns-id-stop path: /campaigns/{id}/stop operations: - name: stopcampaign method: POST description: Stop campaign outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: string required: true - name: channels path: /channels operations: - name: querychannels method: POST description: Query channels outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: channels-batch path: /channels/batch operations: - name: channelbatchupdate method: PUT description: Update channels in batch outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: channels-delete path: /channels/delete operations: - name: deletechannels method: POST description: Deletes channels asynchronously outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: channels-delivered path: /channels/delivered operations: - name: markdelivered method: POST description: Mark channel message delivery status outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: user_id in: query type: string - name: body in: body type: object description: Request body (JSON). required: true - name: channels-grouped path: /channels/grouped operations: - name: groupedquerychannels method: POST description: Grouped query channels outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: channels-read path: /channels/read operations: - name: markchannelsread method: POST description: Mark channels as read outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: channels-type-query path: /channels/{type}/query operations: - name: getorcreatedistinctchannel method: POST description: Get or create channel outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: type in: path type: string required: true - name: body in: body type: object description: Request body (JSON). required: true - name: channels-type-id path: /channels/{type}/{id} operations: - name: deletechannel method: DELETE description: Delete channel outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: type in: path type: string required: true - name: id in: path type: string required: true - name: hard_delete in: query type: boolean - name: updatechannelpartial method: PATCH description: Partially update channel outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: type in: path type: string required: true - name: id in: path type: string required: true - name: body in: body type: object description: Request body (JSON). required: true - name: updatechannel method: POST description: Update channel outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: type in: path type: string required: true - name: id in: path type: string required: true - name: body in: body type: object description: Request body (JSON). required: true - name: channels-type-id-draft path: /channels/{type}/{id}/draft operations: - name: deletedraft method: DELETE description: Delete draft outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: type in: path type: string required: true - name: id in: path type: string required: true - name: parent_id in: query type: string - name: user_id in: query type: string - name: getdraft method: GET description: Get draft outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: type in: path type: string required: true - name: id in: path type: string required: true - name: parent_id in: query type: string - name: user_id in: query type: string - name: channels-type-id-event path: /channels/{type}/{id}/event operations: - name: sendevent method: POST description: Send event outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: type in: path type: string required: true - name: id in: path type: string required: true - name: body in: body type: object description: Request body (JSON). required: true - name: channels-type-id-file path: /channels/{type}/{id}/file operations: - name: deletechannelfile method: DELETE description: Delete file outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: type in: path type: string required: true - name: id in: path type: string required: true - name: url in: query type: string - name: uploadchannelfile method: POST description: Upload file outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: type in: path type: string required: true - name: id in: path type: string required: true - name: body in: body type: object description: Request body (JSON). required: true - name: channels-type-id-hide path: /channels/{type}/{id}/hide operations: - name: hidechannel method: POST description: Hide channel outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: type in: path type: string required: true - name: id in: path type: string required: true - name: body in: body type: object description: Request body (JSON). required: true - name: channels-type-id-image path: /channels/{type}/{id}/image operations: - name: deletechannelimage method: DELETE description: Delete image outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: type in: path type: string required: true - name: id in: path type: string required: true - name: url in: query type: string - name: uploadchannelimage method: POST description: Upload image outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: type in: path type: string required: true - name: id in: path type: string required: true - name: body in: body type: object description: Request body (JSON). required: true - name: channels-type-id-member path: /channels/{type}/{id}/member operations: - name: updatememberpartial method: PATCH description: Partially channel member update outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: type in: path type: string required: true - name: id in: path type: string required: true - name: user_id in: query type: string - name: body in: body type: object description: Request body (JSON). required: true - name: channels-type-id-message path: /channels/{type}/{id}/message operations: - name: sendmessage method: POST description: Send new message outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: type in: path type: string required: true - name: id in: path type: string required: true - name: body in: body type: object description: Request body (JSON). required: true - name: channels-type-id-messages path: /channels/{type}/{id}/messages operations: - name: getmanymessages method: GET description: Get many messages outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: type in: path type: string required: true - name: id in: path type: string required: true - name: ids in: query type: array required: true - name: channels-type-id-query path: /channels/{type}/{id}/query operations: - name: getorcreatechannel method: POST description: Get or create channel outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: type in: path type: string required: true - name: id in: path type: string required: true - name: body in: body type: object description: Request body (JSON). required: true - name: channels-type-id-read path: /channels/{type}/{id}/read operations: - name: markread method: POST description: Mark read outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: type in: path type: string required: true - name: id in: path type: string required: true - name: body in: body type: object description: Request body (JSON). required: true - name: channels-type-id-show path: /channels/{type}/{id}/show operations: - name: showchannel method: POST description: Show channel outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: type in: path type: string required: true - name: id in: path type: string required: true - name: body in: body type: object description: Request body (JSON). required: true - name: channels-type-id-truncate path: /channels/{type}/{id}/truncate operations: - name: truncatechannel method: POST description: Truncate channel outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: type in: path type: string required: true - name: id in: path type: string required: true - name: body in: body type: object description: Request body (JSON). required: true - name: channels-type-id-unread path: /channels/{type}/{id}/unread operations: - name: markunread method: POST description: Mark unread outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: type in: path type: string required: true - name: id in: path type: string required: true - name: body in: body type: object description: Request body (JSON). required: true - name: channeltypes path: /channeltypes operations: - name: listchanneltypes method: GET description: List channel types outputRawFormat: json outputParameters: - name: result type: object value: $. - name: createchanneltype method: POST description: Create channel type outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: channeltypes-name path: /channeltypes/{name} operations: - name: deletechanneltype method: DELETE description: Delete channel type outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: name in: path type: string required: true - name: getchanneltype method: GET description: Get channel type outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: name in: path type: string required: true - name: updatechanneltype method: PUT description: Update channel type outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: name in: path type: string required: true - name: body in: body type: object description: Request body (JSON). required: true - name: check_push path: /check_push operations: - name: checkpush method: POST description: Check push outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: check_sns path: /check_sns operations: - name: checksns method: POST description: Check SNS outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: check_sqs path: /check_sqs operations: - name: checksqs method: POST description: Check SQS outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: commands path: /commands operations: - name: listcommands method: GET description: List commands outputRawFormat: json outputParameters: - name: result type: object value: $. - name: createcommand method: POST description: Create command outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: commands-name path: /commands/{name} operations: - name: deletecommand method: DELETE description: Delete command outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: name in: path type: string required: true - name: getcommand method: GET description: Get command outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: name in: path type: string required: true - name: updatecommand method: PUT description: Update command outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: name in: path type: string required: true - name: body in: body type: object description: Request body (JSON). required: true - name: devices path: /devices operations: - name: deletedevice method: DELETE description: Delete device outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: query type: string required: true - name: user_id in: query type: string - name: listdevices method: GET description: List devices outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: user_id in: query type: string - name: createdevice method: POST description: Create device outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: drafts-query path: /drafts/query operations: - name: querydrafts method: POST description: Query draft messages outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: export-users path: /export/users operations: - name: exportusers method: POST description: Export users outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: export_channels path: /export_channels operations: - name: exportchannels method: POST description: Export channels outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: external_storage path: /external_storage operations: - name: listexternalstorage method: GET description: List external storage outputRawFormat: json outputParameters: - name: result type: object value: $. - name: createexternalstorage method: POST description: Create external storage outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: external_storage-name path: /external_storage/{name} operations: - name: deleteexternalstorage method: DELETE description: Delete external storage outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: name in: path type: string required: true - name: updateexternalstorage method: PUT description: Update External Storage outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: name in: path type: string required: true - name: body in: body type: object description: Request body (JSON). required: true - name: external_storage-name-check path: /external_storage/{name}/check operations: - name: checkexternalstorage method: GET description: Check External Storage outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: name in: path type: string required: true - name: guest path: /guest operations: - name: createguest method: POST description: Create Guest outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: import_urls path: /import_urls operations: - name: createimporturl method: POST description: Create import URL outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: imports path: /imports operations: - name: listimports method: GET description: Get import outputRawFormat: json outputParameters: - name: result type: object value: $. - name: createimport method: POST description: Create import outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: imports-v2 path: /imports/v2 operations: - name: listimportv2tasks method: GET description: List import v2 tasks outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: state in: query type: integer - name: createimportv2task method: POST description: Create import v2 task outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: imports-v2-external-storage path: /imports/v2/external-storage operations: - name: deleteimporterexternalstorage method: DELETE description: Delete external storage outputRawFormat: json outputParameters: - name: result type: object value: $. - name: getimporterexternalstorage method: GET description: Get external storage outputRawFormat: json outputParameters: - name: result type: object value: $. - name: upsertimporterexternalstorage method: PUT description: Upsert external storage outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: imports-v2-external-storage-validate path: /imports/v2/external-storage/validate operations: - name: validateimporterexternalstorage method: POST description: Validate external storage outputRawFormat: json outputParameters: - name: result type: object value: $. - name: imports-v2-id path: /imports/v2/{id} operations: - name: deleteimportv2task method: DELETE description: Delete import v2 task outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: string required: true - name: getimportv2task method: GET description: Get import v2 task outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: string required: true - name: imports-id path: /imports/{id} operations: - name: getimport method: GET description: Get import outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: string required: true - name: members path: /members operations: - name: querymembers method: GET description: Query members outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: payload in: query type: string - name: messages-history path: /messages/history operations: - name: querymessagehistory method: POST description: Query message history outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: messages-id path: /messages/{id} operations: - name: deletemessage method: DELETE description: Delete message outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: string required: true - name: hard in: query type: boolean - name: deleted_by in: query type: string - name: delete_for_me in: query type: boolean - name: getmessage method: GET description: Get message outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: string required: true - name: show_deleted_message in: query type: boolean - name: updatemessage method: POST description: Update message outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: string required: true - name: body in: body type: object description: Request body (JSON). required: true - name: updatemessagepartial method: PUT description: Partially message update outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: string required: true - name: body in: body type: object description: Request body (JSON). required: true - name: messages-id-action path: /messages/{id}/action operations: - name: runmessageaction method: POST description: Run message command action outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: string required: true - name: body in: body type: object description: Request body (JSON). required: true - name: messages-id-commit path: /messages/{id}/commit operations: - name: commitmessage method: POST description: Commit message outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: string required: true - name: messages-id-ephemeral path: /messages/{id}/ephemeral operations: - name: ephemeralmessageupdate method: PATCH description: Ephemeral message update outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: string required: true - name: body in: body type: object description: Request body (JSON). required: true - name: messages-id-reaction path: /messages/{id}/reaction operations: - name: sendreaction method: POST description: Send reaction outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: string required: true - name: body in: body type: object description: Request body (JSON). required: true - name: messages-id-reaction-type path: /messages/{id}/reaction/{type} operations: - name: deletereaction method: DELETE description: Delete reaction outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: string required: true - name: type in: path type: string required: true - name: user_id in: query type: string - name: messages-id-reactions path: /messages/{id}/reactions operations: - name: getreactions method: GET description: Get reactions outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: string required: true - name: limit in: query type: integer - name: offset in: query type: integer - name: queryreactions method: POST description: Get reactions on a message outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: string required: true - name: body in: body type: object description: Request body (JSON). required: true - name: messages-id-translate path: /messages/{id}/translate operations: - name: translatemessage method: POST description: Translate message outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: string required: true - name: body in: body type: object description: Request body (JSON). required: true - name: messages-id-undelete path: /messages/{id}/undelete operations: - name: undeletemessage method: POST description: Undelete message outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: string required: true - name: body in: body type: object description: Request body (JSON). required: true - name: messages-message_id-polls-poll_id-vote path: /messages/{message_id}/polls/{poll_id}/vote operations: - name: castpollvote method: POST description: Cast vote outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: message_id in: path type: string required: true - name: poll_id in: path type: string required: true - name: body in: body type: object description: Request body (JSON). required: true - name: messages-message_id-polls-poll_id-vote-vote_id path: /messages/{message_id}/polls/{poll_id}/vote/{vote_id} operations: - name: deletepollvote method: DELETE description: Delete vote outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: message_id in: path type: string required: true - name: poll_id in: path type: string required: true - name: vote_id in: path type: string required: true - name: user_id in: query type: string - name: messages-message_id-reminders path: /messages/{message_id}/reminders operations: - name: deletereminder method: DELETE description: Delete reminder outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: message_id in: path type: string required: true - name: user_id in: query type: string - name: updatereminder method: PATCH description: Updates Reminder outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: message_id in: path type: string required: true - name: body in: body type: object description: Request body (JSON). required: true - name: createreminder method: POST description: Create reminder outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: message_id in: path type: string required: true - name: body in: body type: object description: Request body (JSON). required: true - name: messages-parent_id-replies path: /messages/{parent_id}/replies operations: - name: getreplies method: GET description: Get replies outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: parent_id in: path type: string required: true - name: sort in: query type: array - name: limit in: query type: integer - name: id_gte in: query type: string - name: id_gt in: query type: string - name: id_lte in: query type: string - name: id_lt in: query type: string - name: id_around in: query type: string - name: moderation-ban path: /moderation/ban operations: - name: unban method: DELETE description: Unban user outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: target_user_id in: query type: string required: true - name: channel_cid in: query type: string - name: created_by in: query type: string - name: remove_future_channels_ban in: query type: boolean - name: reason in: query type: string - name: ban method: POST description: Ban user outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: moderation-flag path: /moderation/flag operations: - name: flag method: POST description: Flag outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: moderation-flags-message path: /moderation/flags/message operations: - name: querymessageflags method: GET description: Query Message Flags outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: payload in: query type: string - name: moderation-mute path: /moderation/mute operations: - name: muteuser method: POST description: Mute user outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: moderation-mute-channel path: /moderation/mute/channel operations: - name: mutechannel method: POST description: Mute channel outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: moderation-unmute path: /moderation/unmute operations: - name: unmuteuser method: POST description: Unmute user outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: moderation-unmute-channel path: /moderation/unmute/channel operations: - name: unmutechannel method: POST description: Unmute channel outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: og path: /og operations: - name: getog method: GET description: Get OG outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: url in: query type: string required: true - name: permissions path: /permissions operations: - name: listpermissions method: GET description: List permissions outputRawFormat: json outputParameters: - name: result type: object value: $. - name: permissions-id path: /permissions/{id} operations: - name: getpermission method: GET description: Get permission outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: string required: true - name: polls path: /polls operations: - name: createpoll method: POST description: Create poll outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: updatepoll method: PUT description: Update poll outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: polls-query path: /polls/query operations: - name: querypolls method: POST description: Query polls outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: user_id in: query type: string - name: body in: body type: object description: Request body (JSON). required: true - name: polls-poll_id path: /polls/{poll_id} operations: - name: deletepoll method: DELETE description: Delete poll outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: poll_id in: path type: string required: true - name: user_id in: query type: string - name: getpoll method: GET description: Get poll outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: poll_id in: path type: string required: true - name: user_id in: query type: string - name: updatepollpartial method: PATCH description: Partial update poll outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: poll_id in: path type: string required: true - name: body in: body type: object description: Request body (JSON). required: true - name: polls-poll_id-options path: /polls/{poll_id}/options operations: - name: createpolloption method: POST description: Create poll option outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: poll_id in: path type: string required: true - name: body in: body type: object description: Request body (JSON). required: true - name: updatepolloption method: PUT description: Update poll option outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: poll_id in: path type: string required: true - name: body in: body type: object description: Request body (JSON). required: true - name: polls-poll_id-options-option_id path: /polls/{poll_id}/options/{option_id} operations: - name: deletepolloption method: DELETE description: Delete poll option outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: poll_id in: path type: string required: true - name: option_id in: path type: string required: true - name: user_id in: query type: string - name: getpolloption method: GET description: Get poll option outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: poll_id in: path type: string required: true - name: option_id in: path type: string required: true - name: user_id in: query type: string - name: polls-poll_id-votes path: /polls/{poll_id}/votes operations: - name: querypollvotes method: POST description: Query votes outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: poll_id in: path type: string required: true - name: user_id in: query type: string - name: body in: body type: object description: Request body (JSON). required: true - name: push_preferences path: /push_preferences operations: - name: updatepushnotificationpreferences method: POST description: Push notification preferences outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: push_providers path: /push_providers operations: - name: listpushproviders method: GET description: List push providers outputRawFormat: json outputParameters: - name: result type: object value: $. - name: upsertpushprovider method: POST description: Upsert a push provider outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: push_providers-type-name path: /push_providers/{type}/{name} operations: - name: deletepushprovider method: DELETE description: Delete a push provider outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: type in: path type: string required: true - name: name in: path type: string required: true - name: push_templates path: /push_templates operations: - name: getpushtemplates method: GET description: Get push notification templates outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: push_provider_name in: query type: string - name: push_provider_type in: query type: string required: true - name: upsertpushtemplate method: POST description: Upsert a push notification template outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: query_banned_users path: /query_banned_users operations: - name: querybannedusers method: GET description: Query Banned Users outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: payload in: query type: string - name: query_future_channel_bans path: /query_future_channel_bans operations: - name: queryfuturechannelbans method: GET description: Query Future Channel Bans outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: payload in: query type: string - name: rate_limits path: /rate_limits operations: - name: getratelimits method: GET description: Get rate limits outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: server_side in: query type: boolean - name: android in: query type: boolean - name: ios in: query type: boolean - name: web in: query type: boolean - name: endpoints in: query type: string - name: reminders-query path: /reminders/query operations: - name: queryreminders method: POST description: Query reminders outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: retention_policy path: /retention_policy operations: - name: getretentionpolicy method: GET description: Get retention policy outputRawFormat: json outputParameters: - name: result type: object value: $. - name: setretentionpolicy method: POST description: Set retention policy outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: retention_policy-delete path: /retention_policy/delete operations: - name: deleteretentionpolicy method: POST description: Delete retention policy outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: retention_policy-runs path: /retention_policy/runs operations: - name: getretentionpolicyruns method: POST description: Get retention policy runs outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: roles path: /roles operations: - name: listroles method: GET description: List roles outputRawFormat: json outputParameters: - name: result type: object value: $. - name: createrole method: POST description: Create role outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: roles-name path: /roles/{name} operations: - name: deleterole method: DELETE description: Delete role outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: name in: path type: string required: true - name: search path: /search operations: - name: search method: GET description: Search messages outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: payload in: query type: string - name: segments-query path: /segments/query operations: - name: querysegments method: POST description: Query segments outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: segments-id path: /segments/{id} operations: - name: deletesegment method: DELETE description: Delete segment outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: string required: true - name: getsegment method: GET description: Get segment outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: string required: true - name: segments-id-deletetargets path: /segments/{id}/deletetargets operations: - name: deletesegmenttargets method: POST description: Delete targets from a segment outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: string required: true - name: body in: body type: object description: Request body (JSON). required: true - name: segments-id-target-target_id path: /segments/{id}/target/{target_id} operations: - name: segmenttargetexists method: GET description: Check whether a target exists in a segment outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: string required: true - name: target_id in: path type: string required: true - name: segments-id-targets-query path: /segments/{id}/targets/query operations: - name: querysegmenttargets method: POST description: Query segment targets outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: string required: true - name: body in: body type: object description: Request body (JSON). required: true - name: stats-team_usage path: /stats/team_usage operations: - name: queryteamusagestats method: POST description: Query Team Usage Statistics outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: tasks-id path: /tasks/{id} operations: - name: gettask method: GET description: Get status of a task outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: string required: true - name: threads path: /threads operations: - name: querythreads method: POST description: Query Threads outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: threads-message_id path: /threads/{message_id} operations: - name: getthread method: GET description: Get Thread outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: message_id in: path type: string required: true - name: reply_limit in: query type: integer - name: participant_limit in: query type: integer - name: member_limit in: query type: integer - name: updatethreadpartial method: PATCH description: Partially update thread outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: message_id in: path type: string required: true - name: body in: body type: object description: Request body (JSON). required: true - name: unread path: /unread operations: - name: unreadcounts method: GET description: Unread counts outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: user_id in: query type: string - name: unread_batch path: /unread_batch operations: - name: unreadcountsbatch method: POST description: Batch unread counts outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: uploads-file path: /uploads/file operations: - name: deletefile method: DELETE description: Delete file outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: url in: query type: string - name: uploadfile method: POST description: Upload file outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: uploads-image path: /uploads/image operations: - name: deleteimage method: DELETE description: Delete image outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: url in: query type: string - name: uploadimage method: POST description: Upload image outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: usergroups path: /usergroups operations: - name: listusergroups method: GET description: List user groups outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: limit in: query type: integer - name: id_gt in: query type: string - name: created_at_gt in: query type: string - name: team_id in: query type: string - name: createusergroup method: POST description: Create user group outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: usergroups-search path: /usergroups/search operations: - name: searchusergroups method: GET description: Search user groups outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: query in: query type: string required: true - name: limit in: query type: integer - name: name_gt in: query type: string - name: id_gt in: query type: string - name: team_id in: query type: string - name: usergroups-id path: /usergroups/{id} operations: - name: deleteusergroup method: DELETE description: Delete user group outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: string required: true - name: team_id in: query type: string - name: getusergroup method: GET description: Get user group outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: string required: true - name: team_id in: query type: string - name: updateusergroup method: PUT description: Update user group outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: string required: true - name: body in: body type: object description: Request body (JSON). required: true - name: usergroups-id-members path: /usergroups/{id}/members operations: - name: addusergroupmembers method: POST description: Add user group members outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: string required: true - name: body in: body type: object description: Request body (JSON). required: true - name: usergroups-id-members-delete path: /usergroups/{id}/members/delete operations: - name: removeusergroupmembers method: POST description: Remove user group members outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: string required: true - name: body in: body type: object description: Request body (JSON). required: true - name: users path: /users operations: - name: queryusers method: GET description: Query users outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: payload in: query type: string - name: updateuserspartial method: PATCH description: Partially update user outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: updateusers method: POST description: Upsert users outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: users-block path: /users/block operations: - name: getblockedusers method: GET description: Get list of blocked Users outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: user_id in: query type: string - name: blockusers method: POST description: Block user outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: users-deactivate path: /users/deactivate operations: - name: deactivateusers method: POST description: Deactivate users outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: users-delete path: /users/delete operations: - name: deleteusers method: POST description: Delete Users outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: users-live_locations path: /users/live_locations operations: - name: getuserlivelocations method: GET description: Get user live locations outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: user_id in: query type: string - name: updatelivelocation method: PUT description: Update live location outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: user_id in: query type: string - name: body in: body type: object description: Request body (JSON). required: true - name: users-reactivate path: /users/reactivate operations: - name: reactivateusers method: POST description: Reactivate users outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: users-restore path: /users/restore operations: - name: restoreusers method: POST description: Restore users outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: users-unblock path: /users/unblock operations: - name: unblockusers method: POST description: Unblock user outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: users-user_id-deactivate path: /users/{user_id}/deactivate operations: - name: deactivateuser method: POST description: Deactivate user outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: user_id in: path type: string required: true - name: body in: body type: object description: Request body (JSON). required: true - name: users-user_id-event path: /users/{user_id}/event operations: - name: sendusercustomevent method: POST description: Send user event outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: user_id in: path type: string required: true - name: body in: body type: object description: Request body (JSON). required: true - name: users-user_id-export path: /users/{user_id}/export operations: - name: exportuser method: GET description: Export user outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: user_id in: path type: string required: true - name: users-user_id-reactivate path: /users/{user_id}/reactivate operations: - name: reactivateuser method: POST description: Reactivate user outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: user_id in: path type: string required: true - name: body in: body type: object description: Request body (JSON). required: true authentication: type: apikey key: Authorization value: '{{env.STREAM_IO_API_KEY}}' placement: header exposes: - type: rest namespace: chat-product-chat-rest port: 8080 description: REST adapter for Stream API — product:chat. One Spectral-compliant resource per consumed operation, prefixed with /v1. resources: - path: /v1/app name: app description: REST surface for app. operations: - method: GET name: getapp description: Get App Settings call: chat-product-chat.getapp outputParameters: - type: object mapping: $. - method: PATCH name: updateapp description: Update App Settings call: chat-product-chat.updateapp with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/blocklists name: blocklists description: REST surface for blocklists. operations: - method: GET name: listblocklists description: List block lists call: chat-product-chat.listblocklists with: team: rest.team outputParameters: - type: object mapping: $. - method: POST name: createblocklist description: Create block list call: chat-product-chat.createblocklist with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/blocklists/{name} name: blocklists-name description: REST surface for blocklists-name. operations: - method: DELETE name: deleteblocklist description: Delete block list call: chat-product-chat.deleteblocklist with: name: rest.name team: rest.team outputParameters: - type: object mapping: $. - method: GET name: getblocklist description: Get block list call: chat-product-chat.getblocklist with: name: rest.name team: rest.team outputParameters: - type: object mapping: $. - method: PUT name: updateblocklist description: Update block list call: chat-product-chat.updateblocklist with: name: rest.name body: rest.body outputParameters: - type: object mapping: $. - path: /v1/campaigns name: campaigns description: REST surface for campaigns. operations: - method: POST name: createcampaign description: Create campaign call: chat-product-chat.createcampaign with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/campaigns/query name: campaigns-query description: REST surface for campaigns-query. operations: - method: POST name: querycampaigns description: Query campaigns call: chat-product-chat.querycampaigns with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/campaigns/{id} name: campaigns-id description: REST surface for campaigns-id. operations: - method: DELETE name: deletecampaign description: Delete campaign call: chat-product-chat.deletecampaign with: id: rest.id outputParameters: - type: object mapping: $. - method: GET name: getcampaign description: Get campaign call: chat-product-chat.getcampaign with: id: rest.id prev: rest.prev next: rest.next limit: rest.limit outputParameters: - type: object mapping: $. - method: PUT name: updatecampaign description: Update campaign call: chat-product-chat.updatecampaign with: id: rest.id body: rest.body outputParameters: - type: object mapping: $. - path: /v1/campaigns/{id}/start name: campaigns-id-start description: REST surface for campaigns-id-start. operations: - method: POST name: startcampaign description: Start/schedule campaign call: chat-product-chat.startcampaign with: id: rest.id body: rest.body outputParameters: - type: object mapping: $. - path: /v1/campaigns/{id}/stop name: campaigns-id-stop description: REST surface for campaigns-id-stop. operations: - method: POST name: stopcampaign description: Stop campaign call: chat-product-chat.stopcampaign with: id: rest.id outputParameters: - type: object mapping: $. - path: /v1/channels name: channels description: REST surface for channels. operations: - method: POST name: querychannels description: Query channels call: chat-product-chat.querychannels with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/channels/batch name: channels-batch description: REST surface for channels-batch. operations: - method: PUT name: channelbatchupdate description: Update channels in batch call: chat-product-chat.channelbatchupdate with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/channels/delete name: channels-delete description: REST surface for channels-delete. operations: - method: POST name: deletechannels description: Deletes channels asynchronously call: chat-product-chat.deletechannels with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/channels/delivered name: channels-delivered description: REST surface for channels-delivered. operations: - method: POST name: markdelivered description: Mark channel message delivery status call: chat-product-chat.markdelivered with: user_id: rest.user_id body: rest.body outputParameters: - type: object mapping: $. - path: /v1/channels/grouped name: channels-grouped description: REST surface for channels-grouped. operations: - method: POST name: groupedquerychannels description: Grouped query channels call: chat-product-chat.groupedquerychannels with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/channels/read name: channels-read description: REST surface for channels-read. operations: - method: POST name: markchannelsread description: Mark channels as read call: chat-product-chat.markchannelsread with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/channels/{type}/query name: channels-type-query description: REST surface for channels-type-query. operations: - method: POST name: getorcreatedistinctchannel description: Get or create channel call: chat-product-chat.getorcreatedistinctchannel with: type: rest.type body: rest.body outputParameters: - type: object mapping: $. - path: /v1/channels/{type}/{id} name: channels-type-id description: REST surface for channels-type-id. operations: - method: DELETE name: deletechannel description: Delete channel call: chat-product-chat.deletechannel with: type: rest.type id: rest.id hard_delete: rest.hard_delete outputParameters: - type: object mapping: $. - method: PATCH name: updatechannelpartial description: Partially update channel call: chat-product-chat.updatechannelpartial with: type: rest.type id: rest.id body: rest.body outputParameters: - type: object mapping: $. - method: POST name: updatechannel description: Update channel call: chat-product-chat.updatechannel with: type: rest.type id: rest.id body: rest.body outputParameters: - type: object mapping: $. - path: /v1/channels/{type}/{id}/draft name: channels-type-id-draft description: REST surface for channels-type-id-draft. operations: - method: DELETE name: deletedraft description: Delete draft call: chat-product-chat.deletedraft with: type: rest.type id: rest.id parent_id: rest.parent_id user_id: rest.user_id outputParameters: - type: object mapping: $. - method: GET name: getdraft description: Get draft call: chat-product-chat.getdraft with: type: rest.type id: rest.id parent_id: rest.parent_id user_id: rest.user_id outputParameters: - type: object mapping: $. - path: /v1/channels/{type}/{id}/event name: channels-type-id-event description: REST surface for channels-type-id-event. operations: - method: POST name: sendevent description: Send event call: chat-product-chat.sendevent with: type: rest.type id: rest.id body: rest.body outputParameters: - type: object mapping: $. - path: /v1/channels/{type}/{id}/file name: channels-type-id-file description: REST surface for channels-type-id-file. operations: - method: DELETE name: deletechannelfile description: Delete file call: chat-product-chat.deletechannelfile with: type: rest.type id: rest.id url: rest.url outputParameters: - type: object mapping: $. - method: POST name: uploadchannelfile description: Upload file call: chat-product-chat.uploadchannelfile with: type: rest.type id: rest.id body: rest.body outputParameters: - type: object mapping: $. - path: /v1/channels/{type}/{id}/hide name: channels-type-id-hide description: REST surface for channels-type-id-hide. operations: - method: POST name: hidechannel description: Hide channel call: chat-product-chat.hidechannel with: type: rest.type id: rest.id body: rest.body outputParameters: - type: object mapping: $. - path: /v1/channels/{type}/{id}/image name: channels-type-id-image description: REST surface for channels-type-id-image. operations: - method: DELETE name: deletechannelimage description: Delete image call: chat-product-chat.deletechannelimage with: type: rest.type id: rest.id url: rest.url outputParameters: - type: object mapping: $. - method: POST name: uploadchannelimage description: Upload image call: chat-product-chat.uploadchannelimage with: type: rest.type id: rest.id body: rest.body outputParameters: - type: object mapping: $. - path: /v1/channels/{type}/{id}/member name: channels-type-id-member description: REST surface for channels-type-id-member. operations: - method: PATCH name: updatememberpartial description: Partially channel member update call: chat-product-chat.updatememberpartial with: type: rest.type id: rest.id user_id: rest.user_id body: rest.body outputParameters: - type: object mapping: $. - path: /v1/channels/{type}/{id}/message name: channels-type-id-message description: REST surface for channels-type-id-message. operations: - method: POST name: sendmessage description: Send new message call: chat-product-chat.sendmessage with: type: rest.type id: rest.id body: rest.body outputParameters: - type: object mapping: $. - path: /v1/channels/{type}/{id}/messages name: channels-type-id-messages description: REST surface for channels-type-id-messages. operations: - method: GET name: getmanymessages description: Get many messages call: chat-product-chat.getmanymessages with: type: rest.type id: rest.id ids: rest.ids outputParameters: - type: object mapping: $. - path: /v1/channels/{type}/{id}/query name: channels-type-id-query description: REST surface for channels-type-id-query. operations: - method: POST name: getorcreatechannel description: Get or create channel call: chat-product-chat.getorcreatechannel with: type: rest.type id: rest.id body: rest.body outputParameters: - type: object mapping: $. - path: /v1/channels/{type}/{id}/read name: channels-type-id-read description: REST surface for channels-type-id-read. operations: - method: POST name: markread description: Mark read call: chat-product-chat.markread with: type: rest.type id: rest.id body: rest.body outputParameters: - type: object mapping: $. - path: /v1/channels/{type}/{id}/show name: channels-type-id-show description: REST surface for channels-type-id-show. operations: - method: POST name: showchannel description: Show channel call: chat-product-chat.showchannel with: type: rest.type id: rest.id body: rest.body outputParameters: - type: object mapping: $. - path: /v1/channels/{type}/{id}/truncate name: channels-type-id-truncate description: REST surface for channels-type-id-truncate. operations: - method: POST name: truncatechannel description: Truncate channel call: chat-product-chat.truncatechannel with: type: rest.type id: rest.id body: rest.body outputParameters: - type: object mapping: $. - path: /v1/channels/{type}/{id}/unread name: channels-type-id-unread description: REST surface for channels-type-id-unread. operations: - method: POST name: markunread description: Mark unread call: chat-product-chat.markunread with: type: rest.type id: rest.id body: rest.body outputParameters: - type: object mapping: $. - path: /v1/channeltypes name: channeltypes description: REST surface for channeltypes. operations: - method: GET name: listchanneltypes description: List channel types call: chat-product-chat.listchanneltypes outputParameters: - type: object mapping: $. - method: POST name: createchanneltype description: Create channel type call: chat-product-chat.createchanneltype with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/channeltypes/{name} name: channeltypes-name description: REST surface for channeltypes-name. operations: - method: DELETE name: deletechanneltype description: Delete channel type call: chat-product-chat.deletechanneltype with: name: rest.name outputParameters: - type: object mapping: $. - method: GET name: getchanneltype description: Get channel type call: chat-product-chat.getchanneltype with: name: rest.name outputParameters: - type: object mapping: $. - method: PUT name: updatechanneltype description: Update channel type call: chat-product-chat.updatechanneltype with: name: rest.name body: rest.body outputParameters: - type: object mapping: $. - path: /v1/check-push name: check-push description: REST surface for check_push. operations: - method: POST name: checkpush description: Check push call: chat-product-chat.checkpush with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/check-sns name: check-sns description: REST surface for check_sns. operations: - method: POST name: checksns description: Check SNS call: chat-product-chat.checksns with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/check-sqs name: check-sqs description: REST surface for check_sqs. operations: - method: POST name: checksqs description: Check SQS call: chat-product-chat.checksqs with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/commands name: commands description: REST surface for commands. operations: - method: GET name: listcommands description: List commands call: chat-product-chat.listcommands outputParameters: - type: object mapping: $. - method: POST name: createcommand description: Create command call: chat-product-chat.createcommand with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/commands/{name} name: commands-name description: REST surface for commands-name. operations: - method: DELETE name: deletecommand description: Delete command call: chat-product-chat.deletecommand with: name: rest.name outputParameters: - type: object mapping: $. - method: GET name: getcommand description: Get command call: chat-product-chat.getcommand with: name: rest.name outputParameters: - type: object mapping: $. - method: PUT name: updatecommand description: Update command call: chat-product-chat.updatecommand with: name: rest.name body: rest.body outputParameters: - type: object mapping: $. - path: /v1/devices name: devices description: REST surface for devices. operations: - method: DELETE name: deletedevice description: Delete device call: chat-product-chat.deletedevice with: id: rest.id user_id: rest.user_id outputParameters: - type: object mapping: $. - method: GET name: listdevices description: List devices call: chat-product-chat.listdevices with: user_id: rest.user_id outputParameters: - type: object mapping: $. - method: POST name: createdevice description: Create device call: chat-product-chat.createdevice with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/drafts/query name: drafts-query description: REST surface for drafts-query. operations: - method: POST name: querydrafts description: Query draft messages call: chat-product-chat.querydrafts with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/export/users name: export-users description: REST surface for export-users. operations: - method: POST name: exportusers description: Export users call: chat-product-chat.exportusers with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/export-channels name: export-channels description: REST surface for export_channels. operations: - method: POST name: exportchannels description: Export channels call: chat-product-chat.exportchannels with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/external-storage name: external-storage description: REST surface for external_storage. operations: - method: GET name: listexternalstorage description: List external storage call: chat-product-chat.listexternalstorage outputParameters: - type: object mapping: $. - method: POST name: createexternalstorage description: Create external storage call: chat-product-chat.createexternalstorage with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/external-storage/{name} name: external-storage-name description: REST surface for external_storage-name. operations: - method: DELETE name: deleteexternalstorage description: Delete external storage call: chat-product-chat.deleteexternalstorage with: name: rest.name outputParameters: - type: object mapping: $. - method: PUT name: updateexternalstorage description: Update External Storage call: chat-product-chat.updateexternalstorage with: name: rest.name body: rest.body outputParameters: - type: object mapping: $. - path: /v1/external-storage/{name}/check name: external-storage-name-check description: REST surface for external_storage-name-check. operations: - method: GET name: checkexternalstorage description: Check External Storage call: chat-product-chat.checkexternalstorage with: name: rest.name outputParameters: - type: object mapping: $. - path: /v1/guest name: guest description: REST surface for guest. operations: - method: POST name: createguest description: Create Guest call: chat-product-chat.createguest with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/import-urls name: import-urls description: REST surface for import_urls. operations: - method: POST name: createimporturl description: Create import URL call: chat-product-chat.createimporturl with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/imports name: imports description: REST surface for imports. operations: - method: GET name: listimports description: Get import call: chat-product-chat.listimports outputParameters: - type: object mapping: $. - method: POST name: createimport description: Create import call: chat-product-chat.createimport with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/imports/v2 name: imports-v2 description: REST surface for imports-v2. operations: - method: GET name: listimportv2tasks description: List import v2 tasks call: chat-product-chat.listimportv2tasks with: state: rest.state outputParameters: - type: object mapping: $. - method: POST name: createimportv2task description: Create import v2 task call: chat-product-chat.createimportv2task with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/imports/v2/external-storage name: imports-v2-external-storage description: REST surface for imports-v2-external-storage. operations: - method: DELETE name: deleteimporterexternalstorage description: Delete external storage call: chat-product-chat.deleteimporterexternalstorage outputParameters: - type: object mapping: $. - method: GET name: getimporterexternalstorage description: Get external storage call: chat-product-chat.getimporterexternalstorage outputParameters: - type: object mapping: $. - method: PUT name: upsertimporterexternalstorage description: Upsert external storage call: chat-product-chat.upsertimporterexternalstorage with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/imports/v2/external-storage/validate name: imports-v2-external-storage-validate description: REST surface for imports-v2-external-storage-validate. operations: - method: POST name: validateimporterexternalstorage description: Validate external storage call: chat-product-chat.validateimporterexternalstorage outputParameters: - type: object mapping: $. - path: /v1/imports/v2/{id} name: imports-v2-id description: REST surface for imports-v2-id. operations: - method: DELETE name: deleteimportv2task description: Delete import v2 task call: chat-product-chat.deleteimportv2task with: id: rest.id outputParameters: - type: object mapping: $. - method: GET name: getimportv2task description: Get import v2 task call: chat-product-chat.getimportv2task with: id: rest.id outputParameters: - type: object mapping: $. - path: /v1/imports/{id} name: imports-id description: REST surface for imports-id. operations: - method: GET name: getimport description: Get import call: chat-product-chat.getimport with: id: rest.id outputParameters: - type: object mapping: $. - path: /v1/members name: members description: REST surface for members. operations: - method: GET name: querymembers description: Query members call: chat-product-chat.querymembers with: payload: rest.payload outputParameters: - type: object mapping: $. - path: /v1/messages/history name: messages-history description: REST surface for messages-history. operations: - method: POST name: querymessagehistory description: Query message history call: chat-product-chat.querymessagehistory with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/messages/{id} name: messages-id description: REST surface for messages-id. operations: - method: DELETE name: deletemessage description: Delete message call: chat-product-chat.deletemessage with: id: rest.id hard: rest.hard deleted_by: rest.deleted_by delete_for_me: rest.delete_for_me outputParameters: - type: object mapping: $. - method: GET name: getmessage description: Get message call: chat-product-chat.getmessage with: id: rest.id show_deleted_message: rest.show_deleted_message outputParameters: - type: object mapping: $. - method: POST name: updatemessage description: Update message call: chat-product-chat.updatemessage with: id: rest.id body: rest.body outputParameters: - type: object mapping: $. - method: PUT name: updatemessagepartial description: Partially message update call: chat-product-chat.updatemessagepartial with: id: rest.id body: rest.body outputParameters: - type: object mapping: $. - path: /v1/messages/{id}/action name: messages-id-action description: REST surface for messages-id-action. operations: - method: POST name: runmessageaction description: Run message command action call: chat-product-chat.runmessageaction with: id: rest.id body: rest.body outputParameters: - type: object mapping: $. - path: /v1/messages/{id}/commit name: messages-id-commit description: REST surface for messages-id-commit. operations: - method: POST name: commitmessage description: Commit message call: chat-product-chat.commitmessage with: id: rest.id outputParameters: - type: object mapping: $. - path: /v1/messages/{id}/ephemeral name: messages-id-ephemeral description: REST surface for messages-id-ephemeral. operations: - method: PATCH name: ephemeralmessageupdate description: Ephemeral message update call: chat-product-chat.ephemeralmessageupdate with: id: rest.id body: rest.body outputParameters: - type: object mapping: $. - path: /v1/messages/{id}/reaction name: messages-id-reaction description: REST surface for messages-id-reaction. operations: - method: POST name: sendreaction description: Send reaction call: chat-product-chat.sendreaction with: id: rest.id body: rest.body outputParameters: - type: object mapping: $. - path: /v1/messages/{id}/reaction/{type} name: messages-id-reaction-type description: REST surface for messages-id-reaction-type. operations: - method: DELETE name: deletereaction description: Delete reaction call: chat-product-chat.deletereaction with: id: rest.id type: rest.type user_id: rest.user_id outputParameters: - type: object mapping: $. - path: /v1/messages/{id}/reactions name: messages-id-reactions description: REST surface for messages-id-reactions. operations: - method: GET name: getreactions description: Get reactions call: chat-product-chat.getreactions with: id: rest.id limit: rest.limit offset: rest.offset outputParameters: - type: object mapping: $. - method: POST name: queryreactions description: Get reactions on a message call: chat-product-chat.queryreactions with: id: rest.id body: rest.body outputParameters: - type: object mapping: $. - path: /v1/messages/{id}/translate name: messages-id-translate description: REST surface for messages-id-translate. operations: - method: POST name: translatemessage description: Translate message call: chat-product-chat.translatemessage with: id: rest.id body: rest.body outputParameters: - type: object mapping: $. - path: /v1/messages/{id}/undelete name: messages-id-undelete description: REST surface for messages-id-undelete. operations: - method: POST name: undeletemessage description: Undelete message call: chat-product-chat.undeletemessage with: id: rest.id body: rest.body outputParameters: - type: object mapping: $. - path: /v1/messages/{message-id}/polls/{poll-id}/vote name: messages-message-id-polls-poll-id-vote description: REST surface for messages-message_id-polls-poll_id-vote. operations: - method: POST name: castpollvote description: Cast vote call: chat-product-chat.castpollvote with: message_id: rest.message_id poll_id: rest.poll_id body: rest.body outputParameters: - type: object mapping: $. - path: /v1/messages/{message-id}/polls/{poll-id}/vote/{vote-id} name: messages-message-id-polls-poll-id-vote-vote-id description: REST surface for messages-message_id-polls-poll_id-vote-vote_id. operations: - method: DELETE name: deletepollvote description: Delete vote call: chat-product-chat.deletepollvote with: message_id: rest.message_id poll_id: rest.poll_id vote_id: rest.vote_id user_id: rest.user_id outputParameters: - type: object mapping: $. - path: /v1/messages/{message-id}/reminders name: messages-message-id-reminders description: REST surface for messages-message_id-reminders. operations: - method: DELETE name: deletereminder description: Delete reminder call: chat-product-chat.deletereminder with: message_id: rest.message_id user_id: rest.user_id outputParameters: - type: object mapping: $. - method: PATCH name: updatereminder description: Updates Reminder call: chat-product-chat.updatereminder with: message_id: rest.message_id body: rest.body outputParameters: - type: object mapping: $. - method: POST name: createreminder description: Create reminder call: chat-product-chat.createreminder with: message_id: rest.message_id body: rest.body outputParameters: - type: object mapping: $. - path: /v1/messages/{parent-id}/replies name: messages-parent-id-replies description: REST surface for messages-parent_id-replies. operations: - method: GET name: getreplies description: Get replies call: chat-product-chat.getreplies with: parent_id: rest.parent_id sort: rest.sort limit: rest.limit id_gte: rest.id_gte id_gt: rest.id_gt id_lte: rest.id_lte id_lt: rest.id_lt id_around: rest.id_around outputParameters: - type: object mapping: $. - path: /v1/moderation/ban name: moderation-ban description: REST surface for moderation-ban. operations: - method: DELETE name: unban description: Unban user call: chat-product-chat.unban with: target_user_id: rest.target_user_id channel_cid: rest.channel_cid created_by: rest.created_by remove_future_channels_ban: rest.remove_future_channels_ban reason: rest.reason outputParameters: - type: object mapping: $. - method: POST name: ban description: Ban user call: chat-product-chat.ban with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/moderation/flag name: moderation-flag description: REST surface for moderation-flag. operations: - method: POST name: flag description: Flag call: chat-product-chat.flag with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/moderation/flags/message name: moderation-flags-message description: REST surface for moderation-flags-message. operations: - method: GET name: querymessageflags description: Query Message Flags call: chat-product-chat.querymessageflags with: payload: rest.payload outputParameters: - type: object mapping: $. - path: /v1/moderation/mute name: moderation-mute description: REST surface for moderation-mute. operations: - method: POST name: muteuser description: Mute user call: chat-product-chat.muteuser with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/moderation/mute/channel name: moderation-mute-channel description: REST surface for moderation-mute-channel. operations: - method: POST name: mutechannel description: Mute channel call: chat-product-chat.mutechannel with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/moderation/unmute name: moderation-unmute description: REST surface for moderation-unmute. operations: - method: POST name: unmuteuser description: Unmute user call: chat-product-chat.unmuteuser with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/moderation/unmute/channel name: moderation-unmute-channel description: REST surface for moderation-unmute-channel. operations: - method: POST name: unmutechannel description: Unmute channel call: chat-product-chat.unmutechannel with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/og name: og description: REST surface for og. operations: - method: GET name: getog description: Get OG call: chat-product-chat.getog with: url: rest.url outputParameters: - type: object mapping: $. - path: /v1/permissions name: permissions description: REST surface for permissions. operations: - method: GET name: listpermissions description: List permissions call: chat-product-chat.listpermissions outputParameters: - type: object mapping: $. - path: /v1/permissions/{id} name: permissions-id description: REST surface for permissions-id. operations: - method: GET name: getpermission description: Get permission call: chat-product-chat.getpermission with: id: rest.id outputParameters: - type: object mapping: $. - path: /v1/polls name: polls description: REST surface for polls. operations: - method: POST name: createpoll description: Create poll call: chat-product-chat.createpoll with: body: rest.body outputParameters: - type: object mapping: $. - method: PUT name: updatepoll description: Update poll call: chat-product-chat.updatepoll with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/polls/query name: polls-query description: REST surface for polls-query. operations: - method: POST name: querypolls description: Query polls call: chat-product-chat.querypolls with: user_id: rest.user_id body: rest.body outputParameters: - type: object mapping: $. - path: /v1/polls/{poll-id} name: polls-poll-id description: REST surface for polls-poll_id. operations: - method: DELETE name: deletepoll description: Delete poll call: chat-product-chat.deletepoll with: poll_id: rest.poll_id user_id: rest.user_id outputParameters: - type: object mapping: $. - method: GET name: getpoll description: Get poll call: chat-product-chat.getpoll with: poll_id: rest.poll_id user_id: rest.user_id outputParameters: - type: object mapping: $. - method: PATCH name: updatepollpartial description: Partial update poll call: chat-product-chat.updatepollpartial with: poll_id: rest.poll_id body: rest.body outputParameters: - type: object mapping: $. - path: /v1/polls/{poll-id}/options name: polls-poll-id-options description: REST surface for polls-poll_id-options. operations: - method: POST name: createpolloption description: Create poll option call: chat-product-chat.createpolloption with: poll_id: rest.poll_id body: rest.body outputParameters: - type: object mapping: $. - method: PUT name: updatepolloption description: Update poll option call: chat-product-chat.updatepolloption with: poll_id: rest.poll_id body: rest.body outputParameters: - type: object mapping: $. - path: /v1/polls/{poll-id}/options/{option-id} name: polls-poll-id-options-option-id description: REST surface for polls-poll_id-options-option_id. operations: - method: DELETE name: deletepolloption description: Delete poll option call: chat-product-chat.deletepolloption with: poll_id: rest.poll_id option_id: rest.option_id user_id: rest.user_id outputParameters: - type: object mapping: $. - method: GET name: getpolloption description: Get poll option call: chat-product-chat.getpolloption with: poll_id: rest.poll_id option_id: rest.option_id user_id: rest.user_id outputParameters: - type: object mapping: $. - path: /v1/polls/{poll-id}/votes name: polls-poll-id-votes description: REST surface for polls-poll_id-votes. operations: - method: POST name: querypollvotes description: Query votes call: chat-product-chat.querypollvotes with: poll_id: rest.poll_id user_id: rest.user_id body: rest.body outputParameters: - type: object mapping: $. - path: /v1/push-preferences name: push-preferences description: REST surface for push_preferences. operations: - method: POST name: updatepushnotificationpreferences description: Push notification preferences call: chat-product-chat.updatepushnotificationpreferences with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/push-providers name: push-providers description: REST surface for push_providers. operations: - method: GET name: listpushproviders description: List push providers call: chat-product-chat.listpushproviders outputParameters: - type: object mapping: $. - method: POST name: upsertpushprovider description: Upsert a push provider call: chat-product-chat.upsertpushprovider with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/push-providers/{type}/{name} name: push-providers-type-name description: REST surface for push_providers-type-name. operations: - method: DELETE name: deletepushprovider description: Delete a push provider call: chat-product-chat.deletepushprovider with: type: rest.type name: rest.name outputParameters: - type: object mapping: $. - path: /v1/push-templates name: push-templates description: REST surface for push_templates. operations: - method: GET name: getpushtemplates description: Get push notification templates call: chat-product-chat.getpushtemplates with: push_provider_name: rest.push_provider_name push_provider_type: rest.push_provider_type outputParameters: - type: object mapping: $. - method: POST name: upsertpushtemplate description: Upsert a push notification template call: chat-product-chat.upsertpushtemplate with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/query-banned-users name: query-banned-users description: REST surface for query_banned_users. operations: - method: GET name: querybannedusers description: Query Banned Users call: chat-product-chat.querybannedusers with: payload: rest.payload outputParameters: - type: object mapping: $. - path: /v1/query-future-channel-bans name: query-future-channel-bans description: REST surface for query_future_channel_bans. operations: - method: GET name: queryfuturechannelbans description: Query Future Channel Bans call: chat-product-chat.queryfuturechannelbans with: payload: rest.payload outputParameters: - type: object mapping: $. - path: /v1/rate-limits name: rate-limits description: REST surface for rate_limits. operations: - method: GET name: getratelimits description: Get rate limits call: chat-product-chat.getratelimits with: server_side: rest.server_side android: rest.android ios: rest.ios web: rest.web endpoints: rest.endpoints outputParameters: - type: object mapping: $. - path: /v1/reminders/query name: reminders-query description: REST surface for reminders-query. operations: - method: POST name: queryreminders description: Query reminders call: chat-product-chat.queryreminders with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/retention-policy name: retention-policy description: REST surface for retention_policy. operations: - method: GET name: getretentionpolicy description: Get retention policy call: chat-product-chat.getretentionpolicy outputParameters: - type: object mapping: $. - method: POST name: setretentionpolicy description: Set retention policy call: chat-product-chat.setretentionpolicy with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/retention-policy/delete name: retention-policy-delete description: REST surface for retention_policy-delete. operations: - method: POST name: deleteretentionpolicy description: Delete retention policy call: chat-product-chat.deleteretentionpolicy with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/retention-policy/runs name: retention-policy-runs description: REST surface for retention_policy-runs. operations: - method: POST name: getretentionpolicyruns description: Get retention policy runs call: chat-product-chat.getretentionpolicyruns with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/roles name: roles description: REST surface for roles. operations: - method: GET name: listroles description: List roles call: chat-product-chat.listroles outputParameters: - type: object mapping: $. - method: POST name: createrole description: Create role call: chat-product-chat.createrole with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/roles/{name} name: roles-name description: REST surface for roles-name. operations: - method: DELETE name: deleterole description: Delete role call: chat-product-chat.deleterole with: name: rest.name outputParameters: - type: object mapping: $. - path: /v1/search name: search description: REST surface for search. operations: - method: GET name: search description: Search messages call: chat-product-chat.search with: payload: rest.payload outputParameters: - type: object mapping: $. - path: /v1/segments/query name: segments-query description: REST surface for segments-query. operations: - method: POST name: querysegments description: Query segments call: chat-product-chat.querysegments with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/segments/{id} name: segments-id description: REST surface for segments-id. operations: - method: DELETE name: deletesegment description: Delete segment call: chat-product-chat.deletesegment with: id: rest.id outputParameters: - type: object mapping: $. - method: GET name: getsegment description: Get segment call: chat-product-chat.getsegment with: id: rest.id outputParameters: - type: object mapping: $. - path: /v1/segments/{id}/deletetargets name: segments-id-deletetargets description: REST surface for segments-id-deletetargets. operations: - method: POST name: deletesegmenttargets description: Delete targets from a segment call: chat-product-chat.deletesegmenttargets with: id: rest.id body: rest.body outputParameters: - type: object mapping: $. - path: /v1/segments/{id}/target/{target-id} name: segments-id-target-target-id description: REST surface for segments-id-target-target_id. operations: - method: GET name: segmenttargetexists description: Check whether a target exists in a segment call: chat-product-chat.segmenttargetexists with: id: rest.id target_id: rest.target_id outputParameters: - type: object mapping: $. - path: /v1/segments/{id}/targets/query name: segments-id-targets-query description: REST surface for segments-id-targets-query. operations: - method: POST name: querysegmenttargets description: Query segment targets call: chat-product-chat.querysegmenttargets with: id: rest.id body: rest.body outputParameters: - type: object mapping: $. - path: /v1/stats/team-usage name: stats-team-usage description: REST surface for stats-team_usage. operations: - method: POST name: queryteamusagestats description: Query Team Usage Statistics call: chat-product-chat.queryteamusagestats with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/tasks/{id} name: tasks-id description: REST surface for tasks-id. operations: - method: GET name: gettask description: Get status of a task call: chat-product-chat.gettask with: id: rest.id outputParameters: - type: object mapping: $. - path: /v1/threads name: threads description: REST surface for threads. operations: - method: POST name: querythreads description: Query Threads call: chat-product-chat.querythreads with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/threads/{message-id} name: threads-message-id description: REST surface for threads-message_id. operations: - method: GET name: getthread description: Get Thread call: chat-product-chat.getthread with: message_id: rest.message_id reply_limit: rest.reply_limit participant_limit: rest.participant_limit member_limit: rest.member_limit outputParameters: - type: object mapping: $. - method: PATCH name: updatethreadpartial description: Partially update thread call: chat-product-chat.updatethreadpartial with: message_id: rest.message_id body: rest.body outputParameters: - type: object mapping: $. - path: /v1/unread name: unread description: REST surface for unread. operations: - method: GET name: unreadcounts description: Unread counts call: chat-product-chat.unreadcounts with: user_id: rest.user_id outputParameters: - type: object mapping: $. - path: /v1/unread-batch name: unread-batch description: REST surface for unread_batch. operations: - method: POST name: unreadcountsbatch description: Batch unread counts call: chat-product-chat.unreadcountsbatch with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/uploads/file name: uploads-file description: REST surface for uploads-file. operations: - method: DELETE name: deletefile description: Delete file call: chat-product-chat.deletefile with: url: rest.url outputParameters: - type: object mapping: $. - method: POST name: uploadfile description: Upload file call: chat-product-chat.uploadfile with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/uploads/image name: uploads-image description: REST surface for uploads-image. operations: - method: DELETE name: deleteimage description: Delete image call: chat-product-chat.deleteimage with: url: rest.url outputParameters: - type: object mapping: $. - method: POST name: uploadimage description: Upload image call: chat-product-chat.uploadimage with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/usergroups name: usergroups description: REST surface for usergroups. operations: - method: GET name: listusergroups description: List user groups call: chat-product-chat.listusergroups with: limit: rest.limit id_gt: rest.id_gt created_at_gt: rest.created_at_gt team_id: rest.team_id outputParameters: - type: object mapping: $. - method: POST name: createusergroup description: Create user group call: chat-product-chat.createusergroup with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/usergroups/search name: usergroups-search description: REST surface for usergroups-search. operations: - method: GET name: searchusergroups description: Search user groups call: chat-product-chat.searchusergroups with: query: rest.query limit: rest.limit name_gt: rest.name_gt id_gt: rest.id_gt team_id: rest.team_id outputParameters: - type: object mapping: $. - path: /v1/usergroups/{id} name: usergroups-id description: REST surface for usergroups-id. operations: - method: DELETE name: deleteusergroup description: Delete user group call: chat-product-chat.deleteusergroup with: id: rest.id team_id: rest.team_id outputParameters: - type: object mapping: $. - method: GET name: getusergroup description: Get user group call: chat-product-chat.getusergroup with: id: rest.id team_id: rest.team_id outputParameters: - type: object mapping: $. - method: PUT name: updateusergroup description: Update user group call: chat-product-chat.updateusergroup with: id: rest.id body: rest.body outputParameters: - type: object mapping: $. - path: /v1/usergroups/{id}/members name: usergroups-id-members description: REST surface for usergroups-id-members. operations: - method: POST name: addusergroupmembers description: Add user group members call: chat-product-chat.addusergroupmembers with: id: rest.id body: rest.body outputParameters: - type: object mapping: $. - path: /v1/usergroups/{id}/members/delete name: usergroups-id-members-delete description: REST surface for usergroups-id-members-delete. operations: - method: POST name: removeusergroupmembers description: Remove user group members call: chat-product-chat.removeusergroupmembers with: id: rest.id body: rest.body outputParameters: - type: object mapping: $. - path: /v1/users name: users description: REST surface for users. operations: - method: GET name: queryusers description: Query users call: chat-product-chat.queryusers with: payload: rest.payload outputParameters: - type: object mapping: $. - method: PATCH name: updateuserspartial description: Partially update user call: chat-product-chat.updateuserspartial with: body: rest.body outputParameters: - type: object mapping: $. - method: POST name: updateusers description: Upsert users call: chat-product-chat.updateusers with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/users/block name: users-block description: REST surface for users-block. operations: - method: GET name: getblockedusers description: Get list of blocked Users call: chat-product-chat.getblockedusers with: user_id: rest.user_id outputParameters: - type: object mapping: $. - method: POST name: blockusers description: Block user call: chat-product-chat.blockusers with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/users/deactivate name: users-deactivate description: REST surface for users-deactivate. operations: - method: POST name: deactivateusers description: Deactivate users call: chat-product-chat.deactivateusers with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/users/delete name: users-delete description: REST surface for users-delete. operations: - method: POST name: deleteusers description: Delete Users call: chat-product-chat.deleteusers with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/users/live-locations name: users-live-locations description: REST surface for users-live_locations. operations: - method: GET name: getuserlivelocations description: Get user live locations call: chat-product-chat.getuserlivelocations with: user_id: rest.user_id outputParameters: - type: object mapping: $. - method: PUT name: updatelivelocation description: Update live location call: chat-product-chat.updatelivelocation with: user_id: rest.user_id body: rest.body outputParameters: - type: object mapping: $. - path: /v1/users/reactivate name: users-reactivate description: REST surface for users-reactivate. operations: - method: POST name: reactivateusers description: Reactivate users call: chat-product-chat.reactivateusers with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/users/restore name: users-restore description: REST surface for users-restore. operations: - method: POST name: restoreusers description: Restore users call: chat-product-chat.restoreusers with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/users/unblock name: users-unblock description: REST surface for users-unblock. operations: - method: POST name: unblockusers description: Unblock user call: chat-product-chat.unblockusers with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/users/{user-id}/deactivate name: users-user-id-deactivate description: REST surface for users-user_id-deactivate. operations: - method: POST name: deactivateuser description: Deactivate user call: chat-product-chat.deactivateuser with: user_id: rest.user_id body: rest.body outputParameters: - type: object mapping: $. - path: /v1/users/{user-id}/event name: users-user-id-event description: REST surface for users-user_id-event. operations: - method: POST name: sendusercustomevent description: Send user event call: chat-product-chat.sendusercustomevent with: user_id: rest.user_id body: rest.body outputParameters: - type: object mapping: $. - path: /v1/users/{user-id}/export name: users-user-id-export description: REST surface for users-user_id-export. operations: - method: GET name: exportuser description: Export user call: chat-product-chat.exportuser with: user_id: rest.user_id outputParameters: - type: object mapping: $. - path: /v1/users/{user-id}/reactivate name: users-user-id-reactivate description: REST surface for users-user_id-reactivate. operations: - method: POST name: reactivateuser description: Reactivate user call: chat-product-chat.reactivateuser with: user_id: rest.user_id body: rest.body outputParameters: - type: object mapping: $. - type: mcp namespace: chat-product-chat-mcp port: 9090 transport: http description: MCP adapter for Stream API — product:chat. One tool per consumed operation, routed inline through this capability's consumes block. tools: - name: get-app-settings description: Get App Settings hints: readOnly: true destructive: false idempotent: true call: chat-product-chat.getapp outputParameters: - type: object mapping: $. - name: update-app-settings description: Update App Settings hints: readOnly: false destructive: false idempotent: true call: chat-product-chat.updateapp with: body: tools.body outputParameters: - type: object mapping: $. - name: list-block-lists description: List block lists hints: readOnly: true destructive: false idempotent: true call: chat-product-chat.listblocklists with: team: tools.team outputParameters: - type: object mapping: $. - name: create-block-list description: Create block list hints: readOnly: false destructive: false idempotent: false call: chat-product-chat.createblocklist with: body: tools.body outputParameters: - type: object mapping: $. - name: delete-block-list description: Delete block list hints: readOnly: false destructive: true idempotent: true call: chat-product-chat.deleteblocklist with: name: tools.name team: tools.team outputParameters: - type: object mapping: $. - name: get-block-list description: Get block list hints: readOnly: true destructive: false idempotent: true call: chat-product-chat.getblocklist with: name: tools.name team: tools.team outputParameters: - type: object mapping: $. - name: update-block-list description: Update block list hints: readOnly: false destructive: false idempotent: true call: chat-product-chat.updateblocklist with: name: tools.name body: tools.body outputParameters: - type: object mapping: $. - name: create-campaign description: Create campaign hints: readOnly: false destructive: false idempotent: false call: chat-product-chat.createcampaign with: body: tools.body outputParameters: - type: object mapping: $. - name: query-campaigns description: Query campaigns hints: readOnly: true destructive: false idempotent: false call: chat-product-chat.querycampaigns with: body: tools.body outputParameters: - type: object mapping: $. - name: delete-campaign description: Delete campaign hints: readOnly: false destructive: true idempotent: true call: chat-product-chat.deletecampaign with: id: tools.id outputParameters: - type: object mapping: $. - name: get-campaign description: Get campaign hints: readOnly: true destructive: false idempotent: true call: chat-product-chat.getcampaign with: id: tools.id prev: tools.prev next: tools.next limit: tools.limit outputParameters: - type: object mapping: $. - name: update-campaign description: Update campaign hints: readOnly: false destructive: false idempotent: true call: chat-product-chat.updatecampaign with: id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: start-schedule-campaign description: Start/schedule campaign hints: readOnly: false destructive: false idempotent: false call: chat-product-chat.startcampaign with: id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: stop-campaign description: Stop campaign hints: readOnly: false destructive: false idempotent: false call: chat-product-chat.stopcampaign with: id: tools.id outputParameters: - type: object mapping: $. - name: query-channels description: Query channels hints: readOnly: true destructive: false idempotent: false call: chat-product-chat.querychannels with: body: tools.body outputParameters: - type: object mapping: $. - name: update-channels-batch description: Update channels in batch hints: readOnly: false destructive: false idempotent: true call: chat-product-chat.channelbatchupdate with: body: tools.body outputParameters: - type: object mapping: $. - name: deletes-channels-asynchronously description: Deletes channels asynchronously hints: readOnly: false destructive: false idempotent: false call: chat-product-chat.deletechannels with: body: tools.body outputParameters: - type: object mapping: $. - name: mark-channel-message-delivery-status description: Mark channel message delivery status hints: readOnly: false destructive: false idempotent: false call: chat-product-chat.markdelivered with: user_id: tools.user_id body: tools.body outputParameters: - type: object mapping: $. - name: grouped-query-channels description: Grouped query channels hints: readOnly: true destructive: false idempotent: false call: chat-product-chat.groupedquerychannels with: body: tools.body outputParameters: - type: object mapping: $. - name: mark-channels-read description: Mark channels as read hints: readOnly: false destructive: false idempotent: false call: chat-product-chat.markchannelsread with: body: tools.body outputParameters: - type: object mapping: $. - name: get-create-channel description: Get or create channel hints: readOnly: true destructive: false idempotent: false call: chat-product-chat.getorcreatedistinctchannel with: type: tools.type body: tools.body outputParameters: - type: object mapping: $. - name: delete-channel description: Delete channel hints: readOnly: false destructive: true idempotent: true call: chat-product-chat.deletechannel with: type: tools.type id: tools.id hard_delete: tools.hard_delete outputParameters: - type: object mapping: $. - name: partially-update-channel description: Partially update channel hints: readOnly: false destructive: false idempotent: true call: chat-product-chat.updatechannelpartial with: type: tools.type id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: update-channel description: Update channel hints: readOnly: false destructive: false idempotent: false call: chat-product-chat.updatechannel with: type: tools.type id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: delete-draft description: Delete draft hints: readOnly: false destructive: true idempotent: true call: chat-product-chat.deletedraft with: type: tools.type id: tools.id parent_id: tools.parent_id user_id: tools.user_id outputParameters: - type: object mapping: $. - name: get-draft description: Get draft hints: readOnly: true destructive: false idempotent: true call: chat-product-chat.getdraft with: type: tools.type id: tools.id parent_id: tools.parent_id user_id: tools.user_id outputParameters: - type: object mapping: $. - name: send-event description: Send event hints: readOnly: false destructive: false idempotent: false call: chat-product-chat.sendevent with: type: tools.type id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: delete-file description: Delete file hints: readOnly: false destructive: true idempotent: true call: chat-product-chat.deletechannelfile with: type: tools.type id: tools.id url: tools.url outputParameters: - type: object mapping: $. - name: upload-file description: Upload file hints: readOnly: false destructive: false idempotent: false call: chat-product-chat.uploadchannelfile with: type: tools.type id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: hide-channel description: Hide channel hints: readOnly: false destructive: false idempotent: false call: chat-product-chat.hidechannel with: type: tools.type id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: delete-image description: Delete image hints: readOnly: false destructive: true idempotent: true call: chat-product-chat.deletechannelimage with: type: tools.type id: tools.id url: tools.url outputParameters: - type: object mapping: $. - name: upload-image description: Upload image hints: readOnly: false destructive: false idempotent: false call: chat-product-chat.uploadchannelimage with: type: tools.type id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: partially-channel-member-update description: Partially channel member update hints: readOnly: false destructive: false idempotent: true call: chat-product-chat.updatememberpartial with: type: tools.type id: tools.id user_id: tools.user_id body: tools.body outputParameters: - type: object mapping: $. - name: send-new-message description: Send new message hints: readOnly: false destructive: false idempotent: false call: chat-product-chat.sendmessage with: type: tools.type id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: get-many-messages description: Get many messages hints: readOnly: true destructive: false idempotent: true call: chat-product-chat.getmanymessages with: type: tools.type id: tools.id ids: tools.ids outputParameters: - type: object mapping: $. - name: get-create-channel-2 description: Get or create channel hints: readOnly: true destructive: false idempotent: false call: chat-product-chat.getorcreatechannel with: type: tools.type id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: mark-read description: Mark read hints: readOnly: false destructive: false idempotent: false call: chat-product-chat.markread with: type: tools.type id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: show-channel description: Show channel hints: readOnly: false destructive: false idempotent: false call: chat-product-chat.showchannel with: type: tools.type id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: truncate-channel description: Truncate channel hints: readOnly: false destructive: false idempotent: false call: chat-product-chat.truncatechannel with: type: tools.type id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: mark-unread description: Mark unread hints: readOnly: false destructive: false idempotent: false call: chat-product-chat.markunread with: type: tools.type id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: list-channel-types description: List channel types hints: readOnly: true destructive: false idempotent: true call: chat-product-chat.listchanneltypes outputParameters: - type: object mapping: $. - name: create-channel-type description: Create channel type hints: readOnly: false destructive: false idempotent: false call: chat-product-chat.createchanneltype with: body: tools.body outputParameters: - type: object mapping: $. - name: delete-channel-type description: Delete channel type hints: readOnly: false destructive: true idempotent: true call: chat-product-chat.deletechanneltype with: name: tools.name outputParameters: - type: object mapping: $. - name: get-channel-type description: Get channel type hints: readOnly: true destructive: false idempotent: true call: chat-product-chat.getchanneltype with: name: tools.name outputParameters: - type: object mapping: $. - name: update-channel-type description: Update channel type hints: readOnly: false destructive: false idempotent: true call: chat-product-chat.updatechanneltype with: name: tools.name body: tools.body outputParameters: - type: object mapping: $. - name: check-push description: Check push hints: readOnly: true destructive: false idempotent: false call: chat-product-chat.checkpush with: body: tools.body outputParameters: - type: object mapping: $. - name: check-sns description: Check SNS hints: readOnly: true destructive: false idempotent: false call: chat-product-chat.checksns with: body: tools.body outputParameters: - type: object mapping: $. - name: check-sqs description: Check SQS hints: readOnly: true destructive: false idempotent: false call: chat-product-chat.checksqs with: body: tools.body outputParameters: - type: object mapping: $. - name: list-commands description: List commands hints: readOnly: true destructive: false idempotent: true call: chat-product-chat.listcommands outputParameters: - type: object mapping: $. - name: create-command description: Create command hints: readOnly: false destructive: false idempotent: false call: chat-product-chat.createcommand with: body: tools.body outputParameters: - type: object mapping: $. - name: delete-command description: Delete command hints: readOnly: false destructive: true idempotent: true call: chat-product-chat.deletecommand with: name: tools.name outputParameters: - type: object mapping: $. - name: get-command description: Get command hints: readOnly: true destructive: false idempotent: true call: chat-product-chat.getcommand with: name: tools.name outputParameters: - type: object mapping: $. - name: update-command description: Update command hints: readOnly: false destructive: false idempotent: true call: chat-product-chat.updatecommand with: name: tools.name body: tools.body outputParameters: - type: object mapping: $. - name: delete-device description: Delete device hints: readOnly: false destructive: true idempotent: true call: chat-product-chat.deletedevice with: id: tools.id user_id: tools.user_id outputParameters: - type: object mapping: $. - name: list-devices description: List devices hints: readOnly: true destructive: false idempotent: true call: chat-product-chat.listdevices with: user_id: tools.user_id outputParameters: - type: object mapping: $. - name: create-device description: Create device hints: readOnly: false destructive: false idempotent: false call: chat-product-chat.createdevice with: body: tools.body outputParameters: - type: object mapping: $. - name: query-draft-messages description: Query draft messages hints: readOnly: true destructive: false idempotent: false call: chat-product-chat.querydrafts with: body: tools.body outputParameters: - type: object mapping: $. - name: export-users description: Export users hints: readOnly: false destructive: false idempotent: false call: chat-product-chat.exportusers with: body: tools.body outputParameters: - type: object mapping: $. - name: export-channels description: Export channels hints: readOnly: false destructive: false idempotent: false call: chat-product-chat.exportchannels with: body: tools.body outputParameters: - type: object mapping: $. - name: list-external-storage description: List external storage hints: readOnly: true destructive: false idempotent: true call: chat-product-chat.listexternalstorage outputParameters: - type: object mapping: $. - name: create-external-storage description: Create external storage hints: readOnly: false destructive: false idempotent: false call: chat-product-chat.createexternalstorage with: body: tools.body outputParameters: - type: object mapping: $. - name: delete-external-storage description: Delete external storage hints: readOnly: false destructive: true idempotent: true call: chat-product-chat.deleteexternalstorage with: name: tools.name outputParameters: - type: object mapping: $. - name: update-external-storage description: Update External Storage hints: readOnly: false destructive: false idempotent: true call: chat-product-chat.updateexternalstorage with: name: tools.name body: tools.body outputParameters: - type: object mapping: $. - name: check-external-storage description: Check External Storage hints: readOnly: true destructive: false idempotent: true call: chat-product-chat.checkexternalstorage with: name: tools.name outputParameters: - type: object mapping: $. - name: create-guest description: Create Guest hints: readOnly: false destructive: false idempotent: false call: chat-product-chat.createguest with: body: tools.body outputParameters: - type: object mapping: $. - name: create-import-url description: Create import URL hints: readOnly: false destructive: false idempotent: false call: chat-product-chat.createimporturl with: body: tools.body outputParameters: - type: object mapping: $. - name: get-import description: Get import hints: readOnly: true destructive: false idempotent: true call: chat-product-chat.listimports outputParameters: - type: object mapping: $. - name: create-import description: Create import hints: readOnly: false destructive: false idempotent: false call: chat-product-chat.createimport with: body: tools.body outputParameters: - type: object mapping: $. - name: list-import-v2-tasks description: List import v2 tasks hints: readOnly: true destructive: false idempotent: true call: chat-product-chat.listimportv2tasks with: state: tools.state outputParameters: - type: object mapping: $. - name: create-import-v2-task description: Create import v2 task hints: readOnly: false destructive: false idempotent: false call: chat-product-chat.createimportv2task with: body: tools.body outputParameters: - type: object mapping: $. - name: delete-external-storage-2 description: Delete external storage hints: readOnly: false destructive: true idempotent: true call: chat-product-chat.deleteimporterexternalstorage outputParameters: - type: object mapping: $. - name: get-external-storage description: Get external storage hints: readOnly: true destructive: false idempotent: true call: chat-product-chat.getimporterexternalstorage outputParameters: - type: object mapping: $. - name: upsert-external-storage description: Upsert external storage hints: readOnly: false destructive: false idempotent: true call: chat-product-chat.upsertimporterexternalstorage with: body: tools.body outputParameters: - type: object mapping: $. - name: validate-external-storage description: Validate external storage hints: readOnly: true destructive: false idempotent: false call: chat-product-chat.validateimporterexternalstorage outputParameters: - type: object mapping: $. - name: delete-import-v2-task description: Delete import v2 task hints: readOnly: false destructive: true idempotent: true call: chat-product-chat.deleteimportv2task with: id: tools.id outputParameters: - type: object mapping: $. - name: get-import-v2-task description: Get import v2 task hints: readOnly: true destructive: false idempotent: true call: chat-product-chat.getimportv2task with: id: tools.id outputParameters: - type: object mapping: $. - name: get-import-2 description: Get import hints: readOnly: true destructive: false idempotent: true call: chat-product-chat.getimport with: id: tools.id outputParameters: - type: object mapping: $. - name: query-members description: Query members hints: readOnly: true destructive: false idempotent: true call: chat-product-chat.querymembers with: payload: tools.payload outputParameters: - type: object mapping: $. - name: query-message-history description: Query message history hints: readOnly: true destructive: false idempotent: false call: chat-product-chat.querymessagehistory with: body: tools.body outputParameters: - type: object mapping: $. - name: delete-message description: Delete message hints: readOnly: false destructive: true idempotent: true call: chat-product-chat.deletemessage with: id: tools.id hard: tools.hard deleted_by: tools.deleted_by delete_for_me: tools.delete_for_me outputParameters: - type: object mapping: $. - name: get-message description: Get message hints: readOnly: true destructive: false idempotent: true call: chat-product-chat.getmessage with: id: tools.id show_deleted_message: tools.show_deleted_message outputParameters: - type: object mapping: $. - name: update-message description: Update message hints: readOnly: false destructive: false idempotent: false call: chat-product-chat.updatemessage with: id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: partially-message-update description: Partially message update hints: readOnly: false destructive: false idempotent: true call: chat-product-chat.updatemessagepartial with: id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: run-message-command-action description: Run message command action hints: readOnly: false destructive: false idempotent: false call: chat-product-chat.runmessageaction with: id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: commit-message description: Commit message hints: readOnly: false destructive: false idempotent: false call: chat-product-chat.commitmessage with: id: tools.id outputParameters: - type: object mapping: $. - name: ephemeral-message-update description: Ephemeral message update hints: readOnly: false destructive: false idempotent: true call: chat-product-chat.ephemeralmessageupdate with: id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: send-reaction description: Send reaction hints: readOnly: false destructive: false idempotent: false call: chat-product-chat.sendreaction with: id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: delete-reaction description: Delete reaction hints: readOnly: false destructive: true idempotent: true call: chat-product-chat.deletereaction with: id: tools.id type: tools.type user_id: tools.user_id outputParameters: - type: object mapping: $. - name: get-reactions description: Get reactions hints: readOnly: true destructive: false idempotent: true call: chat-product-chat.getreactions with: id: tools.id limit: tools.limit offset: tools.offset outputParameters: - type: object mapping: $. - name: get-reactions-message description: Get reactions on a message hints: readOnly: true destructive: false idempotent: false call: chat-product-chat.queryreactions with: id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: translate-message description: Translate message hints: readOnly: false destructive: false idempotent: false call: chat-product-chat.translatemessage with: id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: undelete-message description: Undelete message hints: readOnly: false destructive: false idempotent: false call: chat-product-chat.undeletemessage with: id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: cast-vote description: Cast vote hints: readOnly: false destructive: false idempotent: false call: chat-product-chat.castpollvote with: message_id: tools.message_id poll_id: tools.poll_id body: tools.body outputParameters: - type: object mapping: $. - name: delete-vote description: Delete vote hints: readOnly: false destructive: true idempotent: true call: chat-product-chat.deletepollvote with: message_id: tools.message_id poll_id: tools.poll_id vote_id: tools.vote_id user_id: tools.user_id outputParameters: - type: object mapping: $. - name: delete-reminder description: Delete reminder hints: readOnly: false destructive: true idempotent: true call: chat-product-chat.deletereminder with: message_id: tools.message_id user_id: tools.user_id outputParameters: - type: object mapping: $. - name: updates-reminder description: Updates Reminder hints: readOnly: false destructive: false idempotent: true call: chat-product-chat.updatereminder with: message_id: tools.message_id body: tools.body outputParameters: - type: object mapping: $. - name: create-reminder description: Create reminder hints: readOnly: false destructive: false idempotent: false call: chat-product-chat.createreminder with: message_id: tools.message_id body: tools.body outputParameters: - type: object mapping: $. - name: get-replies description: Get replies hints: readOnly: true destructive: false idempotent: true call: chat-product-chat.getreplies with: parent_id: tools.parent_id sort: tools.sort limit: tools.limit id_gte: tools.id_gte id_gt: tools.id_gt id_lte: tools.id_lte id_lt: tools.id_lt id_around: tools.id_around outputParameters: - type: object mapping: $. - name: unban-user description: Unban user hints: readOnly: false destructive: true idempotent: true call: chat-product-chat.unban with: target_user_id: tools.target_user_id channel_cid: tools.channel_cid created_by: tools.created_by remove_future_channels_ban: tools.remove_future_channels_ban reason: tools.reason outputParameters: - type: object mapping: $. - name: ban-user description: Ban user hints: readOnly: false destructive: false idempotent: false call: chat-product-chat.ban with: body: tools.body outputParameters: - type: object mapping: $. - name: flag description: Flag hints: readOnly: false destructive: false idempotent: false call: chat-product-chat.flag with: body: tools.body outputParameters: - type: object mapping: $. - name: query-message-flags description: Query Message Flags hints: readOnly: true destructive: false idempotent: true call: chat-product-chat.querymessageflags with: payload: tools.payload outputParameters: - type: object mapping: $. - name: mute-user description: Mute user hints: readOnly: false destructive: false idempotent: false call: chat-product-chat.muteuser with: body: tools.body outputParameters: - type: object mapping: $. - name: mute-channel description: Mute channel hints: readOnly: false destructive: false idempotent: false call: chat-product-chat.mutechannel with: body: tools.body outputParameters: - type: object mapping: $. - name: unmute-user description: Unmute user hints: readOnly: false destructive: false idempotent: false call: chat-product-chat.unmuteuser with: body: tools.body outputParameters: - type: object mapping: $. - name: unmute-channel description: Unmute channel hints: readOnly: false destructive: false idempotent: false call: chat-product-chat.unmutechannel with: body: tools.body outputParameters: - type: object mapping: $. - name: get-og description: Get OG hints: readOnly: true destructive: false idempotent: true call: chat-product-chat.getog with: url: tools.url outputParameters: - type: object mapping: $. - name: list-permissions description: List permissions hints: readOnly: true destructive: false idempotent: true call: chat-product-chat.listpermissions outputParameters: - type: object mapping: $. - name: get-permission description: Get permission hints: readOnly: true destructive: false idempotent: true call: chat-product-chat.getpermission with: id: tools.id outputParameters: - type: object mapping: $. - name: create-poll description: Create poll hints: readOnly: false destructive: false idempotent: false call: chat-product-chat.createpoll with: body: tools.body outputParameters: - type: object mapping: $. - name: update-poll description: Update poll hints: readOnly: false destructive: false idempotent: true call: chat-product-chat.updatepoll with: body: tools.body outputParameters: - type: object mapping: $. - name: query-polls description: Query polls hints: readOnly: true destructive: false idempotent: false call: chat-product-chat.querypolls with: user_id: tools.user_id body: tools.body outputParameters: - type: object mapping: $. - name: delete-poll description: Delete poll hints: readOnly: false destructive: true idempotent: true call: chat-product-chat.deletepoll with: poll_id: tools.poll_id user_id: tools.user_id outputParameters: - type: object mapping: $. - name: get-poll description: Get poll hints: readOnly: true destructive: false idempotent: true call: chat-product-chat.getpoll with: poll_id: tools.poll_id user_id: tools.user_id outputParameters: - type: object mapping: $. - name: partial-update-poll description: Partial update poll hints: readOnly: false destructive: false idempotent: true call: chat-product-chat.updatepollpartial with: poll_id: tools.poll_id body: tools.body outputParameters: - type: object mapping: $. - name: create-poll-option description: Create poll option hints: readOnly: false destructive: false idempotent: false call: chat-product-chat.createpolloption with: poll_id: tools.poll_id body: tools.body outputParameters: - type: object mapping: $. - name: update-poll-option description: Update poll option hints: readOnly: false destructive: false idempotent: true call: chat-product-chat.updatepolloption with: poll_id: tools.poll_id body: tools.body outputParameters: - type: object mapping: $. - name: delete-poll-option description: Delete poll option hints: readOnly: false destructive: true idempotent: true call: chat-product-chat.deletepolloption with: poll_id: tools.poll_id option_id: tools.option_id user_id: tools.user_id outputParameters: - type: object mapping: $. - name: get-poll-option description: Get poll option hints: readOnly: true destructive: false idempotent: true call: chat-product-chat.getpolloption with: poll_id: tools.poll_id option_id: tools.option_id user_id: tools.user_id outputParameters: - type: object mapping: $. - name: query-votes description: Query votes hints: readOnly: true destructive: false idempotent: false call: chat-product-chat.querypollvotes with: poll_id: tools.poll_id user_id: tools.user_id body: tools.body outputParameters: - type: object mapping: $. - name: push-notification-preferences description: Push notification preferences hints: readOnly: false destructive: false idempotent: false call: chat-product-chat.updatepushnotificationpreferences with: body: tools.body outputParameters: - type: object mapping: $. - name: list-push-providers description: List push providers hints: readOnly: true destructive: false idempotent: true call: chat-product-chat.listpushproviders outputParameters: - type: object mapping: $. - name: upsert-push-provider description: Upsert a push provider hints: readOnly: false destructive: false idempotent: false call: chat-product-chat.upsertpushprovider with: body: tools.body outputParameters: - type: object mapping: $. - name: delete-push-provider description: Delete a push provider hints: readOnly: false destructive: true idempotent: true call: chat-product-chat.deletepushprovider with: type: tools.type name: tools.name outputParameters: - type: object mapping: $. - name: get-push-notification-templates description: Get push notification templates hints: readOnly: true destructive: false idempotent: true call: chat-product-chat.getpushtemplates with: push_provider_name: tools.push_provider_name push_provider_type: tools.push_provider_type outputParameters: - type: object mapping: $. - name: upsert-push-notification-template description: Upsert a push notification template hints: readOnly: false destructive: false idempotent: false call: chat-product-chat.upsertpushtemplate with: body: tools.body outputParameters: - type: object mapping: $. - name: query-banned-users description: Query Banned Users hints: readOnly: true destructive: false idempotent: true call: chat-product-chat.querybannedusers with: payload: tools.payload outputParameters: - type: object mapping: $. - name: query-future-channel-bans description: Query Future Channel Bans hints: readOnly: true destructive: false idempotent: true call: chat-product-chat.queryfuturechannelbans with: payload: tools.payload outputParameters: - type: object mapping: $. - name: get-rate-limits description: Get rate limits hints: readOnly: true destructive: false idempotent: true call: chat-product-chat.getratelimits with: server_side: tools.server_side android: tools.android ios: tools.ios web: tools.web endpoints: tools.endpoints outputParameters: - type: object mapping: $. - name: query-reminders description: Query reminders hints: readOnly: true destructive: false idempotent: false call: chat-product-chat.queryreminders with: body: tools.body outputParameters: - type: object mapping: $. - name: get-retention-policy description: Get retention policy hints: readOnly: true destructive: false idempotent: true call: chat-product-chat.getretentionpolicy outputParameters: - type: object mapping: $. - name: set-retention-policy description: Set retention policy hints: readOnly: false destructive: false idempotent: false call: chat-product-chat.setretentionpolicy with: body: tools.body outputParameters: - type: object mapping: $. - name: delete-retention-policy description: Delete retention policy hints: readOnly: false destructive: false idempotent: false call: chat-product-chat.deleteretentionpolicy with: body: tools.body outputParameters: - type: object mapping: $. - name: get-retention-policy-runs description: Get retention policy runs hints: readOnly: true destructive: false idempotent: false call: chat-product-chat.getretentionpolicyruns with: body: tools.body outputParameters: - type: object mapping: $. - name: list-roles description: List roles hints: readOnly: true destructive: false idempotent: true call: chat-product-chat.listroles outputParameters: - type: object mapping: $. - name: create-role description: Create role hints: readOnly: false destructive: false idempotent: false call: chat-product-chat.createrole with: body: tools.body outputParameters: - type: object mapping: $. - name: delete-role description: Delete role hints: readOnly: false destructive: true idempotent: true call: chat-product-chat.deleterole with: name: tools.name outputParameters: - type: object mapping: $. - name: search-messages description: Search messages hints: readOnly: true destructive: false idempotent: true call: chat-product-chat.search with: payload: tools.payload outputParameters: - type: object mapping: $. - name: query-segments description: Query segments hints: readOnly: true destructive: false idempotent: false call: chat-product-chat.querysegments with: body: tools.body outputParameters: - type: object mapping: $. - name: delete-segment description: Delete segment hints: readOnly: false destructive: true idempotent: true call: chat-product-chat.deletesegment with: id: tools.id outputParameters: - type: object mapping: $. - name: get-segment description: Get segment hints: readOnly: true destructive: false idempotent: true call: chat-product-chat.getsegment with: id: tools.id outputParameters: - type: object mapping: $. - name: delete-targets-segment description: Delete targets from a segment hints: readOnly: false destructive: false idempotent: false call: chat-product-chat.deletesegmenttargets with: id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: check-whether-target-exists-segment description: Check whether a target exists in a segment hints: readOnly: true destructive: false idempotent: true call: chat-product-chat.segmenttargetexists with: id: tools.id target_id: tools.target_id outputParameters: - type: object mapping: $. - name: query-segment-targets description: Query segment targets hints: readOnly: true destructive: false idempotent: false call: chat-product-chat.querysegmenttargets with: id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: query-team-usage-statistics description: Query Team Usage Statistics hints: readOnly: true destructive: false idempotent: false call: chat-product-chat.queryteamusagestats with: body: tools.body outputParameters: - type: object mapping: $. - name: get-status-task description: Get status of a task hints: readOnly: true destructive: false idempotent: true call: chat-product-chat.gettask with: id: tools.id outputParameters: - type: object mapping: $. - name: query-threads description: Query Threads hints: readOnly: true destructive: false idempotent: false call: chat-product-chat.querythreads with: body: tools.body outputParameters: - type: object mapping: $. - name: get-thread description: Get Thread hints: readOnly: true destructive: false idempotent: true call: chat-product-chat.getthread with: message_id: tools.message_id reply_limit: tools.reply_limit participant_limit: tools.participant_limit member_limit: tools.member_limit outputParameters: - type: object mapping: $. - name: partially-update-thread description: Partially update thread hints: readOnly: false destructive: false idempotent: true call: chat-product-chat.updatethreadpartial with: message_id: tools.message_id body: tools.body outputParameters: - type: object mapping: $. - name: unread-counts description: Unread counts hints: readOnly: true destructive: false idempotent: true call: chat-product-chat.unreadcounts with: user_id: tools.user_id outputParameters: - type: object mapping: $. - name: batch-unread-counts description: Batch unread counts hints: readOnly: false destructive: false idempotent: false call: chat-product-chat.unreadcountsbatch with: body: tools.body outputParameters: - type: object mapping: $. - name: delete-file-2 description: Delete file hints: readOnly: false destructive: true idempotent: true call: chat-product-chat.deletefile with: url: tools.url outputParameters: - type: object mapping: $. - name: upload-file-2 description: Upload file hints: readOnly: false destructive: false idempotent: false call: chat-product-chat.uploadfile with: body: tools.body outputParameters: - type: object mapping: $. - name: delete-image-2 description: Delete image hints: readOnly: false destructive: true idempotent: true call: chat-product-chat.deleteimage with: url: tools.url outputParameters: - type: object mapping: $. - name: upload-image-2 description: Upload image hints: readOnly: false destructive: false idempotent: false call: chat-product-chat.uploadimage with: body: tools.body outputParameters: - type: object mapping: $. - name: list-user-groups description: List user groups hints: readOnly: true destructive: false idempotent: true call: chat-product-chat.listusergroups with: limit: tools.limit id_gt: tools.id_gt created_at_gt: tools.created_at_gt team_id: tools.team_id outputParameters: - type: object mapping: $. - name: create-user-group description: Create user group hints: readOnly: false destructive: false idempotent: false call: chat-product-chat.createusergroup with: body: tools.body outputParameters: - type: object mapping: $. - name: search-user-groups description: Search user groups hints: readOnly: true destructive: false idempotent: true call: chat-product-chat.searchusergroups with: query: tools.query limit: tools.limit name_gt: tools.name_gt id_gt: tools.id_gt team_id: tools.team_id outputParameters: - type: object mapping: $. - name: delete-user-group description: Delete user group hints: readOnly: false destructive: true idempotent: true call: chat-product-chat.deleteusergroup with: id: tools.id team_id: tools.team_id outputParameters: - type: object mapping: $. - name: get-user-group description: Get user group hints: readOnly: true destructive: false idempotent: true call: chat-product-chat.getusergroup with: id: tools.id team_id: tools.team_id outputParameters: - type: object mapping: $. - name: update-user-group description: Update user group hints: readOnly: false destructive: false idempotent: true call: chat-product-chat.updateusergroup with: id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: add-user-group-members description: Add user group members hints: readOnly: false destructive: false idempotent: false call: chat-product-chat.addusergroupmembers with: id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: remove-user-group-members description: Remove user group members hints: readOnly: false destructive: false idempotent: false call: chat-product-chat.removeusergroupmembers with: id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: query-users description: Query users hints: readOnly: true destructive: false idempotent: true call: chat-product-chat.queryusers with: payload: tools.payload outputParameters: - type: object mapping: $. - name: partially-update-user description: Partially update user hints: readOnly: false destructive: false idempotent: true call: chat-product-chat.updateuserspartial with: body: tools.body outputParameters: - type: object mapping: $. - name: upsert-users description: Upsert users hints: readOnly: false destructive: false idempotent: false call: chat-product-chat.updateusers with: body: tools.body outputParameters: - type: object mapping: $. - name: get-list-blocked-users description: Get list of blocked Users hints: readOnly: true destructive: false idempotent: true call: chat-product-chat.getblockedusers with: user_id: tools.user_id outputParameters: - type: object mapping: $. - name: block-user description: Block user hints: readOnly: false destructive: false idempotent: false call: chat-product-chat.blockusers with: body: tools.body outputParameters: - type: object mapping: $. - name: deactivate-users description: Deactivate users hints: readOnly: false destructive: false idempotent: false call: chat-product-chat.deactivateusers with: body: tools.body outputParameters: - type: object mapping: $. - name: delete-users description: Delete Users hints: readOnly: false destructive: false idempotent: false call: chat-product-chat.deleteusers with: body: tools.body outputParameters: - type: object mapping: $. - name: get-user-live-locations description: Get user live locations hints: readOnly: true destructive: false idempotent: true call: chat-product-chat.getuserlivelocations with: user_id: tools.user_id outputParameters: - type: object mapping: $. - name: update-live-location description: Update live location hints: readOnly: false destructive: false idempotent: true call: chat-product-chat.updatelivelocation with: user_id: tools.user_id body: tools.body outputParameters: - type: object mapping: $. - name: reactivate-users description: Reactivate users hints: readOnly: false destructive: false idempotent: false call: chat-product-chat.reactivateusers with: body: tools.body outputParameters: - type: object mapping: $. - name: restore-users description: Restore users hints: readOnly: false destructive: false idempotent: false call: chat-product-chat.restoreusers with: body: tools.body outputParameters: - type: object mapping: $. - name: unblock-user description: Unblock user hints: readOnly: false destructive: false idempotent: false call: chat-product-chat.unblockusers with: body: tools.body outputParameters: - type: object mapping: $. - name: deactivate-user description: Deactivate user hints: readOnly: false destructive: false idempotent: false call: chat-product-chat.deactivateuser with: user_id: tools.user_id body: tools.body outputParameters: - type: object mapping: $. - name: send-user-event description: Send user event hints: readOnly: false destructive: false idempotent: false call: chat-product-chat.sendusercustomevent with: user_id: tools.user_id body: tools.body outputParameters: - type: object mapping: $. - name: export-user description: Export user hints: readOnly: true destructive: false idempotent: true call: chat-product-chat.exportuser with: user_id: tools.user_id outputParameters: - type: object mapping: $. - name: reactivate-user description: Reactivate user hints: readOnly: false destructive: false idempotent: false call: chat-product-chat.reactivateuser with: user_id: tools.user_id body: tools.body outputParameters: - type: object mapping: $.