Method Detail

• getApp

   abstract GetApplicationResponse getApp()

  Get App Settings This Method returns the application settings

• listBlockLists

   abstract ListBlockListResponse listBlockLists(@Query(value = team) String team)

  List block lists Returns all available block lists

• createBlockList

   abstract CreateBlockListResponse createBlockList(@Body() CreateBlockListRequest createBlockListRequest)

  Create block list Creates a new application blocklist, once created the blocklist can be used by any channel type

• deleteBlockList

   abstract Response deleteBlockList(@Path(value = name) String name, @Query(value = team) String team)

  Delete block list Deletes previously created application blocklist

• updateBlockList

   abstract UpdateBlockListResponse updateBlockList(@Path(value = name) String name, @Body() UpdateBlockListRequest updateBlockListRequest)

  Update block list Updates contents of the block list

• updateBlockList

   abstract UpdateBlockListResponse updateBlockList(@Path(value = name) String name)

  Update block list Updates contents of the block list

• deleteDevice

   abstract Response deleteDevice(@Query(value = id) String id)

  Delete device Deletes one device

• listDevices

   abstract ListDevicesResponse listDevices()

  List devices Returns all available devices

• createDevice

   abstract Response createDevice(@Body() CreateDeviceRequest createDeviceRequest)

  Create device Adds a new device to a user, if the same device already exists the call will have no effect

• addActivity

   abstract AddActivityResponse addActivity(@Body() AddActivityRequest addActivityRequest)

  Add a single activity Create a new activity or update an existing one

• upsertActivities

   abstract UpsertActivitiesResponse upsertActivities(@Body() UpsertActivitiesRequest upsertActivitiesRequest)

  Upsert multiple activities Create new activities or update existing ones in a batch operation

• deleteActivities

   abstract DeleteActivitiesResponse deleteActivities(@Body() DeleteActivitiesRequest deleteActivitiesRequest)

  Remove multiple activities Delete one or more activities by their IDs

• trackActivityMetrics

   abstract TrackActivityMetricsResponse trackActivityMetrics(@Body() TrackActivityMetricsRequest trackActivityMetricsRequest)

  Track activity metrics Track metric events (views, clicks, impressions) for activities. Supports batching up to 100 events per request. Each event is independently rate-limited per user per activity per metric. Server-side calls must include user_id.

• queryActivities

   abstract QueryActivitiesResponse queryActivities(@Body() QueryActivitiesRequest queryActivitiesRequest)

  Query activities Query activities based on filters with pagination and sorting options

• queryActivities

   abstract QueryActivitiesResponse queryActivities()

  Query activities Query activities based on filters with pagination and sorting options

• deleteBookmark

   abstract DeleteBookmarkResponse deleteBookmark(@Path(value = activity_id) String activityId, @Query(value = folder_id) String folderId)

  Delete a bookmark Deletes a bookmark from an activity

• updateBookmark

   abstract UpdateBookmarkResponse updateBookmark(@Path(value = activity_id) String activityId, @Body() UpdateBookmarkRequest updateBookmarkRequest)

  Update bookmark Updates a bookmark for an activity

• updateBookmark

   abstract UpdateBookmarkResponse updateBookmark(@Path(value = activity_id) String activityId)

  Update bookmark Updates a bookmark for an activity

• addBookmark

   abstract AddBookmarkResponse addBookmark(@Path(value = activity_id) String activityId, @Body() AddBookmarkRequest addBookmarkRequest)

  Add bookmark Adds a bookmark to an activity

• addBookmark

   abstract AddBookmarkResponse addBookmark(@Path(value = activity_id) String activityId)

  Add bookmark Adds a bookmark to an activity

• activityFeedback

   abstract ActivityFeedbackResponse activityFeedback(@Path(value = activity_id) String activityId, @Body() ActivityFeedbackRequest activityFeedbackRequest)

  Provide feedback on an activity Submit feedback for an activity including options to show less, hide, report, or mute the user

• activityFeedback

   abstract ActivityFeedbackResponse activityFeedback(@Path(value = activity_id) String activityId)

  Provide feedback on an activity Submit feedback for an activity including options to show less, hide, report, or mute the user

• castPollVote

   abstract PollVoteResponse castPollVote(@Path(value = activity_id) String activityId, @Path(value = poll_id) String pollId, @Body() CastPollVoteRequest castPollVoteRequest)

  Cast vote Cast a vote on a poll

• castPollVote

   abstract PollVoteResponse castPollVote(@Path(value = activity_id) String activityId, @Path(value = poll_id) String pollId)

  Cast vote Cast a vote on a poll

• deletePollVote

   abstract PollVoteResponse deletePollVote(@Path(value = activity_id) String activityId, @Path(value = poll_id) String pollId, @Path(value = vote_id) String voteId, @Query(value = user_id) String userId)

  Delete vote Delete a vote from a poll

• addActivityReaction

   abstract AddReactionResponse addActivityReaction(@Path(value = activity_id) String activityId, @Body() AddReactionRequest addReactionRequest)

  Add reaction Adds a reaction to an activity

• queryActivityReactions

   abstract QueryActivityReactionsResponse queryActivityReactions(@Path(value = activity_id) String activityId, @Body() QueryActivityReactionsRequest queryActivityReactionsRequest)

  Query activity reactions Query activity reactions

• queryActivityReactions

   abstract QueryActivityReactionsResponse queryActivityReactions(@Path(value = activity_id) String activityId)

  Query activity reactions Query activity reactions

• deleteActivityReaction

   abstract DeleteActivityReactionResponse deleteActivityReaction(@Path(value = activity_id) String activityId, @Path(value = type) String type, @Query(value = delete_notification_activity) Boolean deleteNotificationActivity)

  Remove reaction Removes a reaction from an activity

• deleteActivity

   abstract DeleteActivityResponse deleteActivity(@Path(value = id) String id, @Query(value = hard_delete) Boolean hardDelete, @Query(value = delete_notification_activity) Boolean deleteNotificationActivity)

  Delete a single activity Delete a single activity by its ID

• getActivity

   abstract GetActivityResponse getActivity(@Path(value = id) String id)

  Get activity Returns activity by ID

• updateActivityPartial

   abstract UpdateActivityPartialResponse updateActivityPartial(@Path(value = id) String id, @Body() UpdateActivityPartialRequest updateActivityPartialRequest)

  Partial activity update Updates certain fields of the activity. Use 'set' to update specific fields and 'unset' to remove fields. This allows you to update only the fields you need without replacing the entire activity. Useful for updating reply restrictions ('restrict_replies'), mentioned users, or custom data.

• updateActivityPartial

   abstract UpdateActivityPartialResponse updateActivityPartial(@Path(value = id) String id)

  Partial activity update Updates certain fields of the activity. Use 'set' to update specific fields and 'unset' to remove fields. This allows you to update only the fields you need without replacing the entire activity. Useful for updating reply restrictions ('restrict_replies'), mentioned users, or custom data.

• updateActivity

   abstract UpdateActivityResponse updateActivity(@Path(value = id) String id, @Body() UpdateActivityRequest updateActivityRequest)

  Full activity update Replaces an activity with the provided data. Use this to update text, attachments, reply restrictions ('restrict_replies'), mentioned users, and other activity fields. Note: This is a full update - any fields not provided will be cleared.

• updateActivity

   abstract UpdateActivityResponse updateActivity(@Path(value = id) String id)

  Full activity update Replaces an activity with the provided data. Use this to update text, attachments, reply restrictions ('restrict_replies'), mentioned users, and other activity fields. Note: This is a full update - any fields not provided will be cleared.

• restoreActivity

   abstract RestoreActivityResponse restoreActivity(@Path(value = id) String id, @Query(value = enrich_own_fields) Boolean enrichOwnFields, @Body() RestoreActivityRequest restoreActivityRequest)

  Restore a soft-deleted activity Restores a soft-deleted activity by its ID. Only the activity owner can restore their own activities.

• restoreActivity

   abstract RestoreActivityResponse restoreActivity(@Path(value = id) String id, @Query(value = enrich_own_fields) Boolean enrichOwnFields)

  Restore a soft-deleted activity Restores a soft-deleted activity by its ID. Only the activity owner can restore their own activities.

• queryBookmarkFolders

   abstract QueryBookmarkFoldersResponse queryBookmarkFolders(@Body() QueryBookmarkFoldersRequest queryBookmarkFoldersRequest)

  Query bookmark folders Query bookmark folders with filter query

• queryBookmarkFolders

   abstract QueryBookmarkFoldersResponse queryBookmarkFolders()

  Query bookmark folders Query bookmark folders with filter query

• deleteBookmarkFolder

   abstract DeleteBookmarkFolderResponse deleteBookmarkFolder(@Path(value = folder_id) String folderId)

  Delete a bookmark folder Delete a bookmark folder by its ID

• updateBookmarkFolder

   abstract UpdateBookmarkFolderResponse updateBookmarkFolder(@Path(value = folder_id) String folderId, @Body() UpdateBookmarkFolderRequest updateBookmarkFolderRequest)

  Update a bookmark folder Update a bookmark folder by its ID

• updateBookmarkFolder

   abstract UpdateBookmarkFolderResponse updateBookmarkFolder(@Path(value = folder_id) String folderId)

  Update a bookmark folder Update a bookmark folder by its ID

• queryBookmarks

   abstract QueryBookmarksResponse queryBookmarks(@Body() QueryBookmarksRequest queryBookmarksRequest)

  Query bookmarks Query bookmarks with filter query

• queryBookmarks

   abstract QueryBookmarksResponse queryBookmarks()

  Query bookmarks Query bookmarks with filter query

• deleteCollections

   abstract DeleteCollectionsResponse deleteCollections(@Query(value = collection_refs) List<String> collectionRefs)

  Delete multiple collections Delete collections in a batch operation. Users can only delete their own collections.

• readCollections

   abstract ReadCollectionsResponse readCollections(@Query(value = collection_refs) List<String> collectionRefs)

  Read collections Read collections by their references. By default, users can only read their own collections.

• updateCollections

   abstract UpdateCollectionsResponse updateCollections(@Body() UpdateCollectionsRequest updateCollectionsRequest)

  Update multiple collections Update existing collections in a batch operation. Only the custom data field is updatable. Users can only update their own collections.

• createCollections

   abstract CreateCollectionsResponse createCollections(@Body() CreateCollectionsRequest createCollectionsRequest)

  Create multiple collections Create new collections in a batch operation. Collections are data objects that can be attached to activities for managing shared data across multiple activities.

• queryCollections

   abstract QueryCollectionsResponse queryCollections(@Body() QueryCollectionsRequest queryCollectionsRequest)

  Query collections Query collections with filter query

• queryCollections

   abstract QueryCollectionsResponse queryCollections()

  Query collections Query collections with filter query

• getComments

   abstract GetCommentsResponse getComments(@Query(value = object_id) String objectId, @Query(value = object_type) String objectType, @Query(value = depth) Integer depth, @Query(value = sort) String sort, @Query(value = replies_limit) Integer repliesLimit, @Query(value = id_around) String idAround, @Query(value = limit) Integer limit, @Query(value = prev) String prev, @Query(value = next) String next)

  Get comments for an object Retrieve a threaded list of comments for a specific object (e.g., activity), with configurable depth, sorting, and pagination

• addComment

   abstract AddCommentResponse addComment(@Body() AddCommentRequest addCommentRequest)

  Add a comment or reply Adds a comment to an object (e.g., activity) or a reply to an existing comment, and broadcasts appropriate events

• addComment

   abstract AddCommentResponse addComment()

  Add a comment or reply Adds a comment to an object (e.g., activity) or a reply to an existing comment, and broadcasts appropriate events

• addCommentsBatch

   abstract AddCommentsBatchResponse addCommentsBatch(@Body() AddCommentsBatchRequest addCommentsBatchRequest)

  Add multiple comments in a batch Adds multiple comments in a single request. Each comment must specify the object type and ID.

• queryComments

   abstract QueryCommentsResponse queryComments(@Body() QueryCommentsRequest queryCommentsRequest)

  Query comments Query comments using MongoDB-style filters with pagination and sorting options

• deleteCommentBookmark

   abstract DeleteCommentBookmarkResponse deleteCommentBookmark(@Path(value = comment_id) String commentId, @Query(value = folder_id) String folderId)

  Delete a comment bookmark Deletes a bookmark from a comment

• updateCommentBookmark

   abstract UpdateCommentBookmarkResponse updateCommentBookmark(@Path(value = comment_id) String commentId, @Body() UpdateCommentBookmarkRequest updateCommentBookmarkRequest)

  Update comment bookmark Updates a bookmark for a comment

• updateCommentBookmark

   abstract UpdateCommentBookmarkResponse updateCommentBookmark(@Path(value = comment_id) String commentId)

  Update comment bookmark Updates a bookmark for a comment

• addCommentBookmark

   abstract AddCommentBookmarkResponse addCommentBookmark(@Path(value = comment_id) String commentId, @Body() AddCommentBookmarkRequest addCommentBookmarkRequest)

  Add comment bookmark Adds a bookmark to a comment

• addCommentBookmark

   abstract AddCommentBookmarkResponse addCommentBookmark(@Path(value = comment_id) String commentId)

  Add comment bookmark Adds a bookmark to a comment

• deleteComment

   abstract DeleteCommentResponse deleteComment(@Path(value = id) String id, @Query(value = hard_delete) Boolean hardDelete, @Query(value = delete_notification_activity) Boolean deleteNotificationActivity)

  Delete a comment Deletes a comment from an object (e.g., activity) and broadcasts appropriate events

• getComment

   abstract GetCommentResponse getComment(@Path(value = id) String id)

  Get comment Get a comment by ID

• updateComment

   abstract UpdateCommentResponse updateComment(@Path(value = id) String id, @Body() UpdateCommentRequest updateCommentRequest)

  Update a comment Updates a comment on an object (e.g., activity) and broadcasts appropriate events

• updateComment

   abstract UpdateCommentResponse updateComment(@Path(value = id) String id)

  Update a comment Updates a comment on an object (e.g., activity) and broadcasts appropriate events

• updateCommentPartial

   abstract UpdateCommentPartialResponse updateCommentPartial(@Path(value = id) String id, @Body() UpdateCommentPartialRequest updateCommentPartialRequest)

  Partial comment update Updates certain fields of the comment. Use 'set' to update specific fields and 'unset' to remove fields.

• updateCommentPartial

   abstract UpdateCommentPartialResponse updateCommentPartial(@Path(value = id) String id)

  Partial comment update Updates certain fields of the comment. Use 'set' to update specific fields and 'unset' to remove fields.

• addCommentReaction

   abstract AddCommentReactionResponse addCommentReaction(@Path(value = id) String id, @Body() AddCommentReactionRequest addCommentReactionRequest)

  Add comment reaction Adds a reaction to a comment

• queryCommentReactions

   abstract QueryCommentReactionsResponse queryCommentReactions(@Path(value = id) String id, @Body() QueryCommentReactionsRequest queryCommentReactionsRequest)

  Query comment reactions Query comment reactions

• queryCommentReactions

   abstract QueryCommentReactionsResponse queryCommentReactions(@Path(value = id) String id)

  Query comment reactions Query comment reactions

• deleteCommentReaction

   abstract DeleteCommentReactionResponse deleteCommentReaction(@Path(value = id) String id, @Path(value = type) String type, @Query(value = delete_notification_activity) Boolean deleteNotificationActivity)

  Delete comment reaction Deletes a reaction from a comment

• getCommentReplies

   abstract GetCommentRepliesResponse getCommentReplies(@Path(value = id) String id, @Query(value = depth) Integer depth, @Query(value = sort) String sort, @Query(value = replies_limit) Integer repliesLimit, @Query(value = id_around) String idAround, @Query(value = limit) Integer limit, @Query(value = prev) String prev, @Query(value = next) String next)

  Get replies for a comment Retrieve a threaded list of replies for a single comment, with configurable depth, sorting, and pagination

• restoreComment

   abstract RestoreCommentResponse restoreComment(@Path(value = id) String id, @Body() RestoreCommentRequest restoreCommentRequest)

  Restore a soft-deleted comment Restores a soft-deleted comment by its ID. The comment and all its descendants are restored. Requires moderator permissions.

• restoreComment

   abstract RestoreCommentResponse restoreComment(@Path(value = id) String id)

  Restore a soft-deleted comment Restores a soft-deleted comment by its ID. The comment and all its descendants are restored. Requires moderator permissions.

• deleteFeed

   abstract DeleteFeedResponse deleteFeed(@Path(value = feed_group_id) String feedGroupId, @Path(value = feed_id) String feedId, @Query(value = hard_delete) Boolean hardDelete)

  Delete a single feed Delete a single feed by its ID

• getOrCreateFeed

   abstract GetOrCreateFeedResponse getOrCreateFeed(@Path(value = feed_group_id) String feedGroupId, @Path(value = feed_id) String feedId, @Query(value = connection_id) String connectionId, @Body() GetOrCreateFeedRequest getOrCreateFeedRequest)

  Create a new feed Create a single feed for a given feed group

• getOrCreateFeed

   abstract GetOrCreateFeedResponse getOrCreateFeed(@Path(value = feed_group_id) String feedGroupId, @Path(value = feed_id) String feedId, @Query(value = connection_id) String connectionId)

  Create a new feed Create a single feed for a given feed group

• updateFeed

   abstract UpdateFeedResponse updateFeed(@Path(value = feed_group_id) String feedGroupId, @Path(value = feed_id) String feedId, @Body() UpdateFeedRequest updateFeedRequest)

  Update a feed Update an existing feed

• updateFeed

   abstract UpdateFeedResponse updateFeed(@Path(value = feed_group_id) String feedGroupId, @Path(value = feed_id) String feedId)

  Update a feed Update an existing feed

• markActivity

   abstract Response markActivity(@Path(value = feed_group_id) String feedGroupId, @Path(value = feed_id) String feedId, @Body() MarkActivityRequest markActivityRequest)

  Mark activities as read/seen/watched Mark activities as read/seen/watched. Can mark by timestamp (seen), activity IDs (read), or all as read.

• markActivity

   abstract Response markActivity(@Path(value = feed_group_id) String feedGroupId, @Path(value = feed_id) String feedId)

  Mark activities as read/seen/watched Mark activities as read/seen/watched. Can mark by timestamp (seen), activity IDs (read), or all as read.

• unpinActivity

   abstract UnpinActivityResponse unpinActivity(@Path(value = feed_group_id) String feedGroupId, @Path(value = feed_id) String feedId, @Path(value = activity_id) String activityId, @Query(value = enrich_own_fields) Boolean enrichOwnFields)

  Unpin an activity from a feed Unpin an activity from a feed. This removes the pin, so the activity will no longer be displayed at the top of the feed.

• pinActivity

   abstract PinActivityResponse pinActivity(@Path(value = feed_group_id) String feedGroupId, @Path(value = feed_id) String feedId, @Path(value = activity_id) String activityId, @Body() PinActivityRequest pinActivityRequest)

  Pin an activity to a feed Pin an activity to a feed. Pinned activities are typically displayed at the top of a feed.

• pinActivity

   abstract PinActivityResponse pinActivity(@Path(value = feed_group_id) String feedGroupId, @Path(value = feed_id) String feedId, @Path(value = activity_id) String activityId)

  Pin an activity to a feed Pin an activity to a feed. Pinned activities are typically displayed at the top of a feed.

• updateFeedMembers

   abstract UpdateFeedMembersResponse updateFeedMembers(@Path(value = feed_group_id) String feedGroupId, @Path(value = feed_id) String feedId, @Body() UpdateFeedMembersRequest updateFeedMembersRequest)

  Update feed members Add, remove, or set members for a feed

• acceptFeedMemberInvite

   abstract AcceptFeedMemberInviteResponse acceptFeedMemberInvite(@Path(value = feed_id) String feedId, @Path(value = feed_group_id) String feedGroupId, @Body() AcceptFeedMemberInviteRequest acceptFeedMemberInviteRequest)

  Accept a feed member request Accepts a pending feed member request

• acceptFeedMemberInvite

   abstract AcceptFeedMemberInviteResponse acceptFeedMemberInvite(@Path(value = feed_id) String feedId, @Path(value = feed_group_id) String feedGroupId)

  Accept a feed member request Accepts a pending feed member request

• queryFeedMembers

   abstract QueryFeedMembersResponse queryFeedMembers(@Path(value = feed_group_id) String feedGroupId, @Path(value = feed_id) String feedId, @Body() QueryFeedMembersRequest queryFeedMembersRequest)

  Query feed members Query feed members based on filters with pagination and sorting options

• queryFeedMembers

   abstract QueryFeedMembersResponse queryFeedMembers(@Path(value = feed_group_id) String feedGroupId, @Path(value = feed_id) String feedId)

  Query feed members Query feed members based on filters with pagination and sorting options

• rejectFeedMemberInvite

   abstract RejectFeedMemberInviteResponse rejectFeedMemberInvite(@Path(value = feed_group_id) String feedGroupId, @Path(value = feed_id) String feedId, @Body() RejectFeedMemberInviteRequest rejectFeedMemberInviteRequest)

  Reject an invite to become a feed member Rejects a pending feed member request

• rejectFeedMemberInvite

   abstract RejectFeedMemberInviteResponse rejectFeedMemberInvite(@Path(value = feed_group_id) String feedGroupId, @Path(value = feed_id) String feedId)

  Reject an invite to become a feed member Rejects a pending feed member request

• queryPinnedActivities

   abstract QueryPinnedActivitiesResponse queryPinnedActivities(@Path(value = feed_group_id) String feedGroupId, @Path(value = feed_id) String feedId, @Body() QueryPinnedActivitiesRequest queryPinnedActivitiesRequest)

  Query pinned activities Query pinned activities for a feed with filter query

• queryPinnedActivities

   abstract QueryPinnedActivitiesResponse queryPinnedActivities(@Path(value = feed_group_id) String feedGroupId, @Path(value = feed_id) String feedId)

  Query pinned activities Query pinned activities for a feed with filter query

• stopWatchingFeed

   abstract Response stopWatchingFeed(@Path(value = feed_group_id) String feedGroupId, @Path(value = feed_id) String feedId, @Query(value = connection_id) String connectionId)

  Stop watching feed Call this Method to stop receiving feed events

• getFollowSuggestions

   abstract GetFollowSuggestionsResponse getFollowSuggestions(@Path(value = feed_group_id) String feedGroupId, @Query(value = limit) Integer limit)

  Get follow suggestions Get follow suggestions for a feed group

• createFeedsBatch

   abstract CreateFeedsBatchResponse createFeedsBatch(@Body() CreateFeedsBatchRequest createFeedsBatchRequest)

  Create multiple feeds at once Create multiple feeds at once for a given feed group

• ownBatch

   abstract OwnBatchResponse ownBatch(@Query(value = connection_id) String connectionId, @Body() OwnBatchRequest ownBatchRequest)

  Get own fields for multiple feeds Retrieves own_follows, own_capabilities, and/or own_membership for multiple feeds in a single request. If fields are not specified, all three fields are returned.

• queryFeeds

   abstract QueryFeedsResponse queryFeeds(@Query(value = connection_id) String connectionId, @Body() QueryFeedsRequest queryFeedsRequest)

  Query feeds Query feeds with filter query

• queryFeeds

   abstract QueryFeedsResponse queryFeeds(@Query(value = connection_id) String connectionId)

  Query feeds Query feeds with filter query

• updateFollow

   abstract UpdateFollowResponse updateFollow(@Body() UpdateFollowRequest updateFollowRequest)

  Update a follow Updates a follow's custom data, push preference, and follower role. Source owner can update custom data and push preference. Follower role can only be updated via server-side requests.

• follow

   abstract SingleFollowResponse follow(@Body() FollowRequest followRequest)

  Create a follow Creates a follow and broadcasts FollowAddedEvent

• acceptFollow

   abstract AcceptFollowResponse acceptFollow(@Body() AcceptFollowRequest acceptFollowRequest)

  Accept a follow request Accepts a pending follow request

• followBatch

   abstract FollowBatchResponse followBatch(@Body() FollowBatchRequest followBatchRequest)

  Create multiple follows at once Creates multiple follows at once and broadcasts FollowAddedEvent for each follow

• getOrCreateFollows

   abstract FollowBatchResponse getOrCreateFollows(@Body() FollowBatchRequest followBatchRequest)

  Upsert multiple follows at once Creates or updates multiple follows at once. Does not return an error if follows already exist. Broadcasts FollowAddedEvent only for newly created follows.

• queryFollows

   abstract QueryFollowsResponse queryFollows(@Body() QueryFollowsRequest queryFollowsRequest)

  Query follows Query follows based on filters with pagination and sorting options

• queryFollows

   abstract QueryFollowsResponse queryFollows()

  Query follows Query follows based on filters with pagination and sorting options

• rejectFollow

   abstract RejectFollowResponse rejectFollow(@Body() RejectFollowRequest rejectFollowRequest)

  Reject a follow request Rejects a pending follow request

• unfollow

   abstract UnfollowResponse unfollow(@Path(value = source) String source, @Path(value = target) String target, @Query(value = delete_notification_activity) Boolean deleteNotificationActivity, @Query(value = keep_history) Boolean keepHistory, @Query(value = enrich_own_fields) Boolean enrichOwnFields)

  Unfollow a feed Removes a follow and broadcasts FollowRemovedEvent

• getOrCreateUnfollows

   abstract UnfollowBatchResponse getOrCreateUnfollows(@Body() UnfollowBatchRequest unfollowBatchRequest)

  Unfollow multiple feeds (idempotent) Removes multiple follows and broadcasts FollowRemovedEvent for each. Does not return an error if follows don't exist.

• createGuest

   abstract CreateGuestResponse createGuest(@Body() CreateGuestRequest createGuestRequest)

  Create Guest

• longPoll

   abstract Unit longPoll(@Query(value = connection_id) String connectionId, @Query(value = json) WSAuthMessage json)

  Long Poll (Transport) WebSocket fallback transport endpoint

• appeal

   abstract AppealResponse appeal(@Body() AppealRequest appealRequest)

  Appeal against the moderation decision Appeal against the moderation decision

• getAppeal

   abstract GetAppealResponse getAppeal(@Path(value = id) String id)

  Get appeal item Retrieve a specific appeal item by its ID

• queryAppeals

   abstract QueryAppealsResponse queryAppeals(@Body() QueryAppealsRequest queryAppealsRequest)

  Query Appeals Query Appeals

• queryAppeals

   abstract QueryAppealsResponse queryAppeals()

  Query Appeals Query Appeals

• ban

   abstract BanResponse ban(@Body() BanRequest banRequest)

  Ban Ban a user from a channel or the entire app

• upsertConfig

   abstract UpsertConfigResponse upsertConfig(@Body() UpsertConfigRequest upsertConfigRequest)

  Create or update moderation configuration Create a new moderation configuration or update an existing one. Configure settings for content filtering, AI analysis, toxicity detection, and other moderation features.

• deleteConfig

   abstract DeleteModerationConfigResponse deleteConfig(@Path(value = key) String key, @Query(value = team) String team)

  Delete a moderation policy Delete a specific moderation policy by its name

• getConfig

   abstract GetConfigResponse getConfig(@Path(value = key) String key, @Query(value = team) String team)

  Get moderation configuration Retrieve a specific moderation configuration by its key and team. This configuration contains settings for various moderation features like toxicity detection, AI analysis, and filtering rules.

• queryModerationConfigs

   abstract QueryModerationConfigsResponse queryModerationConfigs(@Body() QueryModerationConfigsRequest queryModerationConfigsRequest)

  Query moderation configurations Search and filter moderation configurations across your application. This endpoint is designed for building moderation dashboards and managing multiple configuration sets.

• queryModerationConfigs

   abstract QueryModerationConfigsResponse queryModerationConfigs()

  Query moderation configurations Search and filter moderation configurations across your application. This endpoint is designed for building moderation dashboards and managing multiple configuration sets.

• flag

   abstract FlagResponse flag(@Body() FlagRequest flagRequest)

  Flag content for moderation Flag any type of content (messages, users, channels, activities) for moderation review. Supports custom content types and additional metadata for flagged content.

• mute

   abstract MuteResponse mute(@Body() MuteRequest muteRequest)

  Mute Mute a user. Mutes are generally not visible to the user you mute, while block is something you notice.

• queryReviewQueue

   abstract QueryReviewQueueResponse queryReviewQueue(@Body() QueryReviewQueueRequest queryReviewQueueRequest)

  Query review queue items Query review queue items allows you to filter the review queue items. This is used for building a moderation dashboard.

• queryReviewQueue

   abstract QueryReviewQueueResponse queryReviewQueue()

  Query review queue items Query review queue items allows you to filter the review queue items. This is used for building a moderation dashboard.

• submitAction

   abstract SubmitActionResponse submitAction(@Body() SubmitActionRequest submitActionRequest)

  Submit moderation action Take action on flagged content, such as marking content as safe, deleting content, banning users, or executing custom moderation actions. Supports various action types with configurable parameters.

• getOG

   abstract GetOGResponse getOG(@Query(value = url) String url)

  Get OG Get an OpenGraph attachment for a link

• createPoll

   abstract PollResponse createPoll(@Body() CreatePollRequest createPollRequest)

  Create poll Creates a new poll

• updatePoll

   abstract PollResponse updatePoll(@Body() UpdatePollRequest updatePollRequest)

  Update poll Updates a poll

• queryPolls

   abstract QueryPollsResponse queryPolls(@Query(value = user_id) String userId, @Body() QueryPollsRequest queryPollsRequest)

  Query polls Queries polls

• queryPolls

   abstract QueryPollsResponse queryPolls(@Query(value = user_id) String userId)

  Query polls Queries polls

• deletePoll

   abstract Response deletePoll(@Path(value = poll_id) String pollId, @Query(value = user_id) String userId)

  Delete poll Deletes a poll

• getPoll

   abstract PollResponse getPoll(@Path(value = poll_id) String pollId, @Query(value = user_id) String userId)

  Get poll Retrieves a poll

• updatePollPartial

   abstract PollResponse updatePollPartial(@Path(value = poll_id) String pollId, @Body() UpdatePollPartialRequest updatePollPartialRequest)

  Partial update poll Updates a poll partially

• updatePollPartial

   abstract PollResponse updatePollPartial(@Path(value = poll_id) String pollId)

  Partial update poll Updates a poll partially

• createPollOption

   abstract PollOptionResponse createPollOption(@Path(value = poll_id) String pollId, @Body() CreatePollOptionRequest createPollOptionRequest)

  Create poll option Creates a poll option

• updatePollOption

   abstract PollOptionResponse updatePollOption(@Path(value = poll_id) String pollId, @Body() UpdatePollOptionRequest updatePollOptionRequest)

  Update poll option Updates a poll option

• deletePollOption

   abstract Response deletePollOption(@Path(value = poll_id) String pollId, @Path(value = option_id) String optionId, @Query(value = user_id) String userId)

  Delete poll option Deletes a poll option

• getPollOption

   abstract PollOptionResponse getPollOption(@Path(value = poll_id) String pollId, @Path(value = option_id) String optionId, @Query(value = user_id) String userId)

  Get poll option Retrieves a poll option

• queryPollVotes

   abstract PollVotesResponse queryPollVotes(@Path(value = poll_id) String pollId, @Query(value = user_id) String userId, @Body() QueryPollVotesRequest queryPollVotesRequest)

  Query votes Queries votes

• queryPollVotes

   abstract PollVotesResponse queryPollVotes(@Path(value = poll_id) String pollId, @Query(value = user_id) String userId)

  Query votes Queries votes

• updatePushNotificationPreferences

   abstract UpsertPushPreferencesResponse updatePushNotificationPreferences(@Body() UpsertPushPreferencesRequest upsertPushPreferencesRequest)

  Push notification preferences Upserts the push preferences for a user and or channel member. Set to all, mentions or none

• deleteFile

   abstract Response deleteFile(@Query(value = url) String url)

  Delete file Deletes previously uploaded file

• uploadFile

   abstract FileUploadResponse uploadFile(@Body() FileUploadRequest fileUploadRequest)

  Upload file Uploads file

• uploadFile

   abstract FileUploadResponse uploadFile()

  Upload file Uploads file

• deleteImage

   abstract Response deleteImage(@Query(value = url) String url)

  Delete image Deletes previously uploaded image

• uploadImage

   abstract ImageUploadResponse uploadImage(@Body() ImageUploadRequest imageUploadRequest)

  Upload image Uploads image

• uploadImage

   abstract ImageUploadResponse uploadImage()

  Upload image Uploads image

• listUserGroups

   abstract ListUserGroupsResponse listUserGroups(@Query(value = limit) Integer limit, @Query(value = id_gt) String idGt, @Query(value = created_at_gt) String createdAtGt, @Query(value = team_id) String teamId)

  List user groups Lists user groups with cursor-based pagination

• createUserGroup

   abstract CreateUserGroupResponse createUserGroup(@Body() CreateUserGroupRequest createUserGroupRequest)

  Create user group Creates a new user group, optionally with initial members

• searchUserGroups

   abstract SearchUserGroupsResponse searchUserGroups(@Query(value = query) String query, @Query(value = limit) Integer limit, @Query(value = name_gt) String nameGt, @Query(value = id_gt) String idGt, @Query(value = team_id) String teamId)

  Search user groups Searches user groups by name prefix for autocomplete

• deleteUserGroup

   abstract Response deleteUserGroup(@Path(value = id) String id, @Query(value = team_id) String teamId)

  Delete user group Deletes a user group and all its members

• getUserGroup

   abstract GetUserGroupResponse getUserGroup(@Path(value = id) String id, @Query(value = team_id) String teamId)

  Get user group Gets a user group by ID, including its members

• updateUserGroup

   abstract UpdateUserGroupResponse updateUserGroup(@Path(value = id) String id, @Body() UpdateUserGroupRequest updateUserGroupRequest)

  Update user group Updates a user group's name and/or description. team_id is immutable.

• updateUserGroup

   abstract UpdateUserGroupResponse updateUserGroup(@Path(value = id) String id)

  Update user group Updates a user group's name and/or description. team_id is immutable.

• addUserGroupMembers

   abstract AddUserGroupMembersResponse addUserGroupMembers(@Path(value = id) String id, @Body() AddUserGroupMembersRequest addUserGroupMembersRequest)

  Add user group members Adds members to a user group. All user IDs must exist. The operation is all-or-nothing.

• removeUserGroupMembers

   abstract RemoveUserGroupMembersResponse removeUserGroupMembers(@Path(value = id) String id, @Body() RemoveUserGroupMembersRequest removeUserGroupMembersRequest)

  Remove user group members Removes members from a user group. Users already not in the group are silently ignored.

• queryUsers

   abstract QueryUsersResponse queryUsers(@Query(value = payload) QueryUsersPayload payload)

  Query users Find and filter users

• updateUsersPartial

   abstract UpdateUsersResponse updateUsersPartial(@Body() UpdateUsersPartialRequest updateUsersPartialRequest)

  Partially update user Updates certain fields of the user

• updateUsers

   abstract UpdateUsersResponse updateUsers(@Body() UpdateUsersRequest updateUsersRequest)

  Upsert users Update or create users in bulk

• getBlockedUsers

   abstract GetBlockedUsersResponse getBlockedUsers()

  Get list of blocked Users Get list of blocked Users

• blockUsers

   abstract BlockUsersResponse blockUsers(@Body() BlockUsersRequest blockUsersRequest)

  Block user Block users

• getUserLiveLocations

   abstract SharedLocationsResponse getUserLiveLocations()

  Get user live locations Retrieves all active live locations for a user

• updateLiveLocation

   abstract SharedLocationResponse updateLiveLocation(@Body() UpdateLiveLocationRequest updateLiveLocationRequest)

  Update live location Updates an existing live location with new coordinates or expiration time

• unblockUsers

   abstract UnblockUsersResponse unblockUsers(@Body() UnblockUsersRequest unblockUsersRequest)

  Unblock user Unblock users