{"items":[{"type":"link","label":"Firstup API","link":"/endpoints/openapi","routeSlug":"/endpoints/openapi"},{"type":"group","label":"Content Publishing","link":"/endpoints/openapi/content-publishing","routeSlug":"/endpoints/openapi/content-publishing","items":[{"label":"Create a topic in the program","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/endpoints/openapi/content-publishing/createchannel","routeSlug":"/endpoints/openapi/content-publishing/createchannel","metadata":{"seo":{"title":"Create a topic in the program","description":"Creates new topic in the program. A topic holds campaigns and users, organizing content for user consumption.<br> <br> Resources <ul> <li><a href=\"https://support.firstup.io/hc/en-us/articles/4413655133719-Create-or-Edit-a-Topic\">Knowledge Base article on Topics</a></li> <li><a href=\"contentandpublishing/contentoverview\">An overview on Content & Publishing API</a> </li> </ul>"}},"httpPath":"/v2/channels"},{"label":"List all topics in the program","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/endpoints/openapi/content-publishing/listchannels","routeSlug":"/endpoints/openapi/content-publishing/listchannels","metadata":{"seo":{"title":"List all topics in the program","description":"Returns a list of topics and allows for sorting, filtering, and pagination of the records.<br> Response body is an array of records. <br> Resources <ul> <li><a href=\"https://support.firstup.io/hc/en-us/articles/4413655133719-Create-or-Edit-a-Topic\">Knowledge Base article on Topics</a></li> <li><a href=\"contentandpublishing/contentoverview\">An overview on Content & Publishing API</a> <li><a href=\"gettingstarted/pagination\">Pagination</a> <li><a href=\"gettingstarted/filtering\">Filtering</a> </li> </ul>"}},"httpPath":"/v2/channels"},{"label":"Update a topic in the program","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/endpoints/openapi/content-publishing/updatechannel","routeSlug":"/endpoints/openapi/content-publishing/updatechannel","metadata":{"seo":{"title":"Update a topic in the program","description":"Updates a topic in the program"}},"httpPath":"/v2/channels/{channel_id}"},{"label":"List all followers of a topic","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/endpoints/openapi/content-publishing/listchannelfollowers","routeSlug":"/endpoints/openapi/content-publishing/listchannelfollowers","metadata":{"seo":{"title":"List all followers of a topic","description":"Returns a list of all users who follow the topic, and allows for pagination of the records.<br> Response body is an array of records.<br> Resources <ul> <li><a href=\"https://support.firstup.io/hc/en-us/articles/4413655133719-Create-or-Edit-a-Topic\">Knowledge Base article on Topics</a></li> <li><a href=\"contentandpublishing/contentoverview\">An overview on Content & Publishing API</a> <li><a href=\"gettingstarted/pagination\">Pagination</a> </li> </ul>"}},"httpPath":"/v2/channels/{channel_id}/followers"},{"label":"List pages for a topic","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/endpoints/openapi/content-publishing/listchannelpages","routeSlug":"/endpoints/openapi/content-publishing/listchannelpages","metadata":{"seo":{"title":"List pages for a topic","description":"Returns a list of custom pages associated with a topic."}},"httpPath":"/v2/channels/{channel_id}/pages"},{"label":"Fetch a collection of content","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/endpoints/openapi/content-publishing/listcontent","routeSlug":"/endpoints/openapi/content-publishing/listcontent","metadata":{"seo":{"title":"Fetch a collection of content","description":"Returns a list of content records and allows for sorting, filtering, and pagination of the records. This list can be used to pass into a topic.<br> Response body is an array of records.<br> Resources <ul> <li><a href=\"https://support.firstup.io/hc/en-us/articles/4413655133719-Create-or-Edit-a-Topic\">Knowledge Base article on Topics</a></li> <li><a href=\"contentandpublishing/contentoverview\">An overview on Content & Publishing API</a> <li><a href=\"gettingstarted/pagination\">Pagination</a> <li><a href=\"gettingstarted/filtering\">Filtering</a> </li> </ul>"}},"httpPath":"/v2/content"},{"label":"Create a new content post","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/endpoints/openapi/content-publishing/createcontent","routeSlug":"/endpoints/openapi/content-publishing/createcontent","metadata":{"seo":{"title":"Create a new content post","description":"Create a new content item and select what topics will include the content. The new content will be created in the “draft” state.  This endpoint only creates the post. If applicable, an image may be added later via the appropriate endpoint. If author.user_id is provided, it will be used to determine display_name and avatar_url, overriding any values provided for display_name and avatar_url. <br><br> Response body data will be the newly created record.<br><br> Resources <ul> <li><a href=\"https://support.firstup.io/hc/en-us/articles/1500007952761-Create-a-New-Campaign\">Knowledge Base article on Campaigns</a></li> <li><a href=\"contentandpublishing/contentoverview\">An overview on Content & Publishing API</a> <li><a href=\"gettingstarted/pagination\">Pagination</a> <li><a href=\"gettingstarted/filtering\">Filtering</a> <li><a href=\"/endpoints/openapi/content-publishing/addcontentimage\">Add an image</a> <li><a href=\"/endpoints/openapi/content-publishing/publishcontent\">Publish drafted content</a> </li> </ul>"}},"httpPath":"/v2/content"},{"label":"Fetch the details of a content post","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/endpoints/openapi/content-publishing/detailcontent","routeSlug":"/endpoints/openapi/content-publishing/detailcontent","metadata":{"seo":{"title":"Fetch the details of a content post","description":"Read an existing content record. Returns a single record by identifier or by the content UUID. Upon enabling expanded reaction types, the response will include the additional reaction types."}},"httpPath":"/v2/content/{content_id}"},{"label":"Update an existing content post","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/endpoints/openapi/content-publishing/updatecontent","routeSlug":"/endpoints/openapi/content-publishing/updatecontent","metadata":{"seo":{"title":"Update an existing content post","description":"Update an existing content record. Content can be updated in any state, but some states have different validations. Any or all of the content attributes can be provided and only those provided will be updated. <br><br> This endpoint cannot be used to change content type, state, or topics. If author.user_id is provided, it will be used to determine display_name and avatar_url, overriding any values provided for display_name and avatar_url. <br><br> To change the state (i.e. publish a draft) see <a href=\"/endpoints/openapi/content-publishing/publishcontent\"> Publish an existing content post.</a> Response body data will be the updated record."}},"httpPath":"/v2/content/{content_id}"},{"label":"Archive an existing content post","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/endpoints/openapi/content-publishing/archivecontent","routeSlug":"/endpoints/openapi/content-publishing/archivecontent","metadata":{"seo":{"title":"Archive an existing content post","description":"Archive an existing content post. Transition the content state from any state directly to \"archived\". <br><br> Response body contains the latest version of the content record."}},"httpPath":"/v2/content/{content_id}/archive"},{"label":"Draft an existing content post","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/endpoints/openapi/content-publishing/draftcontent","routeSlug":"/endpoints/openapi/content-publishing/draftcontent","metadata":{"seo":{"title":"Draft an existing content post","description":"Transition the content state of an existing content post to draft. A post can be set to draft from any any current state. If the post was published or archived, it will no longer be. <br><br> Response body is the updated record. Returns 400 Bad Request if the content cannot be transitioned to 'draft' due to validation reasons."}},"httpPath":"/v2/content/{content_id}/draft"},{"label":"Publish an existing content post","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/endpoints/openapi/content-publishing/publishcontent","routeSlug":"/endpoints/openapi/content-publishing/publishcontent","metadata":{"seo":{"title":"Publish an existing content post","description":"Change the state of the content to “published.” If the content is already in the “published” state, this request does nothing. Content in a “scheduled” state remains scheduled. For all other states, the content is published immediately. <br> Publishing content requires that at least one topic be associated to the content, as content must always have at least one topic. <br><br> Response body is the updated record. This endpoint returns 400 Bad Request if the content cannot be published. Some attributes have validations that are only applied when moving content to the published state. For example, content cannot be published until its title has been filled in."}},"httpPath":"/v2/content/{content_id}/publish"},{"label":"Mark an existing post as ready for review","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/endpoints/openapi/content-publishing/reviewcontent","routeSlug":"/endpoints/openapi/content-publishing/reviewcontent","metadata":{"seo":{"title":"Mark an existing post as ready for review","description":"Change the state of the post to \"review\". The post is immediately removed from feeds. Posts that are already in \"review\" state will not change."}},"httpPath":"/v2/content/{content_id}/review"},{"label":"List the comments on a content post","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/endpoints/openapi/content-publishing/listcontentcomments","routeSlug":"/endpoints/openapi/content-publishing/listcontentcomments","metadata":{"seo":{"title":"List the comments on a content post","description":"List the comments on a content post. Only top-level comments are returned. Comments which are replies to other comments are not currently available through this endpoint. Upon enabling expanded reactions types, the response will include the additional reaction types. <br><br>When a comment with user mentions is returned, it will be returned with those mentions in the format of either {ref:user:<user_id>} or {ref:user::id:<user_id>}. You can parse out the user_id and then look up the user and transform the mention metadata to the display_name/name of the referenced user."}},"httpPath":"/v2/content/{content_id}/comments"},{"label":"List the replies on comment post","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/endpoints/openapi/content-publishing/listcontentcommentreplies","routeSlug":"/endpoints/openapi/content-publishing/listcontentcommentreplies","metadata":{"seo":{"title":"List the replies on comment post","description":"List the replies on comment post. Upon enabling expanded reactions types, the response will include the additional reaction types. <br><br>When a comment with user mentions is returned, it will be returned with those mentions in the format of either {ref:user:<user_id>} or {ref:user::id:<user_id>}. You can parse out the user_id and then look up the user and transform the mention metadata to the display_name/name of the referenced user."}},"httpPath":"/v2/content/{content_id}/comments/{comment_id}/replies"},{"label":"Add an image to a content post","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/endpoints/openapi/content-publishing/addcontentimage","routeSlug":"/endpoints/openapi/content-publishing/addcontentimage","metadata":{"seo":{"title":"Add an image to a content post","description":"Add a new image to a content record. Response body is the updated content record. This API does not resize or rehost images. Images should be appropriately sized and will be served from the provided URL."}},"httpPath":"/v2/content/{content_id}/images"},{"label":"Add a video for use in content of type article","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/endpoints/openapi/content-publishing/addcontentvideo","routeSlug":"/endpoints/openapi/content-publishing/addcontentvideo","metadata":{"seo":{"title":"Add a video for use in content of type article","description":"Add a new video to a content record. Response body is the attributes of the video record. Insert the returned <code>embed_html</code> into the <code>body</code> of the article at the location you want the video to appear in the article."}},"httpPath":"/v2/content/{content_id}/videos"},{"label":"Remove an image from a content post","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/endpoints/openapi/content-publishing/removecontentimage","routeSlug":"/endpoints/openapi/content-publishing/removecontentimage","metadata":{"seo":{"title":"Remove an image from a content post","description":"Remove an image from a content record. Images cannot be removed from published content. Response status for removed content is 204 No Content."}},"httpPath":"/v2/content/{content_id}/images/{content_image_id}"},{"label":"Fetch content replications","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/endpoints/openapi/content-publishing/listcontentreplications","routeSlug":"/endpoints/openapi/content-publishing/listcontentreplications","metadata":{"seo":{"title":"Fetch content replications","description":"The endpoint allow users to get details of content replication. Source or target filter is required"}},"httpPath":"/v2/content/replications"},{"label":"Get a download URL for a content video","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/endpoints/openapi/content-publishing/downloadcontentvideo","routeSlug":"/endpoints/openapi/content-publishing/downloadcontentvideo","metadata":{"seo":{"title":"Get a download URL for a content video","description":"Returns a temporary link to a content video."}},"httpPath":"/v2/videos/{video_id}/download"},{"label":"Fetch the unique count of users who can see the content post","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/endpoints/openapi/content-publishing/contentreachcount","routeSlug":"/endpoints/openapi/content-publishing/contentreachcount","metadata":{"seo":{"title":"Fetch the unique count of users who can see the content post","description":"Fetch the content reach, the unique user count for audiences, topics, and both."}},"httpPath":"/v2/content/{content_id}/reach/unique_user_count"}]},{"type":"group","label":"Feeds","link":"/endpoints/openapi/feeds","routeSlug":"/endpoints/openapi/feeds","items":[{"label":"Return a user's feed of posts","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/endpoints/openapi/feeds/listfeedposts","routeSlug":"/endpoints/openapi/feeds/listfeedposts","metadata":{"seo":{"title":"Return a user's feed of posts","description":"Provides a list of posts in the user’s feed. Accepts pagination and filtering parameters. Upon enabling expanded reactions types, the response will include the additional reaction types.<br>Resources<ul><li><a href=\"https://support.firstup.io/hc/en-us/articles/4415354532759-How-Do-Users-See-Content\">Knowledge Base article on Feeds</a></li><li><a href=\"/feeds/feedsoverview\">Feeds overview page</a><li><a href=\"gettingstarted/pagination\">Pagination</a><li><a href=\"gettingstarted/filtering\">Filtering</a></li></ul>"}},"httpPath":"/v2/feed/posts"},{"label":"Return a user's homepage feed","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/endpoints/openapi/feeds/webhomepagefeed","routeSlug":"/endpoints/openapi/feeds/webhomepagefeed","metadata":{"seo":{"title":"Return a user's homepage feed","description":"Provides a user’s homepage feed, complete with the homepage banner, user’s shortcuts and modules. This is a restricted endpoint that requires enablement. Reach out to your Firstup representative for access. "}},"httpPath":"/v2/feeds/web_homepage"},{"label":"Return a user profile's submitted content","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/endpoints/openapi/feeds/listfeedprofilesubmitted","routeSlug":"/endpoints/openapi/feeds/listfeedprofilesubmitted","metadata":{"seo":{"title":"Return a user profile's submitted content","description":"Return a user profile's submitted content"}},"httpPath":"/v2/feed/profile/submitted"},{"label":"Return channels followed by a user profile","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/endpoints/openapi/feeds/listfeedprofilechannels","routeSlug":"/endpoints/openapi/feeds/listfeedprofilechannels","metadata":{"seo":{"title":"Return channels followed by a user profile","description":"Return channels followed by a user profile"}},"httpPath":"/v2/feed/profile/channels"},{"label":"Return the details of a single post within a feed","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/endpoints/openapi/feeds/detailfeedpost","routeSlug":"/endpoints/openapi/feeds/detailfeedpost","metadata":{"seo":{"title":"Return the details of a single post within a feed","description":"Provides the data for a single post in a user’s feed. The post must be visible to the user or a 404 Not Found response will be returned. Upon enabling expanded reactions types, the response will include the additional reaction types."}},"httpPath":"/v2/feed/posts/{content_id}"},{"label":"Return the engagement details of a single post within a feed","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/endpoints/openapi/feeds/detailfeedpostengagement","routeSlug":"/endpoints/openapi/feeds/detailfeedpostengagement","metadata":{"seo":{"title":"Return the engagement details of a single post within a feed","description":"Displays the user’s engagements related to a single feed post, including a timestamp for each type of engagement; for example, a <code>liked_at</code> timestamp is present if the user has liked the post and a <code>bookmarked_at</code> is present if the user has bookmarked the post. The post must be visible to the user or a 404 Not Found response will be returned.<br> Upon enabling expanded reactions types, the response will include a <code>reaction_type_id</code> which is associated with a reaction type."}},"httpPath":"/v2/feed/posts/{content_id}/engagement"},{"label":"Like a post in the feed","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/endpoints/openapi/feeds/likepost","routeSlug":"/endpoints/openapi/feeds/likepost","metadata":{"seo":{"title":"Like a post in the feed","description":"Creates a \"like\" engagement of a specific feed post for a scoped user. The post must be visible to the user or a 404 Not Found response will be returned; for example, this would happen if the content is published to a targeted topic that does not target the user. Upon enabling expanded reactions types, the user can like the post with a specific reaction type by providing a reaction_type_id in the request body."}},"httpPath":"/v2/feed/posts/{content_id}/like"},{"label":"Unlike a post in the feed","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/endpoints/openapi/feeds/unlikepost","routeSlug":"/endpoints/openapi/feeds/unlikepost","metadata":{"seo":{"title":"Unlike a post in the feed","description":"Unlikes a feed post for a scoped user. Unliking effectively removes an existing “like” engagement. The post must be visible to the user or a 404 Not Found response will be returned; for example, this would happen if the content is published to a targeted topic that does not target the user."}},"httpPath":"/v2/feed/posts/{content_id}/unlike"},{"label":"Bookmark a post in the feed","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/endpoints/openapi/feeds/bookmarkpost","routeSlug":"/endpoints/openapi/feeds/bookmarkpost","metadata":{"seo":{"title":"Bookmark a post in the feed","description":"Creates a “bookmark” engagement of a specific feed post for a scoped user. The post must be visible to the user or a 404 Not Found response will be returned; for example, this would happen if the content is published to a targeted topic that does not target the user."}},"httpPath":"/v2/feed/posts/{content_id}/bookmark"},{"label":"Unbookmark a post in the feed","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/endpoints/openapi/feeds/unbookmarkpost","routeSlug":"/endpoints/openapi/feeds/unbookmarkpost","metadata":{"seo":{"title":"Unbookmark a post in the feed","description":"Unbookmarks a feed post for a scoped user. Unbookmarking effectively removes an existing “bookmark” engagement. The post must be visible to the user or a 404 Not Found response will be returned; for example, if the content is published to a targeted topic that does not target the user."}},"httpPath":"/v2/feed/posts/{content_id}/unbookmark"},{"label":"Get the trackable URL for a post in the feed","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/endpoints/openapi/feeds/generatetrackableurl","routeSlug":"/endpoints/openapi/feeds/generatetrackableurl","metadata":{"seo":{"title":"Get the trackable URL for a post in the feed","description":"Get the trackable URL for a feed post for a scoped user. The post must be visible to the user or a 400 bas request will be returned."}},"httpPath":"/v2/feed/posts/{content_id}/share/trackable_url"},{"label":"Share a post in the feed","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/endpoints/openapi/feeds/sharepost","routeSlug":"/endpoints/openapi/feeds/sharepost","metadata":{"seo":{"title":"Share a post in the feed","description":"Indicates that the post has been shared by a scoped user. The post must be visible to the user or a 400 bas request will be returned. share_url can be retrieved using GET <a href=\"/endpoints/openapi/feeds/generatetrackableurl\"> the trackable URL for a post in the feed</a>."}},"httpPath":"/v2/feed/posts/{content_id}/share"},{"label":"View a post in the feed","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/endpoints/openapi/feeds/viewpost","routeSlug":"/endpoints/openapi/feeds/viewpost","metadata":{"seo":{"title":"View a post in the feed","description":"Marks a specific feed post as viewed for a scoped user. Viewing is considered as the user having interacted with the content enough to qualify as at least partial consumption. The post must be visible to the user or a 404 Not Found response will be returned."}},"httpPath":"/v2/feed/posts/{content_id}/view"},{"label":"Unview a post in the feed","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/endpoints/openapi/feeds/unviewpost","routeSlug":"/endpoints/openapi/feeds/unviewpost","metadata":{"seo":{"title":"Unview a post in the feed","description":"Reverses a view operation on a feed post for a scoped user. Unviewing is used in cases where a view was mistakenly recorded. The post must be visible to the user or a 404 Not Found response will be returned."}},"httpPath":"/v2/feed/posts/{content_id}/unview"},{"label":"List the comments on a content post","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/endpoints/openapi/feeds/listfeedpostcomments","routeSlug":"/endpoints/openapi/feeds/listfeedpostcomments","metadata":{"seo":{"title":"List the comments on a content post","description":"List the comments on a content post. Only top-level comments are returned. Comments which are replies to other comments are not currently available through this endpoint. Upon enabling expanded reactions types, the response will include the additional reaction types.<br><br>When a comment with user mentions is returned, it will be returned with those mentions in the format of either {ref:user:<user_id>} or {ref:user::id:<user_id>}. You can parse out the user_id and then look up the user and transform the mention metadata to the display_name/name of the referenced user."}},"httpPath":"/v2/feed/posts/{content_id}/comments"},{"label":"Comment on a post in the feed","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/endpoints/openapi/feeds/createfeedpostcomment","routeSlug":"/endpoints/openapi/feeds/createfeedpostcomment","metadata":{"seo":{"title":"Comment on a post in the feed","description":"Creates a new comment record for the content post.You may indicate a mention of a specific user by providing their user_id in the format of either {ref:user:<user_id>} or {ref:user::id:<user_id>}."}},"httpPath":"/v2/feed/posts/{content_id}/comments"},{"label":"List the replies to a comment on a content post","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/endpoints/openapi/feeds/listfeedpostcommentreplies","routeSlug":"/endpoints/openapi/feeds/listfeedpostcommentreplies","metadata":{"seo":{"title":"List the replies to a comment on a content post","description":"List the replies to a comment on a content post. Upon enabling expanded reactions types, the response will include the additional reaction types.<br><br>When a comment with user mentions is returned, it will be returned with those mentions in the format of either {ref:user:<user_id>} or {ref:user::id:<user_id>}. You can parse out the user_id and then look up the user and transform the mention metadata to the display_name/name of the referenced user."}},"httpPath":"/v2/feed/posts/{content_id}/comments/{comment_id}/replies"},{"label":"Reply to a comment on a post in the feed","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/endpoints/openapi/feeds/createfeedpostcommentreply","routeSlug":"/endpoints/openapi/feeds/createfeedpostcommentreply","metadata":{"seo":{"title":"Reply to a comment on a post in the feed","description":"Upon enabling expanded reactions types, the response will include the additional reaction types. <br><br>When a comment with user mentions is returned, it will be returned with those mentions in the format of either {ref:user:<user_id>} or {ref:user::id:<user_id>}. You can parse out the user_id and then look up the user and transform the mention metadata to the display_name/name of the referenced user."}},"httpPath":"/v2/feed/posts/{content_id}/comments/{comment_id}/{post_number}/replies"},{"label":"Report a Comment or Reply for a given post in the feed","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/endpoints/openapi/feeds/reportfeedpostcomment","routeSlug":"/endpoints/openapi/feeds/reportfeedpostcomment","metadata":{"seo":{"title":"Report a Comment or Reply for a given post in the feed","description":"Creates a Report for a specific comment (or reply) to a post for a scoped user. The comment must be visible to the user or a 404 Not Found response will be returned; for example, this would happen if the comment is published to a post in a targeted topic that does not target the user."}},"httpPath":"/v2/feed/posts/{content_id}/comments/{comment_id}/report"},{"label":"Query for users that are able to be mentioned.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/endpoints/openapi/feeds/suggestuser","routeSlug":"/endpoints/openapi/feeds/suggestuser","metadata":{"seo":{"title":"Query for users that are able to be mentioned.","description":"Query for users that are able to be mentioned."}},"httpPath":"/v2/feed/users/suggest"},{"label":"Update a comment on a post in the feed","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/endpoints/openapi/feeds/updatefeedpostcomment","routeSlug":"/endpoints/openapi/feeds/updatefeedpostcomment","metadata":{"seo":{"title":"Update a comment on a post in the feed","description":"Update an existing comment record. The body attribute can be provided and only those provided will be updated. <br><br> Response body data will be the updated record. Upon enabling expanded reactions types, the response will include the additional reaction types.<br><br>You may indicate a mention of a specific user by providing their user_id in the format of either {ref:user:<user_id>} or {ref:user::id:<user_id>}."}},"httpPath":"/v2/feed/posts/{content_id}/comments/{comment_id}"},{"label":"Delete a comment or reply on a post in the feed","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/endpoints/openapi/feeds/deletefeedpostcomment","routeSlug":"/endpoints/openapi/feeds/deletefeedpostcomment","metadata":{"seo":{"title":"Delete a comment or reply on a post in the feed","description":"Allows an authenticated user to delete a comment or reply they authored. The comment is soft deleted and will no longer appear in feed views."}},"httpPath":"/v2/feed/posts/{content_id}/comments/{comment_id}"},{"label":"Return the rendered content of a single post within the feed","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/endpoints/openapi/feeds/renderfeedpost","routeSlug":"/endpoints/openapi/feeds/renderfeedpost","metadata":{"seo":{"title":"Return the rendered content of a single post within the feed","description":"Provides the rendered content for a single post in a user’s feed. The post must be visible to the user or a 404 Not Found response will be returned."}},"httpPath":"/v2/feed/posts/{content_id}/rendered"},{"label":"Report a post in the feed","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/endpoints/openapi/feeds/reportfeedpost","routeSlug":"/endpoints/openapi/feeds/reportfeedpost","metadata":{"seo":{"title":"Report a post in the feed","description":"Creates a Report for a specific feed post for a scoped user. The post must be visible to the user or a 404 Not Found response will be returned; for example, this would happen if the content is published to a targeted topic that does not target the user."}},"httpPath":"/v2/feed/posts/{content_id}/report"},{"label":"Acknowledge a post in the feed.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/endpoints/openapi/feeds/acknowledgefeedpost","routeSlug":"/endpoints/openapi/feeds/acknowledgefeedpost","metadata":{"seo":{"title":"Acknowledge a post in the feed.","description":"Acknowledges a feed post for a scoped user. The post must be visible to the user or a 404 Not Found response will be returned; for example, if the content is published to a targeted channel that does not target the user."}},"httpPath":"/v2/feed/posts/{content_id}/acknowledge"},{"label":"Returns the details of a single poll.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/endpoints/openapi/feeds/showfeedpoll","routeSlug":"/endpoints/openapi/feeds/showfeedpoll","metadata":{"seo":{"title":"Returns the details of a single poll.","description":"Provides data for a single poll."}},"httpPath":"/v2/feed/polls/{poll_id}"},{"label":"Respond to a poll.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/endpoints/openapi/feeds/respondfeedpoll","routeSlug":"/endpoints/openapi/feeds/respondfeedpoll","metadata":{"seo":{"title":"Respond to a poll.","description":"Respond to a poll."}},"httpPath":"/v2/feed/polls/{poll_id}"},{"label":"Returns a user's feed of polls.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/endpoints/openapi/feeds/listfeedpolls","routeSlug":"/endpoints/openapi/feeds/listfeedpolls","metadata":{"seo":{"title":"Returns a user's feed of polls.","description":"Provides a list of polls in the user's feed."}},"httpPath":"/v2/feed/polls"},{"label":"Experimental and undocumented video access","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/endpoints/openapi/feeds/showfeedvideo","routeSlug":"/endpoints/openapi/feeds/showfeedvideo","metadata":{"seo":{"title":"Experimental and undocumented video access","description":"Experimental internal API"}},"httpPath":"/v2/feed/video/{video_id}"},{"label":"Experimental and undocumented attachment access","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/endpoints/openapi/feeds/getattachmentstatus","routeSlug":"/endpoints/openapi/feeds/getattachmentstatus","metadata":{"seo":{"title":"Experimental and undocumented attachment access","description":"Experimental internal API"}},"httpPath":"/v2/feed/attachments/{uuid}/status"},{"label":"Experimental and undocumented attachment redirect","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/endpoints/openapi/feeds/getattachmentredirect","routeSlug":"/endpoints/openapi/feeds/getattachmentredirect","metadata":{"seo":{"title":"Experimental and undocumented attachment redirect","description":"Experimental internal API. Mints a fresh signed S3 URL on every request and 302s to it. Returns 410 with a friendly HTML page when the attachment isn't safe."}},"httpPath":"/v2/feed/attachments/{uuid}/redirect"}]},{"type":"group","label":"User Management","link":"/endpoints/openapi/user-management","routeSlug":"/endpoints/openapi/user-management","items":[{"label":"List SCIM schemas","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/endpoints/openapi/user-management/listschemas","routeSlug":"/endpoints/openapi/user-management/listschemas","metadata":{"seo":{"title":"List SCIM schemas","description":"Returns a list of the schemas in use by this SCIM API. Implements <a href=\"https://tools.ietf.org/html/rfc7643#section-7\">SCIM 2.0 Specification</a>."}},"httpPath":"/scim/v2/Schemas"},{"label":"Detail a SCIM schema","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/endpoints/openapi/user-management/detailschema","routeSlug":"/endpoints/openapi/user-management/detailschema","metadata":{"seo":{"title":"Detail a SCIM schema","description":"Returns the specified schema used by this SCIM API. Implements <a href=\"https://tools.ietf.org/html/rfc7643#section-7\">SCIM 2.0 specification</a>."}},"httpPath":"/scim/v2/Schemas/{schema_id}"},{"label":"Provides SCIM Schema Provider Configuration","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/endpoints/openapi/user-management/detailserviceproviderconfig","routeSlug":"/endpoints/openapi/user-management/detailserviceproviderconfig","metadata":{"seo":{"title":"Provides SCIM Schema Provider Configuration","description":"Returns the Schema Provider configuration as per <a href=\"https://tools.ietf.org/html/rfc7643#section-5\">SCIM 2.0 Specification</a>.Additional references:<ul><li><a href=\"https://tools.ietf.org/html/rfc7643#section-8.5\">SCIM 2.0 Spc Section 8.5</a></li><li><a href=\"https://tools.ietf.org/html/rfc7643#section-8.7.2\">SCIM 2.0 Spec Section 8.7.2</a></li></ul>"}},"httpPath":"/scim/v2/ServiceProviderConfig"},{"label":"Provides SCIM Resource Types","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/endpoints/openapi/user-management/listresourcetypes","routeSlug":"/endpoints/openapi/user-management/listresourcetypes","metadata":{"seo":{"title":"Provides SCIM Resource Types","description":"Returns available Resource Types configuration as per <a href=\"https://tools.ietf.org/html/rfc7643#section-5\">SCIM 2.0 Specification</a>.Additional references:<ul><li><a href=\"https://tools.ietf.org/html/rfc7644#section-4\">SCIM 2.0 Protocol Spec Section 4</a></li><li><a href=\"https://tools.ietf.org/html/rfc7643#section-8.6\">SCIM 2.0 Spec Section 8.5</a></li></ul>"}},"httpPath":"/scim/v2/ResourceTypes"},{"label":"Detail a SCIM Resource Type","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/endpoints/openapi/user-management/detailresourcetype","routeSlug":"/endpoints/openapi/user-management/detailresourcetype","metadata":{"seo":{"title":"Detail a SCIM Resource Type","description":"Returns the requested Resource Type <a href=\"https://tools.ietf.org/html/rfc7643#section-5\">SCIM 2.0 Specification</a>.Additional references:<ul><li><a href=\"https://tools.ietf.org/html/rfc7644#section-4\">SCIM 2.0 Protocol Spec Section 4</a></li><li><a href=\"https://tools.ietf.org/html/rfc7643#section-8.6\">SCIM 2.0 Spec Section 8.5</a></li></ul>"}},"httpPath":"/scim/v2/ResourceTypes/{resource_id}"},{"label":"List users in the program","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/endpoints/openapi/user-management/listusers","routeSlug":"/endpoints/openapi/user-management/listusers","metadata":{"seo":{"title":"List users in the program","description":"This endpoint allows you to retrieve information about all or some of theusers stored in the Firstup application and adheres to theSCIM 2.0 Section: 4.1 standard."}},"httpPath":"/scim/v2/Users"},{"label":"Create a user in the program","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/endpoints/openapi/user-management/createuser","routeSlug":"/endpoints/openapi/user-management/createuser","metadata":{"seo":{"title":"Create a user in the program","description":"Create and provision a new user. The request should include any properties to be set on the user, and leaving any out will leave those values blank, or will use defaults. <br><br> New users have a role of \"member\" by default. New users have an onboarding status of \"created\" by default. <br><br> Setting a user's role requires that the acting user have a role the same or less than the role of the user being created. The role property is also formatted as an array to comply with SCIM protocol though it only accepts a single value. Providing more than one value will result in a 400 response.<br></br>  Additional documentation and resources <br> * <a href=\"https://developers.firstup.io/usermanagementapi/user-role-provisioning\"> User roles and access </a><br> * <a href=\"https://developers.firstup.io/usermanagementapi/user-provisioning\"> User provisioning </a><br> * <a href=\"https://developers.firstup.io/usermanagementapi/scim-user-provision\"> SCIM user provisioning </a> "}},"httpPath":"/scim/v2/Users"},{"label":"Show a single program user by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/endpoints/openapi/user-management/detailuser","routeSlug":"/endpoints/openapi/user-management/detailuser","metadata":{"seo":{"title":"Show a single program user by ID","description":"Returns a User record for specified user in the program."}},"httpPath":"/scim/v2/Users/{user_id}"},{"label":"Replace a user in the program","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/endpoints/openapi/user-management/replaceuser","routeSlug":"/endpoints/openapi/user-management/replaceuser","metadata":{"seo":{"title":"Replace a user in the program","description":"To update or replace user information, ensure that your request includes a comprehensive set of user attributes.Utilize PUT endpoints carefully. Modified data models caused by new features or user-defined fields may lead to data loss. Refer to our <a href=\"https://developers.firstup.io/usermanagementapi/scim-patch-operations\"> SCIM patching documentation</a> before executing.Quick Guidance<br>For a seamless process, consider the following:"}},"httpPath":"/scim/v2/Users/{user_id}"},{"label":"Update a user in the program","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/endpoints/openapi/user-management/patchuser","routeSlug":"/endpoints/openapi/user-management/patchuser","metadata":{"seo":{"title":"Update a user in the program","description":"Update a user in the program with partial changes using <a href=\"https://tools.ietf.org/html/rfc7644#section-3.5.2\">SCIM PatchOp</a>. Add, remove, or replace selected fields of the user. Role updates require the acting user's role to be the same or higher role than the user being updated both before and after the role update. We advise refering to our <a href=\"https://developers.firstup.io/usermanagementapi/scim-patch-operations\"> SCIM patching documentation</a> before executing.Refer to our <a href=\"https://developers.firstup.io/gettingstarted/error_responses\"> error responses documentation</a> for detail on errors."}},"httpPath":"/scim/v2/Users/{user_id}"},{"label":"Completely remove a user from the system","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/endpoints/openapi/user-management/deleteuser","routeSlug":"/endpoints/openapi/user-management/deleteuser","metadata":{"seo":{"title":"Completely remove a user from the system","description":"Permanently remove a User and their details from all Programs. A non-existent user, or a user that's already been forgotten, will return a 204."}},"httpPath":"/scim/v2/Users/{user_id}"},{"label":"Show information about the current user","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/endpoints/openapi/user-management/me","routeSlug":"/endpoints/openapi/user-management/me","metadata":{"seo":{"title":"Show information about the current user","description":"Returns a User record for specified user in the program. This endpoint requires <a href=\"https://developers.firstup.io/authorization/authentication-methods#jwt-bearer-token-grant\"> authentication</a> as a user."}},"httpPath":"/scim/v2/Users/me"},{"label":"Completely remove a user from the system (Not SCIM compliant)","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/endpoints/openapi/user-management/forgetuser","routeSlug":"/endpoints/openapi/user-management/forgetuser","metadata":{"seo":{"title":"Completely remove a user from the system (Not SCIM compliant)","description":"Permanently remove a User and their details from all Programs. A non-existent user, or a user that's already been forgotten, will return a 202."}},"httpPath":"/v2/Users/{user_id}/forget"}]},{"type":"group","label":"User Groups","link":"/endpoints/openapi/user-groups","routeSlug":"/endpoints/openapi/user-groups","items":[{"label":"Returns a list of Groups","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/endpoints/openapi/user-groups/listgroups","routeSlug":"/endpoints/openapi/user-groups/listgroups","metadata":{"seo":{"title":"Returns a list of Groups","description":"Returns a list of all accessible Groups in the acting User's Program."}},"httpPath":"/scim/v2/Groups"},{"label":"Creates a Group","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/endpoints/openapi/user-groups/creategroup","routeSlug":"/endpoints/openapi/user-groups/creategroup","metadata":{"seo":{"title":"Creates a Group","description":"Creates and provisions a new Group of Users. The request should include any properties to be set onthe Group. Any property not provided would leave the value blank or use defaults."}},"httpPath":"/scim/v2/Groups"},{"label":"Returns the details of the given Group, including its members","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/endpoints/openapi/user-groups/detailgroup","routeSlug":"/endpoints/openapi/user-groups/detailgroup","metadata":{"seo":{"title":"Returns the details of the given Group, including its members","description":"Returns the group specified by the group_id. Groups are defined by the SCIM specification."}},"httpPath":"/scim/v2/Groups/{group_id}"},{"label":"Updates a Group","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/endpoints/openapi/user-groups/patchgroup","routeSlug":"/endpoints/openapi/user-groups/patchgroup","metadata":{"seo":{"title":"Updates a Group","description":"Update an audience in the Program with partial changes usingSCIM PatchOp."}},"httpPath":"/scim/v2/Groups/{group_id}"},{"label":"Deletes a Group","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/endpoints/openapi/user-groups/deletegroup","routeSlug":"/endpoints/openapi/user-groups/deletegroup","metadata":{"seo":{"title":"Deletes a Group","description":"Delete an audience in the Program"}},"httpPath":"/scim/v2/Groups/{group_id}"},{"label":"Updates a Group","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/endpoints/openapi/user-groups/updategroup","routeSlug":"/endpoints/openapi/user-groups/updategroup","metadata":{"seo":{"title":"Updates a Group","description":"Updates and provisions an existing Group of Users. The request should include any properties to be set onthe Group. Any property not provided would leave the value blank or use defaults."}},"httpPath":"/scim/v2/Groups/{group_id}"},{"label":"Returns details on asynchronous jobs to modify a Group's members","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/endpoints/openapi/user-groups/groupasyncjobreport","routeSlug":"/endpoints/openapi/user-groups/groupasyncjobreport","metadata":{"seo":{"title":"Returns details on asynchronous jobs to modify a Group's members","description":"The calls to the POST, PUT or PATCH Groups Managements endpoints trigger a series of asynchronous jobs to create or update the list of the Group's members."}},"httpPath":"/v2/Groups/JobReport/{jobId}"}]},{"type":"group","label":"Webhooks","link":"/endpoints/openapi/webhooks","routeSlug":"/endpoints/openapi/webhooks","items":[{"label":"Fetch the program's configured webhook subscriptions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/endpoints/openapi/webhooks/listwebhooksubscriptions","routeSlug":"/endpoints/openapi/webhooks/listwebhooksubscriptions","metadata":{"seo":{"title":"Fetch the program's configured webhook subscriptions","description":"<p>Fetchs multiple subscription records at a time, and can be paginated using cursor pagination. </p>"}},"httpPath":"/v2/webhooks/subscriptions"},{"label":"Create a new webhook subscription","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/endpoints/openapi/webhooks/createwebhooksubscription","routeSlug":"/endpoints/openapi/webhooks/createwebhooksubscription","metadata":{"seo":{"title":"Create a new webhook subscription","description":"<p>Subscriptions are configurations that define what events you want to receive webhooks for. A url and at least one event are required for a subscription. If your server requires authorization, the <code>authorization_header</code> property allows you to specify what value to send in the \"Authorization\" http header of every delivery to your url.</p> <br /> <p>More information about creating webhook subscriptions is available on the <a href=\"/webhooks/webhooks-overview\">Creating Webhook Subscriptions</a> page, and the list of available events is available on the <a href=\"/webhooks/webhook-events\">Event List</a> page.</p> <br /> <p>The access token used when creating a subscription must have the <code>webhooks.write</code> <a href=\"/authorization/authenticationandauthorization#auth-scope-list-and-definitions\">auth scope</a>. </p>"}},"httpPath":"/v2/webhooks/subscriptions"},{"label":"Update an existing webhook subscription","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/endpoints/openapi/webhooks/updatewebhooksubscription","routeSlug":"/endpoints/openapi/webhooks/updatewebhooksubscription","metadata":{"seo":{"title":"Update an existing webhook subscription","description":"<p>After creation, subscriptions can be updated to change what events are subscribed to, what url to send the payloads to, and other settings such as whether the subscription is active. Any values that can be set on the subscription when creating it can be updated.</p> <br /> <p>The update method is a patch operation, so only properties you send in the request will be updated on the record. The <code>events</code> property, however, does not support partial updates as an array. </p> <br /> <p>The access token used when updating a subscription must have the <code>webhooks.write</code> <a href=\"/authorization/authenticationandauthorization#auth-scope-list-and-definitions\">auth scope</a>. </p>"}},"httpPath":"/v2/webhooks/subscriptions/{subscription_id}"},{"label":"Delete a webhook subscription permanently","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/endpoints/openapi/webhooks/deletewebhooksubscription","routeSlug":"/endpoints/openapi/webhooks/deletewebhooksubscription","metadata":{"seo":{"title":"Delete a webhook subscription permanently","description":"Deactivate a webhook subscription and remove the record permanently.Warning: you cannot undo this action."}},"httpPath":"/v2/webhooks/subscriptions/{subscription_id}"},{"label":"Fetch a single webhook subscription record","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/endpoints/openapi/webhooks/detailwebhooksubscription","routeSlug":"/endpoints/openapi/webhooks/detailwebhooksubscription","metadata":{"seo":{"title":"Fetch a single webhook subscription record","description":"Fetch a single webhook subscription record"}},"httpPath":"/v2/webhooks/subscriptions/{subscription_id}"},{"label":"Test a webhook subscription by pinging it with a sample payload","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/endpoints/openapi/webhooks/pingwebhooksubscription","routeSlug":"/endpoints/openapi/webhooks/pingwebhooksubscription","metadata":{"seo":{"title":"Test a webhook subscription by pinging it with a sample payload","description":"More information about testing webhook subscriptions is available on the <a href=\"/webhooks/webhooks-overview#test-a-webook\">Testing Webhook Subscriptions</a> page."}},"httpPath":"/v2/webhooks/subscriptions/{subscription_id}/ping"}]},{"type":"group","label":"Assistant Inbox","link":"/endpoints/openapi/assistant-inbox","routeSlug":"/endpoints/openapi/assistant-inbox","items":[{"label":"Fetch the program user's inbox","deprecated":true,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/endpoints/openapi/assistant-inbox/listinboxitems","routeSlug":"/endpoints/openapi/assistant-inbox/listinboxitems","metadata":{"seo":{"title":"Fetch the program user's inbox","description":"<p>Fetches multiple inbox item records at a time.</p>"}},"httpPath":"/v2/assistant/inbox_items"},{"label":"Fetch the program user's Todos.","deprecated":true,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/endpoints/openapi/assistant-inbox/listassistanttodos","routeSlug":"/endpoints/openapi/assistant-inbox/listassistanttodos","metadata":{"seo":{"title":"Fetch the program user's Todos.","description":"<p>Fetches multiple Todo records at a time. </p>"}},"httpPath":"/v2/assistant/todos"},{"label":"Fetch the program user's notifications.","deprecated":true,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/endpoints/openapi/assistant-inbox/listnotifications","routeSlug":"/endpoints/openapi/assistant-inbox/listnotifications","metadata":{"seo":{"title":"Fetch the program user's notifications.","description":"<p>Fetches multiple inbox notification records at a time. </p>"}},"httpPath":"/v2/assistant/notifications"},{"label":"Acknowledge the program user's notification.","deprecated":true,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/endpoints/openapi/assistant-inbox/acknowledgenotification","routeSlug":"/endpoints/openapi/assistant-inbox/acknowledgenotification","metadata":{"seo":{"title":"Acknowledge the program user's notification.","description":"<p>Mark the program user's notification acknowledged.</p>"}},"httpPath":"/v2/assistant/notifications/{notification_id}/acknowledge"},{"label":"Acknowledge all program user's notifications.","deprecated":true,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/endpoints/openapi/assistant-inbox/acknowledgeallnotifications","routeSlug":"/endpoints/openapi/assistant-inbox/acknowledgeallnotifications","metadata":{"seo":{"title":"Acknowledge all program user's notifications.","description":"<p>Mark all program user's notifications acknowledged.</p>"}},"httpPath":"/v2/assistant/notifications/acknowledge_all"},{"label":"Fetch the program user's notifications count.","deprecated":true,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/endpoints/openapi/assistant-inbox/getinboxitemstotalcount","routeSlug":"/endpoints/openapi/assistant-inbox/getinboxitemstotalcount","metadata":{"seo":{"title":"Fetch the program user's notifications count.","description":"<p>Fetches the count of notifications for the user.</p>"}},"httpPath":"/v2/assistant/inbox_items/total_count"}]},{"type":"group","label":"Notification Center","link":"/endpoints/openapi/notification-center","routeSlug":"/endpoints/openapi/notification-center","items":[{"label":"Fetch the program user's notifications.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/endpoints/openapi/notification-center/listnotifications","routeSlug":"/endpoints/openapi/notification-center/listnotifications","metadata":{"seo":{"title":"Fetch the program user's notifications.","description":"<p>Fetches multiple inbox notification records at a time. </p>"}},"httpPath":"/v2/notification_center/notifications"},{"label":"Acknowledge the program user's notification.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/endpoints/openapi/notification-center/readnotification","routeSlug":"/endpoints/openapi/notification-center/readnotification","metadata":{"seo":{"title":"Acknowledge the program user's notification.","description":"<p>Mark the program user's notification read.</p>"}},"httpPath":"/v2/notification_center/notifications/{notification_id}/read"},{"label":"Fetch the program user's notifications count.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/endpoints/openapi/notification-center/getnotificationstotalcount","routeSlug":"/endpoints/openapi/notification-center/getnotificationstotalcount","metadata":{"seo":{"title":"Fetch the program user's notifications count.","description":"<p>Fetches the count of notifications for the user.</p>"}},"httpPath":"/v2/notification_center/total_count"}]},{"type":"group","label":"User Roles","link":"/endpoints/openapi/user-roles","routeSlug":"/endpoints/openapi/user-roles","items":[{"label":"Return a list of roles","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/endpoints/openapi/user-roles/listroles","routeSlug":"/endpoints/openapi/user-roles/listroles","metadata":{"seo":{"title":"Return a list of roles","description":"Returns a list of all accessible roles in the actor's program. Only primary roles are currently available."}},"httpPath":"/scim/v2/Roles"}]},{"type":"group","label":"Data Exports","link":"/endpoints/openapi/data-exports","routeSlug":"/endpoints/openapi/data-exports","items":[{"label":"Get the latest export file for a given type.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/endpoints/openapi/data-exports/latestexport","routeSlug":"/endpoints/openapi/data-exports/latestexport","metadata":{"seo":{"title":"Get the latest export file for a given type.","description":"<p>Returns metadata and a presigned download URL for the most recent export file of the specified type within the caller's program.</p> <p>Valid type names: <code>users</code>, <code>campaigns</code>, <code>activities</code>.</p>"}},"httpPath":"/v2/data_exports/type/{type_name}/latest"},{"label":"List all available export files for a given type.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/endpoints/openapi/data-exports/listexports","routeSlug":"/endpoints/openapi/data-exports/listexports","metadata":{"seo":{"title":"List all available export files for a given type.","description":"<p>Returns a list of all export files for the specified type within the caller's program. Each file entry includes an opaque file ID that can be used with the show endpoint to obtain a presigned download URL.</p> <p>Valid type names: <code>users</code>, <code>campaigns</code>, <code>activities</code>.</p>"}},"httpPath":"/v2/data_exports/type/{type_name}"},{"label":"Get metadata and download URL for a specific export file.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/endpoints/openapi/data-exports/showexport","routeSlug":"/endpoints/openapi/data-exports/showexport","metadata":{"seo":{"title":"Get metadata and download URL for a specific export file.","description":"<p>Returns metadata and a presigned download URL for a specific export file identified by its file ID. The file ID is obtained from the list exports endpoint.</p>"}},"httpPath":"/v2/data_exports/type/{type_name}/files/{file_id}"}]},{"type":"group","label":"Feed Channel Posts","link":"/endpoints/openapi/feed-channel-posts","routeSlug":"/endpoints/openapi/feed-channel-posts","items":[{"label":"Return a user's feed of posts for channels","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/endpoints/openapi/feed-channel-posts/listfeedchannelposts","routeSlug":"/endpoints/openapi/feed-channel-posts/listfeedchannelposts","metadata":{"seo":{"title":"Return a user's feed of posts for channels","description":"Provides a list of posts in the user’s channels feeds. Accepts pagination and filtering parameters. Upon enabling expanded reactions types, the response will include the additional reaction types.<br>Resources<ul><li><a href=\"https://support.firstup.io/hc/en-us/articles/4415354532759-How-Do-Users-See-Content\">Knowledge Base article on Feed Channels</a></li><li><a href=\"/feed_channels\">Feed Channels overview page</a><li><a href=\"gettingstarted/pagination\">Pagination</a><li><a href=\"gettingstarted/filtering\">Filtering</a></li></ul>"}},"httpPath":"/v2/feed/channels/posts"}]},{"type":"group","label":"User Shortcuts","link":"/endpoints/openapi/user-shortcuts","routeSlug":"/endpoints/openapi/user-shortcuts","items":[{"label":"Fetch the program user's shortcuts.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/endpoints/openapi/user-shortcuts/listshortcuts","routeSlug":"/endpoints/openapi/user-shortcuts/listshortcuts","metadata":{"seo":{"title":"Fetch the program user's shortcuts.","description":"<p>Fetch the program user's shortcuts.</p>"}},"httpPath":"/v2/shortcuts"}]}]}