{"items":[{"type":"link","label":"Firstup API","link":"/endpoints/openapi","routeSlug":"/endpoints/openapi","content":{"contentType":"overview","meta":{"name":"Firstup API"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"openapi.json","url":"/_bundle/endpoints/openapi.json?download"},{"kind":"download","label":"openapi.yaml","url":"/_bundle/endpoints/openapi.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[{"kind":"externallink","title":"URL","titleTranslationKey":"info.contact.url","label":"https://support.firstup.io/hc/en-us","url":"https://support.firstup.io/hc/en-us"},{"kind":"externallink","label":"Terms of Service","labelTranslationKey":"info.termsOfService","url":"https://firstup.io/legal/terms-of-service/"}]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"curl","title":"curl","lang":"curl"},{"key":"javascript","title":"JavaScript","lang":"JavaScript"},{"key":"node","title":"Node.js","lang":"Node.js"},{"key":"python","title":"Python","lang":"Python"},{"key":"java","title":"Java","lang":"Java"},{"key":"csharp","title":"C#","lang":"C#"},{"key":"php","title":"PHP","lang":"PHP"},{"key":"go","title":"Go","lang":"Go"},{"key":"ruby","title":"Ruby","lang":"Ruby"},{"key":"r","title":"R","lang":"R"},{"key":"payload","title":"Payload","lang":"Payload"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"https://partner.socialchorus.com","description":"US1"},{"url":"https://partner.us2.onfirstup.com","description":"US2"},{"url":"https://partner.onfirstup.eu","description":"EU"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Firstup API (2026-05-01)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"border":"1px solid #D9D6FE","background":"linear-gradient(180deg, #F8F6FF 0%, #F3F0FF 100%)","color":"#24124d","padding":"18px 20px","borderRadius":"14px","margin":"20px 0","boxShadow":"0 6px 20px rgba(56, 28, 117, 0.08)"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"strong","attrs":{"style":{"display":"block","fontSize":"16px","marginBottom":"8px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"What’s new"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{"style":{"margin":"0 0 8px 0"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"A quick summary of the latest API changes in version "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"strong","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"2026-05-01"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":":"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{"style":{"margin":"0 0 8px 20px","padding":"0"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"New "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"web_homepage"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" feed endpoint"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"New attachment redirect endpoint for signed downloads"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"New "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Reactions.Fields"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" response schema"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Feed post and content responses now include reaction fields"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://developers.firstup.io/versionchange/changelog"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"See the full changelog →"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API Concepts and Overview"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Each API concept can be found"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in our Docs; we give an overview of each API, the expected behavior and what"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"is possible. "},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Technical details are found in this reference, but some complex\n technicalities are further explained in our docs. "},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Further technical\n guidance on SCIM patching, pagination and filtering can be found in our\n docs:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"/usermanagementapi/scim-patch-operations"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"SCIM patching"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"/gettingstarted/pagination"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Pagination"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"/gettingstarted/filtering"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Filtering"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"/guides"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Use case examples"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Technical Details"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"From this page, you can download the OpenAPI specification for the Firstup API as a"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"openapi.json"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"openapi.yaml"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" file. This can be imported into tools such"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"as Postman to generate a collection of test queries or converted into an SDK using"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://swagger.io/tools/swagger-codegen/"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Swagger Codegen"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"admonition","attributes":{"type":"info"},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alternatively, you can use the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"/gettingstarted/try_it"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"try it function"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this platform. In addition, select your preferred "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"language"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for our request"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and response examples."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Authorization"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{"className":"code-below"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n   All API endpoints use the JSON content type and require an auth token. See "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"/authorization/authenticationandauthorization"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Authentication and Authorization"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for more details on token management.\n   The token and content type should be explicitly set in the request headers. For example:\n "},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"pre","attrs":{"className":"code"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n   curl -X GET \"https://partner.socialchorus.com/v2/channels\" -H \"accept: application/json\" -H \"Authorization: Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","attributes":{"content":"<"},"children":[]},{"$$mdtype":"Node","type":"text","attributes":{"content":"ACCESS TOKEN"},"children":[]},{"$$mdtype":"Node","type":"text","attributes":{"content":">"},"children":[]},{"$$mdtype":"Node","type":"text","attributes":{"content":"\"\n "},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"admonition","attributes":{"type":"info"},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This example uses the US1 region server. Check your region's server "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/authorization/authenticationandauthorization"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"sc-swag"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Main API Sections"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"/endpoints/openapi/content-publishing"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Content Publishing"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"/endpoints/openapi/feeds"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Feeds"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"/endpoints/openapi/user-management"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"User Management (SCIM)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"/endpoints/openapi/user-groups"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"User Group Management (SCIM)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"/endpoints/openapi/webhooks"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Webhooks"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"/endpoints/openapi/assistant-inbox"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Assistant Inbox"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"/endpoints/openapi/notification-center"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Notification Center"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"/endpoints/openapi/user-roles"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"User Roles"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"/endpoints/openapi/user-shortcuts"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"User Shortcuts"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"hr","attrs":{}},"children":[]}]}]}],"sectionId":"/endpoints/openapi"},{"nodeType":"external-docs","url":"/","description":"Firstup Developer Portal"}],"sectionId":"/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.  Resources  Knowledge Base article on Topics An overview on Content & Publishing API  "}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createChannel","name":"Create a topic in the program","isWebhook":false,"pointer":"/paths/~1v2~1channels/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a topic in the program","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates new topic in the program. A topic holds campaigns and users, organizing content for user consumption."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Resources"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"ul","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://support.firstup.io/hc/en-us/articles/4413655133719-Create-or-Edit-a-Topic"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Knowledge Base article on Topics"},"children":[]}]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"/contentandpublishing/contentoverview"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An overview on Content & Publishing API"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2_as_a_user","scopes":["content.write"],"type":"oauth2","description":"OAuth2 for Users (Authorization Code grant flow)","flows":{"authorizationCode":{"authorizationUrl":"IAM_DOMAIN/oauth/authorize","tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","openid":"Authenticate your account using OpenID.","public":"View public information.","feeds.read":"View your feeds.","feeds.rendered.read":"View rendered content from feed posts.","feeds.engage":"View your feeds and engage with posts (likes, bookmarks, etc).","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","assistant.inbox.read":"View and list details of your assistant inbox items.","notification_center":"View and list notification center items.","data_exports.read":"View and download data export files in your program."}}}}]},{"schemes":[{"name":"oauth2_as_a_server","scopes":["content.write"],"type":"oauth2","description":"OAuth2 for Server-to-Server (Client Credentials grant flow)","flows":{"clientCredentials":{"tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","public":"View public information.","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","data_exports.read":"View and download data export files in your program."}}}}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Content.Channel.Post.Resource"}},"schemaId":"components/schemas/Content.Channel.Post.Resource","pointer":"/paths/~1v2~1channels/post/requestBody","description":"Attributes of the topic to create."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/channels","servers":[{"url":"https://partner.socialchorus.com","description":"US1"},{"url":"https://partner.us2.onfirstup.com","description":"US2"},{"url":"https://partner.onfirstup.eu","description":"EU"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2_as_a_user","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"IAM_DOMAIN/oauth/authorize","tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","openid":"Authenticate your account using OpenID.","public":"View public information.","feeds.read":"View your feeds.","feeds.rendered.read":"View rendered content from feed posts.","feeds.engage":"View your feeds and engage with posts (likes, bookmarks, etc).","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","assistant.inbox.read":"View and list details of your assistant inbox items.","notification_center":"View and list notification center items.","data_exports.read":"View and download data export files in your program."}}}}],"scopes":["content.write"]},{"schemes":[{"id":"oauth2_as_a_server","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","public":"View public information.","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","data_exports.read":"View and download data export files in your program."}}}}],"scopes":["content.write"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Content.Channel.Post.Resource"}},"responseCodes":["201","400","401","404"],"pointer":"/v2/channels","href":"content-publishing/createchannel","openApiOperationId":"createChannel","summary":"Create a topic in the program","securityGroups":[{"oauth2_as_a_user":["content.write"]},{"oauth2_as_a_server":["content.write"]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://partner.socialchorus.com","description":"US1"},{"url":"https://partner.us2.onfirstup.com","description":"US2"},{"url":"https://partner.onfirstup.eu","description":"EU"}],"schemaId":"components/schemas/Content.Channel.Post.Resource","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Content.Channel.Post.Resource"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_100"}},"schemaId":"schema_100"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}},"schemaId":"schema_101"},{"code":"401","description":"Unauthenticated","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}},"schemaId":"schema_101"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}},"schemaId":"schema_101"}],"pointer":"/paths/~1v2~1channels/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_100","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_100"}}},{"code":"400","schemaId":"schema_101","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}}},{"code":"401","schemaId":"schema_101","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}}},{"code":"404","schemaId":"schema_101","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/content-publishing/createchannel"}],"panels":[]}]},"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. Response body is an array of records.  Resources  Knowledge Base article on Topics An overview on Content & Publishing API Pagination Filtering  "}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listChannels","name":"List all topics in the program","isWebhook":false,"pointer":"/paths/~1v2~1channels/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all topics in the program","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a list of topics and allows for sorting, filtering, and pagination of the records."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Response body is an array of records. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Resources"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"ul","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://support.firstup.io/hc/en-us/articles/4413655133719-Create-or-Edit-a-Topic"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Knowledge Base article on Topics"},"children":[]}]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"/contentandpublishing/contentoverview"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An overview on Content & Publishing API"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"/gettingstarted/pagination"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pagination"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"/gettingstarted/filtering"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filtering"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2_as_a_user","scopes":["content.read"],"type":"oauth2","description":"OAuth2 for Users (Authorization Code grant flow)","flows":{"authorizationCode":{"authorizationUrl":"IAM_DOMAIN/oauth/authorize","tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","openid":"Authenticate your account using OpenID.","public":"View public information.","feeds.read":"View your feeds.","feeds.rendered.read":"View rendered content from feed posts.","feeds.engage":"View your feeds and engage with posts (likes, bookmarks, etc).","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","assistant.inbox.read":"View and list details of your assistant inbox items.","notification_center":"View and list notification center items.","data_exports.read":"View and download data export files in your program."}}}}]},{"schemes":[{"name":"oauth2_as_a_server","scopes":["content.read"],"type":"oauth2","description":"OAuth2 for Server-to-Server (Client Credentials grant flow)","flows":{"clientCredentials":{"tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","public":"View public information.","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","data_exports.read":"View and download data export files in your program."}}}}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"filter.state","in":"query","schemaId":"schema_102","description":"Limit returned records to those that match the state(s) provided."},{"name":"page.size","in":"query","schemaId":"schema_103","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Return "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"page.size"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" number of records starting at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"size*number"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The default page size is 10 (number of records per page), resulting in the first page being retrieved. The maximum page size is 100."},"children":[]}]}]}]},{"name":"page.number","in":"query","schemaId":"schema_103","description":"Using classical pagination, the page number to return. Default is 1"}],"pointer":"/paths/~1v2~1channels/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/channels","servers":[{"url":"https://partner.socialchorus.com","description":"US1"},{"url":"https://partner.us2.onfirstup.com","description":"US2"},{"url":"https://partner.onfirstup.eu","description":"EU"}],"parameters":{"path":[],"query":[{"name":"filter.state","in":"query","required":false,"schemaId":"schema_102","style":"form","explode":false},{"name":"page.size","in":"query","required":false,"schemaId":"schema_103"},{"name":"page.number","in":"query","required":false,"schemaId":"schema_103"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2_as_a_user","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"IAM_DOMAIN/oauth/authorize","tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","openid":"Authenticate your account using OpenID.","public":"View public information.","feeds.read":"View your feeds.","feeds.rendered.read":"View rendered content from feed posts.","feeds.engage":"View your feeds and engage with posts (likes, bookmarks, etc).","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","assistant.inbox.read":"View and list details of your assistant inbox items.","notification_center":"View and list notification center items.","data_exports.read":"View and download data export files in your program."}}}}],"scopes":["content.read"]},{"schemes":[{"id":"oauth2_as_a_server","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","public":"View public information.","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","data_exports.read":"View and download data export files in your program."}}}}],"scopes":["content.read"]}],"responseCodes":["200","400","401","404"],"pointer":"/v2/channels","href":"content-publishing/listchannels","openApiOperationId":"listChannels","summary":"List all topics in the program","securityGroups":[{"oauth2_as_a_user":["content.read"]},{"oauth2_as_a_server":["content.read"]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://partner.socialchorus.com","description":"US1"},{"url":"https://partner.us2.onfirstup.com","description":"US2"},{"url":"https://partner.onfirstup.eu","description":"EU"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_104"}},"schemaId":"schema_104"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request (this 400 error example shows an incorrect enum validation in the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"state"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameter). See more on "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://developers.firstup.io/gettingstarted/responses#error-responses"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" error responses here "},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_105","exampleIds":["paths/~1v2~1channels/get/responses/400/content/application~1json/example"]}},"schemaId":"schema_105","exampleIds":["paths/~1v2~1channels/get/responses/400/content/application~1json/example"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthenticated. See more on "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://developers.firstup.io/gettingstarted/responses#error-responses"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" error responses here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}},"schemaId":"schema_101"},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Not Found. See more on "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://developers.firstup.io/gettingstarted/responses#error-responses"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" error responses here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}},"schemaId":"schema_101"}],"pointer":"/paths/~1v2~1channels/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_104","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_104"}}},{"code":"400","schemaId":"schema_105","exampleIds":["paths/~1v2~1channels/get/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_105","exampleIds":["paths/~1v2~1channels/get/responses/400/content/application~1json/example"]}}},{"code":"401","schemaId":"schema_101","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}}},{"code":"404","schemaId":"schema_101","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/content-publishing/listchannels"}],"panels":[]}]},"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"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateChannel","name":"Update a topic in the program","isWebhook":false,"pointer":"/paths/~1v2~1channels~1{channel_id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a topic in the program","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates a topic in the program"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2_as_a_user","scopes":["content.write"],"type":"oauth2","description":"OAuth2 for Users (Authorization Code grant flow)","flows":{"authorizationCode":{"authorizationUrl":"IAM_DOMAIN/oauth/authorize","tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","openid":"Authenticate your account using OpenID.","public":"View public information.","feeds.read":"View your feeds.","feeds.rendered.read":"View rendered content from feed posts.","feeds.engage":"View your feeds and engage with posts (likes, bookmarks, etc).","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","assistant.inbox.read":"View and list details of your assistant inbox items.","notification_center":"View and list notification center items.","data_exports.read":"View and download data export files in your program."}}}}]},{"schemes":[{"name":"oauth2_as_a_server","scopes":["content.write"],"type":"oauth2","description":"OAuth2 for Server-to-Server (Client Credentials grant flow)","flows":{"clientCredentials":{"tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","public":"View public information.","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","data_exports.read":"View and download data export files in your program."}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"channel_id","in":"path","schemaId":"schema_106","description":"ID of the topic. The topic must exist in the program.","required":true}],"pointer":"/paths/~1v2~1channels~1{channel_id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Content.Channel.Resource"}},"schemaId":"components/schemas/Content.Channel.Resource","pointer":"/paths/~1v2~1channels~1{channel_id}/put/requestBody","description":"Attributes of the topic to update."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v2/channels/{channel_id}","servers":[{"url":"https://partner.socialchorus.com","description":"US1"},{"url":"https://partner.us2.onfirstup.com","description":"US2"},{"url":"https://partner.onfirstup.eu","description":"EU"}],"parameters":{"path":[{"name":"channel_id","in":"path","required":true,"schemaId":"schema_106"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2_as_a_user","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"IAM_DOMAIN/oauth/authorize","tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","openid":"Authenticate your account using OpenID.","public":"View public information.","feeds.read":"View your feeds.","feeds.rendered.read":"View rendered content from feed posts.","feeds.engage":"View your feeds and engage with posts (likes, bookmarks, etc).","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","assistant.inbox.read":"View and list details of your assistant inbox items.","notification_center":"View and list notification center items.","data_exports.read":"View and download data export files in your program."}}}}],"scopes":["content.write"]},{"schemes":[{"id":"oauth2_as_a_server","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","public":"View public information.","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","data_exports.read":"View and download data export files in your program."}}}}],"scopes":["content.write"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Content.Channel.Resource"}},"responseCodes":["200","400","401","404"],"pointer":"/v2/channels/{channel_id}","href":"content-publishing/updatechannel","openApiOperationId":"updateChannel","summary":"Update a topic in the program","securityGroups":[{"oauth2_as_a_user":["content.write"]},{"oauth2_as_a_server":["content.write"]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://partner.socialchorus.com","description":"US1"},{"url":"https://partner.us2.onfirstup.com","description":"US2"},{"url":"https://partner.onfirstup.eu","description":"EU"}],"schemaId":"components/schemas/Content.Channel.Resource","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Content.Channel.Resource"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Updated","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_100"}},"schemaId":"schema_100"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}},"schemaId":"schema_101"},{"code":"401","description":"Unauthenticated","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}},"schemaId":"schema_101"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}},"schemaId":"schema_101"}],"pointer":"/paths/~1v2~1channels~1{channel_id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_100","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_100"}}},{"code":"400","schemaId":"schema_101","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}}},{"code":"401","schemaId":"schema_101","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}}},{"code":"404","schemaId":"schema_101","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/content-publishing/updatechannel"}],"panels":[]}]},"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. Response body is an array of records. Resources  Knowledge Base article on Topics An overview on Content & Publishing API Pagination  "}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listChannelFollowers","name":"List all followers of a topic","isWebhook":false,"pointer":"/paths/~1v2~1channels~1{channel_id}~1followers/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all followers of a topic","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a list of all users who follow the topic, and allows for pagination of the records."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Response body is an array of records."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Resources"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"ul","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://support.firstup.io/hc/en-us/articles/4413655133719-Create-or-Edit-a-Topic"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Knowledge Base article on Topics"},"children":[]}]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"/contentandpublishing/contentoverview"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An overview on Content & Publishing API"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"/gettingstarted/pagination"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pagination"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2_as_a_user","scopes":["content.read"],"type":"oauth2","description":"OAuth2 for Users (Authorization Code grant flow)","flows":{"authorizationCode":{"authorizationUrl":"IAM_DOMAIN/oauth/authorize","tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","openid":"Authenticate your account using OpenID.","public":"View public information.","feeds.read":"View your feeds.","feeds.rendered.read":"View rendered content from feed posts.","feeds.engage":"View your feeds and engage with posts (likes, bookmarks, etc).","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","assistant.inbox.read":"View and list details of your assistant inbox items.","notification_center":"View and list notification center items.","data_exports.read":"View and download data export files in your program."}}}}]},{"schemes":[{"name":"oauth2_as_a_server","scopes":["content.read"],"type":"oauth2","description":"OAuth2 for Server-to-Server (Client Credentials grant flow)","flows":{"clientCredentials":{"tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","public":"View public information.","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","data_exports.read":"View and download data export files in your program."}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"channel_id","in":"path","schemaId":"schema_106","description":"ID of the topic. The topic must exist in the program.","required":true}],"pointer":"/paths/~1v2~1channels~1{channel_id}~1followers/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page.size","in":"query","schemaId":"schema_103","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Return "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"page.size"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" number of records starting at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"size*number"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The default page size is 10 (number of records per page), resulting in the first page being retrieved. The maximum page size is 100."},"children":[]}]}]}]},{"name":"page.number","in":"query","schemaId":"schema_103","description":"Using classical pagination, the page number to return. Default is 1"}],"pointer":"/paths/~1v2~1channels~1{channel_id}~1followers/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/channels/{channel_id}/followers","servers":[{"url":"https://partner.socialchorus.com","description":"US1"},{"url":"https://partner.us2.onfirstup.com","description":"US2"},{"url":"https://partner.onfirstup.eu","description":"EU"}],"parameters":{"path":[{"name":"channel_id","in":"path","required":true,"schemaId":"schema_106"}],"query":[{"name":"page.size","in":"query","required":false,"schemaId":"schema_103"},{"name":"page.number","in":"query","required":false,"schemaId":"schema_103"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2_as_a_user","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"IAM_DOMAIN/oauth/authorize","tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","openid":"Authenticate your account using OpenID.","public":"View public information.","feeds.read":"View your feeds.","feeds.rendered.read":"View rendered content from feed posts.","feeds.engage":"View your feeds and engage with posts (likes, bookmarks, etc).","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","assistant.inbox.read":"View and list details of your assistant inbox items.","notification_center":"View and list notification center items.","data_exports.read":"View and download data export files in your program."}}}}],"scopes":["content.read"]},{"schemes":[{"id":"oauth2_as_a_server","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","public":"View public information.","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","data_exports.read":"View and download data export files in your program."}}}}],"scopes":["content.read"]}],"responseCodes":["200","400","401","404"],"pointer":"/v2/channels/{channel_id}/followers","href":"content-publishing/listchannelfollowers","openApiOperationId":"listChannelFollowers","summary":"List all followers of a topic","securityGroups":[{"oauth2_as_a_user":["content.read"]},{"oauth2_as_a_server":["content.read"]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://partner.socialchorus.com","description":"US1"},{"url":"https://partner.us2.onfirstup.com","description":"US2"},{"url":"https://partner.onfirstup.eu","description":"EU"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_107"}},"schemaId":"schema_107"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}},"schemaId":"schema_101"},{"code":"401","description":"Unauthenticated","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}},"schemaId":"schema_101"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}},"schemaId":"schema_101"}],"pointer":"/paths/~1v2~1channels~1{channel_id}~1followers/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_107","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_107"}}},{"code":"400","schemaId":"schema_101","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}}},{"code":"401","schemaId":"schema_101","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}}},{"code":"404","schemaId":"schema_101","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/content-publishing/listchannelfollowers"}],"panels":[]}]},"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listChannelPages","name":"List pages for a topic","isWebhook":false,"pointer":"/paths/~1v2~1channels~1{channel_id}~1pages/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List pages for a topic","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a list of custom pages associated with a topic."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2_as_a_user","scopes":["content.read"],"type":"oauth2","description":"OAuth2 for Users (Authorization Code grant flow)","flows":{"authorizationCode":{"authorizationUrl":"IAM_DOMAIN/oauth/authorize","tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","openid":"Authenticate your account using OpenID.","public":"View public information.","feeds.read":"View your feeds.","feeds.rendered.read":"View rendered content from feed posts.","feeds.engage":"View your feeds and engage with posts (likes, bookmarks, etc).","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","assistant.inbox.read":"View and list details of your assistant inbox items.","notification_center":"View and list notification center items.","data_exports.read":"View and download data export files in your program."}}}}]},{"schemes":[{"name":"oauth2_as_a_server","scopes":["content.read"],"type":"oauth2","description":"OAuth2 for Server-to-Server (Client Credentials grant flow)","flows":{"clientCredentials":{"tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","public":"View public information.","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","data_exports.read":"View and download data export files in your program."}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"channel_id","in":"path","schemaId":"schema_106","description":"ID of the topic. The topic must exist in the program.","required":true}],"pointer":"/paths/~1v2~1channels~1{channel_id}~1pages/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/channels/{channel_id}/pages","servers":[{"url":"https://partner.socialchorus.com","description":"US1"},{"url":"https://partner.us2.onfirstup.com","description":"US2"},{"url":"https://partner.onfirstup.eu","description":"EU"}],"parameters":{"path":[{"name":"channel_id","in":"path","required":true,"schemaId":"schema_106"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2_as_a_user","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"IAM_DOMAIN/oauth/authorize","tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","openid":"Authenticate your account using OpenID.","public":"View public information.","feeds.read":"View your feeds.","feeds.rendered.read":"View rendered content from feed posts.","feeds.engage":"View your feeds and engage with posts (likes, bookmarks, etc).","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","assistant.inbox.read":"View and list details of your assistant inbox items.","notification_center":"View and list notification center items.","data_exports.read":"View and download data export files in your program."}}}}],"scopes":["content.read"]},{"schemes":[{"id":"oauth2_as_a_server","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","public":"View public information.","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","data_exports.read":"View and download data export files in your program."}}}}],"scopes":["content.read"]}],"responseCodes":["200","400","401","404"],"pointer":"/v2/channels/{channel_id}/pages","href":"content-publishing/listchannelpages","openApiOperationId":"listChannelPages","summary":"List pages for a topic","securityGroups":[{"oauth2_as_a_user":["content.read"]},{"oauth2_as_a_server":["content.read"]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://partner.socialchorus.com","description":"US1"},{"url":"https://partner.us2.onfirstup.com","description":"US2"},{"url":"https://partner.onfirstup.eu","description":"EU"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_108"}},"schemaId":"schema_108"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}},"schemaId":"schema_101"},{"code":"401","description":"Unauthenticated","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}},"schemaId":"schema_101"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}},"schemaId":"schema_101"}],"pointer":"/paths/~1v2~1channels~1{channel_id}~1pages/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_108","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_108"}}},{"code":"400","schemaId":"schema_101","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}}},{"code":"401","schemaId":"schema_101","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}}},{"code":"404","schemaId":"schema_101","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/content-publishing/listchannelpages"}],"panels":[]}]},"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. Response body is an array of records. Resources  Knowledge Base article on Topics An overview on Content & Publishing API Pagination Filtering  "}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listContent","name":"Fetch a collection of content","isWebhook":false,"pointer":"/paths/~1v2~1content/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetch a collection of content","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Response body is an array of records."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Resources"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"ul","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://support.firstup.io/hc/en-us/articles/4413655133719-Create-or-Edit-a-Topic"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Knowledge Base article on Topics"},"children":[]}]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"/contentandpublishing/contentoverview"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An overview on Content & Publishing API"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"/gettingstarted/pagination"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pagination"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"/gettingstarted/filtering"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filtering"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2_as_a_user","scopes":["content.read"],"type":"oauth2","description":"OAuth2 for Users (Authorization Code grant flow)","flows":{"authorizationCode":{"authorizationUrl":"IAM_DOMAIN/oauth/authorize","tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","openid":"Authenticate your account using OpenID.","public":"View public information.","feeds.read":"View your feeds.","feeds.rendered.read":"View rendered content from feed posts.","feeds.engage":"View your feeds and engage with posts (likes, bookmarks, etc).","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","assistant.inbox.read":"View and list details of your assistant inbox items.","notification_center":"View and list notification center items.","data_exports.read":"View and download data export files in your program."}}}}]},{"schemes":[{"name":"oauth2_as_a_server","scopes":["content.read"],"type":"oauth2","description":"OAuth2 for Server-to-Server (Client Credentials grant flow)","flows":{"clientCredentials":{"tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","public":"View public information.","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","data_exports.read":"View and download data export files in your program."}}}}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"filter.content_type","in":"query","schemaId":"schema_109","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Limit returned records to those that match the content_type(s) provided."},"children":[]}]}]}]},{"name":"filter.state","in":"query","schemaId":"schema_110","description":"Limit returned records to those that match the state(s) provided."},{"name":"filter.targeted_channels","in":"query","schemaId":"schema_111","description":"Return content posts that are assigned to targeted topics"},{"name":"filter.channels.id","in":"query","schemaId":"schema_112","description":"Return content posts that are assigned to the topic."},{"name":"filter.initiative_tags.id","in":"query","schemaId":"schema_112","description":"Return content posts that are tagged with the provided initiative tags. Defaults to all content."},{"name":"filter.visibility","in":"query","schemaId":"schema_113","description":"Limit records to the value provided."},{"name":"filter.featured","in":"query","schemaId":"schema_111","description":"Limit records to the value provided."},{"name":"filter.source.type","in":"query","schemaId":"schema_114","description":"Limit returned records to records using the provided source.type value."},{"name":"filter.source.post_id","in":"query","schemaId":"schema_115","description":"Limit results to records with the given unique identifier on the source system."},{"name":"filter.created_at.from","in":"query","schemaId":"schema_116","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Limit results to records created at or after this time, equivalent to a range filter of \"{value} <= created_at <= now\". Use in combination with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"created_at.to"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to specify a limited upper bound on the value range."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must be formatted as an ISO8601 timestamp or datestamp. Datestamps are assumed to be in UTC."},"children":[]}]}]}]},{"name":"filter.created_at.to","in":"query","schemaId":"schema_116","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Limit results to records created at or before this time, equivalent to a range filter of \"forever <= created_at <= {value}\". Use in combination with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"created_at.from"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to specify a limited lower bound on the value range."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must be formatted as an ISO8601 timestamp or datestamp. Datestamps are assumed to be in UTC."},"children":[]}]}]}]},{"name":"filter.updated_at.from","in":"query","schemaId":"schema_116","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Limit results to records created at or after this time, equivalent to a range filter of \"{value} <= updated_at <= now\". Use in combination with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"updated_at.to"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to specify a limited upper bound on the value range."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must be formatted as an ISO8601 timestamp or datestamp. Datestamps are assumed to be in UTC."},"children":[]}]}]}]},{"name":"filter.updated_at.to","in":"query","schemaId":"schema_116","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Limit results to records created at or before this time, equivalent to a range filter of \"forever <= updated_at <= {value}\". Use in combination with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"updated_at.from"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to specify a limited lower bound on the value range."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must be formatted as an ISO8601 timestamp or datestamp. Datestamps are assumed to be in UTC."},"children":[]}]}]}]},{"name":"filter.published_at.from","in":"query","schemaId":"schema_116","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Limit results to records created at or after this time, equivalent to a range filter of \"{value} <= published_at <= now\". Use in combination with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"published_at.to"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to specify a limited upper bound on the value range."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must be formatted as an ISO8601 timestamp or datestamp. Datestamps are assumed to be in UTC."},"children":[]}]}]}]},{"name":"filter.published_at.to","in":"query","schemaId":"schema_116","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Limit results to records created at or before this time, equivalent to a range filter of \"forever <= published_at <= {value}\". Use in combination with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"published_at.from"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to specify a limited lower bound on the value range."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must be formatted as an ISO8601 timestamp or datestamp. Datestamps are assumed to be in UTC."},"children":[]}]}]}]},{"name":"page.size","in":"query","schemaId":"schema_103","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Return "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"page.size"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" number of records starting at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"size*number"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The default page size is 10 (number of records per page), resulting in the first page being retrieved. The maximum page size is 100."},"children":[]}]}]}]},{"name":"page.number","in":"query","schemaId":"schema_103","description":"Using classical pagination, the page number to return. Default is 1"}],"pointer":"/paths/~1v2~1content/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/content","servers":[{"url":"https://partner.socialchorus.com","description":"US1"},{"url":"https://partner.us2.onfirstup.com","description":"US2"},{"url":"https://partner.onfirstup.eu","description":"EU"}],"parameters":{"path":[],"query":[{"name":"filter.content_type","in":"query","required":false,"schemaId":"schema_109","style":"form","explode":false},{"name":"filter.state","in":"query","required":false,"schemaId":"schema_110","style":"form","explode":false},{"name":"filter.targeted_channels","in":"query","required":false,"schemaId":"schema_111"},{"name":"filter.channels.id","in":"query","required":false,"schemaId":"schema_112","style":"form","explode":false},{"name":"filter.initiative_tags.id","in":"query","required":false,"schemaId":"schema_112","style":"form","explode":false},{"name":"filter.visibility","in":"query","required":false,"schemaId":"schema_113"},{"name":"filter.featured","in":"query","required":false,"schemaId":"schema_111"},{"name":"filter.source.type","in":"query","required":false,"schemaId":"schema_114"},{"name":"filter.source.post_id","in":"query","required":false,"schemaId":"schema_115"},{"name":"filter.created_at.from","in":"query","schemaId":"schema_116"},{"name":"filter.created_at.to","in":"query","schemaId":"schema_116"},{"name":"filter.updated_at.from","in":"query","schemaId":"schema_116"},{"name":"filter.updated_at.to","in":"query","schemaId":"schema_116"},{"name":"filter.published_at.from","in":"query","schemaId":"schema_116"},{"name":"filter.published_at.to","in":"query","schemaId":"schema_116"},{"name":"page.size","in":"query","required":false,"schemaId":"schema_103"},{"name":"page.number","in":"query","required":false,"schemaId":"schema_103"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2_as_a_user","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"IAM_DOMAIN/oauth/authorize","tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","openid":"Authenticate your account using OpenID.","public":"View public information.","feeds.read":"View your feeds.","feeds.rendered.read":"View rendered content from feed posts.","feeds.engage":"View your feeds and engage with posts (likes, bookmarks, etc).","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","assistant.inbox.read":"View and list details of your assistant inbox items.","notification_center":"View and list notification center items.","data_exports.read":"View and download data export files in your program."}}}}],"scopes":["content.read"]},{"schemes":[{"id":"oauth2_as_a_server","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","public":"View public information.","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","data_exports.read":"View and download data export files in your program."}}}}],"scopes":["content.read"]}],"responseCodes":["200","400","401","404"],"pointer":"/v2/content","href":"content-publishing/listcontent","openApiOperationId":"listContent","summary":"Fetch a collection of content","securityGroups":[{"oauth2_as_a_user":["content.read"]},{"oauth2_as_a_server":["content.read"]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://partner.socialchorus.com","description":"US1"},{"url":"https://partner.us2.onfirstup.com","description":"US2"},{"url":"https://partner.onfirstup.eu","description":"EU"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_117"}},"schemaId":"schema_117"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}},"schemaId":"schema_101"},{"code":"401","description":"Unauthenticated","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}},"schemaId":"schema_101"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}},"schemaId":"schema_101"}],"pointer":"/paths/~1v2~1content/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_117","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_117"}}},{"code":"400","schemaId":"schema_101","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}}},{"code":"401","schemaId":"schema_101","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}}},{"code":"404","schemaId":"schema_101","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/content-publishing/listcontent"}],"panels":[]}]},"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.  Response body data will be the newly created record. Resources  Knowledge Base article on Campaigns An overview on Content & Publishing API Pagination Filtering Add an image Publish drafted content  "}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createContent","name":"Create a new content post","isWebhook":false,"pointer":"/paths/~1v2~1content/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a new content post","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create a new content item and select what topics will include the content. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"admonition","inline":true,"attributes":{"type":"info"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The new content will be created in the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"“draft”"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" state. "},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" 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. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Response body data will be the newly created record."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Resources"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"ul","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://support.firstup.io/hc/en-us/articles/1500007952761-Create-a-New-Campaign"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Knowledge Base article on Campaigns"},"children":[]}]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"/contentandpublishing/contentoverview"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An overview on Content & Publishing API"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"/gettingstarted/pagination"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pagination"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"/gettingstarted/filtering"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filtering"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"/endpoints/openapi/content-publishing/addcontentimage"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Add an image"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"/endpoints/openapi/content-publishing/publishcontent"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Publish drafted content"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2_as_a_user","scopes":["content.write"],"type":"oauth2","description":"OAuth2 for Users (Authorization Code grant flow)","flows":{"authorizationCode":{"authorizationUrl":"IAM_DOMAIN/oauth/authorize","tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","openid":"Authenticate your account using OpenID.","public":"View public information.","feeds.read":"View your feeds.","feeds.rendered.read":"View rendered content from feed posts.","feeds.engage":"View your feeds and engage with posts (likes, bookmarks, etc).","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","assistant.inbox.read":"View and list details of your assistant inbox items.","notification_center":"View and list notification center items.","data_exports.read":"View and download data export files in your program."}}}}]},{"schemes":[{"name":"oauth2_as_a_server","scopes":["content.write"],"type":"oauth2","description":"OAuth2 for Server-to-Server (Client Credentials grant flow)","flows":{"clientCredentials":{"tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","public":"View public information.","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","data_exports.read":"View and download data export files in your program."}}}}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_118"}},"schemaId":"schema_118","pointer":"/paths/~1v2~1content/post/requestBody","description":"Attributes of the content to create."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/content","servers":[{"url":"https://partner.socialchorus.com","description":"US1"},{"url":"https://partner.us2.onfirstup.com","description":"US2"},{"url":"https://partner.onfirstup.eu","description":"EU"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2_as_a_user","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"IAM_DOMAIN/oauth/authorize","tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","openid":"Authenticate your account using OpenID.","public":"View public information.","feeds.read":"View your feeds.","feeds.rendered.read":"View rendered content from feed posts.","feeds.engage":"View your feeds and engage with posts (likes, bookmarks, etc).","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","assistant.inbox.read":"View and list details of your assistant inbox items.","notification_center":"View and list notification center items.","data_exports.read":"View and download data export files in your program."}}}}],"scopes":["content.write"]},{"schemes":[{"id":"oauth2_as_a_server","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","public":"View public information.","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","data_exports.read":"View and download data export files in your program."}}}}],"scopes":["content.write"]}],"requestBody":{"application/json":{"schemaId":"schema_118"}},"responseCodes":["201","400","401","403","422"],"pointer":"/v2/content","href":"content-publishing/createcontent","openApiOperationId":"createContent","summary":"Create a new content post","securityGroups":[{"oauth2_as_a_user":["content.write"]},{"oauth2_as_a_server":["content.write"]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://partner.socialchorus.com","description":"US1"},{"url":"https://partner.us2.onfirstup.com","description":"US2"},{"url":"https://partner.onfirstup.eu","description":"EU"}],"schemaId":"schema_118","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_118"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Content Created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_119"}},"schemaId":"schema_119"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}},"schemaId":"schema_101"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthenticated. See more on error responses "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://developers.firstup.io/gettingstarted/error_responses"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_120"}},"schemaId":"schema_120"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized. See more on error responses "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://developers.firstup.io/gettingstarted/error_responses"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_121"}},"schemaId":"schema_121"},{"code":"422","description":"Validation Failed"}],"pointer":"/paths/~1v2~1content/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_119","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_119"}}},{"code":"400","schemaId":"schema_101","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}}},{"code":"401","schemaId":"schema_120","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_120"}}},{"code":"403","schemaId":"schema_121","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_121"}}},{"code":"422"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/content-publishing/createcontent"}],"panels":[]}]},"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"detailContent","name":"Fetch the details of a content post","isWebhook":false,"pointer":"/paths/~1v2~1content~1{content_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetch the details of a content post","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"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."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2_as_a_user","scopes":["content.read"],"type":"oauth2","description":"OAuth2 for Users (Authorization Code grant flow)","flows":{"authorizationCode":{"authorizationUrl":"IAM_DOMAIN/oauth/authorize","tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","openid":"Authenticate your account using OpenID.","public":"View public information.","feeds.read":"View your feeds.","feeds.rendered.read":"View rendered content from feed posts.","feeds.engage":"View your feeds and engage with posts (likes, bookmarks, etc).","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","assistant.inbox.read":"View and list details of your assistant inbox items.","notification_center":"View and list notification center items.","data_exports.read":"View and download data export files in your program."}}}}]},{"schemes":[{"name":"oauth2_as_a_server","scopes":["content.read"],"type":"oauth2","description":"OAuth2 for Server-to-Server (Client Credentials grant flow)","flows":{"clientCredentials":{"tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","public":"View public information.","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","data_exports.read":"View and download data export files in your program."}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"content_id","in":"path","schemaId":"schema_106","description":"ID of the detailed content post","required":true}],"pointer":"/paths/~1v2~1content~1{content_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"replace_image_blocks","in":"query","schemaId":"schema_122","description":"Replace image blocks object with image URLs"}],"pointer":"/paths/~1v2~1content~1{content_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/content/{content_id}","servers":[{"url":"https://partner.socialchorus.com","description":"US1"},{"url":"https://partner.us2.onfirstup.com","description":"US2"},{"url":"https://partner.onfirstup.eu","description":"EU"}],"parameters":{"path":[{"name":"content_id","in":"path","required":true,"schemaId":"schema_106"}],"query":[{"name":"replace_image_blocks","in":"query","required":false,"schemaId":"schema_122"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2_as_a_user","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"IAM_DOMAIN/oauth/authorize","tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","openid":"Authenticate your account using OpenID.","public":"View public information.","feeds.read":"View your feeds.","feeds.rendered.read":"View rendered content from feed posts.","feeds.engage":"View your feeds and engage with posts (likes, bookmarks, etc).","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","assistant.inbox.read":"View and list details of your assistant inbox items.","notification_center":"View and list notification center items.","data_exports.read":"View and download data export files in your program."}}}}],"scopes":["content.read"]},{"schemes":[{"id":"oauth2_as_a_server","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","public":"View public information.","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","data_exports.read":"View and download data export files in your program."}}}}],"scopes":["content.read"]}],"responseCodes":["200","400","401","404"],"pointer":"/v2/content/{content_id}","href":"content-publishing/detailcontent","openApiOperationId":"detailContent","summary":"Fetch the details of a content post","securityGroups":[{"oauth2_as_a_user":["content.read"]},{"oauth2_as_a_server":["content.read"]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://partner.socialchorus.com","description":"US1"},{"url":"https://partner.us2.onfirstup.com","description":"US2"},{"url":"https://partner.onfirstup.eu","description":"EU"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_123"}},"schemaId":"schema_123"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}},"schemaId":"schema_101"},{"code":"401","description":"Unauthenticated","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}},"schemaId":"schema_101"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}},"schemaId":"schema_101"}],"pointer":"/paths/~1v2~1content~1{content_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_123","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_123"}}},{"code":"400","schemaId":"schema_101","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}}},{"code":"401","schemaId":"schema_101","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}}},{"code":"404","schemaId":"schema_101","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/content-publishing/detailcontent"}],"panels":[]}]},"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.  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.  To change the state (i.e. publish a draft) see  Publish an existing content post. Response body data will be the updated record."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateContent","name":"Update an existing content post","isWebhook":false,"pointer":"/paths/~1v2~1content~1{content_id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update an existing content post","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"admonition","inline":true,"attributes":{"type":"info"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" To change the state (i.e. publish a draft) see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"/endpoints/openapi/content-publishing/publishcontent"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Publish an existing content post."},"children":[]}]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Response body data will be the updated record."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2_as_a_user","scopes":["content.write"],"type":"oauth2","description":"OAuth2 for Users (Authorization Code grant flow)","flows":{"authorizationCode":{"authorizationUrl":"IAM_DOMAIN/oauth/authorize","tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","openid":"Authenticate your account using OpenID.","public":"View public information.","feeds.read":"View your feeds.","feeds.rendered.read":"View rendered content from feed posts.","feeds.engage":"View your feeds and engage with posts (likes, bookmarks, etc).","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","assistant.inbox.read":"View and list details of your assistant inbox items.","notification_center":"View and list notification center items.","data_exports.read":"View and download data export files in your program."}}}}]},{"schemes":[{"name":"oauth2_as_a_server","scopes":["content.write"],"type":"oauth2","description":"OAuth2 for Server-to-Server (Client Credentials grant flow)","flows":{"clientCredentials":{"tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","public":"View public information.","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","data_exports.read":"View and download data export files in your program."}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"content_id","in":"path","schemaId":"schema_106","description":"ID or UUID of the content post","required":true}],"pointer":"/paths/~1v2~1content~1{content_id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_124"}},"schemaId":"schema_124","pointer":"/paths/~1v2~1content~1{content_id}/put/requestBody","description":"Attributes of the content to update."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v2/content/{content_id}","servers":[{"url":"https://partner.socialchorus.com","description":"US1"},{"url":"https://partner.us2.onfirstup.com","description":"US2"},{"url":"https://partner.onfirstup.eu","description":"EU"}],"parameters":{"path":[{"name":"content_id","in":"path","required":true,"schemaId":"schema_106"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2_as_a_user","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"IAM_DOMAIN/oauth/authorize","tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","openid":"Authenticate your account using OpenID.","public":"View public information.","feeds.read":"View your feeds.","feeds.rendered.read":"View rendered content from feed posts.","feeds.engage":"View your feeds and engage with posts (likes, bookmarks, etc).","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","assistant.inbox.read":"View and list details of your assistant inbox items.","notification_center":"View and list notification center items.","data_exports.read":"View and download data export files in your program."}}}}],"scopes":["content.write"]},{"schemes":[{"id":"oauth2_as_a_server","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","public":"View public information.","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","data_exports.read":"View and download data export files in your program."}}}}],"scopes":["content.write"]}],"requestBody":{"application/json":{"schemaId":"schema_124"}},"responseCodes":["200","400","401","403","422"],"pointer":"/v2/content/{content_id}","href":"content-publishing/updatecontent","openApiOperationId":"updateContent","summary":"Update an existing content post","securityGroups":[{"oauth2_as_a_user":["content.write"]},{"oauth2_as_a_server":["content.write"]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://partner.socialchorus.com","description":"US1"},{"url":"https://partner.us2.onfirstup.com","description":"US2"},{"url":"https://partner.onfirstup.eu","description":"EU"}],"schemaId":"schema_124","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_124"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Content Updated","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_125"}},"schemaId":"schema_125"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}},"schemaId":"schema_101"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthenticated. See more on error responses "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://developers.firstup.io/gettingstarted/error_responses"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_120"}},"schemaId":"schema_120"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized. See more on error responses "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://developers.firstup.io/gettingstarted/error_responses"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_121"}},"schemaId":"schema_121"},{"code":"422","description":"Validation Failed"}],"pointer":"/paths/~1v2~1content~1{content_id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_125","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_125"}}},{"code":"400","schemaId":"schema_101","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}}},{"code":"401","schemaId":"schema_120","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_120"}}},{"code":"403","schemaId":"schema_121","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_121"}}},{"code":"422"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/content-publishing/updatecontent"}],"panels":[]}]},"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\".  Response body contains the latest version of the content record."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"archiveContent","name":"Archive an existing content post","isWebhook":false,"pointer":"/paths/~1v2~1content~1{content_id}~1archive/put","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Archive an existing content post","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Archive an existing content post. Transition the content state from any state directly to \"archived\". "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Response body contains the latest version of the content record."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2_as_a_user","scopes":["content.write"],"type":"oauth2","description":"OAuth2 for Users (Authorization Code grant flow)","flows":{"authorizationCode":{"authorizationUrl":"IAM_DOMAIN/oauth/authorize","tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","openid":"Authenticate your account using OpenID.","public":"View public information.","feeds.read":"View your feeds.","feeds.rendered.read":"View rendered content from feed posts.","feeds.engage":"View your feeds and engage with posts (likes, bookmarks, etc).","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","assistant.inbox.read":"View and list details of your assistant inbox items.","notification_center":"View and list notification center items.","data_exports.read":"View and download data export files in your program."}}}}]},{"schemes":[{"name":"oauth2_as_a_server","scopes":["content.write"],"type":"oauth2","description":"OAuth2 for Server-to-Server (Client Credentials grant flow)","flows":{"clientCredentials":{"tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","public":"View public information.","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","data_exports.read":"View and download data export files in your program."}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"content_id","in":"path","schemaId":"schema_106","description":"ID or UUID of the content post","required":true}],"pointer":"/paths/~1v2~1content~1{content_id}~1archive/put/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v2/content/{content_id}/archive","servers":[{"url":"https://partner.socialchorus.com","description":"US1"},{"url":"https://partner.us2.onfirstup.com","description":"US2"},{"url":"https://partner.onfirstup.eu","description":"EU"}],"parameters":{"path":[{"name":"content_id","in":"path","required":true,"schemaId":"schema_106"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2_as_a_user","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"IAM_DOMAIN/oauth/authorize","tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","openid":"Authenticate your account using OpenID.","public":"View public information.","feeds.read":"View your feeds.","feeds.rendered.read":"View rendered content from feed posts.","feeds.engage":"View your feeds and engage with posts (likes, bookmarks, etc).","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","assistant.inbox.read":"View and list details of your assistant inbox items.","notification_center":"View and list notification center items.","data_exports.read":"View and download data export files in your program."}}}}],"scopes":["content.write"]},{"schemes":[{"id":"oauth2_as_a_server","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","public":"View public information.","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","data_exports.read":"View and download data export files in your program."}}}}],"scopes":["content.write"]}],"responseCodes":["200","400","401","403","404"],"pointer":"/v2/content/{content_id}/archive","href":"content-publishing/archivecontent","openApiOperationId":"archiveContent","summary":"Archive an existing content post","securityGroups":[{"oauth2_as_a_user":["content.write"]},{"oauth2_as_a_server":["content.write"]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://partner.socialchorus.com","description":"US1"},{"url":"https://partner.us2.onfirstup.com","description":"US2"},{"url":"https://partner.onfirstup.eu","description":"EU"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Content Archived","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_126"}},"schemaId":"schema_126"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}},"schemaId":"schema_101"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthenticated. See more on error responses "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://developers.firstup.io/gettingstarted/error_responses"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_120"}},"schemaId":"schema_120"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized. See more on error responses "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://developers.firstup.io/gettingstarted/error_responses"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_121"}},"schemaId":"schema_121"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}},"schemaId":"schema_101"}],"pointer":"/paths/~1v2~1content~1{content_id}~1archive/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_126","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_126"}}},{"code":"400","schemaId":"schema_101","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}}},{"code":"401","schemaId":"schema_120","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_120"}}},{"code":"403","schemaId":"schema_121","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_121"}}},{"code":"404","schemaId":"schema_101","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/content-publishing/archivecontent"}],"panels":[]}]},"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.  Response body is the updated record. Returns 400 Bad Request if the content cannot be transitioned to 'draft' due to validation reasons."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"draftContent","name":"Draft an existing content post","isWebhook":false,"pointer":"/paths/~1v2~1content~1{content_id}~1draft/put","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Draft an existing content post","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Response body is the updated record. Returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"400 Bad Request"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the content cannot be transitioned to 'draft' due to validation reasons."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2_as_a_user","scopes":["content.write"],"type":"oauth2","description":"OAuth2 for Users (Authorization Code grant flow)","flows":{"authorizationCode":{"authorizationUrl":"IAM_DOMAIN/oauth/authorize","tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","openid":"Authenticate your account using OpenID.","public":"View public information.","feeds.read":"View your feeds.","feeds.rendered.read":"View rendered content from feed posts.","feeds.engage":"View your feeds and engage with posts (likes, bookmarks, etc).","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","assistant.inbox.read":"View and list details of your assistant inbox items.","notification_center":"View and list notification center items.","data_exports.read":"View and download data export files in your program."}}}}]},{"schemes":[{"name":"oauth2_as_a_server","scopes":["content.write"],"type":"oauth2","description":"OAuth2 for Server-to-Server (Client Credentials grant flow)","flows":{"clientCredentials":{"tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","public":"View public information.","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","data_exports.read":"View and download data export files in your program."}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"content_id","in":"path","schemaId":"schema_106","description":"ID or UUID of the content post","required":true}],"pointer":"/paths/~1v2~1content~1{content_id}~1draft/put/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v2/content/{content_id}/draft","servers":[{"url":"https://partner.socialchorus.com","description":"US1"},{"url":"https://partner.us2.onfirstup.com","description":"US2"},{"url":"https://partner.onfirstup.eu","description":"EU"}],"parameters":{"path":[{"name":"content_id","in":"path","required":true,"schemaId":"schema_106"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2_as_a_user","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"IAM_DOMAIN/oauth/authorize","tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","openid":"Authenticate your account using OpenID.","public":"View public information.","feeds.read":"View your feeds.","feeds.rendered.read":"View rendered content from feed posts.","feeds.engage":"View your feeds and engage with posts (likes, bookmarks, etc).","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","assistant.inbox.read":"View and list details of your assistant inbox items.","notification_center":"View and list notification center items.","data_exports.read":"View and download data export files in your program."}}}}],"scopes":["content.write"]},{"schemes":[{"id":"oauth2_as_a_server","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","public":"View public information.","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","data_exports.read":"View and download data export files in your program."}}}}],"scopes":["content.write"]}],"responseCodes":["200","400","401","403","404"],"pointer":"/v2/content/{content_id}/draft","href":"content-publishing/draftcontent","openApiOperationId":"draftContent","summary":"Draft an existing content post","securityGroups":[{"oauth2_as_a_user":["content.write"]},{"oauth2_as_a_server":["content.write"]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://partner.socialchorus.com","description":"US1"},{"url":"https://partner.us2.onfirstup.com","description":"US2"},{"url":"https://partner.onfirstup.eu","description":"EU"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Content Drafted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_126"}},"schemaId":"schema_126"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}},"schemaId":"schema_101"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthenticated. See more on error responses "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://developers.firstup.io/gettingstarted/error_responses"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_120"}},"schemaId":"schema_120"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized. See more on error responses "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://developers.firstup.io/gettingstarted/error_responses"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_121"}},"schemaId":"schema_121"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}},"schemaId":"schema_101"}],"pointer":"/paths/~1v2~1content~1{content_id}~1draft/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_126","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_126"}}},{"code":"400","schemaId":"schema_101","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}}},{"code":"401","schemaId":"schema_120","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_120"}}},{"code":"403","schemaId":"schema_121","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_121"}}},{"code":"404","schemaId":"schema_101","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/content-publishing/draftcontent"}],"panels":[]}]},"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.  Publishing content requires that at least one topic be associated to the content, as content must always have at least one topic.  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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"publishContent","name":"Publish an existing content post","isWebhook":false,"pointer":"/paths/~1v2~1content~1{content_id}~1publish/put","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Publish an existing content post","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Publishing content requires that at least one topic be associated to the content, as content must always have at least one topic. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Response body is the updated record. This endpoint returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"400 Bad Request"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" 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."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2_as_a_user","scopes":["content.write"],"type":"oauth2","description":"OAuth2 for Users (Authorization Code grant flow)","flows":{"authorizationCode":{"authorizationUrl":"IAM_DOMAIN/oauth/authorize","tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","openid":"Authenticate your account using OpenID.","public":"View public information.","feeds.read":"View your feeds.","feeds.rendered.read":"View rendered content from feed posts.","feeds.engage":"View your feeds and engage with posts (likes, bookmarks, etc).","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","assistant.inbox.read":"View and list details of your assistant inbox items.","notification_center":"View and list notification center items.","data_exports.read":"View and download data export files in your program."}}}}]},{"schemes":[{"name":"oauth2_as_a_server","scopes":["content.write"],"type":"oauth2","description":"OAuth2 for Server-to-Server (Client Credentials grant flow)","flows":{"clientCredentials":{"tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","public":"View public information.","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","data_exports.read":"View and download data export files in your program."}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"content_id","in":"path","schemaId":"schema_106","description":"ID or UUID of the content post","required":true}],"pointer":"/paths/~1v2~1content~1{content_id}~1publish/put/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v2/content/{content_id}/publish","servers":[{"url":"https://partner.socialchorus.com","description":"US1"},{"url":"https://partner.us2.onfirstup.com","description":"US2"},{"url":"https://partner.onfirstup.eu","description":"EU"}],"parameters":{"path":[{"name":"content_id","in":"path","required":true,"schemaId":"schema_106"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2_as_a_user","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"IAM_DOMAIN/oauth/authorize","tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","openid":"Authenticate your account using OpenID.","public":"View public information.","feeds.read":"View your feeds.","feeds.rendered.read":"View rendered content from feed posts.","feeds.engage":"View your feeds and engage with posts (likes, bookmarks, etc).","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","assistant.inbox.read":"View and list details of your assistant inbox items.","notification_center":"View and list notification center items.","data_exports.read":"View and download data export files in your program."}}}}],"scopes":["content.write"]},{"schemes":[{"id":"oauth2_as_a_server","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","public":"View public information.","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","data_exports.read":"View and download data export files in your program."}}}}],"scopes":["content.write"]}],"responseCodes":["200","400","401","403","404"],"pointer":"/v2/content/{content_id}/publish","href":"content-publishing/publishcontent","openApiOperationId":"publishContent","summary":"Publish an existing content post","securityGroups":[{"oauth2_as_a_user":["content.write"]},{"oauth2_as_a_server":["content.write"]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://partner.socialchorus.com","description":"US1"},{"url":"https://partner.us2.onfirstup.com","description":"US2"},{"url":"https://partner.onfirstup.eu","description":"EU"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Content Published","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_126"}},"schemaId":"schema_126"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}},"schemaId":"schema_101"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthenticated. See more on error responses "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://developers.firstup.io/gettingstarted/error_responses"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_120"}},"schemaId":"schema_120"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized. See more on error responses "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://developers.firstup.io/gettingstarted/error_responses"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_121"}},"schemaId":"schema_121"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}},"schemaId":"schema_101"}],"pointer":"/paths/~1v2~1content~1{content_id}~1publish/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_126","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_126"}}},{"code":"400","schemaId":"schema_101","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}}},{"code":"401","schemaId":"schema_120","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_120"}}},{"code":"403","schemaId":"schema_121","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_121"}}},{"code":"404","schemaId":"schema_101","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/content-publishing/publishcontent"}],"panels":[]}]},"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"reviewContent","name":"Mark an existing post as ready for review","isWebhook":false,"pointer":"/paths/~1v2~1content~1{content_id}~1review/put","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Mark an existing post as ready for review","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"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.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2_as_a_user","scopes":["content.write"],"type":"oauth2","description":"OAuth2 for Users (Authorization Code grant flow)","flows":{"authorizationCode":{"authorizationUrl":"IAM_DOMAIN/oauth/authorize","tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","openid":"Authenticate your account using OpenID.","public":"View public information.","feeds.read":"View your feeds.","feeds.rendered.read":"View rendered content from feed posts.","feeds.engage":"View your feeds and engage with posts (likes, bookmarks, etc).","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","assistant.inbox.read":"View and list details of your assistant inbox items.","notification_center":"View and list notification center items.","data_exports.read":"View and download data export files in your program."}}}}]},{"schemes":[{"name":"oauth2_as_a_server","scopes":["content.write"],"type":"oauth2","description":"OAuth2 for Server-to-Server (Client Credentials grant flow)","flows":{"clientCredentials":{"tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","public":"View public information.","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","data_exports.read":"View and download data export files in your program."}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"content_id","in":"path","schemaId":"schema_106","description":"ID or UUID of the content post","required":true}],"pointer":"/paths/~1v2~1content~1{content_id}~1review/put/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v2/content/{content_id}/review","servers":[{"url":"https://partner.socialchorus.com","description":"US1"},{"url":"https://partner.us2.onfirstup.com","description":"US2"},{"url":"https://partner.onfirstup.eu","description":"EU"}],"parameters":{"path":[{"name":"content_id","in":"path","required":true,"schemaId":"schema_106"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2_as_a_user","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"IAM_DOMAIN/oauth/authorize","tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","openid":"Authenticate your account using OpenID.","public":"View public information.","feeds.read":"View your feeds.","feeds.rendered.read":"View rendered content from feed posts.","feeds.engage":"View your feeds and engage with posts (likes, bookmarks, etc).","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","assistant.inbox.read":"View and list details of your assistant inbox items.","notification_center":"View and list notification center items.","data_exports.read":"View and download data export files in your program."}}}}],"scopes":["content.write"]},{"schemes":[{"id":"oauth2_as_a_server","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","public":"View public information.","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","data_exports.read":"View and download data export files in your program."}}}}],"scopes":["content.write"]}],"responseCodes":["200","400","401","403","404"],"pointer":"/v2/content/{content_id}/review","href":"content-publishing/reviewcontent","openApiOperationId":"reviewContent","summary":"Mark an existing post as ready for review","securityGroups":[{"oauth2_as_a_user":["content.write"]},{"oauth2_as_a_server":["content.write"]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://partner.socialchorus.com","description":"US1"},{"url":"https://partner.us2.onfirstup.com","description":"US2"},{"url":"https://partner.onfirstup.eu","description":"EU"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Content Moved to Review State","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_126"}},"schemaId":"schema_126"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}},"schemaId":"schema_101"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthenticated. See more on error responses "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://developers.firstup.io/gettingstarted/error_responses"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_120"}},"schemaId":"schema_120"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized. See more on error responses "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://developers.firstup.io/gettingstarted/error_responses"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_121"}},"schemaId":"schema_121"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}},"schemaId":"schema_101"}],"pointer":"/paths/~1v2~1content~1{content_id}~1review/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_126","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_126"}}},{"code":"400","schemaId":"schema_101","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}}},{"code":"401","schemaId":"schema_120","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_120"}}},{"code":"403","schemaId":"schema_121","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_121"}}},{"code":"404","schemaId":"schema_101","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/content-publishing/reviewcontent"}],"panels":[]}]},"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. 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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listContentComments","name":"List the comments on a content post","isWebhook":false,"pointer":"/paths/~1v2~1content~1{content_id}~1comments/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List the comments on a content post","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When a comment with user mentions is returned, it will be returned with those mentions in the format of either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{ref:user:<user_id>}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{ref:user::id:<user_id>}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". 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."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2_as_a_user","scopes":["content.read"],"type":"oauth2","description":"OAuth2 for Users (Authorization Code grant flow)","flows":{"authorizationCode":{"authorizationUrl":"IAM_DOMAIN/oauth/authorize","tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","openid":"Authenticate your account using OpenID.","public":"View public information.","feeds.read":"View your feeds.","feeds.rendered.read":"View rendered content from feed posts.","feeds.engage":"View your feeds and engage with posts (likes, bookmarks, etc).","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","assistant.inbox.read":"View and list details of your assistant inbox items.","notification_center":"View and list notification center items.","data_exports.read":"View and download data export files in your program."}}}}]},{"schemes":[{"name":"oauth2_as_a_server","scopes":["content.read"],"type":"oauth2","description":"OAuth2 for Server-to-Server (Client Credentials grant flow)","flows":{"clientCredentials":{"tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","public":"View public information.","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","data_exports.read":"View and download data export files in your program."}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"content_id","in":"path","schemaId":"schema_106","description":"ID or UUID of the content post","required":true}],"pointer":"/paths/~1v2~1content~1{content_id}~1comments/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/content/{content_id}/comments","servers":[{"url":"https://partner.socialchorus.com","description":"US1"},{"url":"https://partner.us2.onfirstup.com","description":"US2"},{"url":"https://partner.onfirstup.eu","description":"EU"}],"parameters":{"path":[{"name":"content_id","in":"path","required":true,"schemaId":"schema_106"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2_as_a_user","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"IAM_DOMAIN/oauth/authorize","tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","openid":"Authenticate your account using OpenID.","public":"View public information.","feeds.read":"View your feeds.","feeds.rendered.read":"View rendered content from feed posts.","feeds.engage":"View your feeds and engage with posts (likes, bookmarks, etc).","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","assistant.inbox.read":"View and list details of your assistant inbox items.","notification_center":"View and list notification center items.","data_exports.read":"View and download data export files in your program."}}}}],"scopes":["content.read"]},{"schemes":[{"id":"oauth2_as_a_server","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","public":"View public information.","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","data_exports.read":"View and download data export files in your program."}}}}],"scopes":["content.read"]}],"responseCodes":["200","400","401","403"],"pointer":"/v2/content/{content_id}/comments","href":"content-publishing/listcontentcomments","openApiOperationId":"listContentComments","summary":"List the comments on a content post","securityGroups":[{"oauth2_as_a_user":["content.read"]},{"oauth2_as_a_server":["content.read"]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://partner.socialchorus.com","description":"US1"},{"url":"https://partner.us2.onfirstup.com","description":"US2"},{"url":"https://partner.onfirstup.eu","description":"EU"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_127"}},"schemaId":"schema_127"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}},"schemaId":"schema_101"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthenticated. See more on error responses "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://developers.firstup.io/gettingstarted/error_responses"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_120"}},"schemaId":"schema_120"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized. See more on error responses "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://developers.firstup.io/gettingstarted/error_responses"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_121"}},"schemaId":"schema_121"}],"pointer":"/paths/~1v2~1content~1{content_id}~1comments/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_127","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_127"}}},{"code":"400","schemaId":"schema_101","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}}},{"code":"401","schemaId":"schema_120","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_120"}}},{"code":"403","schemaId":"schema_121","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_121"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/content-publishing/listcontentcomments"}],"panels":[]}]},"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. 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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listContentCommentReplies","name":"List the replies on comment post","isWebhook":false,"pointer":"/paths/~1v2~1content~1{content_id}~1comments~1{comment_id}~1replies/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List the replies on comment post","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List the replies on comment post. Upon enabling expanded reactions types, the response will include the additional reaction types. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When a comment with user mentions is returned, it will be returned with those mentions in the format of either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{ref:user:<user_id>}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{ref:user::id:<user_id>}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". 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."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2_as_a_user","scopes":["content.read"],"type":"oauth2","description":"OAuth2 for Users (Authorization Code grant flow)","flows":{"authorizationCode":{"authorizationUrl":"IAM_DOMAIN/oauth/authorize","tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","openid":"Authenticate your account using OpenID.","public":"View public information.","feeds.read":"View your feeds.","feeds.rendered.read":"View rendered content from feed posts.","feeds.engage":"View your feeds and engage with posts (likes, bookmarks, etc).","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","assistant.inbox.read":"View and list details of your assistant inbox items.","notification_center":"View and list notification center items.","data_exports.read":"View and download data export files in your program."}}}}]},{"schemes":[{"name":"oauth2_as_a_server","scopes":["content.read"],"type":"oauth2","description":"OAuth2 for Server-to-Server (Client Credentials grant flow)","flows":{"clientCredentials":{"tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","public":"View public information.","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","data_exports.read":"View and download data export files in your program."}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"content_id","in":"path","schemaId":"schema_106","description":"ID or UUID of the content post","required":true},{"name":"comment_id","in":"path","schemaId":"schema_128","description":"ID or UUID of the comment thread","required":true}],"pointer":"/paths/~1v2~1content~1{content_id}~1comments~1{comment_id}~1replies/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/content/{content_id}/comments/{comment_id}/replies","servers":[{"url":"https://partner.socialchorus.com","description":"US1"},{"url":"https://partner.us2.onfirstup.com","description":"US2"},{"url":"https://partner.onfirstup.eu","description":"EU"}],"parameters":{"path":[{"name":"content_id","in":"path","required":true,"schemaId":"schema_106"},{"name":"comment_id","in":"path","required":true,"schemaId":"schema_128"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2_as_a_user","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"IAM_DOMAIN/oauth/authorize","tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","openid":"Authenticate your account using OpenID.","public":"View public information.","feeds.read":"View your feeds.","feeds.rendered.read":"View rendered content from feed posts.","feeds.engage":"View your feeds and engage with posts (likes, bookmarks, etc).","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","assistant.inbox.read":"View and list details of your assistant inbox items.","notification_center":"View and list notification center items.","data_exports.read":"View and download data export files in your program."}}}}],"scopes":["content.read"]},{"schemes":[{"id":"oauth2_as_a_server","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","public":"View public information.","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","data_exports.read":"View and download data export files in your program."}}}}],"scopes":["content.read"]}],"responseCodes":["200","400","401","403"],"pointer":"/v2/content/{content_id}/comments/{comment_id}/replies","href":"content-publishing/listcontentcommentreplies","openApiOperationId":"listContentCommentReplies","summary":"List the replies on comment post","securityGroups":[{"oauth2_as_a_user":["content.read"]},{"oauth2_as_a_server":["content.read"]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://partner.socialchorus.com","description":"US1"},{"url":"https://partner.us2.onfirstup.com","description":"US2"},{"url":"https://partner.onfirstup.eu","description":"EU"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_127"}},"schemaId":"schema_127"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}},"schemaId":"schema_101"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthenticated. See more on error responses "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://developers.firstup.io/gettingstarted/error_responses"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_120"}},"schemaId":"schema_120"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized. See more on error responses "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://developers.firstup.io/gettingstarted/error_responses"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_121"}},"schemaId":"schema_121"}],"pointer":"/paths/~1v2~1content~1{content_id}~1comments~1{comment_id}~1replies/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_127","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_127"}}},{"code":"400","schemaId":"schema_101","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}}},{"code":"401","schemaId":"schema_120","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_120"}}},{"code":"403","schemaId":"schema_121","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_121"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/content-publishing/listcontentcommentreplies"}],"panels":[]}]},"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"addContentImage","name":"Add an image to a content post","isWebhook":false,"pointer":"/paths/~1v2~1content~1{content_id}~1images/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Add an image to a content post","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Add a new image to a content record. Response body is the updated content record. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"admonition","inline":true,"attributes":{"type":"info"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This API does not resize or rehost images. Images should be appropriately sized and will be served from the provided URL."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2_as_a_user","scopes":["content.write"],"type":"oauth2","description":"OAuth2 for Users (Authorization Code grant flow)","flows":{"authorizationCode":{"authorizationUrl":"IAM_DOMAIN/oauth/authorize","tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","openid":"Authenticate your account using OpenID.","public":"View public information.","feeds.read":"View your feeds.","feeds.rendered.read":"View rendered content from feed posts.","feeds.engage":"View your feeds and engage with posts (likes, bookmarks, etc).","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","assistant.inbox.read":"View and list details of your assistant inbox items.","notification_center":"View and list notification center items.","data_exports.read":"View and download data export files in your program."}}}}]},{"schemes":[{"name":"oauth2_as_a_server","scopes":["content.write"],"type":"oauth2","description":"OAuth2 for Server-to-Server (Client Credentials grant flow)","flows":{"clientCredentials":{"tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","public":"View public information.","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","data_exports.read":"View and download data export files in your program."}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"content_id","in":"path","schemaId":"schema_106","description":"ID or UUID of the content post","required":true}],"pointer":"/paths/~1v2~1content~1{content_id}~1images/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_129"}},"schemaId":"schema_129","pointer":"/paths/~1v2~1content~1{content_id}~1images/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v2/content/{content_id}/images","servers":[{"url":"https://partner.socialchorus.com","description":"US1"},{"url":"https://partner.us2.onfirstup.com","description":"US2"},{"url":"https://partner.onfirstup.eu","description":"EU"}],"parameters":{"path":[{"name":"content_id","in":"path","required":true,"schemaId":"schema_106"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2_as_a_user","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"IAM_DOMAIN/oauth/authorize","tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","openid":"Authenticate your account using OpenID.","public":"View public information.","feeds.read":"View your feeds.","feeds.rendered.read":"View rendered content from feed posts.","feeds.engage":"View your feeds and engage with posts (likes, bookmarks, etc).","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","assistant.inbox.read":"View and list details of your assistant inbox items.","notification_center":"View and list notification center items.","data_exports.read":"View and download data export files in your program."}}}}],"scopes":["content.write"]},{"schemes":[{"id":"oauth2_as_a_server","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","public":"View public information.","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","data_exports.read":"View and download data export files in your program."}}}}],"scopes":["content.write"]}],"requestBody":{"application/json":{"schemaId":"schema_129"}},"responseCodes":["201","400","401","403"],"pointer":"/v2/content/{content_id}/images","href":"content-publishing/addcontentimage","openApiOperationId":"addContentImage","summary":"Add an image to a content post","securityGroups":[{"oauth2_as_a_user":["content.write"]},{"oauth2_as_a_server":["content.write"]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://partner.socialchorus.com","description":"US1"},{"url":"https://partner.us2.onfirstup.com","description":"US2"},{"url":"https://partner.onfirstup.eu","description":"EU"}],"schemaId":"schema_129","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_129"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Content Image Created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_130"}},"schemaId":"schema_130"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}},"schemaId":"schema_101"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthenticated. See more on error responses "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://developers.firstup.io/gettingstarted/error_responses"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_120"}},"schemaId":"schema_120"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized. See more on error responses "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://developers.firstup.io/gettingstarted/error_responses"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_121"}},"schemaId":"schema_121"}],"pointer":"/paths/~1v2~1content~1{content_id}~1images/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_130","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_130"}}},{"code":"400","schemaId":"schema_101","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}}},{"code":"401","schemaId":"schema_120","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_120"}}},{"code":"403","schemaId":"schema_121","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_121"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/content-publishing/addcontentimage"}],"panels":[]}]},"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 embed_html into the body of the article at the location you want the video to appear in the article."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"addContentVideo","name":"Add a video for use in content of type article","isWebhook":false,"pointer":"/paths/~1v2~1content~1{content_id}~1videos/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Add a video for use in content of type article","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Add a new video to a content record. Response body is the attributes of the video record. Insert the returned "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"embed_html"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" into the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"body"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the article at the location you want the video to appear in the article."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2_as_a_user","scopes":["content.write"],"type":"oauth2","description":"OAuth2 for Users (Authorization Code grant flow)","flows":{"authorizationCode":{"authorizationUrl":"IAM_DOMAIN/oauth/authorize","tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","openid":"Authenticate your account using OpenID.","public":"View public information.","feeds.read":"View your feeds.","feeds.rendered.read":"View rendered content from feed posts.","feeds.engage":"View your feeds and engage with posts (likes, bookmarks, etc).","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","assistant.inbox.read":"View and list details of your assistant inbox items.","notification_center":"View and list notification center items.","data_exports.read":"View and download data export files in your program."}}}}]},{"schemes":[{"name":"oauth2_as_a_server","scopes":["content.write"],"type":"oauth2","description":"OAuth2 for Server-to-Server (Client Credentials grant flow)","flows":{"clientCredentials":{"tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","public":"View public information.","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","data_exports.read":"View and download data export files in your program."}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"content_id","in":"path","schemaId":"schema_106","description":"ID or UUID of the content post","required":true}],"pointer":"/paths/~1v2~1content~1{content_id}~1videos/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_131"}},"schemaId":"schema_131","pointer":"/paths/~1v2~1content~1{content_id}~1videos/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v2/content/{content_id}/videos","servers":[{"url":"https://partner.socialchorus.com","description":"US1"},{"url":"https://partner.us2.onfirstup.com","description":"US2"},{"url":"https://partner.onfirstup.eu","description":"EU"}],"parameters":{"path":[{"name":"content_id","in":"path","required":true,"schemaId":"schema_106"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2_as_a_user","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"IAM_DOMAIN/oauth/authorize","tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","openid":"Authenticate your account using OpenID.","public":"View public information.","feeds.read":"View your feeds.","feeds.rendered.read":"View rendered content from feed posts.","feeds.engage":"View your feeds and engage with posts (likes, bookmarks, etc).","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","assistant.inbox.read":"View and list details of your assistant inbox items.","notification_center":"View and list notification center items.","data_exports.read":"View and download data export files in your program."}}}}],"scopes":["content.write"]},{"schemes":[{"id":"oauth2_as_a_server","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","public":"View public information.","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","data_exports.read":"View and download data export files in your program."}}}}],"scopes":["content.write"]}],"requestBody":{"application/json":{"schemaId":"schema_131"}},"responseCodes":["201","400","401","403"],"pointer":"/v2/content/{content_id}/videos","href":"content-publishing/addcontentvideo","openApiOperationId":"addContentVideo","summary":"Add a video for use in content of type article","securityGroups":[{"oauth2_as_a_user":["content.write"]},{"oauth2_as_a_server":["content.write"]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://partner.socialchorus.com","description":"US1"},{"url":"https://partner.us2.onfirstup.com","description":"US2"},{"url":"https://partner.onfirstup.eu","description":"EU"}],"schemaId":"schema_131","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_131"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Content Video Added","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_132"}},"schemaId":"schema_132"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}},"schemaId":"schema_101"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthenticated. See more on error responses "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://developers.firstup.io/gettingstarted/error_responses"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_120"}},"schemaId":"schema_120"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized. See more on error responses "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://developers.firstup.io/gettingstarted/error_responses"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_121"}},"schemaId":"schema_121"}],"pointer":"/paths/~1v2~1content~1{content_id}~1videos/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_132","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_132"}}},{"code":"400","schemaId":"schema_101","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}}},{"code":"401","schemaId":"schema_120","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_120"}}},{"code":"403","schemaId":"schema_121","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_121"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/content-publishing/addcontentvideo"}],"panels":[]}]},"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"removeContentImage","name":"Remove an image from a content post","isWebhook":false,"pointer":"/paths/~1v2~1content~1{content_id}~1images~1{content_image_id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Remove an image from a content post","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Remove an image from a content record. Images cannot be removed from published content. Response status for removed content is 204 No Content."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2_as_a_user","scopes":["content.write"],"type":"oauth2","description":"OAuth2 for Users (Authorization Code grant flow)","flows":{"authorizationCode":{"authorizationUrl":"IAM_DOMAIN/oauth/authorize","tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","openid":"Authenticate your account using OpenID.","public":"View public information.","feeds.read":"View your feeds.","feeds.rendered.read":"View rendered content from feed posts.","feeds.engage":"View your feeds and engage with posts (likes, bookmarks, etc).","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","assistant.inbox.read":"View and list details of your assistant inbox items.","notification_center":"View and list notification center items.","data_exports.read":"View and download data export files in your program."}}}}]},{"schemes":[{"name":"oauth2_as_a_server","scopes":["content.write"],"type":"oauth2","description":"OAuth2 for Server-to-Server (Client Credentials grant flow)","flows":{"clientCredentials":{"tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","public":"View public information.","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","data_exports.read":"View and download data export files in your program."}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"content_id","in":"path","schemaId":"schema_106","description":"ID or UUID of the content post","required":true},{"name":"content_image_id","in":"path","schemaId":"schema_106","description":"ID of the content image","required":true}],"pointer":"/paths/~1v2~1content~1{content_id}~1images~1{content_image_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v2/content/{content_id}/images/{content_image_id}","servers":[{"url":"https://partner.socialchorus.com","description":"US1"},{"url":"https://partner.us2.onfirstup.com","description":"US2"},{"url":"https://partner.onfirstup.eu","description":"EU"}],"parameters":{"path":[{"name":"content_id","in":"path","required":true,"schemaId":"schema_106"},{"name":"content_image_id","in":"path","required":true,"schemaId":"schema_106"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2_as_a_user","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"IAM_DOMAIN/oauth/authorize","tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","openid":"Authenticate your account using OpenID.","public":"View public information.","feeds.read":"View your feeds.","feeds.rendered.read":"View rendered content from feed posts.","feeds.engage":"View your feeds and engage with posts (likes, bookmarks, etc).","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","assistant.inbox.read":"View and list details of your assistant inbox items.","notification_center":"View and list notification center items.","data_exports.read":"View and download data export files in your program."}}}}],"scopes":["content.write"]},{"schemes":[{"id":"oauth2_as_a_server","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","public":"View public information.","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","data_exports.read":"View and download data export files in your program."}}}}],"scopes":["content.write"]}],"responseCodes":["204","400","401","403"],"pointer":"/v2/content/{content_id}/images/{content_image_id}","href":"content-publishing/removecontentimage","openApiOperationId":"removeContentImage","summary":"Remove an image from a content post","securityGroups":[{"oauth2_as_a_user":["content.write"]},{"oauth2_as_a_server":["content.write"]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://partner.socialchorus.com","description":"US1"},{"url":"https://partner.us2.onfirstup.com","description":"US2"},{"url":"https://partner.onfirstup.eu","description":"EU"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Success"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}},"schemaId":"schema_101"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthenticated. See more on error responses "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://developers.firstup.io/gettingstarted/error_responses"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_120"}},"schemaId":"schema_120"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized. See more on error responses "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://developers.firstup.io/gettingstarted/error_responses"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_121"}},"schemaId":"schema_121"}],"pointer":"/paths/~1v2~1content~1{content_id}~1images~1{content_image_id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"schema_101","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}}},{"code":"401","schemaId":"schema_120","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_120"}}},{"code":"403","schemaId":"schema_121","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_121"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/content-publishing/removecontentimage"}],"panels":[]}]},"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"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listContentReplications","name":"Fetch content replications","isWebhook":false,"pointer":"/paths/~1v2~1content~1replications/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetch content replications","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"The endpoint allow users to get details of content replication. Source or target filter is required"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2_as_a_user","scopes":["content.read","content.replication.audit"],"type":"oauth2","description":"OAuth2 for Users (Authorization Code grant flow)","flows":{"authorizationCode":{"authorizationUrl":"IAM_DOMAIN/oauth/authorize","tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","openid":"Authenticate your account using OpenID.","public":"View public information.","feeds.read":"View your feeds.","feeds.rendered.read":"View rendered content from feed posts.","feeds.engage":"View your feeds and engage with posts (likes, bookmarks, etc).","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","assistant.inbox.read":"View and list details of your assistant inbox items.","notification_center":"View and list notification center items.","data_exports.read":"View and download data export files in your program."}}}}]},{"schemes":[{"name":"oauth2_as_a_server","scopes":["content.read","content.replication.audit"],"type":"oauth2","description":"OAuth2 for Server-to-Server (Client Credentials grant flow)","flows":{"clientCredentials":{"tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","public":"View public information.","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","data_exports.read":"View and download data export files in your program."}}}}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"filter.source.contentId","in":"query","schemaId":"schema_106","description":"ID of source content. If present then source platform should also be present"},{"name":"filter.source.platform","in":"query","schemaId":"schema_133","description":"Source platform type. If present then source content ID should also be present"},{"name":"filter.target.contentId","in":"query","schemaId":"schema_115","description":"ID of published content. If present then target platform should also be present"},{"name":"filter.target.platform","in":"query","schemaId":"schema_133","description":"Target platform type. If present then target content ID should also be present"},{"name":"filter.workflowId","in":"query","schemaId":"schema_115","description":"ID of workflow"}],"pointer":"/paths/~1v2~1content~1replications/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/content/replications","servers":[{"url":"https://partner.socialchorus.com","description":"US1"},{"url":"https://partner.us2.onfirstup.com","description":"US2"},{"url":"https://partner.onfirstup.eu","description":"EU"}],"parameters":{"path":[],"query":[{"name":"filter.source.contentId","in":"query","schemaId":"schema_106"},{"name":"filter.source.platform","in":"query","schemaId":"schema_133"},{"name":"filter.target.contentId","in":"query","required":false,"schemaId":"schema_115"},{"name":"filter.target.platform","in":"query","required":false,"schemaId":"schema_133"},{"name":"filter.workflowId","in":"query","required":false,"schemaId":"schema_115"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2_as_a_user","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"IAM_DOMAIN/oauth/authorize","tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","openid":"Authenticate your account using OpenID.","public":"View public information.","feeds.read":"View your feeds.","feeds.rendered.read":"View rendered content from feed posts.","feeds.engage":"View your feeds and engage with posts (likes, bookmarks, etc).","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","assistant.inbox.read":"View and list details of your assistant inbox items.","notification_center":"View and list notification center items.","data_exports.read":"View and download data export files in your program."}}}}],"scopes":["content.read","content.replication.audit"]},{"schemes":[{"id":"oauth2_as_a_server","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","public":"View public information.","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","data_exports.read":"View and download data export files in your program."}}}}],"scopes":["content.read","content.replication.audit"]}],"responseCodes":["200","400","401","403","422"],"pointer":"/v2/content/replications","href":"content-publishing/listcontentreplications","openApiOperationId":"listContentReplications","summary":"Fetch content replications","securityGroups":[{"oauth2_as_a_user":["content.read","content.replication.audit"]},{"oauth2_as_a_server":["content.read","content.replication.audit"]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://partner.socialchorus.com","description":"US1"},{"url":"https://partner.us2.onfirstup.com","description":"US2"},{"url":"https://partner.onfirstup.eu","description":"EU"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_134"}},"schemaId":"schema_134"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}},"schemaId":"schema_101"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthenticated. See more on error responses "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://developers.firstup.io/gettingstarted/error_responses"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_120"}},"schemaId":"schema_120"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized. See more on error responses "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://developers.firstup.io/gettingstarted/error_responses"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_121"}},"schemaId":"schema_121"},{"code":"422","description":"Validation Failed"}],"pointer":"/paths/~1v2~1content~1replications/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_134","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_134"}}},{"code":"400","schemaId":"schema_101","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}}},{"code":"401","schemaId":"schema_120","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_120"}}},{"code":"403","schemaId":"schema_121","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_121"}}},{"code":"422"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/content-publishing/listcontentreplications"}],"panels":[]}]},"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"downloadContentVideo","name":"Get a download URL for a content video","isWebhook":false,"pointer":"/paths/~1v2~1videos~1{video_id}~1download/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a download URL for a content video","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a temporary link to a content video."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2_as_a_user","scopes":["content.videos.download"],"type":"oauth2","description":"OAuth2 for Users (Authorization Code grant flow)","flows":{"authorizationCode":{"authorizationUrl":"IAM_DOMAIN/oauth/authorize","tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","openid":"Authenticate your account using OpenID.","public":"View public information.","feeds.read":"View your feeds.","feeds.rendered.read":"View rendered content from feed posts.","feeds.engage":"View your feeds and engage with posts (likes, bookmarks, etc).","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","assistant.inbox.read":"View and list details of your assistant inbox items.","notification_center":"View and list notification center items.","data_exports.read":"View and download data export files in your program."}}}}]},{"schemes":[{"name":"oauth2_as_a_server","scopes":["content.videos.download"],"type":"oauth2","description":"OAuth2 for Server-to-Server (Client Credentials grant flow)","flows":{"clientCredentials":{"tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","public":"View public information.","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","data_exports.read":"View and download data export files in your program."}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"video_id","in":"path","schemaId":"schema_106","description":"ID of the video","required":true}],"pointer":"/paths/~1v2~1videos~1{video_id}~1download/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"lifespan","in":"query","schemaId":"schema_135","description":"Number of seconds the link should remain valid from the time it is generated"}],"pointer":"/paths/~1v2~1videos~1{video_id}~1download/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/videos/{video_id}/download","servers":[{"url":"https://partner.socialchorus.com","description":"US1"},{"url":"https://partner.us2.onfirstup.com","description":"US2"},{"url":"https://partner.onfirstup.eu","description":"EU"}],"parameters":{"path":[{"name":"video_id","in":"path","required":true,"schemaId":"schema_106"}],"query":[{"name":"lifespan","in":"query","required":false,"schemaId":"schema_135"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2_as_a_user","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"IAM_DOMAIN/oauth/authorize","tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","openid":"Authenticate your account using OpenID.","public":"View public information.","feeds.read":"View your feeds.","feeds.rendered.read":"View rendered content from feed posts.","feeds.engage":"View your feeds and engage with posts (likes, bookmarks, etc).","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","assistant.inbox.read":"View and list details of your assistant inbox items.","notification_center":"View and list notification center items.","data_exports.read":"View and download data export files in your program."}}}}],"scopes":["content.videos.download"]},{"schemes":[{"id":"oauth2_as_a_server","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","public":"View public information.","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","data_exports.read":"View and download data export files in your program."}}}}],"scopes":["content.videos.download"]}],"responseCodes":["200","400","401","404"],"pointer":"/v2/videos/{video_id}/download","href":"content-publishing/downloadcontentvideo","openApiOperationId":"downloadContentVideo","summary":"Get a download URL for a content video","securityGroups":[{"oauth2_as_a_user":["content.videos.download"]},{"oauth2_as_a_server":["content.videos.download"]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://partner.socialchorus.com","description":"US1"},{"url":"https://partner.us2.onfirstup.com","description":"US2"},{"url":"https://partner.onfirstup.eu","description":"EU"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_136"}},"schemaId":"schema_136"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}},"schemaId":"schema_101"},{"code":"401","description":"Unauthenticated","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}},"schemaId":"schema_101"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}},"schemaId":"schema_101"}],"pointer":"/paths/~1v2~1videos~1{video_id}~1download/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_136","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_136"}}},{"code":"400","schemaId":"schema_101","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}}},{"code":"401","schemaId":"schema_101","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}}},{"code":"404","schemaId":"schema_101","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/content-publishing/downloadcontentvideo"}],"panels":[]}]},"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"contentReachCount","name":"Fetch the unique count of users who can see the content post","isWebhook":false,"pointer":"/paths/~1v2~1content~1{content_id}~1reach~1unique_user_count/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetch the unique count of users who can see the content post","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Fetch the content reach, the unique user count for audiences, topics, and both."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2_as_a_user","scopes":["content.read"],"type":"oauth2","description":"OAuth2 for Users (Authorization Code grant flow)","flows":{"authorizationCode":{"authorizationUrl":"IAM_DOMAIN/oauth/authorize","tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","openid":"Authenticate your account using OpenID.","public":"View public information.","feeds.read":"View your feeds.","feeds.rendered.read":"View rendered content from feed posts.","feeds.engage":"View your feeds and engage with posts (likes, bookmarks, etc).","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","assistant.inbox.read":"View and list details of your assistant inbox items.","notification_center":"View and list notification center items.","data_exports.read":"View and download data export files in your program."}}}}]},{"schemes":[{"name":"oauth2_as_a_server","scopes":["content.read"],"type":"oauth2","description":"OAuth2 for Server-to-Server (Client Credentials grant flow)","flows":{"clientCredentials":{"tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","public":"View public information.","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","data_exports.read":"View and download data export files in your program."}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"content_id","in":"path","schemaId":"schema_106","description":"ID of the content post","required":true}],"pointer":"/paths/~1v2~1content~1{content_id}~1reach~1unique_user_count/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/content/{content_id}/reach/unique_user_count","servers":[{"url":"https://partner.socialchorus.com","description":"US1"},{"url":"https://partner.us2.onfirstup.com","description":"US2"},{"url":"https://partner.onfirstup.eu","description":"EU"}],"parameters":{"path":[{"name":"content_id","in":"path","required":true,"schemaId":"schema_106"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2_as_a_user","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"IAM_DOMAIN/oauth/authorize","tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","openid":"Authenticate your account using OpenID.","public":"View public information.","feeds.read":"View your feeds.","feeds.rendered.read":"View rendered content from feed posts.","feeds.engage":"View your feeds and engage with posts (likes, bookmarks, etc).","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","assistant.inbox.read":"View and list details of your assistant inbox items.","notification_center":"View and list notification center items.","data_exports.read":"View and download data export files in your program."}}}}],"scopes":["content.read"]},{"schemes":[{"id":"oauth2_as_a_server","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","public":"View public information.","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","data_exports.read":"View and download data export files in your program."}}}}],"scopes":["content.read"]}],"responseCodes":["200","400","401","404"],"pointer":"/v2/content/{content_id}/reach/unique_user_count","href":"content-publishing/contentreachcount","openApiOperationId":"contentReachCount","summary":"Fetch the unique count of users who can see the content post","securityGroups":[{"oauth2_as_a_user":["content.read"]},{"oauth2_as_a_server":["content.read"]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://partner.socialchorus.com","description":"US1"},{"url":"https://partner.us2.onfirstup.com","description":"US2"},{"url":"https://partner.onfirstup.eu","description":"EU"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_137"}},"schemaId":"schema_137"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}},"schemaId":"schema_101"},{"code":"401","description":"Unauthenticated","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}},"schemaId":"schema_101"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}},"schemaId":"schema_101"}],"pointer":"/paths/~1v2~1content~1{content_id}~1reach~1unique_user_count/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_137","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_137"}}},{"code":"400","schemaId":"schema_101","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}}},{"code":"401","schemaId":"schema_101","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}}},{"code":"404","schemaId":"schema_101","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/content-publishing/contentreachcount"}],"panels":[]}]},"httpPath":"/v2/content/{content_id}/reach/unique_user_count"}],"content":{"contentType":"group","meta":{"name":"Content Publishing"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Content Publishing","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"The Content Publishing API provides access to content the same way\nProgram Studio does, enabling the creation and updating of\n"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"articles"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"links"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"videos"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"images"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Security:"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" Users with a "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"“"},"children":[]},{"$$mdtype":"Node","type":"text","attributes":{"content":"publisher"},"children":[]},{"$$mdtype":"Node","type":"text","attributes":{"content":"”"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" or higher role can work with\n      content in this admin-like function. A 403 code is returned for content-related requests\n      to users without a "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"“"},"children":[]},{"$$mdtype":"Node","type":"text","attributes":{"content":"publisher"},"children":[]},{"$$mdtype":"Node","type":"text","attributes":{"content":"”"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" or higher role. Permissions are not granular;\n      any authenticated user may read, update, or take action on any existing content. See "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"/usermanagementapi/user-role-provisioning"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"user roles and access"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for more guidance.\n    "},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"States:"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" Content is initially created in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"“"},"children":[]},{"$$mdtype":"Node","type":"text","attributes":{"content":"draft"},"children":[]},{"$$mdtype":"Node","type":"text","attributes":{"content":"”"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" state. It becomes\n      fully visible in feeds when it has passed the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"“"},"children":[]},{"$$mdtype":"Node","type":"text","attributes":{"content":"review"},"children":[]},{"$$mdtype":"Node","type":"text","attributes":{"content":"”"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" state (meaning that\n      it requires review) and is in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"“"},"children":[]},{"$$mdtype":"Node","type":"text","attributes":{"content":"published"},"children":[]},{"$$mdtype":"Node","type":"text","attributes":{"content":"”"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" state. Content can also pass\n      through "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"“"},"children":[]},{"$$mdtype":"Node","type":"text","attributes":{"content":"archived"},"children":[]},{"$$mdtype":"Node","type":"text","attributes":{"content":"”"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" (similar to deleted), "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"“"},"children":[]},{"$$mdtype":"Node","type":"text","attributes":{"content":"scheduled"},"children":[]},{"$$mdtype":"Node","type":"text","attributes":{"content":"”"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" (content to\n      be published in the future automatically), "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"“"},"children":[]},{"$$mdtype":"Node","type":"text","attributes":{"content":"processing"},"children":[]},{"$$mdtype":"Node","type":"text","attributes":{"content":"”"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" (refers to media\n      that is still being processed or uploaded; like content in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"“"},"children":[]},{"$$mdtype":"Node","type":"text","attributes":{"content":"draft"},"children":[]},{"$$mdtype":"Node","type":"text","attributes":{"content":"”"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"\n      state, this content does not become "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"“"},"children":[]},{"$$mdtype":"Node","type":"text","attributes":{"content":"published"},"children":[]},{"$$mdtype":"Node","type":"text","attributes":{"content":"”"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" until processing has\n      completed), and "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"“"},"children":[]},{"$$mdtype":"Node","type":"text","attributes":{"content":"processing error"},"children":[]},{"$$mdtype":"Node","type":"text","attributes":{"content":"”"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" (media or similar objects that fail\n      during the processing phase; this content cannot be transitioned to another state)\n      states.\n    "},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Sources:"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" Content sources include "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"“"},"children":[]},{"$$mdtype":"Node","type":"text","attributes":{"content":"submitted"},"children":[]},{"$$mdtype":"Node","type":"text","attributes":{"content":"”"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" (by users);\n      "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"“"},"children":[]},{"$$mdtype":"Node","type":"text","attributes":{"content":"pinterest"},"children":[]},{"$$mdtype":"Node","type":"text","attributes":{"content":"”"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"“"},"children":[]},{"$$mdtype":"Node","type":"text","attributes":{"content":"rss"},"children":[]},{"$$mdtype":"Node","type":"text","attributes":{"content":"”"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"“"},"children":[]},{"$$mdtype":"Node","type":"text","attributes":{"content":"facebook"},"children":[]},{"$$mdtype":"Node","type":"text","attributes":{"content":"”"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":",\n      "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"“"},"children":[]},{"$$mdtype":"Node","type":"text","attributes":{"content":"twitter"},"children":[]},{"$$mdtype":"Node","type":"text","attributes":{"content":"”"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" (X) and "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"“"},"children":[]},{"$$mdtype":"Node","type":"text","attributes":{"content":"instagram"},"children":[]},{"$$mdtype":"Node","type":"text","attributes":{"content":"”"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" (for content harvested from external\n      sources); "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"“"},"children":[]},{"$$mdtype":"Node","type":"text","attributes":{"content":"socialchoruscpcm"},"children":[]},{"$$mdtype":"Node","type":"text","attributes":{"content":"”"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" (for content that is republished between\n      programs); "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"“"},"children":[]},{"$$mdtype":"Node","type":"text","attributes":{"content":"studio"},"children":[]},{"$$mdtype":"Node","type":"text","attributes":{"content":"”"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" (for admin-created content); and "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"“"},"children":[]},{"$$mdtype":"Node","type":"text","attributes":{"content":"oauthclient"},"children":[]},{"$$mdtype":"Node","type":"text","attributes":{"content":"”"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" (for content published via the Partner API or other OAuth client)."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":" For contextual guidance on content publishing, and for use case examples, refer to our "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"/contentandpublishing/contentoverview"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Content Publishing Overview page"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v2/channels","summary":"Create a topic in the program","prefix":{"name":"post","color":"post"},"badges":[],"link":"/content-publishing/createchannel","deprecated":false},{"title":"/v2/channels","summary":"List all topics in the program","prefix":{"name":"get","color":"get"},"badges":[],"link":"/content-publishing/listchannels","deprecated":false},{"title":"/v2/channels/{channel_id}","summary":"Update a topic in the program","prefix":{"name":"put","color":"put"},"badges":[],"link":"/content-publishing/updatechannel","deprecated":false},{"title":"/v2/channels/{channel_id}/followers","summary":"List all followers of a topic","prefix":{"name":"get","color":"get"},"badges":[],"link":"/content-publishing/listchannelfollowers","deprecated":false},{"title":"/v2/channels/{channel_id}/pages","summary":"List pages for a topic","prefix":{"name":"get","color":"get"},"badges":[],"link":"/content-publishing/listchannelpages","deprecated":false},{"title":"/v2/content","summary":"Fetch a collection of content","prefix":{"name":"get","color":"get"},"badges":[],"link":"/content-publishing/listcontent","deprecated":false},{"title":"/v2/content","summary":"Create a new content post","prefix":{"name":"post","color":"post"},"badges":[],"link":"/content-publishing/createcontent","deprecated":false},{"title":"/v2/content/{content_id}","summary":"Fetch the details of a content post","prefix":{"name":"get","color":"get"},"badges":[],"link":"/content-publishing/detailcontent","deprecated":false},{"title":"/v2/content/{content_id}","summary":"Update an existing content post","prefix":{"name":"put","color":"put"},"badges":[],"link":"/content-publishing/updatecontent","deprecated":false},{"title":"/v2/content/{content_id}/archive","summary":"Archive an existing content post","prefix":{"name":"put","color":"put"},"badges":[],"link":"/content-publishing/archivecontent","deprecated":false},{"title":"/v2/content/{content_id}/draft","summary":"Draft an existing content post","prefix":{"name":"put","color":"put"},"badges":[],"link":"/content-publishing/draftcontent","deprecated":false},{"title":"/v2/content/{content_id}/publish","summary":"Publish an existing content post","prefix":{"name":"put","color":"put"},"badges":[],"link":"/content-publishing/publishcontent","deprecated":false},{"title":"/v2/content/{content_id}/review","summary":"Mark an existing post as ready for review","prefix":{"name":"put","color":"put"},"badges":[],"link":"/content-publishing/reviewcontent","deprecated":false},{"title":"/v2/content/{content_id}/comments","summary":"List the comments on a content post","prefix":{"name":"get","color":"get"},"badges":[],"link":"/content-publishing/listcontentcomments","deprecated":false},{"title":"/v2/content/{content_id}/comments/{comment_id}/replies","summary":"List the replies on comment post","prefix":{"name":"get","color":"get"},"badges":[],"link":"/content-publishing/listcontentcommentreplies","deprecated":false},{"title":"/v2/content/{content_id}/images","summary":"Add an image to a content post","prefix":{"name":"put","color":"put"},"badges":[],"link":"/content-publishing/addcontentimage","deprecated":false},{"title":"/v2/content/{content_id}/videos","summary":"Add a video for use in content of type article","prefix":{"name":"put","color":"put"},"badges":[],"link":"/content-publishing/addcontentvideo","deprecated":false},{"title":"/v2/content/{content_id}/images/{content_image_id}","summary":"Remove an image from a content post","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/content-publishing/removecontentimage","deprecated":false},{"title":"/v2/content/replications","summary":"Fetch content replications","prefix":{"name":"get","color":"get"},"badges":[],"link":"/content-publishing/listcontentreplications","deprecated":false},{"title":"/v2/videos/{video_id}/download","summary":"Get a download URL for a content video","prefix":{"name":"get","color":"get"},"badges":[],"link":"/content-publishing/downloadcontentvideo","deprecated":false},{"title":"/v2/content/{content_id}/reach/unique_user_count","summary":"Fetch the unique count of users who can see the content post","prefix":{"name":"get","color":"get"},"badges":[],"link":"/content-publishing/contentreachcount","deprecated":false}]}]}]}]}},{"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.Resources"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listFeedPosts","name":"Return a user's feed of posts","isWebhook":false,"pointer":"/paths/~1v2~1feed~1posts/get","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Return a user's feed of posts","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Resources"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://support.firstup.io/hc/en-us/articles/4415354532759-How-Do-Users-See-Content"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Knowledge Base article on Feeds"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"/feeds/feedsoverview"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Feeds overview page"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"/gettingstarted/pagination"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Pagination"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"/gettingstarted/filtering"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Filtering"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2_as_a_user","scopes":["feeds.read"],"type":"oauth2","description":"OAuth2 for Users (Authorization Code grant flow)","flows":{"authorizationCode":{"authorizationUrl":"IAM_DOMAIN/oauth/authorize","tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","openid":"Authenticate your account using OpenID.","public":"View public information.","feeds.read":"View your feeds.","feeds.rendered.read":"View rendered content from feed posts.","feeds.engage":"View your feeds and engage with posts (likes, bookmarks, etc).","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","assistant.inbox.read":"View and list details of your assistant inbox items.","notification_center":"View and list notification center items.","data_exports.read":"View and download data export files in your program."}}}}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"name","in":"query","schemaId":"schema_138","description":"Use a specific named feed, which is a preset of filters for specific types of feeds. By default, requests return the \"myfeed\" feed, which includes posts the user can see but may not necessarily be following. Specifying a name not listed here will result in a 400 Bad Request error.\n"},{"name":"search","in":"query","schemaId":"schema_115","description":"Find content matching provided keywords. When specified, parameters other than pagination and the topics filter will be ignored.\n"},{"name":"filter.user_behaviors","in":"query","schemaId":"schema_139","description":"Return content posts that users have interacted with in the provided ways. Defaults to all content if left empty.\n"},{"name":"filter.channels.id","in":"query","schemaId":"schema_112","description":"Build the feed from the given topics. Provide a list as either array or comma separated list. Returns posts that are published to ANY of the topics. Defaults to all topics.\n"},{"name":"filter.initiative_tags.id","in":"query","schemaId":"schema_112","description":"Build the feed from the given initiative tags. Provide a list as either array or comma separated list. Returns posts that are published with ANY of the initiative tags. Defaults to all content.\n"},{"name":"filter.content_type","in":"query","schemaId":"schema_140","description":"Return only content matching the provided types, which can be a single type or a list as either array or comma separated list. Possible values include 'article', 'link', 'note', 'image', and 'video'. Defaults to all types. Including a type not listed her will result in a 400 Bad Request error.\n"},{"name":"filter.visibility","in":"query","schemaId":"schema_113","description":"Limit records to the value provided."},{"name":"filter.featured","in":"query","schemaId":"schema_111","description":"Limit records to the value provided."},{"name":"page.size","in":"query","schemaId":"schema_103","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Return "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"page.size"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" number of records starting at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"size*number"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The default page size is 10 (number of records per page), resulting in the first page being retrieved. The maximum page size is 100."},"children":[]}]}]}]},{"name":"page.number","in":"query","schemaId":"schema_103","description":"Using classical pagination, the page number to return. Default is 1"}],"pointer":"/paths/~1v2~1feed~1posts/get/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_112"}},"schemaId":"schema_112","pointer":"/paths/~1v2~1feed~1posts/get/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/feed/posts","servers":[{"url":"https://partner.socialchorus.com","description":"US1"},{"url":"https://partner.us2.onfirstup.com","description":"US2"},{"url":"https://partner.onfirstup.eu","description":"EU"}],"parameters":{"path":[],"query":[{"name":"name","in":"query","required":false,"schemaId":"schema_138"},{"name":"search","in":"query","required":false,"schemaId":"schema_115"},{"name":"filter.user_behaviors","in":"query","required":false,"schemaId":"schema_139"},{"name":"filter.channels.id","in":"query","required":false,"schemaId":"schema_112","style":"form","explode":false},{"name":"filter.initiative_tags.id","in":"query","required":false,"schemaId":"schema_112","style":"form","explode":false},{"name":"filter.content_type","in":"query","required":false,"schemaId":"schema_140","style":"form","explode":false},{"name":"filter.visibility","in":"query","schemaId":"schema_113"},{"name":"filter.featured","in":"query","schemaId":"schema_111"},{"name":"page.size","in":"query","required":false,"schemaId":"schema_103"},{"name":"page.number","in":"query","required":false,"schemaId":"schema_103"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2_as_a_user","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"IAM_DOMAIN/oauth/authorize","tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","openid":"Authenticate your account using OpenID.","public":"View public information.","feeds.read":"View your feeds.","feeds.rendered.read":"View rendered content from feed posts.","feeds.engage":"View your feeds and engage with posts (likes, bookmarks, etc).","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","assistant.inbox.read":"View and list details of your assistant inbox items.","notification_center":"View and list notification center items.","data_exports.read":"View and download data export files in your program."}}}}],"scopes":["feeds.read"]}],"requestBody":{"application/json":{"schemaId":"schema_112"}},"responseCodes":["200","400","401","404"],"pointer":"/v2/feed/posts","href":"feeds/listfeedposts","openApiOperationId":"listFeedPosts","summary":"Return a user's feed of posts"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://partner.socialchorus.com","description":"US1"},{"url":"https://partner.us2.onfirstup.com","description":"US2"},{"url":"https://partner.onfirstup.eu","description":"EU"}],"schemaId":"schema_112","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_112"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_141"}},"schemaId":"schema_141"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request (this 400 error example shows an incorrect enum validation in the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Name"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameter). See more on "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://developers.firstup.io/gettingstarted/responses#error-responses"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" error responses here "},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_142","exampleIds":["paths/~1v2~1feed~1posts/get/responses/400/content/application~1json/example"]}},"schemaId":"schema_142","exampleIds":["paths/~1v2~1feed~1posts/get/responses/400/content/application~1json/example"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthenticated. See more on "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://developers.firstup.io/gettingstarted/responses#error-responses"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" error responses here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}},"schemaId":"schema_101"},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Not Found. See more on "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://developers.firstup.io/gettingstarted/responses#error-responses"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" error responses here "},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}},"schemaId":"schema_101"}],"pointer":"/paths/~1v2~1feed~1posts/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_141","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_141"}}},{"code":"400","schemaId":"schema_142","exampleIds":["paths/~1v2~1feed~1posts/get/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_142","exampleIds":["paths/~1v2~1feed~1posts/get/responses/400/content/application~1json/example"]}}},{"code":"401","schemaId":"schema_101","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}}},{"code":"404","schemaId":"schema_101","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/feeds/listfeedposts"}],"panels":[]}]},"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. "}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"webHomepageFeed","name":"Return a user's homepage feed","isWebhook":false,"pointer":"/paths/~1v2~1feeds~1web_homepage/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Return a user's homepage feed","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Provides a user’s homepage feed, complete with the homepage banner, user’s shortcuts and modules."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"admonition","inline":true,"attributes":{"type":"info"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" This is a restricted endpoint that requires enablement. Reach out to your Firstup representative for access. "},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2_as_a_user","scopes":["feeds.read"],"type":"oauth2","description":"OAuth2 for Users (Authorization Code grant flow)","flows":{"authorizationCode":{"authorizationUrl":"IAM_DOMAIN/oauth/authorize","tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","openid":"Authenticate your account using OpenID.","public":"View public information.","feeds.read":"View your feeds.","feeds.rendered.read":"View rendered content from feed posts.","feeds.engage":"View your feeds and engage with posts (likes, bookmarks, etc).","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","assistant.inbox.read":"View and list details of your assistant inbox items.","notification_center":"View and list notification center items.","data_exports.read":"View and download data export files in your program."}}}}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/feeds/web_homepage","servers":[{"url":"https://partner.socialchorus.com","description":"US1"},{"url":"https://partner.us2.onfirstup.com","description":"US2"},{"url":"https://partner.onfirstup.eu","description":"EU"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2_as_a_user","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"IAM_DOMAIN/oauth/authorize","tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","openid":"Authenticate your account using OpenID.","public":"View public information.","feeds.read":"View your feeds.","feeds.rendered.read":"View rendered content from feed posts.","feeds.engage":"View your feeds and engage with posts (likes, bookmarks, etc).","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","assistant.inbox.read":"View and list details of your assistant inbox items.","notification_center":"View and list notification center items.","data_exports.read":"View and download data export files in your program."}}}}],"scopes":["feeds.read"]}],"responseCodes":["200","400","401"],"pointer":"/v2/feeds/web_homepage","href":"feeds/webhomepagefeed","openApiOperationId":"webHomepageFeed","summary":"Return a user's homepage feed"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://partner.socialchorus.com","description":"US1"},{"url":"https://partner.us2.onfirstup.com","description":"US2"},{"url":"https://partner.onfirstup.eu","description":"EU"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_143"}},"schemaId":"schema_143"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request. See more on "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://developers.firstup.io/gettingstarted/responses#error-responses"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" error responses here "},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}},"schemaId":"schema_101"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthenticated. See more on "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://developers.firstup.io/gettingstarted/responses#error-responses"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" error responses here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}},"schemaId":"schema_101"}],"pointer":"/paths/~1v2~1feeds~1web_homepage/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_143","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_143"}}},{"code":"400","schemaId":"schema_101","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}}},{"code":"401","schemaId":"schema_101","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/feeds/webhomepagefeed"}],"panels":[]}]},"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"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listFeedProfileSubmitted","name":"Return a user profile's submitted content","isWebhook":false,"pointer":"/paths/~1v2~1feed~1profile~1submitted/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Return a user profile's submitted content","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2_as_a_user","scopes":["feeds.read"],"type":"oauth2","description":"OAuth2 for Users (Authorization Code grant flow)","flows":{"authorizationCode":{"authorizationUrl":"IAM_DOMAIN/oauth/authorize","tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","openid":"Authenticate your account using OpenID.","public":"View public information.","feeds.read":"View your feeds.","feeds.rendered.read":"View rendered content from feed posts.","feeds.engage":"View your feeds and engage with posts (likes, bookmarks, etc).","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","assistant.inbox.read":"View and list details of your assistant inbox items.","notification_center":"View and list notification center items.","data_exports.read":"View and download data export files in your program."}}}}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"user_id","in":"query","schemaId":"schema_144","description":"The ID of the user whose profile to view. Defaults to the authenticated user if not provided.\n"},{"name":"page.size","in":"query","schemaId":"schema_103","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Return "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"page.size"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" number of records starting at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"size*number"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The default page size is 10 (number of records per page), resulting in the first page being retrieved. The maximum page size is 100."},"children":[]}]}]}]},{"name":"page.number","in":"query","schemaId":"schema_103","description":"Using classical pagination, the page number to return. Default is 1"}],"pointer":"/paths/~1v2~1feed~1profile~1submitted/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/feed/profile/submitted","servers":[{"url":"https://partner.socialchorus.com","description":"US1"},{"url":"https://partner.us2.onfirstup.com","description":"US2"},{"url":"https://partner.onfirstup.eu","description":"EU"}],"parameters":{"path":[],"query":[{"name":"user_id","in":"query","required":false,"schemaId":"schema_144"},{"name":"page.size","in":"query","required":false,"schemaId":"schema_103"},{"name":"page.number","in":"query","required":false,"schemaId":"schema_103"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2_as_a_user","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"IAM_DOMAIN/oauth/authorize","tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","openid":"Authenticate your account using OpenID.","public":"View public information.","feeds.read":"View your feeds.","feeds.rendered.read":"View rendered content from feed posts.","feeds.engage":"View your feeds and engage with posts (likes, bookmarks, etc).","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","assistant.inbox.read":"View and list details of your assistant inbox items.","notification_center":"View and list notification center items.","data_exports.read":"View and download data export files in your program."}}}}],"scopes":["feeds.read"]}],"responseCodes":["200","401"],"pointer":"/v2/feed/profile/submitted","href":"feeds/listfeedprofilesubmitted","openApiOperationId":"listFeedProfileSubmitted","summary":"Return a user profile's submitted content"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://partner.socialchorus.com","description":"US1"},{"url":"https://partner.us2.onfirstup.com","description":"US2"},{"url":"https://partner.onfirstup.eu","description":"EU"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_145"}},"schemaId":"schema_145"},{"code":"401","description":"Unauthenticated","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}},"schemaId":"schema_101"}],"pointer":"/paths/~1v2~1feed~1profile~1submitted/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_145","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_145"}}},{"code":"401","schemaId":"schema_101","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/feeds/listfeedprofilesubmitted"}],"panels":[]}]},"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"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listFeedProfileChannels","name":"Return channels followed by a user profile","isWebhook":false,"pointer":"/paths/~1v2~1feed~1profile~1channels/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Return channels followed by a user profile","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2_as_a_user","scopes":["feeds.read"],"type":"oauth2","description":"OAuth2 for Users (Authorization Code grant flow)","flows":{"authorizationCode":{"authorizationUrl":"IAM_DOMAIN/oauth/authorize","tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","openid":"Authenticate your account using OpenID.","public":"View public information.","feeds.read":"View your feeds.","feeds.rendered.read":"View rendered content from feed posts.","feeds.engage":"View your feeds and engage with posts (likes, bookmarks, etc).","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","assistant.inbox.read":"View and list details of your assistant inbox items.","notification_center":"View and list notification center items.","data_exports.read":"View and download data export files in your program."}}}}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"user_id","in":"query","schemaId":"schema_144","description":"The ID of the user whose profile to view. Defaults to the authenticated user if not provided.\n"}],"pointer":"/paths/~1v2~1feed~1profile~1channels/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/feed/profile/channels","servers":[{"url":"https://partner.socialchorus.com","description":"US1"},{"url":"https://partner.us2.onfirstup.com","description":"US2"},{"url":"https://partner.onfirstup.eu","description":"EU"}],"parameters":{"path":[],"query":[{"name":"user_id","in":"query","required":false,"schemaId":"schema_144"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2_as_a_user","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"IAM_DOMAIN/oauth/authorize","tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","openid":"Authenticate your account using OpenID.","public":"View public information.","feeds.read":"View your feeds.","feeds.rendered.read":"View rendered content from feed posts.","feeds.engage":"View your feeds and engage with posts (likes, bookmarks, etc).","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","assistant.inbox.read":"View and list details of your assistant inbox items.","notification_center":"View and list notification center items.","data_exports.read":"View and download data export files in your program."}}}}],"scopes":["feeds.read"]}],"responseCodes":["200","401"],"pointer":"/v2/feed/profile/channels","href":"feeds/listfeedprofilechannels","openApiOperationId":"listFeedProfileChannels","summary":"Return channels followed by a user profile"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://partner.socialchorus.com","description":"US1"},{"url":"https://partner.us2.onfirstup.com","description":"US2"},{"url":"https://partner.onfirstup.eu","description":"EU"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_146"}},"schemaId":"schema_146"},{"code":"401","description":"Unauthenticated","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}},"schemaId":"schema_101"}],"pointer":"/paths/~1v2~1feed~1profile~1channels/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_146","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_146"}}},{"code":"401","schemaId":"schema_101","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/feeds/listfeedprofilechannels"}],"panels":[]}]},"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"detailFeedPost","name":"Return the details of a single post within a feed","isWebhook":false,"pointer":"/paths/~1v2~1feed~1posts~1{content_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Return the details of a single post within a feed","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2_as_a_user","scopes":["feeds.read"],"type":"oauth2","description":"OAuth2 for Users (Authorization Code grant flow)","flows":{"authorizationCode":{"authorizationUrl":"IAM_DOMAIN/oauth/authorize","tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","openid":"Authenticate your account using OpenID.","public":"View public information.","feeds.read":"View your feeds.","feeds.rendered.read":"View rendered content from feed posts.","feeds.engage":"View your feeds and engage with posts (likes, bookmarks, etc).","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","assistant.inbox.read":"View and list details of your assistant inbox items.","notification_center":"View and list notification center items.","data_exports.read":"View and download data export files in your program."}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"content_id","in":"path","schemaId":"schema_106","description":"ID of the detailed post","required":true}],"pointer":"/paths/~1v2~1feed~1posts~1{content_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"locale","in":"query","schemaId":"schema_115","description":"locale (for translatable posts)"}],"pointer":"/paths/~1v2~1feed~1posts~1{content_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/feed/posts/{content_id}","servers":[{"url":"https://partner.socialchorus.com","description":"US1"},{"url":"https://partner.us2.onfirstup.com","description":"US2"},{"url":"https://partner.onfirstup.eu","description":"EU"}],"parameters":{"path":[{"name":"content_id","in":"path","required":true,"schemaId":"schema_106"}],"query":[{"name":"locale","in":"query","required":false,"schemaId":"schema_115"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2_as_a_user","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"IAM_DOMAIN/oauth/authorize","tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","openid":"Authenticate your account using OpenID.","public":"View public information.","feeds.read":"View your feeds.","feeds.rendered.read":"View rendered content from feed posts.","feeds.engage":"View your feeds and engage with posts (likes, bookmarks, etc).","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","assistant.inbox.read":"View and list details of your assistant inbox items.","notification_center":"View and list notification center items.","data_exports.read":"View and download data export files in your program."}}}}],"scopes":["feeds.read"]}],"responseCodes":["200","400","401","404"],"pointer":"/v2/feed/posts/{content_id}","href":"feeds/detailfeedpost","openApiOperationId":"detailFeedPost","summary":"Return the details of a single post within a feed"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://partner.socialchorus.com","description":"US1"},{"url":"https://partner.us2.onfirstup.com","description":"US2"},{"url":"https://partner.onfirstup.eu","description":"EU"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_147"}},"schemaId":"schema_147"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}},"schemaId":"schema_101"},{"code":"401","description":"Unauthenticated","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}},"schemaId":"schema_101"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}},"schemaId":"schema_101"}],"pointer":"/paths/~1v2~1feed~1posts~1{content_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_147","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_147"}}},{"code":"400","schemaId":"schema_101","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}}},{"code":"401","schemaId":"schema_101","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}}},{"code":"404","schemaId":"schema_101","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/feeds/detailfeedpost"}],"panels":[]}]},"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 liked_at timestamp is present if the user has liked the post and a bookmarked_at 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. Upon enabling expanded reactions types, the response will include a reaction_type_id which is associated with a reaction type."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"detailFeedPostEngagement","name":"Return the engagement details of a single post within a feed","isWebhook":false,"pointer":"/paths/~1v2~1feed~1posts~1{content_id}~1engagement/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Return the engagement details of a single post within a feed","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Displays the user’s engagements related to a single feed post, including a timestamp for each type of engagement; for example, a "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"liked_at"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" timestamp is present if the user has liked the post and a "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"bookmarked_at"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" 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."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Upon enabling expanded reactions types, the response will include a "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"reaction_type_id"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" which is associated with a reaction type."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2_as_a_user","scopes":["feeds.read"],"type":"oauth2","description":"OAuth2 for Users (Authorization Code grant flow)","flows":{"authorizationCode":{"authorizationUrl":"IAM_DOMAIN/oauth/authorize","tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","openid":"Authenticate your account using OpenID.","public":"View public information.","feeds.read":"View your feeds.","feeds.rendered.read":"View rendered content from feed posts.","feeds.engage":"View your feeds and engage with posts (likes, bookmarks, etc).","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","assistant.inbox.read":"View and list details of your assistant inbox items.","notification_center":"View and list notification center items.","data_exports.read":"View and download data export files in your program."}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"content_id","in":"path","schemaId":"schema_106","description":"ID of the post","required":true}],"pointer":"/paths/~1v2~1feed~1posts~1{content_id}~1engagement/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/feed/posts/{content_id}/engagement","servers":[{"url":"https://partner.socialchorus.com","description":"US1"},{"url":"https://partner.us2.onfirstup.com","description":"US2"},{"url":"https://partner.onfirstup.eu","description":"EU"}],"parameters":{"path":[{"name":"content_id","in":"path","required":true,"schemaId":"schema_106"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2_as_a_user","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"IAM_DOMAIN/oauth/authorize","tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","openid":"Authenticate your account using OpenID.","public":"View public information.","feeds.read":"View your feeds.","feeds.rendered.read":"View rendered content from feed posts.","feeds.engage":"View your feeds and engage with posts (likes, bookmarks, etc).","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","assistant.inbox.read":"View and list details of your assistant inbox items.","notification_center":"View and list notification center items.","data_exports.read":"View and download data export files in your program."}}}}],"scopes":["feeds.read"]}],"responseCodes":["200","400","401","404"],"pointer":"/v2/feed/posts/{content_id}/engagement","href":"feeds/detailfeedpostengagement","openApiOperationId":"detailFeedPostEngagement","summary":"Return the engagement details of a single post within a feed"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://partner.socialchorus.com","description":"US1"},{"url":"https://partner.us2.onfirstup.com","description":"US2"},{"url":"https://partner.onfirstup.eu","description":"EU"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_148"}},"schemaId":"schema_148"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}},"schemaId":"schema_101"},{"code":"401","description":"Unauthenticated","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}},"schemaId":"schema_101"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}},"schemaId":"schema_101"}],"pointer":"/paths/~1v2~1feed~1posts~1{content_id}~1engagement/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_148","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_148"}}},{"code":"400","schemaId":"schema_101","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}}},{"code":"401","schemaId":"schema_101","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}}},{"code":"404","schemaId":"schema_101","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/feeds/detailfeedpostengagement"}],"panels":[]}]},"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"likePost","name":"Like a post in the feed","isWebhook":false,"pointer":"/paths/~1v2~1feed~1posts~1{content_id}~1like/put","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Like a post in the feed","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2_as_a_user","scopes":["feeds.engage"],"type":"oauth2","description":"OAuth2 for Users (Authorization Code grant flow)","flows":{"authorizationCode":{"authorizationUrl":"IAM_DOMAIN/oauth/authorize","tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","openid":"Authenticate your account using OpenID.","public":"View public information.","feeds.read":"View your feeds.","feeds.rendered.read":"View rendered content from feed posts.","feeds.engage":"View your feeds and engage with posts (likes, bookmarks, etc).","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","assistant.inbox.read":"View and list details of your assistant inbox items.","notification_center":"View and list notification center items.","data_exports.read":"View and download data export files in your program."}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"content_id","in":"path","schemaId":"schema_106","description":"ID of the post. The post must be visible to the user.","required":true}],"pointer":"/paths/~1v2~1feed~1posts~1{content_id}~1like/put/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v2/feed/posts/{content_id}/like","servers":[{"url":"https://partner.socialchorus.com","description":"US1"},{"url":"https://partner.us2.onfirstup.com","description":"US2"},{"url":"https://partner.onfirstup.eu","description":"EU"}],"parameters":{"path":[{"name":"content_id","in":"path","required":true,"schemaId":"schema_106"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2_as_a_user","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"IAM_DOMAIN/oauth/authorize","tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","openid":"Authenticate your account using OpenID.","public":"View public information.","feeds.read":"View your feeds.","feeds.rendered.read":"View rendered content from feed posts.","feeds.engage":"View your feeds and engage with posts (likes, bookmarks, etc).","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","assistant.inbox.read":"View and list details of your assistant inbox items.","notification_center":"View and list notification center items.","data_exports.read":"View and download data export files in your program."}}}}],"scopes":["feeds.engage"]}],"responseCodes":["204","400","401","404"],"pointer":"/v2/feed/posts/{content_id}/like","href":"feeds/likepost","openApiOperationId":"likePost","summary":"Like a post in the feed"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://partner.socialchorus.com","description":"US1"},{"url":"https://partner.us2.onfirstup.com","description":"US2"},{"url":"https://partner.onfirstup.eu","description":"EU"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Feed Post Liked"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}},"schemaId":"schema_101"},{"code":"401","description":"Unauthenticated","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}},"schemaId":"schema_101"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}},"schemaId":"schema_101"}],"pointer":"/paths/~1v2~1feed~1posts~1{content_id}~1like/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"schema_101","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}}},{"code":"401","schemaId":"schema_101","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}}},{"code":"404","schemaId":"schema_101","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/feeds/likepost"}],"panels":[]}]},"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"unlikePost","name":"Unlike a post in the feed","isWebhook":false,"pointer":"/paths/~1v2~1feed~1posts~1{content_id}~1unlike/put","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Unlike a post in the feed","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2_as_a_user","scopes":["feeds.engage"],"type":"oauth2","description":"OAuth2 for Users (Authorization Code grant flow)","flows":{"authorizationCode":{"authorizationUrl":"IAM_DOMAIN/oauth/authorize","tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","openid":"Authenticate your account using OpenID.","public":"View public information.","feeds.read":"View your feeds.","feeds.rendered.read":"View rendered content from feed posts.","feeds.engage":"View your feeds and engage with posts (likes, bookmarks, etc).","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","assistant.inbox.read":"View and list details of your assistant inbox items.","notification_center":"View and list notification center items.","data_exports.read":"View and download data export files in your program."}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"content_id","in":"path","schemaId":"schema_106","description":"ID of the post. The post must be visible to the user.","required":true}],"pointer":"/paths/~1v2~1feed~1posts~1{content_id}~1unlike/put/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v2/feed/posts/{content_id}/unlike","servers":[{"url":"https://partner.socialchorus.com","description":"US1"},{"url":"https://partner.us2.onfirstup.com","description":"US2"},{"url":"https://partner.onfirstup.eu","description":"EU"}],"parameters":{"path":[{"name":"content_id","in":"path","required":true,"schemaId":"schema_106"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2_as_a_user","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"IAM_DOMAIN/oauth/authorize","tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","openid":"Authenticate your account using OpenID.","public":"View public information.","feeds.read":"View your feeds.","feeds.rendered.read":"View rendered content from feed posts.","feeds.engage":"View your feeds and engage with posts (likes, bookmarks, etc).","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","assistant.inbox.read":"View and list details of your assistant inbox items.","notification_center":"View and list notification center items.","data_exports.read":"View and download data export files in your program."}}}}],"scopes":["feeds.engage"]}],"responseCodes":["204","400","401","404"],"pointer":"/v2/feed/posts/{content_id}/unlike","href":"feeds/unlikepost","openApiOperationId":"unlikePost","summary":"Unlike a post in the feed"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://partner.socialchorus.com","description":"US1"},{"url":"https://partner.us2.onfirstup.com","description":"US2"},{"url":"https://partner.onfirstup.eu","description":"EU"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Feed Post Unliked"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}},"schemaId":"schema_101"},{"code":"401","description":"Unauthenticated","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}},"schemaId":"schema_101"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}},"schemaId":"schema_101"}],"pointer":"/paths/~1v2~1feed~1posts~1{content_id}~1unlike/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"schema_101","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}}},{"code":"401","schemaId":"schema_101","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}}},{"code":"404","schemaId":"schema_101","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/feeds/unlikepost"}],"panels":[]}]},"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"bookmarkPost","name":"Bookmark a post in the feed","isWebhook":false,"pointer":"/paths/~1v2~1feed~1posts~1{content_id}~1bookmark/put","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Bookmark a post in the feed","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2_as_a_user","scopes":["feeds.engage"],"type":"oauth2","description":"OAuth2 for Users (Authorization Code grant flow)","flows":{"authorizationCode":{"authorizationUrl":"IAM_DOMAIN/oauth/authorize","tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","openid":"Authenticate your account using OpenID.","public":"View public information.","feeds.read":"View your feeds.","feeds.rendered.read":"View rendered content from feed posts.","feeds.engage":"View your feeds and engage with posts (likes, bookmarks, etc).","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","assistant.inbox.read":"View and list details of your assistant inbox items.","notification_center":"View and list notification center items.","data_exports.read":"View and download data export files in your program."}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"content_id","in":"path","schemaId":"schema_106","description":"ID of the post. The post must be visible to the user.","required":true}],"pointer":"/paths/~1v2~1feed~1posts~1{content_id}~1bookmark/put/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v2/feed/posts/{content_id}/bookmark","servers":[{"url":"https://partner.socialchorus.com","description":"US1"},{"url":"https://partner.us2.onfirstup.com","description":"US2"},{"url":"https://partner.onfirstup.eu","description":"EU"}],"parameters":{"path":[{"name":"content_id","in":"path","required":true,"schemaId":"schema_106"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2_as_a_user","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"IAM_DOMAIN/oauth/authorize","tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","openid":"Authenticate your account using OpenID.","public":"View public information.","feeds.read":"View your feeds.","feeds.rendered.read":"View rendered content from feed posts.","feeds.engage":"View your feeds and engage with posts (likes, bookmarks, etc).","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","assistant.inbox.read":"View and list details of your assistant inbox items.","notification_center":"View and list notification center items.","data_exports.read":"View and download data export files in your program."}}}}],"scopes":["feeds.engage"]}],"responseCodes":["204","400","401","404"],"pointer":"/v2/feed/posts/{content_id}/bookmark","href":"feeds/bookmarkpost","openApiOperationId":"bookmarkPost","summary":"Bookmark a post in the feed"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://partner.socialchorus.com","description":"US1"},{"url":"https://partner.us2.onfirstup.com","description":"US2"},{"url":"https://partner.onfirstup.eu","description":"EU"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Feed Post Bookmarked"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}},"schemaId":"schema_101"},{"code":"401","description":"Unauthenticated","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}},"schemaId":"schema_101"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}},"schemaId":"schema_101"}],"pointer":"/paths/~1v2~1feed~1posts~1{content_id}~1bookmark/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"schema_101","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}}},{"code":"401","schemaId":"schema_101","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}}},{"code":"404","schemaId":"schema_101","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/feeds/bookmarkpost"}],"panels":[]}]},"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"unbookmarkPost","name":"Unbookmark a post in the feed","isWebhook":false,"pointer":"/paths/~1v2~1feed~1posts~1{content_id}~1unbookmark/put","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Unbookmark a post in the feed","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2_as_a_user","scopes":["feeds.engage"],"type":"oauth2","description":"OAuth2 for Users (Authorization Code grant flow)","flows":{"authorizationCode":{"authorizationUrl":"IAM_DOMAIN/oauth/authorize","tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","openid":"Authenticate your account using OpenID.","public":"View public information.","feeds.read":"View your feeds.","feeds.rendered.read":"View rendered content from feed posts.","feeds.engage":"View your feeds and engage with posts (likes, bookmarks, etc).","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","assistant.inbox.read":"View and list details of your assistant inbox items.","notification_center":"View and list notification center items.","data_exports.read":"View and download data export files in your program."}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"content_id","in":"path","schemaId":"schema_106","description":"ID of the post. The post must be visible to the user.","required":true}],"pointer":"/paths/~1v2~1feed~1posts~1{content_id}~1unbookmark/put/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v2/feed/posts/{content_id}/unbookmark","servers":[{"url":"https://partner.socialchorus.com","description":"US1"},{"url":"https://partner.us2.onfirstup.com","description":"US2"},{"url":"https://partner.onfirstup.eu","description":"EU"}],"parameters":{"path":[{"name":"content_id","in":"path","required":true,"schemaId":"schema_106"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2_as_a_user","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"IAM_DOMAIN/oauth/authorize","tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","openid":"Authenticate your account using OpenID.","public":"View public information.","feeds.read":"View your feeds.","feeds.rendered.read":"View rendered content from feed posts.","feeds.engage":"View your feeds and engage with posts (likes, bookmarks, etc).","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","assistant.inbox.read":"View and list details of your assistant inbox items.","notification_center":"View and list notification center items.","data_exports.read":"View and download data export files in your program."}}}}],"scopes":["feeds.engage"]}],"responseCodes":["204","400","401","404"],"pointer":"/v2/feed/posts/{content_id}/unbookmark","href":"feeds/unbookmarkpost","openApiOperationId":"unbookmarkPost","summary":"Unbookmark a post in the feed"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://partner.socialchorus.com","description":"US1"},{"url":"https://partner.us2.onfirstup.com","description":"US2"},{"url":"https://partner.onfirstup.eu","description":"EU"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Feed Post Unbookmarked"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}},"schemaId":"schema_101"},{"code":"401","description":"Unauthenticated","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}},"schemaId":"schema_101"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}},"schemaId":"schema_101"}],"pointer":"/paths/~1v2~1feed~1posts~1{content_id}~1unbookmark/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"schema_101","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}}},{"code":"401","schemaId":"schema_101","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}}},{"code":"404","schemaId":"schema_101","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/feeds/unbookmarkpost"}],"panels":[]}]},"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"generateTrackableUrl","name":"Get the trackable URL for a post in the feed","isWebhook":false,"pointer":"/paths/~1v2~1feed~1posts~1{content_id}~1share~1trackable_url/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get the trackable URL for a post in the feed","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"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.\n"},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"content_id","in":"path","schemaId":"schema_106","description":"ID of the post. The post must be visible to the user.","required":true}],"pointer":"/paths/~1v2~1feed~1posts~1{content_id}~1share~1trackable_url/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/feed/posts/{content_id}/share/trackable_url","servers":[{"url":"https://partner.socialchorus.com","description":"US1"},{"url":"https://partner.us2.onfirstup.com","description":"US2"},{"url":"https://partner.onfirstup.eu","description":"EU"}],"parameters":{"path":[{"name":"content_id","in":"path","required":true,"schemaId":"schema_106"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","404"],"pointer":"/v2/feed/posts/{content_id}/share/trackable_url","href":"feeds/generatetrackableurl","openApiOperationId":"generateTrackableUrl","summary":"Get the trackable URL for a post in the feed"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://partner.socialchorus.com","description":"US1"},{"url":"https://partner.us2.onfirstup.com","description":"US2"},{"url":"https://partner.onfirstup.eu","description":"EU"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Feed Post trackable URL","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_149"}},"schemaId":"schema_149"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}},"schemaId":"schema_101"},{"code":"401","description":"Unauthenticated","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}},"schemaId":"schema_101"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}},"schemaId":"schema_101"}],"pointer":"/paths/~1v2~1feed~1posts~1{content_id}~1share~1trackable_url/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_149","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_149"}}},{"code":"400","schemaId":"schema_101","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}}},{"code":"401","schemaId":"schema_101","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}}},{"code":"404","schemaId":"schema_101","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/feeds/generatetrackableurl"}],"panels":[]}]},"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  the trackable URL for a post in the feed."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"sharePost","name":"Share a post in the feed","isWebhook":false,"pointer":"/paths/~1v2~1feed~1posts~1{content_id}~1share/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Share a post in the feed","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"share_url"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can be retrieved using "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"/endpoints/openapi/feeds/generatetrackableurl"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the trackable URL for a post in the feed"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2_as_a_user","scopes":["feeds.engage"],"type":"oauth2","description":"OAuth2 for Users (Authorization Code grant flow)","flows":{"authorizationCode":{"authorizationUrl":"IAM_DOMAIN/oauth/authorize","tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","openid":"Authenticate your account using OpenID.","public":"View public information.","feeds.read":"View your feeds.","feeds.rendered.read":"View rendered content from feed posts.","feeds.engage":"View your feeds and engage with posts (likes, bookmarks, etc).","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","assistant.inbox.read":"View and list details of your assistant inbox items.","notification_center":"View and list notification center items.","data_exports.read":"View and download data export files in your program."}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"content_id","in":"path","schemaId":"schema_106","description":"ID of the post. The post must be visible to the user.","required":true}],"pointer":"/paths/~1v2~1feed~1posts~1{content_id}~1share/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_150"}},"schemaId":"schema_150","pointer":"/paths/~1v2~1feed~1posts~1{content_id}~1share/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v2/feed/posts/{content_id}/share","servers":[{"url":"https://partner.socialchorus.com","description":"US1"},{"url":"https://partner.us2.onfirstup.com","description":"US2"},{"url":"https://partner.onfirstup.eu","description":"EU"}],"parameters":{"path":[{"name":"content_id","in":"path","required":true,"schemaId":"schema_106"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2_as_a_user","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"IAM_DOMAIN/oauth/authorize","tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","openid":"Authenticate your account using OpenID.","public":"View public information.","feeds.read":"View your feeds.","feeds.rendered.read":"View rendered content from feed posts.","feeds.engage":"View your feeds and engage with posts (likes, bookmarks, etc).","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","assistant.inbox.read":"View and list details of your assistant inbox items.","notification_center":"View and list notification center items.","data_exports.read":"View and download data export files in your program."}}}}],"scopes":["feeds.engage"]}],"requestBody":{"application/json":{"schemaId":"schema_150"}},"responseCodes":["204","400","401","404"],"pointer":"/v2/feed/posts/{content_id}/share","href":"feeds/sharepost","openApiOperationId":"sharePost","summary":"Share a post in the feed"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://partner.socialchorus.com","description":"US1"},{"url":"https://partner.us2.onfirstup.com","description":"US2"},{"url":"https://partner.onfirstup.eu","description":"EU"}],"schemaId":"schema_150","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_150"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Feed Post share intent is recorded"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}},"schemaId":"schema_101"},{"code":"401","description":"Unauthenticated","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}},"schemaId":"schema_101"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}},"schemaId":"schema_101"}],"pointer":"/paths/~1v2~1feed~1posts~1{content_id}~1share/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"schema_101","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}}},{"code":"401","schemaId":"schema_101","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}}},{"code":"404","schemaId":"schema_101","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/feeds/sharepost"}],"panels":[]}]},"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"viewPost","name":"View a post in the feed","isWebhook":false,"pointer":"/paths/~1v2~1feed~1posts~1{content_id}~1view/put","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"View a post in the feed","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"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.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2_as_a_user","scopes":["feeds.engage"],"type":"oauth2","description":"OAuth2 for Users (Authorization Code grant flow)","flows":{"authorizationCode":{"authorizationUrl":"IAM_DOMAIN/oauth/authorize","tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","openid":"Authenticate your account using OpenID.","public":"View public information.","feeds.read":"View your feeds.","feeds.rendered.read":"View rendered content from feed posts.","feeds.engage":"View your feeds and engage with posts (likes, bookmarks, etc).","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","assistant.inbox.read":"View and list details of your assistant inbox items.","notification_center":"View and list notification center items.","data_exports.read":"View and download data export files in your program."}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"content_id","in":"path","schemaId":"schema_106","description":"ID of the post. The post must be visible to the user.","required":true}],"pointer":"/paths/~1v2~1feed~1posts~1{content_id}~1view/put/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v2/feed/posts/{content_id}/view","servers":[{"url":"https://partner.socialchorus.com","description":"US1"},{"url":"https://partner.us2.onfirstup.com","description":"US2"},{"url":"https://partner.onfirstup.eu","description":"EU"}],"parameters":{"path":[{"name":"content_id","in":"path","required":true,"schemaId":"schema_106"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2_as_a_user","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"IAM_DOMAIN/oauth/authorize","tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","openid":"Authenticate your account using OpenID.","public":"View public information.","feeds.read":"View your feeds.","feeds.rendered.read":"View rendered content from feed posts.","feeds.engage":"View your feeds and engage with posts (likes, bookmarks, etc).","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","assistant.inbox.read":"View and list details of your assistant inbox items.","notification_center":"View and list notification center items.","data_exports.read":"View and download data export files in your program."}}}}],"scopes":["feeds.engage"]}],"responseCodes":["204","400","401","404"],"pointer":"/v2/feed/posts/{content_id}/view","href":"feeds/viewpost","openApiOperationId":"viewPost","summary":"View a post in the feed"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://partner.socialchorus.com","description":"US1"},{"url":"https://partner.us2.onfirstup.com","description":"US2"},{"url":"https://partner.onfirstup.eu","description":"EU"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Feed Post Viewed"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}},"schemaId":"schema_101"},{"code":"401","description":"Unauthenticated","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}},"schemaId":"schema_101"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}},"schemaId":"schema_101"}],"pointer":"/paths/~1v2~1feed~1posts~1{content_id}~1view/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"schema_101","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}}},{"code":"401","schemaId":"schema_101","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}}},{"code":"404","schemaId":"schema_101","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/feeds/viewpost"}],"panels":[]}]},"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"unviewPost","name":"Unview a post in the feed","isWebhook":false,"pointer":"/paths/~1v2~1feed~1posts~1{content_id}~1unview/put","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Unview a post in the feed","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"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.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2_as_a_user","scopes":["feeds.engage"],"type":"oauth2","description":"OAuth2 for Users (Authorization Code grant flow)","flows":{"authorizationCode":{"authorizationUrl":"IAM_DOMAIN/oauth/authorize","tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","openid":"Authenticate your account using OpenID.","public":"View public information.","feeds.read":"View your feeds.","feeds.rendered.read":"View rendered content from feed posts.","feeds.engage":"View your feeds and engage with posts (likes, bookmarks, etc).","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","assistant.inbox.read":"View and list details of your assistant inbox items.","notification_center":"View and list notification center items.","data_exports.read":"View and download data export files in your program."}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"content_id","in":"path","schemaId":"schema_106","description":"ID of the post. The post must be visible to the user.","required":true}],"pointer":"/paths/~1v2~1feed~1posts~1{content_id}~1unview/put/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v2/feed/posts/{content_id}/unview","servers":[{"url":"https://partner.socialchorus.com","description":"US1"},{"url":"https://partner.us2.onfirstup.com","description":"US2"},{"url":"https://partner.onfirstup.eu","description":"EU"}],"parameters":{"path":[{"name":"content_id","in":"path","required":true,"schemaId":"schema_106"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2_as_a_user","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"IAM_DOMAIN/oauth/authorize","tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","openid":"Authenticate your account using OpenID.","public":"View public information.","feeds.read":"View your feeds.","feeds.rendered.read":"View rendered content from feed posts.","feeds.engage":"View your feeds and engage with posts (likes, bookmarks, etc).","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","assistant.inbox.read":"View and list details of your assistant inbox items.","notification_center":"View and list notification center items.","data_exports.read":"View and download data export files in your program."}}}}],"scopes":["feeds.engage"]}],"responseCodes":["204","400","401","404"],"pointer":"/v2/feed/posts/{content_id}/unview","href":"feeds/unviewpost","openApiOperationId":"unviewPost","summary":"Unview a post in the feed"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://partner.socialchorus.com","description":"US1"},{"url":"https://partner.us2.onfirstup.com","description":"US2"},{"url":"https://partner.onfirstup.eu","description":"EU"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Feed Post Unviewed"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}},"schemaId":"schema_101"},{"code":"401","description":"Unauthenticated","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}},"schemaId":"schema_101"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}},"schemaId":"schema_101"}],"pointer":"/paths/~1v2~1feed~1posts~1{content_id}~1unview/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"schema_101","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}}},{"code":"401","schemaId":"schema_101","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}}},{"code":"404","schemaId":"schema_101","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/feeds/unviewpost"}],"panels":[]}]},"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.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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listFeedPostComments","name":"List the comments on a content post","isWebhook":false,"pointer":"/paths/~1v2~1feed~1posts~1{content_id}~1comments/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List the comments on a content post","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When a comment with user mentions is returned, it will be returned with those mentions in the format of either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{ref:user:<user_id>}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{ref:user::id:<user_id>}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". 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."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2_as_a_user","scopes":["feeds.read"],"type":"oauth2","description":"OAuth2 for Users (Authorization Code grant flow)","flows":{"authorizationCode":{"authorizationUrl":"IAM_DOMAIN/oauth/authorize","tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","openid":"Authenticate your account using OpenID.","public":"View public information.","feeds.read":"View your feeds.","feeds.rendered.read":"View rendered content from feed posts.","feeds.engage":"View your feeds and engage with posts (likes, bookmarks, etc).","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","assistant.inbox.read":"View and list details of your assistant inbox items.","notification_center":"View and list notification center items.","data_exports.read":"View and download data export files in your program."}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"content_id","in":"path","schemaId":"schema_106","description":"ID or UUID of the content post","required":true}],"pointer":"/paths/~1v2~1feed~1posts~1{content_id}~1comments/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page.size","in":"query","schemaId":"schema_103","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Return "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"page.size"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" number of records starting at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"size*number"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The default page size is 10 (number of records per page), resulting in the first page being retrieved. The maximum page size is 100."},"children":[]}]}]}]},{"name":"page.number","in":"query","schemaId":"schema_103","description":"Using classical pagination, the page number to return. Default is 1"}],"pointer":"/paths/~1v2~1feed~1posts~1{content_id}~1comments/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/feed/posts/{content_id}/comments","servers":[{"url":"https://partner.socialchorus.com","description":"US1"},{"url":"https://partner.us2.onfirstup.com","description":"US2"},{"url":"https://partner.onfirstup.eu","description":"EU"}],"parameters":{"path":[{"name":"content_id","in":"path","required":true,"schemaId":"schema_106"}],"query":[{"name":"page.size","in":"query","required":false,"schemaId":"schema_103"},{"name":"page.number","in":"query","required":false,"schemaId":"schema_103"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2_as_a_user","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"IAM_DOMAIN/oauth/authorize","tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","openid":"Authenticate your account using OpenID.","public":"View public information.","feeds.read":"View your feeds.","feeds.rendered.read":"View rendered content from feed posts.","feeds.engage":"View your feeds and engage with posts (likes, bookmarks, etc).","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","assistant.inbox.read":"View and list details of your assistant inbox items.","notification_center":"View and list notification center items.","data_exports.read":"View and download data export files in your program."}}}}],"scopes":["feeds.read"]}],"responseCodes":["200","400","401","403"],"pointer":"/v2/feed/posts/{content_id}/comments","href":"feeds/listfeedpostcomments","openApiOperationId":"listFeedPostComments","summary":"List the comments on a content post"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://partner.socialchorus.com","description":"US1"},{"url":"https://partner.us2.onfirstup.com","description":"US2"},{"url":"https://partner.onfirstup.eu","description":"EU"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_151"}},"schemaId":"schema_151"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}},"schemaId":"schema_101"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthenticated. See more on error responses "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://developers.firstup.io/gettingstarted/error_responses"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_120"}},"schemaId":"schema_120"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized. See more on error responses "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://developers.firstup.io/gettingstarted/error_responses"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_121"}},"schemaId":"schema_121"}],"pointer":"/paths/~1v2~1feed~1posts~1{content_id}~1comments/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_151","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_151"}}},{"code":"400","schemaId":"schema_101","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}}},{"code":"401","schemaId":"schema_120","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_120"}}},{"code":"403","schemaId":"schema_121","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_121"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/feeds/listfeedpostcomments"}],"panels":[]}]},"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>}."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createFeedPostComment","name":"Comment on a post in the feed","isWebhook":false,"pointer":"/paths/~1v2~1feed~1posts~1{content_id}~1comments/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Comment on a post in the feed","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates a new comment record for the content post."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You may indicate a mention of a specific user by providing their "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"user_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the format of either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{ref:user:<user_id>}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{ref:user::id:<user_id>}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2_as_a_user","scopes":["feeds.engage"],"type":"oauth2","description":"OAuth2 for Users (Authorization Code grant flow)","flows":{"authorizationCode":{"authorizationUrl":"IAM_DOMAIN/oauth/authorize","tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","openid":"Authenticate your account using OpenID.","public":"View public information.","feeds.read":"View your feeds.","feeds.rendered.read":"View rendered content from feed posts.","feeds.engage":"View your feeds and engage with posts (likes, bookmarks, etc).","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","assistant.inbox.read":"View and list details of your assistant inbox items.","notification_center":"View and list notification center items.","data_exports.read":"View and download data export files in your program."}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"content_id","in":"path","schemaId":"schema_106","description":"ID or UUID of the content post","required":true}],"pointer":"/paths/~1v2~1feed~1posts~1{content_id}~1comments/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_152"}},"schemaId":"schema_152","pointer":"/paths/~1v2~1feed~1posts~1{content_id}~1comments/post/requestBody","description":"Comment data"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/feed/posts/{content_id}/comments","servers":[{"url":"https://partner.socialchorus.com","description":"US1"},{"url":"https://partner.us2.onfirstup.com","description":"US2"},{"url":"https://partner.onfirstup.eu","description":"EU"}],"parameters":{"path":[{"name":"content_id","in":"path","required":true,"schemaId":"schema_106"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2_as_a_user","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"IAM_DOMAIN/oauth/authorize","tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","openid":"Authenticate your account using OpenID.","public":"View public information.","feeds.read":"View your feeds.","feeds.rendered.read":"View rendered content from feed posts.","feeds.engage":"View your feeds and engage with posts (likes, bookmarks, etc).","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","assistant.inbox.read":"View and list details of your assistant inbox items.","notification_center":"View and list notification center items.","data_exports.read":"View and download data export files in your program."}}}}],"scopes":["feeds.engage"]}],"requestBody":{"application/json":{"schemaId":"schema_152"}},"responseCodes":["200","400","401","403"],"pointer":"/v2/feed/posts/{content_id}/comments","href":"feeds/createfeedpostcomment","openApiOperationId":"createFeedPostComment","summary":"Comment on a post in the feed"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://partner.socialchorus.com","description":"US1"},{"url":"https://partner.us2.onfirstup.com","description":"US2"},{"url":"https://partner.onfirstup.eu","description":"EU"}],"schemaId":"schema_152","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_152"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_153"}},"schemaId":"schema_153"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}},"schemaId":"schema_101"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthenticated. See more on error responses "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://developers.firstup.io/gettingstarted/error_responses"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_120"}},"schemaId":"schema_120"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized. See more on error responses "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://developers.firstup.io/gettingstarted/error_responses"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_121"}},"schemaId":"schema_121"}],"pointer":"/paths/~1v2~1feed~1posts~1{content_id}~1comments/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_153","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_153"}}},{"code":"400","schemaId":"schema_101","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}}},{"code":"401","schemaId":"schema_120","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_120"}}},{"code":"403","schemaId":"schema_121","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_121"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/feeds/createfeedpostcomment"}],"panels":[]}]},"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.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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listFeedPostCommentReplies","name":"List the replies to a comment on a content post","isWebhook":false,"pointer":"/paths/~1v2~1feed~1posts~1{content_id}~1comments~1{comment_id}~1replies/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List the replies to a comment on a content post","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List the replies to a comment on a content post. Upon enabling expanded reactions types, the response will include the additional reaction types."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When a comment with user mentions is returned, it will be returned with those mentions in the format of either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{ref:user:<user_id>}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{ref:user::id:<user_id>}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". 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."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2_as_a_user","scopes":["feeds.read"],"type":"oauth2","description":"OAuth2 for Users (Authorization Code grant flow)","flows":{"authorizationCode":{"authorizationUrl":"IAM_DOMAIN/oauth/authorize","tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","openid":"Authenticate your account using OpenID.","public":"View public information.","feeds.read":"View your feeds.","feeds.rendered.read":"View rendered content from feed posts.","feeds.engage":"View your feeds and engage with posts (likes, bookmarks, etc).","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","assistant.inbox.read":"View and list details of your assistant inbox items.","notification_center":"View and list notification center items.","data_exports.read":"View and download data export files in your program."}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"content_id","in":"path","schemaId":"schema_106","description":"ID or UUID of the content post","required":true},{"name":"comment_id","in":"path","schemaId":"schema_128","description":"ID or UUID of the comment","required":true}],"pointer":"/paths/~1v2~1feed~1posts~1{content_id}~1comments~1{comment_id}~1replies/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page.size","in":"query","schemaId":"schema_103","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Return "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"page.size"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" number of records starting at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"size*number"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The default page size is 10 (number of records per page), resulting in the first page being retrieved. The maximum page size is 100."},"children":[]}]}]}]},{"name":"page.number","in":"query","schemaId":"schema_103","description":"Using classical pagination, the page number to return. Default is 1"}],"pointer":"/paths/~1v2~1feed~1posts~1{content_id}~1comments~1{comment_id}~1replies/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/feed/posts/{content_id}/comments/{comment_id}/replies","servers":[{"url":"https://partner.socialchorus.com","description":"US1"},{"url":"https://partner.us2.onfirstup.com","description":"US2"},{"url":"https://partner.onfirstup.eu","description":"EU"}],"parameters":{"path":[{"name":"content_id","in":"path","required":true,"schemaId":"schema_106"},{"name":"comment_id","in":"path","required":true,"schemaId":"schema_128"}],"query":[{"name":"page.size","in":"query","required":false,"schemaId":"schema_103"},{"name":"page.number","in":"query","required":false,"schemaId":"schema_103"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2_as_a_user","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"IAM_DOMAIN/oauth/authorize","tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","openid":"Authenticate your account using OpenID.","public":"View public information.","feeds.read":"View your feeds.","feeds.rendered.read":"View rendered content from feed posts.","feeds.engage":"View your feeds and engage with posts (likes, bookmarks, etc).","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","assistant.inbox.read":"View and list details of your assistant inbox items.","notification_center":"View and list notification center items.","data_exports.read":"View and download data export files in your program."}}}}],"scopes":["feeds.read"]}],"responseCodes":["200","400","401","403"],"pointer":"/v2/feed/posts/{content_id}/comments/{comment_id}/replies","href":"feeds/listfeedpostcommentreplies","openApiOperationId":"listFeedPostCommentReplies","summary":"List the replies to a comment on a content post"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://partner.socialchorus.com","description":"US1"},{"url":"https://partner.us2.onfirstup.com","description":"US2"},{"url":"https://partner.onfirstup.eu","description":"EU"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_151"}},"schemaId":"schema_151"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}},"schemaId":"schema_101"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthenticated. See more on error responses "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://developers.firstup.io/gettingstarted/error_responses"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_120"}},"schemaId":"schema_120"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized. See more on error responses "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://developers.firstup.io/gettingstarted/error_responses"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_121"}},"schemaId":"schema_121"}],"pointer":"/paths/~1v2~1feed~1posts~1{content_id}~1comments~1{comment_id}~1replies/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_151","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_151"}}},{"code":"400","schemaId":"schema_101","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}}},{"code":"401","schemaId":"schema_120","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_120"}}},{"code":"403","schemaId":"schema_121","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_121"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/feeds/listfeedpostcommentreplies"}],"panels":[]}]},"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. 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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createFeedPostCommentReply","name":"Reply to a comment on a post in the feed","isWebhook":false,"pointer":"/paths/~1v2~1feed~1posts~1{content_id}~1comments~1{comment_id}~1{post_number}~1replies/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Reply to a comment on a post in the feed","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Upon enabling expanded reactions types, the response will include the additional reaction types. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When a comment with user mentions is returned, it will be returned with those mentions in the format of either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{ref:user:<user_id>}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{ref:user::id:<user_id>}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". 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."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2_as_a_user","scopes":["feeds.engage"],"type":"oauth2","description":"OAuth2 for Users (Authorization Code grant flow)","flows":{"authorizationCode":{"authorizationUrl":"IAM_DOMAIN/oauth/authorize","tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","openid":"Authenticate your account using OpenID.","public":"View public information.","feeds.read":"View your feeds.","feeds.rendered.read":"View rendered content from feed posts.","feeds.engage":"View your feeds and engage with posts (likes, bookmarks, etc).","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","assistant.inbox.read":"View and list details of your assistant inbox items.","notification_center":"View and list notification center items.","data_exports.read":"View and download data export files in your program."}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"content_id","in":"path","schemaId":"schema_106","description":"ID or UUID of the content post","required":true},{"name":"comment_id","in":"path","schemaId":"schema_128","description":"ID or UUID of the comment to reply to","required":true},{"name":"post_number","in":"path","schemaId":"schema_106","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"post_number of the comment to reply to"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1v2~1feed~1posts~1{content_id}~1comments~1{comment_id}~1{post_number}~1replies/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_154"}},"schemaId":"schema_154","pointer":"/paths/~1v2~1feed~1posts~1{content_id}~1comments~1{comment_id}~1{post_number}~1replies/post/requestBody","description":"Comment data"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/feed/posts/{content_id}/comments/{comment_id}/{post_number}/replies","servers":[{"url":"https://partner.socialchorus.com","description":"US1"},{"url":"https://partner.us2.onfirstup.com","description":"US2"},{"url":"https://partner.onfirstup.eu","description":"EU"}],"parameters":{"path":[{"name":"content_id","in":"path","required":true,"schemaId":"schema_106"},{"name":"comment_id","in":"path","required":true,"schemaId":"schema_128"},{"name":"post_number","in":"path","required":true,"schemaId":"schema_106"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2_as_a_user","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"IAM_DOMAIN/oauth/authorize","tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","openid":"Authenticate your account using OpenID.","public":"View public information.","feeds.read":"View your feeds.","feeds.rendered.read":"View rendered content from feed posts.","feeds.engage":"View your feeds and engage with posts (likes, bookmarks, etc).","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","assistant.inbox.read":"View and list details of your assistant inbox items.","notification_center":"View and list notification center items.","data_exports.read":"View and download data export files in your program."}}}}],"scopes":["feeds.engage"]}],"requestBody":{"application/json":{"schemaId":"schema_154"}},"responseCodes":["200","400","401","403"],"pointer":"/v2/feed/posts/{content_id}/comments/{comment_id}/{post_number}/replies","href":"feeds/createfeedpostcommentreply","openApiOperationId":"createFeedPostCommentReply","summary":"Reply to a comment on a post in the feed"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://partner.socialchorus.com","description":"US1"},{"url":"https://partner.us2.onfirstup.com","description":"US2"},{"url":"https://partner.onfirstup.eu","description":"EU"}],"schemaId":"schema_154","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_154"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_153"}},"schemaId":"schema_153"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}},"schemaId":"schema_101"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthenticated. See more on error responses "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://developers.firstup.io/gettingstarted/error_responses"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_120"}},"schemaId":"schema_120"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized. See more on error responses "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://developers.firstup.io/gettingstarted/error_responses"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_121"}},"schemaId":"schema_121"}],"pointer":"/paths/~1v2~1feed~1posts~1{content_id}~1comments~1{comment_id}~1{post_number}~1replies/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_153","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_153"}}},{"code":"400","schemaId":"schema_101","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}}},{"code":"401","schemaId":"schema_120","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_120"}}},{"code":"403","schemaId":"schema_121","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_121"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/feeds/createfeedpostcommentreply"}],"panels":[]}]},"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"reportFeedPostComment","name":"Report a Comment or Reply for a given post in the feed","isWebhook":false,"pointer":"/paths/~1v2~1feed~1posts~1{content_id}~1comments~1{comment_id}~1report/put","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Report a Comment or Reply for a given post in the feed","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"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.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2_as_a_user","scopes":["feeds.engage"],"type":"oauth2","description":"OAuth2 for Users (Authorization Code grant flow)","flows":{"authorizationCode":{"authorizationUrl":"IAM_DOMAIN/oauth/authorize","tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","openid":"Authenticate your account using OpenID.","public":"View public information.","feeds.read":"View your feeds.","feeds.rendered.read":"View rendered content from feed posts.","feeds.engage":"View your feeds and engage with posts (likes, bookmarks, etc).","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","assistant.inbox.read":"View and list details of your assistant inbox items.","notification_center":"View and list notification center items.","data_exports.read":"View and download data export files in your program."}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"content_id","in":"path","schemaId":"schema_106","description":"ID of the post. The post must be visible to the user.","required":true},{"name":"comment_id","in":"path","schemaId":"schema_128","description":"ID or UUID of the comment to report","required":true}],"pointer":"/paths/~1v2~1feed~1posts~1{content_id}~1comments~1{comment_id}~1report/put/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v2/feed/posts/{content_id}/comments/{comment_id}/report","servers":[{"url":"https://partner.socialchorus.com","description":"US1"},{"url":"https://partner.us2.onfirstup.com","description":"US2"},{"url":"https://partner.onfirstup.eu","description":"EU"}],"parameters":{"path":[{"name":"content_id","in":"path","required":true,"schemaId":"schema_106"},{"name":"comment_id","in":"path","required":true,"schemaId":"schema_128"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2_as_a_user","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"IAM_DOMAIN/oauth/authorize","tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","openid":"Authenticate your account using OpenID.","public":"View public information.","feeds.read":"View your feeds.","feeds.rendered.read":"View rendered content from feed posts.","feeds.engage":"View your feeds and engage with posts (likes, bookmarks, etc).","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","assistant.inbox.read":"View and list details of your assistant inbox items.","notification_center":"View and list notification center items.","data_exports.read":"View and download data export files in your program."}}}}],"scopes":["feeds.engage"]}],"responseCodes":["204","400","401","404"],"pointer":"/v2/feed/posts/{content_id}/comments/{comment_id}/report","href":"feeds/reportfeedpostcomment","openApiOperationId":"reportFeedPostComment","summary":"Report a Comment or Reply for a given post in the feed"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://partner.socialchorus.com","description":"US1"},{"url":"https://partner.us2.onfirstup.com","description":"US2"},{"url":"https://partner.onfirstup.eu","description":"EU"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Comment Has Been Reported"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}},"schemaId":"schema_101"},{"code":"401","description":"Unauthenticated","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}},"schemaId":"schema_101"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}},"schemaId":"schema_101"}],"pointer":"/paths/~1v2~1feed~1posts~1{content_id}~1comments~1{comment_id}~1report/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"schema_101","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}}},{"code":"401","schemaId":"schema_101","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}}},{"code":"404","schemaId":"schema_101","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/feeds/reportfeedpostcomment"}],"panels":[]}]},"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"suggestUser","name":"Query for users that are able to be mentioned.","isWebhook":false,"pointer":"/paths/~1v2~1feed~1users~1suggest/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Query for users that are able to be mentioned.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Query for users that are able to be mentioned."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2_as_a_user","scopes":["feeds.engage"],"type":"oauth2","description":"OAuth2 for Users (Authorization Code grant flow)","flows":{"authorizationCode":{"authorizationUrl":"IAM_DOMAIN/oauth/authorize","tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","openid":"Authenticate your account using OpenID.","public":"View public information.","feeds.read":"View your feeds.","feeds.rendered.read":"View rendered content from feed posts.","feeds.engage":"View your feeds and engage with posts (likes, bookmarks, etc).","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","assistant.inbox.read":"View and list details of your assistant inbox items.","notification_center":"View and list notification center items.","data_exports.read":"View and download data export files in your program."}}}}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"search","in":"query","schemaId":"schema_115","description":"String to match mentionable users' data.","required":true}],"pointer":"/paths/~1v2~1feed~1users~1suggest/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/feed/users/suggest","servers":[{"url":"https://partner.socialchorus.com","description":"US1"},{"url":"https://partner.us2.onfirstup.com","description":"US2"},{"url":"https://partner.onfirstup.eu","description":"EU"}],"parameters":{"path":[],"query":[{"name":"search","in":"query","required":true,"schemaId":"schema_115"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2_as_a_user","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"IAM_DOMAIN/oauth/authorize","tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","openid":"Authenticate your account using OpenID.","public":"View public information.","feeds.read":"View your feeds.","feeds.rendered.read":"View rendered content from feed posts.","feeds.engage":"View your feeds and engage with posts (likes, bookmarks, etc).","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","assistant.inbox.read":"View and list details of your assistant inbox items.","notification_center":"View and list notification center items.","data_exports.read":"View and download data export files in your program."}}}}],"scopes":["feeds.engage"]}],"responseCodes":["200","400","401","403","404"],"pointer":"/v2/feed/users/suggest","href":"feeds/suggestuser","openApiOperationId":"suggestUser","summary":"Query for users that are able to be mentioned."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://partner.socialchorus.com","description":"US1"},{"url":"https://partner.us2.onfirstup.com","description":"US2"},{"url":"https://partner.onfirstup.eu","description":"EU"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_155"}},"schemaId":"schema_155"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}},"schemaId":"schema_101"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthenticated. See more on error responses "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://developers.firstup.io/gettingstarted/error_responses"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_120"}},"schemaId":"schema_120"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized. See more on error responses "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://developers.firstup.io/gettingstarted/error_responses"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_121"}},"schemaId":"schema_121"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}},"schemaId":"schema_101"}],"pointer":"/paths/~1v2~1feed~1users~1suggest/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_155","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_155"}}},{"code":"400","schemaId":"schema_101","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}}},{"code":"401","schemaId":"schema_120","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_120"}}},{"code":"403","schemaId":"schema_121","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_121"}}},{"code":"404","schemaId":"schema_101","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/feeds/suggestuser"}],"panels":[]}]},"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.  Response body data will be the updated record. Upon enabling expanded reactions types, the response will include the additional reaction types.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>}."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateFeedPostComment","name":"Update a comment on a post in the feed","isWebhook":false,"pointer":"/paths/~1v2~1feed~1posts~1{content_id}~1comments~1{comment_id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a comment on a post in the feed","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Update an existing comment record. The body attribute can be provided and only those provided will be updated. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Response body data will be the updated record. Upon enabling expanded reactions types, the response will include the additional reaction types."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You may indicate a mention of a specific user by providing their "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"user_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the format of either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{ref:user:<user_id>}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{ref:user::id:<user_id>}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2_as_a_user","scopes":["feeds.engage"],"type":"oauth2","description":"OAuth2 for Users (Authorization Code grant flow)","flows":{"authorizationCode":{"authorizationUrl":"IAM_DOMAIN/oauth/authorize","tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","openid":"Authenticate your account using OpenID.","public":"View public information.","feeds.read":"View your feeds.","feeds.rendered.read":"View rendered content from feed posts.","feeds.engage":"View your feeds and engage with posts (likes, bookmarks, etc).","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","assistant.inbox.read":"View and list details of your assistant inbox items.","notification_center":"View and list notification center items.","data_exports.read":"View and download data export files in your program."}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"content_id","in":"path","schemaId":"schema_106","description":"ID or UUID of the content post.","required":true},{"name":"comment_id","in":"path","schemaId":"schema_128","description":"ID or UUID of the comment post","required":true}],"pointer":"/paths/~1v2~1feed~1posts~1{content_id}~1comments~1{comment_id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_156"}},"schemaId":"schema_156","pointer":"/paths/~1v2~1feed~1posts~1{content_id}~1comments~1{comment_id}/put/requestBody","description":"Comment data"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v2/feed/posts/{content_id}/comments/{comment_id}","servers":[{"url":"https://partner.socialchorus.com","description":"US1"},{"url":"https://partner.us2.onfirstup.com","description":"US2"},{"url":"https://partner.onfirstup.eu","description":"EU"}],"parameters":{"path":[{"name":"content_id","in":"path","required":true,"schemaId":"schema_106"},{"name":"comment_id","in":"path","required":true,"schemaId":"schema_128"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2_as_a_user","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"IAM_DOMAIN/oauth/authorize","tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","openid":"Authenticate your account using OpenID.","public":"View public information.","feeds.read":"View your feeds.","feeds.rendered.read":"View rendered content from feed posts.","feeds.engage":"View your feeds and engage with posts (likes, bookmarks, etc).","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","assistant.inbox.read":"View and list details of your assistant inbox items.","notification_center":"View and list notification center items.","data_exports.read":"View and download data export files in your program."}}}}],"scopes":["feeds.engage"]}],"requestBody":{"application/json":{"schemaId":"schema_156"}},"responseCodes":["200","400","401","403","404"],"pointer":"/v2/feed/posts/{content_id}/comments/{comment_id}","href":"feeds/updatefeedpostcomment","openApiOperationId":"updateFeedPostComment","summary":"Update a comment on a post in the feed"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://partner.socialchorus.com","description":"US1"},{"url":"https://partner.us2.onfirstup.com","description":"US2"},{"url":"https://partner.onfirstup.eu","description":"EU"}],"schemaId":"schema_156","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_156"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_157"}},"schemaId":"schema_157"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}},"schemaId":"schema_101"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthenticated. See more on error responses "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://developers.firstup.io/gettingstarted/error_responses"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_120"}},"schemaId":"schema_120"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized. See more on error responses "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://developers.firstup.io/gettingstarted/error_responses"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_121"}},"schemaId":"schema_121"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}},"schemaId":"schema_101"}],"pointer":"/paths/~1v2~1feed~1posts~1{content_id}~1comments~1{comment_id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_157","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_157"}}},{"code":"400","schemaId":"schema_101","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}}},{"code":"401","schemaId":"schema_120","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_120"}}},{"code":"403","schemaId":"schema_121","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_121"}}},{"code":"404","schemaId":"schema_101","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/feeds/updatefeedpostcomment"}],"panels":[]}]},"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteFeedPostComment","name":"Delete a comment or reply on a post in the feed","isWebhook":false,"pointer":"/paths/~1v2~1feed~1posts~1{content_id}~1comments~1{comment_id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a comment or reply on a post in the feed","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Allows an authenticated user to delete a comment or reply they authored.\nThe comment is soft deleted and will no longer appear in feed views.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2_as_a_user","scopes":["feeds.engage"],"type":"oauth2","description":"OAuth2 for Users (Authorization Code grant flow)","flows":{"authorizationCode":{"authorizationUrl":"IAM_DOMAIN/oauth/authorize","tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","openid":"Authenticate your account using OpenID.","public":"View public information.","feeds.read":"View your feeds.","feeds.rendered.read":"View rendered content from feed posts.","feeds.engage":"View your feeds and engage with posts (likes, bookmarks, etc).","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","assistant.inbox.read":"View and list details of your assistant inbox items.","notification_center":"View and list notification center items.","data_exports.read":"View and download data export files in your program."}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"content_id","in":"path","schemaId":"schema_106","description":"ID or UUID of the content post.","required":true},{"name":"comment_id","in":"path","schemaId":"schema_128","description":"ID or UUID of the comment post","required":true}],"pointer":"/paths/~1v2~1feed~1posts~1{content_id}~1comments~1{comment_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v2/feed/posts/{content_id}/comments/{comment_id}","servers":[{"url":"https://partner.socialchorus.com","description":"US1"},{"url":"https://partner.us2.onfirstup.com","description":"US2"},{"url":"https://partner.onfirstup.eu","description":"EU"}],"parameters":{"path":[{"name":"content_id","in":"path","required":true,"schemaId":"schema_106"},{"name":"comment_id","in":"path","required":true,"schemaId":"schema_128"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2_as_a_user","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"IAM_DOMAIN/oauth/authorize","tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","openid":"Authenticate your account using OpenID.","public":"View public information.","feeds.read":"View your feeds.","feeds.rendered.read":"View rendered content from feed posts.","feeds.engage":"View your feeds and engage with posts (likes, bookmarks, etc).","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","assistant.inbox.read":"View and list details of your assistant inbox items.","notification_center":"View and list notification center items.","data_exports.read":"View and download data export files in your program."}}}}],"scopes":["feeds.engage"]}],"responseCodes":["204","400","401","403","404"],"pointer":"/v2/feed/posts/{content_id}/comments/{comment_id}","href":"feeds/deletefeedpostcomment","openApiOperationId":"deleteFeedPostComment","summary":"Delete a comment or reply on a post in the feed"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://partner.socialchorus.com","description":"US1"},{"url":"https://partner.us2.onfirstup.com","description":"US2"},{"url":"https://partner.onfirstup.eu","description":"EU"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Comment Successfully Deleted"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}},"schemaId":"schema_101"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthenticated. See more on error responses "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://developers.firstup.io/gettingstarted/error_responses"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_120"}},"schemaId":"schema_120"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized. See more on error responses "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://developers.firstup.io/gettingstarted/error_responses"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_121"}},"schemaId":"schema_121"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}},"schemaId":"schema_101"}],"pointer":"/paths/~1v2~1feed~1posts~1{content_id}~1comments~1{comment_id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"schema_101","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}}},{"code":"401","schemaId":"schema_120","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_120"}}},{"code":"403","schemaId":"schema_121","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_121"}}},{"code":"404","schemaId":"schema_101","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/feeds/deletefeedpostcomment"}],"panels":[]}]},"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"renderFeedPost","name":"Return the rendered content of a single post within the feed","isWebhook":false,"pointer":"/paths/~1v2~1feed~1posts~1{content_id}~1rendered/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Return the rendered content of a single post within the feed","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2_as_a_user","scopes":["feeds.rendered.read"],"type":"oauth2","description":"OAuth2 for Users (Authorization Code grant flow)","flows":{"authorizationCode":{"authorizationUrl":"IAM_DOMAIN/oauth/authorize","tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","openid":"Authenticate your account using OpenID.","public":"View public information.","feeds.read":"View your feeds.","feeds.rendered.read":"View rendered content from feed posts.","feeds.engage":"View your feeds and engage with posts (likes, bookmarks, etc).","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","assistant.inbox.read":"View and list details of your assistant inbox items.","notification_center":"View and list notification center items.","data_exports.read":"View and download data export files in your program."}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"content_id","in":"path","schemaId":"schema_106","description":"ID of the post","required":true}],"pointer":"/paths/~1v2~1feed~1posts~1{content_id}~1rendered/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"locale","in":"query","schemaId":"schema_115","description":"Locale (for translatable posts)"},{"name":"target_platform","in":"query","schemaId":"schema_158","description":"The target platform the post should be rendered for."}],"pointer":"/paths/~1v2~1feed~1posts~1{content_id}~1rendered/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/feed/posts/{content_id}/rendered","servers":[{"url":"https://partner.socialchorus.com","description":"US1"},{"url":"https://partner.us2.onfirstup.com","description":"US2"},{"url":"https://partner.onfirstup.eu","description":"EU"}],"parameters":{"path":[{"name":"content_id","in":"path","required":true,"schemaId":"schema_106"}],"query":[{"name":"locale","in":"query","required":false,"schemaId":"schema_115"},{"name":"target_platform","in":"query","required":false,"schemaId":"schema_158"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2_as_a_user","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"IAM_DOMAIN/oauth/authorize","tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","openid":"Authenticate your account using OpenID.","public":"View public information.","feeds.read":"View your feeds.","feeds.rendered.read":"View rendered content from feed posts.","feeds.engage":"View your feeds and engage with posts (likes, bookmarks, etc).","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","assistant.inbox.read":"View and list details of your assistant inbox items.","notification_center":"View and list notification center items.","data_exports.read":"View and download data export files in your program."}}}}],"scopes":["feeds.rendered.read"]}],"responseCodes":["200","400","401","404"],"pointer":"/v2/feed/posts/{content_id}/rendered","href":"feeds/renderfeedpost","openApiOperationId":"renderFeedPost","summary":"Return the rendered content of a single post within the feed"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://partner.socialchorus.com","description":"US1"},{"url":"https://partner.us2.onfirstup.com","description":"US2"},{"url":"https://partner.onfirstup.eu","description":"EU"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_159"}},"schemaId":"schema_159"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}},"schemaId":"schema_101"},{"code":"401","description":"Unauthenticated","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}},"schemaId":"schema_101"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}},"schemaId":"schema_101"}],"pointer":"/paths/~1v2~1feed~1posts~1{content_id}~1rendered/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_159","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_159"}}},{"code":"400","schemaId":"schema_101","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}}},{"code":"401","schemaId":"schema_101","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}}},{"code":"404","schemaId":"schema_101","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/feeds/renderfeedpost"}],"panels":[]}]},"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"reportFeedPost","name":"Report a post in the feed","isWebhook":false,"pointer":"/paths/~1v2~1feed~1posts~1{content_id}~1report/put","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Report a post in the feed","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"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.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2_as_a_user","scopes":["feeds.engage"],"type":"oauth2","description":"OAuth2 for Users (Authorization Code grant flow)","flows":{"authorizationCode":{"authorizationUrl":"IAM_DOMAIN/oauth/authorize","tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","openid":"Authenticate your account using OpenID.","public":"View public information.","feeds.read":"View your feeds.","feeds.rendered.read":"View rendered content from feed posts.","feeds.engage":"View your feeds and engage with posts (likes, bookmarks, etc).","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","assistant.inbox.read":"View and list details of your assistant inbox items.","notification_center":"View and list notification center items.","data_exports.read":"View and download data export files in your program."}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"content_id","in":"path","schemaId":"schema_106","description":"ID of the post. The post must be visible to the user.","required":true}],"pointer":"/paths/~1v2~1feed~1posts~1{content_id}~1report/put/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v2/feed/posts/{content_id}/report","servers":[{"url":"https://partner.socialchorus.com","description":"US1"},{"url":"https://partner.us2.onfirstup.com","description":"US2"},{"url":"https://partner.onfirstup.eu","description":"EU"}],"parameters":{"path":[{"name":"content_id","in":"path","required":true,"schemaId":"schema_106"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2_as_a_user","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"IAM_DOMAIN/oauth/authorize","tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","openid":"Authenticate your account using OpenID.","public":"View public information.","feeds.read":"View your feeds.","feeds.rendered.read":"View rendered content from feed posts.","feeds.engage":"View your feeds and engage with posts (likes, bookmarks, etc).","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","assistant.inbox.read":"View and list details of your assistant inbox items.","notification_center":"View and list notification center items.","data_exports.read":"View and download data export files in your program."}}}}],"scopes":["feeds.engage"]}],"responseCodes":["204","400","401","404"],"pointer":"/v2/feed/posts/{content_id}/report","href":"feeds/reportfeedpost","openApiOperationId":"reportFeedPost","summary":"Report a post in the feed"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://partner.socialchorus.com","description":"US1"},{"url":"https://partner.us2.onfirstup.com","description":"US2"},{"url":"https://partner.onfirstup.eu","description":"EU"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Feed Post Reported"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}},"schemaId":"schema_101"},{"code":"401","description":"Unauthenticated","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}},"schemaId":"schema_101"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}},"schemaId":"schema_101"}],"pointer":"/paths/~1v2~1feed~1posts~1{content_id}~1report/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"schema_101","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}}},{"code":"401","schemaId":"schema_101","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}}},{"code":"404","schemaId":"schema_101","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/feeds/reportfeedpost"}],"panels":[]}]},"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"acknowledgeFeedPost","name":"Acknowledge a post in the feed.","isWebhook":false,"pointer":"/paths/~1v2~1feed~1posts~1{content_id}~1acknowledge/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Acknowledge a post in the feed.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"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."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2_as_a_user","scopes":["feeds.engage"],"type":"oauth2","description":"OAuth2 for Users (Authorization Code grant flow)","flows":{"authorizationCode":{"authorizationUrl":"IAM_DOMAIN/oauth/authorize","tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","openid":"Authenticate your account using OpenID.","public":"View public information.","feeds.read":"View your feeds.","feeds.rendered.read":"View rendered content from feed posts.","feeds.engage":"View your feeds and engage with posts (likes, bookmarks, etc).","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","assistant.inbox.read":"View and list details of your assistant inbox items.","notification_center":"View and list notification center items.","data_exports.read":"View and download data export files in your program."}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"content_id","in":"path","schemaId":"schema_106","description":"ID of the post. The post must be visible to the user.","required":true}],"pointer":"/paths/~1v2~1feed~1posts~1{content_id}~1acknowledge/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/feed/posts/{content_id}/acknowledge","servers":[{"url":"https://partner.socialchorus.com","description":"US1"},{"url":"https://partner.us2.onfirstup.com","description":"US2"},{"url":"https://partner.onfirstup.eu","description":"EU"}],"parameters":{"path":[{"name":"content_id","in":"path","required":true,"schemaId":"schema_106"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2_as_a_user","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"IAM_DOMAIN/oauth/authorize","tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","openid":"Authenticate your account using OpenID.","public":"View public information.","feeds.read":"View your feeds.","feeds.rendered.read":"View rendered content from feed posts.","feeds.engage":"View your feeds and engage with posts (likes, bookmarks, etc).","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","assistant.inbox.read":"View and list details of your assistant inbox items.","notification_center":"View and list notification center items.","data_exports.read":"View and download data export files in your program."}}}}],"scopes":["feeds.engage"]}],"responseCodes":["204","400","401","404"],"pointer":"/v2/feed/posts/{content_id}/acknowledge","href":"feeds/acknowledgefeedpost","openApiOperationId":"acknowledgeFeedPost","summary":"Acknowledge a post in the feed."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://partner.socialchorus.com","description":"US1"},{"url":"https://partner.us2.onfirstup.com","description":"US2"},{"url":"https://partner.onfirstup.eu","description":"EU"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Feed Post Acknowledged"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}},"schemaId":"schema_101"},{"code":"401","description":"Unauthenticated","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}},"schemaId":"schema_101"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}},"schemaId":"schema_101"}],"pointer":"/paths/~1v2~1feed~1posts~1{content_id}~1acknowledge/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"schema_101","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}}},{"code":"401","schemaId":"schema_101","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}}},{"code":"404","schemaId":"schema_101","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/feeds/acknowledgefeedpost"}],"panels":[]}]},"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"showFeedPoll","name":"Returns the details of a single poll.","isWebhook":false,"pointer":"/paths/~1v2~1feed~1polls~1{poll_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns the details of a single poll.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Provides data for a single poll."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2_as_a_user","scopes":["feeds.rendered.read"],"type":"oauth2","description":"OAuth2 for Users (Authorization Code grant flow)","flows":{"authorizationCode":{"authorizationUrl":"IAM_DOMAIN/oauth/authorize","tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","openid":"Authenticate your account using OpenID.","public":"View public information.","feeds.read":"View your feeds.","feeds.rendered.read":"View rendered content from feed posts.","feeds.engage":"View your feeds and engage with posts (likes, bookmarks, etc).","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","assistant.inbox.read":"View and list details of your assistant inbox items.","notification_center":"View and list notification center items.","data_exports.read":"View and download data export files in your program."}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"poll_id","in":"path","schemaId":"schema_106","description":"ID of the poll","required":true}],"pointer":"/paths/~1v2~1feed~1polls~1{poll_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/feed/polls/{poll_id}","servers":[{"url":"https://partner.socialchorus.com","description":"US1"},{"url":"https://partner.us2.onfirstup.com","description":"US2"},{"url":"https://partner.onfirstup.eu","description":"EU"}],"parameters":{"path":[{"name":"poll_id","in":"path","required":true,"schemaId":"schema_106"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2_as_a_user","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"IAM_DOMAIN/oauth/authorize","tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","openid":"Authenticate your account using OpenID.","public":"View public information.","feeds.read":"View your feeds.","feeds.rendered.read":"View rendered content from feed posts.","feeds.engage":"View your feeds and engage with posts (likes, bookmarks, etc).","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","assistant.inbox.read":"View and list details of your assistant inbox items.","notification_center":"View and list notification center items.","data_exports.read":"View and download data export files in your program."}}}}],"scopes":["feeds.rendered.read"]}],"responseCodes":["200","400","401","404"],"pointer":"/v2/feed/polls/{poll_id}","href":"feeds/showfeedpoll","openApiOperationId":"showFeedPoll","summary":"Returns the details of a single poll."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://partner.socialchorus.com","description":"US1"},{"url":"https://partner.us2.onfirstup.com","description":"US2"},{"url":"https://partner.onfirstup.eu","description":"EU"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_160"}},"schemaId":"schema_160"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}},"schemaId":"schema_101"},{"code":"401","description":"Unauthenticated","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}},"schemaId":"schema_101"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}},"schemaId":"schema_101"}],"pointer":"/paths/~1v2~1feed~1polls~1{poll_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_160","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_160"}}},{"code":"400","schemaId":"schema_101","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}}},{"code":"401","schemaId":"schema_101","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}}},{"code":"404","schemaId":"schema_101","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/feeds/showfeedpoll"}],"panels":[]}]},"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"respondFeedPoll","name":"Respond to a poll.","isWebhook":false,"pointer":"/paths/~1v2~1feed~1polls~1{poll_id}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Respond to a poll.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Respond to a poll."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2_as_a_user","scopes":["feeds.engage"],"type":"oauth2","description":"OAuth2 for Users (Authorization Code grant flow)","flows":{"authorizationCode":{"authorizationUrl":"IAM_DOMAIN/oauth/authorize","tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","openid":"Authenticate your account using OpenID.","public":"View public information.","feeds.read":"View your feeds.","feeds.rendered.read":"View rendered content from feed posts.","feeds.engage":"View your feeds and engage with posts (likes, bookmarks, etc).","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","assistant.inbox.read":"View and list details of your assistant inbox items.","notification_center":"View and list notification center items.","data_exports.read":"View and download data export files in your program."}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"poll_id","in":"path","schemaId":"schema_106","description":"ID of the poll","required":true}],"pointer":"/paths/~1v2~1feed~1polls~1{poll_id}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_161"}},"schemaId":"schema_161","pointer":"/paths/~1v2~1feed~1polls~1{poll_id}/post/requestBody","description":"Answer data"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/feed/polls/{poll_id}","servers":[{"url":"https://partner.socialchorus.com","description":"US1"},{"url":"https://partner.us2.onfirstup.com","description":"US2"},{"url":"https://partner.onfirstup.eu","description":"EU"}],"parameters":{"path":[{"name":"poll_id","in":"path","required":true,"schemaId":"schema_106"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2_as_a_user","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"IAM_DOMAIN/oauth/authorize","tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","openid":"Authenticate your account using OpenID.","public":"View public information.","feeds.read":"View your feeds.","feeds.rendered.read":"View rendered content from feed posts.","feeds.engage":"View your feeds and engage with posts (likes, bookmarks, etc).","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","assistant.inbox.read":"View and list details of your assistant inbox items.","notification_center":"View and list notification center items.","data_exports.read":"View and download data export files in your program."}}}}],"scopes":["feeds.engage"]}],"requestBody":{"application/json":{"schemaId":"schema_161"}},"responseCodes":["200","400","401","404"],"pointer":"/v2/feed/polls/{poll_id}","href":"feeds/respondfeedpoll","openApiOperationId":"respondFeedPoll","summary":"Respond to a poll."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://partner.socialchorus.com","description":"US1"},{"url":"https://partner.us2.onfirstup.com","description":"US2"},{"url":"https://partner.onfirstup.eu","description":"EU"}],"schemaId":"schema_161","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_161"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_160"}},"schemaId":"schema_160"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}},"schemaId":"schema_101"},{"code":"401","description":"Unauthenticated","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}},"schemaId":"schema_101"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}},"schemaId":"schema_101"}],"pointer":"/paths/~1v2~1feed~1polls~1{poll_id}/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_160","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_160"}}},{"code":"400","schemaId":"schema_101","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}}},{"code":"401","schemaId":"schema_101","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}}},{"code":"404","schemaId":"schema_101","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/feeds/respondfeedpoll"}],"panels":[]}]},"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listFeedPolls","name":"Returns a user's feed of polls.","isWebhook":false,"pointer":"/paths/~1v2~1feed~1polls/get","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a user's feed of polls.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Provides a list of polls in the user's feed."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2_as_a_user","scopes":["feeds.rendered.read"],"type":"oauth2","description":"OAuth2 for Users (Authorization Code grant flow)","flows":{"authorizationCode":{"authorizationUrl":"IAM_DOMAIN/oauth/authorize","tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","openid":"Authenticate your account using OpenID.","public":"View public information.","feeds.read":"View your feeds.","feeds.rendered.read":"View rendered content from feed posts.","feeds.engage":"View your feeds and engage with posts (likes, bookmarks, etc).","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","assistant.inbox.read":"View and list details of your assistant inbox items.","notification_center":"View and list notification center items.","data_exports.read":"View and download data export files in your program."}}}}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_112"}},"schemaId":"schema_112","pointer":"/paths/~1v2~1feed~1polls/get/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/feed/polls","servers":[{"url":"https://partner.socialchorus.com","description":"US1"},{"url":"https://partner.us2.onfirstup.com","description":"US2"},{"url":"https://partner.onfirstup.eu","description":"EU"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2_as_a_user","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"IAM_DOMAIN/oauth/authorize","tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","openid":"Authenticate your account using OpenID.","public":"View public information.","feeds.read":"View your feeds.","feeds.rendered.read":"View rendered content from feed posts.","feeds.engage":"View your feeds and engage with posts (likes, bookmarks, etc).","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","assistant.inbox.read":"View and list details of your assistant inbox items.","notification_center":"View and list notification center items.","data_exports.read":"View and download data export files in your program."}}}}],"scopes":["feeds.rendered.read"]}],"requestBody":{"application/json":{"schemaId":"schema_112"}},"responseCodes":["200","400","401","404"],"pointer":"/v2/feed/polls","href":"feeds/listfeedpolls","openApiOperationId":"listFeedPolls","summary":"Returns a user's feed of polls."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://partner.socialchorus.com","description":"US1"},{"url":"https://partner.us2.onfirstup.com","description":"US2"},{"url":"https://partner.onfirstup.eu","description":"EU"}],"schemaId":"schema_112","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_112"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_162"}},"schemaId":"schema_162"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}},"schemaId":"schema_101"},{"code":"401","description":"Unauthenticated","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}},"schemaId":"schema_101"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}},"schemaId":"schema_101"}],"pointer":"/paths/~1v2~1feed~1polls/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_162","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_162"}}},{"code":"400","schemaId":"schema_101","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}}},{"code":"401","schemaId":"schema_101","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}}},{"code":"404","schemaId":"schema_101","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/feeds/listfeedpolls"}],"panels":[]}]},"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"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"showFeedVideo","name":"Experimental and undocumented video access","isWebhook":false,"pointer":"/paths/~1v2~1feed~1video~1{video_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Experimental and undocumented video access","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Experimental internal API"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2_as_a_user","scopes":["feeds.rendered.read"],"type":"oauth2","description":"OAuth2 for Users (Authorization Code grant flow)","flows":{"authorizationCode":{"authorizationUrl":"IAM_DOMAIN/oauth/authorize","tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","openid":"Authenticate your account using OpenID.","public":"View public information.","feeds.read":"View your feeds.","feeds.rendered.read":"View rendered content from feed posts.","feeds.engage":"View your feeds and engage with posts (likes, bookmarks, etc).","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","assistant.inbox.read":"View and list details of your assistant inbox items.","notification_center":"View and list notification center items.","data_exports.read":"View and download data export files in your program."}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"video_id","in":"path","schemaId":"schema_115","description":"Experimental Parameter","required":true}],"pointer":"/paths/~1v2~1feed~1video~1{video_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/feed/video/{video_id}","servers":[{"url":"https://partner.socialchorus.com","description":"US1"},{"url":"https://partner.us2.onfirstup.com","description":"US2"},{"url":"https://partner.onfirstup.eu","description":"EU"}],"parameters":{"path":[{"name":"video_id","in":"path","required":true,"schemaId":"schema_115"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2_as_a_user","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"IAM_DOMAIN/oauth/authorize","tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","openid":"Authenticate your account using OpenID.","public":"View public information.","feeds.read":"View your feeds.","feeds.rendered.read":"View rendered content from feed posts.","feeds.engage":"View your feeds and engage with posts (likes, bookmarks, etc).","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","assistant.inbox.read":"View and list details of your assistant inbox items.","notification_center":"View and list notification center items.","data_exports.read":"View and download data export files in your program."}}}}],"scopes":["feeds.rendered.read"]}],"responseCodes":["200","400","401","404"],"pointer":"/v2/feed/video/{video_id}","href":"feeds/showfeedvideo","openApiOperationId":"showFeedVideo","summary":"Experimental and undocumented video access"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://partner.socialchorus.com","description":"US1"},{"url":"https://partner.us2.onfirstup.com","description":"US2"},{"url":"https://partner.onfirstup.eu","description":"EU"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_163"}},"schemaId":"schema_163"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}},"schemaId":"schema_101"},{"code":"401","description":"Unauthenticated","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}},"schemaId":"schema_101"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}},"schemaId":"schema_101"}],"pointer":"/paths/~1v2~1feed~1video~1{video_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_163","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_163"}}},{"code":"400","schemaId":"schema_101","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}}},{"code":"401","schemaId":"schema_101","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}}},{"code":"404","schemaId":"schema_101","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/feeds/showfeedvideo"}],"panels":[]}]},"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"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAttachmentStatus","name":"Experimental and undocumented attachment access","isWebhook":false,"pointer":"/paths/~1v2~1feed~1attachments~1{uuid}~1status/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Experimental and undocumented attachment access","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Experimental internal API"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2_as_a_user","scopes":["feeds.rendered.read"],"type":"oauth2","description":"OAuth2 for Users (Authorization Code grant flow)","flows":{"authorizationCode":{"authorizationUrl":"IAM_DOMAIN/oauth/authorize","tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","openid":"Authenticate your account using OpenID.","public":"View public information.","feeds.read":"View your feeds.","feeds.rendered.read":"View rendered content from feed posts.","feeds.engage":"View your feeds and engage with posts (likes, bookmarks, etc).","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","assistant.inbox.read":"View and list details of your assistant inbox items.","notification_center":"View and list notification center items.","data_exports.read":"View and download data export files in your program."}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"uuid","in":"path","schemaId":"schema_115","description":"Experimental Parameter","required":true}],"pointer":"/paths/~1v2~1feed~1attachments~1{uuid}~1status/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/feed/attachments/{uuid}/status","servers":[{"url":"https://partner.socialchorus.com","description":"US1"},{"url":"https://partner.us2.onfirstup.com","description":"US2"},{"url":"https://partner.onfirstup.eu","description":"EU"}],"parameters":{"path":[{"name":"uuid","in":"path","required":true,"schemaId":"schema_115"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2_as_a_user","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"IAM_DOMAIN/oauth/authorize","tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","openid":"Authenticate your account using OpenID.","public":"View public information.","feeds.read":"View your feeds.","feeds.rendered.read":"View rendered content from feed posts.","feeds.engage":"View your feeds and engage with posts (likes, bookmarks, etc).","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","assistant.inbox.read":"View and list details of your assistant inbox items.","notification_center":"View and list notification center items.","data_exports.read":"View and download data export files in your program."}}}}],"scopes":["feeds.rendered.read"]}],"responseCodes":["200","400","401","404"],"pointer":"/v2/feed/attachments/{uuid}/status","href":"feeds/getattachmentstatus","openApiOperationId":"getAttachmentStatus","summary":"Experimental and undocumented attachment access"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://partner.socialchorus.com","description":"US1"},{"url":"https://partner.us2.onfirstup.com","description":"US2"},{"url":"https://partner.onfirstup.eu","description":"EU"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_164"}},"schemaId":"schema_164"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}},"schemaId":"schema_101"},{"code":"401","description":"Unauthenticated","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}},"schemaId":"schema_101"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}},"schemaId":"schema_101"}],"pointer":"/paths/~1v2~1feed~1attachments~1{uuid}~1status/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_164","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_164"}}},{"code":"400","schemaId":"schema_101","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}}},{"code":"401","schemaId":"schema_101","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}}},{"code":"404","schemaId":"schema_101","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/feeds/getattachmentstatus"}],"panels":[]}]},"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAttachmentRedirect","name":"Experimental and undocumented attachment redirect","isWebhook":false,"pointer":"/paths/~1v2~1feed~1attachments~1{uuid}~1redirect/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Experimental and undocumented attachment redirect","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Experimental internal API. Mints a fresh signed S3 URL on every request\nand 302s to it. Returns 410 with a friendly HTML page when the\nattachment isn't safe.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2_as_a_user","scopes":["feeds.rendered.read"],"type":"oauth2","description":"OAuth2 for Users (Authorization Code grant flow)","flows":{"authorizationCode":{"authorizationUrl":"IAM_DOMAIN/oauth/authorize","tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","openid":"Authenticate your account using OpenID.","public":"View public information.","feeds.read":"View your feeds.","feeds.rendered.read":"View rendered content from feed posts.","feeds.engage":"View your feeds and engage with posts (likes, bookmarks, etc).","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","assistant.inbox.read":"View and list details of your assistant inbox items.","notification_center":"View and list notification center items.","data_exports.read":"View and download data export files in your program."}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"uuid","in":"path","schemaId":"schema_115","description":"Experimental Parameter","required":true}],"pointer":"/paths/~1v2~1feed~1attachments~1{uuid}~1redirect/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/feed/attachments/{uuid}/redirect","servers":[{"url":"https://partner.socialchorus.com","description":"US1"},{"url":"https://partner.us2.onfirstup.com","description":"US2"},{"url":"https://partner.onfirstup.eu","description":"EU"}],"parameters":{"path":[{"name":"uuid","in":"path","required":true,"schemaId":"schema_115"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2_as_a_user","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"IAM_DOMAIN/oauth/authorize","tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","openid":"Authenticate your account using OpenID.","public":"View public information.","feeds.read":"View your feeds.","feeds.rendered.read":"View rendered content from feed posts.","feeds.engage":"View your feeds and engage with posts (likes, bookmarks, etc).","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","assistant.inbox.read":"View and list details of your assistant inbox items.","notification_center":"View and list notification center items.","data_exports.read":"View and download data export files in your program."}}}}],"scopes":["feeds.rendered.read"]}],"responseCodes":["302","400","401","403","410"],"pointer":"/v2/feed/attachments/{uuid}/redirect","href":"feeds/getattachmentredirect","openApiOperationId":"getAttachmentRedirect","summary":"Experimental and undocumented attachment redirect"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://partner.socialchorus.com","description":"US1"},{"url":"https://partner.us2.onfirstup.com","description":"US2"},{"url":"https://partner.onfirstup.eu","description":"EU"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"302","description":"Redirect to a freshly signed attachment URL","headers":{"Location":{"schema":{"type":"string"}}},"headerSchemaId":"schema_165"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}},"schemaId":"schema_101"},{"code":"401","description":"Unauthenticated","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}},"schemaId":"schema_101"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}},"schemaId":"schema_101"},{"code":"410","description":"Attachment is no longer available","mediaType":"text/html","mediaTypes":["text/html"],"mediaTypeContent":{"text/html":{"schemaId":"schema_115"}},"schemaId":"schema_115"}],"pointer":"/paths/~1v2~1feed~1attachments~1{uuid}~1redirect/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"302"},{"code":"400","schemaId":"schema_101","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}}},{"code":"401","schemaId":"schema_101","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}}},{"code":"403","schemaId":"schema_101","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}}},{"code":"410","schemaId":"schema_115","mediaTypes":["text/html"],"mediaTypeContent":{"text/html":{"schemaId":"schema_115"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/feeds/getattachmentredirect"}],"panels":[]}]},"httpPath":"/v2/feed/attachments/{uuid}/redirect"}],"content":{"contentType":"group","meta":{"name":"Feeds"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Feeds","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"The Feeds API provides access to lists of content similar to how a user\nsees them in the Firstup experience application. Feeds are specific to the\nauthenticated user and a user can only see what the platform gives them\naccess to. "},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"At their core, feeds are built using filters to find the exact topics\nand type of posts your application wishes to expose to its users. One of\nthe basic filters is the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"channels.id"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" filter, but there are\nadditional filters like "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"content_type"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" and\n"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"visibility"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":". There are also preset configurations called\n"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"em","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"named feeds"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", which uses the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"name"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" query parameter and\nare convenient wrappers around a set of filters. These include things like\n"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\"trending\""},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" posts, "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\"following\""},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\"myfeed\""},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":". "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","attributes":{"content":" The full list of feed names\nis outlined in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"/endpoints/openapi/feeds/listfeedposts"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"listFeedPosts"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"\ndocumentation. "},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Feeds are paginated, but have no total records as they are an\ninherently dynamic list of posts."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Actions like liking, bookmarking,\nand responding to polls can be taken on individual posts in the same way\nthey can be taken on the experience applications."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"admonition","attributes":{"type":"info"},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Feeds API requires "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://developers.firstup.io/authorization/authentication-methods#jwt-bearer-token-grant"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" as a user."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Resources"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://support.firstup.io/hc/en-us/articles/4415354532759-How-Do-Users-See-Content"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Knowledge Base article on Feeds"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"/feeds/feedsoverview"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Feeds overview page"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for contextual guidance, use cases and API Flows.\n"},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v2/feed/posts","summary":"Return a user's feed of posts","prefix":{"name":"get","color":"get"},"badges":[],"link":"/feeds/listfeedposts","deprecated":false},{"title":"/v2/feeds/web_homepage","summary":"Return a user's homepage feed","prefix":{"name":"get","color":"get"},"badges":[],"link":"/feeds/webhomepagefeed","deprecated":false},{"title":"/v2/feed/profile/submitted","summary":"Return a user profile's submitted content","prefix":{"name":"get","color":"get"},"badges":[],"link":"/feeds/listfeedprofilesubmitted","deprecated":false},{"title":"/v2/feed/profile/channels","summary":"Return channels followed by a user profile","prefix":{"name":"get","color":"get"},"badges":[],"link":"/feeds/listfeedprofilechannels","deprecated":false},{"title":"/v2/feed/posts/{content_id}","summary":"Return the details of a single post within a feed","prefix":{"name":"get","color":"get"},"badges":[],"link":"/feeds/detailfeedpost","deprecated":false},{"title":"/v2/feed/posts/{content_id}/engagement","summary":"Return the engagement details of a single post within a feed","prefix":{"name":"get","color":"get"},"badges":[],"link":"/feeds/detailfeedpostengagement","deprecated":false},{"title":"/v2/feed/posts/{content_id}/like","summary":"Like a post in the feed","prefix":{"name":"put","color":"put"},"badges":[],"link":"/feeds/likepost","deprecated":false},{"title":"/v2/feed/posts/{content_id}/unlike","summary":"Unlike a post in the feed","prefix":{"name":"put","color":"put"},"badges":[],"link":"/feeds/unlikepost","deprecated":false},{"title":"/v2/feed/posts/{content_id}/bookmark","summary":"Bookmark a post in the feed","prefix":{"name":"put","color":"put"},"badges":[],"link":"/feeds/bookmarkpost","deprecated":false},{"title":"/v2/feed/posts/{content_id}/unbookmark","summary":"Unbookmark a post in the feed","prefix":{"name":"put","color":"put"},"badges":[],"link":"/feeds/unbookmarkpost","deprecated":false},{"title":"/v2/feed/posts/{content_id}/share/trackable_url","summary":"Get the trackable URL for a post in the feed","prefix":{"name":"get","color":"get"},"badges":[],"link":"/feeds/generatetrackableurl","deprecated":false},{"title":"/v2/feed/posts/{content_id}/share","summary":"Share a post in the feed","prefix":{"name":"put","color":"put"},"badges":[],"link":"/feeds/sharepost","deprecated":false},{"title":"/v2/feed/posts/{content_id}/view","summary":"View a post in the feed","prefix":{"name":"put","color":"put"},"badges":[],"link":"/feeds/viewpost","deprecated":false},{"title":"/v2/feed/posts/{content_id}/unview","summary":"Unview a post in the feed","prefix":{"name":"put","color":"put"},"badges":[],"link":"/feeds/unviewpost","deprecated":false},{"title":"/v2/feed/posts/{content_id}/comments","summary":"List the comments on a content post","prefix":{"name":"get","color":"get"},"badges":[],"link":"/feeds/listfeedpostcomments","deprecated":false},{"title":"/v2/feed/posts/{content_id}/comments","summary":"Comment on a post in the feed","prefix":{"name":"post","color":"post"},"badges":[],"link":"/feeds/createfeedpostcomment","deprecated":false},{"title":"/v2/feed/posts/{content_id}/comments/{comment_id}/replies","summary":"List the replies to a comment on a content post","prefix":{"name":"get","color":"get"},"badges":[],"link":"/feeds/listfeedpostcommentreplies","deprecated":false},{"title":"/v2/feed/posts/{content_id}/comments/{comment_id}/{post_number}/replies","summary":"Reply to a comment on a post in the feed","prefix":{"name":"post","color":"post"},"badges":[],"link":"/feeds/createfeedpostcommentreply","deprecated":false},{"title":"/v2/feed/posts/{content_id}/comments/{comment_id}/report","summary":"Report a Comment or Reply for a given post in the feed","prefix":{"name":"put","color":"put"},"badges":[],"link":"/feeds/reportfeedpostcomment","deprecated":false},{"title":"/v2/feed/users/suggest","summary":"Query for users that are able to be mentioned.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/feeds/suggestuser","deprecated":false},{"title":"/v2/feed/posts/{content_id}/comments/{comment_id}","summary":"Update a comment on a post in the feed","prefix":{"name":"put","color":"put"},"badges":[],"link":"/feeds/updatefeedpostcomment","deprecated":false},{"title":"/v2/feed/posts/{content_id}/comments/{comment_id}","summary":"Delete a comment or reply on a post in the feed","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/feeds/deletefeedpostcomment","deprecated":false},{"title":"/v2/feed/posts/{content_id}/rendered","summary":"Return the rendered content of a single post within the feed","prefix":{"name":"get","color":"get"},"badges":[],"link":"/feeds/renderfeedpost","deprecated":false},{"title":"/v2/feed/posts/{content_id}/report","summary":"Report a post in the feed","prefix":{"name":"put","color":"put"},"badges":[],"link":"/feeds/reportfeedpost","deprecated":false},{"title":"/v2/feed/posts/{content_id}/acknowledge","summary":"Acknowledge a post in the feed.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/feeds/acknowledgefeedpost","deprecated":false},{"title":"/v2/feed/polls/{poll_id}","summary":"Returns the details of a single poll.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/feeds/showfeedpoll","deprecated":false},{"title":"/v2/feed/polls/{poll_id}","summary":"Respond to a poll.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/feeds/respondfeedpoll","deprecated":false},{"title":"/v2/feed/polls","summary":"Returns a user's feed of polls.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/feeds/listfeedpolls","deprecated":false},{"title":"/v2/feed/video/{video_id}","summary":"Experimental and undocumented video access","prefix":{"name":"get","color":"get"},"badges":[],"link":"/feeds/showfeedvideo","deprecated":false},{"title":"/v2/feed/attachments/{uuid}/status","summary":"Experimental and undocumented attachment access","prefix":{"name":"get","color":"get"},"badges":[],"link":"/feeds/getattachmentstatus","deprecated":false},{"title":"/v2/feed/attachments/{uuid}/redirect","summary":"Experimental and undocumented attachment redirect","prefix":{"name":"get","color":"get"},"badges":[],"link":"/feeds/getattachmentredirect","deprecated":false}]}]}]}]}},{"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 SCIM 2.0 Specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listSchemas","name":"List SCIM schemas","isWebhook":false,"pointer":"/paths/~1scim~1v2~1Schemas/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List SCIM schemas","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a list of the schemas in use by this SCIM API. Implements "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://tools.ietf.org/html/rfc7643#section-7"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SCIM 2.0 Specification"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2_as_a_server","scopes":["users.read"],"type":"oauth2","description":"OAuth2 for Server-to-Server (Client Credentials grant flow)","flows":{"clientCredentials":{"tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","public":"View public information.","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","data_exports.read":"View and download data export files in your program."}}}}]},{"schemes":[{"name":"oauth2_as_a_user","scopes":["users.read"],"type":"oauth2","description":"OAuth2 for Users (Authorization Code grant flow)","flows":{"authorizationCode":{"authorizationUrl":"IAM_DOMAIN/oauth/authorize","tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","openid":"Authenticate your account using OpenID.","public":"View public information.","feeds.read":"View your feeds.","feeds.rendered.read":"View rendered content from feed posts.","feeds.engage":"View your feeds and engage with posts (likes, bookmarks, etc).","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","assistant.inbox.read":"View and list details of your assistant inbox items.","notification_center":"View and list notification center items.","data_exports.read":"View and download data export files in your program."}}}}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/scim/v2/Schemas","servers":[{"url":"https://partner.socialchorus.com","description":"US1"},{"url":"https://partner.us2.onfirstup.com","description":"US2"},{"url":"https://partner.onfirstup.eu","description":"EU"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2_as_a_server","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","public":"View public information.","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","data_exports.read":"View and download data export files in your program."}}}}],"scopes":["users.read"]},{"schemes":[{"id":"oauth2_as_a_user","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"IAM_DOMAIN/oauth/authorize","tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","openid":"Authenticate your account using OpenID.","public":"View public information.","feeds.read":"View your feeds.","feeds.rendered.read":"View rendered content from feed posts.","feeds.engage":"View your feeds and engage with posts (likes, bookmarks, etc).","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","assistant.inbox.read":"View and list details of your assistant inbox items.","notification_center":"View and list notification center items.","data_exports.read":"View and download data export files in your program."}}}}],"scopes":["users.read"]}],"responseCodes":["200","401","403"],"pointer":"/scim/v2/Schemas","href":"user-management/listschemas","openApiOperationId":"listSchemas","summary":"List SCIM schemas","securityGroups":[{"oauth2_as_a_server":["users.read"]},{"oauth2_as_a_user":["users.read"]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://partner.socialchorus.com","description":"US1"},{"url":"https://partner.us2.onfirstup.com","description":"US2"},{"url":"https://partner.onfirstup.eu","description":"EU"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/scim+json","mediaTypes":["application/scim+json"],"mediaTypeContent":{"application/scim+json":{"schemaId":"schema_166"}},"schemaId":"schema_166"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthenticated. See more on error responses "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://developers.firstup.io/gettingstarted/error_responses"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_167"}},"schemaId":"schema_167"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized. See more on error responses "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://developers.firstup.io/gettingstarted/error_responses"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_168"}},"schemaId":"schema_168"}],"pointer":"/paths/~1scim~1v2~1Schemas/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_166","mediaTypes":["application/scim+json"],"mediaTypeContent":{"application/scim+json":{"schemaId":"schema_166"}}},{"code":"401","schemaId":"schema_167","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_167"}}},{"code":"403","schemaId":"schema_168","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_168"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/user-management/listschemas"}],"panels":[]}]},"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 SCIM 2.0 specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"detailSchema","name":"Detail a SCIM schema","isWebhook":false,"pointer":"/paths/~1scim~1v2~1Schemas~1{schema_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Detail a SCIM schema","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns the specified schema used by this SCIM API. Implements "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://tools.ietf.org/html/rfc7643#section-7"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SCIM 2.0 specification"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2_as_a_server","scopes":["users.read"],"type":"oauth2","description":"OAuth2 for Server-to-Server (Client Credentials grant flow)","flows":{"clientCredentials":{"tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","public":"View public information.","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","data_exports.read":"View and download data export files in your program."}}}}]},{"schemes":[{"name":"oauth2_as_a_user","scopes":["users.read"],"type":"oauth2","description":"OAuth2 for Users (Authorization Code grant flow)","flows":{"authorizationCode":{"authorizationUrl":"IAM_DOMAIN/oauth/authorize","tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","openid":"Authenticate your account using OpenID.","public":"View public information.","feeds.read":"View your feeds.","feeds.rendered.read":"View rendered content from feed posts.","feeds.engage":"View your feeds and engage with posts (likes, bookmarks, etc).","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","assistant.inbox.read":"View and list details of your assistant inbox items.","notification_center":"View and list notification center items.","data_exports.read":"View and download data export files in your program."}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"schema_id","in":"path","schemaId":"schema_115","description":"The Schema ID.","required":true}],"pointer":"/paths/~1scim~1v2~1Schemas~1{schema_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/scim/v2/Schemas/{schema_id}","servers":[{"url":"https://partner.socialchorus.com","description":"US1"},{"url":"https://partner.us2.onfirstup.com","description":"US2"},{"url":"https://partner.onfirstup.eu","description":"EU"}],"parameters":{"path":[{"name":"schema_id","in":"path","required":true,"schemaId":"schema_115"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2_as_a_server","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","public":"View public information.","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","data_exports.read":"View and download data export files in your program."}}}}],"scopes":["users.read"]},{"schemes":[{"id":"oauth2_as_a_user","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"IAM_DOMAIN/oauth/authorize","tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","openid":"Authenticate your account using OpenID.","public":"View public information.","feeds.read":"View your feeds.","feeds.rendered.read":"View rendered content from feed posts.","feeds.engage":"View your feeds and engage with posts (likes, bookmarks, etc).","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","assistant.inbox.read":"View and list details of your assistant inbox items.","notification_center":"View and list notification center items.","data_exports.read":"View and download data export files in your program."}}}}],"scopes":["users.read"]}],"responseCodes":["200","401","403","404"],"pointer":"/scim/v2/Schemas/{schema_id}","href":"user-management/detailschema","openApiOperationId":"detailSchema","summary":"Detail a SCIM schema","securityGroups":[{"oauth2_as_a_server":["users.read"]},{"oauth2_as_a_user":["users.read"]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://partner.socialchorus.com","description":"US1"},{"url":"https://partner.us2.onfirstup.com","description":"US2"},{"url":"https://partner.onfirstup.eu","description":"EU"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/scim+json","mediaTypes":["application/scim+json"],"mediaTypeContent":{"application/scim+json":{"schemaId":"schema_169"}},"schemaId":"schema_169"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthenticated. See more on error responses "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://developers.firstup.io/gettingstarted/error_responses"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_167"}},"schemaId":"schema_167"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized. See more on error responses "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://developers.firstup.io/gettingstarted/error_responses"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_168"}},"schemaId":"schema_168"},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Not Found. See more on error responses "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://developers.firstup.io/gettingstarted/error_responses"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_170"}},"schemaId":"schema_170"}],"pointer":"/paths/~1scim~1v2~1Schemas~1{schema_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_169","mediaTypes":["application/scim+json"],"mediaTypeContent":{"application/scim+json":{"schemaId":"schema_169"}}},{"code":"401","schemaId":"schema_167","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_167"}}},{"code":"403","schemaId":"schema_168","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_168"}}},{"code":"404","schemaId":"schema_170","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_170"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/user-management/detailschema"}],"panels":[]}]},"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 SCIM 2.0 Specification.Additional references:"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"detailServiceProviderConfig","name":"Provides SCIM Schema Provider Configuration","isWebhook":false,"pointer":"/paths/~1scim~1v2~1ServiceProviderConfig/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Provides SCIM Schema Provider Configuration","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns the Schema Provider configuration as per "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://tools.ietf.org/html/rfc7643#section-5"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SCIM 2.0 Specification"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional references:"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://tools.ietf.org/html/rfc7643#section-8.5"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"SCIM 2.0 Spc Section 8.5"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://tools.ietf.org/html/rfc7643#section-8.7.2"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"SCIM 2.0 Spec Section 8.7.2"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2_as_a_server","scopes":["users.read"],"type":"oauth2","description":"OAuth2 for Server-to-Server (Client Credentials grant flow)","flows":{"clientCredentials":{"tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","public":"View public information.","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","data_exports.read":"View and download data export files in your program."}}}}]},{"schemes":[{"name":"oauth2_as_a_user","scopes":["users.read"],"type":"oauth2","description":"OAuth2 for Users (Authorization Code grant flow)","flows":{"authorizationCode":{"authorizationUrl":"IAM_DOMAIN/oauth/authorize","tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","openid":"Authenticate your account using OpenID.","public":"View public information.","feeds.read":"View your feeds.","feeds.rendered.read":"View rendered content from feed posts.","feeds.engage":"View your feeds and engage with posts (likes, bookmarks, etc).","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","assistant.inbox.read":"View and list details of your assistant inbox items.","notification_center":"View and list notification center items.","data_exports.read":"View and download data export files in your program."}}}}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/scim/v2/ServiceProviderConfig","servers":[{"url":"https://partner.socialchorus.com","description":"US1"},{"url":"https://partner.us2.onfirstup.com","description":"US2"},{"url":"https://partner.onfirstup.eu","description":"EU"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2_as_a_server","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","public":"View public information.","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","data_exports.read":"View and download data export files in your program."}}}}],"scopes":["users.read"]},{"schemes":[{"id":"oauth2_as_a_user","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"IAM_DOMAIN/oauth/authorize","tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","openid":"Authenticate your account using OpenID.","public":"View public information.","feeds.read":"View your feeds.","feeds.rendered.read":"View rendered content from feed posts.","feeds.engage":"View your feeds and engage with posts (likes, bookmarks, etc).","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","assistant.inbox.read":"View and list details of your assistant inbox items.","notification_center":"View and list notification center items.","data_exports.read":"View and download data export files in your program."}}}}],"scopes":["users.read"]}],"responseCodes":["200","401","403"],"pointer":"/scim/v2/ServiceProviderConfig","href":"user-management/detailserviceproviderconfig","openApiOperationId":"detailServiceProviderConfig","summary":"Provides SCIM Schema Provider Configuration","securityGroups":[{"oauth2_as_a_server":["users.read"]},{"oauth2_as_a_user":["users.read"]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://partner.socialchorus.com","description":"US1"},{"url":"https://partner.us2.onfirstup.com","description":"US2"},{"url":"https://partner.onfirstup.eu","description":"EU"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/scim+json","mediaTypes":["application/scim+json"],"mediaTypeContent":{"application/scim+json":{"schemaId":"schema_171"}},"schemaId":"schema_171"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthenticated. See more on error responses "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://developers.firstup.io/gettingstarted/error_responses"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_167"}},"schemaId":"schema_167"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized. See more on error responses "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://developers.firstup.io/gettingstarted/error_responses"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_168"}},"schemaId":"schema_168"}],"pointer":"/paths/~1scim~1v2~1ServiceProviderConfig/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_171","mediaTypes":["application/scim+json"],"mediaTypeContent":{"application/scim+json":{"schemaId":"schema_171"}}},{"code":"401","schemaId":"schema_167","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_167"}}},{"code":"403","schemaId":"schema_168","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_168"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/user-management/detailserviceproviderconfig"}],"panels":[]}]},"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 SCIM 2.0 Specification.Additional references:"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listResourceTypes","name":"Provides SCIM Resource Types","isWebhook":false,"pointer":"/paths/~1scim~1v2~1ResourceTypes/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Provides SCIM Resource Types","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns available Resource Types configuration as per "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://tools.ietf.org/html/rfc7643#section-5"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SCIM 2.0 Specification"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional references:"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://tools.ietf.org/html/rfc7644#section-4"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"SCIM 2.0 Protocol Spec Section 4"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://tools.ietf.org/html/rfc7643#section-8.6"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"SCIM 2.0 Spec Section 8.5"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2_as_a_server","scopes":["users.read"],"type":"oauth2","description":"OAuth2 for Server-to-Server (Client Credentials grant flow)","flows":{"clientCredentials":{"tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","public":"View public information.","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","data_exports.read":"View and download data export files in your program."}}}}]},{"schemes":[{"name":"oauth2_as_a_user","scopes":["users.read"],"type":"oauth2","description":"OAuth2 for Users (Authorization Code grant flow)","flows":{"authorizationCode":{"authorizationUrl":"IAM_DOMAIN/oauth/authorize","tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","openid":"Authenticate your account using OpenID.","public":"View public information.","feeds.read":"View your feeds.","feeds.rendered.read":"View rendered content from feed posts.","feeds.engage":"View your feeds and engage with posts (likes, bookmarks, etc).","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","assistant.inbox.read":"View and list details of your assistant inbox items.","notification_center":"View and list notification center items.","data_exports.read":"View and download data export files in your program."}}}}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/scim/v2/ResourceTypes","servers":[{"url":"https://partner.socialchorus.com","description":"US1"},{"url":"https://partner.us2.onfirstup.com","description":"US2"},{"url":"https://partner.onfirstup.eu","description":"EU"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2_as_a_server","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","public":"View public information.","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","data_exports.read":"View and download data export files in your program."}}}}],"scopes":["users.read"]},{"schemes":[{"id":"oauth2_as_a_user","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"IAM_DOMAIN/oauth/authorize","tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","openid":"Authenticate your account using OpenID.","public":"View public information.","feeds.read":"View your feeds.","feeds.rendered.read":"View rendered content from feed posts.","feeds.engage":"View your feeds and engage with posts (likes, bookmarks, etc).","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","assistant.inbox.read":"View and list details of your assistant inbox items.","notification_center":"View and list notification center items.","data_exports.read":"View and download data export files in your program."}}}}],"scopes":["users.read"]}],"responseCodes":["200","401","403"],"pointer":"/scim/v2/ResourceTypes","href":"user-management/listresourcetypes","openApiOperationId":"listResourceTypes","summary":"Provides SCIM Resource Types","securityGroups":[{"oauth2_as_a_server":["users.read"]},{"oauth2_as_a_user":["users.read"]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://partner.socialchorus.com","description":"US1"},{"url":"https://partner.us2.onfirstup.com","description":"US2"},{"url":"https://partner.onfirstup.eu","description":"EU"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/scim+json","mediaTypes":["application/scim+json"],"mediaTypeContent":{"application/scim+json":{"schemaId":"schema_172"}},"schemaId":"schema_172"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthenticated. See more on error responses "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://developers.firstup.io/gettingstarted/error_responses"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_167"}},"schemaId":"schema_167"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized. See more on error responses "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://developers.firstup.io/gettingstarted/error_responses"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_168"}},"schemaId":"schema_168"}],"pointer":"/paths/~1scim~1v2~1ResourceTypes/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_172","mediaTypes":["application/scim+json"],"mediaTypeContent":{"application/scim+json":{"schemaId":"schema_172"}}},{"code":"401","schemaId":"schema_167","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_167"}}},{"code":"403","schemaId":"schema_168","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_168"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/user-management/listresourcetypes"}],"panels":[]}]},"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 SCIM 2.0 Specification.Additional references:"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"detailResourceType","name":"Detail a SCIM Resource Type","isWebhook":false,"pointer":"/paths/~1scim~1v2~1ResourceTypes~1{resource_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Detail a SCIM Resource Type","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns the requested Resource Type "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://tools.ietf.org/html/rfc7643#section-5"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SCIM 2.0 Specification"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional references:"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://tools.ietf.org/html/rfc7644#section-4"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"SCIM 2.0 Protocol Spec Section 4"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://tools.ietf.org/html/rfc7643#section-8.6"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"SCIM 2.0 Spec Section 8.5"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2_as_a_server","scopes":["users.read"],"type":"oauth2","description":"OAuth2 for Server-to-Server (Client Credentials grant flow)","flows":{"clientCredentials":{"tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","public":"View public information.","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","data_exports.read":"View and download data export files in your program."}}}}]},{"schemes":[{"name":"oauth2_as_a_user","scopes":["users.read"],"type":"oauth2","description":"OAuth2 for Users (Authorization Code grant flow)","flows":{"authorizationCode":{"authorizationUrl":"IAM_DOMAIN/oauth/authorize","tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","openid":"Authenticate your account using OpenID.","public":"View public information.","feeds.read":"View your feeds.","feeds.rendered.read":"View rendered content from feed posts.","feeds.engage":"View your feeds and engage with posts (likes, bookmarks, etc).","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","assistant.inbox.read":"View and list details of your assistant inbox items.","notification_center":"View and list notification center items.","data_exports.read":"View and download data export files in your program."}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"resource_id","in":"path","schemaId":"schema_115","description":"The Resource ID.","required":true}],"pointer":"/paths/~1scim~1v2~1ResourceTypes~1{resource_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/scim/v2/ResourceTypes/{resource_id}","servers":[{"url":"https://partner.socialchorus.com","description":"US1"},{"url":"https://partner.us2.onfirstup.com","description":"US2"},{"url":"https://partner.onfirstup.eu","description":"EU"}],"parameters":{"path":[{"name":"resource_id","in":"path","required":true,"schemaId":"schema_115"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2_as_a_server","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","public":"View public information.","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","data_exports.read":"View and download data export files in your program."}}}}],"scopes":["users.read"]},{"schemes":[{"id":"oauth2_as_a_user","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"IAM_DOMAIN/oauth/authorize","tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","openid":"Authenticate your account using OpenID.","public":"View public information.","feeds.read":"View your feeds.","feeds.rendered.read":"View rendered content from feed posts.","feeds.engage":"View your feeds and engage with posts (likes, bookmarks, etc).","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","assistant.inbox.read":"View and list details of your assistant inbox items.","notification_center":"View and list notification center items.","data_exports.read":"View and download data export files in your program."}}}}],"scopes":["users.read"]}],"responseCodes":["200","401","403"],"pointer":"/scim/v2/ResourceTypes/{resource_id}","href":"user-management/detailresourcetype","openApiOperationId":"detailResourceType","summary":"Detail a SCIM Resource Type","securityGroups":[{"oauth2_as_a_server":["users.read"]},{"oauth2_as_a_user":["users.read"]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://partner.socialchorus.com","description":"US1"},{"url":"https://partner.us2.onfirstup.com","description":"US2"},{"url":"https://partner.onfirstup.eu","description":"EU"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/scim+json","mediaTypes":["application/scim+json"],"mediaTypeContent":{"application/scim+json":{"schemaId":"schema_173"}},"schemaId":"schema_173"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthenticated. See more on error responses "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://developers.firstup.io/gettingstarted/error_responses"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_167"}},"schemaId":"schema_167"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized. See more on error responses "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://developers.firstup.io/gettingstarted/error_responses"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_168"}},"schemaId":"schema_168"}],"pointer":"/paths/~1scim~1v2~1ResourceTypes~1{resource_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_173","mediaTypes":["application/scim+json"],"mediaTypeContent":{"application/scim+json":{"schemaId":"schema_173"}}},{"code":"401","schemaId":"schema_167","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_167"}}},{"code":"403","schemaId":"schema_168","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_168"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/user-management/detailresourcetype"}],"panels":[]}]},"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listUsers","name":"List users in the program","isWebhook":false,"pointer":"/paths/~1scim~1v2~1Users/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List users in the program","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint allows you to retrieve information about all or some of the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"users stored in the Firstup application and adheres to the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc7643#section-4.1"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SCIM 2.0 Section: 4.1"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" standard."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"📚 For more in-depth guidance on using the user interface and"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"understanding the application's behavior, you can refer to the user"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation provided"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://support.firstup.io/hc/en-us/articles/4834506731543-Manually-Add-or-Import-Users"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This documentation will help bridge the gap between"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the API and the intricacies of Firstup."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2_as_a_server","scopes":["users.read"],"type":"oauth2","description":"OAuth2 for Server-to-Server (Client Credentials grant flow)","flows":{"clientCredentials":{"tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","public":"View public information.","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","data_exports.read":"View and download data export files in your program."}}}}]},{"schemes":[{"name":"oauth2_as_a_user","scopes":["users.read"],"type":"oauth2","description":"OAuth2 for Users (Authorization Code grant flow)","flows":{"authorizationCode":{"authorizationUrl":"IAM_DOMAIN/oauth/authorize","tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","openid":"Authenticate your account using OpenID.","public":"View public information.","feeds.read":"View your feeds.","feeds.rendered.read":"View rendered content from feed posts.","feeds.engage":"View your feeds and engage with posts (likes, bookmarks, etc).","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","assistant.inbox.read":"View and list details of your assistant inbox items.","notification_center":"View and list notification center items.","data_exports.read":"View and download data export files in your program."}}}}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"filter","in":"query","schemaId":"schema_115","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supports a"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://tools.ietf.org/html/rfc7644#section-3.4.2.2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SCIM filter expression"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"allowing for filtering the results based on specific criteria, such as"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"userName or role."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported operator: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"eq"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported Fields:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"userName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": internally maps to universal identifier."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"role"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": either new or legacy roles depending on program configuration."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Examples"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"userName eq \"user123\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (URL encoded: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"?filter=userName%20eq%20%22user123%22"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"role eq \"publisher\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (URL encoded: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"?filter=role%20eq%20%22publisher%22"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}]}]},{"name":"startIndex","in":"query","schemaId":"schema_106","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://tools.ietf.org/html/rfc7644#section-3.4.2.4"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SCIM pagination parameter"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"1-based offset of the first query result"},"children":[]}]}]}]},{"name":"count","in":"query","schemaId":"schema_106","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://tools.ietf.org/html/rfc7644#section-3.4.2.4"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SCIM pagination parameter"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Total number of results returned"},"children":[]}]}]}]}],"pointer":"/paths/~1scim~1v2~1Users/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/scim/v2/Users","servers":[{"url":"https://partner.socialchorus.com","description":"US1"},{"url":"https://partner.us2.onfirstup.com","description":"US2"},{"url":"https://partner.onfirstup.eu","description":"EU"}],"parameters":{"path":[],"query":[{"name":"filter","in":"query","required":false,"schemaId":"schema_115"},{"name":"startIndex","in":"query","required":false,"schemaId":"schema_106"},{"name":"count","in":"query","required":false,"schemaId":"schema_106"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2_as_a_server","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","public":"View public information.","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","data_exports.read":"View and download data export files in your program."}}}}],"scopes":["users.read"]},{"schemes":[{"id":"oauth2_as_a_user","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"IAM_DOMAIN/oauth/authorize","tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","openid":"Authenticate your account using OpenID.","public":"View public information.","feeds.read":"View your feeds.","feeds.rendered.read":"View rendered content from feed posts.","feeds.engage":"View your feeds and engage with posts (likes, bookmarks, etc).","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","assistant.inbox.read":"View and list details of your assistant inbox items.","notification_center":"View and list notification center items.","data_exports.read":"View and download data export files in your program."}}}}],"scopes":["users.read"]}],"responseCodes":["200","400","401","403","404"],"pointer":"/scim/v2/Users","href":"user-management/listusers","openApiOperationId":"listUsers","summary":"List users in the program","securityGroups":[{"oauth2_as_a_server":["users.read"]},{"oauth2_as_a_user":["users.read"]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://partner.socialchorus.com","description":"US1"},{"url":"https://partner.us2.onfirstup.com","description":"US2"},{"url":"https://partner.onfirstup.eu","description":"EU"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/scim+json","mediaTypes":["application/scim+json"],"mediaTypeContent":{"application/scim+json":{"schemaId":"schema_174"}},"schemaId":"schema_174"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request. See more on error responses "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://developers.firstup.io/gettingstarted/error_responses"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_175"}},"schemaId":"schema_175"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthenticated. See more on error responses "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://developers.firstup.io/gettingstarted/error_responses"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_167"}},"schemaId":"schema_167"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized. See more on error responses "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://developers.firstup.io/gettingstarted/error_responses"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_168"}},"schemaId":"schema_168"},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Not Found. See more on error responses "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://developers.firstup.io/gettingstarted/error_responses"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_170"}},"schemaId":"schema_170"}],"pointer":"/paths/~1scim~1v2~1Users/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_174","mediaTypes":["application/scim+json"],"mediaTypeContent":{"application/scim+json":{"schemaId":"schema_174"}}},{"code":"400","schemaId":"schema_175","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_175"}}},{"code":"401","schemaId":"schema_167","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_167"}}},{"code":"403","schemaId":"schema_168","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_168"}}},{"code":"404","schemaId":"schema_170","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_170"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/user-management/listusers"}],"panels":[]}]},"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.  New users have a role of \"member\" by default. New users have an onboarding status of \"created\" by default.  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.  Additional documentation and resources  *  User roles and access  *  User provisioning  *  SCIM user provisioning  "}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createUser","name":"Create a user in the program","isWebhook":false,"pointer":"/paths/~1scim~1v2~1Users/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a user in the program","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" New users have a role of \"member\" by default. New users have an onboarding status of \"created\" by default. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" 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."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"admonition","inline":true,"attributes":{"type":"info"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional documentation and resources"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" * "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://developers.firstup.io/usermanagementapi/user-role-provisioning"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" User roles and access "},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" * "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://developers.firstup.io/usermanagementapi/user-provisioning"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" User provisioning "},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" * "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://developers.firstup.io/usermanagementapi/scim-user-provision"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" SCIM user provisioning "},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2_as_a_server","scopes":["users.write"],"type":"oauth2","description":"OAuth2 for Server-to-Server (Client Credentials grant flow)","flows":{"clientCredentials":{"tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","public":"View public information.","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","data_exports.read":"View and download data export files in your program."}}}}]},{"schemes":[{"name":"oauth2_as_a_user","scopes":["users.write"],"type":"oauth2","description":"OAuth2 for Users (Authorization Code grant flow)","flows":{"authorizationCode":{"authorizationUrl":"IAM_DOMAIN/oauth/authorize","tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","openid":"Authenticate your account using OpenID.","public":"View public information.","feeds.read":"View your feeds.","feeds.rendered.read":"View rendered content from feed posts.","feeds.engage":"View your feeds and engage with posts (likes, bookmarks, etc).","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","assistant.inbox.read":"View and list details of your assistant inbox items.","notification_center":"View and list notification center items.","data_exports.read":"View and download data export files in your program."}}}}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Scim.User.CreateRequestBody"}},"schemaId":"components/schemas/Scim.User.CreateRequestBody","pointer":"/paths/~1scim~1v2~1Users/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/scim/v2/Users","servers":[{"url":"https://partner.socialchorus.com","description":"US1"},{"url":"https://partner.us2.onfirstup.com","description":"US2"},{"url":"https://partner.onfirstup.eu","description":"EU"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2_as_a_server","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","public":"View public information.","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","data_exports.read":"View and download data export files in your program."}}}}],"scopes":["users.write"]},{"schemes":[{"id":"oauth2_as_a_user","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"IAM_DOMAIN/oauth/authorize","tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","openid":"Authenticate your account using OpenID.","public":"View public information.","feeds.read":"View your feeds.","feeds.rendered.read":"View rendered content from feed posts.","feeds.engage":"View your feeds and engage with posts (likes, bookmarks, etc).","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","assistant.inbox.read":"View and list details of your assistant inbox items.","notification_center":"View and list notification center items.","data_exports.read":"View and download data export files in your program."}}}}],"scopes":["users.write"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Scim.User.CreateRequestBody"}},"responseCodes":["201","400","401","403","422"],"pointer":"/scim/v2/Users","href":"user-management/createuser","openApiOperationId":"createUser","summary":"Create a user in the program","securityGroups":[{"oauth2_as_a_server":["users.write"]},{"oauth2_as_a_user":["users.write"]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://partner.socialchorus.com","description":"US1"},{"url":"https://partner.us2.onfirstup.com","description":"US2"},{"url":"https://partner.onfirstup.eu","description":"EU"}],"schemaId":"components/schemas/Scim.User.CreateRequestBody","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Scim.User.CreateRequestBody"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"User created","mediaType":"application/scim+json","mediaTypes":["application/scim+json"],"mediaTypeContent":{"application/scim+json":{"schemaId":"schema_176"}},"schemaId":"schema_176"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request. See more on error responses "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://developers.firstup.io/gettingstarted/error_responses"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_175"}},"schemaId":"schema_175"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthenticated. See more on error responses "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://developers.firstup.io/gettingstarted/error_responses"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_167"}},"schemaId":"schema_167"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized. See more on error responses "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://developers.firstup.io/gettingstarted/error_responses"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_168"}},"schemaId":"schema_168"},{"code":"422","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unprocessable Entity. See more on error responses "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://developers.firstup.io/gettingstarted/error_responses"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_177"}},"schemaId":"schema_177"}],"pointer":"/paths/~1scim~1v2~1Users/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_176","mediaTypes":["application/scim+json"],"mediaTypeContent":{"application/scim+json":{"schemaId":"schema_176"}}},{"code":"400","schemaId":"schema_175","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_175"}}},{"code":"401","schemaId":"schema_167","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_167"}}},{"code":"403","schemaId":"schema_168","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_168"}}},{"code":"422","schemaId":"schema_177","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_177"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/user-management/createuser"}],"panels":[]}]},"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"detailUser","name":"Show a single program user by ID","isWebhook":false,"pointer":"/paths/~1scim~1v2~1Users~1{user_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Show a single program user by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a User record for specified user in the program."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2_as_a_server","scopes":["users.read"],"type":"oauth2","description":"OAuth2 for Server-to-Server (Client Credentials grant flow)","flows":{"clientCredentials":{"tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","public":"View public information.","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","data_exports.read":"View and download data export files in your program."}}}}]},{"schemes":[{"name":"oauth2_as_a_user","scopes":["users.read"],"type":"oauth2","description":"OAuth2 for Users (Authorization Code grant flow)","flows":{"authorizationCode":{"authorizationUrl":"IAM_DOMAIN/oauth/authorize","tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","openid":"Authenticate your account using OpenID.","public":"View public information.","feeds.read":"View your feeds.","feeds.rendered.read":"View rendered content from feed posts.","feeds.engage":"View your feeds and engage with posts (likes, bookmarks, etc).","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","assistant.inbox.read":"View and list details of your assistant inbox items.","notification_center":"View and list notification center items.","data_exports.read":"View and download data export files in your program."}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"user_id","in":"path","schemaId":"schema_115","description":"Identifier of the user to look up. It could be used either the user's id, universal identifier, an email address, or external Id. The look up will be done in the above mentioned order.\n","required":true}],"pointer":"/paths/~1scim~1v2~1Users~1{user_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/scim/v2/Users/{user_id}","servers":[{"url":"https://partner.socialchorus.com","description":"US1"},{"url":"https://partner.us2.onfirstup.com","description":"US2"},{"url":"https://partner.onfirstup.eu","description":"EU"}],"parameters":{"path":[{"name":"user_id","in":"path","required":true,"schemaId":"schema_115"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2_as_a_server","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","public":"View public information.","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","data_exports.read":"View and download data export files in your program."}}}}],"scopes":["users.read"]},{"schemes":[{"id":"oauth2_as_a_user","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"IAM_DOMAIN/oauth/authorize","tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","openid":"Authenticate your account using OpenID.","public":"View public information.","feeds.read":"View your feeds.","feeds.rendered.read":"View rendered content from feed posts.","feeds.engage":"View your feeds and engage with posts (likes, bookmarks, etc).","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","assistant.inbox.read":"View and list details of your assistant inbox items.","notification_center":"View and list notification center items.","data_exports.read":"View and download data export files in your program."}}}}],"scopes":["users.read"]}],"responseCodes":["200","400","401","403","404"],"pointer":"/scim/v2/Users/{user_id}","href":"user-management/detailuser","openApiOperationId":"detailUser","summary":"Show a single program user by ID","securityGroups":[{"oauth2_as_a_server":["users.read"]},{"oauth2_as_a_user":["users.read"]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://partner.socialchorus.com","description":"US1"},{"url":"https://partner.us2.onfirstup.com","description":"US2"},{"url":"https://partner.onfirstup.eu","description":"EU"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/scim+json","mediaTypes":["application/scim+json"],"mediaTypeContent":{"application/scim+json":{"schemaId":"schema_176"}},"schemaId":"schema_176"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request. See more on error responses "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://developers.firstup.io/gettingstarted/error_responses"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_175"}},"schemaId":"schema_175"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthenticated. See more on error responses "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://developers.firstup.io/gettingstarted/error_responses"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_167"}},"schemaId":"schema_167"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized. See more on error responses "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://developers.firstup.io/gettingstarted/error_responses"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_168"}},"schemaId":"schema_168"},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Not Found. See more on error responses "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://developers.firstup.io/gettingstarted/error_responses"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_170"}},"schemaId":"schema_170"}],"pointer":"/paths/~1scim~1v2~1Users~1{user_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_176","mediaTypes":["application/scim+json"],"mediaTypeContent":{"application/scim+json":{"schemaId":"schema_176"}}},{"code":"400","schemaId":"schema_175","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_175"}}},{"code":"401","schemaId":"schema_167","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_167"}}},{"code":"403","schemaId":"schema_168","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_168"}}},{"code":"404","schemaId":"schema_170","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_170"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/user-management/detailuser"}],"panels":[]}]},"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  SCIM patching documentation before executing.Quick GuidanceFor a seamless process, consider the following:"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"replaceUser","name":"Replace a user in the program","isWebhook":false,"pointer":"/paths/~1scim~1v2~1Users~1{user_id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Replace a user in the program","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To update or replace user information, ensure that your request includes a comprehensive set of user attributes."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"admonition","inline":true,"attributes":{"type":"warning"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Utilize "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PUT"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoints carefully. Modified data models caused by new features or user-defined fields may lead to data loss. Refer to our "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://developers.firstup.io/usermanagementapi/scim-patch-operations"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" SCIM patching documentation"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before executing."},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Quick Guidance"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a seamless process, consider the following:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://developers.firstup.io/endpoints/openapi/user-management/detailuser"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the user record"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to retrieve all current attributes and objects associated with the user."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Modify the values you wish to change within the retrieved user record."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Execute the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PUT"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" call with the modified user record to ensure no inadvertent data removal from the application."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alternatively, you can opt for a "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://developers.firstup.io/endpoints/openapi/user-management/patchuser"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PATCH"},"children":[]}]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" call to selectively modify specific attributes without affecting others."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Keep in mind that when updating a user's role using oath2_as_a_user, the acting user must have a role that's the same as or higher than both the starting and ending roles of the user being updated."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"admonition","inline":true,"attributes":{"type":"info"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" We advise refering to our "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://developers.firstup.io/usermanagementapi/scim-patch-operations"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" SCIM patching documentation"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before executing."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refer to our "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://developers.firstup.io/gettingstarted/error_responses"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" error responses documentation"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for detail on errors."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2_as_a_server","scopes":["users.write"],"type":"oauth2","description":"OAuth2 for Server-to-Server (Client Credentials grant flow)","flows":{"clientCredentials":{"tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","public":"View public information.","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","data_exports.read":"View and download data export files in your program."}}}}]},{"schemes":[{"name":"oauth2_as_a_user","scopes":["users.write"],"type":"oauth2","description":"OAuth2 for Users (Authorization Code grant flow)","flows":{"authorizationCode":{"authorizationUrl":"IAM_DOMAIN/oauth/authorize","tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","openid":"Authenticate your account using OpenID.","public":"View public information.","feeds.read":"View your feeds.","feeds.rendered.read":"View rendered content from feed posts.","feeds.engage":"View your feeds and engage with posts (likes, bookmarks, etc).","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","assistant.inbox.read":"View and list details of your assistant inbox items.","notification_center":"View and list notification center items.","data_exports.read":"View and download data export files in your program."}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"user_id","in":"path","schemaId":"schema_115","description":"ID of the user to update","required":true}],"pointer":"/paths/~1scim~1v2~1Users~1{user_id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Scim.User.UpdateRequestBody"}},"schemaId":"components/schemas/Scim.User.UpdateRequestBody","pointer":"/paths/~1scim~1v2~1Users~1{user_id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/scim/v2/Users/{user_id}","servers":[{"url":"https://partner.socialchorus.com","description":"US1"},{"url":"https://partner.us2.onfirstup.com","description":"US2"},{"url":"https://partner.onfirstup.eu","description":"EU"}],"parameters":{"path":[{"name":"user_id","in":"path","required":true,"schemaId":"schema_115"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2_as_a_server","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","public":"View public information.","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","data_exports.read":"View and download data export files in your program."}}}}],"scopes":["users.write"]},{"schemes":[{"id":"oauth2_as_a_user","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"IAM_DOMAIN/oauth/authorize","tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","openid":"Authenticate your account using OpenID.","public":"View public information.","feeds.read":"View your feeds.","feeds.rendered.read":"View rendered content from feed posts.","feeds.engage":"View your feeds and engage with posts (likes, bookmarks, etc).","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","assistant.inbox.read":"View and list details of your assistant inbox items.","notification_center":"View and list notification center items.","data_exports.read":"View and download data export files in your program."}}}}],"scopes":["users.write"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Scim.User.UpdateRequestBody"}},"responseCodes":["200","400","401","403"],"pointer":"/scim/v2/Users/{user_id}","href":"user-management/replaceuser","openApiOperationId":"replaceUser","summary":"Replace a user in the program","securityGroups":[{"oauth2_as_a_server":["users.write"]},{"oauth2_as_a_user":["users.write"]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://partner.socialchorus.com","description":"US1"},{"url":"https://partner.us2.onfirstup.com","description":"US2"},{"url":"https://partner.onfirstup.eu","description":"EU"}],"schemaId":"components/schemas/Scim.User.UpdateRequestBody","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Scim.User.UpdateRequestBody"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/scim+json","mediaTypes":["application/scim+json"],"mediaTypeContent":{"application/scim+json":{"schemaId":"schema_176"}},"schemaId":"schema_176"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request. See more on error responses "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://developers.firstup.io/gettingstarted/error_responses"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_175"}},"schemaId":"schema_175"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthenticated. See more on error responses "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://developers.firstup.io/gettingstarted/error_responses"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_167"}},"schemaId":"schema_167"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized. See more on error responses "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://developers.firstup.io/gettingstarted/error_responses"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_168"}},"schemaId":"schema_168"}],"pointer":"/paths/~1scim~1v2~1Users~1{user_id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_176","mediaTypes":["application/scim+json"],"mediaTypeContent":{"application/scim+json":{"schemaId":"schema_176"}}},{"code":"400","schemaId":"schema_175","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_175"}}},{"code":"401","schemaId":"schema_167","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_167"}}},{"code":"403","schemaId":"schema_168","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_168"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/user-management/replaceuser"}],"panels":[]}]},"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 SCIM PatchOp. 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  SCIM patching documentation before executing.Refer to our  error responses documentation for detail on errors."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchUser","name":"Update a user in the program","isWebhook":false,"pointer":"/paths/~1scim~1v2~1Users~1{user_id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a user in the program","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Update a user in the program with partial changes using "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://tools.ietf.org/html/rfc7644#section-3.5.2"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SCIM PatchOp"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". 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."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"admonition","inline":true,"attributes":{"type":"info"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" We advise refering to our "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://developers.firstup.io/usermanagementapi/scim-patch-operations"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" SCIM patching documentation"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before executing."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refer to our "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://developers.firstup.io/gettingstarted/error_responses"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" error responses documentation"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for detail on errors."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2_as_a_server","scopes":["users.write"],"type":"oauth2","description":"OAuth2 for Server-to-Server (Client Credentials grant flow)","flows":{"clientCredentials":{"tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","public":"View public information.","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","data_exports.read":"View and download data export files in your program."}}}}]},{"schemes":[{"name":"oauth2_as_a_user","scopes":["users.write"],"type":"oauth2","description":"OAuth2 for Users (Authorization Code grant flow)","flows":{"authorizationCode":{"authorizationUrl":"IAM_DOMAIN/oauth/authorize","tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","openid":"Authenticate your account using OpenID.","public":"View public information.","feeds.read":"View your feeds.","feeds.rendered.read":"View rendered content from feed posts.","feeds.engage":"View your feeds and engage with posts (likes, bookmarks, etc).","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","assistant.inbox.read":"View and list details of your assistant inbox items.","notification_center":"View and list notification center items.","data_exports.read":"View and download data export files in your program."}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"user_id","in":"path","schemaId":"schema_115","description":"Identifier of the user to patch. It could be used either the user's id, universal identifier, an email address, or external Id. The look up will be done in the above mentioned order.\n","required":true}],"pointer":"/paths/~1scim~1v2~1Users~1{user_id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Scim.User.PatchRequestBody"}},"schemaId":"components/schemas/Scim.User.PatchRequestBody","pointer":"/paths/~1scim~1v2~1Users~1{user_id}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/scim/v2/Users/{user_id}","servers":[{"url":"https://partner.socialchorus.com","description":"US1"},{"url":"https://partner.us2.onfirstup.com","description":"US2"},{"url":"https://partner.onfirstup.eu","description":"EU"}],"parameters":{"path":[{"name":"user_id","in":"path","required":true,"schemaId":"schema_115"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2_as_a_server","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","public":"View public information.","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","data_exports.read":"View and download data export files in your program."}}}}],"scopes":["users.write"]},{"schemes":[{"id":"oauth2_as_a_user","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"IAM_DOMAIN/oauth/authorize","tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","openid":"Authenticate your account using OpenID.","public":"View public information.","feeds.read":"View your feeds.","feeds.rendered.read":"View rendered content from feed posts.","feeds.engage":"View your feeds and engage with posts (likes, bookmarks, etc).","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","assistant.inbox.read":"View and list details of your assistant inbox items.","notification_center":"View and list notification center items.","data_exports.read":"View and download data export files in your program."}}}}],"scopes":["users.write"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Scim.User.PatchRequestBody"}},"responseCodes":["200","400","401","403"],"pointer":"/scim/v2/Users/{user_id}","href":"user-management/patchuser","openApiOperationId":"patchUser","summary":"Update a user in the program","securityGroups":[{"oauth2_as_a_server":["users.write"]},{"oauth2_as_a_user":["users.write"]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://partner.socialchorus.com","description":"US1"},{"url":"https://partner.us2.onfirstup.com","description":"US2"},{"url":"https://partner.onfirstup.eu","description":"EU"}],"schemaId":"components/schemas/Scim.User.PatchRequestBody","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Scim.User.PatchRequestBody"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/scim+json","mediaTypes":["application/scim+json"],"mediaTypeContent":{"application/scim+json":{"schemaId":"schema_176"}},"schemaId":"schema_176"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request. See more on error responses "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://developers.firstup.io/gettingstarted/error_responses"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_175"}},"schemaId":"schema_175"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthenticated. See more on error responses "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://developers.firstup.io/gettingstarted/error_responses"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_167"}},"schemaId":"schema_167"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized. See more on error responses "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://developers.firstup.io/gettingstarted/error_responses"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_168"}},"schemaId":"schema_168"}],"pointer":"/paths/~1scim~1v2~1Users~1{user_id}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_176","mediaTypes":["application/scim+json"],"mediaTypeContent":{"application/scim+json":{"schemaId":"schema_176"}}},{"code":"400","schemaId":"schema_175","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_175"}}},{"code":"401","schemaId":"schema_167","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_167"}}},{"code":"403","schemaId":"schema_168","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_168"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/user-management/patchuser"}],"panels":[]}]},"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteUser","name":"Completely remove a user from the system","isWebhook":false,"pointer":"/paths/~1scim~1v2~1Users~1{user_id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Completely remove a user from the system","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Permanently remove a User and their details from all Programs.\nA non-existent user, or a user that's already been forgotten, will return a 204.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2_as_a_server","scopes":["users.write"],"type":"oauth2","description":"OAuth2 for Server-to-Server (Client Credentials grant flow)","flows":{"clientCredentials":{"tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","public":"View public information.","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","data_exports.read":"View and download data export files in your program."}}}}]},{"schemes":[{"name":"oauth2_as_a_user","scopes":["users.write"],"type":"oauth2","description":"OAuth2 for Users (Authorization Code grant flow)","flows":{"authorizationCode":{"authorizationUrl":"IAM_DOMAIN/oauth/authorize","tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","openid":"Authenticate your account using OpenID.","public":"View public information.","feeds.read":"View your feeds.","feeds.rendered.read":"View rendered content from feed posts.","feeds.engage":"View your feeds and engage with posts (likes, bookmarks, etc).","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","assistant.inbox.read":"View and list details of your assistant inbox items.","notification_center":"View and list notification center items.","data_exports.read":"View and download data export files in your program."}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"user_id","in":"path","schemaId":"schema_115","description":"Identifier of the user to delete. It could be used either the user's id, universal identifier, an email address, or external Id. The look up will be done in the above mentioned order.\n","required":true}],"pointer":"/paths/~1scim~1v2~1Users~1{user_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/scim/v2/Users/{user_id}","servers":[{"url":"https://partner.socialchorus.com","description":"US1"},{"url":"https://partner.us2.onfirstup.com","description":"US2"},{"url":"https://partner.onfirstup.eu","description":"EU"}],"parameters":{"path":[{"name":"user_id","in":"path","required":true,"schemaId":"schema_115"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2_as_a_server","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","public":"View public information.","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","data_exports.read":"View and download data export files in your program."}}}}],"scopes":["users.write"]},{"schemes":[{"id":"oauth2_as_a_user","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"IAM_DOMAIN/oauth/authorize","tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","openid":"Authenticate your account using OpenID.","public":"View public information.","feeds.read":"View your feeds.","feeds.rendered.read":"View rendered content from feed posts.","feeds.engage":"View your feeds and engage with posts (likes, bookmarks, etc).","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","assistant.inbox.read":"View and list details of your assistant inbox items.","notification_center":"View and list notification center items.","data_exports.read":"View and download data export files in your program."}}}}],"scopes":["users.write"]}],"responseCodes":["204","400","401","403","404"],"pointer":"/scim/v2/Users/{user_id}","href":"user-management/deleteuser","openApiOperationId":"deleteUser","summary":"Completely remove a user from the system","securityGroups":[{"oauth2_as_a_server":["users.write"]},{"oauth2_as_a_user":["users.write"]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://partner.socialchorus.com","description":"US1"},{"url":"https://partner.us2.onfirstup.com","description":"US2"},{"url":"https://partner.onfirstup.eu","description":"EU"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Success"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request. See more on error responses "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://developers.firstup.io/gettingstarted/error_responses"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_175"}},"schemaId":"schema_175"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthenticated. See more on error responses "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://developers.firstup.io/gettingstarted/error_responses"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_167"}},"schemaId":"schema_167"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized. See more on error responses "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://developers.firstup.io/gettingstarted/error_responses"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_168"}},"schemaId":"schema_168"},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Not Found. See more on error responses "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://developers.firstup.io/gettingstarted/error_responses"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_170"}},"schemaId":"schema_170"}],"pointer":"/paths/~1scim~1v2~1Users~1{user_id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"schema_175","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_175"}}},{"code":"401","schemaId":"schema_167","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_167"}}},{"code":"403","schemaId":"schema_168","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_168"}}},{"code":"404","schemaId":"schema_170","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_170"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/user-management/deleteuser"}],"panels":[]}]},"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  authentication as a user."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"me","name":"Show information about the current user","isWebhook":false,"pointer":"/paths/~1scim~1v2~1Users~1me/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Show information about the current user","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a User record for specified user in the program."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"admonition","inline":true,"attributes":{"type":"info"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" This endpoint requires "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://developers.firstup.io/authorization/authentication-methods#jwt-bearer-token-grant"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" as a user."},"children":[]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/scim/v2/Users/me","servers":[{"url":"https://partner.socialchorus.com","description":"US1"},{"url":"https://partner.us2.onfirstup.com","description":"US2"},{"url":"https://partner.onfirstup.eu","description":"EU"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404"],"pointer":"/scim/v2/Users/me","href":"user-management/me","openApiOperationId":"me","summary":"Show information about the current user"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://partner.socialchorus.com","description":"US1"},{"url":"https://partner.us2.onfirstup.com","description":"US2"},{"url":"https://partner.onfirstup.eu","description":"EU"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/scim+json","mediaTypes":["application/scim+json"],"mediaTypeContent":{"application/scim+json":{"schemaId":"schema_176"}},"schemaId":"schema_176"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request. See more on error responses "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://developers.firstup.io/gettingstarted/error_responses"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_175"}},"schemaId":"schema_175"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthenticated. See more on error responses "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://developers.firstup.io/gettingstarted/error_responses"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_167"}},"schemaId":"schema_167"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized. See more on error responses "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://developers.firstup.io/gettingstarted/error_responses"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_168"}},"schemaId":"schema_168"},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Not Found. See more on error responses "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://developers.firstup.io/gettingstarted/error_responses"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_170"}},"schemaId":"schema_170"}],"pointer":"/paths/~1scim~1v2~1Users~1me/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_176","mediaTypes":["application/scim+json"],"mediaTypeContent":{"application/scim+json":{"schemaId":"schema_176"}}},{"code":"400","schemaId":"schema_175","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_175"}}},{"code":"401","schemaId":"schema_167","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_167"}}},{"code":"403","schemaId":"schema_168","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_168"}}},{"code":"404","schemaId":"schema_170","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_170"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/user-management/me"}],"panels":[]}]},"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"forgetUser","name":"Completely remove a user from the system (Not SCIM compliant)","isWebhook":false,"pointer":"/paths/~1v2~1Users~1{user_id}~1forget/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Completely remove a user from the system (Not SCIM compliant)","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Permanently remove a User and their details from all Programs.\nA non-existent user, or a user that's already been forgotten, will return a 202.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2_as_a_server","scopes":["users.write"],"type":"oauth2","description":"OAuth2 for Server-to-Server (Client Credentials grant flow)","flows":{"clientCredentials":{"tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","public":"View public information.","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","data_exports.read":"View and download data export files in your program."}}}}]},{"schemes":[{"name":"oauth2_as_a_user","scopes":["users.write"],"type":"oauth2","description":"OAuth2 for Users (Authorization Code grant flow)","flows":{"authorizationCode":{"authorizationUrl":"IAM_DOMAIN/oauth/authorize","tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","openid":"Authenticate your account using OpenID.","public":"View public information.","feeds.read":"View your feeds.","feeds.rendered.read":"View rendered content from feed posts.","feeds.engage":"View your feeds and engage with posts (likes, bookmarks, etc).","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","assistant.inbox.read":"View and list details of your assistant inbox items.","notification_center":"View and list notification center items.","data_exports.read":"View and download data export files in your program."}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"user_id","in":"path","schemaId":"schema_115","description":"ID of the user to forget","required":true}],"pointer":"/paths/~1v2~1Users~1{user_id}~1forget/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/Users/{user_id}/forget","servers":[{"url":"https://partner.socialchorus.com","description":"US1"},{"url":"https://partner.us2.onfirstup.com","description":"US2"},{"url":"https://partner.onfirstup.eu","description":"EU"}],"parameters":{"path":[{"name":"user_id","in":"path","required":true,"schemaId":"schema_115"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2_as_a_server","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","public":"View public information.","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","data_exports.read":"View and download data export files in your program."}}}}],"scopes":["users.write"]},{"schemes":[{"id":"oauth2_as_a_user","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"IAM_DOMAIN/oauth/authorize","tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","openid":"Authenticate your account using OpenID.","public":"View public information.","feeds.read":"View your feeds.","feeds.rendered.read":"View rendered content from feed posts.","feeds.engage":"View your feeds and engage with posts (likes, bookmarks, etc).","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","assistant.inbox.read":"View and list details of your assistant inbox items.","notification_center":"View and list notification center items.","data_exports.read":"View and download data export files in your program."}}}}],"scopes":["users.write"]}],"responseCodes":["202","400","401","403"],"pointer":"/v2/Users/{user_id}/forget","href":"user-management/forgetuser","openApiOperationId":"forgetUser","summary":"Completely remove a user from the system (Not SCIM compliant)","securityGroups":[{"oauth2_as_a_server":["users.write"]},{"oauth2_as_a_user":["users.write"]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://partner.socialchorus.com","description":"US1"},{"url":"https://partner.us2.onfirstup.com","description":"US2"},{"url":"https://partner.onfirstup.eu","description":"EU"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"Success"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request. See more on error responses "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://developers.firstup.io/gettingstarted/error_responses"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_175"}},"schemaId":"schema_175"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthenticated. See more on error responses "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://developers.firstup.io/gettingstarted/error_responses"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_167"}},"schemaId":"schema_167"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized. See more on error responses "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://developers.firstup.io/gettingstarted/error_responses"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_168"}},"schemaId":"schema_168"}],"pointer":"/paths/~1v2~1Users~1{user_id}~1forget/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"202"},{"code":"400","schemaId":"schema_175","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_175"}}},{"code":"401","schemaId":"schema_167","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_167"}}},{"code":"403","schemaId":"schema_168","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_168"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/user-management/forgetuser"}],"panels":[]}]},"httpPath":"/v2/Users/{user_id}/forget"}],"content":{"contentType":"group","meta":{"name":"User Management"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"User Management","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The User Management API adheres to the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://scim.cloud/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SCIM 2.0"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" protocol unless otherwise stated, and provides management and provisioning of users in a program. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Managing users requires that the acting user have a role of Program Manager or Administrator, and users can only create or update users with a role less than or equal to their own."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Resources"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"/usermanagementapi/user-management-overview"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"User Management contextual overview"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":".\n    "},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"/usermanagementapi/user-provisioning"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"User provisioning use case examples"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":".\n    "},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"/usermanagementapi/scim-patch-operations"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"SCIM patching and user editing use case examples"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"/usermanagementapi/custom-attributes"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Custom user attributes overview"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"/usermanagementapi/user-role-provisioning"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"User role and access"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/scim/v2/Schemas","summary":"List SCIM schemas","prefix":{"name":"get","color":"get"},"badges":[],"link":"/user-management/listschemas","deprecated":false},{"title":"/scim/v2/Schemas/{schema_id}","summary":"Detail a SCIM schema","prefix":{"name":"get","color":"get"},"badges":[],"link":"/user-management/detailschema","deprecated":false},{"title":"/scim/v2/ServiceProviderConfig","summary":"Provides SCIM Schema Provider Configuration","prefix":{"name":"get","color":"get"},"badges":[],"link":"/user-management/detailserviceproviderconfig","deprecated":false},{"title":"/scim/v2/ResourceTypes","summary":"Provides SCIM Resource Types","prefix":{"name":"get","color":"get"},"badges":[],"link":"/user-management/listresourcetypes","deprecated":false},{"title":"/scim/v2/ResourceTypes/{resource_id}","summary":"Detail a SCIM Resource Type","prefix":{"name":"get","color":"get"},"badges":[],"link":"/user-management/detailresourcetype","deprecated":false},{"title":"/scim/v2/Users","summary":"List users in the program","prefix":{"name":"get","color":"get"},"badges":[],"link":"/user-management/listusers","deprecated":false},{"title":"/scim/v2/Users","summary":"Create a user in the program","prefix":{"name":"post","color":"post"},"badges":[],"link":"/user-management/createuser","deprecated":false},{"title":"/scim/v2/Users/{user_id}","summary":"Show a single program user by ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/user-management/detailuser","deprecated":false},{"title":"/scim/v2/Users/{user_id}","summary":"Replace a user in the program","prefix":{"name":"put","color":"put"},"badges":[],"link":"/user-management/replaceuser","deprecated":false},{"title":"/scim/v2/Users/{user_id}","summary":"Update a user in the program","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/user-management/patchuser","deprecated":false},{"title":"/scim/v2/Users/{user_id}","summary":"Completely remove a user from the system","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/user-management/deleteuser","deprecated":false},{"title":"/scim/v2/Users/me","summary":"Show information about the current user","prefix":{"name":"get","color":"get"},"badges":[],"link":"/user-management/me","deprecated":false},{"title":"/v2/Users/{user_id}/forget","summary":"Completely remove a user from the system (Not SCIM compliant)","prefix":{"name":"post","color":"post"},"badges":[],"link":"/user-management/forgetuser","deprecated":false}]}]}]}]}},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listGroups","name":"Returns a list of Groups","isWebhook":false,"pointer":"/paths/~1scim~1v2~1Groups/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a list of Groups","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a list of all accessible Groups in the acting User's Program.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2_as_a_server","scopes":["groups.read"],"type":"oauth2","description":"OAuth2 for Server-to-Server (Client Credentials grant flow)","flows":{"clientCredentials":{"tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","public":"View public information.","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","data_exports.read":"View and download data export files in your program."}}}}]},{"schemes":[{"name":"oauth2_as_a_user","scopes":["groups.read"],"type":"oauth2","description":"OAuth2 for Users (Authorization Code grant flow)","flows":{"authorizationCode":{"authorizationUrl":"IAM_DOMAIN/oauth/authorize","tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","openid":"Authenticate your account using OpenID.","public":"View public information.","feeds.read":"View your feeds.","feeds.rendered.read":"View rendered content from feed posts.","feeds.engage":"View your feeds and engage with posts (likes, bookmarks, etc).","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","assistant.inbox.read":"View and list details of your assistant inbox items.","notification_center":"View and list notification center items.","data_exports.read":"View and download data export files in your program."}}}}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"startIndex","in":"query","schemaId":"schema_106","description":"\nSpecifies the 1-based index of the page of results to be returned.\n"},{"name":"count","in":"query","schemaId":"schema_106","description":"\nSpecifies the maximum number of results to be returned.\n"}],"pointer":"/paths/~1scim~1v2~1Groups/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/scim/v2/Groups","servers":[{"url":"https://partner.socialchorus.com","description":"US1"},{"url":"https://partner.us2.onfirstup.com","description":"US2"},{"url":"https://partner.onfirstup.eu","description":"EU"}],"parameters":{"path":[],"query":[{"name":"startIndex","in":"query","required":false,"schemaId":"schema_106"},{"name":"count","in":"query","required":false,"schemaId":"schema_106"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2_as_a_server","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","public":"View public information.","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","data_exports.read":"View and download data export files in your program."}}}}],"scopes":["groups.read"]},{"schemes":[{"id":"oauth2_as_a_user","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"IAM_DOMAIN/oauth/authorize","tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","openid":"Authenticate your account using OpenID.","public":"View public information.","feeds.read":"View your feeds.","feeds.rendered.read":"View rendered content from feed posts.","feeds.engage":"View your feeds and engage with posts (likes, bookmarks, etc).","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","assistant.inbox.read":"View and list details of your assistant inbox items.","notification_center":"View and list notification center items.","data_exports.read":"View and download data export files in your program."}}}}],"scopes":["groups.read"]}],"responseCodes":["200","400","401","403","404"],"pointer":"/scim/v2/Groups","href":"user-groups/listgroups","openApiOperationId":"listGroups","summary":"Returns a list of Groups","securityGroups":[{"oauth2_as_a_server":["groups.read"]},{"oauth2_as_a_user":["groups.read"]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://partner.socialchorus.com","description":"US1"},{"url":"https://partner.us2.onfirstup.com","description":"US2"},{"url":"https://partner.onfirstup.eu","description":"EU"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/scim+json","mediaTypes":["application/scim+json"],"mediaTypeContent":{"application/scim+json":{"schemaId":"schema_178"}},"schemaId":"schema_178"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request. See more on error responses "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://developers.firstup.io/gettingstarted/error_responses"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_175"}},"schemaId":"schema_175"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthenticated. See more on error responses "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://developers.firstup.io/gettingstarted/error_responses"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_167"}},"schemaId":"schema_167"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized. See more on error responses "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://developers.firstup.io/gettingstarted/error_responses"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_168"}},"schemaId":"schema_168"},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Not Found. See more on error responses "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://developers.firstup.io/gettingstarted/error_responses"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_170"}},"schemaId":"schema_170"}],"pointer":"/paths/~1scim~1v2~1Groups/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_178","mediaTypes":["application/scim+json"],"mediaTypeContent":{"application/scim+json":{"schemaId":"schema_178"}}},{"code":"400","schemaId":"schema_175","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_175"}}},{"code":"401","schemaId":"schema_167","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_167"}}},{"code":"403","schemaId":"schema_168","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_168"}}},{"code":"404","schemaId":"schema_170","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_170"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/user-groups/listgroups"}],"panels":[]}]},"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createGroup","name":"Creates a Group","isWebhook":false,"pointer":"/paths/~1scim~1v2~1Groups/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a Group","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates and provisions a new Group of Users. The request should include any properties to be set on"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the Group. Any property not provided would leave the value blank or use defaults."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The list of members could be empty or not present. Members are referenced with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"identifierField"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"by either:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"email"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"userName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (the default if no "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"identifierField"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is included)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This operation is asynchronous, the response will not include the list of members."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"JobId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will be in the response's meta, to be able to get a JobReport (see the ad hoc endpoint below)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indexing a Group's Users can take some time."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2_as_a_server","scopes":["groups.write"],"type":"oauth2","description":"OAuth2 for Server-to-Server (Client Credentials grant flow)","flows":{"clientCredentials":{"tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","public":"View public information.","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","data_exports.read":"View and download data export files in your program."}}}}]},{"schemes":[{"name":"oauth2_as_a_user","scopes":["groups.write"],"type":"oauth2","description":"OAuth2 for Users (Authorization Code grant flow)","flows":{"authorizationCode":{"authorizationUrl":"IAM_DOMAIN/oauth/authorize","tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","openid":"Authenticate your account using OpenID.","public":"View public information.","feeds.read":"View your feeds.","feeds.rendered.read":"View rendered content from feed posts.","feeds.engage":"View your feeds and engage with posts (likes, bookmarks, etc).","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","assistant.inbox.read":"View and list details of your assistant inbox items.","notification_center":"View and list notification center items.","data_exports.read":"View and download data export files in your program."}}}}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_179"}},"schemaId":"schema_179","pointer":"/paths/~1scim~1v2~1Groups/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/scim/v2/Groups","servers":[{"url":"https://partner.socialchorus.com","description":"US1"},{"url":"https://partner.us2.onfirstup.com","description":"US2"},{"url":"https://partner.onfirstup.eu","description":"EU"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2_as_a_server","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","public":"View public information.","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","data_exports.read":"View and download data export files in your program."}}}}],"scopes":["groups.write"]},{"schemes":[{"id":"oauth2_as_a_user","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"IAM_DOMAIN/oauth/authorize","tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","openid":"Authenticate your account using OpenID.","public":"View public information.","feeds.read":"View your feeds.","feeds.rendered.read":"View rendered content from feed posts.","feeds.engage":"View your feeds and engage with posts (likes, bookmarks, etc).","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","assistant.inbox.read":"View and list details of your assistant inbox items.","notification_center":"View and list notification center items.","data_exports.read":"View and download data export files in your program."}}}}],"scopes":["groups.write"]}],"requestBody":{"application/json":{"schemaId":"schema_179"}},"responseCodes":["201","400","401","403"],"pointer":"/scim/v2/Groups","href":"user-groups/creategroup","openApiOperationId":"createGroup","summary":"Creates a Group","securityGroups":[{"oauth2_as_a_server":["groups.write"]},{"oauth2_as_a_user":["groups.write"]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://partner.socialchorus.com","description":"US1"},{"url":"https://partner.us2.onfirstup.com","description":"US2"},{"url":"https://partner.onfirstup.eu","description":"EU"}],"schemaId":"schema_179","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_179"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Group created","mediaType":"application/scim+json","mediaTypes":["application/scim+json"],"mediaTypeContent":{"application/scim+json":{"schemaId":"schema_180"}},"schemaId":"schema_180"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request. See more on error responses "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://developers.firstup.io/gettingstarted/error_responses"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_175"}},"schemaId":"schema_175"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthenticated. See more on error responses "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://developers.firstup.io/gettingstarted/error_responses"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_167"}},"schemaId":"schema_167"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized. See more on error responses "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://developers.firstup.io/gettingstarted/error_responses"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_168"}},"schemaId":"schema_168"}],"pointer":"/paths/~1scim~1v2~1Groups/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_180","mediaTypes":["application/scim+json"],"mediaTypeContent":{"application/scim+json":{"schemaId":"schema_180"}}},{"code":"400","schemaId":"schema_175","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_175"}}},{"code":"401","schemaId":"schema_167","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_167"}}},{"code":"403","schemaId":"schema_168","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_168"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/user-groups/creategroup"}],"panels":[]}]},"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"detailGroup","name":"Returns the details of the given Group, including its members","isWebhook":false,"pointer":"/paths/~1scim~1v2~1Groups~1{group_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns the details of the given Group, including its members","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns the group specified by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"group_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Groups are defined by the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc7643#section-4.2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SCIM specification"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2_as_a_server","scopes":["groups.read"],"type":"oauth2","description":"OAuth2 for Server-to-Server (Client Credentials grant flow)","flows":{"clientCredentials":{"tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","public":"View public information.","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","data_exports.read":"View and download data export files in your program."}}}}]},{"schemes":[{"name":"oauth2_as_a_user","scopes":["groups.read"],"type":"oauth2","description":"OAuth2 for Users (Authorization Code grant flow)","flows":{"authorizationCode":{"authorizationUrl":"IAM_DOMAIN/oauth/authorize","tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","openid":"Authenticate your account using OpenID.","public":"View public information.","feeds.read":"View your feeds.","feeds.rendered.read":"View rendered content from feed posts.","feeds.engage":"View your feeds and engage with posts (likes, bookmarks, etc).","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","assistant.inbox.read":"View and list details of your assistant inbox items.","notification_center":"View and list notification center items.","data_exports.read":"View and download data export files in your program."}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"group_id","in":"path","schemaId":"schema_115","description":"ID of the group to look up.","required":true}],"pointer":"/paths/~1scim~1v2~1Groups~1{group_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/scim/v2/Groups/{group_id}","servers":[{"url":"https://partner.socialchorus.com","description":"US1"},{"url":"https://partner.us2.onfirstup.com","description":"US2"},{"url":"https://partner.onfirstup.eu","description":"EU"}],"parameters":{"path":[{"name":"group_id","in":"path","required":true,"schemaId":"schema_115"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2_as_a_server","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","public":"View public information.","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","data_exports.read":"View and download data export files in your program."}}}}],"scopes":["groups.read"]},{"schemes":[{"id":"oauth2_as_a_user","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"IAM_DOMAIN/oauth/authorize","tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","openid":"Authenticate your account using OpenID.","public":"View public information.","feeds.read":"View your feeds.","feeds.rendered.read":"View rendered content from feed posts.","feeds.engage":"View your feeds and engage with posts (likes, bookmarks, etc).","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","assistant.inbox.read":"View and list details of your assistant inbox items.","notification_center":"View and list notification center items.","data_exports.read":"View and download data export files in your program."}}}}],"scopes":["groups.read"]}],"responseCodes":["200","400","401","403","404"],"pointer":"/scim/v2/Groups/{group_id}","href":"user-groups/detailgroup","openApiOperationId":"detailGroup","summary":"Returns the details of the given Group, including its members","securityGroups":[{"oauth2_as_a_server":["groups.read"]},{"oauth2_as_a_user":["groups.read"]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://partner.socialchorus.com","description":"US1"},{"url":"https://partner.us2.onfirstup.com","description":"US2"},{"url":"https://partner.onfirstup.eu","description":"EU"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/scim+json","mediaTypes":["application/scim+json"],"mediaTypeContent":{"application/scim+json":{"schemaId":"schema_181"}},"schemaId":"schema_181"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request. See more on error responses "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://developers.firstup.io/gettingstarted/error_responses"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_175"}},"schemaId":"schema_175"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthenticated. See more on error responses "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://developers.firstup.io/gettingstarted/error_responses"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_167"}},"schemaId":"schema_167"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized. See more on error responses "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://developers.firstup.io/gettingstarted/error_responses"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_168"}},"schemaId":"schema_168"},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Not Found. See more on error responses "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://developers.firstup.io/gettingstarted/error_responses"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_170"}},"schemaId":"schema_170"}],"pointer":"/paths/~1scim~1v2~1Groups~1{group_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_181","mediaTypes":["application/scim+json"],"mediaTypeContent":{"application/scim+json":{"schemaId":"schema_181"}}},{"code":"400","schemaId":"schema_175","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_175"}}},{"code":"401","schemaId":"schema_167","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_167"}}},{"code":"403","schemaId":"schema_168","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_168"}}},{"code":"404","schemaId":"schema_170","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_170"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/user-groups/detailgroup"}],"panels":[]}]},"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchGroup","name":"Updates a Group","isWebhook":false,"pointer":"/paths/~1scim~1v2~1Groups~1{group_id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a Group","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Update an audience in the Program with partial changes using"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://tools.ietf.org/html/rfc7644#section-3.5.2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SCIM PatchOp"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Add or remove selected fields of the audience."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The list of members in the Group is referenced using the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"identifierField"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", by either:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"email"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"userName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (the default if no "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"identifierField"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is included)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All operations are supported: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"add"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"remove"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"replace"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"admonition","inline":true,"attributes":{"type":"info"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"replace"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" replaces "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"all the members"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the Group by the value sent"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(a full replace)."},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This operation is asynchronous, the response will not include the list of members."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"JobId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will be in the response's meta, to be able to get a JobReport (see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://developers.firstup.io/endpoints/openapi/user-groups/groupasyncjobreport"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" GET /v2/Groups/JobReport/{jobId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"admonition","inline":true,"attributes":{"type":"info"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" We advise refering to our "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://developers.firstup.io/usermanagementapi/scim-patch-operations"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" SCIM patching documentation"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before executing."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refer to our "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://developers.firstup.io/gettingstarted/error_responses"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" error responses documentation"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for detail on errors."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2_as_a_server","scopes":["groups.write"],"type":"oauth2","description":"OAuth2 for Server-to-Server (Client Credentials grant flow)","flows":{"clientCredentials":{"tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","public":"View public information.","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","data_exports.read":"View and download data export files in your program."}}}}]},{"schemes":[{"name":"oauth2_as_a_user","scopes":["groups.write"],"type":"oauth2","description":"OAuth2 for Users (Authorization Code grant flow)","flows":{"authorizationCode":{"authorizationUrl":"IAM_DOMAIN/oauth/authorize","tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","openid":"Authenticate your account using OpenID.","public":"View public information.","feeds.read":"View your feeds.","feeds.rendered.read":"View rendered content from feed posts.","feeds.engage":"View your feeds and engage with posts (likes, bookmarks, etc).","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","assistant.inbox.read":"View and list details of your assistant inbox items.","notification_center":"View and list notification center items.","data_exports.read":"View and download data export files in your program."}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"group_id","in":"path","schemaId":"schema_115","description":"ID of the audience to patch","required":true}],"pointer":"/paths/~1scim~1v2~1Groups~1{group_id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Scim.Group.PatchRequestBody"}},"schemaId":"components/schemas/Scim.Group.PatchRequestBody","pointer":"/paths/~1scim~1v2~1Groups~1{group_id}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/scim/v2/Groups/{group_id}","servers":[{"url":"https://partner.socialchorus.com","description":"US1"},{"url":"https://partner.us2.onfirstup.com","description":"US2"},{"url":"https://partner.onfirstup.eu","description":"EU"}],"parameters":{"path":[{"name":"group_id","in":"path","required":true,"schemaId":"schema_115"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2_as_a_server","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","public":"View public information.","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","data_exports.read":"View and download data export files in your program."}}}}],"scopes":["groups.write"]},{"schemes":[{"id":"oauth2_as_a_user","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"IAM_DOMAIN/oauth/authorize","tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","openid":"Authenticate your account using OpenID.","public":"View public information.","feeds.read":"View your feeds.","feeds.rendered.read":"View rendered content from feed posts.","feeds.engage":"View your feeds and engage with posts (likes, bookmarks, etc).","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","assistant.inbox.read":"View and list details of your assistant inbox items.","notification_center":"View and list notification center items.","data_exports.read":"View and download data export files in your program."}}}}],"scopes":["groups.write"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Scim.Group.PatchRequestBody"}},"responseCodes":["200","400","401","403","404"],"pointer":"/scim/v2/Groups/{group_id}","href":"user-groups/patchgroup","openApiOperationId":"patchGroup","summary":"Updates a Group","securityGroups":[{"oauth2_as_a_server":["groups.write"]},{"oauth2_as_a_user":["groups.write"]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://partner.socialchorus.com","description":"US1"},{"url":"https://partner.us2.onfirstup.com","description":"US2"},{"url":"https://partner.onfirstup.eu","description":"EU"}],"schemaId":"components/schemas/Scim.Group.PatchRequestBody","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Scim.Group.PatchRequestBody"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_180"}},"schemaId":"schema_180"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request. See more on error responses "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://developers.firstup.io/gettingstarted/error_responses"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_175"}},"schemaId":"schema_175"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthenticated. See more on error responses "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://developers.firstup.io/gettingstarted/error_responses"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_167"}},"schemaId":"schema_167"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized. See more on error responses "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://developers.firstup.io/gettingstarted/error_responses"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_168"}},"schemaId":"schema_168"},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Not Found. See more on error responses "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://developers.firstup.io/gettingstarted/error_responses"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_170"}},"schemaId":"schema_170"}],"pointer":"/paths/~1scim~1v2~1Groups~1{group_id}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_180","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_180"}}},{"code":"400","schemaId":"schema_175","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_175"}}},{"code":"401","schemaId":"schema_167","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_167"}}},{"code":"403","schemaId":"schema_168","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_168"}}},{"code":"404","schemaId":"schema_170","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_170"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/user-groups/patchgroup"}],"panels":[]}]},"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"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteGroup","name":"Deletes a Group","isWebhook":false,"pointer":"/paths/~1scim~1v2~1Groups~1{group_id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Deletes a Group","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Delete an audience in the Program\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2_as_a_server","scopes":["groups.write"],"type":"oauth2","description":"OAuth2 for Server-to-Server (Client Credentials grant flow)","flows":{"clientCredentials":{"tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","public":"View public information.","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","data_exports.read":"View and download data export files in your program."}}}}]},{"schemes":[{"name":"oauth2_as_a_user","scopes":["groups.write"],"type":"oauth2","description":"OAuth2 for Users (Authorization Code grant flow)","flows":{"authorizationCode":{"authorizationUrl":"IAM_DOMAIN/oauth/authorize","tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","openid":"Authenticate your account using OpenID.","public":"View public information.","feeds.read":"View your feeds.","feeds.rendered.read":"View rendered content from feed posts.","feeds.engage":"View your feeds and engage with posts (likes, bookmarks, etc).","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","assistant.inbox.read":"View and list details of your assistant inbox items.","notification_center":"View and list notification center items.","data_exports.read":"View and download data export files in your program."}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"group_id","in":"path","schemaId":"schema_115","description":"ID of the audience to delete","required":true}],"pointer":"/paths/~1scim~1v2~1Groups~1{group_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/scim/v2/Groups/{group_id}","servers":[{"url":"https://partner.socialchorus.com","description":"US1"},{"url":"https://partner.us2.onfirstup.com","description":"US2"},{"url":"https://partner.onfirstup.eu","description":"EU"}],"parameters":{"path":[{"name":"group_id","in":"path","required":true,"schemaId":"schema_115"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2_as_a_server","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","public":"View public information.","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","data_exports.read":"View and download data export files in your program."}}}}],"scopes":["groups.write"]},{"schemes":[{"id":"oauth2_as_a_user","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"IAM_DOMAIN/oauth/authorize","tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","openid":"Authenticate your account using OpenID.","public":"View public information.","feeds.read":"View your feeds.","feeds.rendered.read":"View rendered content from feed posts.","feeds.engage":"View your feeds and engage with posts (likes, bookmarks, etc).","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","assistant.inbox.read":"View and list details of your assistant inbox items.","notification_center":"View and list notification center items.","data_exports.read":"View and download data export files in your program."}}}}],"scopes":["groups.write"]}],"responseCodes":["204","400","401","403"],"pointer":"/scim/v2/Groups/{group_id}","href":"user-groups/deletegroup","openApiOperationId":"deleteGroup","summary":"Deletes a Group","securityGroups":[{"oauth2_as_a_server":["groups.write"]},{"oauth2_as_a_user":["groups.write"]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://partner.socialchorus.com","description":"US1"},{"url":"https://partner.us2.onfirstup.com","description":"US2"},{"url":"https://partner.onfirstup.eu","description":"EU"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Deleted"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request. See more on error responses "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://developers.firstup.io/gettingstarted/error_responses"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_175"}},"schemaId":"schema_175"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthenticated. See more on error responses "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://developers.firstup.io/gettingstarted/error_responses"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_167"}},"schemaId":"schema_167"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized. See more on error responses "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://developers.firstup.io/gettingstarted/error_responses"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_168"}},"schemaId":"schema_168"}],"pointer":"/paths/~1scim~1v2~1Groups~1{group_id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"schema_175","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_175"}}},{"code":"401","schemaId":"schema_167","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_167"}}},{"code":"403","schemaId":"schema_168","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_168"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/user-groups/deletegroup"}],"panels":[]}]},"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateGroup","name":"Updates a Group","isWebhook":false,"pointer":"/paths/~1scim~1v2~1Groups~1{group_id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a Group","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Updates and provisions an existing Group of Users. The request should include any properties to be set on"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the Group. Any property not provided would leave the value blank or use defaults."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The list of members could be empty or not present. Members are referenced with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"identifierField"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"by either:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"email"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"userName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (the default if no "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"identifierField"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is included)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This operation is asynchronous, the response will not include the list of members."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"JobId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will be in the response's meta, to be able to get a JobReport ("},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://developers.firstup.io/endpoints/openapi/user-groups/groupasyncjobreport"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" GET /v2/Groups/JobReport/{jobId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indexing a Group's Users can take some time."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2_as_a_server","scopes":["groups.write"],"type":"oauth2","description":"OAuth2 for Server-to-Server (Client Credentials grant flow)","flows":{"clientCredentials":{"tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","public":"View public information.","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","data_exports.read":"View and download data export files in your program."}}}}]},{"schemes":[{"name":"oauth2_as_a_user","scopes":["groups.write"],"type":"oauth2","description":"OAuth2 for Users (Authorization Code grant flow)","flows":{"authorizationCode":{"authorizationUrl":"IAM_DOMAIN/oauth/authorize","tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","openid":"Authenticate your account using OpenID.","public":"View public information.","feeds.read":"View your feeds.","feeds.rendered.read":"View rendered content from feed posts.","feeds.engage":"View your feeds and engage with posts (likes, bookmarks, etc).","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","assistant.inbox.read":"View and list details of your assistant inbox items.","notification_center":"View and list notification center items.","data_exports.read":"View and download data export files in your program."}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"group_id","in":"path","schemaId":"schema_115","description":"ID of the audience to update","required":true}],"pointer":"/paths/~1scim~1v2~1Groups~1{group_id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_179"}},"schemaId":"schema_179","pointer":"/paths/~1scim~1v2~1Groups~1{group_id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/scim/v2/Groups/{group_id}","servers":[{"url":"https://partner.socialchorus.com","description":"US1"},{"url":"https://partner.us2.onfirstup.com","description":"US2"},{"url":"https://partner.onfirstup.eu","description":"EU"}],"parameters":{"path":[{"name":"group_id","in":"path","required":true,"schemaId":"schema_115"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2_as_a_server","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","public":"View public information.","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","data_exports.read":"View and download data export files in your program."}}}}],"scopes":["groups.write"]},{"schemes":[{"id":"oauth2_as_a_user","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"IAM_DOMAIN/oauth/authorize","tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","openid":"Authenticate your account using OpenID.","public":"View public information.","feeds.read":"View your feeds.","feeds.rendered.read":"View rendered content from feed posts.","feeds.engage":"View your feeds and engage with posts (likes, bookmarks, etc).","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","assistant.inbox.read":"View and list details of your assistant inbox items.","notification_center":"View and list notification center items.","data_exports.read":"View and download data export files in your program."}}}}],"scopes":["groups.write"]}],"requestBody":{"application/json":{"schemaId":"schema_179"}},"responseCodes":["200","400","401","403"],"pointer":"/scim/v2/Groups/{group_id}","href":"user-groups/updategroup","openApiOperationId":"updateGroup","summary":"Updates a Group","securityGroups":[{"oauth2_as_a_server":["groups.write"]},{"oauth2_as_a_user":["groups.write"]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://partner.socialchorus.com","description":"US1"},{"url":"https://partner.us2.onfirstup.com","description":"US2"},{"url":"https://partner.onfirstup.eu","description":"EU"}],"schemaId":"schema_179","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_179"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Group updated","mediaType":"application/scim+json","mediaTypes":["application/scim+json"],"mediaTypeContent":{"application/scim+json":{"schemaId":"schema_180"}},"schemaId":"schema_180"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request. See more on error responses "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://developers.firstup.io/gettingstarted/error_responses"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_175"}},"schemaId":"schema_175"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthenticated. See more on error responses "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://developers.firstup.io/gettingstarted/error_responses"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_167"}},"schemaId":"schema_167"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized. See more on error responses "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://developers.firstup.io/gettingstarted/error_responses"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_168"}},"schemaId":"schema_168"}],"pointer":"/paths/~1scim~1v2~1Groups~1{group_id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_180","mediaTypes":["application/scim+json"],"mediaTypeContent":{"application/scim+json":{"schemaId":"schema_180"}}},{"code":"400","schemaId":"schema_175","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_175"}}},{"code":"401","schemaId":"schema_167","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_167"}}},{"code":"403","schemaId":"schema_168","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_168"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/user-groups/updategroup"}],"panels":[]}]},"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"groupAsyncJobReport","name":"Returns details on asynchronous jobs to modify a Group's members","isWebhook":false,"pointer":"/paths/~1v2~1Groups~1JobReport~1{jobId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns details on asynchronous jobs to modify a Group's members","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The calls to the POST, PUT or PATCH "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Groups Managements"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoints trigger a series of asynchronous jobs to create or update the list of the Group's members."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As these tasks are asynchronous, those API calls do not respond with the final list of the Group's members, but an unique Job identifier to inquire about the task."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint takes the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"jobId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" identifier, and returns details about the asynchronous job's execution."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The job could have already finished or still be running, and the response could include details on the number of members added, removed, processed, and error conditions (if any)."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2_as_a_server","scopes":["groups.read"],"type":"oauth2","description":"OAuth2 for Server-to-Server (Client Credentials grant flow)","flows":{"clientCredentials":{"tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","public":"View public information.","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","data_exports.read":"View and download data export files in your program."}}}}]},{"schemes":[{"name":"oauth2_as_a_user","scopes":["groups.read"],"type":"oauth2","description":"OAuth2 for Users (Authorization Code grant flow)","flows":{"authorizationCode":{"authorizationUrl":"IAM_DOMAIN/oauth/authorize","tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","openid":"Authenticate your account using OpenID.","public":"View public information.","feeds.read":"View your feeds.","feeds.rendered.read":"View rendered content from feed posts.","feeds.engage":"View your feeds and engage with posts (likes, bookmarks, etc).","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","assistant.inbox.read":"View and list details of your assistant inbox items.","notification_center":"View and list notification center items.","data_exports.read":"View and download data export files in your program."}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"jobId","in":"path","schemaId":"schema_106","description":"The unique identifier of one asynchronous Job","required":true}],"pointer":"/paths/~1v2~1Groups~1JobReport~1{jobId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/Groups/JobReport/{jobId}","servers":[{"url":"https://partner.socialchorus.com","description":"US1"},{"url":"https://partner.us2.onfirstup.com","description":"US2"},{"url":"https://partner.onfirstup.eu","description":"EU"}],"parameters":{"path":[{"name":"jobId","in":"path","required":true,"schemaId":"schema_106"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2_as_a_server","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","public":"View public information.","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","data_exports.read":"View and download data export files in your program."}}}}],"scopes":["groups.read"]},{"schemes":[{"id":"oauth2_as_a_user","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"IAM_DOMAIN/oauth/authorize","tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","openid":"Authenticate your account using OpenID.","public":"View public information.","feeds.read":"View your feeds.","feeds.rendered.read":"View rendered content from feed posts.","feeds.engage":"View your feeds and engage with posts (likes, bookmarks, etc).","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","assistant.inbox.read":"View and list details of your assistant inbox items.","notification_center":"View and list notification center items.","data_exports.read":"View and download data export files in your program."}}}}],"scopes":["groups.read"]}],"responseCodes":["200","400","401","403","404"],"pointer":"/v2/Groups/JobReport/{jobId}","href":"user-groups/groupasyncjobreport","openApiOperationId":"groupAsyncJobReport","summary":"Returns details on asynchronous jobs to modify a Group's members","securityGroups":[{"oauth2_as_a_server":["groups.read"]},{"oauth2_as_a_user":["groups.read"]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://partner.socialchorus.com","description":"US1"},{"url":"https://partner.us2.onfirstup.com","description":"US2"},{"url":"https://partner.onfirstup.eu","description":"EU"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_182"}},"schemaId":"schema_182"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request. See more on error responses "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://developers.firstup.io/gettingstarted/error_responses"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_175"}},"schemaId":"schema_175"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthenticated. See more on error responses "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://developers.firstup.io/gettingstarted/error_responses"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_167"}},"schemaId":"schema_167"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized. See more on error responses "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://developers.firstup.io/gettingstarted/error_responses"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_168"}},"schemaId":"schema_168"},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Not Found. See more on error responses "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://developers.firstup.io/gettingstarted/error_responses"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_170"}},"schemaId":"schema_170"}],"pointer":"/paths/~1v2~1Groups~1JobReport~1{jobId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_182","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_182"}}},{"code":"400","schemaId":"schema_175","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_175"}}},{"code":"401","schemaId":"schema_167","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_167"}}},{"code":"403","schemaId":"schema_168","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_168"}}},{"code":"404","schemaId":"schema_170","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_170"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/user-groups/groupasyncjobreport"}],"panels":[]}]},"httpPath":"/v2/Groups/JobReport/{jobId}"}],"content":{"contentType":"group","meta":{"name":"User Groups"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"User Groups","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Group Management API adheres to the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://scim.cloud/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SCIM 2.0"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" protocol "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"unless otherwise stated"},"children":[]}]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and provides management and provisioning of Groups and its members (Users) within a Program. Managing Groups requires that the acting User have a role of Program Manager or Administrator, and Group read and/or write access. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"admonition","inline":true,"attributes":{"type":"info"},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User groups are SCIM groups only. Currently, this API does not support creating "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://support.firstup.io/hc/en-us/articles/4412604456983-Overview-How-to-Use-Audiences"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" audiences "},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/scim/v2/Groups","summary":"Returns a list of Groups","prefix":{"name":"get","color":"get"},"badges":[],"link":"/user-groups/listgroups","deprecated":false},{"title":"/scim/v2/Groups","summary":"Creates a Group","prefix":{"name":"post","color":"post"},"badges":[],"link":"/user-groups/creategroup","deprecated":false},{"title":"/scim/v2/Groups/{group_id}","summary":"Returns the details of the given Group, including its members","prefix":{"name":"get","color":"get"},"badges":[],"link":"/user-groups/detailgroup","deprecated":false},{"title":"/scim/v2/Groups/{group_id}","summary":"Updates a Group","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/user-groups/patchgroup","deprecated":false},{"title":"/scim/v2/Groups/{group_id}","summary":"Deletes a Group","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/user-groups/deletegroup","deprecated":false},{"title":"/scim/v2/Groups/{group_id}","summary":"Updates a Group","prefix":{"name":"put","color":"put"},"badges":[],"link":"/user-groups/updategroup","deprecated":false},{"title":"/v2/Groups/JobReport/{jobId}","summary":"Returns details on asynchronous jobs to modify a Group's members","prefix":{"name":"get","color":"get"},"badges":[],"link":"/user-groups/groupasyncjobreport","deprecated":false}]}]}]}]}},{"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":"Fetchs multiple subscription records at a time, and can be paginated using cursor pagination. "}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listWebhookSubscriptions","name":"Fetch the program's configured webhook subscriptions","isWebhook":false,"pointer":"/paths/~1v2~1webhooks~1subscriptions/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetch the program's configured webhook subscriptions","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Fetchs multiple subscription records at a time, and can be paginated using cursor pagination. "},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2_as_a_user","scopes":["webhooks.read"],"type":"oauth2","description":"OAuth2 for Users (Authorization Code grant flow)","flows":{"authorizationCode":{"authorizationUrl":"IAM_DOMAIN/oauth/authorize","tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","openid":"Authenticate your account using OpenID.","public":"View public information.","feeds.read":"View your feeds.","feeds.rendered.read":"View rendered content from feed posts.","feeds.engage":"View your feeds and engage with posts (likes, bookmarks, etc).","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","assistant.inbox.read":"View and list details of your assistant inbox items.","notification_center":"View and list notification center items.","data_exports.read":"View and download data export files in your program."}}}}]},{"schemes":[{"name":"oauth2_as_a_server","scopes":["webhooks.read"],"type":"oauth2","description":"OAuth2 for Server-to-Server (Client Credentials grant flow)","flows":{"clientCredentials":{"tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","public":"View public information.","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","data_exports.read":"View and download data export files in your program."}}}}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page.size","in":"query","schemaId":"schema_103","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Return "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"page.size"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" number of records starting at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"size*number"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The default page size is 10 (number of records per page), resulting in the first page being retrieved. The maximum page size is 100."},"children":[]}]}]}]},{"name":"page.number","in":"query","schemaId":"schema_103","description":"Using classical pagination, the page number to return. Default is 1"}],"pointer":"/paths/~1v2~1webhooks~1subscriptions/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/webhooks/subscriptions","servers":[{"url":"https://partner.socialchorus.com","description":"US1"},{"url":"https://partner.us2.onfirstup.com","description":"US2"},{"url":"https://partner.onfirstup.eu","description":"EU"}],"parameters":{"path":[],"query":[{"name":"page.size","in":"query","required":false,"schemaId":"schema_103"},{"name":"page.number","in":"query","required":false,"schemaId":"schema_103"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2_as_a_user","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"IAM_DOMAIN/oauth/authorize","tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","openid":"Authenticate your account using OpenID.","public":"View public information.","feeds.read":"View your feeds.","feeds.rendered.read":"View rendered content from feed posts.","feeds.engage":"View your feeds and engage with posts (likes, bookmarks, etc).","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","assistant.inbox.read":"View and list details of your assistant inbox items.","notification_center":"View and list notification center items.","data_exports.read":"View and download data export files in your program."}}}}],"scopes":["webhooks.read"]},{"schemes":[{"id":"oauth2_as_a_server","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","public":"View public information.","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","data_exports.read":"View and download data export files in your program."}}}}],"scopes":["webhooks.read"]}],"responseCodes":["200","400","401"],"pointer":"/v2/webhooks/subscriptions","href":"webhooks/listwebhooksubscriptions","openApiOperationId":"listWebhookSubscriptions","summary":"Fetch the program's configured webhook subscriptions","securityGroups":[{"oauth2_as_a_user":["webhooks.read"]},{"oauth2_as_a_server":["webhooks.read"]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://partner.socialchorus.com","description":"US1"},{"url":"https://partner.us2.onfirstup.com","description":"US2"},{"url":"https://partner.onfirstup.eu","description":"EU"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_183"}},"schemaId":"schema_183"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}},"schemaId":"schema_101"},{"code":"401","description":"Unauthenticated","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}},"schemaId":"schema_101"}],"pointer":"/paths/~1v2~1webhooks~1subscriptions/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_183","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_183"}}},{"code":"400","schemaId":"schema_101","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}}},{"code":"401","schemaId":"schema_101","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooks/listwebhooksubscriptions"}],"panels":[]}]},"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":"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 authorization_header property allows you to specify what value to send in the \"Authorization\" http header of every delivery to your url."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createWebhookSubscription","name":"Create a new webhook subscription","isWebhook":false,"pointer":"/paths/~1v2~1webhooks~1subscriptions/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a new webhook subscription","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"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 "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"authorization_header"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" property allows you to specify what value to send in the \"Authorization\" http header of every delivery to your url."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"More information about creating webhook subscriptions is available on the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"/webhooks/webhooks-overview"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Creating Webhook Subscriptions"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" page, and the list of available events is available on the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"/webhooks/webhook-events"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Event List"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" page."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"The access token used when creating a subscription must have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"webhooks.write"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"/authorization/authenticationandauthorization#auth-scope-list-and-definitions"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"auth scope"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":". "},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2_as_a_user","scopes":["webhooks.write"],"type":"oauth2","description":"OAuth2 for Users (Authorization Code grant flow)","flows":{"authorizationCode":{"authorizationUrl":"IAM_DOMAIN/oauth/authorize","tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","openid":"Authenticate your account using OpenID.","public":"View public information.","feeds.read":"View your feeds.","feeds.rendered.read":"View rendered content from feed posts.","feeds.engage":"View your feeds and engage with posts (likes, bookmarks, etc).","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","assistant.inbox.read":"View and list details of your assistant inbox items.","notification_center":"View and list notification center items.","data_exports.read":"View and download data export files in your program."}}}}]},{"schemes":[{"name":"oauth2_as_a_server","scopes":["webhooks.write"],"type":"oauth2","description":"OAuth2 for Server-to-Server (Client Credentials grant flow)","flows":{"clientCredentials":{"tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","public":"View public information.","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","data_exports.read":"View and download data export files in your program."}}}}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Webhooks.Subscription.CreateRequestBody"}},"schemaId":"components/schemas/Webhooks.Subscription.CreateRequestBody","pointer":"/paths/~1v2~1webhooks~1subscriptions/post/requestBody","description":"Attributes of the webhook subscription to create."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/webhooks/subscriptions","servers":[{"url":"https://partner.socialchorus.com","description":"US1"},{"url":"https://partner.us2.onfirstup.com","description":"US2"},{"url":"https://partner.onfirstup.eu","description":"EU"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2_as_a_user","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"IAM_DOMAIN/oauth/authorize","tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","openid":"Authenticate your account using OpenID.","public":"View public information.","feeds.read":"View your feeds.","feeds.rendered.read":"View rendered content from feed posts.","feeds.engage":"View your feeds and engage with posts (likes, bookmarks, etc).","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","assistant.inbox.read":"View and list details of your assistant inbox items.","notification_center":"View and list notification center items.","data_exports.read":"View and download data export files in your program."}}}}],"scopes":["webhooks.write"]},{"schemes":[{"id":"oauth2_as_a_server","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","public":"View public information.","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","data_exports.read":"View and download data export files in your program."}}}}],"scopes":["webhooks.write"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Webhooks.Subscription.CreateRequestBody"}},"responseCodes":["201","400","401"],"pointer":"/v2/webhooks/subscriptions","href":"webhooks/createwebhooksubscription","openApiOperationId":"createWebhookSubscription","summary":"Create a new webhook subscription","securityGroups":[{"oauth2_as_a_user":["webhooks.write"]},{"oauth2_as_a_server":["webhooks.write"]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://partner.socialchorus.com","description":"US1"},{"url":"https://partner.us2.onfirstup.com","description":"US2"},{"url":"https://partner.onfirstup.eu","description":"EU"}],"schemaId":"components/schemas/Webhooks.Subscription.CreateRequestBody","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Webhooks.Subscription.CreateRequestBody"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_184"}},"schemaId":"schema_184"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}},"schemaId":"schema_101"},{"code":"401","description":"Unauthenticated","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}},"schemaId":"schema_101"}],"pointer":"/paths/~1v2~1webhooks~1subscriptions/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_184","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_184"}}},{"code":"400","schemaId":"schema_101","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}}},{"code":"401","schemaId":"schema_101","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooks/createwebhooksubscription"}],"panels":[]}]},"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":"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateWebhookSubscription","name":"Update an existing webhook subscription","isWebhook":false,"pointer":"/paths/~1v2~1webhooks~1subscriptions~1{subscription_id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update an existing webhook subscription","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"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."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"The update method is a patch operation, so only properties you send in the request will be updated on the record. The "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"events"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" property, however, does not support partial updates as an array. "},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"The access token used when updating a subscription must have the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"webhooks.write"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"/authorization/authenticationandauthorization#auth-scope-list-and-definitions"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"auth scope"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":". "},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2_as_a_user","scopes":["webhooks.write"],"type":"oauth2","description":"OAuth2 for Users (Authorization Code grant flow)","flows":{"authorizationCode":{"authorizationUrl":"IAM_DOMAIN/oauth/authorize","tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","openid":"Authenticate your account using OpenID.","public":"View public information.","feeds.read":"View your feeds.","feeds.rendered.read":"View rendered content from feed posts.","feeds.engage":"View your feeds and engage with posts (likes, bookmarks, etc).","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","assistant.inbox.read":"View and list details of your assistant inbox items.","notification_center":"View and list notification center items.","data_exports.read":"View and download data export files in your program."}}}}]},{"schemes":[{"name":"oauth2_as_a_server","scopes":["webhooks.write"],"type":"oauth2","description":"OAuth2 for Server-to-Server (Client Credentials grant flow)","flows":{"clientCredentials":{"tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","public":"View public information.","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","data_exports.read":"View and download data export files in your program."}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"subscription_id","in":"path","schemaId":"schema_115","description":"Id of the subscription to update","required":true}],"pointer":"/paths/~1v2~1webhooks~1subscriptions~1{subscription_id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Webhooks.Subscription.CreateRequestBody"}},"schemaId":"components/schemas/Webhooks.Subscription.CreateRequestBody","pointer":"/paths/~1v2~1webhooks~1subscriptions~1{subscription_id}/put/requestBody","description":"Attributes of the webhook subscription to update."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v2/webhooks/subscriptions/{subscription_id}","servers":[{"url":"https://partner.socialchorus.com","description":"US1"},{"url":"https://partner.us2.onfirstup.com","description":"US2"},{"url":"https://partner.onfirstup.eu","description":"EU"}],"parameters":{"path":[{"name":"subscription_id","in":"path","required":true,"schemaId":"schema_115"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2_as_a_user","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"IAM_DOMAIN/oauth/authorize","tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","openid":"Authenticate your account using OpenID.","public":"View public information.","feeds.read":"View your feeds.","feeds.rendered.read":"View rendered content from feed posts.","feeds.engage":"View your feeds and engage with posts (likes, bookmarks, etc).","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","assistant.inbox.read":"View and list details of your assistant inbox items.","notification_center":"View and list notification center items.","data_exports.read":"View and download data export files in your program."}}}}],"scopes":["webhooks.write"]},{"schemes":[{"id":"oauth2_as_a_server","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","public":"View public information.","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","data_exports.read":"View and download data export files in your program."}}}}],"scopes":["webhooks.write"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Webhooks.Subscription.CreateRequestBody"}},"responseCodes":["200","400","401"],"pointer":"/v2/webhooks/subscriptions/{subscription_id}","href":"webhooks/updatewebhooksubscription","openApiOperationId":"updateWebhookSubscription","summary":"Update an existing webhook subscription","securityGroups":[{"oauth2_as_a_user":["webhooks.write"]},{"oauth2_as_a_server":["webhooks.write"]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://partner.socialchorus.com","description":"US1"},{"url":"https://partner.us2.onfirstup.com","description":"US2"},{"url":"https://partner.onfirstup.eu","description":"EU"}],"schemaId":"components/schemas/Webhooks.Subscription.CreateRequestBody","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Webhooks.Subscription.CreateRequestBody"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_184"}},"schemaId":"schema_184"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}},"schemaId":"schema_101"},{"code":"401","description":"Unauthenticated","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}},"schemaId":"schema_101"}],"pointer":"/paths/~1v2~1webhooks~1subscriptions~1{subscription_id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_184","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_184"}}},{"code":"400","schemaId":"schema_101","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}}},{"code":"401","schemaId":"schema_101","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooks/updatewebhooksubscription"}],"panels":[]}]},"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteWebhookSubscription","name":"Delete a webhook subscription permanently","isWebhook":false,"pointer":"/paths/~1v2~1webhooks~1subscriptions~1{subscription_id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a webhook subscription permanently","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deactivate a webhook subscription and remove the record permanently."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"admonition","inline":true,"attributes":{"type":"warning"},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Warning"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": you cannot undo this action."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2_as_a_server","scopes":["webhooks.write"],"type":"oauth2","description":"OAuth2 for Server-to-Server (Client Credentials grant flow)","flows":{"clientCredentials":{"tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","public":"View public information.","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","data_exports.read":"View and download data export files in your program."}}}}]},{"schemes":[{"name":"oauth2_as_a_user","scopes":["webhooks.write"],"type":"oauth2","description":"OAuth2 for Users (Authorization Code grant flow)","flows":{"authorizationCode":{"authorizationUrl":"IAM_DOMAIN/oauth/authorize","tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","openid":"Authenticate your account using OpenID.","public":"View public information.","feeds.read":"View your feeds.","feeds.rendered.read":"View rendered content from feed posts.","feeds.engage":"View your feeds and engage with posts (likes, bookmarks, etc).","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","assistant.inbox.read":"View and list details of your assistant inbox items.","notification_center":"View and list notification center items.","data_exports.read":"View and download data export files in your program."}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"subscription_id","in":"path","schemaId":"schema_106","description":"Id of the subscription to delete","required":true}],"pointer":"/paths/~1v2~1webhooks~1subscriptions~1{subscription_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v2/webhooks/subscriptions/{subscription_id}","servers":[{"url":"https://partner.socialchorus.com","description":"US1"},{"url":"https://partner.us2.onfirstup.com","description":"US2"},{"url":"https://partner.onfirstup.eu","description":"EU"}],"parameters":{"path":[{"name":"subscription_id","in":"path","required":true,"schemaId":"schema_106"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2_as_a_server","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","public":"View public information.","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","data_exports.read":"View and download data export files in your program."}}}}],"scopes":["webhooks.write"]},{"schemes":[{"id":"oauth2_as_a_user","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"IAM_DOMAIN/oauth/authorize","tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","openid":"Authenticate your account using OpenID.","public":"View public information.","feeds.read":"View your feeds.","feeds.rendered.read":"View rendered content from feed posts.","feeds.engage":"View your feeds and engage with posts (likes, bookmarks, etc).","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","assistant.inbox.read":"View and list details of your assistant inbox items.","notification_center":"View and list notification center items.","data_exports.read":"View and download data export files in your program."}}}}],"scopes":["webhooks.write"]}],"responseCodes":["204","400","401","403"],"pointer":"/v2/webhooks/subscriptions/{subscription_id}","href":"webhooks/deletewebhooksubscription","openApiOperationId":"deleteWebhookSubscription","summary":"Delete a webhook subscription permanently","securityGroups":[{"oauth2_as_a_server":["webhooks.write"]},{"oauth2_as_a_user":["webhooks.write"]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://partner.socialchorus.com","description":"US1"},{"url":"https://partner.us2.onfirstup.com","description":"US2"},{"url":"https://partner.onfirstup.eu","description":"EU"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Success"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}},"schemaId":"schema_101"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthenticated. See more on error responses "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://developers.firstup.io/gettingstarted/error_responses"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_120"}},"schemaId":"schema_120"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized. See more on error responses "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://developers.firstup.io/gettingstarted/error_responses"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_121"}},"schemaId":"schema_121"}],"pointer":"/paths/~1v2~1webhooks~1subscriptions~1{subscription_id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"schema_101","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}}},{"code":"401","schemaId":"schema_120","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_120"}}},{"code":"403","schemaId":"schema_121","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_121"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooks/deletewebhooksubscription"}],"panels":[]}]},"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"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"detailWebhookSubscription","name":"Fetch a single webhook subscription record","isWebhook":false,"pointer":"/paths/~1v2~1webhooks~1subscriptions~1{subscription_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetch a single webhook subscription record","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2_as_a_user","scopes":["webhooks.read"],"type":"oauth2","description":"OAuth2 for Users (Authorization Code grant flow)","flows":{"authorizationCode":{"authorizationUrl":"IAM_DOMAIN/oauth/authorize","tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","openid":"Authenticate your account using OpenID.","public":"View public information.","feeds.read":"View your feeds.","feeds.rendered.read":"View rendered content from feed posts.","feeds.engage":"View your feeds and engage with posts (likes, bookmarks, etc).","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","assistant.inbox.read":"View and list details of your assistant inbox items.","notification_center":"View and list notification center items.","data_exports.read":"View and download data export files in your program."}}}}]},{"schemes":[{"name":"oauth2_as_a_server","scopes":["webhooks.read"],"type":"oauth2","description":"OAuth2 for Server-to-Server (Client Credentials grant flow)","flows":{"clientCredentials":{"tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","public":"View public information.","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","data_exports.read":"View and download data export files in your program."}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"subscription_id","in":"path","schemaId":"schema_106","description":"Id of the subscription to detail","required":true}],"pointer":"/paths/~1v2~1webhooks~1subscriptions~1{subscription_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/webhooks/subscriptions/{subscription_id}","servers":[{"url":"https://partner.socialchorus.com","description":"US1"},{"url":"https://partner.us2.onfirstup.com","description":"US2"},{"url":"https://partner.onfirstup.eu","description":"EU"}],"parameters":{"path":[{"name":"subscription_id","in":"path","required":true,"schemaId":"schema_106"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2_as_a_user","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"IAM_DOMAIN/oauth/authorize","tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","openid":"Authenticate your account using OpenID.","public":"View public information.","feeds.read":"View your feeds.","feeds.rendered.read":"View rendered content from feed posts.","feeds.engage":"View your feeds and engage with posts (likes, bookmarks, etc).","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","assistant.inbox.read":"View and list details of your assistant inbox items.","notification_center":"View and list notification center items.","data_exports.read":"View and download data export files in your program."}}}}],"scopes":["webhooks.read"]},{"schemes":[{"id":"oauth2_as_a_server","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","public":"View public information.","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","data_exports.read":"View and download data export files in your program."}}}}],"scopes":["webhooks.read"]}],"responseCodes":["200","401"],"pointer":"/v2/webhooks/subscriptions/{subscription_id}","href":"webhooks/detailwebhooksubscription","openApiOperationId":"detailWebhookSubscription","summary":"Fetch a single webhook subscription record","securityGroups":[{"oauth2_as_a_user":["webhooks.read"]},{"oauth2_as_a_server":["webhooks.read"]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://partner.socialchorus.com","description":"US1"},{"url":"https://partner.us2.onfirstup.com","description":"US2"},{"url":"https://partner.onfirstup.eu","description":"EU"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_184"}},"schemaId":"schema_184"},{"code":"401","description":"Unauthenticated","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}},"schemaId":"schema_101"}],"pointer":"/paths/~1v2~1webhooks~1subscriptions~1{subscription_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_184","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_184"}}},{"code":"401","schemaId":"schema_101","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooks/detailwebhooksubscription"}],"panels":[]}]},"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 Testing Webhook Subscriptions page."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"pingWebhookSubscription","name":"Test a webhook subscription by pinging it with a sample payload","isWebhook":false,"pointer":"/paths/~1v2~1webhooks~1subscriptions~1{subscription_id}~1ping/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Test a webhook subscription by pinging it with a sample payload","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"More information about testing webhook subscriptions is available on the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"/webhooks/webhooks-overview#test-a-webook"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Testing Webhook Subscriptions"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" page."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2_as_a_server","scopes":["webhooks.read"],"type":"oauth2","description":"OAuth2 for Server-to-Server (Client Credentials grant flow)","flows":{"clientCredentials":{"tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","public":"View public information.","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","data_exports.read":"View and download data export files in your program."}}}}]},{"schemes":[{"name":"oauth2_as_a_user","scopes":["webhooks.read"],"type":"oauth2","description":"OAuth2 for Users (Authorization Code grant flow)","flows":{"authorizationCode":{"authorizationUrl":"IAM_DOMAIN/oauth/authorize","tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","openid":"Authenticate your account using OpenID.","public":"View public information.","feeds.read":"View your feeds.","feeds.rendered.read":"View rendered content from feed posts.","feeds.engage":"View your feeds and engage with posts (likes, bookmarks, etc).","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","assistant.inbox.read":"View and list details of your assistant inbox items.","notification_center":"View and list notification center items.","data_exports.read":"View and download data export files in your program."}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"subscription_id","in":"path","schemaId":"schema_106","description":"Id of the subscription to ping","required":true}],"pointer":"/paths/~1v2~1webhooks~1subscriptions~1{subscription_id}~1ping/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/webhooks/subscriptions/{subscription_id}/ping","servers":[{"url":"https://partner.socialchorus.com","description":"US1"},{"url":"https://partner.us2.onfirstup.com","description":"US2"},{"url":"https://partner.onfirstup.eu","description":"EU"}],"parameters":{"path":[{"name":"subscription_id","in":"path","required":true,"schemaId":"schema_106"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2_as_a_server","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","public":"View public information.","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","data_exports.read":"View and download data export files in your program."}}}}],"scopes":["webhooks.read"]},{"schemes":[{"id":"oauth2_as_a_user","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"IAM_DOMAIN/oauth/authorize","tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","openid":"Authenticate your account using OpenID.","public":"View public information.","feeds.read":"View your feeds.","feeds.rendered.read":"View rendered content from feed posts.","feeds.engage":"View your feeds and engage with posts (likes, bookmarks, etc).","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","assistant.inbox.read":"View and list details of your assistant inbox items.","notification_center":"View and list notification center items.","data_exports.read":"View and download data export files in your program."}}}}],"scopes":["webhooks.read"]}],"responseCodes":["200","400","401","403"],"pointer":"/v2/webhooks/subscriptions/{subscription_id}/ping","href":"webhooks/pingwebhooksubscription","openApiOperationId":"pingWebhookSubscription","summary":"Test a webhook subscription by pinging it with a sample payload","securityGroups":[{"oauth2_as_a_server":["webhooks.read"]},{"oauth2_as_a_user":["webhooks.read"]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://partner.socialchorus.com","description":"US1"},{"url":"https://partner.us2.onfirstup.com","description":"US2"},{"url":"https://partner.onfirstup.eu","description":"EU"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_185"}},"schemaId":"schema_185"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}},"schemaId":"schema_101"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthenticated. See more on error responses "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://developers.firstup.io/gettingstarted/error_responses"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_120"}},"schemaId":"schema_120"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized. See more on error responses "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://developers.firstup.io/gettingstarted/error_responses"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_121"}},"schemaId":"schema_121"}],"pointer":"/paths/~1v2~1webhooks~1subscriptions~1{subscription_id}~1ping/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_185","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_185"}}},{"code":"400","schemaId":"schema_101","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}}},{"code":"401","schemaId":"schema_120","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_120"}}},{"code":"403","schemaId":"schema_121","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_121"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooks/pingwebhooksubscription"}],"panels":[]}]},"httpPath":"/v2/webhooks/subscriptions/{subscription_id}/ping"}],"content":{"contentType":"group","meta":{"name":"Webhooks"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Webhooks","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"The Webhooks API provides a mechanism for subscribing to events that occur within the Firstup platform to receive http payloads when those events occur. Use webhook subscriptions to trigger actions on your own application."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Webhook events are sent by the Firstup platform as POST requests to your webhook url. Each event contains a payload specific to that event. More information about the webhooks system, including a list of events that can be subscribed to, is available on the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"/webhooks/webhooks-overview"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":" Webhooks page"},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v2/webhooks/subscriptions","summary":"Fetch the program's configured webhook subscriptions","prefix":{"name":"get","color":"get"},"badges":[],"link":"/webhooks/listwebhooksubscriptions","deprecated":false},{"title":"/v2/webhooks/subscriptions","summary":"Create a new webhook subscription","prefix":{"name":"post","color":"post"},"badges":[],"link":"/webhooks/createwebhooksubscription","deprecated":false},{"title":"/v2/webhooks/subscriptions/{subscription_id}","summary":"Update an existing webhook subscription","prefix":{"name":"put","color":"put"},"badges":[],"link":"/webhooks/updatewebhooksubscription","deprecated":false},{"title":"/v2/webhooks/subscriptions/{subscription_id}","summary":"Delete a webhook subscription permanently","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/webhooks/deletewebhooksubscription","deprecated":false},{"title":"/v2/webhooks/subscriptions/{subscription_id}","summary":"Fetch a single webhook subscription record","prefix":{"name":"get","color":"get"},"badges":[],"link":"/webhooks/detailwebhooksubscription","deprecated":false},{"title":"/v2/webhooks/subscriptions/{subscription_id}/ping","summary":"Test a webhook subscription by pinging it with a sample payload","prefix":{"name":"post","color":"post"},"badges":[],"link":"/webhooks/pingwebhooksubscription","deprecated":false}]}]}]}]}},{"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":"Fetches multiple inbox item records at a time."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listInboxItems","name":"Fetch the program user's inbox","deprecated":true,"isWebhook":false,"pointer":"/paths/~1v2~1assistant~1inbox_items/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetch the program user's inbox","isWebhook":false,"deprecated":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Fetches multiple inbox item records at a time."},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2_as_a_user","scopes":["assistant.inbox.read"],"type":"oauth2","description":"OAuth2 for Users (Authorization Code grant flow)","flows":{"authorizationCode":{"authorizationUrl":"IAM_DOMAIN/oauth/authorize","tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","openid":"Authenticate your account using OpenID.","public":"View public information.","feeds.read":"View your feeds.","feeds.rendered.read":"View rendered content from feed posts.","feeds.engage":"View your feeds and engage with posts (likes, bookmarks, etc).","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","assistant.inbox.read":"View and list details of your assistant inbox items.","notification_center":"View and list notification center items.","data_exports.read":"View and download data export files in your program."}}}}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"filter.categories","in":"query","schemaId":"schema_186","description":"Limit returned records to those that match the category(s) provided."}],"pointer":"/paths/~1v2~1assistant~1inbox_items/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/assistant/inbox_items","servers":[{"url":"https://partner.socialchorus.com","description":"US1"},{"url":"https://partner.us2.onfirstup.com","description":"US2"},{"url":"https://partner.onfirstup.eu","description":"EU"}],"parameters":{"path":[],"query":[{"name":"filter.categories","in":"query","required":false,"schemaId":"schema_186","style":"form","explode":false}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2_as_a_user","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"IAM_DOMAIN/oauth/authorize","tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","openid":"Authenticate your account using OpenID.","public":"View public information.","feeds.read":"View your feeds.","feeds.rendered.read":"View rendered content from feed posts.","feeds.engage":"View your feeds and engage with posts (likes, bookmarks, etc).","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","assistant.inbox.read":"View and list details of your assistant inbox items.","notification_center":"View and list notification center items.","data_exports.read":"View and download data export files in your program."}}}}],"scopes":["assistant.inbox.read"]}],"responseCodes":["200","400","401"],"pointer":"/v2/assistant/inbox_items","href":"assistant-inbox/listinboxitems","openApiOperationId":"listInboxItems","summary":"Fetch the program user's inbox"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://partner.socialchorus.com","description":"US1"},{"url":"https://partner.us2.onfirstup.com","description":"US2"},{"url":"https://partner.onfirstup.eu","description":"EU"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_187"}},"schemaId":"schema_187"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}},"schemaId":"schema_101"},{"code":"401","description":"Unauthenticated","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}},"schemaId":"schema_101"}],"pointer":"/paths/~1v2~1assistant~1inbox_items/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_187","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_187"}}},{"code":"400","schemaId":"schema_101","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}}},{"code":"401","schemaId":"schema_101","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/assistant-inbox/listinboxitems"}],"panels":[]}]},"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":"Fetches multiple Todo records at a time. "}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listAssistantTodos","name":"Fetch the program user's Todos.","deprecated":true,"isWebhook":false,"pointer":"/paths/~1v2~1assistant~1todos/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetch the program user's Todos.","isWebhook":false,"deprecated":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Fetches multiple Todo records at a time. "},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2_as_a_user","scopes":["assistant.inbox.read","feeds.read","feeds.rendered.read"],"type":"oauth2","description":"OAuth2 for Users (Authorization Code grant flow)","flows":{"authorizationCode":{"authorizationUrl":"IAM_DOMAIN/oauth/authorize","tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","openid":"Authenticate your account using OpenID.","public":"View public information.","feeds.read":"View your feeds.","feeds.rendered.read":"View rendered content from feed posts.","feeds.engage":"View your feeds and engage with posts (likes, bookmarks, etc).","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","assistant.inbox.read":"View and list details of your assistant inbox items.","notification_center":"View and list notification center items.","data_exports.read":"View and download data export files in your program."}}}}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"filter.categories","in":"query","schemaId":"schema_188","description":"Limit returned records to those that match the category(s) provided."}],"pointer":"/paths/~1v2~1assistant~1todos/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/assistant/todos","servers":[{"url":"https://partner.socialchorus.com","description":"US1"},{"url":"https://partner.us2.onfirstup.com","description":"US2"},{"url":"https://partner.onfirstup.eu","description":"EU"}],"parameters":{"path":[],"query":[{"name":"filter.categories","in":"query","required":false,"schemaId":"schema_188","style":"form","explode":false}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2_as_a_user","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"IAM_DOMAIN/oauth/authorize","tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","openid":"Authenticate your account using OpenID.","public":"View public information.","feeds.read":"View your feeds.","feeds.rendered.read":"View rendered content from feed posts.","feeds.engage":"View your feeds and engage with posts (likes, bookmarks, etc).","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","assistant.inbox.read":"View and list details of your assistant inbox items.","notification_center":"View and list notification center items.","data_exports.read":"View and download data export files in your program."}}}}],"scopes":["assistant.inbox.read","feeds.read","feeds.rendered.read"]}],"responseCodes":["200","400","401"],"pointer":"/v2/assistant/todos","href":"assistant-inbox/listassistanttodos","openApiOperationId":"listAssistantTodos","summary":"Fetch the program user's Todos."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://partner.socialchorus.com","description":"US1"},{"url":"https://partner.us2.onfirstup.com","description":"US2"},{"url":"https://partner.onfirstup.eu","description":"EU"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_189"}},"schemaId":"schema_189"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}},"schemaId":"schema_101"},{"code":"401","description":"Unauthenticated","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}},"schemaId":"schema_101"}],"pointer":"/paths/~1v2~1assistant~1todos/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_189","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_189"}}},{"code":"400","schemaId":"schema_101","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}}},{"code":"401","schemaId":"schema_101","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/assistant-inbox/listassistanttodos"}],"panels":[]}]},"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":"Fetches multiple inbox notification records at a time. "}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listNotifications","name":"Fetch the program user's notifications.","deprecated":true,"isWebhook":false,"pointer":"/paths/~1v2~1assistant~1notifications/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetch the program user's notifications.","isWebhook":false,"deprecated":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Fetches multiple inbox notification records at a time. "},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2_as_a_user","scopes":["assistant.inbox.read"],"type":"oauth2","description":"OAuth2 for Users (Authorization Code grant flow)","flows":{"authorizationCode":{"authorizationUrl":"IAM_DOMAIN/oauth/authorize","tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","openid":"Authenticate your account using OpenID.","public":"View public information.","feeds.read":"View your feeds.","feeds.rendered.read":"View rendered content from feed posts.","feeds.engage":"View your feeds and engage with posts (likes, bookmarks, etc).","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","assistant.inbox.read":"View and list details of your assistant inbox items.","notification_center":"View and list notification center items.","data_exports.read":"View and download data export files in your program."}}}}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"filter.unacknowledged","in":"query","schemaId":"schema_122","description":"Get only unacknowledged notifications"},{"name":"filter.ids","in":"query","schemaId":"schema_112","description":"Filter notifications by IDs"},{"name":"page.size","in":"query","schemaId":"schema_103","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Return "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"page.size"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" number of records starting at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"size*number"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The default page size is 10 (number of records per page), resulting in the first page being retrieved. The maximum page size is 100."},"children":[]}]}]}]},{"name":"page.number","in":"query","schemaId":"schema_103","description":"Using classical pagination, the page number to return. Default is 1"}],"pointer":"/paths/~1v2~1assistant~1notifications/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/assistant/notifications","servers":[{"url":"https://partner.socialchorus.com","description":"US1"},{"url":"https://partner.us2.onfirstup.com","description":"US2"},{"url":"https://partner.onfirstup.eu","description":"EU"}],"parameters":{"path":[],"query":[{"name":"filter.unacknowledged","in":"query","schemaId":"schema_122"},{"name":"filter.ids","in":"query","schemaId":"schema_112","style":"form","explode":false},{"name":"page.size","in":"query","required":false,"schemaId":"schema_103"},{"name":"page.number","in":"query","required":false,"schemaId":"schema_103"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2_as_a_user","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"IAM_DOMAIN/oauth/authorize","tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","openid":"Authenticate your account using OpenID.","public":"View public information.","feeds.read":"View your feeds.","feeds.rendered.read":"View rendered content from feed posts.","feeds.engage":"View your feeds and engage with posts (likes, bookmarks, etc).","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","assistant.inbox.read":"View and list details of your assistant inbox items.","notification_center":"View and list notification center items.","data_exports.read":"View and download data export files in your program."}}}}],"scopes":["assistant.inbox.read"]}],"responseCodes":["200","400","401"],"pointer":"/v2/assistant/notifications","href":"assistant-inbox/listnotifications","openApiOperationId":"listNotifications","summary":"Fetch the program user's notifications."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://partner.socialchorus.com","description":"US1"},{"url":"https://partner.us2.onfirstup.com","description":"US2"},{"url":"https://partner.onfirstup.eu","description":"EU"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_190"}},"schemaId":"schema_190"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}},"schemaId":"schema_101"},{"code":"401","description":"Unauthenticated","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}},"schemaId":"schema_101"}],"pointer":"/paths/~1v2~1assistant~1notifications/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_190","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_190"}}},{"code":"400","schemaId":"schema_101","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}}},{"code":"401","schemaId":"schema_101","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/assistant-inbox/listnotifications"}],"panels":[]}]},"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":"Mark the program user's notification acknowledged."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"acknowledgeNotification","name":"Acknowledge the program user's notification.","deprecated":true,"isWebhook":false,"pointer":"/paths/~1v2~1assistant~1notifications~1{notification_id}~1acknowledge/put","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Acknowledge the program user's notification.","isWebhook":false,"deprecated":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Mark the program user's notification acknowledged."},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2_as_a_user","scopes":["assistant.inbox.read"],"type":"oauth2","description":"OAuth2 for Users (Authorization Code grant flow)","flows":{"authorizationCode":{"authorizationUrl":"IAM_DOMAIN/oauth/authorize","tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","openid":"Authenticate your account using OpenID.","public":"View public information.","feeds.read":"View your feeds.","feeds.rendered.read":"View rendered content from feed posts.","feeds.engage":"View your feeds and engage with posts (likes, bookmarks, etc).","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","assistant.inbox.read":"View and list details of your assistant inbox items.","notification_center":"View and list notification center items.","data_exports.read":"View and download data export files in your program."}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"notification_id","in":"path","schemaId":"schema_106","required":true}],"pointer":"/paths/~1v2~1assistant~1notifications~1{notification_id}~1acknowledge/put/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v2/assistant/notifications/{notification_id}/acknowledge","servers":[{"url":"https://partner.socialchorus.com","description":"US1"},{"url":"https://partner.us2.onfirstup.com","description":"US2"},{"url":"https://partner.onfirstup.eu","description":"EU"}],"parameters":{"path":[{"name":"notification_id","in":"path","required":true,"schemaId":"schema_106"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2_as_a_user","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"IAM_DOMAIN/oauth/authorize","tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","openid":"Authenticate your account using OpenID.","public":"View public information.","feeds.read":"View your feeds.","feeds.rendered.read":"View rendered content from feed posts.","feeds.engage":"View your feeds and engage with posts (likes, bookmarks, etc).","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","assistant.inbox.read":"View and list details of your assistant inbox items.","notification_center":"View and list notification center items.","data_exports.read":"View and download data export files in your program."}}}}],"scopes":["assistant.inbox.read"]}],"responseCodes":["200","400","401"],"pointer":"/v2/assistant/notifications/{notification_id}/acknowledge","href":"assistant-inbox/acknowledgenotification","openApiOperationId":"acknowledgeNotification","summary":"Acknowledge the program user's notification."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://partner.socialchorus.com","description":"US1"},{"url":"https://partner.us2.onfirstup.com","description":"US2"},{"url":"https://partner.onfirstup.eu","description":"EU"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}},"schemaId":"schema_101"},{"code":"401","description":"Unauthenticated","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}},"schemaId":"schema_101"}],"pointer":"/paths/~1v2~1assistant~1notifications~1{notification_id}~1acknowledge/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200"},{"code":"400","schemaId":"schema_101","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}}},{"code":"401","schemaId":"schema_101","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/assistant-inbox/acknowledgenotification"}],"panels":[]}]},"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":"Mark all program user's notifications acknowledged."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"acknowledgeAllNotifications","name":"Acknowledge all program user's notifications.","deprecated":true,"isWebhook":false,"pointer":"/paths/~1v2~1assistant~1notifications~1acknowledge_all/put","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Acknowledge all program user's notifications.","isWebhook":false,"deprecated":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Mark all program user's notifications acknowledged."},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2_as_a_user","scopes":["assistant.inbox.read"],"type":"oauth2","description":"OAuth2 for Users (Authorization Code grant flow)","flows":{"authorizationCode":{"authorizationUrl":"IAM_DOMAIN/oauth/authorize","tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","openid":"Authenticate your account using OpenID.","public":"View public information.","feeds.read":"View your feeds.","feeds.rendered.read":"View rendered content from feed posts.","feeds.engage":"View your feeds and engage with posts (likes, bookmarks, etc).","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","assistant.inbox.read":"View and list details of your assistant inbox items.","notification_center":"View and list notification center items.","data_exports.read":"View and download data export files in your program."}}}}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v2/assistant/notifications/acknowledge_all","servers":[{"url":"https://partner.socialchorus.com","description":"US1"},{"url":"https://partner.us2.onfirstup.com","description":"US2"},{"url":"https://partner.onfirstup.eu","description":"EU"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2_as_a_user","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"IAM_DOMAIN/oauth/authorize","tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","openid":"Authenticate your account using OpenID.","public":"View public information.","feeds.read":"View your feeds.","feeds.rendered.read":"View rendered content from feed posts.","feeds.engage":"View your feeds and engage with posts (likes, bookmarks, etc).","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","assistant.inbox.read":"View and list details of your assistant inbox items.","notification_center":"View and list notification center items.","data_exports.read":"View and download data export files in your program."}}}}],"scopes":["assistant.inbox.read"]}],"responseCodes":["200","400","401"],"pointer":"/v2/assistant/notifications/acknowledge_all","href":"assistant-inbox/acknowledgeallnotifications","openApiOperationId":"acknowledgeAllNotifications","summary":"Acknowledge all program user's notifications."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://partner.socialchorus.com","description":"US1"},{"url":"https://partner.us2.onfirstup.com","description":"US2"},{"url":"https://partner.onfirstup.eu","description":"EU"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}},"schemaId":"schema_101"},{"code":"401","description":"Unauthenticated","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}},"schemaId":"schema_101"}],"pointer":"/paths/~1v2~1assistant~1notifications~1acknowledge_all/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200"},{"code":"400","schemaId":"schema_101","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}}},{"code":"401","schemaId":"schema_101","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/assistant-inbox/acknowledgeallnotifications"}],"panels":[]}]},"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":"Fetches the count of notifications for the user."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getInboxItemsTotalCount","name":"Fetch the program user's notifications count.","deprecated":true,"isWebhook":false,"pointer":"/paths/~1v2~1assistant~1inbox_items~1total_count/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetch the program user's notifications count.","isWebhook":false,"deprecated":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Fetches the count of notifications for the user."},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2_as_a_user","scopes":["assistant.inbox.read"],"type":"oauth2","description":"OAuth2 for Users (Authorization Code grant flow)","flows":{"authorizationCode":{"authorizationUrl":"IAM_DOMAIN/oauth/authorize","tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","openid":"Authenticate your account using OpenID.","public":"View public information.","feeds.read":"View your feeds.","feeds.rendered.read":"View rendered content from feed posts.","feeds.engage":"View your feeds and engage with posts (likes, bookmarks, etc).","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","assistant.inbox.read":"View and list details of your assistant inbox items.","notification_center":"View and list notification center items.","data_exports.read":"View and download data export files in your program."}}}}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/assistant/inbox_items/total_count","servers":[{"url":"https://partner.socialchorus.com","description":"US1"},{"url":"https://partner.us2.onfirstup.com","description":"US2"},{"url":"https://partner.onfirstup.eu","description":"EU"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2_as_a_user","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"IAM_DOMAIN/oauth/authorize","tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","openid":"Authenticate your account using OpenID.","public":"View public information.","feeds.read":"View your feeds.","feeds.rendered.read":"View rendered content from feed posts.","feeds.engage":"View your feeds and engage with posts (likes, bookmarks, etc).","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","assistant.inbox.read":"View and list details of your assistant inbox items.","notification_center":"View and list notification center items.","data_exports.read":"View and download data export files in your program."}}}}],"scopes":["assistant.inbox.read"]}],"responseCodes":["200","400","401"],"pointer":"/v2/assistant/inbox_items/total_count","href":"assistant-inbox/getinboxitemstotalcount","openApiOperationId":"getInboxItemsTotalCount","summary":"Fetch the program user's notifications count."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://partner.socialchorus.com","description":"US1"},{"url":"https://partner.us2.onfirstup.com","description":"US2"},{"url":"https://partner.onfirstup.eu","description":"EU"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_191"}},"schemaId":"schema_191"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}},"schemaId":"schema_101"},{"code":"401","description":"Unauthenticated","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}},"schemaId":"schema_101"}],"pointer":"/paths/~1v2~1assistant~1inbox_items~1total_count/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_191","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_191"}}},{"code":"400","schemaId":"schema_101","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}}},{"code":"401","schemaId":"schema_101","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/assistant-inbox/getinboxitemstotalcount"}],"panels":[]}]},"httpPath":"/v2/assistant/inbox_items/total_count"}],"content":{"contentType":"group","meta":{"name":"Assistant Inbox"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Assistant Inbox","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"admonition","inline":true,"attributes":{"type":"info"},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This API is deprecated and has been replaced by the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"/endpoints/openapi/notification-center"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notification Center API"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v2/assistant/inbox_items","summary":"Fetch the program user's inbox","prefix":{"name":"get","color":"http-deprecated"},"badges":[],"link":"/assistant-inbox/listinboxitems","deprecated":true},{"title":"/v2/assistant/todos","summary":"Fetch the program user's Todos.","prefix":{"name":"get","color":"http-deprecated"},"badges":[],"link":"/assistant-inbox/listassistanttodos","deprecated":true},{"title":"/v2/assistant/notifications","summary":"Fetch the program user's notifications.","prefix":{"name":"get","color":"http-deprecated"},"badges":[],"link":"/assistant-inbox/listnotifications","deprecated":true},{"title":"/v2/assistant/notifications/{notification_id}/acknowledge","summary":"Acknowledge the program user's notification.","prefix":{"name":"put","color":"http-deprecated"},"badges":[],"link":"/assistant-inbox/acknowledgenotification","deprecated":true},{"title":"/v2/assistant/notifications/acknowledge_all","summary":"Acknowledge all program user's notifications.","prefix":{"name":"put","color":"http-deprecated"},"badges":[],"link":"/assistant-inbox/acknowledgeallnotifications","deprecated":true},{"title":"/v2/assistant/inbox_items/total_count","summary":"Fetch the program user's notifications count.","prefix":{"name":"get","color":"http-deprecated"},"badges":[],"link":"/assistant-inbox/getinboxitemstotalcount","deprecated":true}]}]}]}]}},{"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":"Fetches multiple inbox notification records at a time. "}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listNotifications","name":"Fetch the program user's notifications.","isWebhook":false,"pointer":"/paths/~1v2~1notification_center~1notifications/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetch the program user's notifications.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Fetches multiple inbox notification records at a time. "},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2_as_a_user","scopes":["notification_center"],"type":"oauth2","description":"OAuth2 for Users (Authorization Code grant flow)","flows":{"authorizationCode":{"authorizationUrl":"IAM_DOMAIN/oauth/authorize","tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","openid":"Authenticate your account using OpenID.","public":"View public information.","feeds.read":"View your feeds.","feeds.rendered.read":"View rendered content from feed posts.","feeds.engage":"View your feeds and engage with posts (likes, bookmarks, etc).","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","assistant.inbox.read":"View and list details of your assistant inbox items.","notification_center":"View and list notification center items.","data_exports.read":"View and download data export files in your program."}}}}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"filter.read","in":"query","schemaId":"schema_122","description":"Get only read notifications"},{"name":"filter.unread","in":"query","schemaId":"schema_122","description":"Get only unread notifications"},{"name":"filter.archived","in":"query","schemaId":"schema_122","description":"Get only archived notifications"},{"name":"filter.unarchived","in":"query","schemaId":"schema_122","description":"Get only unarchived notifications"},{"name":"filter.important","in":"query","schemaId":"schema_122","description":"Get only important notifications"},{"name":"filter.action_required","in":"query","schemaId":"schema_122","description":"Get only notifications with action required"},{"name":"filter.message","in":"query","schemaId":"schema_122","description":"Get only message notifications"},{"name":"filter.activity","in":"query","schemaId":"schema_122","description":"Get only activity notifications"},{"name":"page.size","in":"query","schemaId":"schema_103","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Return "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"page.size"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" number of records starting at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"size*number"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The default page size is 10 (number of records per page), resulting in the first page being retrieved. The maximum page size is 100."},"children":[]}]}]}]},{"name":"page.number","in":"query","schemaId":"schema_103","description":"Using classical pagination, the page number to return. Default is 1"}],"pointer":"/paths/~1v2~1notification_center~1notifications/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/notification_center/notifications","servers":[{"url":"https://partner.socialchorus.com","description":"US1"},{"url":"https://partner.us2.onfirstup.com","description":"US2"},{"url":"https://partner.onfirstup.eu","description":"EU"}],"parameters":{"path":[],"query":[{"name":"filter.read","in":"query","schemaId":"schema_122"},{"name":"filter.unread","in":"query","schemaId":"schema_122"},{"name":"filter.archived","in":"query","schemaId":"schema_122"},{"name":"filter.unarchived","in":"query","schemaId":"schema_122"},{"name":"filter.important","in":"query","schemaId":"schema_122"},{"name":"filter.action_required","in":"query","schemaId":"schema_122"},{"name":"filter.message","in":"query","schemaId":"schema_122"},{"name":"filter.activity","in":"query","schemaId":"schema_122"},{"name":"page.size","in":"query","required":false,"schemaId":"schema_103"},{"name":"page.number","in":"query","required":false,"schemaId":"schema_103"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2_as_a_user","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"IAM_DOMAIN/oauth/authorize","tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","openid":"Authenticate your account using OpenID.","public":"View public information.","feeds.read":"View your feeds.","feeds.rendered.read":"View rendered content from feed posts.","feeds.engage":"View your feeds and engage with posts (likes, bookmarks, etc).","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","assistant.inbox.read":"View and list details of your assistant inbox items.","notification_center":"View and list notification center items.","data_exports.read":"View and download data export files in your program."}}}}],"scopes":["notification_center"]}],"responseCodes":["200","400","401"],"pointer":"/v2/notification_center/notifications","href":"notification-center/listnotifications","openApiOperationId":"listNotifications","summary":"Fetch the program user's notifications."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://partner.socialchorus.com","description":"US1"},{"url":"https://partner.us2.onfirstup.com","description":"US2"},{"url":"https://partner.onfirstup.eu","description":"EU"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_190"}},"schemaId":"schema_190"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}},"schemaId":"schema_101"},{"code":"401","description":"Unauthenticated","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}},"schemaId":"schema_101"}],"pointer":"/paths/~1v2~1notification_center~1notifications/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_190","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_190"}}},{"code":"400","schemaId":"schema_101","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}}},{"code":"401","schemaId":"schema_101","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/notification-center/listnotifications"}],"panels":[]}]},"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":"Mark the program user's notification read."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"readNotification","name":"Acknowledge the program user's notification.","isWebhook":false,"pointer":"/paths/~1v2~1notification_center~1notifications~1{notification_id}~1read/put","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Acknowledge the program user's notification.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Mark the program user's notification read."},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2_as_a_user","scopes":["notification_center"],"type":"oauth2","description":"OAuth2 for Users (Authorization Code grant flow)","flows":{"authorizationCode":{"authorizationUrl":"IAM_DOMAIN/oauth/authorize","tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","openid":"Authenticate your account using OpenID.","public":"View public information.","feeds.read":"View your feeds.","feeds.rendered.read":"View rendered content from feed posts.","feeds.engage":"View your feeds and engage with posts (likes, bookmarks, etc).","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","assistant.inbox.read":"View and list details of your assistant inbox items.","notification_center":"View and list notification center items.","data_exports.read":"View and download data export files in your program."}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"notification_id","in":"path","schemaId":"schema_106","required":true}],"pointer":"/paths/~1v2~1notification_center~1notifications~1{notification_id}~1read/put/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v2/notification_center/notifications/{notification_id}/read","servers":[{"url":"https://partner.socialchorus.com","description":"US1"},{"url":"https://partner.us2.onfirstup.com","description":"US2"},{"url":"https://partner.onfirstup.eu","description":"EU"}],"parameters":{"path":[{"name":"notification_id","in":"path","required":true,"schemaId":"schema_106"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2_as_a_user","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"IAM_DOMAIN/oauth/authorize","tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","openid":"Authenticate your account using OpenID.","public":"View public information.","feeds.read":"View your feeds.","feeds.rendered.read":"View rendered content from feed posts.","feeds.engage":"View your feeds and engage with posts (likes, bookmarks, etc).","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","assistant.inbox.read":"View and list details of your assistant inbox items.","notification_center":"View and list notification center items.","data_exports.read":"View and download data export files in your program."}}}}],"scopes":["notification_center"]}],"responseCodes":["200","400","401"],"pointer":"/v2/notification_center/notifications/{notification_id}/read","href":"notification-center/readnotification","openApiOperationId":"readNotification","summary":"Acknowledge the program user's notification."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://partner.socialchorus.com","description":"US1"},{"url":"https://partner.us2.onfirstup.com","description":"US2"},{"url":"https://partner.onfirstup.eu","description":"EU"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}},"schemaId":"schema_101"},{"code":"401","description":"Unauthenticated","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}},"schemaId":"schema_101"}],"pointer":"/paths/~1v2~1notification_center~1notifications~1{notification_id}~1read/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200"},{"code":"400","schemaId":"schema_101","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}}},{"code":"401","schemaId":"schema_101","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/notification-center/readnotification"}],"panels":[]}]},"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":"Fetches the count of notifications for the user."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getNotificationsTotalCount","name":"Fetch the program user's notifications count.","isWebhook":false,"pointer":"/paths/~1v2~1notification_center~1total_count/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetch the program user's notifications count.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Fetches the count of notifications for the user."},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2_as_a_user","scopes":["notification_center"],"type":"oauth2","description":"OAuth2 for Users (Authorization Code grant flow)","flows":{"authorizationCode":{"authorizationUrl":"IAM_DOMAIN/oauth/authorize","tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","openid":"Authenticate your account using OpenID.","public":"View public information.","feeds.read":"View your feeds.","feeds.rendered.read":"View rendered content from feed posts.","feeds.engage":"View your feeds and engage with posts (likes, bookmarks, etc).","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","assistant.inbox.read":"View and list details of your assistant inbox items.","notification_center":"View and list notification center items.","data_exports.read":"View and download data export files in your program."}}}}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/notification_center/total_count","servers":[{"url":"https://partner.socialchorus.com","description":"US1"},{"url":"https://partner.us2.onfirstup.com","description":"US2"},{"url":"https://partner.onfirstup.eu","description":"EU"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2_as_a_user","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"IAM_DOMAIN/oauth/authorize","tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","openid":"Authenticate your account using OpenID.","public":"View public information.","feeds.read":"View your feeds.","feeds.rendered.read":"View rendered content from feed posts.","feeds.engage":"View your feeds and engage with posts (likes, bookmarks, etc).","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","assistant.inbox.read":"View and list details of your assistant inbox items.","notification_center":"View and list notification center items.","data_exports.read":"View and download data export files in your program."}}}}],"scopes":["notification_center"]}],"responseCodes":["200","400","401"],"pointer":"/v2/notification_center/total_count","href":"notification-center/getnotificationstotalcount","openApiOperationId":"getNotificationsTotalCount","summary":"Fetch the program user's notifications count."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://partner.socialchorus.com","description":"US1"},{"url":"https://partner.us2.onfirstup.com","description":"US2"},{"url":"https://partner.onfirstup.eu","description":"EU"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_191"}},"schemaId":"schema_191"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}},"schemaId":"schema_101"},{"code":"401","description":"Unauthenticated","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}},"schemaId":"schema_101"}],"pointer":"/paths/~1v2~1notification_center~1total_count/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_191","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_191"}}},{"code":"400","schemaId":"schema_101","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}}},{"code":"401","schemaId":"schema_101","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/notification-center/getnotificationstotalcount"}],"panels":[]}]},"httpPath":"/v2/notification_center/total_count"}],"content":{"contentType":"group","meta":{"name":"Notification Center"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Notification Center","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"The Notification Center API provides programmatic access to the notifications surfaced in the Firstup application. It enables developers to query and track notifications, including their status, delivery channel, and engagement events, ensuring alignment with what employees see in their Notification Center hub. Notifications reflect activity such as campaigns, journeys, and post interactions, and respect user preferences and notification settings."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"admonition","attributes":{"type":"info"},"children":[{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Notification Center API requires "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://developers.firstup.io/authorization/authentication-methods#jwt-bearer-token-grant"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" as a user."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Notification Center replaces the Assistant Inbox"},"children":[]}]}]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v2/notification_center/notifications","summary":"Fetch the program user's notifications.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/notification-center/listnotifications","deprecated":false},{"title":"/v2/notification_center/notifications/{notification_id}/read","summary":"Acknowledge the program user's notification.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/notification-center/readnotification","deprecated":false},{"title":"/v2/notification_center/total_count","summary":"Fetch the program user's notifications count.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/notification-center/getnotificationstotalcount","deprecated":false}]}]}]}]}},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listRoles","name":"Return a list of roles","isWebhook":false,"pointer":"/paths/~1scim~1v2~1Roles/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Return a list of roles","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"\nReturns a list of all accessible roles in the actor's program. Only primary roles are currently available.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2_as_a_server","scopes":["users.read"],"type":"oauth2","description":"OAuth2 for Server-to-Server (Client Credentials grant flow)","flows":{"clientCredentials":{"tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","public":"View public information.","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","data_exports.read":"View and download data export files in your program."}}}}]},{"schemes":[{"name":"oauth2_as_a_user","scopes":["users.read"],"type":"oauth2","description":"OAuth2 for Users (Authorization Code grant flow)","flows":{"authorizationCode":{"authorizationUrl":"IAM_DOMAIN/oauth/authorize","tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","openid":"Authenticate your account using OpenID.","public":"View public information.","feeds.read":"View your feeds.","feeds.rendered.read":"View rendered content from feed posts.","feeds.engage":"View your feeds and engage with posts (likes, bookmarks, etc).","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","assistant.inbox.read":"View and list details of your assistant inbox items.","notification_center":"View and list notification center items.","data_exports.read":"View and download data export files in your program."}}}}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"origin","in":"query","schemaId":"schema_115","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional parameter to receive only either \"custom\" or \"system\" roles, using the SCIM filter form and the operator "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"eq"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Examples:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"?filter=origin eq \"custom\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (URL-encoded as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"?filter=origin%20eq%20%22custom%22"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"?filter=origin eq \"system\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (URL-encoded as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"?filter=origin%20eq%20%22system%22"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}]}]}],"pointer":"/paths/~1scim~1v2~1Roles/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/scim/v2/Roles","servers":[{"url":"https://partner.socialchorus.com","description":"US1"},{"url":"https://partner.us2.onfirstup.com","description":"US2"},{"url":"https://partner.onfirstup.eu","description":"EU"}],"parameters":{"path":[],"query":[{"name":"origin","in":"query","required":false,"schemaId":"schema_115"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2_as_a_server","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","public":"View public information.","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","data_exports.read":"View and download data export files in your program."}}}}],"scopes":["users.read"]},{"schemes":[{"id":"oauth2_as_a_user","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"IAM_DOMAIN/oauth/authorize","tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","openid":"Authenticate your account using OpenID.","public":"View public information.","feeds.read":"View your feeds.","feeds.rendered.read":"View rendered content from feed posts.","feeds.engage":"View your feeds and engage with posts (likes, bookmarks, etc).","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","assistant.inbox.read":"View and list details of your assistant inbox items.","notification_center":"View and list notification center items.","data_exports.read":"View and download data export files in your program."}}}}],"scopes":["users.read"]}],"responseCodes":["200","400","401","403","404"],"pointer":"/scim/v2/Roles","href":"user-roles/listroles","openApiOperationId":"listRoles","summary":"Return a list of roles","securityGroups":[{"oauth2_as_a_server":["users.read"]},{"oauth2_as_a_user":["users.read"]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://partner.socialchorus.com","description":"US1"},{"url":"https://partner.us2.onfirstup.com","description":"US2"},{"url":"https://partner.onfirstup.eu","description":"EU"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/scim+json","mediaTypes":["application/scim+json"],"mediaTypeContent":{"application/scim+json":{"schemaId":"schema_192"}},"schemaId":"schema_192"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request. See more on error responses "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://developers.firstup.io/gettingstarted/error_responses"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_175"}},"schemaId":"schema_175"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthenticated. See more on error responses "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://developers.firstup.io/gettingstarted/error_responses"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_167"}},"schemaId":"schema_167"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized. See more on error responses "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://developers.firstup.io/gettingstarted/error_responses"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_168"}},"schemaId":"schema_168"},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Not Found. See more on error responses "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://developers.firstup.io/gettingstarted/error_responses"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_170"}},"schemaId":"schema_170"}],"pointer":"/paths/~1scim~1v2~1Roles/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_192","mediaTypes":["application/scim+json"],"mediaTypeContent":{"application/scim+json":{"schemaId":"schema_192"}}},{"code":"400","schemaId":"schema_175","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_175"}}},{"code":"401","schemaId":"schema_167","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_167"}}},{"code":"403","schemaId":"schema_168","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_168"}}},{"code":"404","schemaId":"schema_170","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_170"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/user-roles/listroles"}],"panels":[]}]},"httpPath":"/scim/v2/Roles"}],"content":{"contentType":"group","meta":{"name":"User Roles"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"User Roles","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"The User Roles API enables you to retrieve the set of roles that are available to the authenticated acting user within their program. Roles represent permission levels and access scopes for users across the Firstup platform. For example granting access to Creator Studio, content publishing tools, or member experience features."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Resources"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://support.firstup.io/hc/en-us/articles/6278321908503-Defining-Roles-and-Permissions"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Knowledge Base article on roles and permissions"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"/usermanagementapi/user-role-provisioning"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Roles API overview page"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" for contextual guidance, use cases and API Flows. "},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/scim/v2/Roles","summary":"Return a list of roles","prefix":{"name":"get","color":"get"},"badges":[],"link":"/user-roles/listroles","deprecated":false}]}]}]}]}},{"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":"Returns metadata and a presigned download URL for the most recent export file of the specified type within the caller's program."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"latestExport","name":"Get the latest export file for a given type.","isWebhook":false,"pointer":"/paths/~1v2~1data_exports~1type~1{type_name}~1latest/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get the latest export file for a given type.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Returns metadata and a presigned download URL for the most recent export file of the specified type within the caller's program."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Valid type names: "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"users"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"campaigns"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"activities"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2_as_a_server","scopes":["data_exports.read"],"type":"oauth2","description":"OAuth2 for Server-to-Server (Client Credentials grant flow)","flows":{"clientCredentials":{"tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","public":"View public information.","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","data_exports.read":"View and download data export files in your program."}}}}]},{"schemes":[{"name":"oauth2_as_a_user","scopes":["data_exports.read"],"type":"oauth2","description":"OAuth2 for Users (Authorization Code grant flow)","flows":{"authorizationCode":{"authorizationUrl":"IAM_DOMAIN/oauth/authorize","tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","openid":"Authenticate your account using OpenID.","public":"View public information.","feeds.read":"View your feeds.","feeds.rendered.read":"View rendered content from feed posts.","feeds.engage":"View your feeds and engage with posts (likes, bookmarks, etc).","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","assistant.inbox.read":"View and list details of your assistant inbox items.","notification_center":"View and list notification center items.","data_exports.read":"View and download data export files in your program."}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"type_name","in":"path","schemaId":"schema_193","description":"The export type. One of: users, campaigns, activities.","required":true}],"pointer":"/paths/~1v2~1data_exports~1type~1{type_name}~1latest/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/data_exports/type/{type_name}/latest","servers":[{"url":"https://partner.socialchorus.com","description":"US1"},{"url":"https://partner.us2.onfirstup.com","description":"US2"},{"url":"https://partner.onfirstup.eu","description":"EU"}],"parameters":{"path":[{"name":"type_name","in":"path","required":true,"schemaId":"schema_193"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2_as_a_server","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","public":"View public information.","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","data_exports.read":"View and download data export files in your program."}}}}],"scopes":["data_exports.read"]},{"schemes":[{"id":"oauth2_as_a_user","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"IAM_DOMAIN/oauth/authorize","tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","openid":"Authenticate your account using OpenID.","public":"View public information.","feeds.read":"View your feeds.","feeds.rendered.read":"View rendered content from feed posts.","feeds.engage":"View your feeds and engage with posts (likes, bookmarks, etc).","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","assistant.inbox.read":"View and list details of your assistant inbox items.","notification_center":"View and list notification center items.","data_exports.read":"View and download data export files in your program."}}}}],"scopes":["data_exports.read"]}],"responseCodes":["200","400","401","404"],"pointer":"/v2/data_exports/type/{type_name}/latest","href":"data-exports/latestexport","openApiOperationId":"latestExport","summary":"Get the latest export file for a given type.","securityGroups":[{"oauth2_as_a_server":["data_exports.read"]},{"oauth2_as_a_user":["data_exports.read"]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://partner.socialchorus.com","description":"US1"},{"url":"https://partner.us2.onfirstup.com","description":"US2"},{"url":"https://partner.onfirstup.eu","description":"EU"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_194"}},"schemaId":"schema_194"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}},"schemaId":"schema_101"},{"code":"401","description":"Unauthenticated","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}},"schemaId":"schema_101"},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Not Found — no export files exist for this type and program."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}},"schemaId":"schema_101"}],"pointer":"/paths/~1v2~1data_exports~1type~1{type_name}~1latest/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_194","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_194"}}},{"code":"400","schemaId":"schema_101","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}}},{"code":"401","schemaId":"schema_101","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}}},{"code":"404","schemaId":"schema_101","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/data-exports/latestexport"}],"panels":[]}]},"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":"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listExports","name":"List all available export files for a given type.","isWebhook":false,"pointer":"/paths/~1v2~1data_exports~1type~1{type_name}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all available export files for a given type.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"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."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Valid type names: "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"users"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"campaigns"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"activities"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2_as_a_server","scopes":["data_exports.read"],"type":"oauth2","description":"OAuth2 for Server-to-Server (Client Credentials grant flow)","flows":{"clientCredentials":{"tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","public":"View public information.","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","data_exports.read":"View and download data export files in your program."}}}}]},{"schemes":[{"name":"oauth2_as_a_user","scopes":["data_exports.read"],"type":"oauth2","description":"OAuth2 for Users (Authorization Code grant flow)","flows":{"authorizationCode":{"authorizationUrl":"IAM_DOMAIN/oauth/authorize","tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","openid":"Authenticate your account using OpenID.","public":"View public information.","feeds.read":"View your feeds.","feeds.rendered.read":"View rendered content from feed posts.","feeds.engage":"View your feeds and engage with posts (likes, bookmarks, etc).","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","assistant.inbox.read":"View and list details of your assistant inbox items.","notification_center":"View and list notification center items.","data_exports.read":"View and download data export files in your program."}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"type_name","in":"path","schemaId":"schema_193","description":"The export type. One of: users, campaigns, activities.","required":true}],"pointer":"/paths/~1v2~1data_exports~1type~1{type_name}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/data_exports/type/{type_name}","servers":[{"url":"https://partner.socialchorus.com","description":"US1"},{"url":"https://partner.us2.onfirstup.com","description":"US2"},{"url":"https://partner.onfirstup.eu","description":"EU"}],"parameters":{"path":[{"name":"type_name","in":"path","required":true,"schemaId":"schema_193"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2_as_a_server","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","public":"View public information.","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","data_exports.read":"View and download data export files in your program."}}}}],"scopes":["data_exports.read"]},{"schemes":[{"id":"oauth2_as_a_user","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"IAM_DOMAIN/oauth/authorize","tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","openid":"Authenticate your account using OpenID.","public":"View public information.","feeds.read":"View your feeds.","feeds.rendered.read":"View rendered content from feed posts.","feeds.engage":"View your feeds and engage with posts (likes, bookmarks, etc).","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","assistant.inbox.read":"View and list details of your assistant inbox items.","notification_center":"View and list notification center items.","data_exports.read":"View and download data export files in your program."}}}}],"scopes":["data_exports.read"]}],"responseCodes":["200","400","401"],"pointer":"/v2/data_exports/type/{type_name}","href":"data-exports/listexports","openApiOperationId":"listExports","summary":"List all available export files for a given type.","securityGroups":[{"oauth2_as_a_server":["data_exports.read"]},{"oauth2_as_a_user":["data_exports.read"]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://partner.socialchorus.com","description":"US1"},{"url":"https://partner.us2.onfirstup.com","description":"US2"},{"url":"https://partner.onfirstup.eu","description":"EU"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_195"}},"schemaId":"schema_195"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}},"schemaId":"schema_101"},{"code":"401","description":"Unauthenticated","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}},"schemaId":"schema_101"}],"pointer":"/paths/~1v2~1data_exports~1type~1{type_name}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_195","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_195"}}},{"code":"400","schemaId":"schema_101","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}}},{"code":"401","schemaId":"schema_101","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/data-exports/listexports"}],"panels":[]}]},"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":"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"showExport","name":"Get metadata and download URL for a specific export file.","isWebhook":false,"pointer":"/paths/~1v2~1data_exports~1type~1{type_name}~1files~1{file_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get metadata and download URL for a specific export file.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"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."},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2_as_a_server","scopes":["data_exports.read"],"type":"oauth2","description":"OAuth2 for Server-to-Server (Client Credentials grant flow)","flows":{"clientCredentials":{"tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","public":"View public information.","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","data_exports.read":"View and download data export files in your program."}}}}]},{"schemes":[{"name":"oauth2_as_a_user","scopes":["data_exports.read"],"type":"oauth2","description":"OAuth2 for Users (Authorization Code grant flow)","flows":{"authorizationCode":{"authorizationUrl":"IAM_DOMAIN/oauth/authorize","tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","openid":"Authenticate your account using OpenID.","public":"View public information.","feeds.read":"View your feeds.","feeds.rendered.read":"View rendered content from feed posts.","feeds.engage":"View your feeds and engage with posts (likes, bookmarks, etc).","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","assistant.inbox.read":"View and list details of your assistant inbox items.","notification_center":"View and list notification center items.","data_exports.read":"View and download data export files in your program."}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"type_name","in":"path","schemaId":"schema_193","description":"The export type. One of: users, campaigns, activities.","required":true},{"name":"file_id","in":"path","schemaId":"schema_115","description":"The opaque file identifier returned by the list exports endpoint.","required":true}],"pointer":"/paths/~1v2~1data_exports~1type~1{type_name}~1files~1{file_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/data_exports/type/{type_name}/files/{file_id}","servers":[{"url":"https://partner.socialchorus.com","description":"US1"},{"url":"https://partner.us2.onfirstup.com","description":"US2"},{"url":"https://partner.onfirstup.eu","description":"EU"}],"parameters":{"path":[{"name":"type_name","in":"path","required":true,"schemaId":"schema_193"},{"name":"file_id","in":"path","required":true,"schemaId":"schema_115"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2_as_a_server","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","public":"View public information.","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","data_exports.read":"View and download data export files in your program."}}}}],"scopes":["data_exports.read"]},{"schemes":[{"id":"oauth2_as_a_user","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"IAM_DOMAIN/oauth/authorize","tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","openid":"Authenticate your account using OpenID.","public":"View public information.","feeds.read":"View your feeds.","feeds.rendered.read":"View rendered content from feed posts.","feeds.engage":"View your feeds and engage with posts (likes, bookmarks, etc).","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","assistant.inbox.read":"View and list details of your assistant inbox items.","notification_center":"View and list notification center items.","data_exports.read":"View and download data export files in your program."}}}}],"scopes":["data_exports.read"]}],"responseCodes":["200","400","401","404"],"pointer":"/v2/data_exports/type/{type_name}/files/{file_id}","href":"data-exports/showexport","openApiOperationId":"showExport","summary":"Get metadata and download URL for a specific export file.","securityGroups":[{"oauth2_as_a_server":["data_exports.read"]},{"oauth2_as_a_user":["data_exports.read"]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://partner.socialchorus.com","description":"US1"},{"url":"https://partner.us2.onfirstup.com","description":"US2"},{"url":"https://partner.onfirstup.eu","description":"EU"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_194"}},"schemaId":"schema_194"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}},"schemaId":"schema_101"},{"code":"401","description":"Unauthenticated","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}},"schemaId":"schema_101"},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Not Found — file does not exist or does not belong to this program/type."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}},"schemaId":"schema_101"}],"pointer":"/paths/~1v2~1data_exports~1type~1{type_name}~1files~1{file_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_194","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_194"}}},{"code":"400","schemaId":"schema_101","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}}},{"code":"401","schemaId":"schema_101","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}}},{"code":"404","schemaId":"schema_101","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/data-exports/showexport"}],"panels":[]}]},"httpPath":"/v2/data_exports/type/{type_name}/files/{file_id}"}],"content":{"contentType":"group","meta":{"name":"Data Exports"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Data Exports","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"The Data Exports API provides programmatic access to the same Direct Data Export v2 datasets available through Studio, without requiring an SFTP connection. Instead of configuring a server-to-server file delivery, clients can use the API to discover available export files, retrieve the latest file for a given export type, and request a temporary download URL for a specific file. The API supports the same export categories used by Direct Data Export v2"},"children":[]},{"$$mdtype":"Node","type":"text","attributes":{"content":"—"},"children":[]},{"$$mdtype":"Node","type":"text","attributes":{"content":"users, campaigns, and activities"},"children":[]},{"$$mdtype":"Node","type":"text","attributes":{"content":"—"},"children":[]},{"$$mdtype":"Node","type":"text","attributes":{"content":"making it a REST-based alternative for integrating Firstup export data into external reporting, warehousing, and analytics workflows."},"children":[]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v2/data_exports/type/{type_name}/latest","summary":"Get the latest export file for a given type.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/data-exports/latestexport","deprecated":false},{"title":"/v2/data_exports/type/{type_name}","summary":"List all available export files for a given type.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/data-exports/listexports","deprecated":false},{"title":"/v2/data_exports/type/{type_name}/files/{file_id}","summary":"Get metadata and download URL for a specific export file.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/data-exports/showexport","deprecated":false}]}]}]}]}},{"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.Resources"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listFeedChannelPosts","name":"Return a user's feed of posts for channels","isWebhook":false,"pointer":"/paths/~1v2~1feed~1channels~1posts/get","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Return a user's feed of posts for channels","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Resources"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://support.firstup.io/hc/en-us/articles/4415354532759-How-Do-Users-See-Content"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Knowledge Base article on Feed Channels"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"/feed_channels"},"href":"/feed_channels"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Feed Channels overview page"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"/gettingstarted/pagination"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Pagination"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"/gettingstarted/filtering"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Filtering"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2_as_a_user","scopes":["feeds.read"],"type":"oauth2","description":"OAuth2 for Users (Authorization Code grant flow)","flows":{"authorizationCode":{"authorizationUrl":"IAM_DOMAIN/oauth/authorize","tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","openid":"Authenticate your account using OpenID.","public":"View public information.","feeds.read":"View your feeds.","feeds.rendered.read":"View rendered content from feed posts.","feeds.engage":"View your feeds and engage with posts (likes, bookmarks, etc).","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","assistant.inbox.read":"View and list details of your assistant inbox items.","notification_center":"View and list notification center items.","data_exports.read":"View and download data export files in your program."}}}}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"name","in":"query","schemaId":"schema_196","description":"Use a specific named feed, which is a preset of filters for specific types of feeds. By default, requests return the \"following\" feed. Specifying a name not listed here will result in a 400 Bad Request error.\n"},{"name":"query","in":"query","schemaId":"schema_115","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Find content matching provided keywords. When specified, parameters other than pagination filter will be ignored. Required when using "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"search"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"page.size","in":"query","schemaId":"schema_103","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Return "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"page.size"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" number of records starting at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"size*number"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The default page size is 10 (number of records per page), resulting in the first page being retrieved. The maximum page size is 100."},"children":[]}]}]}]},{"name":"page.number","in":"query","schemaId":"schema_103","description":"Using classical pagination, the page number to return. Default is 1"}],"pointer":"/paths/~1v2~1feed~1channels~1posts/get/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_112"}},"schemaId":"schema_112","pointer":"/paths/~1v2~1feed~1channels~1posts/get/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/feed/channels/posts","servers":[{"url":"https://partner.socialchorus.com","description":"US1"},{"url":"https://partner.us2.onfirstup.com","description":"US2"},{"url":"https://partner.onfirstup.eu","description":"EU"}],"parameters":{"path":[],"query":[{"name":"name","in":"query","required":false,"schemaId":"schema_196"},{"name":"query","in":"query","required":false,"schemaId":"schema_115"},{"name":"page.size","in":"query","required":false,"schemaId":"schema_103"},{"name":"page.number","in":"query","required":false,"schemaId":"schema_103"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2_as_a_user","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"IAM_DOMAIN/oauth/authorize","tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","openid":"Authenticate your account using OpenID.","public":"View public information.","feeds.read":"View your feeds.","feeds.rendered.read":"View rendered content from feed posts.","feeds.engage":"View your feeds and engage with posts (likes, bookmarks, etc).","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","assistant.inbox.read":"View and list details of your assistant inbox items.","notification_center":"View and list notification center items.","data_exports.read":"View and download data export files in your program."}}}}],"scopes":["feeds.read"]}],"requestBody":{"application/json":{"schemaId":"schema_112"}},"responseCodes":["200","400","401","404"],"pointer":"/v2/feed/channels/posts","href":"feed-channel-posts/listfeedchannelposts","openApiOperationId":"listFeedChannelPosts","summary":"Return a user's feed of posts for channels"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://partner.socialchorus.com","description":"US1"},{"url":"https://partner.us2.onfirstup.com","description":"US2"},{"url":"https://partner.onfirstup.eu","description":"EU"}],"schemaId":"schema_112","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_112"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_197"}},"schemaId":"schema_197"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request (this 400 error example shows an incorrect enum validation in the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Name"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameter or "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Query"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is missing when using "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"search"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). See more on "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://developers.firstup.io/gettingstarted/responses#error-responses"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" error responses here "},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_198","exampleIds":["paths/~1v2~1feed~1channels~1posts/get/responses/400/content/application~1json/example"]}},"schemaId":"schema_198","exampleIds":["paths/~1v2~1feed~1channels~1posts/get/responses/400/content/application~1json/example"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthenticated. See more on "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://developers.firstup.io/gettingstarted/responses#error-responses"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" error responses here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}},"schemaId":"schema_101"},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Not Found. See more on "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://developers.firstup.io/gettingstarted/responses#error-responses"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" error responses here "},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}},"schemaId":"schema_101"}],"pointer":"/paths/~1v2~1feed~1channels~1posts/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_197","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_197"}}},{"code":"400","schemaId":"schema_198","exampleIds":["paths/~1v2~1feed~1channels~1posts/get/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_198","exampleIds":["paths/~1v2~1feed~1channels~1posts/get/responses/400/content/application~1json/example"]}}},{"code":"401","schemaId":"schema_101","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}}},{"code":"404","schemaId":"schema_101","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/feed-channel-posts/listfeedchannelposts"}],"panels":[]}]},"httpPath":"/v2/feed/channels/posts"}],"content":{"contentType":"group","meta":{"name":"Feed Channel Posts"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Feed Channel Posts","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v2/feed/channels/posts","summary":"Return a user's feed of posts for channels","prefix":{"name":"get","color":"get"},"badges":[],"link":"/feed-channel-posts/listfeedchannelposts","deprecated":false}]}]}]}]}},{"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":"Fetch the program user's shortcuts."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listShortcuts","name":"Fetch the program user's shortcuts.","isWebhook":false,"pointer":"/paths/~1v2~1shortcuts/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetch the program user's shortcuts.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Fetch the program user's shortcuts."},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2_as_a_user","scopes":["users.read"],"type":"oauth2","description":"OAuth2 for Users (Authorization Code grant flow)","flows":{"authorizationCode":{"authorizationUrl":"IAM_DOMAIN/oauth/authorize","tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","openid":"Authenticate your account using OpenID.","public":"View public information.","feeds.read":"View your feeds.","feeds.rendered.read":"View rendered content from feed posts.","feeds.engage":"View your feeds and engage with posts (likes, bookmarks, etc).","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","assistant.inbox.read":"View and list details of your assistant inbox items.","notification_center":"View and list notification center items.","data_exports.read":"View and download data export files in your program."}}}}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/shortcuts","servers":[{"url":"https://partner.socialchorus.com","description":"US1"},{"url":"https://partner.us2.onfirstup.com","description":"US2"},{"url":"https://partner.onfirstup.eu","description":"EU"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2_as_a_user","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"IAM_DOMAIN/oauth/authorize","tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","openid":"Authenticate your account using OpenID.","public":"View public information.","feeds.read":"View your feeds.","feeds.rendered.read":"View rendered content from feed posts.","feeds.engage":"View your feeds and engage with posts (likes, bookmarks, etc).","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","assistant.inbox.read":"View and list details of your assistant inbox items.","notification_center":"View and list notification center items.","data_exports.read":"View and download data export files in your program."}}}}],"scopes":["users.read"]}],"responseCodes":["200","400","401"],"pointer":"/v2/shortcuts","href":"user-shortcuts/listshortcuts","openApiOperationId":"listShortcuts","summary":"Fetch the program user's shortcuts."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://partner.socialchorus.com","description":"US1"},{"url":"https://partner.us2.onfirstup.com","description":"US2"},{"url":"https://partner.onfirstup.eu","description":"EU"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_199"}},"schemaId":"schema_199"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}},"schemaId":"schema_101"},{"code":"401","description":"Unauthenticated","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}},"schemaId":"schema_101"}],"pointer":"/paths/~1v2~1shortcuts/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_199","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_199"}}},{"code":"400","schemaId":"schema_101","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}}},{"code":"401","schemaId":"schema_101","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/user-shortcuts/listshortcuts"}],"panels":[]}]},"httpPath":"/v2/shortcuts"}],"content":{"contentType":"group","meta":{"name":"User Shortcuts"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"User Shortcuts","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v2/shortcuts","summary":"Fetch the program user's shortcuts.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/user-shortcuts/listshortcuts","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/Reactions.Fields":{"id":"components/schemas/Reactions.Fields","kind":"json-schema","title":"Reactions.Fields","data":{"type":"object","description":"Reaction counts and expanded reaction types for a post.","properties":{"reaction_counts":{"type":"object","description":"Counts of different reaction types on the content.","properties":{"likes":{"type":"integer","example":0},"views":{"type":"integer","example":1},"shares":{"type":"integer","example":0},"bookmarks":{"type":"integer","example":0}}},"expanded_reactions":{"type":"array","description":"Expanded reaction types with counts. Only included when the expanded reaction types feature is enabled for the program.","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"3fa85f64-5717-4562-b3fc-2c963f66afa6"},"emoji":{"type":"string","example":"👍"},"title":{"type":"string","example":"thumbsup"},"reacted":{"type":"boolean","example":true},"default":{"type":"boolean","example":true},"count":{"type":"integer","example":5}}}}}}},"components/schemas/Feeds.WebHomepage.Resource":{"id":"components/schemas/Feeds.WebHomepage.Resource","kind":"json-schema","title":"Feeds.WebHomepage.Resource","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A user's assembled custom homepage. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"feed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array contains an ordered list of modules. Each module has a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"attributes"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object whose shape depends on the module type ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"banner"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"link_carousel"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or a content module: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"hero"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"grid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"gallery"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"row"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Content modules embed their resolved "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"feed_items"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":["type","attributes"],"properties":{"type":{"type":"string","example":"web_homepage"},"attributes":{"type":"object","required":["id","feed"],"properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the homepage selected for this user.","example":"1f2e3d4c-5b6a-7980-1234-567890abcdef"},"feed":{"type":"array","description":"Ordered list of homepage modules.","items":{"$ref":"#/components/schemas/Feeds.WebHomepage.Module"}}}}},"example":{"type":"web_homepage","attributes":{"id":"1f2e3d4c-5b6a-7980-1234-567890abcdef","feed":[{"type":"banner","attributes":{"id":"11111111-1111-1111-1111-111111111111","size":"large","web_image":"https://cdn.example.com/banner.jpg","aria_label":"Company Announcement","image_url":"https://example.com/destination","action":{"type":"navigation","navigation":{"type":"external","url":"https://example.com/destination"}}}},{"type":"link_carousel","attributes":{"id":"shortcuts_module","shortcut_module_id":"22222222-2222-2222-2222-222222222222","is_reorder_enabled":true,"view_all_action":null,"links":[{"title":"Benefits","image_url":"https://cdn.example.com/benefits.png","action":{"type":"navigation","navigation":{"type":"external","url":"https://benefits.example.com"}}}]}},{"type":"hero","attributes":{"id":"33333333-3333-3333-3333-333333333333","name":"Featured Stories","display_type":"hero","description":"Top stories curated for you","source":"featured","content_inclusion":"all","minimum_content_threshold":3,"only_include_followed_topics":false,"reference_ids":[],"action":{"type":"navigation","navigation":{"type":"deeplink","url":"sc://feedfilter?filter_type=featured&pagination=older_than_id"}},"feed_items":[{"type":"article","attributes":{"id":1001,"title":"Company Update Q2","summary":"A brief overview of Q2 highlights.","image_url":"https://cdn.example.com/article-image.jpg","published_at":"2026-05-01T09:00:00Z","author":"Jane Smith","channel":"Company News","read_time_minutes":3,"is_read":false}}]}}]}}}},"components/schemas/Feeds.WebHomepage.Module":{"id":"components/schemas/Feeds.WebHomepage.Module","kind":"json-schema","title":"Feeds.WebHomepage.Module","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A single homepage module. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"attributes"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" varies by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"banner"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" modules carry image and action fields; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"link_carousel"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" carries the user's shortcuts; content modules ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"hero"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"grid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"gallery"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"row"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") carry their configuration plus an embedded "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"feed_items"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array."},"children":[]}]}]}],"required":["type","attributes"],"properties":{"type":{"type":"string","description":"The module type.","enum":["banner","link_carousel","hero","grid","gallery","row"]},"attributes":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Module attributes; shape depends on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}}}},"components/schemas/Feeds.Post.Resource":{"id":"components/schemas/Feeds.Post.Resource","kind":"json-schema","title":"Feeds.Post.Resource","data":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier for this post","example":456},"uuid":{"type":"string","format":"uuid","example":"8b358e6b-11d4-4e89-bf7f-ec670e3398ed"},"version":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The version of the content creation studio used to generate the content."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Legacy Studio"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Creator Studio"},"children":[]}]}]}]}],"enum":[1,2]},"content_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of content. One of: article, image, link, note, or video. The content_type can determine how the post should be presented."},"children":[]}]}]}],"example":"article"},"title":{"type":"string","description":"The post title. Can also be considered the headline.","example":"Example Post Title"},"summary":{"type":"string","description":"Short summary of the post.","example":"Example Post Summary"},"body":{"type":"string","description":"The body of the post.","example":"Example post body"},"accent_color":{"type":"string","description":"The color of the post, currently only applicable to notes."},"author":{"$ref":"#/components/schemas/Content.Post.Resource.author"},"channels":{"type":"array","description":"A list of the topics this post is published to.","items":{"type":"object","properties":{"channel_id":{"type":"integer","example":789,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Topic's unique identifier (GUID). "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NOTE:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Originally called \"id\" in this documentation."},"children":[]}]}]}]},"name":{"type":"string","example":"Name of Example Topic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Topic's name. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NOTE:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Originally called \"title\" in this documentation."},"children":[]}]}]}]}}}},"engagement":{"type":"object","properties":{"liked_at":{"type":"string","format":"date-time","description":"Date and time at which the user liked the post. If the user has not liked the post, this value will be null.","example":"2000-01-01T00:00:00Z"},"bookmarked_at":{"type":"string","format":"date-time","description":"Date and time at which the user bookmarked the post. If the user has not bookmarked the post, this value will be null.","example":"2000-01-01T00:00:00Z"},"viewed_at":{"type":"string","format":"date-time","description":"Date and time at which the user viewed the post. If the user has not viewed the post, this value will be null.","example":"2000-01-01T00:00:00Z"},"total_likes_count":{"type":"integer","format":"int64","description":"The total likes of this post within the program by any user.","example":5},"total_shares_count":{"type":"integer","format":"int64","description":"The total number of shares of this post within the program by any user.","example":5},"total_bookmarks_count":{"type":"integer","format":"int64","description":"The total number of bookmarks this post has got within the program by any user.","example":5}}},"updated_at":{"type":"string","format":"date-time","description":"When this content was last updated in ISO8601 format and UTC timezone.","example":"2000-01-01T00:00:00Z"},"published_at":{"type":"string","format":"date-time","description":"When this content was published in ISO8601 format and UTC timezone.","example":"2000-01-01T00:00:00Z"},"visibility":{"type":"string","enum":["private","public","any"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An indication of the native availability of the post within the Firstup platform. If 'public', the post has a public_link_url and shares of the post should use that url as the canonical url. If 'private', the post requires user authentication to view."},"children":[]}]}]}],"example":"public"},"featured":{"type":"boolean","description":"Whether the post is featured.","example":true},"featured_label":{"type":"string","description":"The content's feature label","example":"Save Pandora!"},"permalink_url":{"type":"string","description":"The url of the post on the Firstup platform.","example":"https://onfirstup.com/acme/acmetimes/sc4#contents/456"},"shareable_url":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The publicly shareable url of the post if it's visibility is public. Private visibility posts will have no shareable_url."},"children":[]}]}]}],"example":"https://onfirstup.com/acme/acmetimes/sc4#contents/456"},"prepopulated_share_message":{"type":"string","description":"The auto-generated string used when sharing the post.\n","example":"Example Post Title https://onfirstup.com/acme/acmetimes/sc4#contents/456"},"appended_hashtag":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The hashtag configured to be included when sharing the posts. example: #YourBrand"},"children":[]}]}]}]},"language":{"type":"string","description":"The language. For non-translatable posts, this value will be null.","example":"en"},"is_translatable":{"type":"boolean","description":"Whether the content is translatable.","example":true},"is_commentable":{"type":"boolean","description":"Whether the content allows comments.","example":true},"comment_count":{"type":"integer","description":"The number of comments on the content.","example":5},"poster_image_url":{"type":"string","description":"The url of the primary image used for this post, if one exists. ","example":"https://cdn.example.com/acme/acmetimes/images/abc123"},"links":{"type":"array","items":{"type":"object","properties":{"link_url":{"type":"string","example":"https://google.com"}}}},"images":{"type":"array","items":{"$ref":"#/components/schemas/Content.Image.Resource"}},"videos":{"type":"array","items":{"type":"object","properties":{"embed_html":{"type":"string","description":"Html that can be used to embed the video in a page, wrapped in an iframe widget.\n","example":"<iframe href='https://onfirstup.com/acme/acmetimes/sc4#contents/456/videos/abc123'></iframe>\n"},"link_url":{"type":"string","description":"A link to the video where it can be played","example":"https://onfirstup.com/acme/acmetimes/sc4#contents/456/videos/abc123"}}}}}}},"components/schemas/Feeds.Poll.Resource":{"id":"components/schemas/Feeds.Poll.Resource","kind":"json-schema","title":"Feeds.Poll.Resource","data":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier for this poll","example":456},"type":{"type":"string","example":"unanswered_poll"},"attributes":{"type":"object","properties":{"id":{"type":"integer","example":1},"program_id":{"type":"integer","example":1},"max_selections":{"type":"integer","example":1},"question_text":{"type":"string","example":"question"},"criterion":{"type":"string","example":"criterion"},"preset":{"type":"string","example":"preset"},"publish_at":{"type":"string","format":"date-time","example":"2000-01-01T00:00:00Z"},"archive_at":{"type":"string","format":"date-time","example":"2000-01-01T00:00:00Z"},"status":{"type":"string","example":"published"},"description_text":{"type":"string","example":"description text"},"selection":{"type":"string","example":"selection"},"selection_type":{"type":"string","example":"selection type"},"total_audience":{"type":"integer","example":1},"show_results_to_user":{"type":"boolean","example":true},"author":{"type":"object","properties":{"user_id":{"type":"integer","example":1},"avatar_color":{"type":"string","example":"avatar color"},"email":{"type":"string","example":"email"},"avatar_url":{"type":"string","example":"avatar url"},"display_name":{"type":"string","example":"display name"}}},"results":{"type":"object","properties":{"answer1":{"type":"integer","example":1},"answer2":{"type":"integer","example":2}}},"total_participants":{"type":"integer","example":1},"config":{"type":"object","properties":{"options":{"type":"array","items":{"type":"string","example":"answer1, answer2"}}}}}}}}},"components/schemas/Feeds.Video.Resource":{"id":"components/schemas/Feeds.Video.Resource","kind":"json-schema","title":"Feeds.Video.Resource","data":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for this video","example":"456"}}}},"components/schemas/Feeds.Attachment.Resource":{"id":"components/schemas/Feeds.Attachment.Resource","kind":"json-schema","title":"Feeds.Attachment.Resource","data":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for this attachment","example":"uuid"}}}},"components/schemas/Feeds.RenderedPost.Resource":{"id":"components/schemas/Feeds.RenderedPost.Resource","kind":"json-schema","title":"Feeds.RenderedPost.Resource","data":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier for this post","example":456},"content_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of content. One of: article, image, link, note, or video. The content_type can determine how the post should be presented."},"children":[]}]}]}],"example":"article"},"locale":{"type":"string","description":"The locale. For non-translatable posts, this value will be null.","example":"en"},"is_translatable":{"type":"boolean","description":"Whether the content is translatable.","example":true},"rendered":{"type":"string","description":"An HTML string containing the rendered content.","example":"<html><body>Rendered Content</body></html>"}}}},"components/schemas/Feeds.PostEngagement.Resource":{"id":"components/schemas/Feeds.PostEngagement.Resource","kind":"json-schema","title":"Feeds.PostEngagement.Resource","data":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier for this post"},"user_id":{"type":"integer","example":456},"liked_at":{"type":"string","format":"date-time","description":"Date and time at which the user liked the post. If the user has not liked the post, this value will be null.","example":"2000-01-01T00:00:00Z"},"bookmarked_at":{"type":"string","format":"date-time","description":"Date and time at which the user bookmarked the post. If the user has not bookmarked the post, this value will be null.","example":"2000-01-01T00:00:00Z"},"viewed_at":{"type":"string","format":"date-time","description":"Date and time at which the user viewed the post. If the user has not viewed the post, this value will be null.","example":"2000-01-01T00:00:00Z"},"shares":{"type":"array","items":{"type":"object","properties":{"share_id":{"type":"string","description":"The identifier of the share record used internally at Firstup."},"platform":{"type":"string","description":"The platform on which the share was created. Usually a social network."},"posted_at":{"type":"string","format":"date-time","description":"The date/time at which the post was created on the external platform."},"share_url":{"type":"string","description":"The url to the post where it is shared on the external platform."}}}},"total_likes_count":{"type":"integer","format":"int64","description":"The total likes of this post within the program by any user.","example":5},"total_shares_count":{"type":"integer","format":"int64","description":"The total shares of this post within the program by any user.","example":0},"total_bookmarks_count":{"type":"integer","format":"int64","description":"The total number of bookmarks this post has got within the program by any user.","example":0}}}},"components/schemas/Feed.Comment.Resource":{"id":"components/schemas/Feed.Comment.Resource","kind":"json-schema","title":"Feed.Comment.Resource","data":{"type":"object","properties":{"id":{"type":"integer","description":"The unique id of the comment record.","example":456},"uuid":{"type":"string","description":"The UUID of the comment record.","example":"8b358e6b-11d4-4e89-bf7f-ec670e3398ed"},"author":{"$ref":"#/components/schemas/Content.Post.Resource.author"},"raw_body":{"type":"string","description":"The body of the comment, as it was written by the user.","example":"Example comment text"},"body":{"type":"string","description":"The body of the comment, in HTML format.","example":"<p>Example comment text</p>"},"liked":{"type":"boolean","description":"Whether this comment was liked by the feed owner.","example":true},"like_count":{"type":"integer","description":"How many users have liked this comment.","example":5},"reply_count":{"type":"integer","description":"The number of replies associated with this comment.","example":5},"attachments":{"type":"array","description":"An array of attachments associated with this comment.","items":{"$ref":"#/components/schemas/Feed.Comment.Attachment.Resource"}},"created_at":{"type":"string","format":"date-time","description":"When this comment was created in ISO8601 format and UTC timezone.\n","example":"2000-01-01T00:00:00Z"},"updated_at":{"type":"string","format":"date-time","description":"When this comment was last updated in ISO8601 format and UTC timezone.\n","example":"2000-01-01T00:00:00Z"},"post_number":{"type":"integer","description":"The identifier of the comment post.","example":1}}}},"components/schemas/Feed.Comment.Attachment.Resource":{"id":"components/schemas/Feed.Comment.Attachment.Resource","kind":"json-schema","title":"Feed.Comment.Attachment.Resource","data":{"type":"object","properties":{"url":{"type":"string","description":"URL of image attached to the comment.","example":"https://example.com/image.jpg"},"alt_text":{"type":"string","description":"The alt text for the attachment","example":"Image Caption"}}}},"components/schemas/Content.Channel.Post.Resource":{"id":"components/schemas/Content.Channel.Post.Resource","kind":"json-schema","title":"Content.Channel.Post.Resource","data":{"type":"object","properties":{"name":{"type":"string","example":"Company News","description":"The topic name."},"description":{"type":"string","example":"All the latest from our company.","description":"The topic description."},"state":{"type":"string","description":"The state of the topic. One of: archived, hidden, or published.","enum":["active","published","hidden","available","archived"],"example":"published"},"auto_publish":{"type":"boolean","example":true,"description":"Whether the topic is set to auto-publish."},"auto_follow":{"type":"boolean","example":true,"description":"Whether the topic is set to auto-follow."},"auto_follow_mandatory":{"type":"boolean","example":true,"description":"Whether the topic is set to mandatory auto-follow."},"recommended":{"type":"boolean","example":true,"description":"Whether the topic is recommended."},"targeted":{"type":"boolean","example":true,"description":"Whether the topic is targeted."},"user_submittable":{"type":"boolean","example":true,"description":"Whether the topic is user-submittable."},"groups":{"type":"array","example":["group1","group2"],"description":"A list of the audiences this topic is targeted to.","items":{"type":"string"}},"contributor_count":{"type":"integer","example":12,"description":"How many contributors this topic has.","readOnly":true},"contributors":{"type":"array","example":[1,2],"description":"Contributor IDs","items":{"type":"integer"}},"follower_count":{"type":"integer","example":1000,"description":"How many followers this topic has.","readOnly":true},"created_at":{"type":"string","format":"date-time","description":"When this topic was created in ISO8601 format and UTC timezone.\n","example":"2000-01-01T00:00:00Z","readOnly":true},"updated_at":{"type":"string","format":"date-time","description":"When this topic was last updated in ISO8601 format and UTC timezone.\n","example":"2000-01-01T00:00:00Z","readOnly":true},"promoted":{"type":"boolean","description":"Is channel promoted\n","example":true}},"required":["name","description"]}},"components/schemas/Content.Channel.Resource":{"id":"components/schemas/Content.Channel.Resource","kind":"json-schema","title":"Content.Channel.Resource","data":{"allOf":[{"$ref":"#/components/schemas/Content.Channel.Post.Resource"},{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier for the topic.","example":789,"readOnly":true}}}]}},"components/schemas/Content.ChannelFollower.Resource":{"id":"components/schemas/Content.ChannelFollower.Resource","kind":"json-schema","title":"Content.ChannelFollower.Resource","data":{"type":"object","properties":{"avatar_url":{"description":"Path to an image representing the follower.","type":"string","example":"https://example.com/avatar.png"},"display_name":{"description":"The name to display as the follower.","type":"string","example":"Some User"},"user_id":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Firstup user_id of the follower."},"children":[]}]}]}],"type":"integer","example":123},"full_name":{"description":"Full name of the follower.","type":"string","example":"Bobby Brown"},"username":{"description":"Username of the follower.","type":"string","example":"BobbyBrown"},"employee_id":{"description":"Employee ID of the follower.","type":"string","example":"employee1"}}}},"components/schemas/Content.ChannelPage.Resource":{"id":"components/schemas/Content.ChannelPage.Resource","kind":"json-schema","title":"Content.ChannelPage.Resource","data":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier for the tab.","example":1},"tab_type":{"type":"string","description":"Type of the tab.","example":"custom"},"position":{"type":"integer","description":"Display order position.","example":1},"name":{"type":"string","description":"Display name of the tab.","example":"Welcome"},"preview_content":{"type":"string","description":"Brief preview content for the page. Only for custom and about tabs.","example":"Welcome preview...","nullable":true},"page_content":{"type":"string","description":"Full HTML content of the page. Only for custom and about tabs.","example":"<p>Welcome to our channel...</p>","nullable":true}}}},"components/schemas/Content.Post.Resource":{"id":"components/schemas/Content.Post.Resource","kind":"json-schema","title":"Content.Post.Resource","data":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier for this post.","example":456},"version":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The version of the content creation studio used to generate the content."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Legacy Studio"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Creator Studio"},"children":[]}]}]}]}],"enum":[1,2]},"uuid":{"type":"string","format":"uuid","example":"8b358e6b-11d4-4e89-bf7f-ec670e3398ed"},"content_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of content. One of: article, image, link, note, or video. The content_type can determine how the post should be presented."},"children":[]}]}]}],"example":"article"},"cover_image_alt":{"type":"string","description":"The url of the post on the Firstup platform. This property will only be returned for V2 content which can be viewed but not created via the Firstup API.\n","example":"Image of an elephant"},"permalink_url":{"type":"string","description":"The url of the post on the Firstup platform.","example":"https://onfirstup.com/acme/acmetimes/sc4#contents/456"},"title":{"type":"string","description":"The post title. Can also be considered the headline.","example":"Example Article Title"},"summary":{"type":"string","description":"Short summary of the post.","example":"Example article summary"},"body":{"type":"string","description":"The body of the post.","example":"Example article body"},"state":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The state of the post. One of: archived, draft, processing, processing_error, published, review or scheduled."},"children":[]}]}]}],"example":"published"},"accent_color":{"type":"string","description":"The color of the post, currently only applicable to notes.","example":"#ae2225"},"featured_label":{"type":"string","description":"The content's feature label","example":"Save Pandora!"},"featured":{"type":"boolean","description":"Whether the post is featured.","example":false},"author":{"$ref":"#/components/schemas/Content.Post.Resource.author"},"channels":{"type":"array","description":"A list of the topics this post is published to.","items":{"type":"object","properties":{"id":{"type":"integer","example":789,"description":"Unique identifier for the topic."},"name":{"type":"string","example":"Example Topic Name"}}}},"source":{"properties":{"type":{"type":"string","example":"studio"},"post_id":{"type":"string","description":"The unique identifier of the post on the source system, if it is republished from another platform or application.\n","example":"abc123"},"posted_at":{"type":"string","description":"The timestamp at which the post was published on the source system, if it is republished from another platform or application.\n","example":"2000-01-01T00:00:00Z"}}},"template":{"properties":{"id":{"type":"integer","example":234}}},"visibility":{"type":"string","enum":["private","public","any"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An indication of the native availability of the post within the Firstup platform. If 'public', the post has a public_link_url and shares of the post should use that url as the canonical url. If 'private', the post requires user authentication to view."},"children":[]}]}]}],"example":"public"},"shareable_url":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The publicly shareable url of the post if its visibility is public. Private visibility posts will have no shareable_url."},"children":[]}]}]}],"example":"https://onfirstup.com/acme/acmetimes/sc4#contents/456"},"language":{"type":"string","description":"The language. For non-translatable posts, this value will be null.","example":"en"},"is_translatable":{"type":"boolean","description":"Whether the content is translatable.","example":true},"is_commentable":{"type":"boolean","description":"Whether the content allows comments.","example":true},"comment_count":{"type":"integer","description":"The number of comments on the content.","example":5},"created_at":{"type":"string","format":"date-time","description":"When this content was created in ISO8601 format and UTC timezone.\n","example":"2000-01-01T00:00:00Z"},"updated_at":{"type":"string","format":"date-time","description":"When this content was last updated in ISO8601 format and UTC timezone.\n","example":"2000-01-01T00:00:00Z"},"published_at":{"type":"string","format":"date-time","description":"When this content was published in ISO8601 format and UTC timezone.\n","example":"2000-01-01T00:00:00Z"},"links":{"type":"array","items":{"type":"object","properties":{"link_url":{"type":"string","example":"https://google.com"}}}},"images":{"type":"array","items":{"$ref":"#/components/schemas/Content.Image.Resource"}},"image_blocks":{"type":"array","description":"All image blocks of Creator Studio content","items":{"$ref":"#/components/schemas/Content.ImageBlock.Resource"}},"videos":{"type":"array","items":{"$ref":"#/components/schemas/Content.Video.Resource"}},"initiatives":{"type":"array","description":"A list of the initiatives.","items":{"type":"object","properties":{"id":{"type":"integer","example":2,"description":"Unique identifier for the initiative."},"name":{"type":"string","example":"Example Initiative Name"}}}}}}},"components/schemas/Content.Post.Resource.author":{"id":"components/schemas/Content.Post.Resource.author","kind":"json-schema","title":"Content.Post.Resource.author","data":{"type":"object","properties":{"avatar_url":{"description":"Path to an image representing the author.","type":"string","example":"https://example.com/avatar.png"},"display_name":{"description":"The name to display as the author.","type":"string","example":"Some User"},"user_id":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Firstup user_id of the author."},"children":[]}]}]}],"type":"integer","example":123}}}},"components/schemas/Content.Comment.Resource":{"id":"components/schemas/Content.Comment.Resource","kind":"json-schema","title":"Content.Comment.Resource","data":{"type":"object","properties":{"id":{"type":"integer","description":"The unique ID of the comment record.","example":567},"uuid":{"type":"string","description":"The UUID of the comment record.","example":"8b358e6b-11d4-4e89-bf7f-ec670e3398ed"},"author":{"$ref":"#/components/schemas/Content.Post.Resource.author"},"body":{"type":"string","description":"The body of the comment, in HTML format.","example":"<p>Example comment text</p>"},"raw_body":{"type":"string","description":"The body of the comment as it was written by the user.","example":"Example comment text"},"attachments":{"type":"array","description":"An array of attachments associated with this comment.","items":{"$ref":"#/components/schemas/Content.Comment.Attachment.Resource"}},"like_count":{"type":"integer","description":"How many users have liked this comment.","example":5},"reply_count":{"type":"integer","description":"The number of replies associated with this comment.","example":5},"created_at":{"type":"string","format":"date-time","description":"When this comment was created in ISO8601 format and UTC timezone.\n","example":"2000-01-01T00:00:00Z"},"updated_at":{"type":"string","format":"date-time","description":"When this comment was last updated in ISO8601 format and UTC timezone.\n","example":"2000-01-01T00:00:00Z"},"post_number":{"type":"integer","description":"The identifier of the comment post.","example":1}}}},"components/schemas/Content.Image.Resource":{"id":"components/schemas/Content.Image.Resource","kind":"json-schema","title":"Content.Image.Resource","data":{"type":"object","properties":{"id":{"type":"integer","description":"The unique identifier of this image record","example":678},"image_url":{"type":"string","example":"https://cdn.example.com/acme/acmetimes/images/abc123"},"width":{"type":"integer","description":"The width of the image in pixels","example":1024},"height":{"type":"integer","description":"The height of the image in pixels","example":768}}}},"components/schemas/Content.ImageBlock.Resource":{"id":"components/schemas/Content.ImageBlock.Resource","kind":"json-schema","title":"Content.ImageBlock.Resource","data":{"type":"object","properties":{"id":{"type":"integer","description":"The unique identifier of this image block record","example":678},"image_url":{"type":"string","example":"https://cdn.example.com/acme/acmetimes/images/abc123"},"width":{"type":"integer","description":"The width of the image in pixels","example":1024},"height":{"type":"integer","description":"The height of the image in pixels","example":768},"alt_text":{"type":"string","description":"The alt text of the image","example":"Example alt text"}}}},"components/schemas/Content.Video.Resource":{"id":"components/schemas/Content.Video.Resource","kind":"json-schema","title":"Content.Video.Resource","data":{"properties":{"id":{"type":"integer","description":"The unique identifier of this video record"},"uuid":{"type":"string","format":"uuid","description":"The unique uuid identifier of this video record. Used in public urls.\n","example":"205ba32a-7f12-439d-b33d-df1c611c8e9c"},"caption":{"type":"string","description":"A caption description of this video.","example":"Example video caption"},"source":{"type":"string","enum":["youtube","vimeo","socialchorus","socialchorus_galaxy","office365"],"example":"socialchorus"},"state":{"type":"string","enum":["completed","submitted","error"],"example":"completed"},"duration":{"type":"integer","format":"int64","description":"Length of the video in seconds","example":30},"preview_image_url":{"type":"string","description":"A url to an image that acts as a poster for the video before the video is loaded.\n"},"embed_html":{"type":"string","description":"An HTML iframe widget that can be used to embed the video in an article.\n","example":"<iframe href='https://onfirstup.com/acme/acmetimes/sc4#contents/456/videos/abc123'></iframe>\n"},"link_url":{"type":"string","description":"A link to the video where it can be played","example":"https://onfirstup.com/acme/acmetimes/sc4#contents/456/videos/abc123"},"created_at":{"type":"string","format":"date-time","example":"2000-01-01T00:00:00Z"}}}},"components/schemas/Content.Comment.Attachment.Resource":{"id":"components/schemas/Content.Comment.Attachment.Resource","kind":"json-schema","title":"Content.Comment.Attachment.Resource","data":{"type":"object","properties":{"url":{"type":"string","description":"URL of image attached to the comment.","example":"https://image.example.com/image.png"},"alt_text":{"type":"string","description":"The alt text for the attachment","example":"Image caption"}}}},"components/schemas/Content.Creation.Images":{"id":"components/schemas/Content.Creation.Images","kind":"json-schema","title":"Content.Creation.Images","data":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An ordered list of images for this content."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Images are only validated for content of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"image\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" type. There is a limit of ten images."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"children":[]}]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The content returned immediately after content creation or modification contains will not contain the final image URIs due to additional post-processing"},"children":[]}]}]}],"items":{"type":"object","required":["image_url"],"properties":{"image_url":{"type":"string","example":"https://image.site.com/an_image.png"}}}}},"components/schemas/Scim.Group.Resource":{"id":"components/schemas/Scim.Group.Resource","kind":"json-schema","title":"Scim.Group.Resource","data":{"type":"object","properties":{"id":{"type":"integer","description":"Group unique id\n","example":115},"displayName":{"type":"string","description":"A human-readable name for the Group. REQUIRED.","example":"Group of users"},"externalId":{"type":"string","description":"ID from provisioning system. This is the resource ID on the client system, not Firstup's ID.","example":"1234qweasd567"},"description":{"type":"string","description":"Description for the Group.","example":"Group of iOS users from partner domain"},"members":{"type":"array","description":"A list of members of the Group.","example":[{"value":"3","_$ref":"https://partner.socialchorus.com/scim/v2/Users/3"}],"items":{"type":"object","properties":{"value":{"type":"string","description":"unique member identifier","example":"1"},"$ref":{"type":"string","description":"reference to a member","example":"https://partner.socialchorus.com/scim/v2/Users/1"}}}},"meta":{"type":"object","properties":{"resourceType":{"type":"string","example":"Group"},"created":{"type":"string","description":"date and time when the group was created","example":"2022-05-13T13:32:00.598Z"},"lastModified":{"type":"string","description":"date and time when the group was last updated","example":"2022-05-13T13:32:00.598Z"},"location":{"type":"string","description":"URL of the group","example":"https://partner.socialchorus.com/scim/v2/Groups/115"},"next":{"type":"string","description":"URL of the next page of group","example":"https://partner.socialchorus.com/scim/v2/Groups/115?page=2"}}}}}},"components/schemas/Scim.Group.AsyncResource":{"id":"components/schemas/Scim.Group.AsyncResource","kind":"json-schema","title":"Scim.Group.AsyncResource","data":{"type":"object","properties":{"id":{"type":"integer","description":"Group unique id\n","example":115},"name":{"type":"string","description":"A name for the Group, generated from the given displayName.","example":"group_of_users"},"displayName":{"type":"string","description":"A human-readable name for the Group.","example":"Group of users"},"externalId":{"type":"string","description":"ID from provisioning system. This is the resource ID on the client system, not Firstup's ID.","example":"1234qweasd567"},"description":{"type":"string","description":"Description for the Group.","example":"Group of iOS users from partner domain"},"members":{"type":"array","description":"An empty array, as members will be changed later, asynchronously","example":[],"items":{"type":"object"}},"meta":{"type":"object","properties":{"resourceType":{"type":"string","example":"Group"},"created":{"type":"string","description":"date and time when the group was created","example":"2022-05-13T13:32:00.598Z"},"lastModified":{"type":"string","description":"date and time when the group was last updated","example":"2022-05-13T13:32:00.598Z"},"location":{"type":"string","description":"URL of the group","example":"https://partner.socialchorus.com/scim/v2/Groups/115"},"jobId":{"type":"integer","description":"the ID of the asynchronus job, to be able to request a Job report","example":4567}}},"SocialChorus:1.0:Group":{"type":"object","example":{}}}}},"components/schemas/Scim.Group.SocialChorusExtension":{"id":"components/schemas/Scim.Group.SocialChorusExtension","kind":"json-schema","title":"Scim.Group.SocialChorusExtension","data":{"type":"object","properties":{"identifierField":{"type":"string","description":"Specifies which user identifier field to use to determine group membership.\nAllowed values are 'id', 'email' and 'userName'. Default value is 'userName'.\n","example":"userName"}}}},"components/schemas/Scim.Group.UpdateRequestBody":{"id":"components/schemas/Scim.Group.UpdateRequestBody","kind":"json-schema","title":"Scim.Group.UpdateRequestBody","data":{"type":"object","properties":{"displayName":{"type":"string","example":"Group of specific users"},"description":{"type":"string","example":"Group of iOS users from partner domain"},"SocialChorus:1.0:Group":{"$ref":"#/components/schemas/Scim.Group.SocialChorusExtension"},"externalId":{"type":"string","example":"1234qweasd567"},"members":{"type":"array","description":"An array of objects representing user identifiers to be included into a group. The identifiers allowed are the user \"id\", \"email\" and \"userName\" (defaulting to \"userName\").\n","example":[{"value":"username3"},{"value":"username4"},{"value":"username33"}],"items":{"type":"object","properties":{"value":{"type":"string","example":"username3"}}}}},"required":["displayName"]}},"components/schemas/Scim.Group.CreateRequestBody":{"id":"components/schemas/Scim.Group.CreateRequestBody","kind":"json-schema","title":"Scim.Group.CreateRequestBody","data":{"type":"object","properties":{"displayName":{"type":"string","example":"Group of specific users"},"description":{"type":"string","example":"Group of iOS users from partner domain"},"SocialChorus:1.0:Group":{"$ref":"#/components/schemas/Scim.Group.SocialChorusExtension"},"externalId":{"type":"string","example":"1234qweasd567"},"members":{"type":"array","description":"An array of objects representing user identifiers to be included into a group. The identifiers allowed are the user \"id\", \"email\" and \"userName\" (defaulting to \"userName\").\n","example":[{"value":"username3"},{"value":"username4"},{"value":"username33"}],"items":{"type":"object","properties":{"value":{"type":"string","example":"username3"}}}}},"required":["displayName"]}},"components/schemas/Scim.Group.BaseRequestBody":{"id":"components/schemas/Scim.Group.BaseRequestBody","kind":"json-schema","title":"Scim.Group.BaseRequestBody","data":{"type":"object","properties":{"displayName":{"type":"string","example":"Group of specific users"},"description":{"type":"string","example":"Group of iOS users from partner domain"},"SocialChorus:1.0:Group":{"$ref":"#/components/schemas/Scim.Group.SocialChorusExtension"},"externalId":{"type":"string","example":"1234qweasd567"},"members":{"type":"array","description":"An array of objects representing user identifiers to be included into a group. The identifiers allowed are the user \"id\", \"email\" and \"userName\" (defaulting to \"userName\").\n","example":[{"value":"username3"},{"value":"username4"},{"value":"username33"}],"items":{"type":"object","properties":{"value":{"type":"string","example":"username3"}}}}},"required":["displayName"]}},"components/schemas/Scim.Group.PatchRequestBody":{"id":"components/schemas/Scim.Group.PatchRequestBody","kind":"json-schema","title":"Scim.Group.PatchRequestBody","data":{"type":"object","properties":{"schemas":{"type":"array","items":{"type":"string"},"example":["urn:ietf:params:scim:api:messages:2.0:PatchOp"]},"SocialChorus:1.0:Group":{"$ref":"#/components/schemas/Scim.Group.SocialChorusExtension"},"Operations":{"type":"array","items":{"type":"object","properties":{"op":{"type":"string","example":"add"},"path":{"type":"string","example":"members"},"value":{"type":"array","items":{"type":"object","example":{"value":"username3"}}}}}}}}},"components/schemas/Scim.User.Resource":{"id":"components/schemas/Scim.User.Resource","kind":"json-schema","title":"Scim.User.Resource","data":{"allOf":[{"$ref":"#/components/schemas/Scim.User.Core"},{"type":"object","properties":{"urn:SocialChorus:1.0:User":{"$ref":"#/components/schemas/Scim.User.SocialChorusExtension"},"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User":{"$ref":"#/components/schemas/Scim.User.EnterpriseExtension"}}}]}},"components/schemas/Scim.User.Core":{"id":"components/schemas/Scim.User.Core","kind":"json-schema","title":"Scim.User.Core","data":{"type":"object","properties":{"meta":{"type":"object","properties":{"resourceType":{"type":"string","example":"User"}}},"id":{"$ref":"#/components/schemas/Scim.User.Core.id"},"userName":{"$ref":"#/components/schemas/Scim.User.Core.userName"},"programMembershipId":{"$ref":"#/components/schemas/Scim.User.Core.programMembershipId"},"externalId":{"$ref":"#/components/schemas/Scim.User.Core.externalId"},"name":{"$ref":"#/components/schemas/Scim.User.Core.name"},"displayName":{"$ref":"#/components/schemas/Scim.User.Core.displayName"},"nickName":{"$ref":"#/components/schemas/Scim.User.Core.nickName"},"roles":{"$ref":"#/components/schemas/Scim.User.Core.roles"},"emails":{"$ref":"#/components/schemas/Scim.User.Core.emails"},"photos":{"$ref":"#/components/schemas/Scim.User.Core.photos"},"phoneNumbers":{"$ref":"#/components/schemas/Scim.User.Core.phoneNumbers"},"addresses":{"$ref":"#/components/schemas/Scim.User.Core.addresses"},"title":{"$ref":"#/components/schemas/Scim.User.Core.title"},"userType":{"$ref":"#/components/schemas/Scim.User.Core.userType"},"locale":{"$ref":"#/components/schemas/Scim.User.Core.locale"},"timezone":{"$ref":"#/components/schemas/Scim.User.Core.timezone"},"preferredLanguage":{"$ref":"#/components/schemas/Scim.User.Core.preferredLanguage"},"active":{"$ref":"#/components/schemas/Scim.User.Core.active"}}}},"components/schemas/Scim.User.Core.id":{"id":"components/schemas/Scim.User.Core.id","kind":"json-schema","title":"Scim.User.Core.id","data":{"type":"string","example":"8675309","description":"\nAn immutable string identifier for the user. This value will never change once a user is created.\n"}},"components/schemas/Scim.User.Core.roleString":{"id":"components/schemas/Scim.User.Core.roleString","kind":"json-schema","title":"Scim.User.Core.roleString","data":{"type":"string","default":"member","example":"publisher","enum":["administrator","program_manager","analyst","publisher","channel_contributor","member"]}},"components/schemas/Scim.User.Core.roleObject":{"id":"components/schemas/Scim.User.Core.roleObject","kind":"json-schema","title":"Scim.User.Core.roleObject","data":{"description":"The roles key is an array containing a single object that defines the user's\nrole or legacy role within the Firstup application. This key provides crucial\ninformation about the user's permissions and access level, allowing for\nprecise role-based management and authorization across the platform.\n","type":"object","properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field specifies the role or access permissions in the Firstup API. It encompasses the following key elements:"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field specifies the role or access permissions in the Firstup API."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It encompasses the following key elements:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Role:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Represents the Creator Studio Advanced Permissions Role, defining the user's overarching responsibilities."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Scope:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Indicates the restrictions associated with the Advanced Permissions Role, determining the records the user can access within Firstup."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Legacy Roles:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Deprecated roles from the past that may still be associated with the user. In most scenarios, these roles are no longer utilized and are not required for current functionality."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Ensure to review and align roles and scopes for effective management of user access and permissions."},"children":[]}]}]}],"enum":["role","scope","legacy_role"]},"value":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"value"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field within the context of the Firstup API represents the identifier or key associated with the corresponding record."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This identifier links to the specific record defined by the user's role, scope, or legacy roles."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example, if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is role, the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"value"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" would point to the unique identifier for that role."},"children":[]}]}]}],"nullable":true}},"example":{"type":"scope","value":"audience:15"}}},"components/schemas/Scim.User.Core.rolesObjectArray":{"id":"components/schemas/Scim.User.Core.rolesObjectArray","kind":"json-schema","title":"Scim.User.Core.rolesObjectArray","data":{"type":"array","minItems":1,"example":["member"],"items":{"oneOf":[{"$ref":"#/components/schemas/Scim.User.Core.roleString"},{"$ref":"#/components/schemas/Scim.User.Core.roleObject"}]}}},"components/schemas/Scim.User.Core.userName":{"id":"components/schemas/Scim.User.Core.userName","kind":"json-schema","title":"Scim.User.Core.userName","data":{"type":"string","example":"janeDoe123","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"userName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" uniquely identifies a user in the scope of your organization. It can be updated by the client, but must remain unique."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In Firstup Studio it is referred to as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"universal_identifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}},"components/schemas/Scim.User.Core.programMembershipId":{"id":"components/schemas/Scim.User.Core.programMembershipId","kind":"json-schema","title":"Scim.User.Core.programMembershipId","data":{"type":"string","example":"262574","description":"An immutable string identifier for the user's program membership.\n"}},"components/schemas/Scim.User.Core.externalId":{"id":"components/schemas/Scim.User.Core.externalId","kind":"json-schema","title":"Scim.User.Core.externalId","data":{"example":"ext_123489","description":"ID from provisioning system. This is the resource ID on the client system, not Firstup's ID.","oneOf":[{"type":"string","nullable":true},{"type":"integer","nullable":true}]}},"components/schemas/Scim.User.Core.name":{"id":"components/schemas/Scim.User.Core.name","kind":"json-schema","title":"Scim.User.Core.name","data":{"type":"object","properties":{"givenName":{"type":"string","example":"Jane","description":"User's first name"},"familyName":{"type":"string","example":"Doe","description":"User's last name"}},"description":"An object containing multiple parts that make up a user's name.\n","required":["givenName","familyName"],"additionalProperties":false}},"components/schemas/Scim.User.Core.displayName":{"id":"components/schemas/Scim.User.Core.displayName","kind":"json-schema","title":"Scim.User.Core.displayName","data":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"admonition","inline":true,"attributes":{"type":"warning"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Please refrain from using this attribute without prior consultation with our support staff."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n  This attribute serves a distinct purpose within the Firstup system, requires a specific format\n  and inappropriate use may introduce unintended side effects.\n"},"children":[]}]}]}},"components/schemas/Scim.User.Core.nickName":{"id":"components/schemas/Scim.User.Core.nickName","kind":"json-schema","title":"Scim.User.Core.nickName","data":{"type":"string","nullable":true,"example":"Jane","description":"The casual way to address the user in real life."}},"components/schemas/Scim.User.Core.active":{"id":"components/schemas/Scim.User.Core.active","kind":"json-schema","title":"Scim.User.Core.active","data":{"example":true,"description":"\nWhether or not the user is currently marked \"active\" in the program.\n","oneOf":[{"type":"boolean"},{"type":"string"}]}},"components/schemas/Scim.User.Core.roles":{"id":"components/schemas/Scim.User.Core.roles","kind":"json-schema","title":"Scim.User.Core.roles","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defines a user's permissions and access privileges within a system or application."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The provided array extends support for Advanced Permissions, while supporting legacy Roles from Classic Studio. It accommodates a list of objects, each detailing the user's role, record permissions (scope), and legacy role if applicable."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"admonition","inline":true,"attributes":{"type":"info"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Extended documentation explaining how user roles and access works within our API can be found "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://developers.firstup.io/usermanagementapi/user-role-provisioning"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". "},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Discover Available Roles"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"/endpoints/openapi/user-roles"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" GET /scim/v2/roles "},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"to explore available roles."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Available Legacy Roles"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"administrator"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"program_manager"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"analyst"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"publisher"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"channel_contributor"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"member"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional Resources"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For comprehensive insights into roles, scopes, and legacy roles refer to the following Knowledge Base Articles:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://support.firstup.io/hc/en-us/articles/6278321908503"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Roles-Standard"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://support.firstup.io/hc/en-us/articles/6744088254359"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Roles-Custom"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://support.firstup.io/hc/en-us/articles/6278321908503#h_01HBV399TW5WN1ZZABQF845H4E"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Scopes or Restrictions"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://howto.socialchorus.com/hc/en-us/articles/115006356588#h_23542235341518566935216"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Legacy Roles"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Backward Compatibility:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Support the original single-string legacy role format [\""},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"legacy_role"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"]"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Legacy roles include \"administrator\",  \"program_manager\", \"analyst\", \"publisher\", \"channel_contributor\", or \"member\"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"/endpoints/openapi/user-management/listusers"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" GET /scim/v2/users"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"/endpoints/openapi/user-management/detailuser"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GET /scim/v2/users/{user_id}"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" return this field based on a program configuration. Please contact"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://support.firstup.io/hc/en-us"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Support"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if you need to switch the syntax."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"admonition","inline":true,"attributes":{"type":"info"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Firstup users have a single role and legacy_role but can have multiple scopes applied."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Limitation Notice: Scope"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In addition to role and legacy_role the array supports the setting of record restrictions via scope objects. This includes the ability to define Topic, Audience, Template, and Email Aliases Permissions."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Issue:"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Currently the API does not validate the scope data against existing restriction records. While this does not compromise system security, it may result in users experiencing unexpected access limitations."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Impact:"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Users will still be able to access the application, but their access may not align with expectations due to permissions for records that are not valid. It's crucial to recognize that topic, audience, template, and email scopes play a pivotal role in limiting users to only seeing records defined within those specified scopes."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Recommendation:"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To ensure accurate access and visibility, we recommend using the Bulk Permissions UI. This ensures that restrictions align with the intended access for users, providing a proactive approach to managing and validating restriction data effectively."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]}],"oneOf":[{"$ref":"#/components/schemas/Scim.User.Core.roleString"},{"$ref":"#/components/schemas/Scim.User.Core.rolesObjectArray"}]}},"components/schemas/Scim.User.Core.emails":{"id":"components/schemas/Scim.User.Core.emails","kind":"json-schema","title":"Scim.User.Core.emails","data":{"type":"array","description":"A list of the user's emails.\nIf a user has no emails this will be an empty list.\n","items":{"$ref":"#/components/schemas/Scim.User.Core.email"}}},"components/schemas/Scim.User.Core.photos":{"id":"components/schemas/Scim.User.Core.photos","kind":"json-schema","title":"Scim.User.Core.photos","data":{"type":"array","description":"A list containing at most a single element, the user's avatar photo URL.\nIf a user has no avatar photo URL this will be an empty list.\n","items":{"$ref":"#/components/schemas/Scim.User.Core.photo"}}},"components/schemas/Scim.User.Core.phoneNumbers.create":{"id":"components/schemas/Scim.User.Core.phoneNumbers.create","kind":"json-schema","title":"Scim.User.Core.phoneNumbers.create","data":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A list of the user's phone numbers."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If a user has no phone numbers this will be an empty list."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"info-box"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"strong","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Note:"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" The SCIM spec allows an arbitrary number\n    of phone numbers with arbitrary types, but Firstup will only save\n    numbers of types "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\"main\""},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\"mobile\""},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":",\n    and only a single number for each type.\n  "},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    It is not an "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"em","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"error"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" to include other types or additional\n    numbers, but they will be ignored without an error message.\n  "},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/Scim.User.Core.phoneNumber"}}},"components/schemas/Scim.User.Core.phoneNumbers":{"id":"components/schemas/Scim.User.Core.phoneNumbers","kind":"json-schema","title":"Scim.User.Core.phoneNumbers","data":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A list of the user's phone numbers."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If a user has no phone numbers this will be an empty list."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Firstup only saves and returns phone numbers with a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"main"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"mobile"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/Scim.User.Core.phoneNumber"}}},"components/schemas/Scim.User.Core.email":{"id":"components/schemas/Scim.User.Core.email","kind":"json-schema","title":"Scim.User.Core.email","data":{"type":"object","additionalProperties":false,"properties":{"value":{"type":"string","example":"janedoe@email.com","description":"A valid email address"},"primary":{"type":"boolean","example":true,"description":"Indicates if the value is the user's primary email address"},"type":{"example":"work","enum":["work","home","other",null],"description":"An email type. Should be one of \"work\", \"home\", \"other\" or null","nullable":true,"type":"string"}}}},"components/schemas/Scim.User.Core.photo":{"id":"components/schemas/Scim.User.Core.photo","kind":"json-schema","title":"Scim.User.Core.photo","data":{"type":"object","additionalProperties":false,"properties":{"value":{"type":"string","example":"http://some.url/photo.png","description":"Direct link to photo image resource"},"type":{"type":"string","example":"photo","enum":["photo"],"description":"The type of photo; only \"photo\" is supported."}}}},"components/schemas/Scim.User.Core.phoneNumber":{"id":"components/schemas/Scim.User.Core.phoneNumber","kind":"json-schema","title":"Scim.User.Core.phoneNumber","data":{"type":"object","additionalProperties":false,"properties":{"value":{"type":"string","example":"555-1212","description":"A phone number"},"type":{"type":"string","example":"mobile","enum":["main","mobile","work"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of phone number. Only "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"main\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"mobile\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are saved or returned by Firstup. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"admonition","inline":true,"attributes":{"type":"warning"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DO NOT use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"work"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" as the phone number type because it will be ignored. It's listed for third-party compatibility only."},"children":[]}]}]}]}]},"primary":{"type":"boolean","example":true,"description":"This optional attribute is for compatibility purposes only and is ignored by Firstup."}}}},"components/schemas/Scim.User.Core.addresses":{"id":"components/schemas/Scim.User.Core.addresses","kind":"json-schema","title":"Scim.User.Core.addresses","data":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The user's addresses in the program."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A Firstup user has only one address. The user's address will be set to either:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The first address, or... * The first address marked "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"primary"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sending anything other than an array (which may be empty) is an error."},"children":[]}]}]}]}],"items":{"type":"object","additionalProperties":false,"properties":{"streetAddress":{"type":"string","nullable":true,"example":"123 Mission St","description":"A street address, e.g., house number and street name."},"locality":{"type":"string","nullable":true,"example":"San Francisco","description":"Address's locality, e.g, in the US, the city."},"region":{"type":"string","nullable":true,"example":"CA","description":"Address's region, e.g., in the US, the state."},"postalCode":{"type":"string","nullable":true,"example":"94105","description":"Address's postal code, e.g., in the US, the zip code."},"country":{"type":"string","nullable":true,"example":"US","description":"Address's country."},"primary":{"type":"boolean","example":false,"description":"Is address primary"},"formatted":{"type":"string","nullable":true,"example":"123 Mission St, San Francisco, CA, 94105","description":"Complete address as formatted string."},"type":{"type":"string","nullable":true,"example":"work","description":"Address type. This field is ignored by Firstup."}}}}},"components/schemas/Scim.User.Core.photos.incoming":{"id":"components/schemas/Scim.User.Core.photos.incoming","kind":"json-schema","title":"Scim.User.Core.photos.incoming","data":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The user's photo (avatar)."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Firstup users have a single avatar photo."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The single photo must be contained within an array."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sending multiple photos is ok but only the first photo is used."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only the first photo is validated for correctness."},"children":[]}]}]}]}],"items":{"type":"object","properties":{"type":{"type":"string","example":"photo","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of photo."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"photo\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is supported—any other value is an error."},"children":[]}]}]}]},"value":{"type":"string","example":"http://an.image/url","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The URI of the photo (avatar)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URIs may be HTTP, HTTPS, or DATA. DATA URIs must contain a complete data URI including the MIME type, encoding, and data, e.g., "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data:image/jpeg;base64,/9j/4AAQSkZJRgABAQAAAQABAAD..."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All photos are downloaded by Firstup and self-hosted: the resulting photo URL will not be the same as the incoming URI."},"children":[]}]}]}]}}}}},"components/schemas/Scim.User.Core.title":{"id":"components/schemas/Scim.User.Core.title","kind":"json-schema","title":"Scim.User.Core.title","data":{"type":"string","description":"A string containing the user's job title.","example":"Vice President"}},"components/schemas/Scim.User.Core.userType":{"id":"components/schemas/Scim.User.Core.userType","kind":"json-schema","title":"Scim.User.Core.userType","data":{"type":"string","description":"The user's employee type","example":"Associate"}},"components/schemas/Scim.User.Core.locale":{"id":"components/schemas/Scim.User.Core.locale","kind":"json-schema","title":"Scim.User.Core.locale","data":{"type":"string","description":"The user's locale.","example":"en-US"}},"components/schemas/Scim.User.Core.timezone":{"id":"components/schemas/Scim.User.Core.timezone","kind":"json-schema","title":"Scim.User.Core.timezone","data":{"type":"string","description":"The user's geographical timezone (IANA format. Note, this is case sensitive).","example":"America/Chicago"}},"components/schemas/Scim.User.Core.preferredLanguage":{"id":"components/schemas/Scim.User.Core.preferredLanguage","kind":"json-schema","title":"Scim.User.Core.preferredLanguage","data":{"type":"string","description":"A string containing the user's preferred language.","example":"en-US"}},"components/schemas/Scim.User.SocialChorusExtension":{"id":"components/schemas/Scim.User.SocialChorusExtension","kind":"json-schema","title":"Scim.User.SocialChorusExtension","data":{"type":"object","additionalProperties":false,"properties":{"businessUnit":{"type":"string","nullable":true,"description":"The user's business unit.","example":"Accounts Receivable"},"gender":{"type":"string","nullable":true,"description":"The user's gender.","example":"Female"},"pronouns":{"type":"string","nullable":true,"description":"The user's pronouns.","example":"they/them"},"managerName":{"type":"string","nullable":true,"description":"The user's manager's name.","example":"Jimmy Dean"},"workLocation":{"type":"string","nullable":true,"description":"The user's work location.","example":"Kabukicho"},"birthDate":{"type":"string","nullable":true,"format":"date-time","description":"The user's birth date.","example":"2000-01-01T00:00:00.000Z"},"hireDate":{"type":"string","nullable":true,"format":"date-time","description":"The user's start of employment date.","example":"2000-01-01T00:00:00.000Z"},"promotionDate":{"type":"string","nullable":true,"format":"date-time","description":"The user's promotion date.","example":"2000-01-01T00:00:00.000Z"},"requisitionApprovalDate":{"type":"string","nullable":true,"format":"date-time","description":"The Requisition Approval date.","example":"2000-01-01T00:00:00.000Z"},"lastAccessedAt":{"type":"string","nullable":true,"format":"date-time","description":"Please contact your Firstup representative for more information.","example":"2000-01-01T00:00:00.000Z"},"customAttributes":{"type":"array","description":"An array of objects including a name and value. These are stored as an arbitrary additional list of attributes associated to the user and can be used to create Groups and audiences in the Firstup platform. Currently, Custom Attributes can only be string values.\n","example":[{"name":"favorite_food","value":"pizza"},{"name":"favorite_sport","value":"soccer"},{"name":"hair_color","value":"brown"}],"items":{"oneOf":[{"type":"object","properties":{"name":{"type":"string","description":"The name of the attribute"},"value":{"type":"string","nullable":true,"description":"The value of the attribute"}},"required":["name","value"],"additionalProperties":false},{"allOf":[{"not":{"required":["name","value"]}},{"type":"object","additionalProperties":{"type":"string"},"minProperties":1}]}]}}}}},"components/schemas/Scim.User.EnterpriseExtension":{"id":"components/schemas/Scim.User.EnterpriseExtension","kind":"json-schema","title":"Scim.User.EnterpriseExtension","data":{"type":"object","additionalProperties":false,"properties":{"employeeNumber":{"type":"string","nullable":true,"example":"abc123","description":"An employee id or identifier used in external systems."},"organization":{"type":"string","nullable":true,"example":"Firstup","description":"The employee organization name"},"department":{"type":"string","nullable":true,"example":"HR","description":"The employee's department name"},"costCenter":{"type":"string","nullable":true,"description":"The user's cost center","example":"NY"},"division":{"type":"string","nullable":true,"description":"The user's division","example":"THCI"}}}},"components/schemas/Scim.User.UpdateRequestBody":{"id":"components/schemas/Scim.User.UpdateRequestBody","kind":"json-schema","title":"Scim.User.UpdateRequestBody","data":{"type":"object","properties":{"userName":{"$ref":"#/components/schemas/Scim.User.Core.userName"},"active":{"type":"boolean","description":"Whether the user is active or blocked in the program.","example":true},"name":{"$ref":"#/components/schemas/Scim.User.Core.name"},"displayName":{"$ref":"#/components/schemas/Scim.User.Core.displayName"},"nickName":{"$ref":"#/components/schemas/Scim.User.Core.nickName"},"roles":{"$ref":"#/components/schemas/Scim.User.Core.roles"},"emails":{"$ref":"#/components/schemas/Scim.User.Core.emails"},"addresses":{"$ref":"#/components/schemas/Scim.User.Core.addresses"},"title":{"$ref":"#/components/schemas/Scim.User.Core.title"},"photos":{"$ref":"#/components/schemas/Scim.User.Core.photos.incoming"},"preferredLanguage":{"$ref":"#/components/schemas/Scim.User.Core.preferredLanguage"},"userType":{"$ref":"#/components/schemas/Scim.User.Core.userType"},"locale":{"$ref":"#/components/schemas/Scim.User.Core.locale"},"timezone":{"$ref":"#/components/schemas/Scim.User.Core.timezone"},"urn:SocialChorus:1.0:User":{"$ref":"#/components/schemas/Scim.User.SocialChorusExtension"},"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User":{"$ref":"#/components/schemas/Scim.User.EnterpriseExtension"}}}},"components/schemas/Scim.User.CreateRequestBody":{"id":"components/schemas/Scim.User.CreateRequestBody","kind":"json-schema","title":"Scim.User.CreateRequestBody","data":{"type":"object","properties":{"schemas":{"type":"array","items":{"type":"string","enum":["urn:ietf:params:scim:schemas:core:2.0:User","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User","urn:SocialChorus:1.0:User"]},"example":["urn:ietf:params:scim:schemas:core:2.0:User"]},"userName":{"$ref":"#/components/schemas/Scim.User.Core.userName"},"name":{"$ref":"#/components/schemas/Scim.User.Core.name"},"displayName":{"$ref":"#/components/schemas/Scim.User.Core.displayName"},"externalId":{"$ref":"#/components/schemas/Scim.User.Core.externalId"},"nickName":{"$ref":"#/components/schemas/Scim.User.Core.nickName"},"active":{"$ref":"#/components/schemas/Scim.User.Core.active"},"roles":{"$ref":"#/components/schemas/Scim.User.Core.roles"},"phoneNumbers":{"$ref":"#/components/schemas/Scim.User.Core.phoneNumbers.create"},"emails":{"$ref":"#/components/schemas/Scim.User.Core.emails"},"addresses":{"$ref":"#/components/schemas/Scim.User.Core.addresses"},"title":{"$ref":"#/components/schemas/Scim.User.Core.title"},"photos":{"$ref":"#/components/schemas/Scim.User.Core.photos.incoming"},"preferredLanguage":{"$ref":"#/components/schemas/Scim.User.Core.preferredLanguage"},"userType":{"$ref":"#/components/schemas/Scim.User.Core.userType"},"locale":{"$ref":"#/components/schemas/Scim.User.Core.locale"},"timezone":{"$ref":"#/components/schemas/Scim.User.Core.timezone"},"urn:SocialChorus:1.0:User":{"$ref":"#/components/schemas/Scim.User.SocialChorusExtension"},"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User":{"$ref":"#/components/schemas/Scim.User.EnterpriseExtension"}},"required":["userName"]}},"components/schemas/Scim.User.PatchRequestBody":{"id":"components/schemas/Scim.User.PatchRequestBody","kind":"json-schema","title":"Scim.User.PatchRequestBody","data":{"type":"object","properties":{"schemas":{"type":"array","items":{"type":"string"},"example":["urn:ietf:params:scim:api:messages:2.0:PatchOp"]},"Operations":{"type":"array","items":{"type":"object","properties":{"op":{"type":"string","example":"replace"},"path":{"type":"string","example":"active"},"value":{}}},"example":[{"op":"replace","path":"active","value":false},{"op":"replace","path":"emails[type eq \"work\"].value","value":"janedoe@email.com"}]}}}},"components/schemas/Scim.Role.Resource":{"id":"components/schemas/Scim.Role.Resource","kind":"json-schema","title":"Scim.Role.Resource","data":{"type":"object","properties":{"value":{"type":"string","description":"The value of a role (name)\n","example":"group_admin"},"display":{"type":"string","description":"A human-readable name, primarily used for display purposes.","example":"Community Admin"},"type":{"type":"string","description":"A label indicating the role's function.","example":"primary"},"enabled":{"type":"boolean","description":"A boolean type that indicates if the role is enabled and usable in the SCIM service provider's system.","example":true},"contains":{"type":"array","description":"A complex type that shows what other roles this role indirectly grants - values can be considered the child role in a parent/child relationship.","example":["moderate_comments","create_audience","publish_campaign","insights"],"items":{"type":"string","example":"publish_campaign"}}}}},"components/schemas/Webhooks.Subscription.Resource":{"id":"components/schemas/Webhooks.Subscription.Resource","kind":"json-schema","title":"Webhooks.Subscription.Resource","data":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/Webhooks.Subscription.id"},"url":{"$ref":"#/components/schemas/Webhooks.Subscription.url"},"authorization_header":{"$ref":"#/components/schemas/Webhooks.Subscription.authorization_header"},"active":{"$ref":"#/components/schemas/Webhooks.Subscription.active"},"events":{"type":"array","items":{"$ref":"#/components/schemas/Webhooks.Subscription.Event"}},"created_at":{"type":"string","format":"date-time","example":"2000-01-01T00:00:00Z"},"updated_at":{"type":"string","format":"date-time","example":"2000-01-01T00:00:00Z"}}}},"components/schemas/Webhooks.Subscription.Event":{"id":"components/schemas/Webhooks.Subscription.Event","kind":"json-schema","title":"Webhooks.Subscription.Event","data":{"type":"object","properties":{"name":{"description":"The name of the event.","example":"content_published"},"version":{"description":"The version of the event this subscription uses.","example":"1"}}}},"components/schemas/Webhooks.Subscription.Ping":{"id":"components/schemas/Webhooks.Subscription.Ping","kind":"json-schema","title":"Webhooks.Subscription.Ping","data":{"type":"object","properties":{"delivery":{"$ref":"#/components/schemas/Webhooks.Delivery.Resource"},"subscription":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/Webhooks.Subscription.id"},"url":{"$ref":"#/components/schemas/Webhooks.Subscription.url"}}}}}},"components/schemas/Webhooks.Delivery.Resource":{"id":"components/schemas/Webhooks.Delivery.Resource","kind":"json-schema","title":"Webhooks.Delivery.Resource","data":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/Webhooks.Delivery.id"},"status":{"$ref":"#/components/schemas/Webhooks.Delivery.status"}}}},"components/schemas/Webhooks.Subscription.id":{"id":"components/schemas/Webhooks.Subscription.id","kind":"json-schema","title":"Webhooks.Subscription.id","data":{"type":"string","description":"Unique identifier for this subscription.","example":"abc123"}},"components/schemas/Webhooks.Subscription.url":{"id":"components/schemas/Webhooks.Subscription.url","kind":"json-schema","title":"Webhooks.Subscription.url","data":{"type":"string","format":"url","description":"The url that will be called when delivering events for this subscription.","example":"https://example.com/webhook"}},"components/schemas/Webhooks.Subscription.authorization_header":{"id":"components/schemas/Webhooks.Subscription.authorization_header","kind":"json-schema","title":"Webhooks.Subscription.authorization_header","data":{"type":"string","description":"A value will be sent in every delivery as the 'Authorization' header value in the POST request.","example":"Bearer abc123-some-token"}},"components/schemas/Webhooks.Subscription.active":{"id":"components/schemas/Webhooks.Subscription.active","kind":"json-schema","title":"Webhooks.Subscription.active","data":{"type":"boolean","description":"Whether the subscription is \"turned on\". Inactive subscriptions will not send deliveries to the subscription url except for ping deliveries.","example":true}},"components/schemas/Webhooks.Subscription.CreateRequestBody":{"id":"components/schemas/Webhooks.Subscription.CreateRequestBody","kind":"json-schema","title":"Webhooks.Subscription.CreateRequestBody","data":{"type":"object","properties":{"url":{"$ref":"#/components/schemas/Webhooks.Subscription.url"},"authorization_header":{"$ref":"#/components/schemas/Webhooks.Subscription.authorization_header"},"active":{"$ref":"#/components/schemas/Webhooks.Subscription.active"},"events":{"type":"array","items":{"$ref":"#/components/schemas/Webhooks.Subscription.Event"}}}}},"components/schemas/Webhooks.Subscription.UpdateRequestBody":{"id":"components/schemas/Webhooks.Subscription.UpdateRequestBody","kind":"json-schema","title":"Webhooks.Subscription.UpdateRequestBody","data":{"type":"object","properties":{"url":{"$ref":"#/components/schemas/Webhooks.Subscription.url"},"authorization_header":{"$ref":"#/components/schemas/Webhooks.Subscription.authorization_header"},"active":{"$ref":"#/components/schemas/Webhooks.Subscription.active"},"events":{"type":"array","items":{"$ref":"#/components/schemas/Webhooks.Subscription.Event"}}}}},"components/schemas/Webhooks.Delivery.id":{"id":"components/schemas/Webhooks.Delivery.id","kind":"json-schema","title":"Webhooks.Delivery.id","data":{"type":"string","description":"The unique id of the delivery. This value is also provided in the 'X-SocialChorus-Delivery' header of the request made to the subscription's url.\n","example":"abc123-456"}},"components/schemas/Webhooks.Delivery.status":{"id":"components/schemas/Webhooks.Delivery.status","kind":"json-schema","title":"Webhooks.Delivery.status","data":{"type":"string","enum":["pending","success","failure","retryable"],"description":"A value indicating the status of the delivery and the response we received back when sending the delivery to the subscription's url.\n","example":"success"}},"components/schemas/Assistant.Inbox.Items.Resource":{"id":"components/schemas/Assistant.Inbox.Items.Resource","kind":"json-schema","title":"Assistant.Inbox.Items.Resource","data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","example":1},"categories":{"type":"string","example":"categories"},"resource_type":{"type":"string","example":"resource_type"},"resource_url":{"type":"string","example":"resource_url"},"text":{"type":"string","example":"text"},"image_icon":{"type":"object","properties":{"url":{"type":"string","example":"url"}}},"attribution":{"type":"string","example":"text"}}}}},"components/schemas/Assistant.Inbox.Todos.Resource":{"id":"components/schemas/Assistant.Inbox.Todos.Resource","kind":"json-schema","title":"Assistant.Inbox.Todos.Resource","data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","example":1},"category":{"type":"string","example":"category"},"label":{"type":"string","example":"label"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"resource":{"type":"object","properties":{"id":{"type":"integer","example":1},"url":{"type":"string","example":"url"}}},"actions":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"name"},"label":{"type":"string","example":"label"},"method":{"type":"string","example":"method"},"url":{"type":"string","example":"url"}}}}}}}},"components/schemas/Assistant.Inbox.Notifications.Resource":{"id":"components/schemas/Assistant.Inbox.Notifications.Resource","kind":"json-schema","title":"Assistant.Inbox.Notifications.Resource","data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","example":1},"category":{"type":"string","example":"category_type"},"acknowledged":{"type":"boolean","example":false},"text":{"type":"string","example":"text"},"label":{"type":"string","example":"Label name"},"details":{"type":"object","properties":{"url":{"type":"string","example":"url"}}},"created_at":{"type":"string","example":"2022-07-06T07:15:46.121Z"},"updated_at":{"type":"string","example":"2022-07-06T07:15:46.121Z"}}}}},"components/schemas/Standard.Meta.CursorPagination":{"id":"components/schemas/Standard.Meta.CursorPagination","kind":"json-schema","title":"Standard.Meta.CursorPagination","data":{"type":"object","properties":{"cursor":{"description":"The cursor value used for the set of records returned.","example":"current-cursor-value"},"next":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The cursor value that can be used for the "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"next"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" set of records in the next request using the same filters."},"children":[]}]}]}],"example":"nex-cursor-value"},"page_size":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The max number of records requested with pagination applied. Is not necessarily an exact count of the current records returned. Defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"10"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":10}}}},"components/schemas/Standard.Meta.PagePagination":{"id":"components/schemas/Standard.Meta.PagePagination","kind":"json-schema","title":"Standard.Meta.PagePagination","data":{"type":"object","properties":{"page":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The page returned. Defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":1},"page_size":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The max number of records requested with pagination applied. Is not necessarily an exact count of the current records returned. Defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"10"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":10},"total_records":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A count of all records if the request were not paginated. If filters are applied, total_records only counts records matching the filters."},"children":[]}]}]}],"example":20}}}},"components/schemas/Standard.Feed.Meta.PagePagination":{"id":"components/schemas/Standard.Feed.Meta.PagePagination","kind":"json-schema","title":"Standard.Feed.Meta.PagePagination","data":{"type":"object","properties":{"page":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The page returned. Defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":1},"page_size":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The max number of records requested with pagination applied. Is not necessarily an exact count of the current records returned. Defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"10"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":10}}}},"schema_100":{"kind":"json-schema","data":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/Content.Channel.Resource"}}},"id":"schema_100"},"schema_101":{"kind":"json-schema","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error. See more on error responses "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://developers.firstup.io/gettingstarted/error_responses"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"content":{"*/*":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"status":{"type":"integer","format":"int32"},"title":{"type":"string"},"detail":{"type":"string"}}}}}}}}},"id":"schema_101"},"schema_102":{"kind":"json-schema","data":{"type":"array","items":{"type":"string","default":"any","enum":["archived","hidden","published","any"]}},"id":"schema_102"},"schema_103":{"kind":"json-schema","data":{"type":"integer","format":"int64"},"id":"schema_103"},"schema_104":{"kind":"json-schema","data":{"type":"object","required":["data"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Content.Channel.Resource"}},"meta":{"properties":{"filters":{"description":"A list of the filters applied in the current request.","example":{"state":"published"}},"pagination":{"$ref":"#/components/schemas/Standard.Meta.PagePagination"}}}}},"id":"schema_104"},"schema_105":{"kind":"json-schema","data":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","title","detail"],"properties":{"code":{"type":"integer","description":"The HTTP status code of the received error.","example":400},"title":{"type":"string","description":"A short, human-readable title describing the error.","example":"Bad Request"},"detail":{"type":"string","description":"A detailed explanation of what caused the error.","example":"One or more request validations have failed."},"validations":{"type":"array","description":"A list of validation errors that caused the request to fail.","items":{"type":"object","properties":{"rule":{"type":"string","description":"The validation rule that was violated.","example":"invalid_enum"},"parameter":{"type":"string","description":"The name of the request parameter that failed validation.","example":"name"},"message":{"type":"string","description":"A human-readable message describing the validation failure.","example":"state must be one of archived, hidden, published, any"}}}}}}}},"id":"schema_105"},"schema_106":{"kind":"json-schema","data":{"type":"integer"},"id":"schema_106"},"schema_107":{"kind":"json-schema","data":{"type":"object","required":["data"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Content.ChannelFollower.Resource"}},"meta":{"properties":{"pagination":{"$ref":"#/components/schemas/Standard.Meta.PagePagination"}}}}},"id":"schema_107"},"schema_108":{"kind":"json-schema","data":{"type":"object","required":["data"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Content.ChannelPage.Resource"}}}},"id":"schema_108"},"schema_109":{"kind":"json-schema","data":{"type":"array","items":{"type":"string","default":"any","enum":["article","link","video","image","note","any"]}},"id":"schema_109"},"schema_110":{"kind":"json-schema","data":{"type":"array","items":{"type":"string","default":"any","enum":["draft","published","review","archived","scheduled","processing","processing_error","any"]}},"id":"schema_110"},"schema_111":{"kind":"json-schema","data":{"type":"string","enum":["true","false","any"],"default":"any"},"id":"schema_111"},"schema_112":{"kind":"json-schema","data":{"type":"array","items":{"type":"integer"}},"id":"schema_112"},"schema_113":{"kind":"json-schema","data":{"type":"string","enum":["public","private","any"],"default":"any"},"id":"schema_113"},"schema_114":{"kind":"json-schema","data":{"type":"string","enum":["submitted","pinterest","rss","facebook","twitter","instagram","socialchorus_cpcm","studio","oauth_client","any"],"default":"any"},"id":"schema_114"},"schema_115":{"kind":"json-schema","data":{"type":"string"},"id":"schema_115"},"schema_116":{"kind":"json-schema","data":{"type":"string","format":"date-time"},"id":"schema_116"},"schema_117":{"kind":"json-schema","data":{"type":"object","required":["data"],"properties":{"data":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/Content.Post.Resource"},{"$ref":"#/components/schemas/Reactions.Fields"}]}},"meta":{"properties":{"filters":{"description":"A list of the filters applied in the current request.","example":{"content_type":"article","featured":true}},"pagination":{"$ref":"#/components/schemas/Standard.Meta.PagePagination"}}}}},"id":"schema_117"},"schema_118":{"kind":"json-schema","data":{"type":"object","properties":{"content_type":{"default":"article","description":"The type of content to create","type":"string","enum":["article","link","video","image"],"example":"article"},"title":{"description":"A title for the post","example":"Example Post Title"},"body":{"description":"The body text for the post. HTML is permitted.","example":"Example post body"},"summary":{"description":"Post summary blurb","example":"Example post summary"},"author":{"$ref":"#/components/schemas/Content.Post.Resource.author"},"featured":{"type":"boolean","description":"Whether the post is featured.","example":true},"featured_label":{"type":"string","description":"The featured label.","example":"A Label"},"visibility":{"type":"string","default":"private","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An indication of the native availability of the post within the Firstup platform. If 'public', the post has a public_link_url and shares of the post should use that url as the canonical url. If 'private', the post requires user authentication to view."},"children":[]}]}]}],"enum":["private","public"],"example":"private"},"targeted":{"type":"boolean","description":"Works with groups: true limits visibility to listed audiences; false uses audiences for delivery only.","example":true},"groups":{"type":"array","description":"A non-empty list of audiences this post targets. Required to enable targeting; if empty or omitted, targeting will not be applied.","items":{"type":"string"},"example":["group1","group2"]},"channels":{"type":"array","description":"A list of topics the content will be published to.\n","items":{"type":"object","required":["id"],"properties":{"id":{"type":"integer","example":789},"hidden":{"type":"boolean","example":false,"default":false}}}},"source":{"type":"object","properties":{"post_id":{"type":"string","description":"The unique identifier of the post on the source system, if it is republished from another platform or application."},"posted_at":{"type":"string","description":"The timestamp at which the post was published on the source system, if it is republished from another platform or application."}}},"images":{"$ref":"#/components/schemas/Content.Creation.Images"},"template":{"properties":{"id":{"type":"integer"}}},"link_url":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The url if the content_type is link"},"children":[]}]}]}]}}},"id":"schema_118"},"schema_119":{"kind":"json-schema","data":{"type":"object","required":["data"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Content.Post.Resource"}}}},"id":"schema_119"},"schema_120":{"kind":"json-schema","data":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"integer","format":"int32","example":401},"title":{"type":"string","example":"Unauthenticated"},"detail":{"type":"string","example":"Access token was not provided or not recognized."}}}}}},"id":"schema_120"},"schema_121":{"kind":"json-schema","data":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"integer","format":"int32","example":403},"title":{"type":"string","example":"Unauthorized"},"detail":{"type":"string"}}}}}},"id":"schema_121"},"schema_122":{"kind":"json-schema","data":{"type":"boolean"},"id":"schema_122"},"schema_123":{"kind":"json-schema","data":{"type":"object","required":["data"],"properties":{"data":{"allOf":[{"$ref":"#/components/schemas/Content.Post.Resource"},{"$ref":"#/components/schemas/Reactions.Fields"}]}}},"id":"schema_123"},"schema_124":{"kind":"json-schema","data":{"type":"object","properties":{"title":{"description":"A title for the post","example":"Example Post Title"},"body":{"description":"The body text for the post. HTML is permitted.","example":"Example post body"},"summary":{"description":"Post summary blurb","example":"Example post summary"},"author":{"$ref":"#/components/schemas/Content.Post.Resource.author"},"featured":{"type":"boolean","description":"Whether the post is featured.","example":true},"featured_label":{"type":"string","description":"The featured label.","example":"A Label"},"visibility":{"type":"string","default":"private","enum":["private","public"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An indication of the native availability of the post within the Firstup platform. If 'public', the post has a public_link_url and shares of the post should use that url as the canonical url. If 'private', the post requires user authentication to view."},"children":[]}]}]}]},"targeted":{"type":"boolean","description":"Works with groups: true limits visibility to listed audiences; false uses audiences for delivery only.","example":true},"groups":{"type":"array","description":"A non-empty list of audiences this post targets. Required to enable targeting; if empty or omitted, targeting will not be applied.","items":{"type":"string"},"example":["group1","group2"]},"source":{"type":"object","properties":{"post_id":{"type":"string","description":"The unique identifier of the post on the source system, if it is republished from another platform or application.\n","example":"abc123"},"posted_at":{"type":"string","description":"The timestamp at which the post was published on the source system, if it is republished from another platform or application.\n","example":"2000-01-01T00:00:00Z"}}},"template":{"properties":{"id":{"type":"integer","example":234}}},"images":{"$ref":"#/components/schemas/Content.Creation.Images"},"link_url":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The url if the content_type is link"},"children":[]}]}]}],"example":"https://google.com"}}},"id":"schema_124"},"schema_125":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Content.Post.Resource"}}}},"id":"schema_125"},"schema_126":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Content.Post.Resource"}}},"id":"schema_126"},"schema_127":{"kind":"json-schema","data":{"type":"object","required":["data"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Content.Comment.Resource"}}}},"id":"schema_127"},"schema_128":{"kind":"json-schema","data":{"oneOf":[{"type":"integer"},{"type":"string","format":"uuid"}]},"id":"schema_128"},"schema_129":{"kind":"json-schema","data":{"type":"object","properties":{"image_url":{"description":"URL of the image to add.","type":"string"}}},"id":"schema_129"},"schema_130":{"kind":"json-schema","data":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/Content.Image.Resource"}}},"id":"schema_130"},"schema_131":{"kind":"json-schema","data":{"type":"object","properties":{"video_url":{"description":"URL of the video to add.","type":"string","example":"https://some.video.url"},"caption":{"description":"Video caption","type":"string","example":"Watch out!"},"preview_image_url":{"description":"Video preview image URL","type":"string","example":"https://preview_image.video.url"}},"required":["video_url"]},"id":"schema_131"},"schema_132":{"kind":"json-schema","data":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/Content.Video.Resource"}}},"id":"schema_132"},"schema_133":{"kind":"json-schema","data":{"type":"string","enum":["firstup","slack","sharepoint"]},"id":"schema_133"},"schema_134":{"kind":"json-schema","data":{"type":"object","required":["data"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"sourceContentId":{"type":"string"},"sourcePlatform":{"type":"string"},"targetContentId":{"type":"string"},"targetPlatform":{"type":"string"},"replicatedAt":{"type":"string"},"targetLocationId":{"type":"string"},"workflowId":{"type":"integer"}}}}},"example":{"data":[{"sourceContentId":"3","sourcePlatform":"firstup","targetContentId":"1","targetPlatform":"firstup","replicatedAt":"2000-01-01T00:00:00Z","targetLocationId":"10","workflowId":2},{"sourceContentId":"4","sourcePlatform":"firstup","targetContentId":"723","targetPlatform":"slack","publicationDate":"2020-01-01T00:00:00Z","targetLocationId":"47","workflowId":7}]}},"id":"schema_134"},"schema_135":{"kind":"json-schema","data":{"type":"integer","format":"int32"},"id":"schema_135"},"schema_136":{"kind":"json-schema","data":{"type":"object","required":["data"],"properties":{"data":{"type":"object","properties":{"video_id":{"type":"integer","description":"ID of the video","example":628},"download_url":{"type":"string","example":"https://cdn.example.com/acme/acmetimes/video/cab13"},"width":{"type":"integer","description":"Width of the video preview image in pixels","example":720},"height":{"type":"integer","description":"Height of the video preview image in pixels","example":480}}}}},"id":"schema_136"},"schema_137":{"kind":"json-schema","data":{"type":"object","required":["data"],"properties":{"data":{"type":"object","properties":{"content_id":{"type":"integer","example":1},"unique_user_count":{"type":"object","properties":{"total":{"type":"integer","description":"Total unique user count","example":700},"topic":{"type":"integer","description":"Unique user count from topic settings","example":300},"audience":{"type":"integer","description":"Unique user count from audience settings","example":500}}}}}}},"id":"schema_137"},"schema_138":{"kind":"json-schema","data":{"type":"string","enum":["myfeed","following","resources","trending","icymi","featured","bookmarked","community_images","for_you"],"default":"myfeed"},"id":"schema_138"},"schema_139":{"kind":"json-schema","data":{"type":"array","items":{"type":"string","enum":["liked","bookmarked","read","unread"]}},"id":"schema_139"},"schema_140":{"kind":"json-schema","data":{"type":"array","items":{"type":"string","enum":["article","link","note","image","video"]}},"id":"schema_140"},"schema_141":{"kind":"json-schema","data":{"type":"object","required":["data"],"properties":{"data":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/Feeds.Post.Resource"},{"$ref":"#/components/schemas/Reactions.Fields"}]}},"meta":{"properties":{"filters":{"description":"A list of the filters applied in the current request.","example":{"content_type":"article","visibility":"public"}},"feed_name":{"description":"The name of the current feed, if named.","example":"myfeed"},"pagination":{"$ref":"#/components/schemas/Standard.Feed.Meta.PagePagination"}}}}},"id":"schema_141"},"schema_142":{"kind":"json-schema","data":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","title","detail"],"properties":{"code":{"type":"integer","description":"The HTTP status code of the received error.","example":400},"title":{"type":"string","description":"A short, human-readable title describing the error.","example":"Bad Request"},"detail":{"type":"string","description":"A detailed explanation of what caused the error.","example":"One or more request validations have failed."},"validations":{"type":"array","description":"A list of validation errors that caused the request to fail.","items":{"type":"object","properties":{"rule":{"type":"string","description":"The validation rule that was violated.","example":"invalid_enum"},"parameter":{"type":"string","description":"The name of the request parameter that failed validation.","example":"state"},"message":{"type":"string","description":"A human-readable message describing the validation failure.","example":"name must be one of: myfeed, following, resources"}}}}}}}},"id":"schema_142"},"schema_143":{"kind":"json-schema","data":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/Feeds.WebHomepage.Resource"}}},"id":"schema_143"},"schema_144":{"kind":"json-schema","data":{"type":"integer","minimum":1},"id":"schema_144"},"schema_145":{"kind":"json-schema","data":{"type":"object","required":["data"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Feeds.Post.Resource"}},"meta":{"properties":{"pagination":{"$ref":"#/components/schemas/Standard.Feed.Meta.PagePagination"}}}}},"id":"schema_145"},"schema_146":{"kind":"json-schema","data":{"type":"object","required":["data"],"properties":{"data":{"type":"array","items":{"type":"object"}}}},"id":"schema_146"},"schema_147":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"allOf":[{"$ref":"#/components/schemas/Feeds.Post.Resource"},{"$ref":"#/components/schemas/Reactions.Fields"}]}}},"id":"schema_147"},"schema_148":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Feeds.PostEngagement.Resource"}}},"id":"schema_148"},"schema_149":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"object","properties":{"trackable_url":{"type":"string","description":"The shortened trackable URL for the post","example":"https://bit.ly/abcdefg"},"uniquified_original_url":{"type":"string","description":"The non-shortened trackable URL for the post","example":"https://onfirstup.com/acme/acmetimes/articles/myarticle?bypass_deeplink=true"}}}}},"id":"schema_149"},"schema_150":{"kind":"json-schema","data":{"type":"object","required":["platform","content_channel_id","share_url"],"properties":{"platform":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The platform the post was shared to. Supported platforms are "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"facebook"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"twitter"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"linked_in"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"copy"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"copy"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is used for when the post was copied to the clipboard. Platforms not listed here will be accepted and treated as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"other"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"facebook","type":"string"},"content_channel_id":{"description":"The ID of the content channel where the post is viewed.","example":42,"type":"integer"},"share_url":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The URL that has been shared.It  can be retrieved using GET "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/v2/feed/posts/{content_id}/share/trackable_url"},"children":[]}]}]}],"example":"https://bit.ly/abcdefg","type":"string"}}},"id":"schema_150"},"schema_151":{"kind":"json-schema","data":{"type":"object","required":["data"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Feed.Comment.Resource"}},"meta":{"properties":{"filters":{"description":"A list of the filters applied in the current request."},"pagination":{"$ref":"#/components/schemas/Standard.Meta.PagePagination"}}}}},"id":"schema_151"},"schema_152":{"kind":"json-schema","data":{"type":"object","required":["body"],"properties":{"body":{"description":"Comment body","example":"This is a comment or reply to a comment.","type":"string"},"attachments":{"type":"array","description":"An array of images to be associated with this comment. Note: currently only one image is supported.\nNote: This API does not resize or rehost images. The image should be appropriately sized and will be served from the provided URL.\n","items":{"type":"object","required":["url"],"properties":{"url":{"type":"string"},"alt_text":{"type":"string"}}}}}},"id":"schema_152"},"schema_153":{"kind":"json-schema","data":{"type":"object","required":["data"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Feed.Comment.Resource"}}}},"id":"schema_153"},"schema_154":{"kind":"json-schema","data":{"type":"object","required":["body"],"properties":{"body":{"description":"Comment body","example":"This a reply to a comment.","type":"string"},"attachments":{"type":"array","description":"An array of images to be associated with this comment. Note: currently only one image is supported.\nNote: This API does not resize or rehost images. The image should be appropriately sized and will be served from the provided URL.\n","items":{"type":"object","properties":{"url":{"type":"string"},"alt_text":{"type":"string"}}}}}},"id":"schema_154"},"schema_155":{"kind":"json-schema","data":{"type":"array","items":{"type":"object","properties":{"user_id":{"type":"integer","description":"ID of the user","example":628},"name":{"type":"string","example":"Johnathan Smith"},"displayName":{"type":"string","example":"John Smith"},"avatarUrl":{"type":"string","description":"The url for the user's avatar"},"avatarColor":{"type":"string","description":"The hex code for presenting the user","example":"#ec407a"}}}},"id":"schema_155"},"schema_156":{"kind":"json-schema","data":{"type":"object","required":["body"],"properties":{"body":{"description":"Comment body","example":"This is an updated comment.","type":"string"},"attachments":{"type":"array","description":"An array of images to be associated with this comment. Note: currently only one image is supported.\nNote: This API does not resize or rehost images. The image should be appropriately sized and will be served from the provided URL.\n","items":{"type":"object","properties":{"url":{"type":"string"},"alt_text":{"type":"string"}}}}}},"id":"schema_156"},"schema_157":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Feed.Comment.Resource"}}}},"id":"schema_157"},"schema_158":{"kind":"json-schema","data":{"type":"string","enum":["android","email","ios","microapp","public_content","web"]},"id":"schema_158"},"schema_159":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Feeds.RenderedPost.Resource"}}},"id":"schema_159"},"schema_160":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Feeds.Poll.Resource"}}},"id":"schema_160"},"schema_161":{"kind":"json-schema","data":{"type":"array","items":{"type":"string"}},"id":"schema_161"},"schema_162":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Feeds.Poll.Resource"}}}},"id":"schema_162"},"schema_163":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Feeds.Video.Resource"}}},"id":"schema_163"},"schema_164":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Feeds.Attachment.Resource"}}},"id":"schema_164"},"schema_165":{"kind":"json-schema","data":{"type":"object","properties":{"Location":{"type":"string"}}},"id":"schema_165"},"schema_166":{"kind":"json-schema","data":{"type":"object","properties":{"schemas":{"type":"array","items":{"type":"string"},"example":["urn:ietf:params:scim:api:messages:2.0:ListResponse"]},"totalResults":{"type":"integer","example":5},"itemsPerPage":{"type":"integer","example":10},"startIndex":{"type":"integer","example":1},"Resources":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"urn:ietf:params:scim:schemas:core:2.0:User"},"name":{"type":"string","example":"SCIMCoreUser"},"description":{"type":"string","example":"SCIM Core User"},"meta":{"type":"object","properties":{"resourceType":{"type":"string","example":"Schema"},"location":{"type":"string","example":"https://partner.socialchorus.com/scim/v2/Schemas/urn:ietf:params:scim:schemas:core:2.0:User"}}},"attributes":{"type":"array","items":{"type":"object"}}}},"example":[{"id":"urn:ietf:params:scim:schemas:core:2.0:User","name":"SCIMCoreUser","description":"SCIM Core User","attributes":[{}]},{"id":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User","name":"EnterpriseUser","description":"Enterprise User","attributes":[{}]},{"id":"urn:SocialChorus:1.0:User","name":"SocialChorusUserExtension","description":"Social Chorus User Extension","attributes":[{}]}]}}},"id":"schema_166"},"schema_167":{"kind":"json-schema","data":{"type":"object","properties":{"schemas":{"type":"array","items":{"type":"string"},"example":["urn:ietf:params:scim:api:messages:2.0:Error"]},"detail":{"type":"string","example":"Authentication failure"},"status":{"type":"integer","example":401}}},"id":"schema_167"},"schema_168":{"kind":"json-schema","data":{"type":"object","properties":{"schemas":{"type":"array","items":{"type":"string"},"example":["urn:ietf:params:scim:api:messages:2.0:Error"]},"detail":{"type":"string","example":"Operation is not permitted"},"status":{"type":"integer","example":403}}},"id":"schema_168"},"schema_169":{"kind":"json-schema","data":{"type":"object","example":{"id":"urn:SocialChorus:1.0:User","name":"SocialChorusUserExtension","description":"Social Chorus User Extension","attributes":[{"caseExact":false,"description":"The user's business unit.","multiValued":false,"mutability":"readWrite","name":"businessUnit","required":false,"returned":"default","type":"string","uniqueness":"none"},{"caseExact":false,"description":"The user's gender.","multiValued":false,"mutability":"readWrite","name":"gender","required":false,"returned":"default","type":"string","uniqueness":"none"},{"caseExact":false,"description":"The user's manager's name.","multiValued":false,"mutability":"readWrite","name":"managerName","required":false,"returned":"default","type":"string","uniqueness":"none"},{"caseExact":false,"description":"The user's work location.","multiValued":false,"mutability":"readWrite","name":"workLocation","required":false,"returned":"default","type":"string","uniqueness":"none"},{"caseExact":false,"description":"The user's birth date.","multiValued":false,"mutability":"readWrite","name":"birthDate","required":false,"returned":"default","type":"string","uniqueness":"none"},{"caseExact":false,"description":"The user's start of employment date.","multiValued":false,"mutability":"readWrite","name":"hireDate","required":false,"returned":"default","type":"string","uniqueness":"none"},{"caseExact":false,"description":"The user's promotion date.","multiValued":false,"mutability":"readWrite","name":"promotionDate","required":false,"returned":"default","type":"string","uniqueness":"none"},{"caseExact":false,"description":"The requisition approval date.","multiValued":false,"mutability":"readWrite","name":"requisitionApprovalDate","required":false,"returned":"default","type":"string","uniqueness":"none"},{"caseExact":false,"description":"An array of objects including a name and value. These are stored as an arbitrary additional list of attributes associated to the user and can be used to create Groups and audiences in the Firstup platform. Currently, Custom Attributes can only be string values.","multiValued":true,"mutability":"readWrite","name":"customAttributes","required":false,"returned":"default","type":"complex","uniqueness":"none","subAttributes":["Array"]}]}},"id":"schema_169"},"schema_170":{"kind":"json-schema","data":{"type":"object","properties":{"schemas":{"type":"array","items":{"type":"string"},"example":["urn:ietf:params:scim:api:messages:2.0:Error"]},"detail":{"type":"string","example":"The requested resource was not found."},"status":{"type":"integer","example":404}}},"id":"schema_170"},"schema_171":{"kind":"json-schema","data":{"type":"object","example":{"schemas":["urn:ietf:params:scim:schemas:core:2.0:ServiceProviderConfig"],"documentationUri":"https://partner.socialchorus.com/endpoints","patch":{"supported":true},"bulk":{"supported":false},"filter":{"supported":true},"changePassword":{"supported":false},"sort":{"supported":true},"etag":{"supported":false},"authenticationSchemas":[{"name":"OAuth Bearer Token","description":"Authentication scheme using the OAuth Bearer Token Standard","specUri":"https://www.rfc-editor.org/info/rfc6750","documentationUri":"https://partner.socialchorus.com/authorization","type":"oauthbearertoken","primary":true}],"meta":{"location":"undefined/scim/v2/ServiceProviderConfig","resourceType":"ServiceProviderConfig","created":"2020-10-19T00:00:00Z","lastModified":"2020-10-19T00:00:00Z","version":"v1.22.1"}}},"id":"schema_171"},"schema_172":{"kind":"json-schema","data":{"type":"object","example":{"totalResults":1,"itemsPerPage":1,"startIndex":1,"schemas":["urn:ietf:params:scim:api:messages:2.0:ListResponse"],"Resources":[{"schemas":["Array"],"id":"User","name":"User","endpoint":"/scim/v2/Users","description":"User Account","schema":"urn:ietf:params:scim:schemas:core:2.0:User","schemaExtensions":["Array"],"meta":["Object"]}]}},"id":"schema_172"},"schema_173":{"kind":"json-schema","data":{"type":"object","example":{"schemas":["urn:ietf:params:scim:schemas:core:2.0:ResourceType"],"id":"User","name":"User","endpoint":"/scim/v2/Users","description":"User Account","schema":"urn:ietf:params:scim:schemas:core:2.0:User","schemaExtensions":[{"schema":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User","required":true},{"schema":"urn:SocialChorus:1.0:User","required":true}],"meta":{"location":"undefined/v2/ResourceTypes/User","resourceType":"ResourceType"}}},"id":"schema_173"},"schema_174":{"kind":"json-schema","data":{"type":"object","properties":{"schemas":{"type":"array","items":{"type":"string"},"example":["urn:ietf:params:scim:api:messages:2.0:ListResponse"]},"totalResults":{"type":"integer","example":5},"itemsPerPage":{"type":"integer","example":10},"startIndex":{"type":"integer","example":1},"Resources":{"type":"array","items":{"$ref":"#/components/schemas/Scim.User.Resource"}}}},"id":"schema_174"},"schema_175":{"kind":"json-schema","data":{"type":"object","properties":{"schemas":{"type":"array","items":{"type":"string"},"example":["urn:ietf:params:scim:api:messages:2.0:Error"]},"detail":{"type":"string","example":"Reason for bad request"},"status":{"type":"integer","example":400}}},"id":"schema_175"},"schema_176":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/Scim.User.Resource"},{"type":"object","properties":{"schemas":{"type":"array","items":{"type":"string","example":"urn:ietf:params:scim:schemas:core:2.0:User"}}}}]},"id":"schema_176"},"schema_177":{"kind":"json-schema","data":{"type":"object","properties":{"schemas":{"type":"array","items":{"type":"string"},"example":["urn:ietf:params:scim:api:messages:2.0:Error"]},"detail":{"type":"array","items":{"type":"object","properties":{"instancePath":{"type":"string"},"schemaPath":{"type":"string"},"keyword":{"type":"string"},"params":{"type":"object"},"message":{"type":"string"}}}},"status":{"type":"integer","example":422}}},"id":"schema_177"},"schema_178":{"kind":"json-schema","data":{"type":"object","properties":{"schemas":{"type":"array","items":{"type":"string"},"example":["urn:ietf:params:scim:api:messages:2.0:ListResponse"]},"Resources":{"type":"array","items":{"$ref":"#/components/schemas/Scim.Group.Resource"}}}},"id":"schema_178"},"schema_179":{"kind":"json-schema","data":{"$ref":"#/components/schemas/Scim.Group.BaseRequestBody"},"id":"schema_179"},"schema_180":{"kind":"json-schema","data":{"allOf":[{"type":"object","properties":{"schemas":{"type":"array","description":"List of Schemas","example":["urn:ietf:params:scim:schemas:core:2.0:Group","SocialChorus:1.0:Group"],"items":{"type":"string"}}}},{"$ref":"#/components/schemas/Scim.Group.AsyncResource"}]},"id":"schema_180"},"schema_181":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/Scim.Group.Resource"},{"type":"object","properties":{"schemas":{"type":"array","items":{"type":"string","example":"urn:ietf:params:scim:schemas:core:2.0:Group"}}}}]},"id":"schema_181"},"schema_182":{"kind":"json-schema","data":{"type":"object","properties":{"id":{"type":"integer","description":"Job unique identifier","example":127},"groupId":{"type":"integer","description":"Group unique identifier","example":3242},"status":{"type":"string","description":"Whether the asynchronous job is still ongoing or it has finished","example":"finished"},"requestType":{"type":"string","description":"The type of request that launched the asynchronous job","example":"group_update"},"requestedChanges":{"type":"string","description":"JSON string wih details of the number of members to be changed by the API request","example":"{\"create\":4,\"destroy\":7}"},"requestReceivedAt":{"type":"string","description":"Date and time when the asynchronous job was launched","example":"2024-04-11T12:59:28.043Z"},"membersCreatedCount":{"type":"integer","description":"Number of members added to the group","example":0},"membersRemovedCount":{"type":"integer","description":"Number of members removed from the group","example":1},"membersProcessedCount":{"type":"integer","description":"Number of members processed. It could include additions, removals, or users ignored (for example, for being already in the group, or not being members of the program)\n","example":11},"membersPendingCount":{"type":"integer","description":"Number of members pending to the processed","example":0},"messages":{"type":"string","description":"Additional details compiled during the job's execution, if any relevant applies, specially those related to the total number of members processed. For example: number of users not considered, for already being members, or users asked to be both added and removed, or system errors...\n","example":"4 user(s) not added (already members?); 6 user(s) not removed (not members?)"}}},"id":"schema_182"},"schema_183":{"kind":"json-schema","data":{"type":"object","required":["data"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Webhooks.Subscription.Resource"}},"meta":{"properties":{"pagination":{"$ref":"#/components/schemas/Standard.Meta.CursorPagination"}}}}},"id":"schema_183"},"schema_184":{"kind":"json-schema","data":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/Webhooks.Subscription.Resource"}}},"id":"schema_184"},"schema_185":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Webhooks.Subscription.Ping"}}},"id":"schema_185"},"schema_186":{"kind":"json-schema","data":{"type":"array","items":{"type":"string","enum":["todo","push","mention","author","message_for_you","contributor","service","social_engagement","followed_channels","recommended_content","bookmarks"]}},"id":"schema_186"},"schema_187":{"kind":"json-schema","data":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/Assistant.Inbox.Items.Resource"}}},"id":"schema_187"},"schema_188":{"kind":"json-schema","data":{"type":"array","items":{"type":"string","enum":["content_acknowledgement","content_approval","poll"]}},"id":"schema_188"},"schema_189":{"kind":"json-schema","data":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/Assistant.Inbox.Todos.Resource"}}},"id":"schema_189"},"schema_190":{"kind":"json-schema","data":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/Assistant.Inbox.Notifications.Resource"}}},"id":"schema_190"},"schema_191":{"kind":"json-schema","data":{"type":"object","required":["data"],"properties":{"data":{"type":"object","properties":{"count":{"type":"integer","example":1}}}}},"id":"schema_191"},"schema_192":{"kind":"json-schema","data":{"type":"object","properties":{"schemas":{"type":"array","items":{"type":"string"},"example":["urn:ietf:params:scim:api:messages:2.0:ListResponse"]},"Resources":{"type":"array","items":{"$ref":"#/components/schemas/Scim.Role.Resource"}}}},"id":"schema_192"},"schema_193":{"kind":"json-schema","data":{"type":"string","enum":["users","campaigns","activities"]},"id":"schema_193"},"schema_194":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"object","properties":{"presigned_url":{"type":"string","description":"A temporary presigned URL to download the file."},"presigned_url_ttl_seconds":{"type":"integer","description":"The number of seconds until the presigned URL expires.","example":900},"file_name":{"type":"string","description":"The name of the file.","example":"part-00000-abc123.csv.gz"},"size_bytes":{"type":"integer","nullable":true,"description":"File size in bytes."},"checksum_function":{"type":"string","nullable":true,"description":"The checksum algorithm used (e.g. SHA256, CRC32, CRC64NVME)."},"checksum":{"type":"string","nullable":true,"description":"The checksum value."},"generated_at":{"type":"string","nullable":true,"description":"Timestamp of when the export was generated (YYYY-MM-DD-HH).","example":"2025-01-15-06"}}}}},"id":"schema_194"},"schema_195":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"object","properties":{"files":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Opaque file identifier (base64url-encoded)."},"file_name":{"type":"string","description":"The name of the file.","example":"part-00000-abc123.csv.gz"},"generated_at":{"type":"string","nullable":true,"description":"Timestamp of when the export was generated (YYYY-MM-DD-HH).","example":"2025-01-15-06"},"base_name":{"type":"string","description":"The base export name.","example":"unload_user_data"}}}}}}}},"id":"schema_195"},"schema_196":{"kind":"json-schema","data":{"type":"string","enum":["following","recommended","latest","popular","most_contributed","visible","search"],"default":"following"},"id":"schema_196"},"schema_197":{"kind":"json-schema","data":{"type":"object","required":["data"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Feeds.Post.Resource"}},"meta":{"properties":{"filters":{"description":"A list of the filters applied in the current request.","example":{"content_type":"article","visibility":"public"}},"feed_name":{"description":"The name of the current feed, if named.","example":"following"},"pagination":{"$ref":"#/components/schemas/Standard.Feed.Meta.PagePagination"}}}}},"id":"schema_197"},"schema_198":{"kind":"json-schema","data":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","title","detail"],"properties":{"code":{"type":"integer","description":"The HTTP status code of the received error.","example":400},"title":{"type":"string","description":"A short, human-readable title describing the error.","example":"Bad Request"},"detail":{"type":"string","description":"A detailed explanation of what caused the error.","example":"One or more request validations have failed."},"validations":{"type":"array","description":"A list of validation errors that caused the request to fail.","items":{"type":"object","properties":{"rule":{"type":"string","description":"The validation rule that was violated.","example":"invalid_enum"},"parameter":{"type":"string","description":"The name of the request parameter that failed validation.","example":"state"},"message":{"type":"string","description":"A human-readable message describing the validation failure.","example":"name must be one of following, recommended, latest, popular, most_contributed, visible, search"}}}}}}}},"id":"schema_198"},"schema_199":{"kind":"json-schema","data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","description":"ID of the integration/shortcut","example":628},"name":{"type":"string","example":"Employee Notices"},"image_url":{"type":"string","description":"The url for the shortcut's image"},"banner_image_url":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The url for the shortcut's banner_image url"},"children":[]}]}]}]},"links":{"type":"array","description":"List of links","items":{"type":"object","properties":{"url":{"type":"string","description":"The URI of the link"},"label":{"type":"string","description":"The label for the link","example":"Team FAQ"}}}}}}},"id":"schema_199"}},"exampleStore":{"paths/~1v2~1channels/get/responses/400/content/application~1json/example":{"value":{"error":{"code":400,"title":"Bad Request","detail":"One or more request validations have failed. The request cannot be completed unless all validations are passed.","validations":[{"rule":"invalid_enum","parameter":"state","message":"state must be one of archived, hidden, published, any"}]}},"id":"paths/~1v2~1channels/get/responses/400/content/application~1json/example"},"paths/~1v2~1feed~1posts/get/responses/400/content/application~1json/example":{"value":{"error":{"code":400,"title":"Bad Request","detail":"One or more request validations have failed. The request cannot be completed unless all validations are passed.","validations":[{"rule":"invalid_enum","parameter":"name","message":"name must be one of: myfeed, following, resources, trending, icymi, featured, bookmarked, community_images, for_you"}]}},"id":"paths/~1v2~1feed~1posts/get/responses/400/content/application~1json/example"},"paths/~1v2~1feed~1channels~1posts/get/responses/400/content/application~1json/example":{"value":{"error":{"code":400,"title":"Bad Request","detail":"One or more request validations have failed. The request cannot be completed unless all validations are passed.","validations":[{"rule":"invalid_enum","parameter":"name","message":"name must be one of following, recommended, latest, popular, most_contributed, visible, search"}]}},"id":"paths/~1v2~1feed~1channels~1posts/get/responses/400/content/application~1json/example"}},"securitySchemeStore":{"oauth2_as_a_server":{"id":"oauth2_as_a_server","type":"oauth2","description":"OAuth2 for Server-to-Server (Client Credentials grant flow)","flows":{"clientCredentials":{"tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","public":"View public information.","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","data_exports.read":"View and download data export files in your program."}}}},"oauth2_as_a_user":{"id":"oauth2_as_a_user","type":"oauth2","description":"OAuth2 for Users (Authorization Code grant flow)","flows":{"authorizationCode":{"authorizationUrl":"IAM_DOMAIN/oauth/authorize","tokenUrl":"IAM_DOMAIN/oauth/token","scopes":{"admin_login":"Manage groups and other sensitive information","openid":"Authenticate your account using OpenID.","public":"View public information.","feeds.read":"View your feeds.","feeds.rendered.read":"View rendered content from feed posts.","feeds.engage":"View your feeds and engage with posts (likes, bookmarks, etc).","users.read":"View and list details of users in your program.","users.write":"Create, view, and update users in your program.","groups.read":"View and list details of groups in your program.","groups.write":"Create, view, and update groups in your program.","content.read":"View and list details of content in your program.","content.write":"Create, view, and update content in your program.","content.videos.download":"Download and play videos in content posts.","content.replication.audit":"Read content replication status.","webhooks.read":"View and list details of webhook subscriptions in your program.","webhooks.write":"Create, view, and update webhook subscriptions in your program.","assistant.inbox.read":"View and list details of your assistant inbox items.","notification_center":"View and list notification center items.","data_exports.read":"View and download data export files in your program."}}}}},"servers":[{"url":"https://partner.socialchorus.com","description":"US1"},{"url":"https://partner.us2.onfirstup.com","description":"US2"},{"url":"https://partner.onfirstup.eu","description":"EU"}]},"options":{"hideSidebar":true,"mockServer":{"off":true},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/endpoints/openapi.json?download"},{"url":"/_bundle/endpoints/openapi.yaml?download"}],"excludeFromSearch":false,"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Firstup API","description":"<div style=\"border:1px solid #D9D6FE; background:linear-gradient(180deg, #F8F6FF 0%, #F3F0FF 100%); color:#24124d; padding:18px 20px; border-radius:14px; margin:20px 0; box-shadow:0 6px 20px rgba(56, 28, 117, 0.08);\"> <strong style=\"display:block; font-size:16px; margin-bottom:8px;\">What’s new</strong> <p style=\"margin:0 0 8px 0;\">A quick summary of the latest API changes in version <strong>2026-05-01</strong>:</p> <ul style=\"margin:0 0 8px 20px; padding:0;\">\n <li>New <code>web_homepage</code> feed endpoint</li>\n <li>New attachment redirect endpoint for signed downloads</li>\n <li>New <code>Reactions.Fields</code> response schema</li>\n <li>Feed post and content responses now include reaction fields</li>\n</ul> <a href=\"https://developers.firstup.io/versionchange/changelog\">See the full changelog →</a> </div>\n\n <b>API Concepts and Overview</b> <br></br> <p>Each API concept can be found\n in our Docs; we give an overview of each API, the expected behavior and what\n is possible. </p>\n\n <p>Technical details are found in this reference, but some complex\n technicalities are further explained in our docs. </p>  <p>Further technical\n guidance on SCIM patching, pagination and filtering can be found in our\n docs:</p>\n       <ul>\n     <li><a href=\"/usermanagementapi/scim-patch-operations\">SCIM patching</a></li>\n     <li><a href=\"/gettingstarted/pagination\">Pagination</a></li>\n     <li><a href=\"/gettingstarted/filtering\">Filtering</a></li>\n     <li><a href=\"/guides\">Use case examples</a></li>\n   </ul>\n <b>Technical Details</b>\n\n  From this page, you can download the OpenAPI specification for the Firstup API as a\n  <b>openapi.json</b> or <b>openapi.yaml</b> file. This can be imported into tools such\n  as Postman to generate a collection of test queries or converted into an SDK using\n  <a href=\"https://swagger.io/tools/swagger-codegen/\">Swagger Codegen</a>.\n\n   {% admonition type=\"info\" %}\n  Alternatively, you can use the <a href=\"/gettingstarted/try_it\">try it function</a>\n  in this platform. In addition, select your preferred <b>language</b> for our request\n  and response examples.\n  {% /admonition %}\n\n </p> <b>Authorization</b> <br></br> <p class=\"code-below\">\n   All API endpoints use the JSON content type and require an auth token. See <a href=\"authorization/authenticationandauthorization\">Authentication and Authorization</a> for more details on token management.\n   The token and content type should be explicitly set in the request headers. For example:\n </p>\n\n <pre class=\"code\">\n   curl -X GET \"https://partner.socialchorus.com/v2/channels\" -H \"accept: application/json\" -H \"Authorization: Bearer &lt;ACCESS TOKEN&gt;\"\n </pre>\n\n\n {% admonition type=\"info\" %}\n   This example uses the US1 region server. Check your region's server [here](/authorization/authenticationandauthorization).\n {% /admonition %}\n\n\n <div class='sc-swag'>\n   <b>Main API Sections</b>\n   <br></br>\n   <ul>\n     <li><a href=\"/endpoints/openapi/content-publishing\">Content Publishing</a></li>\n     <li><a href=\"/endpoints/openapi/feeds\">Feeds</a></li>\n     <li><a href=\"/endpoints/openapi/user-management\">User Management (SCIM)</a></li>\n     <li><a href=\"/endpoints/openapi/user-groups\">User Group Management (SCIM)</a></li>\n     <li><a href=\"/endpoints/openapi/webhooks\">Webhooks</a></li>\n     <li><a href=\"/endpoints/openapi/assistant-inbox\">Assistant Inbox</a></li>\n     <li><a href=\"/endpoints/openapi/notification-center\">Notification Center</a></li>\n     <li><a href=\"/endpoints/openapi/user-roles\">User Roles</a></li>\n     <li><a href=\"/endpoints/openapi/user-shortcuts\">User Shortcuts</a></li>\n   </ul>\n   <hr>\n </div>\n"}},"baseSlug":"/endpoints/openapi","routesMapping":{}}