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
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/discussions/v2/channels | List all channels |
| POST | /api/discussions/v2/channels | Create a new channel |
| GET | /api/discussions/v2/channels/{channel | Get a single channel by ID |
| PATCH | /api/discussions/v2/channels/{channel | Update a channel |
| DELETE | /api/discussions/v2/channels/{channel | Delete a channel |
| DELETE | /api/discussions/v2/channels/{channel | Delete all activity in a channel |
| GET | /api/discussions/v2/channels/{channel | Get notification opt-out status for a channel |
| POST | /api/discussions/v2/channels/{channel | Opt out of notifications for a channel |
| DELETE | /api/discussions/v2/channels/{channel | Remove notification opt-out for a channel |
Posts
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/discussions/v2/posts | List all posts |
| POST | /api/discussions/v2/posts | Create a new post |
| GET | /api/discussions/v2/posts/{post | Get a single post by ID |
| PATCH | /api/discussions/v2/posts/{post | Update a post |
| DELETE | /api/discussions/v2/posts/{post | Delete a post |
| POST | /api/discussions/v2/posts/{post | Reply to a post |
| PATCH | /api/discussions/v2/posts/{post | Update the moderation status of a post |
| POST | /api/discussions/v2/posts/search | Search posts using filters in the request body |
Reactions
| Method | Endpoint | Description |
|---|---|---|
| POST | /api/discussions/v2/reactions | Add a reaction to a post |
| DELETE | /api/discussions/v2/reactions/{reaction | Remove a reaction |
Settings
| Method | Endpoint | Description |
|---|---|---|
| POST | /api/discussions/v2/settings | Create 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.