The Hub Discussions API lets you programmatically manage conversations attached to ArcGIS Hub. Discussions are organized into channels, which contain posts. Posts can be replied to, reacted to, and moderated. Discussions allow channel members to have secure and focused conversations about content items and on discussion boards.

Use-cases

Some of the broad use-cases of the Discussions API are as follows:

  • Create and manage channels where discussions take place
  • Post, reply, and search for discussion posts within channels
  • Moderate posts by updating their status
  • React to posts and replies with reactions
  • Manage notification preferences by opting in or out of discussion updates
  • Configure discussion settings

Endpoints

The Discussions API includes the following endpoints:

Channels

MethodEndpointDescription
GET/api/discussions/v2/channelsList all channels
POST/api/discussions/v2/channelsCreate a new channel
GET/api/discussions/v2/channels/{channelId}Get a single channel by ID
PATCH/api/discussions/v2/channels/{channelId}Update a channel
DELETE/api/discussions/v2/channels/{channelId}Delete a channel
DELETE/api/discussions/v2/channels/{channelId}/activityDelete all activity in a channel
GET/api/discussions/v2/channels/{channelId}/notifications/opt-outGet notification opt-out status for a channel
POST/api/discussions/v2/channels/{channelId}/notifications/opt-outOpt out of notifications for a channel
DELETE/api/discussions/v2/channels/{channelId}/notifications/opt-outRemove notification opt-out for a channel

Posts

MethodEndpointDescription
GET/api/discussions/v2/postsList all posts
POST/api/discussions/v2/postsCreate a new post
GET/api/discussions/v2/posts/{postId}Get a single post by ID
PATCH/api/discussions/v2/posts/{postId}Update a post
DELETE/api/discussions/v2/posts/{postId}Delete a post
POST/api/discussions/v2/posts/{postId}/replyReply to a post
PATCH/api/discussions/v2/posts/{postId}/statusUpdate the moderation status of a post
POST/api/discussions/v2/posts/searchSearch posts using filters in the request body

Reactions

MethodEndpointDescription
POST/api/discussions/v2/reactionsAdd a reaction to a post
DELETE/api/discussions/v2/reactions/{reactionId}Remove a reaction

Settings

MethodEndpointDescription
POST/api/discussions/v2/settingsCreate discussion settings
GET/api/discussions/v2/settings/{id}Get settings by ID
PATCH/api/discussions/v2/settings/{id}Update settings
DELETE/api/discussions/v2/settings/{id}Delete settings

Authentication

Endpoints require an ArcGIS login token. To learn more about authentication, see Authentication.

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.