![](\\\"https://stationfy.imgix.net/cm/5d024b62f3cf2dc42684ff96.jpg\\\")
Arena provides a simple and powerful REST API to integrate into your business or application.
\nThis API reference provides information on available endpoints and how to interact with it.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"724792","collectionId":"532cd21c-13c6-475e-8b4b-a372bf663df4","publishedId":"S1ENxJQG","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"5021A6"},"publishDate":"2021-04-26T15:58:07.000Z"},"item":[{"name":"Liveblog","item":[{"name":"Get Liveblogs","id":"c90a64cf-1b9a-4366-81ca-2fd34dbe2018","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","type":"text","value":"YOUR_API_KEY"},{"key":"Content-Type","type":"text","value":"application/json"}],"url":"https://api.arena.im/customers-v1/liveblogs?siteId=[SITE_ID]&coverageStatus=[ENUM]&searchTerm=[TEXT]&startIndex=[START_INDEX]&numberResults=[NUMBER_RESULTS]","description":"Retrieve a list of Liveblogs for the account.
\n","urlObject":{"protocol":"https","path":["customers-v1","liveblogs"],"host":["api","arena","im"],"query":[{"description":{"content":"(optional) Return only liveblogs for this site. If omitted, will return all liveblogs from the first site
\n","type":"text/plain"},"key":"siteId","value":"[SITE_ID]"},{"description":{"content":"(optional) Return only liveblogs with the given status. Possible values are ALL (default) | PAST | CURRENT
\n","type":"text/plain"},"key":"coverageStatus","value":"[ENUM]"},{"description":{"content":"(optional) Filter liveblogs by search term
\n","type":"text/plain"},"key":"searchTerm","value":"[TEXT]"},{"description":{"content":"(optional) Default 0.
\n","type":"text/plain"},"key":"startIndex","value":"[START_INDEX]"},{"description":{"content":"(optional) Default 30.
\n","type":"text/plain"},"key":"numberResults","value":"[NUMBER_RESULTS]"}],"variable":[]}},"response":[{"id":"6c070808-0eb7-4c36-b779-12cfa01e63ac","name":"Get Liveblogs","originalRequest":{"method":"GET","header":[{"key":"x-api-key","type":"text","value":"YOUR_API_KEY"},{"key":"Content-Type","type":"text","value":"application/json"}],"url":{"raw":"https://api.arena.im/customers-v1/liveblogs?siteId=[SITE_ID]","protocol":"https","host":["api","arena","im"],"path":["customers-v1","liveblogs"],"query":[{"key":"siteId","value":"[SITE_ID]","description":"(optional) Return only liveblogs for this site. If omitted, will return all liveblogs from the first site"}]}},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"items\": [\n {\n \"_id\": \"-LYh02wVEPUxpuKtwpLt\",\n \"streams\": [\n \"5cf03177aff47816290b443a\",\n \"5cf0318baff478402f0b443c\",\n \"5e3e0e1a819a0a0008bf590d\",\n \"607f3238deaa7a0008b20e1a\"\n ],\n \"siteId\": \"IChF0zAWZjY6KZwMyyBRWg7DRDw2\",\n \"sportId\": \"technology\",\n \"name\": \"Developer Week\",\n \"location\": \"\",\n \"startDate\": 1550162264876,\n \"slug\": \"1550164704279\",\n \"status\": \"live\",\n \"createdAt\": 1550164704279,\n \"presenceId\": \"-LYh02tHmlBljJeRISvv\",\n \"commentIsEnabled\": true,\n \"infoTab\": true,\n \"lang\": \"en-us\",\n \"pagination\": 20,\n \"reactionType\": \"claps\",\n \"scoreBar\": true,\n \"share\": true,\n \"voting\": true,\n \"soundAlert\": true,\n \"statusBar\": true,\n \"timeFormat\": \"mm/dd/yyyy\",\n \"adsIsEnabled\": false,\n \"updatedBy\": \"IChF0zAWZjY6KZwMyyBRWg7DRDw2\",\n \"timeTitleColor\": \"#f47373\",\n \"modifiedAt\": 1618948664301,\n \"createdBy\": \"IChF0zAWZjY6KZwMyyBRWg7DRDw2\",\n \"chatPosition\": \"bottom\",\n \"chatRoom\": true,\n \"chatType\": \"-LYh02wK4a-mvb3yHzbc\",\n \"chatId\": \"-LYh02wK4a-mvb3yHzbc\",\n \"autoPlayByPlay\": false,\n \"autoScore\": false,\n \"isFirestore\": true,\n \"__v\": 0,\n \"streamPin\": \"5cf03177aff47816290b443a\",\n \"description\": \"\",\n \"liveblogLayout\": \"timeline\",\n \"tags\": [],\n \"theme\": {\n \"bgColor\": null,\n \"buttonsColor\": null,\n \"chatColor\": null,\n \"hoverColor\": null,\n \"iconColor\": null,\n \"linkColor\": null,\n \"textColor\": null,\n \"timelineColor\": null,\n \"titleColor\": null,\n \"cardBgColor\": null\n },\n \"profanityFilterType\": \"\",\n \"summaryWordEvent\": \"WEEKLY\",\n \"language\": \"en-us\",\n \"id\": \"-LYh02wVEPUxpuKtwpLt\",\n \"coverageStatus\": \"live\"\n },\n {\n \"_id\": \"5c84139796a789cc3c3f8084\",\n \"adsIsEnabled\": false,\n \"autoPlayByPlay\": false,\n \"avatarImage\": \"https://arenacdn.azureedge.net/videoupload/kDizKZCIKIMG_0007.JPG\",\n \"backgroundImage\": \"https://arenacdn.azureedge.net/videoupload/AKE0WouyEios_from_eic.jpg\",\n \"chatPosition\": \"bottom\",\n \"chatRoom\": true,\n \"chatType\": \"-L_Yv7LzK0kQ-bQBYlSt\",\n \"commentIsEnabled\": true,\n \"description\": \"Brand and Retail selection day\",\n \"infoTab\": true,\n \"location\": \"Plug n Play Tech Center\",\n \"name\": \"App Tech Event - Live\",\n \"pagination\": 20,\n \"reactionType\": \"thumbs-up-down\",\n \"scoreBar\": true,\n \"share\": true,\n \"siteId\": \"IChF0zAWZjY6KZwMyyBRWg7DRDw2\",\n \"soundAlert\": true,\n \"sportId\": \"technology\",\n \"startDate\": 1552159589438,\n \"status\": \"live\",\n \"statusBar\": true,\n \"timeFormat\": \"mm/dd/yyyy\",\n \"timeTitleColor\": \"#37d67a\",\n \"voting\": true,\n \"createdBy\": \"IChF0zAWZjY6KZwMyyBRWg7DRDw2\",\n \"slug\": \"jz37\",\n \"presenceId\": \"-L_Yv7Bg90axcoiGmRLE\",\n \"isFirestore\": true,\n \"lang\": \"en-us\",\n \"chatId\": \"-L_Yv7LzK0kQ-bQBYlSt\",\n \"createdAt\": 1552159639123,\n \"__v\": 0,\n \"tags\": [],\n \"modifiedAt\": 1580421267019,\n \"updatedBy\": \"IChF0zAWZjY6KZwMyyBRWg7DRDw2\",\n \"streams\": [\n \"5dd446729154490007326e50\"\n ],\n \"liveblogLayout\": \"timeline\",\n \"theme\": {\n \"bgColor\": \"transparent\",\n \"cardBgColor\": \"#37d67b\",\n \"buttonsColor\": \"#37d67a\",\n \"chatColor\": \"#37d67a\",\n \"hoverColor\": \"#3C3B6E\",\n \"iconColor\": \"#37d67a\",\n \"linkColor\": \"#A57CEF\",\n \"textColor\": \"#454C5F\",\n \"timelineColor\": \"#D8DCE9\",\n \"titleColor\": \"#454C5F\"\n },\n \"streamPin\": \"5dd446729154490007326e50\",\n \"profanityFilterType\": \"\",\n \"themeSelection\": \"custom\",\n \"language\": \"en-us\",\n \"id\": \"5c84139796a789cc3c3f8084\",\n \"coverageStatus\": \"live\"\n },\n {\n \"_id\": \"5f281ff62289c00008e70332\",\n \"onPostAddedWebhooks\": [],\n \"adsIsEnabled\": false,\n \"autoPlayByPlay\": true,\n \"autoScore\": true,\n \"chatPosition\": \"bottom\",\n \"chatRoom\": true,\n \"chatType\": \"5f281ff62289c00008e70333\",\n \"commentIsEnabled\": true,\n \"description\": \"\",\n \"hourFormat\": \"24h\",\n \"infoTab\": true,\n \"liveblogLayout\": \"timeline\",\n \"location\": \"Silverstone Circuit\",\n \"name\": \"Formula 1 70th Anniversary GP - Second practice\",\n \"officialEventId\": \"second_practice_819593\",\n \"pagination\": 20,\n \"profanityFilterType\": \"none\",\n \"reactionType\": \"thumbs-up-down\",\n \"scoreBar\": true,\n \"share\": true,\n \"showEventTitle\": false,\n \"siteId\": \"IChF0zAWZjY6KZwMyyBRWg7DRDw2\",\n \"soundAlert\": true,\n \"sportId\": \"motor-racing\",\n \"startDate\": 1596805200000,\n \"status\": \"live\",\n \"statusBar\": true,\n \"timeTitleColor\": \"#37d67a\",\n \"tournamentId\": \"ar:tournament:-461196329-5755\",\n \"voting\": true,\n \"createdBy\": \"IChF0zAWZjY6KZwMyyBRWg7DRDw2\",\n \"slug\": \"t6d9\",\n \"presenceId\": \"t6d9\",\n \"isFirestore\": true,\n \"playByPlaySource\": \"sportradar\",\n \"lang\": \"ja\",\n \"chatId\": \"5f281ff62289c00008e70333\",\n \"createdAt\": 1596465143488,\n \"__v\": 0,\n \"modifiedAt\": 1608748421016,\n \"updatedBy\": \"IChF0zAWZjY6KZwMyyBRWg7DRDw2\",\n \"tags\": [],\n \"theme\": {\n \"bgColor\": null,\n \"buttonsColor\": null,\n \"cardBgColor\": null,\n \"chatColor\": null,\n \"hoverColor\": null,\n \"iconColor\": null,\n \"linkColor\": null,\n \"textColor\": null,\n \"timelineColor\": null,\n \"titleColor\": null\n },\n \"language\": \"ja\",\n \"id\": \"5f281ff62289c00008e70332\",\n \"coverageStatus\": \"live\"\n },\n {\n \"_id\": \"-LUeehGIzFa94Cvp0GvX\",\n \"streams\": [],\n \"siteId\": \"IChF0zAWZjY6KZwMyyBRWg7DRDw2\",\n \"sportId\": \"politics\",\n \"name\": \"Politics From Twitter \",\n \"location\": \"AAA\",\n \"startDate\": 1611522000000,\n \"slug\": \"1545830322591\",\n \"status\": \"live\",\n \"createdAt\": 1545830322591,\n \"presenceId\": \"-LUeehAuy7HD2bZ9pg6-\",\n \"commentIsEnabled\": true,\n \"infoTab\": true,\n \"lang\": \"en-us\",\n \"pagination\": 20,\n \"reactionType\": \"thumbs-up-down\",\n \"scoreBar\": true,\n \"share\": true,\n \"voting\": true,\n \"soundAlert\": true,\n \"statusBar\": true,\n \"timeFormat\": \"mm/dd/yyyy\",\n \"adsIsEnabled\": false,\n \"updatedBy\": \"IChF0zAWZjY6KZwMyyBRWg7DRDw2\",\n \"timeTitleColor\": \"#f47373\",\n \"modifiedAt\": 1611520018969,\n \"conversionCardsAutoPost\": [\n {\n \"_id\": \"-LIgsaobroN-_miLf5qs\",\n \"enabled\": false,\n \"frequency\": 10,\n \"id\": \"-LIgsaobroN-_miLf5qs\"\n },\n {\n \"_id\": \"-LIrQ2F3-YGKtymaz4OB\",\n \"enabled\": false,\n \"frequency\": 40,\n \"id\": \"-LIrQ2F3-YGKtymaz4OB\"\n },\n {\n \"_id\": \"-LJGnEMUxDKPxdx9yfvD\",\n \"enabled\": true,\n \"frequency\": 10,\n \"id\": \"-LJGnEMUxDKPxdx9yfvD\"\n },\n {\n \"_id\": \"-LaWg5fEVpnTaRVRQFjP\",\n \"enabled\": false,\n \"frequency\": 10,\n \"id\": \"-LaWg5fEVpnTaRVRQFjP\"\n },\n {\n \"_id\": \"-Lf7hFxSlHe-QQ3DXMZl\",\n \"enabled\": true,\n \"frequency\": 10,\n \"id\": \"-Lf7hFxSlHe-QQ3DXMZl\"\n }\n ],\n \"createdBy\": \"IChF0zAWZjY6KZwMyyBRWg7DRDw2\",\n \"chatPosition\": \"bottom\",\n \"chatRoom\": true,\n \"chatType\": \"5fbc05141aca9d00081ec97b\",\n \"chatId\": \"5fbc05141aca9d00081ec97b\",\n \"autoPlayByPlay\": false,\n \"autoScore\": false,\n \"isFirestore\": true,\n \"__v\": 0,\n \"profanityFilterType\": \"replace\",\n \"description\": \"test 2\",\n \"liveblogLayout\": \"timeline\",\n \"tags\": [],\n \"theme\": {\n \"bgColor\": null,\n \"buttonsColor\": null,\n \"chatColor\": null,\n \"hoverColor\": null,\n \"iconColor\": null,\n \"linkColor\": null,\n \"textColor\": null,\n \"timelineColor\": null,\n \"titleColor\": null,\n \"cardBgColor\": null\n },\n \"onPostAddedWebhooks\": [\n \"https://postman-echo.com/post\"\n ],\n \"summaryWordEvent\": \"Tralala\",\n \"showCoronaVirusMap\": true,\n \"language\": \"en-us\",\n \"id\": \"-LUeehGIzFa94Cvp0GvX\",\n \"coverageStatus\": \"live\"\n }\n ]\n}"}],"_postman_id":"c90a64cf-1b9a-4366-81ca-2fd34dbe2018"},{"name":"Get Liveblog Posts","id":"7fdb9830-eb5d-4a8f-b08e-eec190a71fe4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","type":"text","value":"YOUR_API_KEY"},{"key":"Content-Type","type":"text","value":"application/json"}],"url":"https://api.arena.im/customers-v1/liveblogs/{liveblogId}/posts?limit=10&order=desc","description":"Retrieve this liveblog posts ordered by creation date. {liveblogId} can be the liveblog's slug or id.
\n","urlObject":{"protocol":"https","path":["customers-v1","liveblogs","{liveblogId}","posts"],"host":["api","arena","im"],"query":[{"description":{"content":"Total posts to retrieve. Default: 20. Max: 50.
\n","type":"text/plain"},"key":"limit","value":"10"},{"description":{"content":"desc|asc. 'desc' will return the most recent first. Default: desc.
\n","type":"text/plain"},"key":"order","value":"desc"}],"variable":[]}},"response":[{"id":"3c4b0a58-b059-4783-8d07-b4888c397ff4","name":"Get Liveblog Posts","originalRequest":{"method":"GET","header":[{"key":"x-api-key","type":"text","value":"YOUR_API_KEY"},{"key":"Content-Type","type":"text","value":"application/json"}],"url":{"raw":"https://api.arena.im/customers-v1/liveblogs/{liveblogId}/posts?limit=10&order=desc","protocol":"https","host":["api","arena","im"],"path":["customers-v1","liveblogs","{liveblogId}","posts"],"query":[{"key":"limit","value":"10","description":"Total posts to retrieve. Default: 20. Max: 50."},{"key":"order","value":"desc","description":"desc|asc. 'desc' will return the most recent first. Default: desc."}]}},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"[\n {\n \"summary\": null,\n \"sender\": {\n \"uid\": \"IChF0zAWZjY6KZwMyyBRWg7DRDw2\",\n \"photoURL\": \"https://firebasestorage.googleapis.com/v0/b/arena-dev-f9045.appspot.com/o/images%2F0dabede391a0fe9d1df498804cf9f40b.jpg?alt=media&token=4c018d92-91ed-4620-8b0a-96f503cc70ec\",\n \"displayName\": \"Rodrigo Reis\"\n },\n \"hasComments\": true,\n \"priority\": 1,\n \"key\": \"OPIT4rvFUwdf53UczSKe\",\n \"backgroundColor\": \"transparent\",\n \"message\": {\n \"url\": null,\n \"title\": \"Photo iOS \",\n \"text\": null,\n \"media\": {\n \"url\": \"https://arenacdn.azureedge.net/videoupload/JrjeVWcbCcamera_file.JPG\",\n \"providerName\": \"arena\",\n \"thumbnailUrl\": \"https://arenacdn.azureedge.net/videoupload/JrjeVWcbCcamera_file.JPG\",\n \"type\": \"photo\",\n \"html\": \"
\"\n }\n },\n \"owner\": \"IChF0zAWZjY6KZwMyyBRWg7DRDw2\",\n \"action\": {\n \"timeSec\": null,\n \"period\": null,\n \"team\": null,\n \"player\": null,\n \"time\": null,\n \"type\": null\n },\n \"event\": \"-LUeehGIzFa94Cvp0GvX\",\n \"createdAt\": 1570835948777,\n \"editorName\": false,\n \"reactions\": {\n \"thumbs_up\": 1\n },\n \"publisherId\": \"IChF0zAWZjY6KZwMyyBRWg7DRDw2\",\n \"updatedAt\": 1572044110344,\n \"device\": \"mobile\"\n },\n {\n \"summary\": null,\n \"sender\": {\n \"photoURL\": \"https://firebasestorage.googleapis.com/v0/b/arena-dev-f9045.appspot.com/o/images%2F0dabede391a0fe9d1df498804cf9f40b.jpg?alt=media&token=4c018d92-91ed-4620-8b0a-96f503cc70ec\",\n \"displayName\": \"Rodrigo Reis\",\n \"uid\": \"IChF0zAWZjY6KZwMyyBRWg7DRDw2\"\n },\n \"hasComments\": true,\n \"settings\": null,\n \"priority\": 1,\n \"key\": \"BlyTEIBZIgIgsak3tht1\",\n \"backgroundColor\": \"transparent\",\n \"message\": {\n \"title\": \"Wow\",\n \"text\": null,\n \"media\": null,\n \"url\": null\n },\n \"owner\": \"IChF0zAWZjY6KZwMyyBRWg7DRDw2\",\n \"action\": {\n \"timeSec\": null,\n \"period\": null,\n \"team\": null,\n \"player\": null,\n \"time\": null,\n \"type\": null\n },\n \"event\": \"-LUeehGIzFa94Cvp0GvX\",\n \"createdAt\": 1570835757523,\n \"editorName\": false,\n \"publisherId\": \"IChF0zAWZjY6KZwMyyBRWg7DRDw2\",\n \"updatedAt\": 1572044154742,\n \"device\": \"mobile\",\n \"postToSocialAccounts\": {\n \"facebookIds\": []\n }\n },\n {\n \"editorName\": false,\n \"assetIds\": [\n \"5d024b62f3cf2dc42684ff96\"\n ],\n \"publisherId\": \"IChF0zAWZjY6KZwMyyBRWg7DRDw2\",\n \"pendingAssets\": false,\n \"device\": \"desktop\",\n \"priority\": 1,\n \"sender\": {\n \"displayName\": \"Rodrigo Reis\",\n \"uid\": \"IChF0zAWZjY6KZwMyyBRWg7DRDw2\",\n \"photoURL\": \"https://firebasestorage.googleapis.com/v0/b/arena-dev-f9045.appspot.com/o/images%2F0dabede391a0fe9d1df498804cf9f40b.jpg?alt=media&token=4c018d92-91ed-4620-8b0a-96f503cc70ec\"\n },\n \"key\": \"tc4iEdDtLDyqNL2zD1vh\",\n \"arenaPost\": true,\n \"backgroundColor\": \"transparent\",\n \"message\": {\n \"text\": \"Thats great guys!
\",\n \"media\": null\n },\n \"owner\": \"IChF0zAWZjY6KZwMyyBRWg7DRDw2\",\n \"action\": {},\n \"event\": \"-LUeehGIzFa94Cvp0GvX\",\n \"createdAt\": 1570579357362\n },\n {\n \"summary\": null,\n \"settings\": null,\n \"priority\": 1,\n \"sender\": {\n \"displayName\": \"QA Publisher\",\n \"uid\": \"OSRA5O0YmdfjWIt9l7QSWspONoz2\",\n \"photoURL\": \"https://firebasestorage.googleapis.com/v0/b/arena-dev-f9045.appspot.com/o/images%2F4d393abb0e8bdeda2c787d56592c71f3.jpg?alt=media&token=a8951c60-d47a-4792-87ef-27380172505a\"\n },\n \"key\": \"VxwGBw4OvYL3SQdDXNan\",\n \"backgroundColor\": \"transparent\",\n \"message\": {\n \"title\": \"Teste\",\n \"text\": \"Com texto\",\n \"media\": {\n \"url\": \"https://arenacdn.azureedge.net/videoupload/afjFaJVDScamera_file.JPG\",\n \"providerName\": \"arena\",\n \"thumbnailUrl\": \"https://arenacdn.azureedge.net/videoupload/afjFaJVDScamera_file.JPG\",\n \"type\": \"photo\",\n \"html\": \"
\"\n },\n \"url\": null\n },\n \"owner\": \"OSRA5O0YmdfjWIt9l7QSWspONoz2\",\n \"action\": {\n \"period\": null,\n \"team\": null,\n \"player\": null,\n \"time\": null,\n \"type\": null,\n \"timeSec\": null\n },\n \"event\": \"5d98ace195e4033a2b24edf7\",\n \"createdAt\": 1570579353084,\n \"editorName\": false,\n \"publisherId\": \"OSRA5O0YmdfjWIt9l7QSWspONoz2\",\n \"device\": \"mobile\"\n },\n {\n \"key\": \"kFcyieIZEKyhV1vX2Fu9\",\n \"arenaPost\": true,\n \"backgroundColor\": \"transparent\",\n \"message\": {\n \"text\": \"
\",\n \"url\": \"https://arenacdn.azureedge.net/videoupload/afjFaJVDScamera_file.JPG\",\n \"providerName\": \"arena\",\n \"thumbnailUrl\": \"https://arenacdn.azureedge.net/videoupload/afjFaJVDScamera_file.JPG\"\n },\n \"url\": null,\n \"title\": \"Teste\"\n },\n \"owner\": \"OSRA5O0YmdfjWIt9l7QSWspONoz2\",\n \"action\": {\n \"period\": null,\n \"team\": null,\n \"player\": null,\n \"time\": null,\n \"type\": null,\n \"timeSec\": null\n },\n \"event\": \"5d98ace195e4033a2b24edf7\",\n \"createdAt\": 1570296177730,\n \"editorName\": false,\n \"publisherId\": \"OSRA5O0YmdfjWIt9l7QSWspONoz2\",\n \"device\": \"mobile\"\n },\n {\n \"publisherId\": \"OSRA5O0YmdfjWIt9l7QSWspONoz2\",\n \"device\": \"mobile\",\n \"summary\": null,\n \"settings\": null,\n \"priority\": 1,\n \"sender\": {\n \"uid\": \"OSRA5O0YmdfjWIt9l7QSWspONoz2\",\n \"photoURL\": \"https://firebasestorage.googleapis.com/v0/b/arena-dev-f9045.appspot.com/o/images%2F4d393abb0e8bdeda2c787d56592c71f3.jpg?alt=media&token=a8951c60-d47a-4792-87ef-27380172505a\",\n \"displayName\": \"QA Publisher\"\n },\n \"key\": \"4EDLz7W1HLSgeW0kCRFf\",\n \"backgroundColor\": \"transparent\",\n \"message\": {\n \"text\": \"Com texto\",\n \"media\": {\n \"url\": \"https://arenacdn.azureedge.net/videoupload/afjFaJVDScamera_file.JPG\",\n \"providerName\": \"arena\",\n \"thumbnailUrl\": \"https://arenacdn.azureedge.net/videoupload/afjFaJVDScamera_file.JPG\",\n \"type\": \"photo\",\n \"html\": \"\"\n },\n \"url\": null,\n \"title\": \"Teste\"\n },\n \"owner\": \"OSRA5O0YmdfjWIt9l7QSWspONoz2\",\n \"action\": {\n \"type\": null,\n \"timeSec\": null,\n \"period\": null,\n \"team\": null,\n \"player\": null,\n \"time\": null\n },\n \"event\": \"5d98ace195e4033a2b24edf7\",\n \"createdAt\": 1570295967888,\n \"editorName\": false\n },\n {\n \"editorName\": false,\n \"publisherId\": \"OSRA5O0YmdfjWIt9l7QSWspONoz2\",\n \"device\": \"mobile\",\n \"summary\": null,\n \"settings\": null,\n \"priority\": 1,\n \"sender\": {\n \"uid\": \"OSRA5O0YmdfjWIt9l7QSWspONoz2\",\n \"photoURL\": \"https://firebasestorage.googleapis.com/v0/b/arena-dev-f9045.appspot.com/o/images%2F4d393abb0e8bdeda2c787d56592c71f3.jpg?alt=media&token=a8951c60-d47a-4792-87ef-27380172505a\",\n \"displayName\": \"QA Publisher\"\n },\n \"key\": \"MzT3n1CAIkrnOdegp0Jj\",\n \"backgroundColor\": \"transparent\",\n \"message\": {\n \"title\": \"Teste\",\n \"text\": \"Com texto\",\n \"media\": {\n \"providerName\": \"arena\",\n \"thumbnailUrl\": \"https://arenacdn.azureedge.net/videoupload/afjFaJVDScamera_file.JPG\",\n \"type\": \"photo\",\n \"html\": \"\",\n \"url\": \"https://arenacdn.azureedge.net/videoupload/afjFaJVDScamera_file.JPG\"\n },\n \"url\": null\n },\n \"owner\": \"OSRA5O0YmdfjWIt9l7QSWspONoz2\",\n \"action\": {\n \"timeSec\": null,\n \"period\": null,\n \"team\": null,\n \"player\": null,\n \"time\": null,\n \"type\": null\n },\n \"event\": \"5d98ace195e4033a2b24edf7\",\n \"createdAt\": 1570295910617\n },\n {\n \"message\": {\n \"text\": null,\n \"media\": {\n \"providerName\": \"arena\",\n \"thumbnailUrl\": \"https://arenacdn.azureedge.net/videoupload/kfDtjQKdZcamera_file.JPG\",\n \"type\": \"photo\",\n \"html\": \"
\",\n \"url\": \"https://arenacdn.azureedge.net/videoupload/kfDtjQKdZcamera_file.JPG\"\n },\n \"url\": null,\n \"title\": \"Test 6\"\n },\n \"owner\": \"5ccc91b2f286ed23543dbcdf\",\n \"action\": {\n \"team\": null,\n \"player\": null,\n \"time\": null,\n \"type\": null,\n \"timeSec\": null,\n \"period\": null\n },\n \"event\": \"5d8a5377064c7875e331146c\",\n \"createdAt\": 1570240557651,\n \"editorName\": false,\n \"publisherId\": \"5ccc91b2f286ed23543dbcdf\",\n \"device\": \"mobile\",\n \"summary\": null,\n \"settings\": null,\n \"priority\": 1,\n \"sender\": {\n \"displayName\": \"Cesar William 9\",\n \"uid\": \"Wa49tNE4vhb8T0rIfcZWMjYWKnO2\",\n \"photoURL\": \"https://firebasestorage.googleapis.com/v0/b/arena-dev-f9045.appspot.com/o/images%2Ff2a980aeae366e545ed6f6c024fa5428.jpg?alt=media&token=4ecba8c5-4418-4178-a66b-cb1221df0438\"\n },\n \"key\": \"NaWz8DgLiFHCoqpOdsI0\",\n \"backgroundColor\": \"transparent\"\n },\n {\n \"editorName\": false,\n \"assetIds\": [\n \"5d93b234a2892e77427fa0e6\"\n ],\n \"publisherId\": \"5ccc91b2f286ed23543dbcdf\",\n \"pendingAssets\": true,\n \"updatedAt\": 1569961369953,\n \"device\": \"desktop\",\n \"priority\": 1,\n \"sender\": {\n \"uid\": \"Wa49tNE4vhb8T0rIfcZWMjYWKnO2\",\n \"photoURL\": \"https://firebasestorage.googleapis.com/v0/b/arena-dev-f9045.appspot.com/o/images%2Ff2a980aeae366e545ed6f6c024fa5428.jpg?alt=media&token=4ecba8c5-4418-4178-a66b-cb1221df0438\",\n \"displayName\": \"Cesar William 9\"\n },\n \"key\": \"ludTw7hmWiV5U0KoZAdb\",\n \"arenaPost\": true,\n \"backgroundColor\": \"transparent\",\n \"message\": {\n \"text\": \"![](\\\"https://stationfy.imgix.net/cm/5d93b234a2892e77427fa0e6.jpg\\\")
Retrieve a liveblog sports lineup. {liveblogId} can be the liveblog's slug or id.
\nIf the liveblog is not sports related, an empty response will be returned.
\n","urlObject":{"protocol":"https","path":["customers-v1","liveblogs","{liveblogId}","lineup"],"host":["api","arena","im"],"query":[],"variable":[]}},"response":[{"id":"191cb357-54b5-43de-995e-524d37c9faeb","name":"Get Liveblog Lineup","originalRequest":{"method":"GET","header":[{"key":"x-api-key","type":"text","value":"YOUR_API_KEY"},{"key":"Content-Type","type":"text","value":"application/json"}],"url":"https://api.arena.im/customers-v1/liveblogs/{liveblogId}/lineup"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"_id\": \"5d7d46ef9e31f47f8873b37a\",\n \"externalEventId\": \"sr:match:17789166\",\n \"lastUpdate\": \"2019-09-14T20:00:47.071Z\",\n \"homeLineup\": {\n \"substitutes\": [\n {\n \"name\": \"Cesar\",\n \"type\": \"goalkeeper\",\n \"localizedType\": \"Goalkeeper\",\n \"image\": \"https://stationfy.imgix.net/sports/sr-player-158269.png\"\n },\n {\n \"name\": \"Gabriel Batista\",\n \"type\": \"goalkeeper\",\n \"localizedType\": \"Goalkeeper\",\n \"image\": \"https://stationfy.imgix.net/sports/sr-player-918766.png\"\n },\n {\n \"name\": \"Joao Lucas\",\n \"type\": \"defender\",\n \"localizedType\": \"Defender\"\n },\n {\n \"name\": \"Rene\",\n \"type\": \"defender\",\n \"localizedType\": \"Defender\",\n \"image\": \"https://stationfy.imgix.net/sports/sr-player-243113.png\"\n },\n {\n \"name\": \"Rodinei\",\n \"type\": \"defender\",\n \"localizedType\": \"Defender\",\n \"image\": \"https://stationfy.imgix.net/sports/sr-player-244039.png\"\n },\n {\n \"name\": \"Thuler\",\n \"type\": \"defender\",\n \"localizedType\": \"Defender\"\n },\n {\n \"name\": \"Rhodolfo\",\n \"type\": \"defender\",\n \"localizedType\": \"Defender\",\n \"image\": \"https://stationfy.imgix.net/sports/sr-player-39355.png\"\n },\n {\n \"name\": \"Robert Piris\",\n \"type\": \"midfielder\",\n \"localizedType\": \"Midfielder\",\n \"image\": \"https://stationfy.imgix.net/sports/sr-player-333371.png\"\n },\n {\n \"name\": \"Reinier\",\n \"type\": \"midfielder\",\n \"localizedType\": \"Midfielder\"\n },\n {\n \"name\": \"Vinicius De Souza Costa\",\n \"type\": \"midfielder\",\n \"localizedType\": \"Midfielder\"\n },\n {\n \"name\": \"Vitinho\",\n \"type\": \"forward\",\n \"localizedType\": \"Forward\",\n \"image\": \"https://stationfy.imgix.net/sports/sr-player-242054.png\"\n },\n {\n \"name\": \"Orlando Berrio\",\n \"type\": \"forward\",\n \"localizedType\": \"Forward\",\n \"image\": \"https://stationfy.imgix.net/sports/sr-player-285849.png\"\n }\n ],\n \"starting\": [\n {\n \"name\": \"Diego Alves\",\n \"type\": \"goalkeeper\",\n \"localizedType\": \"Goalkeeper\"\n },\n {\n \"name\": \"Rafinha\",\n \"type\": \"defender\",\n \"localizedType\": \"Defender\"\n },\n {\n \"name\": \"Rodrigo Caio\",\n \"type\": \"defender\",\n \"localizedType\": \"Defender\",\n \"image\": \"https://stationfy.imgix.net/sports/sr-player-166273.png\"\n },\n {\n \"name\": \"Pablo Mari\",\n \"type\": \"defender\",\n \"localizedType\": \"Defender\",\n \"image\": \"https://stationfy.imgix.net/sports/sr-player-208988.png\"\n },\n {\n \"name\": \"Filipe Luis\",\n \"type\": \"defender\",\n \"localizedType\": \"Defender\",\n \"image\": \"https://stationfy.imgix.net/sports/sr-player-26029.png\"\n },\n {\n \"name\": \"Gerson\",\n \"type\": \"midfielder\",\n \"localizedType\": \"Midfielder\",\n \"image\": \"https://stationfy.imgix.net/sports/sr-player-611876.png\"\n },\n {\n \"name\": \"Willian Arao\",\n \"type\": \"midfielder\",\n \"localizedType\": \"Midfielder\",\n \"image\": \"https://stationfy.imgix.net/sports/sr-player-242213.png\"\n },\n {\n \"name\": \"Everton Ribeiro\",\n \"type\": \"midfielder\",\n \"localizedType\": \"Midfielder\",\n \"image\": \"https://stationfy.imgix.net/sports/sr-player-145063.png\"\n },\n {\n \"name\": \"Giorgian De Arrascaeta\",\n \"type\": \"midfielder\",\n \"localizedType\": \"Midfielder\",\n \"image\": \"https://stationfy.imgix.net/sports/sr-player-333587.png\"\n },\n {\n \"name\": \"Bruno Henrique\",\n \"type\": \"forward\",\n \"localizedType\": \"Forward\",\n \"image\": \"https://stationfy.imgix.net/sports/sr-player-838379.png\"\n },\n {\n \"name\": \"Gabriel Barbosa\",\n \"type\": \"forward\",\n \"localizedType\": \"Forward\",\n \"image\": \"https://stationfy.imgix.net/sports/sr-player-358554.png\"\n }\n ]\n },\n \"awayLineup\": {\n \"substitutes\": [\n {\n \"name\": \"Joao Paulo\",\n \"type\": \"goalkeeper\",\n \"localizedType\": \"Goalkeeper\",\n \"image\": \"https://stationfy.imgix.net/sports/sr-player-838169.png\"\n },\n {\n \"name\": \"Vanderlei\",\n \"type\": \"goalkeeper\",\n \"localizedType\": \"Goalkeeper\",\n \"image\": \"https://stationfy.imgix.net/sports/sr-player-77526.png\"\n },\n {\n \"name\": \"Felipe Jonatan\",\n \"type\": \"defender\",\n \"localizedType\": \"Defender\"\n },\n {\n \"name\": \"Felipe Aguilar\",\n \"type\": \"defender\",\n \"localizedType\": \"Defender\",\n \"image\": \"https://stationfy.imgix.net/sports/sr-player-329577.png\"\n },\n {\n \"name\": \"Luiz Felipe\",\n \"type\": \"defender\",\n \"localizedType\": \"Defender\",\n \"image\": \"https://stationfy.imgix.net/sports/sr-player-962967.png\"\n },\n {\n \"name\": \"Jean Mota\",\n \"type\": \"midfielder\",\n \"localizedType\": \"Midfielder\",\n \"image\": \"https://stationfy.imgix.net/sports/sr-player-243231.png\"\n },\n {\n \"name\": \"Tailson\",\n \"type\": \"midfielder\",\n \"localizedType\": \"Midfielder\"\n },\n {\n \"name\": \"Christian Cueva\",\n \"type\": \"midfielder\",\n \"localizedType\": \"Midfielder\",\n \"image\": \"https://stationfy.imgix.net/sports/sr-player-47447.png\"\n },\n {\n \"name\": \"Jobson\",\n \"type\": \"midfielder\",\n \"localizedType\": \"Midfielder\"\n },\n {\n \"name\": \"Kaio Jorge\",\n \"type\": \"forward\",\n \"localizedType\": \"Forward\"\n },\n {\n \"name\": \"Lucas Venuto\",\n \"type\": \"forward\",\n \"localizedType\": \"Forward\",\n \"image\": \"https://stationfy.imgix.net/sports/sr-player-575954.png\"\n },\n {\n \"name\": \"Fernando Uribe\",\n \"type\": \"forward\",\n \"localizedType\": \"Forward\",\n \"image\": \"https://stationfy.imgix.net/sports/sr-player-107233.png\"\n }\n ],\n \"starting\": [\n {\n \"name\": \"Eduardo Sasha\",\n \"type\": \"forward\",\n \"localizedType\": \"Forward\",\n \"image\": \"https://stationfy.imgix.net/sports/sr-player-143846.png\"\n },\n {\n \"name\": \"Victor Ferraz\",\n \"type\": \"defender\",\n \"localizedType\": \"Defender\",\n \"image\": \"https://stationfy.imgix.net/sports/sr-player-255613.png\"\n },\n {\n \"name\": \"Alison\",\n \"type\": \"midfielder\",\n \"localizedType\": \"Midfielder\",\n \"image\": \"https://stationfy.imgix.net/sports/sr-player-329201.png\"\n },\n {\n \"name\": \"Everson\",\n \"type\": \"goalkeeper\",\n \"localizedType\": \"Goalkeeper\"\n },\n {\n \"name\": \"Luan Peres\",\n \"type\": \"defender\",\n \"localizedType\": \"Defender\",\n \"image\": \"https://stationfy.imgix.net/sports/sr-player-1005437.png\"\n },\n {\n \"name\": \"Carlos Sanchez\",\n \"type\": \"midfielder\",\n \"localizedType\": \"Midfielder\",\n \"image\": \"https://stationfy.imgix.net/sports/sr-player-77034.png\"\n },\n {\n \"name\": \"Marinho\",\n \"type\": \"forward\",\n \"localizedType\": \"Forward\"\n },\n {\n \"name\": \"Yeferson Soteldo\",\n \"type\": \"midfielder\",\n \"localizedType\": \"Midfielder\",\n \"image\": \"https://stationfy.imgix.net/sports/sr-player-803660.png\"\n },\n {\n \"name\": \"Lucas Verissimo\",\n \"type\": \"defender\",\n \"localizedType\": \"Defender\",\n \"image\": \"https://stationfy.imgix.net/sports/sr-player-937008.png\"\n },\n {\n \"name\": \"Gustavo Henrique\",\n \"type\": \"defender\",\n \"localizedType\": \"Defender\",\n \"image\": \"https://stationfy.imgix.net/sports/sr-player-243181.png\"\n },\n {\n \"name\": \"Jorge\",\n \"type\": \"defender\",\n \"localizedType\": \"Defender\",\n \"image\": \"https://stationfy.imgix.net/sports/sr-player-759428.png\"\n }\n ]\n }\n}"}],"_postman_id":"a7e67641-1ff4-42e2-a303-10b1b37b79c7"},{"name":"Export LiveBlog analytics data","id":"0661cdc7-d47e-4374-a490-274706828bbb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","value":"YOUR_API_KEY","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://api.arena.im/customers-v1/liveblogs/{liveblogId}/analytics?format=csv","description":"Export analytics data for a given liveBlog.
\nRequest fields:
\nliveblogId: The id of the liveBlog.
format: (optional) the format for the final file. The default format is json. Accepted values: json, csv
(optional) The format of the generated file. Options csv json
Retrieves a list of all chat rooms.
\nRequest fields:
\nnumberResults: For pagination, the maximum number of results to retrieve.
startIndex: For pagination, index offset
(optional) Return only liveblogs for this site. If omitted, will return all liveblogs from the first site
\n","type":"text/plain"},"key":"siteId","value":"[SITE_ID]"},{"key":"numberResults","value":"[MAX_RESULTS]"}],"variable":[]}},"response":[{"id":"2a7698af-077b-4d1b-8499-3f26392866c0","name":"Get Chat Rooms","originalRequest":{"method":"GET","header":[{"key":"x-api-key","type":"text","value":"YOUR_API_KEY"},{"key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":{"raw":"https://api.arena.im/customers-v1/chat-rooms/{chatRoomId}?siteId=[siteId]&numberResults=[numberResults]","protocol":"https","host":["api","arena","im"],"path":["customers-v1","chat-rooms","{chatRoomId}"],"query":[{"key":"siteId","value":"[siteId]","type":"text"},{"key":"numberResults","value":"[numberResults]","type":"text"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"_id\": \"608309c1ce49b40008967f49\",\n \"privateChatIsEnabled\": true,\n \"qnaIsEnabled\": false,\n \"lang\": \"en-us\",\n \"showArenaBranding\": true,\n \"showEmojiButton\": true,\n \"streams\": [],\n \"name\": \"CountDown Soon!\",\n \"chatAutoOpen\": true,\n \"chatPreModerationIsEnabled\": false,\n \"chatClosedIsEnabled\": false,\n \"chatSlowModeInterval\": 10,\n \"chatRequestModeratorIsEnabled\": false,\n \"chatPreviewEnabled\": true,\n \"allowSendGifs\": true,\n \"allowShareUrls\": false,\n \"signUpRequired\": false,\n \"signUpSettings\": {\n \"type\": \"SIGN_UP_REQUIRED\"\n },\n \"profanityFilterType\": \"none\",\n \"slug\": \"boya\",\n \"siteId\": \"IChF0zAWZjY6KZwMyyBRWg7DRDw2\",\n \"showOnlineUsersNumber\": true,\n \"updatedAt\": 1619200449239,\n \"createdAt\": 1619200449239,\n \"createdBy\": \"IChF0zAWZjY6KZwMyyBRWg7DRDw2\",\n \"standalone\": false,\n \"global\": false,\n \"presenceId\": \"boya\",\n \"version\": \"V2\",\n \"mainChannelId\": \"608309c1ce49b40008967f4a\",\n \"__v\": 0\n },\n {\n \"_id\": \"6078502721a74f000815c666\",\n \"privateChatIsEnabled\": true,\n \"qnaIsEnabled\": false,\n \"lang\": \"en-us\",\n \"showArenaBranding\": true,\n \"showEmojiButton\": true,\n \"streams\": [],\n \"name\": \"XSS\",\n \"chatAutoOpen\": true,\n \"chatPreModerationIsEnabled\": true,\n \"chatClosedIsEnabled\": false,\n \"chatColor\": \"#5021A6\",\n \"chatSlowModeInterval\": 0,\n \"chatRequestModeratorIsEnabled\": false,\n \"chatPreviewEnabled\": true,\n \"allowSendGifs\": true,\n \"allowShareUrls\": false,\n \"signUpRequired\": false,\n \"signUpSettings\": {\n \"suggest\": false,\n \"type\": \"SIGN_UP_NOT_REQUIRED\"\n },\n \"profanityFilterType\": \"\",\n \"slug\": \"3s85\",\n \"siteId\": \"IChF0zAWZjY6KZwMyyBRWg7DRDw2\",\n \"showOnlineUsersNumber\": true,\n \"updatedAt\": 1619188386033,\n \"createdAt\": 1618497575914,\n \"createdBy\": \"IChF0zAWZjY6KZwMyyBRWg7DRDw2\",\n \"standalone\": true,\n \"global\": false,\n \"presenceId\": \"3s85\",\n \"version\": \"V2\",\n \"mainChannelId\": \"6078502721a74f000815c667\",\n \"__v\": 0,\n \"reactionsEnabled\": true,\n \"updatedBy\": \"IChF0zAWZjY6KZwMyyBRWg7DRDw2\"\n }\n]"}],"_postman_id":"4406fb2b-b90c-4a86-bfe1-679a8ddff513"},{"name":"Get Chat Room By Id","id":"bf437f0d-2aa7-465f-9eda-52313fd7f8a9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","type":"text","value":"YOUR_API_KEY"},{"key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://api.arena.im/customers-v1/chat-rooms/{chatRoomId}","description":"Get a Chat Room object by id/slug.
\nParameter chatRoomId can be either the ID or Slug. For any other calls you must use only the ID.
Create a new Chat Room.
\nWhen a Chat Room is created one Channel is already created by default. Messages are sent to channels and one chat room can hold multiple channels.
\nRequest fields:
\nsiteId: [optional] Site ID where this chat room is being added to.
allowShareUrls: true|false. When enabled users will be able to post links to the chat room.
chatClosedIsEnabled: true|false. Create chat room in a Closed state where users won't be able to post messages.
chatPreModerationIsEnabled: true|false. Enable pre-moderation on the chat room.
chatRequestModeratorIsEnabled: true|false. When enabled any user can request to be a moderator.
privateChatIsEnabled: true|false. When enabled allow users to chat privately with one another.
chatPreviewEnabled: true|false. When disabled the public view hosted by Arena won't be accessible and iFrame embed code won't work.
profanityFilterType: none|replace|block. Automatic profanity filter type mode.
modLabelsPreference: ALL|CHANNEL, a enum informing how to chose who can be visible as moderator in this chatroom
ALL: All moderators will be visible
CHANNEL: Only moderator direct related to this chatroom will be visible
reactionsEnabled: true|false. Enables the love reaction button for each message.
signUpRequired: true|false. Forces users to sign up before they can send messages.
name: The name of the chat room.
chatColor: An optional valid hexadecimal custom color for the chat. Is required a # prefix.
directMessageOnlyForModerators : Optional boolean. When true will allow user to send direct message only to moderator.
chatSlowModeInterval: Optional integer. Require users to wait between sending messages. Minimum: 0 second. Maximum: 300 seconds.
hideOfflineModerators: Boolean ( true/ false ) [default: false]. If true, only online moderators will be visible in the user list.
Update Chat Room Information.
\nRequest fields:
\nallowShareUrls: true|false. When enabled users will be able to post links to the chat room.
chatClosedIsEnabled: true|false. Create chat room in a Closed state where users won't be able to post messages.
chatPreModerationIsEnabled: true|false. Enable pre-moderation on the chat room.
chatRequestModeratorIsEnabled: true|false. When enabled any user can request to be a moderator.
privateChatIsEnabled: true|false. When enabled allow users to chat privately with one another.
chatPreviewEnabled: true|false. When disabled the public view hosted by Arena won't be accessible and iFrame embed code won't work.
profanityFilterType: none|replace|block. Automatic profanity filter type mode.
reactionsEnabled: true|false. Enables the love reaction button for each message.
signUpRequired: true|false. Forces users to sign up before they can send messages.
name: The name of the chat room.
modLabelsPreference: ALL|CHANNEL, a enum informing how to chose who can be visible as moderator in this chatroom
ALL: All moderators will be visible
CHANNEL: Only moderator direct related to this chatroom will be visible
chatColor: An optional valid hexadecimal custom color for the chat. Is required a # prefix.
directMessageOnlyForModerators : Optional boolean. When true will allow user to send direct message only to moderator.
chatSlowModeInterval: Optional integer. Require users to wait between sending messages. Minimum: 0 second. Maximum: 300 seconds.
hideOfflineModerators: Boolean ( true/ false ) [default: false]. If true, only online moderators will be visible in the user list.
Response:
The updated chat room object.
Note: The API treats the request payload as a sparse update, you must pass only the fields that you want to update.
\n","urlObject":{"protocol":"https","path":["customers-v1","chat-rooms","{chatRoomId}"],"host":["api","arena","im"],"query":[],"variable":[]}},"response":[{"id":"6aa7c020-c9f1-4c4d-8832-988baa57f58b","name":"Update Chat Room","originalRequest":{"method":"POST","header":[{"key":"x-api-key","type":"text","value":"YOUR_API_KEY"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"allowShareUrls\": true,\n\t\"chatClosedIsEnabled\": false,\n \"chatPreModerationIsEnabled\": false,\n \"profanityFilterType\": \"none\",\n \"reactionsEnabled\": true,\n \"signUpRequired\": false,\n \"name\": \"Updated name from api\",\n \"chatColor\": \"#FFFFFF\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.arena.im/customers-v1/chat-rooms/{chatRoomId}"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"_id\": \"5eb05ec24351a000078adf0d\",\n \"streams\": [],\n \"name\": \"Updated name from api\",\n \"chatPreModerationIsEnabled\": false,\n \"chatClosedIsEnabled\": false,\n \"chatRequestModeratorIsEnabled\": true,\n \"allowShareUrls\": true,\n \"signUpRequired\": false,\n \"profanityFilterType\": \"\",\n \"slug\": \"27nt\",\n \"siteId\": \"IChF0zAWZjY6KZwMyyBRWg7DRDw2\",\n \"updatedAt\": 1627497851864,\n \"createdAt\": 1588616898941,\n \"createdBy\": \"system\",\n \"standalone\": true,\n \"global\": false,\n \"presenceId\": \"-M6VwXZTT3NvoFL9nFgc\",\n \"__v\": 0,\n \"updatedBy\": \"system\",\n \"allowSendGifs\": true,\n \"chatAutoOpen\": true,\n \"chatPreviewEnabled\": true,\n \"reactionsEnabled\": true,\n \"showOnlineUsersNumber\": true,\n \"signUpSettings\": {\n \"suggest\": true,\n \"type\": \"SIGN_UP_NOT_REQUIRED\"\n },\n \"lang\": \"en-us\",\n \"mainChannelId\": \"5f918b5ef4d39aa4b4d61b9c\",\n \"version\": \"V2\",\n \"reminderId\": null,\n \"language\": \"en-us\",\n \"id\": \"5eb05ec24351a000078adf0d\"\n}"}],"_postman_id":"cde78124-7ffb-4a65-8222-7268cfb52c5f"},{"name":"Delete Chat Room","id":"6694707d-39be-4338-bae1-3b8e6ede9a17","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"x-api-key","type":"text","value":"YOUR_API_KEY"},{"key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://api.arena.im/customers-v1/chat-rooms/{chatRoomId}","description":"Delete chat room and all messages.
\nNote: This operation is irreversible.
\n","urlObject":{"protocol":"https","path":["customers-v1","chat-rooms","{chatRoomId}"],"host":["api","arena","im"],"query":[],"variable":[]}},"response":[{"id":"b8cfa977-6319-4382-bf3e-20340b950136","name":"Delete Chat Room","originalRequest":{"method":"DELETE","header":[{"key":"x-api-key","type":"text","value":"YOUR_API_KEY"},{"key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://api.arena.im/customers-v1/chat-rooms/5eed2e5a5f9a819884d42ff0"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"success\": true\n}"}],"_postman_id":"6694707d-39be-4338-bae1-3b8e6ede9a17"},{"name":"Get Channels","id":"bb84de72-04da-4503-acbe-05a44bddbe71","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","type":"text","value":"YOUR_API_KEY"},{"key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://api.arena.im/customers-v1/chat-rooms/{chatRoomId}/channels","description":"Get all chat room Channels.
\n","urlObject":{"protocol":"https","path":["customers-v1","chat-rooms","{chatRoomId}","channels"],"host":["api","arena","im"],"query":[],"variable":[]}},"response":[{"id":"0092745a-a91a-44e1-9642-fd672741f4a9","name":"Get Chat Room Channels","originalRequest":{"method":"GET","header":[{"key":"x-api-key","type":"text","value":"YOUR_API_KEY"},{"key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://api.arena.im/customers-v1/chat-rooms/{chatRoomId}/channels"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"_id\": \"603a955af0aaae0007cbc620\",\n \"qnaIsEnabled\": false,\n \"showEmojiButton\": true,\n \"streams\": [],\n \"name\": \"{{chat.tabs.live_chat}}\",\n \"chatPreModerationIsEnabled\": false,\n \"chatRequestModeratorIsEnabled\": false,\n \"chatSlowModeInterval\": 10,\n \"allowSendGifs\": true,\n \"allowShareUrls\": true,\n \"profanityFilterType\": \"none\",\n \"siteId\": \"IChF0zAWZjY6KZwMyyBRWg7DRDw2\",\n \"chatRoomId\": \"603a955af0aaae0007cbc61f\",\n \"dataPath\": \"chat-rooms/603a955af0aaae0007cbc61f\",\n \"updatedAt\": 1616507723451,\n \"createdAt\": 1614452058170,\n \"createdBy\": \"system\",\n \"__v\": 0,\n \"hasPolls\": false,\n \"updatedBy\": \"system\"\n },\n {\n \"_id\": \"603a95dc1b8f5000072da12e\",\n \"qnaIsEnabled\": false,\n \"showEmojiButton\": true,\n \"streams\": [],\n \"name\": \"Channel 1\",\n \"chatPreModerationIsEnabled\": false,\n \"chatRequestModeratorIsEnabled\": false,\n \"chatSlowModeInterval\": 10,\n \"allowSendGifs\": true,\n \"allowShareUrls\": true,\n \"profanityFilterType\": \"none\",\n \"siteId\": \"IChF0zAWZjY6KZwMyyBRWg7DRDw2\",\n \"chatRoomId\": \"603a955af0aaae0007cbc61f\",\n \"dataPath\": \"chat-rooms/603a955af0aaae0007cbc61f/channels/603a95dc1b8f5000072da12e\",\n \"updatedAt\": 1616507723450,\n \"createdAt\": 1614452188487,\n \"createdBy\": \"system\",\n \"__v\": 0,\n \"hasPolls\": false,\n \"updatedBy\": \"system\"\n }\n]"}],"_postman_id":"bb84de72-04da-4503-acbe-05a44bddbe71"},{"name":"Get Channel By Id","id":"3c956de2-752f-4db8-83d4-18d773b9d9f0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","type":"text","value":"YOUR_API_KEY"},{"key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://api.arena.im/customers-v1/chat-rooms/{chatRoomId}/channels/{channelId}","description":"Get a Channel object by ID.
\n","urlObject":{"protocol":"https","path":["customers-v1","chat-rooms","{chatRoomId}","channels","{channelId}"],"host":["api","arena","im"],"query":[],"variable":[]}},"response":[{"id":"0848ff96-62ad-40b8-b698-04f6670db04a","name":"Get Channel By Id","originalRequest":{"method":"GET","header":[{"key":"x-api-key","type":"text","value":"qztNqwb5XA77VcofJ1eAv1bZYFrKlZOG95c49iuB"},{"key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://api.arena.im/customers-v1/chat-rooms/603a955af0aaae0007cbc61f/channels/api-channel-1"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"625"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Wed, 28 Jul 2021 19:51:41 GMT"},{"key":"x-amzn-RequestId","value":"c21b90d3-95b3-4c99-8659-b618017204db"},{"key":"x-amz-apigw-id","value":"DMlEKGAnPHcF_Fw="},{"key":"X-Amzn-Trace-Id","value":"Root=1-6101b54d-104b4ea77665797a5ba0c48c;Sampled=0"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 b97800dba63a54d15f1e69f88e3a1a3e.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"GRU1-C1"},{"key":"X-Amz-Cf-Id","value":"M9xV95oUuTDT6998LDwsZQ4Qimp2rPDfu4MdgQgG_HSl1Cskb6qMCw=="}],"cookie":[],"responseTime":null,"body":"{\n \"_id\": \"603a98a6740e7a000752be2f\",\n \"qnaIsEnabled\": true,\n \"showEmojiButton\": true,\n \"streams\": [],\n \"name\": \"Channel 2\",\n \"chatPreModerationIsEnabled\": false,\n \"chatRequestModeratorIsEnabled\": false,\n \"chatSlowModeInterval\": 10,\n \"allowSendGifs\": true,\n \"allowShareUrls\": true,\n \"profanityFilterType\": \"none\",\n \"siteId\": \"IChF0zAWZjY6KZwMyyBRWg7DRDw2\",\n \"chatRoomId\": \"603a955af0aaae0007cbc61f\",\n \"dataPath\": \"chat-rooms/603a955af0aaae0007cbc61f/channels/603a98a6740e7a000752be2f\",\n \"updatedAt\": 1623853025418,\n \"createdAt\": 1614452902417,\n \"createdBy\": \"system\",\n \"externalId\": \"api-channel-1\",\n \"__v\": 0,\n \"updatedBy\": \"system\",\n \"qnaId\": \"603a9e7bb281c80007e1d705\",\n \"hasPolls\": true\n}"}],"_postman_id":"3c956de2-752f-4db8-83d4-18d773b9d9f0"},{"name":"Create Channel","id":"19f6fbbb-0ddd-428e-bf59-282a32cf606d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-api-key","type":"text","value":"YOUR_API_KEY"},{"key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"allowShareUrls\": true,\n\t\"chatClosedIsEnabled\": false,\n \"chatPreModerationIsEnabled\": false,\n \"profanityFilterType\": \"none\",\n \"reactionsEnabled\": true,\n \"signUpRequired\": false,\n \"name\": \"CHANNEL NAME\"\n}"},"url":"https://api.arena.im/customers-v1/chat-rooms/{chatRoomId}/channels","description":"Create a new Channel for a Chat Room.
\nRequest fields:
\nchatRoomId: Chat Room where this chat room is being added to.
externalId: Optional ID to match with your system.
allowSendGifs: true|false. When enabled the GIF button will be displayed.
allowShareUrls: true|false. When enabled users will be able to post links to the chat room.
chatPreModerationIsEnabled: true|false. Enable pre-moderation on the chat room.
profanityFilterType: none|replace|block. Automatic profanity filter type mode.
reactionsEnabled: true|false. Enables the love reaction button for each message.
qnaIsEnabled: true|false. When enabled, a Q&A session will be created for this channel.
showEmojiButton: true|false. Show/hide the Emoji button keyboard on Desktop.
name: The name of the channel. Maximum of 18 chars recommended. Use {{chat.tabs.live_chat}} to use the translated \"Live Chat\" term.
Update Channel information.
\nRequest fields:
\nallowSendGifs: true|false. When enabled the GIF button will be displayed.
allowShareUrls: true|false. When enabled users will be able to post links to the chat room.
chatPreModerationIsEnabled: true|false. Enable pre-moderation on the chat room.
profanityFilterType: none|replace|block. Automatic profanity filter type mode.
reactionsEnabled: true|false. Enables the love reaction button for each message.
qnaIsEnabled: true|false. When enabled, a Q&A session will be created for this channel.
showEmojiButton: true|false. Show/hide the Emoji button keyboard on Desktop.
name: The name of the channel. Maximum of 18 chars recommended. Use {{chat.tabs.live_chat}} to use the translated \"Live Chat\" term.
Delete channel and all messages.
\nNote: This operation is irreversible.
\n","urlObject":{"protocol":"https","path":["customers-v1","chat-rooms","{chatRoomId}","channels","{channelId}"],"host":["api","arena","im"],"query":[],"variable":[]}},"response":[{"id":"614c3752-4ba1-4cad-a366-4b644e4d1f5e","name":"Delete Channel","originalRequest":{"method":"DELETE","header":[{"key":"x-api-key","type":"text","value":"YOUR_API_KEY"},{"key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://api.arena.im/customers-v1/chat-rooms/603a955af0aaae0007cbc61f/channels/api-channel-1"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"success\": true\n}"}],"_postman_id":"b698cd37-edbb-4227-b2a7-335dda1e613d"},{"name":"Get Channel Messages","id":"de91c459-de3b-4aba-82fb-773b12fb1ce4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","type":"text","value":"YOUR_API_KEY"},{"key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://api.arena.im/customers-v1/chat-rooms/{chatRoomId}/channels/{channelId}/messages?limit=10&startIndex=0&startAt=0&startAfter=0&endAt=0&endBefore=0","description":"Retrieve the messages from the channel with the most recent appearing first.
\nMain properties for the chat room message object:
\nmessage.text: The text message sent by the user
message.sender: Information about the message author
Total messages to retrieve. Default: 20. Max: 500.
\n","type":"text/plain"},"key":"limit","value":"10"},{"description":{"content":"Optinal, (number, offset starting from 0) -- number of results to skip
\n","type":"text/plain"},"key":"startIndex","value":"0"},{"description":{"content":"Optional, (number, unix timestamp in ms) -- start from record matching value
\n","type":"text/plain"},"key":"startAt","value":"0"},{"description":{"content":"Optional, (number, unix timestamp in ms) -- start from record after this value
\n","type":"text/plain"},"key":"startAfter","value":"0"},{"description":{"content":"Optional, (number, unix timestamp in ms) -- end to record matching value
\n","type":"text/plain"},"key":"endAt","value":"0"},{"description":{"content":"Optional, (number, unix timestamp in ms) -- end to record before this value
\n","type":"text/plain"},"key":"endBefore","value":"0"}],"variable":[]}},"response":[{"id":"e4734993-cacb-4eec-862b-5612c011119d","name":"Get Channel Messages","originalRequest":{"method":"GET","header":[{"key":"x-api-key","type":"text","value":"YOUR_API_KEY"},{"key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":{"raw":"https://api.arena.im/customers-v1/chat-rooms/603a955af0aaae0007cbc61f/channels/603a955af0aaae0007cbc620/messages?limit=10","protocol":"https","host":["api","arena","im"],"path":["customers-v1","chat-rooms","603a955af0aaae0007cbc61f","channels","603a955af0aaae0007cbc620","messages"],"query":[{"key":"limit","value":"10","description":"Total messages to retrieve. Default: 20. Max: 500."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"1141"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Wed, 28 Jul 2021 19:55:10 GMT"},{"key":"x-amzn-RequestId","value":"12a0f3ca-e69d-4662-a715-d4eb60db3117"},{"key":"x-amz-apigw-id","value":"DMlkWG1oPHcF_fw="},{"key":"X-Amzn-Trace-Id","value":"Root=1-6101b61b-129e39953c74123e4e84bd0f;Sampled=0"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 b97800dba63a54d15f1e69f88e3a1a3e.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"GRU1-C1"},{"key":"X-Amz-Cf-Id","value":"hPhH42Aw-kiwiKfPp9mR1DmEuhkdwopQWmDz36GtZmvU9iCSM-1IMQ=="}],"cookie":[],"responseTime":null,"body":"{\n \"messages\": [\n {\n \"key\": \"UCO8vnmP6roGzJZe0gwl\",\n \"createdAt\": 1614452234151,\n \"sender\": {\n \"uid\": \"IChF0zAWZjY6KZwMyyBRWg7DRDw2\",\n \"displayName\": \"Rodrigo Reis\",\n \"photoURL\": \"https://firebasestorage.googleapis.com/v0/b/arena-dev-f9045.appspot.com/o/images%2F0dabede391a0fe9d1df498804cf9f40b.jpg?alt=media&token=4c018d92-91ed-4620-8b0a-96f503cc70ec\",\n \"providerId\": \"IChF0zAWZjY6KZwMyyBRWg7DRDw2\"\n },\n \"message\": {\n \"text\": \"hey there\"\n }\n },\n {\n \"message\": {\n \"text\": \"main channel\"\n },\n \"key\": \"fEoNsZase6tWh4udub6Z\",\n \"sender\": {\n \"uid\": \"IChF0zAWZjY6KZwMyyBRWg7DRDw2\",\n \"displayName\": \"Rodrigo Reis\",\n \"providerId\": \"IChF0zAWZjY6KZwMyyBRWg7DRDw2\",\n \"photoURL\": \"https://firebasestorage.googleapis.com/v0/b/arena-dev-f9045.appspot.com/o/images%2F0dabede391a0fe9d1df498804cf9f40b.jpg?alt=media&token=4c018d92-91ed-4620-8b0a-96f503cc70ec\"\n },\n \"createdAt\": 1614452236933\n },\n {\n \"key\": \"mtDsHWsxafv3ZHdERK2W\",\n \"message\": {\n \"text\": \"whats up\"\n },\n \"sender\": {\n \"photoURL\": \"http://stnfy-imgs.s3-website-us-east-1.amazonaws.com/users/alexandra_boylan_user_200x200_v1.jpg\",\n \"displayName\": \"Alexandra Boylan\",\n \"uid\": \"52e1a094e4b0ad8370bccc5e\"\n },\n \"createdAt\": 1623867629462,\n \"userId\": \"52e1a094e4b0ad8370bccc5e\"\n }\n ],\n \"pagination\": {\n \"total\": 3\n }\n}"}],"_postman_id":"de91c459-de3b-4aba-82fb-773b12fb1ce4"},{"name":"Delete Channel Message","id":"fe41d0d1-722e-4eb6-8a78-749901f78050","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"x-api-key","type":"text","value":"YOUR_API_KEY"},{"key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://api.arena.im/customers-v1/chat-rooms/{chatRoomId}/channels/{channelId}/messages/{messageId}","description":"Delete a channel message.
\n","urlObject":{"protocol":"https","path":["customers-v1","chat-rooms","{chatRoomId}","channels","{channelId}","messages","{messageId}"],"host":["api","arena","im"],"query":[],"variable":[]}},"response":[{"id":"988df9a7-1fd3-4470-8d7c-09205ddf5519","name":"Delete Channel Pre-Moderation Message","originalRequest":{"method":"GET","header":[{"key":"x-api-key","type":"text","value":"YOUR_API_KEY"},{"key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://api.arena.im/customers-v1/chat-rooms/{chatRoomId}/channels/{channelId}/messages/{messageId}"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"true"}],"_postman_id":"fe41d0d1-722e-4eb6-8a78-749901f78050"},{"name":"Get Channel Pre-Moderation Messages","id":"ec236cd2-5836-45e2-9331-7ff3e832039f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","type":"text","value":"YOUR_API_KEY"},{"key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://api.arena.im/customers-v1/chat-rooms/{chatRoomId}/channels/{channelId}/messages?limit=10","description":"Retrieve the pre-moderation messages from the channel with the most recent appearing first.
\nMain properties for the channel message object:
\nmessage.text: The text message sent by the user
message.sender: Information about the message author
message.key: Message id used to approved or reject message
Total messages to retrieve. Default: 20. Max: 500.
\n","type":"text/plain"},"key":"limit","value":"10"}],"variable":[]}},"response":[{"id":"4c988ec5-8b4e-4807-b20c-f15ee1080e9c","name":"Get Channel Pre-Moderation Messages","originalRequest":{"method":"GET","header":[{"key":"x-api-key","type":"text","value":"YOUR_API_KEY"},{"key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":{"raw":"https://api.arena.im/customers-v1/chat-rooms/{chatRoomId}/channels/{channelId}/messages?limit=10","protocol":"https","host":["api","arena","im"],"path":["customers-v1","chat-rooms","{chatRoomId}","channels","{channelId}","messages"],"query":[{"key":"limit","value":"10","description":"Total messages to retrieve. Default: 20. Max: 500."}]}},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"messages\": [\n {\n \"sender\": {\n \"userName\": \"thadeu@arena.im\",\n \"uid\": \"5f96c98ea503040008620e5e\",\n \"photoURL\": \"https://stationfy.imgix.net/cache/1603717518328-1./a-/AOh14GhHGvP9VZpgHIrCShHziFeQDdRVAC3G2LGNFf9Y=s96-c\",\n \"providerId\": \"101394667381093829510\",\n \"displayName\": \"Thadeu Tucci\"\n },\n \"key\": \"8tfvSnX50VhxhWxb5ZZS\",\n \"createdAt\": 1623789582784,\n \"message\": {\n \"text\": \"Hi!\"\n }\n }\n ],\n \"pagination\": {\n \"total\": 1\n }\n}"}],"_postman_id":"ec236cd2-5836-45e2-9331-7ff3e832039f"},{"name":"Approve Channel Pre-Moderation Message","id":"787e0442-f006-4977-ae86-be55730961f8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-api-key","type":"text","value":"YOUR_API_KEY"},{"key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://api.arena.im/customers-v1/chat-rooms/{chatRoomId}/channels/{channelId}/pre-moderation/{messageId}","description":"Approve a message in the pre-moderation queue. After approval the message will be posted to the public channel.
\n","urlObject":{"protocol":"https","path":["customers-v1","chat-rooms","{chatRoomId}","channels","{channelId}","pre-moderation","{messageId}"],"host":["api","arena","im"],"query":[],"variable":[]}},"response":[{"id":"6a4e45d0-2559-430a-b27f-3a347c6ba2a3","name":"Approve Channel Pre-Moderation Message","originalRequest":{"method":"GET","header":[{"key":"x-api-key","type":"text","value":"YOUR_API_KEY"},{"key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://api.arena.im/customers-v1/chat-rooms/{chatRoomId}/channels/{channelId}/pre-moderation"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"true"}],"_postman_id":"787e0442-f006-4977-ae86-be55730961f8"},{"name":"Delete Channel Pre-Moderation Message","id":"49955fc2-5349-4792-bd88-1a562a4c7774","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"x-api-key","type":"text","value":"YOUR_API_KEY"},{"key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://api.arena.im/customers-v1/chat-rooms/{chatRoomId}/channels/{channelId}/pre-moderation/{messageId}","description":"Delete a channel pre-moderation message.
\n","urlObject":{"protocol":"https","path":["customers-v1","chat-rooms","{chatRoomId}","channels","{channelId}","pre-moderation","{messageId}"],"host":["api","arena","im"],"query":[],"variable":[]}},"response":[{"id":"b375e892-d50e-47a8-b513-9f4dc57af36e","name":"Delete Channel Pre-Moderation Message","originalRequest":{"method":"GET","header":[{"key":"x-api-key","type":"text","value":"YOUR_API_KEY"},{"key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://api.arena.im/customers-v1/chat-rooms/{chatRoomId}/channels/{channelId}/pre-moderation/{messageId}"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"true"}],"_postman_id":"49955fc2-5349-4792-bd88-1a562a4c7774"},{"name":"Get Reports","id":"78ef04a0-ec7b-443a-9afd-99b0ef3431e6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","type":"text","value":"YOUR_API_KEY"},{"key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://api.arena.im/customers-v1/chat-rooms/{chatRoomId}/channels/{channelId}/reports","description":"Get channel reported messages
\n","urlObject":{"protocol":"https","path":["customers-v1","chat-rooms","{chatRoomId}","channels","{channelId}","reports"],"host":["api","arena","im"],"query":[],"variable":[]}},"response":[{"id":"456b8937-e7f6-4922-a5f1-c33409f0651d","name":"Get Reports","originalRequest":{"method":"GET","header":[{"key":"x-api-key","type":"text","value":"YOUR_API_KEY"},{"key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://api.arena.im/customers-v1/chat-rooms/{chatRoomId}/channels/{channelId}/reports"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"messages\": [\n {\n \"createdAt\": 1623812733690,\n \"message\": {\n \"message\": {\n \"text\": \"Hi!\"\n },\n \"createdAt\": 1623790628398,\n \"key\": \"8tfvSnX50VhxhWxb5ZZS\",\n \"referer\": \"https://sandbox.arena.im/\",\n \"sender\": {\n \"photoURL\": \"https://stationfy.imgix.net/cache/1603717518328-1./a-/AOh14GhHGvP9VZpgHIrCShHziFeQDdRVAC3G2LGNFf9Y=s96-c\",\n \"userName\": \"thadeu@arena.im\",\n \"displayName\": \"Thadeu Knychala Tucci\",\n \"uid\": \"5f96c98ea503040008620e5e\",\n \"providerId\": \"101394667381093829510\"\n },\n },\n \"reportedBy\": [\n {\n \"uid\": \"{userId}\"\n }\n ]\n }\n ],\n \"pagination\": {\n \"total\": 1\n }\n}"}],"_postman_id":"78ef04a0-ec7b-443a-9afd-99b0ef3431e6"},{"name":"Create Report","id":"f0f63bf7-d66e-4956-86b7-4f958599b183","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-api-key","type":"text","value":"YOUR_API_KEY"},{"key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"userId\": \"[USER_ID]\",\n \"messageId\": \"[MESSAGE_ID]\"\n}"},"url":"https://api.arena.im/customers-v1/chat-rooms/{chatRoomId}/channels/{channelId}/reports","description":"Report channel message.
\nuserId (required) Id of the user reporting
messageId(required)
Deletes the report. To delete the message use Delete Channel Message
Export the channel messages in a CSV/JSON format.
\nThe API returns a signed url that can be used to download the file. It expires in 2 hours.
\nParameters:
\nformat: json|csv
\n","urlObject":{"protocol":"https","path":["customers-v1","chat-rooms","{chatRoomId}","channels","{channelId}","messages","{format}"],"host":["api","arena","im"],"query":[],"variable":[]}},"response":[],"_postman_id":"40ea9eb0-b809-433f-bb72-7ed2f7d959fb"},{"name":"Export Channel Messages CSV [deprecated]","id":"39e104be-d9d6-49a7-b6d8-db2aeb8802ab","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","type":"text","value":"YOUR_API_KEY"},{"key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://api.arena.im/customers-v1/chat-rooms/{chatRoomId}/channels/{channelId}/messages-csv","description":"Export the channel messages in a CSV format.
\nThe API returns a signed url that can be used to download the CSV file. It expires in 2 hours.
\n","urlObject":{"protocol":"https","path":["customers-v1","chat-rooms","{chatRoomId}","channels","{channelId}","messages-csv"],"host":["api","arena","im"],"query":[],"variable":[]}},"response":[],"_postman_id":"39e104be-d9d6-49a7-b6d8-db2aeb8802ab"},{"name":"Get Chat Room Messages [deprecated]","id":"eaa0d692-2c14-4945-be24-b0791fa9a645","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","type":"text","value":"YOUR_API_KEY"},{"key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://api.arena.im/customers-v1/chat-rooms/{chatRoomId}/messages?limit=10","description":"Note: with our transition to a Channels model, this endpoint is now deprecated.
\nRetrieve the messages from the chat room with the most recent appearing first.
\nMain properties for the chat room message object:
\nmessage.text: The text message sent by the user
message.sender: Information about the message author
Total messages to retrieve. Default: 20. Max: 500.
\n","type":"text/plain"},"key":"limit","value":"10"}],"variable":[]}},"response":[],"_postman_id":"eaa0d692-2c14-4945-be24-b0791fa9a645"},{"name":"Send Chat Message [deprecated]","id":"32a65e51-72e6-4d29-b81c-b5fc628a93f9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-api-key","type":"text","value":"YOUR_API_KEY"},{"key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"message\": {\n\t\t\"text\": \"hello all\"\n\t},\n\t\"sender\": {\n\t\t\"displayName\": \"rodrigofb\",\n\t\t\"name\": \"Rodrigo\",\n\t\t\"photoURL\": \"http://stationfy.imgix.net/cache/1474323335150-3.jpg\",\n\t\t\"uid\": \"57e06304429b4d0100be4a55\"\n\t}\n}"},"url":"https://api.arena.im/customers-v1/chat-rooms/{chatRoomId}/messages","description":"Note: with our transition to a Channels model, this endpoint is now deprecated.
\nSend a message to the chat room.
\nRequest fields:
\nmessage.text: contains the actual text that will be published.
sender.displayName: Sender's user name. Ex: johnd
sender.name: Sender's full name. Ex: John Doe
sender.photoURL: Sender's image
sender.uid: Sender's user id
Note: with our transition to a Channels model, this endpoint is now deprecated.
\nDelete a chat message.
\nRequest fields:
\npreModeration: true|false. Inform true when the message is still in the pre-moderation queue.
Note: with our transition to a Channels model, this endpoint is now deprecated.
\nApprove a message in the pre-moderation queue. After approval the message will be posted to the public chat room.
\n","urlObject":{"protocol":"https","path":["customers-v1","chat-rooms","{chatRoomId}","messages","{messageId}"],"host":["api","arena","im"],"query":[],"variable":[]}},"response":[],"_postman_id":"4f4edba5-b507-4ebd-8071-1294f75890bf"},{"name":"Export ChatRoom analytics data","id":"33da18a3-974c-4fa8-ab8f-131dc98ac306","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","value":"YOUR_API_KEY","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://api.arena.im/customers-v1/chat-rooms/{chatRoomId}/analytics?format=csv","description":"Export analytics data for a given chatRoomId
\nRequest fields:
\nchatRoomId: The id of the chatRoom.
format: (optional) the format for the final file. The default format is json. Accepted values: json, csv
(optional) File format, json or csv. default=json
\n","type":"text/plain"},"key":"format","value":"csv"}],"variable":[]}},"response":[{"id":"a0cf26b4-b70c-4857-8567-84611e0ddd43","name":"Export ChatRoom analytics data","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"YOUR_API_KEY","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"https://api.arena.im/customers-v1/chat-rooms/{chatRoomId}/analytics?format=csv","protocol":"https","host":["api","arena","im"],"path":["customers-v1","chat-rooms","{chatRoomId}","analytics"],"query":[{"key":"format","value":"csv","description":"(optional) File format, json or csv. default=json"}]}},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"fileUrl\": \"https://signed-url-to-download-the-generaed-file\"\n}"}],"_postman_id":"33da18a3-974c-4fa8-ab8f-131dc98ac306"},{"name":"Bulk archive Chat messages","id":"a4267344-76e3-420a-9a40-6aacef05f67e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"x-api-key","value":"YOUR_API_KEY","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://api.arena.im/customers-v1/chat-rooms/[chatRoomSlug]/channels/[channelId]/messages","description":"This endpoint will archive all messages in a Channel and return a string with the URL to download the messages file.
\nRequest fields:
\nchatRoomSlug The slug of chatroom that contains the ChannelchannelId The id of the Channel to archive the messages. This field doesn’t accept a slug.Get the page views history, aggregated by day.
\nData is sliced by page type (Liveblog, Chat Room, Content Wall) and device (mobile or desktop).
\n","urlObject":{"protocol":"https","path":["customers-v1","pageviews"],"host":["api","arena","im"],"query":[{"description":{"content":"Start date range (must be ISO Format)
\n","type":"text/plain"},"key":"start","value":"2019-03-01T00:00:00Z"},{"description":{"content":"End date range (must be ISO Format)
\n","type":"text/plain"},"key":"end","value":"2019-03-31T00:00:00Z"},{"description":{"content":"The id os the Site. This endpoints will not accept Site slug as ID.
\n","type":"text/plain"},"key":"siteId","value":"the_id_of_the_site"}],"variable":[]}},"response":[{"id":"bf1f1516-0bbf-441c-a4b3-3b9722af0dc3","name":"Get Page Views","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"YOUR_API_KEY","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"https://api.arena.im/customers-v1/pageviews?start=2019-03-01T00:00:00Z&end=2019-03-03T00:00:00Z","protocol":"https","host":["api","arena","im"],"path":["customers-v1","pageviews"],"query":[{"key":"start","value":"2019-03-01T00:00:00Z","description":"Start date range (must be ISO Format)"},{"key":"end","value":"2019-03-03T00:00:00Z","description":"End date range (must be ISO Format)"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"[{\n\t\"date\": \"2019-04-01T00:00:00.000Z\",\n\t\"is_mobile\": \"false\",\n\t\"widget_type\": \"Content Wall\",\n\t\"count\": \"2\"\n}, {\n\t\"date\": \"2019-04-01T00:00:00.000Z\",\n\t\"is_mobile\": \"false\",\n\t\"widget_type\": \"Liveblog\",\n\t\"count\": \"25\"\n}, {\n\t\"date\": \"2019-04-01T00:00:00.000Z\",\n\t\"is_mobile\": \"true\",\n\t\"widget_type\": \"Content Wall\",\n\t\"count\": \"1\"\n}, {\n\t\"date\": \"2019-04-01T00:00:00.000Z\",\n\t\"is_mobile\": \"true\",\n\t\"widget_type\": \"Liveblog\",\n\t\"count\": \"16\"\n}, {\n\t\"date\": \"2019-04-02T00:00:00.000Z\",\n\t\"is_mobile\": \"false\",\n\t\"widget_type\": \"Content Wall\",\n\t\"count\": \"3\"\n}, {\n\t\"date\": \"2019-04-02T00:00:00.000Z\",\n\t\"is_mobile\": \"false\",\n\t\"widget_type\": \"Liveblog\",\n\t\"count\": \"6\"\n}, {\n\t\"date\": \"2019-04-02T00:00:00.000Z\",\n\t\"is_mobile\": \"true\",\n\t\"widget_type\": \"Content Wall\",\n\t\"count\": \"2\"\n}, {\n\t\"date\": \"2019-04-03T00:00:00.000Z\",\n\t\"is_mobile\": \"false\",\n\t\"widget_type\": \"Content Wall\",\n\t\"count\": \"5\"\n}, {\n\t\"date\": \"2019-04-03T00:00:00.000Z\",\n\t\"is_mobile\": \"false\",\n\t\"widget_type\": \"Liveblog\",\n\t\"count\": \"3\"\n}, {\n\t\"date\": \"2019-04-08T00:00:00.000Z\",\n\t\"is_mobile\": \"false\",\n\t\"widget_type\": \"Liveblog\",\n\t\"count\": \"2\"\n}, {\n\t\"date\": \"2019-04-08T00:00:00.000Z\",\n\t\"is_mobile\": \"true\",\n\t\"widget_type\": \"Content Wall\",\n\t\"count\": \"1\"\n}, {\n\t\"date\": \"2019-04-12T00:00:00.000Z\",\n\t\"is_mobile\": \"false\",\n\t\"widget_type\": \"Liveblog\",\n\t\"count\": \"1\"\n}, {\n\t\"date\": \"2019-04-13T00:00:00.000Z\",\n\t\"is_mobile\": \"false\",\n\t\"widget_type\": \"Content Wall\",\n\t\"count\": \"1\"\n}, {\n\t\"date\": \"2019-04-23T00:00:00.000Z\",\n\t\"is_mobile\": \"false\",\n\t\"widget_type\": \"Liveblog\",\n\t\"count\": \"1\"\n}, {\n\t\"date\": \"2019-04-24T00:00:00.000Z\",\n\t\"is_mobile\": \"false\",\n\t\"widget_type\": \"Soccer Match Timeline\",\n\t\"count\": \"10\"\n}, {\n\t\"date\": \"2019-04-24T00:00:00.000Z\",\n\t\"is_mobile\": \"true\",\n\t\"widget_type\": \"Soccer Match Timeline\",\n\t\"count\": \"2\"\n}, {\n\t\"date\": \"2019-04-25T00:00:00.000Z\",\n\t\"is_mobile\": \"false\",\n\t\"widget_type\": \"Soccer Match Timeline\",\n\t\"count\": \"6\"\n}, {\n\t\"date\": \"2019-04-26T00:00:00.000Z\",\n\t\"is_mobile\": \"false\",\n\t\"widget_type\": \"Content Wall\",\n\t\"count\": \"2\"\n}, {\n\t\"date\": \"2019-04-26T00:00:00.000Z\",\n\t\"is_mobile\": \"false\",\n\t\"widget_type\": \"Soccer Match Timeline\",\n\t\"count\": \"2\"\n}, {\n\t\"date\": \"2019-04-26T00:00:00.000Z\",\n\t\"is_mobile\": \"true\",\n\t\"widget_type\": \"Chat Room\",\n\t\"count\": \"3\"\n}, {\n\t\"date\": \"2019-04-26T00:00:00.000Z\",\n\t\"is_mobile\": \"true\",\n\t\"widget_type\": \"Soccer Match Timeline\",\n\t\"count\": \"3\"\n}]"}],"_postman_id":"1f323021-b79c-4329-8fc0-eaf1d3e17757"}],"id":"1ff1c71a-db60-4cd5-9a29-c4c57cb438a4","_postman_id":"1ff1c71a-db60-4cd5-9a29-c4c57cb438a4","description":""},{"name":"Account","item":[{"name":"Get Organizations","id":"27ba37d8-522f-4535-bd9a-9a11b60689fd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","type":"text","value":"YOUR_API_KEY"},{"key":"Content-Type","type":"text","value":"application/json"}],"url":"https://api.arena.im/customers-v1/organizations","description":"Retrieve a list of Organizations for the account.
\nThe acccount hierarchy is: Account > Organization > Site
\n","urlObject":{"protocol":"https","path":["customers-v1","organizations"],"host":["api","arena","im"],"query":[],"variable":[]}},"response":[{"id":"e4b2ecd0-b15c-4716-a0fd-cc88a99bba04","name":"Get Organizations","originalRequest":{"method":"GET","header":[{"key":"x-api-key","type":"text","value":"YOUR_API_KEY"},{"key":"Content-Type","type":"text","value":"application/json"}],"url":"https://api.arena.im/customers-v1/organizations"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"213"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Wed, 28 Jul 2021 19:44:09 GMT"},{"key":"x-amzn-RequestId","value":"9001975b-b0a3-40ad-8f81-9e28e17c6377"},{"key":"x-amz-apigw-id","value":"DMj9bEU4vHcFscw="},{"key":"X-Amzn-Trace-Id","value":"Root=1-6101b388-2c580e063959064d12b6ab4b;Sampled=0"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 a9099ea1e29fa928ad562a5af3831b88.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"GRU3-C2"},{"key":"X-Amz-Cf-Id","value":"iftZ_KaWA3a6oLB_JTdqvJFQIURw3c4KrOSH9jpNJXryUJdPfqUr-w=="}],"cookie":[],"responseTime":null,"body":"[\n {\n \"_id\": \"IChF0zAWZjY6KZwMyyBRWg7DRDw2\",\n \"__v\": 0,\n \"name\": \"Rodrigo PnP\",\n \"account\": \"5c4af8a261fb4909d41bc84f\"\n },\n {\n \"_id\": \"6101a68f9e8ebf000919308b\",\n \"account\": \"5c4af8a261fb4909d41bc84f\",\n \"name\": \"New Site From Api\",\n \"__v\": 0\n }\n]"}],"_postman_id":"27ba37d8-522f-4535-bd9a-9a11b60689fd"},{"name":"Create Organization","id":"59197444-0f21-4c23-b266-e0081d37b413","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-api-key","type":"text","value":"YOUR_API_KEY"},{"key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"name\": \"ORGANIZATION NAME\"\n}"},"url":"https://api.arena.im/customers-v1/organizations","description":"Create a new site under this account.
\nThis endpoint is available only for Enterprise customers.
\nRequest fields:
\nimage: Site logo or avatar.
name: (required) Site name
organizationId: (required) Parent organization for this site. Use GET /organizations to fetch all account organizations.
siteUrl: Site domain where widgets will be embedded. No wildcards (*.foo.bar) and no https or http.
whiteListDomains: Additional domains where the widgets will be embedded.
For siteUrl and whiteListDomains don't pass wildcards (*.site.com) and don't pass https:// or http://, inform just the raw domain: site.com or subdomain.site.com.
For each valid domain we already consider the www. and m. subdomains as valid ones.
\n","urlObject":{"protocol":"https","path":["customers-v1","organizations"],"host":["api","arena","im"],"query":[],"variable":[]}},"response":[{"id":"df4adfc9-1520-4165-87ce-db8dcc3e1a31","name":"Create Organization","originalRequest":{"method":"POST","header":[{"key":"x-api-key","type":"text","value":"YOUR_API_KEY"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"name\": \"New Organization From Api\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.arena.im/customers-v1/organizations"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"106"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Wed, 28 Jul 2021 19:45:11 GMT"},{"key":"x-amzn-RequestId","value":"26c3eba4-42b3-4102-ab89-e35df167c0c2"},{"key":"x-amz-apigw-id","value":"DMkHGEiOPHcFtRA="},{"key":"X-Amzn-Trace-Id","value":"Root=1-6101b3c6-0034b73a77eafef9068218eb;Sampled=0"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 a9099ea1e29fa928ad562a5af3831b88.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"GRU3-C2"},{"key":"X-Amz-Cf-Id","value":"AVWxAZAo-qX-Yu3egm3TIP7bth9wUihdIwXdGv9w6a5ZlCt3t9EpvA=="}],"cookie":[],"responseTime":null,"body":"{\n \"account\": \"5c4af8a261fb4909d41bc84f\",\n \"name\": \"New Organization From Api\",\n \"_id\": \"6101b3c66146f80008e3f232\",\n \"__v\": 0\n}"}],"_postman_id":"59197444-0f21-4c23-b266-e0081d37b413"},{"name":"Update Organization","id":"ff9a4f2d-983c-45ed-bea8-87eed11a3036","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-api-key","type":"text","value":"YOUR_API_KEY"},{"key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"name\": \"Updated Organization From Api\"\n}"},"url":"https://api.arena.im/customers-v1/organizations/{organizationId}","description":"Create a new site under this account.
\nThis endpoint is available only for Enterprise customers.
\nRequest fields:
\nimage: Site logo or avatar.
name: (required) Site name
organizationId: (required) Parent organization for this site. Use GET /organizations to fetch all account organizations.
siteUrl: Site domain where widgets will be embedded. No wildcards (*.foo.bar) and no https or http.
whiteListDomains: Additional domains where the widgets will be embedded.
For siteUrl and whiteListDomains don't pass wildcards (*.site.com) and don't pass https:// or http://, inform just the raw domain: site.com or subdomain.site.com.
For each valid domain we already consider the www. and m. subdomains as valid ones.
\n","urlObject":{"protocol":"https","path":["customers-v1","organizations","{organizationId}"],"host":["api","arena","im"],"query":[],"variable":[]}},"response":[{"id":"1c10adeb-9789-4ad8-953a-3ca95a62074b","name":"Update Organization","originalRequest":{"method":"POST","header":[{"key":"x-api-key","type":"text","value":"YOUR_API_KEY"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"name\": \"Updated Organization From Api\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.arena.im/customers-v1/organizations/6101a68f9e8ebf000919308b"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"118"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Wed, 28 Jul 2021 19:44:18 GMT"},{"key":"x-amzn-RequestId","value":"d2f26eab-79e8-414e-91af-53ab3379a235"},{"key":"x-amz-apigw-id","value":"DMj-6EF8PHcFXNw="},{"key":"X-Amzn-Trace-Id","value":"Root=1-6101b392-33af320821fd9135148ddcf9;Sampled=0"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 a9099ea1e29fa928ad562a5af3831b88.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"GRU3-C2"},{"key":"X-Amz-Cf-Id","value":"rtcuBtczXj-7MgXmlMOrukmIItl7VSX-NZc6I9uHKPvokBFZ3J8eyg=="}],"cookie":[],"responseTime":null,"body":"{\n \"_id\": \"6101a68f9e8ebf000919308b\",\n \"account\": \"5c4af8a261fb4909d41bc84f\",\n \"name\": \"Updated Organization From Api\",\n \"__v\": 0\n}"}],"_postman_id":"ff9a4f2d-983c-45ed-bea8-87eed11a3036"},{"name":"Delete Organization","id":"b0004495-7334-4949-9fd2-ff5ea986b529","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"x-api-key","type":"text","value":"YOUR_API_KEY"},{"key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://api.arena.im/customers-v1/organizations/{organizationId}","description":"Create a new site under this account.
\nThis endpoint is available only for Enterprise customers.
\nRequest fields:
\nimage: Site logo or avatar.
name: (required) Site name
organizationId: (required) Parent organization for this site. Use GET /organizations to fetch all account organizations.
siteUrl: Site domain where widgets will be embedded. No wildcards (*.foo.bar) and no https or http.
whiteListDomains: Additional domains where the widgets will be embedded.
For siteUrl and whiteListDomains don't pass wildcards (*.site.com) and don't pass https:// or http://, inform just the raw domain: site.com or subdomain.site.com.
For each valid domain we already consider the www. and m. subdomains as valid ones.
\n","urlObject":{"protocol":"https","path":["customers-v1","organizations","{organizationId}"],"host":["api","arena","im"],"query":[],"variable":[]}},"response":[{"id":"b03cd6dd-aa89-4486-a4fe-2f4253bebbf9","name":"Delete Organization","originalRequest":{"method":"DELETE","header":[{"key":"x-api-key","type":"text","value":"YOUR_API_KEY"},{"key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://api.arena.im/customers-v1/organizations/5c4af8a261fb4909d41bc84f"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"16"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Wed, 28 Jul 2021 19:45:39 GMT"},{"key":"x-amzn-RequestId","value":"83d40a3a-2c07-4fb8-8e3c-a7f7aeb361e3"},{"key":"x-amz-apigw-id","value":"DMkLkE77PHcFvgQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-6101b3e3-58f18a9b1b5950f92789bef7;Sampled=0"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 a9099ea1e29fa928ad562a5af3831b88.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"GRU3-C2"},{"key":"X-Amz-Cf-Id","value":"mNKqtoXDOpz0-og4cLdRa2FYC0mIjzoOKAlnosFgaKSIbOuJkoOuRw=="}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true\n}"}],"_postman_id":"b0004495-7334-4949-9fd2-ff5ea986b529"},{"name":"Get Sites","id":"226a4b27-cff8-4479-bf2c-395281d3746a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","type":"text","value":"YOUR_API_KEY"},{"key":"Content-Type","type":"text","value":"application/json"}],"url":"https://api.arena.im/customers-v1/sites","description":"Retrieve a list of Sites for the account.
\n","urlObject":{"protocol":"https","path":["customers-v1","sites"],"host":["api","arena","im"],"query":[],"variable":[]}},"response":[{"id":"a4d248ae-c67f-4b4d-81ff-34cef7af30e7","name":"Get Sites","originalRequest":{"method":"GET","header":[{"key":"x-api-key","type":"text","value":"YOUR_API_KEY"},{"key":"Content-Type","type":"text","value":"application/json"}],"url":"https://api.arena.im/customers-v1//sites"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"8564"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Wed, 28 Jul 2021 19:56:53 GMT"},{"key":"x-amzn-RequestId","value":"1cbd148a-fdf9-4b44-938b-83868f686868"},{"key":"x-amz-apigw-id","value":"DMl07GhxPHcFYMg="},{"key":"X-Amzn-Trace-Id","value":"Root=1-6101b685-1cea706e5529048d19610e2c;Sampled=0"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 b97800dba63a54d15f1e69f88e3a1a3e.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"GRU1-C1"},{"key":"X-Amz-Cf-Id","value":"hz3gZlItN-S_PtFEav3li2L5i5SFbA57j1RehWW3B10R67iLME9nvQ=="}],"cookie":[],"responseTime":null,"body":"[\n {\n \"_id\": \"IChF0zAWZjY6KZwMyyBRWg7DRDw2\",\n \"name\": \"Rodrigo PnP\",\n \"image\": \"https://logo.clearbit.com/cnn.com\",\n \"slug\": \"rodrigo-pnp\",\n \"websiteUrl\": \"sportspage.arena.im\",\n \"whiteListDomains\": [\n \"*.mypartner.com\"\n ]\n },\n {\n \"_id\": \"5c9fd1d9af3c7b7611a93292\",\n \"name\": \"CNN Sports\",\n \"image\": \"https://logo.clearbit.com/cnn.com\",\n \"slug\": \"cnn-sports\",\n \"websiteUrl\": \"cnn.com\",\n \"whiteListDomains\": []\n },\n {\n \"_id\": \"5ec0b80ef15e5b0008648aa1\",\n \"name\": \"Birchwood\",\n \"image\": \"https://firebasestorage.googleapis.com/v0/b/arena-dev-f9045.appspot.com/o/images%2F0f959d4ab1efc410ba85bcdaf959d9cd.jpg?alt=media&token=43722ff9-82f6-4d2d-a609-40f850dfa8d9\",\n \"slug\": \"birchwood\",\n \"whiteListDomains\": []\n },\n {\n \"_id\": \"5ec0b8d3e7bab8000815d783\",\n \"name\": \"Kensington\",\n \"image\": \"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAJgAAACYCAYAAAAYwiAhAAAU50lEQVR4Xu2dB3QU1RrH/7OphJAKUhXBgoIF5SlgQxH1AXZFPT5UpFkAUR9ioTyliKBSpAooKIgoIqh0pYoUCUpRiiCdECC9kL7zzv8uiwGS7MxkbzLZvfccToDMfDPf//7mlu82DSWkpg92igrND7pNh/MeQGsOoAGASAABJd2j/t8vFCgEkAZgP6Bv1OBYmhOUv2bL/OmpxXmvnfufjTt0CI7MimitO7Qeuo6bAMT4hWzKSasKJGsa1mlOfXyUHrZy8eKxuUUNnQXYLe1fiC7Q8nvrOnoAqG71ieo+v1QgSdMwLlAPGrN24cQUtwJnADtdJQ52Qu+mASF+KZFyukwK6ECuA9qUnKD8Ae4qUwDGajEiO/Itp443FFxl0tjvbyZkGrThGWGpQ3fMmZMnAGvRtltb3aF/rqpFv+fDWwIkQsMzGxdMXaSJqrEgcIau415vWVd2lAKahgU5gQVPac3bdX0AGj4BEKtkUQp4UYEk6OiiNW/fZTygvehFw8qUUuC0AvoErXn7rnEAmilNlAISFIgjYEkqmCpBWmWSCiQTsAI1/KNokKRAIQHTJRlXZpUCUIApCKQqoACTKq8yrgBTDEhVQAEmVV5lXAGmGJCqgAJMqrzKuAJMMSBVAQWYVHmVcQWYYkCqAgowqfIq4wowxYBUBRRgUuVVxhVgigGpCijApMqrjCvAFANSFVCASZVXGVeAKQakKqAAkyqvMq4AUwxIVUABJlVeZVwBphiQqoACTKq8yrgCTDEgVQEFmFR5lXEFmGJAqgIKMKnyKuMKMMWAVAUUYFLlVcYVYIoBqQoowKTKq4wrwBQDUhWoUMB03bU1metH0b8b81kTm7Br4E/N9Y8KT//49M+2a6fdNPRudvTJ0IuXcJF0wJxOHRTd4SAIWpGfDoSHVUFwcBCqVQ1DSEiQYCyiWlUEBQV69Ck/vwDpmaeQm5uHtIxMpGdkIb+gEE6nE4WFTnIHh+Z6prdTodMp3pU+ufxyiOcEBjhQLbwqgoMCUS08DAEBAQgIcCAivKr46SnRp4ws+pQvfMrIPIW8/HxQQ/rFn+6PSYZfnt7Pyu+lA1anZnU0uKgOataIQY3YKFSPjkRUZDVERYYjNCQYgQGBrp+BrkPcqoSGGMoMQpSdk4uCggLxMyMrG8eOJ+LQ0ePYs/8I4hNOin9nnsoRdjWCYEWhc+5hxjasXwd1a9VA7QtiUT02CrFREYiJjhQfCn0JCAxAlZBgOBwOAWBoSIj46SnRp5zcPOSf9iknJxfJqek4euwkDsUfx/5D8UhMTsOJxBScynadOWWn0rs4/6QCRoFffOZhdHzkHk/aevX3zKiTSSnYdygev23bjV82bcPhYyeQl1dgKKNLe5mgwECMHtQbza65wqvvbMQY4TuRmIwDRxKwY/d+xG3bhQOHE5CemSU+HjuWalIBY7XwUpfH8Pj9dxrRT8o1hI2ZsnbTdixavg479xwQVbbVzGD1PWl4XzS5nMdnVlxilZmZlY0//9ovPqBfNm1Hwokk0TwwUlqW15vLB6xzBzz+QJvy8qfE57DJzQz4dtEqzF/yM9LSM0QVZjbZBbCi780qldXoj2t+xaLl6xF/PPF09em5Wjbrv9nr/QYwtzDMjDUbtmDS5/Nw6OgJ0YYxk+wImPv9WXrtPXAE3yxYiZXrNiM941SFl2Z+Bxgzg1Xklj/3YPi4Gdh36JipTLAzYG7QcvPyxUf06ewF2HfwqOXmgJkPr6Rr/RIwtxjMhOHjZ4iemdE2WWUAzPURAbv/PohJM+Zj429/ijCHUR+9AZbbhl8DRtGnzV6IT2YvEBlgJFUWwNy+HD+ZjEkz5uHHNZvAOFt5Q+bXgDETGFN6c9hEbN+5z1BVWdkAo48M3k78bB7mLV4tmgflmWwJGNsQRxNOIiklDWnpmSgocEXmRdJ1hAQHITY6EhfVq+WKmFvoDRYVec6CFfho6hzkFRR4DMaWBTCOALAhztLy3IymeyIwG+BAYIAr6OzNlJicivcnzsLq9b9706xHW7YEbF3cdoyZ+jVS0zKRm5cH5zlfHYFixD82OgLXNL4UrW9uhquvvATBQUEeHS7ugviERPQeOAoHjx4Xw0ulJauA/f7HX/jp501glZWUki6qq6I087nRkdVwQfUYXHxhLTH6Ub9eLTFaYCWcUpwPBw4fw6BR0/DHrr+9ZtOT4LYEjPGcIaOnIzsnr9QwgqsU0BAdFY5/39ESnTq0RXRUhCefz/s9x/uGffQ5Fi5f51F4K4DxPad88T0mz/zuTDVcXEXlQts1eM8hJw5HNWnUAK1aXodrG18mSuuyprW/bsOQMdORkppeLu0xmwK2CUM/+gzZ2bmG4lTMQJZqbVu3RM/Oj4qSwGyau3AVRkyY6VH0sgA2ddb3HgEu+t7ujkfVsCq4/upGeLhdK9zQtLEYTLeaWEWPm/YNZs370ZC2Vp/jvs8nABNNM0C0XTo/cS+efbydqYzk/Rxu6ffex2LgvLSeVnkCdjZsOqKjquGBe27Fkw/eJSYMWE2sKt98dyL+PhhvqGNj9TmiPJZ5XqQYi7QwVMQutZkSzC0Av3i2XT78Xy/Uq32BKV04Rvn60AlIOJlcajusogATHxFL6oAAtGrRFL26dABnqlhNM75ZggmffSu9V+lTgFFsNoiHvN5dNPzNJE7x6TtkvBjTK22wuCIBc0HmKq/ZLuv7YkdUj4k04+aZa1mKvTZ4nJjeJDM25nOAUcHuHR8QVaWZtGf/YfQdPB5HExJtDZjbJ/Y6H7v/Trzw9EMICQk246q4trCwEB9+PBvfLFzpseds2niRG3wOMFYjD7Vthdd7dDT1ZVaWEsydd/STjf9+Lz2DO2/9lyUG1m/+AwNGTBYzZ2WVYj4J2JMP3Y3eXR8zJfqOv/aLNtjxxBTbtsHOdYiBW/Yu33vrBUs9Z86W7T1gFHb/fVhaY9/nAGMm9Hn+STx67x2mAOPAd/8Rk8V8+NJirRXdBivqFEsxrmlgaX1vm5tN+cuLOXXpw0lfijly3grmnvsSPgUYBecCiw/+1wvXNr7UlOBffLsUY6bO8fgl2wkwOsie820tmmLQa90QViXUlM+8mOOTw8fPNH2f0Rt8CjCKfcdN12PAq53FiiWjibGvASOmYM2G3z1+yXYDjB8Vx2VHvv0Srri0vlGXz1zHqTz9h092zes3O/vSwNN8BjAu6apTMxYDXumMZtc0MuD6P5dw8uEb7040NHxiN8DoBQPMbHN2uK+1Kb95McMUfQaNBcMWMqrJSg8Yv2AOhteqEYMenR7B3a1uNCUUB51HTfkKcxeuNPQF2xEwhhwebnc73uj5lCEfilLIHmSv/iPx5+79hpYLmiXYvoCN4WA31/4Vnd1wevU3vTw9w4LtjmubXCaWxjW7upEpuGgmbusu0VVnj8pIFWFLwJxOtGx2FYb07S4WLptJHJt8eeBobPjtT/8BbPnaOLw3bgZycvLO4otVATOYg70ci7v6ikvQ/LrGaHrV5YiKCDejq7iW8804fWV93B8eG/du43YEjM2Dyy+5EO8P6Cmm95hJvPedkZ9g8Yr1pj9OI8+xZQnG+Vlbd+xBQWHhWSVYWJUQsXqaX2ntmrEi0Gh1ch4XsU6eOR+zv1tueLo0BbUjYGwm1KlVA6Pf6S3mkJlJBGzw6GlY+BOnKplcYmXgQbYEzMB7l+kSwjVz7lIwNHEqO8dQ1WjnEoyAcVuGjwa/gob165rSRgFmSi7PF3MF0cy5SzBvyRpw7wcj7a6iVu1YgvH9GHCd9N5raGxyxbkCzDMzhq4oKCgEh4Omfb0IG3/7Q8yNNwuXnavImKgIjB3yKi5tUM+QHu6LFGCm5Dr/Yrbj9h+Mx7I1v2Lpyo04nphsCSy7V5GcGzZ60Mvm22C6jsGjVBvMMmaH40+IbQJWrf9NLLQoazDRjlUk22AX1a2JkW/3xoV1zE205OjHwPenYtnqjWXWprhM8vlGPsNlx08m4Ycf12LuotUi3uVp5VBpNNsRMELC1VWcVVE9JsrUx8gSvle/kYjbulPMlvV28nnA3IKxDbZ09Uax4IHLxqxCZkfA2J68rWVTDOrTDVXDzA14p2VkiSk7fhXJ9/ZX5LbH+VMLf/pFzJrIzLI2yc6WgDmdYiHIK92fMC0dd03sM3gcDnNNaBkXMFeaKpKxKVZl7OEwsbcXGhqMoIAAhIeHWQ6u0hbbYdwQZNa8ZZYWPNgRMO66+OpzT4iZvGbTpi07xWoq7glrpVft6Xm2rCK5OHTC9Lliv1IORdJxDgWFBAeLlTRXXnaxGHurJVY9m48+c//WN4dNws49B03fbzfA2MBniII9yEaXXOQpv8/7/XdLf8awsZ+bvs/oDbYEjMvWuPq46MLbotuDE7SLL6yNpx79N9rcdoOlvSlmf/cTxn46x7UjtYlkN8DYwL+xaWMM6/eCGEYzk9guHT31K3z9/XIp1aOofSrrukgKy4l2PZ59BO1atzQtEONhrw0ah117WYoZ30rTboCxdOdcsCcsbFPKrd9feXuM4Z2FzMDrvrbSAkYH2EardUEMBvftbnqKNMMXXMrPP2baHnYCjB/ZJfXr4v2BPU0vNKZ+23f+LdZGpqRlmNLADGiVGjAXZE60v/MmvNHrabGtk5nEmaxcbMstooxCZifA6KuVNaBujaZ9tVBsyCJzz7BKD5h7JsGI/j3R+PKLzfAFxoAIGPfSN3ISB43bBTB+WNyyaujrz4nOjtmUmp6Jfu9Nwq9bdlpqwxp9XqUHjI4SMk6XfrpDW6N+n7lu9JSv8OV87jRjrDdqB8DoL3cQeuulZ8SKIivp541bMfD9KadnDVuxYOwenwCMX3Pz65qI5Wpmq0nu+Mcp03ncEM5AqmjACBeniT//9EN4pP3tlmKCeXn5YnOZxSs2mA7TGJDorEt8BDAddWtVF0u3uLuOmXQ4/jhe6j9KHF5gpBSrSMD4IUVGhKPjw/eIwy24SZ2VtHnbLhFcldm494lepNsJftUUu1/vTmJVkZnEUYNBIz/F8rWbDbXDKgIwdyO8Xp0L0Pnxe3H37TeC0XsrKetUttg9kusezIRnrDyL9/hECUZHGDDt+p/78FzHB01r8dnXi8TwkZHeVHkCxvfhH5ZaN99wjTjziYtrjZS0xYnAgbcFP64V2wV42mjPtIgl3OAzgLmW0F+Hd/p0EYtBzCSxunnEZHHmpKfMKwtgU2Z9X2KPzQWTq8PC/gZLKE69uf6aRmh9SzP86+orUKVKiBm3zruWW1Rx7ld5nv7hM4AxY2rXrI7xQ/+LurVrmMqIk0mp6NnvQ+w3cKyMVcC4o+DHM+ejgFO1z3k7Qh1etYrYV4O9Q1aFTZtchquuaIh6tWogNLRsYPFxqWkZYg+KFb9s9vgRmRLPw8W+AxgPMw0JRv+XO6HNrTeY0kj2LtN8GW7NyakxYvvycxIH7MPDuBwvzHVYa0Q1r/buWB0yoMoxR3FabzkmnwGMmnELgf9Y2BuM985dtAojxsvZZboc8/O8RxGuGXOX4Iu5y5CTa34VVVnf3acAY0O/xfVNMPSN50wvod+6Y6/YeZmrvb29y3RZM8nq/QKub5aIuW/l1ag/9119CjD3VkacG3V5wwtN5QuHTvq8MxZbd+4tdejEShvM1It46WK2K3mcHw+XyM3lgRbGRiq89PgzZnwKMHpFITmEct9d5nf8+2DSLMz5YUWlLsE4x4vH1kz/ehEYUHX1SisGLpEflXU+WElfGsMV7e68CQNf6Wy6obz85zgxPldaQ9iuJRhBOnYiCd8vW4sflq0FD7+qSLDc+eOTgHGO1AcDe5kOVxw4koBX3/4IR4/xqOXiv3q7AcaODaeAr16/BYtWrMO+g/EVdvhocR+9zwHGaDW3d2IJdtdt5sIVPEaQq5yXrtpY4rCRHQBjaZWRlY1DRxKwav3vWBe3TcTwuBFdeQz/mGmn+RxgIlzhdIozfXgSBoEwk7gp7ocffwm2ZYpLFQUYd4Q+lZ0rYmnbduzF5u27sWvPQbEaiP7aDaxyqyJ7PdsBTzzYxvAeXBRq2epf8S5PW/NwnF9J4Lij+qwmWV3qurHgouZw4ODhY/jvO2NxpIRqkkM4w956HjdceyWCgoLEsI632zp8f27KywXCPF+Sx9vsPXBErB9IOJEkJkqytNI0R7mcmGbmAy3XMAWF56FU3D9VF+eheU4aNCSlpotNaY2eo12cVYLa4KLaiImMMPxs2mEsjZnJvUuLbVMIn2ogOjICYWGhiI2KEIPRPMuRY6DunRYjq1UVvy89aWL8k4uAM7OywVBJckqaOAwiOTVN/I7rQ7NO5ZweiHedJeltoD3nivUrpFaR7urq3BNrPb0ul/V7o8hnb9DIDImi7+M+2ri0TCx6JLK7FOH17j/ucImR6IB7gNs9c0JsanxmwbELpsoEVLmWYJ5AUr/3fQWkl2C+L6HysDQFFGCKD6kKKMCkyquMK8AUA1IVUIBJlVcZV4ApBqQqoACTKq8yrgBTDEhVQAEmVV5lXAGmGJCqgAJMqrzKuAJMMSBVAQWYVHmVcQWYYkCqAgowqfIq4wowxYBUBRRgUuVVxhVgigGpCijApMqrjCvAFANSFVCASZVXGVeAKQakKqAAkyqvMq4AUwxIVUABJlVeZVwBphiQqoACTKq8yrgCTDEgVQEFmFR5lXEFmGJAqgIKMKnyKuMKMMWAVAUIGE9nCpD6FGXcXxUoJGBJAGL8VQHlt1QFkglYHIBmUh+jjPurAnFa8/ZdxgPai/6qgPJbpgL6BK1F+27369A/BRAr81HKtt8pkKRB66w1a9M9MiDYOUPTcJ/fSaAclqaAruOHwjzHU+LEpxZtu7XVHfrnAKpLe6Iy7E8KJGpO7ekNi6csFoA17tAhuNqpqH469Nc1oOwnkPuTlMrXsxTQgVwN2vCMsNShO+bMyTtzZt0t7V+IztfyB+s6uirIFDVWFCBcDmhTAhE4cO3CiSm0cdahiAIyFLwM6D1Uo9+KxH59TxKgjQ9C4Gg3XOcBxv9o27ZXSApyWiNAf1HXcZMKwvo1NEacT9Y0rEOhNiEaoSsWLx6bW/SmEg9zbvpgp6iQvMBW0PS7efIygIYAItSwkhHNffoaHqSZDmAfoG+Eri3LDS5YvWX+9NTivP4/ZvpBxFVsAv8AAAAASUVORK5CYII=\",\n \"slug\": \"kensington\",\n \"whiteListDomains\": []\n },\n {\n \"_id\": \"5ec0ba5352fc220008259fb3\",\n \"name\": \"Carlyle\",\n \"image\": \"https://stationfy.imgix.net/abgrd/6.png?txtfont=Arial%20Bold&txt=C&txtsize=100&txtcolor=FFFFFF&txtalign=center,middle&w=200&h=200&t=1589688915871\",\n \"slug\": \"carlyle\",\n \"whiteListDomains\": []\n },\n {\n \"_id\": \"5ee2c7a536e5180007e3c844\",\n \"name\": \"New Site From Api\",\n \"image\": \"https://stationfy.imgix.net/abgrd/6.png?txtfont=Arial%20Bold&txt=NSFA&txtsize=100&txtcolor=FFFFFF&txtalign=center,middle&w=200&h=200&t=1591920549971\",\n \"slug\": \"new-site-from-api-49803\",\n \"websiteUrl\": \"myblog2.com\",\n \"whiteListDomains\": [\n \"mypartner.com\",\n \"foo.site.com\"\n ]\n }\n]"}],"_postman_id":"226a4b27-cff8-4479-bf2c-395281d3746a"},{"name":"Create Site","id":"f771ba21-bfc2-45a7-b8d5-29223a40ec2b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-api-key","type":"text","value":"YOUR_API_KEY"},{"key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"name\": \"My New Site\",\n\t\"organizationId\": \"ORG_ID\",\n\t\"siteUrl\": \"myblog.com\",\n\t\"whiteListDomains\": [\"mypartner.com\", \"foo.site.com\"]\n}"},"url":"https://api.arena.im/customers-v1/sites","description":"Create a new site under this account.
\nThis endpoint is available only for Enterprise customers.
\nRequest fields:
\nimage: Site logo or avatar.
name: (required) Site name
organizationId: (required) Parent organization for this site. Use GET /organizations to fetch all account organizations.
siteUrl: Site domain where widgets will be embedded. No wildcards (*.foo.bar) and no https or http.
whiteListDomains: Additional domains where the widgets will be embedded.
For siteUrl don't pass wildcards (*.example.com) and don't pass https:// or http://, inform just the raw domain: example.com or subdomain.example.com. The field whiteListDomains accepts wildcards: *.example.com.
For each valid domain we already consider the www. and m. subdomains as valid ones.
\n","urlObject":{"protocol":"https","path":["customers-v1","sites"],"host":["api","arena","im"],"query":[],"variable":[]}},"response":[{"id":"0d8bf415-76db-4801-972b-eb6c0ccd1dcb","name":"Create Site","originalRequest":{"method":"POST","header":[{"key":"x-api-key","type":"text","value":"YOUR_API_KEY"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"name\": \"New Site From Api\",\n\t\"organizationId\": \"IChF0zAWZjY6KZwMyyBRWg7DRDw2\",\n\t\"siteUrl\": \"myblog.com\",\n\t\"whiteListDomains\": [\"mypartner.com\", \"foo.site.com\"]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.arena.im/customers-v1/sites"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"332"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Wed, 28 Jul 2021 19:57:33 GMT"},{"key":"x-amzn-RequestId","value":"40c4f002-7795-4b87-a565-7ed82ba9bf82"},{"key":"x-amz-apigw-id","value":"DMl63GInvHcF10w="},{"key":"X-Amzn-Trace-Id","value":"Root=1-6101b6ab-556e5286704a529a5f8975d5;Sampled=0"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 b97800dba63a54d15f1e69f88e3a1a3e.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"GRU1-C1"},{"key":"X-Amz-Cf-Id","value":"5wWS6_NxQqrg3qImXhABOY6xJ-sZttEXkxQ0rOE9P7qnSghNCGulXQ=="}],"cookie":[],"responseTime":null,"body":"{\n \"_id\": \"6101b6ac6146f80008e3f279\",\n \"name\": \"New Site From Api\",\n \"image\": \"https://stationfy.imgix.net/abgrd/10.png?txtfont=Arial%20Bold&txt=NSFA&txtsize=100&txtcolor=FFFFFF&txtalign=center,middle&w=200&h=200&t=1627502252010\",\n \"slug\": \"new-site-from-api-51916\",\n \"websiteUrl\": \"myblog.com\",\n \"whiteListDomains\": [\n \"mypartner.com\",\n \"foo.site.com\"\n ]\n}"}],"_postman_id":"f771ba21-bfc2-45a7-b8d5-29223a40ec2b"},{"name":"Update Site","id":"e74e71a5-eb85-4220-8b01-5824a8b0b51b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-api-key","type":"text","value":"YOUR_API_KEY"},{"key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"name\": \"My New Site\",\n\t\"organizationId\": \"ORG_ID\",\n\t\"siteUrl\": \"myblog.com\",\n\t\"whiteListDomains\": [\"mypartner.com\", \"foo.site.com\"],\n \"config\": {\n \"hideOfflineModerators\": true\n }\n}"},"url":"https://api.arena.im/customers-v1/sites/{siteId}","description":"Update site information.
\nThis endpoint is available only for Enterprise customers.
\nRequest fields:
\nimage: Site logo or avatar.
name: (required) Site name
websiteUrl: Site domain where widgets will be embedded. No wildcards (*.foo.bar) and no https or http.
whiteListDomains: Additional domains where the widgets will be embedded.
config.hideOfflineModerators: Boolean ( true/ false ) [default: false]. If true, only online moderators will be visible in the user list.
config.globalModerationScope : Boolean ( true / false ) [default: false]. When false, you will be able to define a moderator scroped by chatroom using the field chatroomId when defining the user as moderator. The default value is true and it means that any moderator you create will be visible as moderator for all chatrooms in current site.
For siteUrl don't pass wildcards (\\*.example.com) and don't pass https:// or http://, inform just the raw domain: example.com or subdomain.example.com. The field whiteListDomains accepts wildcards: \\*.example.com.
For each valid domain we already consider the www. and m. subdomains as valid ones.
\n","urlObject":{"protocol":"https","path":["customers-v1","sites","{siteId}"],"host":["api","arena","im"],"query":[],"variable":[]}},"response":[{"id":"aa3df70f-da9e-45ca-8143-fb911e1f17ea","name":"Update Site","originalRequest":{"method":"POST","header":[{"key":"x-api-key","type":"text","value":"YOUR_API_KEY"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"name\": \"Updated from api\",\n\t\"whiteListDomains\": [\"mypartner.com\", \"foo.site.com\", \"msn.com\"]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.arena.im/customers-v1/sites/6101b6ac6146f80008e3f279"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"331"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Wed, 28 Jul 2021 19:57:58 GMT"},{"key":"x-amzn-RequestId","value":"5ea7bb78-2186-41ff-b922-28e67fcf5b5e"},{"key":"x-amz-apigw-id","value":"DMl_EGHAvHcFwXA="},{"key":"X-Amzn-Trace-Id","value":"Root=1-6101b6c6-5b25cf4a113b8379168b46a7;Sampled=0"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 b97800dba63a54d15f1e69f88e3a1a3e.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"GRU1-C1"},{"key":"X-Amz-Cf-Id","value":"LMfO2TlNOA1glldJIfDUbKXJXoFgVoAjSvGjKNU0femC_2XNuBAyig=="}],"cookie":[],"responseTime":null,"body":"{\n \"_id\": \"6101b6ac6146f80008e3f279\",\n \"name\": \"Updated from api\",\n \"image\": \"https://stationfy.imgix.net/abgrd/10.png?txtfont=Arial%20Bold&txt=NSFA&txtsize=100&txtcolor=FFFFFF&txtalign=center,middle&w=200&h=200&t=1627502252010\",\n \"slug\": \"new-site-from-api-51916\",\n \"websiteUrl\": \"myblog.com\",\n \"whiteListDomains\": [\n \"mypartner.com\",\n \"foo.site.com\"\n ]\n}"}],"_postman_id":"e74e71a5-eb85-4220-8b01-5824a8b0b51b"},{"name":"Delete Site","id":"1a152d49-e28a-402f-91d5-031c2c1e2d36","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"x-api-key","type":"text","value":"YOUR_API_KEY"},{"key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://api.arena.im/customers-v1/sites/{siteId}","description":"Delete site.
\nThis endpoint is available only for Enterprise customers.
\nThis operation is irreversible. Use with caution since after deleting the site all widgets will be also deleted and any embed code will stop working.
\n","urlObject":{"protocol":"https","path":["customers-v1","sites","{siteId}"],"host":["api","arena","im"],"query":[],"variable":[]}},"response":[{"id":"4ceb58ec-cc0e-43c4-a048-12bbd6607a0c","name":"Delete Site","originalRequest":{"method":"DELETE","header":[{"key":"x-api-key","type":"text","value":"YOUR_API_KEY"},{"key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://api.arena.im/customers-v1/sites/6101b6ac6146f80008e3f279"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"16"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Wed, 28 Jul 2021 19:58:07 GMT"},{"key":"x-amzn-RequestId","value":"92e93643-f295-46d8-a090-4f92a50ef986"},{"key":"x-amz-apigw-id","value":"DMmAQE-uPHcF1eA="},{"key":"X-Amzn-Trace-Id","value":"Root=1-6101b6ce-571466833eb1b89a2dcab3ba;Sampled=0"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 b97800dba63a54d15f1e69f88e3a1a3e.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"GRU1-C1"},{"key":"X-Amz-Cf-Id","value":"3pGu8Ak6rqdD3OrXJty36UO7Na8vUSPk5zwFY-nbq4m8Rsx-xG6vEg=="}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true\n}"}],"_postman_id":"1a152d49-e28a-402f-91d5-031c2c1e2d36"},{"name":"Add Allowed Domains","id":"7ad0ddbf-b03f-4581-bdb3-736efdc7757f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-api-key","type":"text","value":"YOUR_API_KEY"},{"key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"domains\": [\"*.mypartner.com\", \"foo.site.com\"]\n}"},"url":"https://api.arena.im/customers-v1/sites/{siteId}/domains","description":"Add domains to the allowed domain list. Existing domains won't be affected.
\n","urlObject":{"protocol":"https","path":["customers-v1","sites","{siteId}","domains"],"host":["api","arena","im"],"query":[],"variable":[]}},"response":[{"id":"aa33b3bf-f2f8-4c0c-be05-9e32eeec26b3","name":"Add Allowed Domains","originalRequest":{"method":"POST","header":[{"key":"x-api-key","type":"text","value":"YOUR_API_KEY"},{"key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"domains\": [\"bar.site.com\"]\n}"},"url":"https://api.arena.im/customers-v1/sites/6101b74a42a55f00084785aa/domains"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"346"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Wed, 28 Jul 2021 20:00:19 GMT"},{"key":"x-amzn-RequestId","value":"95ebf90f-bf8d-4e48-8d48-ee253e68dca8"},{"key":"x-amz-apigw-id","value":"DMmVCEFUvHcFoVg="},{"key":"X-Amzn-Trace-Id","value":"Root=1-6101b753-49d204652b784bc72ba1755e;Sampled=0"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 b97800dba63a54d15f1e69f88e3a1a3e.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"GRU1-C1"},{"key":"X-Amz-Cf-Id","value":"TPX6lJCkZ-R-P3TyMdRpTDg9NN_CZT5jeWAdU0b3rAbEuUJxNnCL1w=="}],"cookie":[],"responseTime":null,"body":"{\n \"_id\": \"6101b74a42a55f00084785aa\",\n \"name\": \"New Site From Api\",\n \"image\": \"https://stationfy.imgix.net/abgrd/1.png?txtfont=Arial%20Bold&txt=NSFA&txtsize=100&txtcolor=FFFFFF&txtalign=center,middle&w=200&h=200&t=1627502410765\",\n \"slug\": \"new-site-from-api-10736\",\n \"websiteUrl\": \"myblog.com\",\n \"whiteListDomains\": [\n \"mypartner.com\",\n \"foo.site.com\",\n \"bar.site.com\"\n ]\n}"}],"_postman_id":"7ad0ddbf-b03f-4581-bdb3-736efdc7757f"},{"name":"Remove Allowed Domains","id":"8646cc53-df2c-45a9-8184-19f8189356e4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"x-api-key","type":"text","value":"YOUR_API_KEY"},{"key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"domains\": [\"*.mypartner.com\", \"foo.site.com\"]\n}"},"url":"https://api.arena.im/customers-v1/sites/{siteId}/domains","description":"Remove domains from the allowed list. Existing domains won't be affected.
\n","urlObject":{"protocol":"https","path":["customers-v1","sites","{siteId}","domains"],"host":["api","arena","im"],"query":[],"variable":[]}},"response":[{"id":"545e9828-f88d-49d1-81e4-332eeeea840b","name":"Remove Allowed Domains","originalRequest":{"method":"DELETE","header":[{"key":"x-api-key","type":"text","value":"YOUR_API_KEY"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"domains\": [\"bar.site.com\"]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.arena.im/customers-v1/sites/6101b74a42a55f00084785aa/domains"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"331"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Wed, 28 Jul 2021 20:00:49 GMT"},{"key":"x-amzn-RequestId","value":"562c3210-a78a-446a-8658-65dd0616ff5a"},{"key":"x-amz-apigw-id","value":"DMmZuGBIPHcFvzA="},{"key":"X-Amzn-Trace-Id","value":"Root=1-6101b771-0f2c84397f615b940c647d2e;Sampled=0"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 b97800dba63a54d15f1e69f88e3a1a3e.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"GRU1-C1"},{"key":"X-Amz-Cf-Id","value":"Jl08_lhPQoMvG0e9DOux3_OsiPzRQ82BPDkgxyzpk5RgzFiTSLGLcQ=="}],"cookie":[],"responseTime":null,"body":"{\n \"_id\": \"6101b74a42a55f00084785aa\",\n \"name\": \"New Site From Api\",\n \"image\": \"https://stationfy.imgix.net/abgrd/1.png?txtfont=Arial%20Bold&txt=NSFA&txtsize=100&txtcolor=FFFFFF&txtalign=center,middle&w=200&h=200&t=1627502410765\",\n \"slug\": \"new-site-from-api-10736\",\n \"websiteUrl\": \"myblog.com\",\n \"whiteListDomains\": [\n \"mypartner.com\",\n \"foo.site.com\"\n ]\n}"}],"_postman_id":"8646cc53-df2c-45a9-8184-19f8189356e4"}],"id":"fd0ac2d6-312e-4fee-9efa-ebc10fa41f1e","_postman_id":"fd0ac2d6-312e-4fee-9efa-ebc10fa41f1e","description":""},{"name":"Stream","item":[{"name":"Get Stream Results","id":"36dea0c2-8565-408f-86ba-cd194731cfb7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","type":"text","value":"YOUR_API_KEY"},{"key":"Content-Type","type":"text","value":"application/json"}],"url":"https://api.arena.im/customers-v1/streams/{streamId}/results","description":"Get results for a stream.
\n","urlObject":{"protocol":"https","path":["customers-v1","streams","{streamId}","results"],"host":["api","arena","im"],"query":[],"variable":[]}},"response":[],"_postman_id":"36dea0c2-8565-408f-86ba-cd194731cfb7"}],"id":"a6d9e1af-8016-4373-abdf-0ac306dc4d3d","_postman_id":"a6d9e1af-8016-4373-abdf-0ac306dc4d3d","description":""},{"name":"Users","item":[{"name":"Get User","id":"63776f1f-c4a2-4242-9599-3154ff669940","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","type":"text","value":"YOUR_API_KEY"},{"key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://api.arena.im/customers-v1/users/:userId?siteId","description":"Returns a user profile.
\n\n\n","urlObject":{"protocol":"https","path":["customers-v1","users",":userId"],"host":["api","arena","im"],"query":[{"description":{"content":"You can query only users that was created on one site of your account.
\n
The id of the the site where the user account was created
\n","type":"text/plain"},"key":"siteId","value":null}],"variable":[{"description":{"content":"ID of user on your authentication system.
\n","type":"text/plain"},"type":"any","value":null,"key":"userId"}]}},"response":[{"id":"4093d599-14ec-4b7b-89ec-a5509a34a3df","name":"Get User","originalRequest":{"method":"GET","header":[{"key":"x-api-key","type":"text","value":"YOUR_API_KEY"},{"key":"Content-Type","type":"text","value":"application/json"}],"url":"https://api.arena.im/customers-v1/users/WED453"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"322"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Thu, 29 Jul 2021 17:06:47 GMT"},{"key":"x-amzn-RequestId","value":"56ede69a-6d71-45f9-a1e0-8c551b7c07a1"},{"key":"x-amz-apigw-id","value":"DPf2IG-mvHcFlAg="},{"key":"X-Amzn-Trace-Id","value":"Root=1-6102e027-3a93dc28588d8f101c15f73f;Sampled=0"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 964cf114e0992390e6487315faea90ac.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"HIO50-C2"},{"key":"X-Amz-Cf-Id","value":"zpZ1mUkqDYi7V-JJCmo_ipnklNALgLtAHCpqbDBZJE2N7CeKS2Xs_w=="}],"cookie":[],"responseTime":null,"body":"{\n \"_id\": \"5fbefcddd343f80007bcc46a\",\n \"roles\": [\n \"USER\"\n ],\n \"userName\": \"r.anderson@null.com\",\n \"name\": \"Rob Anderson\",\n \"urlName\": \"robanderson1646\",\n \"thumbnails\": {\n \"raw\": \"https://randomuser.me/api/portraits/men/12.jpg\"\n },\n \"provider\": \"{{site-slug}}\",\n \"profile\": {\n \"email\": \"r.anderson@null.com\"\n },\n \"socialLinks\": [],\n \"social\": {\n \"{{site-slug}}\": \"WED453\"\n }\n}"}],"_postman_id":"63776f1f-c4a2-4242-9599-3154ff669940"},{"name":"Create User","id":"aab4c23a-bdbe-4faa-b0c7-3397164fd727","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-api-key","type":"text","value":"YOUR_API_KEY"},{"key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"siteId\": \"[SITE_ID]\",\n \"id\": \"user-id-on-my-system\",\n\t\"name\": \"Julie Anderson\",\n \"userName\": \"j.anderson\",\n \"email\": \"julie@test.com\",\n\t\"picture\": \"https://randomuser.me/api/portraits/women/12.jpg\",\n \"isModerator\": false,\n\t\"metadata\": {\n\t\t\"location\": \"Philadelphia\",\n\t\t\"favorites\": \"movie,music\"\n\t}\n}"},"url":"https://api.arena.im/customers-v1/users","description":"Create a new user profile. If a user with the same ID already exists it will be returned. To update a user profile use the endpoint \"Update User\"
\nsiteId: Required. All users are scoped within a site.
\nid: Required. ID of user on your authentication system.
\nname: User's name
\nuserName: (optional) An unique slug for the user
\npicture: User's profile picture
\nisModerator: Whether or not this user will be a moderator.
\nmetadata: Key/value pair with any information you'd like to attach to the user.
\n","urlObject":{"protocol":"https","path":["customers-v1","users"],"host":["api","arena","im"],"query":[],"variable":[]}},"response":[{"id":"c78bba22-50f7-4861-bd37-58b4d959c56a","name":"Create User","originalRequest":{"method":"POST","header":[{"key":"x-api-key","type":"text","value":"YOUR_API_KEY"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"siteId\": \"IChF0zAWZjY6KZwMyyBRWg7DRDw2\",\n \"id\": \"WED453\",\n\t\"name\": \"Rob Anderson\",\n \"userName\": \"r.anderson\",\n \"picture\": \"https://randomuser.me/api/portraits/men/12.jpg\",\n \"isModerator\": true,\n\t\"metadata\": {\n\t\t\"location\": \"Philadelphia\",\n\t\t\"favorites\": \"movie,music\"\n\t}\n}","options":{"raw":{"language":"json"}}},"url":"https://api.arena.im/customers-v1/users"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"322"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Thu, 29 Jul 2021 13:59:44 GMT"},{"key":"x-amzn-RequestId","value":"870cf95e-d22f-423d-8c43-7ea30bea03f8"},{"key":"x-amz-apigw-id","value":"DPEcZGojPHcFkUw="},{"key":"X-Amzn-Trace-Id","value":"Root=1-6102b44f-66a2e23956d2609242427fc9;Sampled=0"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 2268373f32ed46c458ef5057fc6f60f9.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"GRU3-C2"},{"key":"X-Amz-Cf-Id","value":"We3GK_tXWpCjlygAFg1vIzdQPh5WsJnpthLEVVEf8VhAFz018xLa8Q=="}],"cookie":[],"responseTime":null,"body":"{\n \"_id\": \"5fbefcddd343f80007bcc46a\",\n \"roles\": [\n \"USER\"\n ],\n \"userName\": \"r.anderson@null.com\",\n \"name\": \"Rob Anderson\",\n \"urlName\": \"robanderson1646\",\n \"thumbnails\": {\n \"raw\": \"https://randomuser.me/api/portraits/men/12.jpg\"\n },\n \"provider\": \"{{site-slug}}\",\n \"profile\": {\n \"email\": \"r.anderson@null.com\"\n },\n \"socialLinks\": [],\n \"social\": {\n \"{{site-slug}}\": \"WED453\"\n }\n}"}],"_postman_id":"aab4c23a-bdbe-4faa-b0c7-3397164fd727"},{"name":"Update User","id":"28f47e4c-890c-4869-ab78-060dc6b89084","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-api-key","type":"text","value":"YOUR_API_KEY"},{"key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"siteId\": \"[SITE_ID]\",\n\t\"name\": \"Julie Anderson\",\n\t\"picture\": \"https://randomuser.me/api/portraits/women/12.jpg\",\n\t\"metadata\": {\n\t\t\"location\": \"Philadelphia\",\n\t\t\"favorites\": \"movie,music\"\n\t}\n}"},"url":"https://api.arena.im/customers-v1/users/{userId}","description":"Updates information on a user. In addition to changing a user's name or profile image, you can also update the metadata key/value pairs for the user. If a user doesn't exist, an error will be returned.
\nuserId: User's unique id, usually the same id in your own system
\nsiteId: Required. All users are scoped within a site.
\nname: User's name
\npicture: User's profile picture
\nmetadata: Key/value pair with any information you'd like to attach to the user. You can pass only the keys you wish to update/add. Currently there's no option to delete a metadata key.
\n","urlObject":{"protocol":"https","path":["customers-v1","users","{userId}"],"host":["api","arena","im"],"query":[],"variable":[]}},"response":[{"id":"681a0dfc-02a5-44d4-aa49-f8700e682278","name":"Update User","originalRequest":{"method":"POST","header":[{"key":"x-api-key","type":"text","value":"YOUR_API_KEY"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"siteId\": \"IChF0zAWZjY6KZwMyyBRWg7DRDw2\",\n\t\"name\": \"Julie Anderson\",\n\t\"picture\": \"https://randomuser.me/api/portraits/women/12.jpg\",\n\t\"metadata\": {\n\t\t\"location\": \"Philadelphia\",\n\t\t\"favorites\": \"movie,music\"\n\t}\n}","options":{"raw":{"language":"json"}}},"url":"https://api.arena.im/customers-v1/users/WED453"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"273"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Thu, 29 Jul 2021 17:03:56 GMT"},{"key":"x-amzn-RequestId","value":"c629478f-576b-46ca-8b48-d4a51940bc9e"},{"key":"x-amz-apigw-id","value":"DPfbZENQvHcF29Q="},{"key":"X-Amzn-Trace-Id","value":"Root=1-6102df7b-61e32ae16ca130fb1a47bbbd;Sampled=0"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 4c7fd3c8d1d5afb1ce8ed03385580c2e.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"HIO50-C2"},{"key":"X-Amz-Cf-Id","value":"UOJeD-2sAMyT_Ypm78YKsURP20_ucJgrqFRcP91g5ZLJFmlZBXee5Q=="}],"cookie":[],"responseTime":null,"body":"{\n \"_id\": \"5fbefcddd343f80007bcc46a\",\n \"name\": \"Julie Anderson\",\n \"metadata\": {\n \"location\": \"Philadelphia\",\n \"favorites\": \"movie,music\"\n },\n \"email\": \"r.anderson@null.com\",\n \"providerUserId\": \"WED453\",\n \"userName\": \"r.anderson@null.com\",\n \"picture\": \"https://randomuser.me/api/portraits/women/12.jpg\"\n}"}],"_postman_id":"28f47e4c-890c-4869-ab78-060dc6b89084"}],"id":"1c7e3aff-a6ec-4391-98ea-97f79dc05752","description":"Users profiles are created by the SSO flow and each user is identified by its own unique id, usually the same user id in your system. They may have a customized nickname and profile image. Using the API, you can manage the various attributes of each user, as well as their actions.
\n","_postman_id":"1c7e3aff-a6ec-4391-98ea-97f79dc05752"},{"name":"Moderation","item":[{"name":"Get Moderators","id":"cf329d5b-fb2e-41ed-89b8-2a55a296e9e0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","type":"text","value":"YOUR_API_KEY"},{"key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://api.arena.im/customers-v1/moderation/moderators?siteId=[SITE_ID]&status=[STATUS]&onlyPublicModerators=[BOOLEAN]&chatRoomId=[CHATROOM_ID]","description":"Get moderators list.
\n","urlObject":{"protocol":"https","path":["customers-v1","moderation","moderators"],"host":["api","arena","im"],"query":[{"description":{"content":"(optional) Return only moderators for this site. If omitted, will return all moderators from the first site
\n","type":"text/plain"},"key":"siteId","value":"[SITE_ID]"},{"description":{"content":"(optional) Return users with moderation status in APPROVED or PENDING. (default APPROVED)
\n","type":"text/plain"},"key":"status","value":"[STATUS]"},{"description":{"content":"(optional) If true returns only moderators that are not dashboard users.
\n","type":"text/plain"},"key":"onlyPublicModerators","value":"[BOOLEAN]"},{"description":{"content":"(optional) Only used for sites with local moderation scope.
\n","type":"text/plain"},"key":"chatRoomId","value":"[CHATROOM_ID]"}],"variable":[]}},"response":[{"id":"b71043f3-861e-4d05-b1e2-3db97018ab2e","name":"Get Moderators","originalRequest":{"method":"GET","header":[{"key":"x-api-key","type":"text","value":"qztNqwb5XA77VcofJ1eAv1bZYFrKlZOG95c49iuB"},{"key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":{"raw":"https://api.arena.im/customers-v1/moderation/moderators?siteId=[SITE_ID]&status=[STATUS]&onlyPublicModerators=[BOOLEAN]&chatRoomId=[CHATROOM_ID]","protocol":"https","host":["api","arena","im"],"path":["customers-v1","moderation","moderators"],"query":[{"key":"siteId","value":"[SITE_ID]","description":"(optional) Return only moderators for this site. If omitted, will return all moderators from the first site"},{"key":"status","value":"[STATUS]","description":"(optional) Return users with moderation status in APPROVED or PENDING. (default APPROVED)"},{"key":"onlyPublicModerators","value":"[BOOLEAN]","description":"(optional) If true returns only moderators that are not dashboard users."},{"key":"chatRoomId","value":"[CHATROOM_ID]","description":"(optional) Only used for sites with local moderation scope."}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"items\": [\n {\n \"_id\": \"5ea75bd49e31f47f88f0dccf\",\n \"userId\": \"57e06304429b4d0100be4a55\",\n \"siteId\": \"IChF0zAWZjY6KZwMyyBRWg7DRDw2\",\n \"status\": \"APPROVED\",\n \"label\": \"Pastor\",\n \"isDashboardUser\": false\n },\n {\n \"_id\": \"5f7d08488ccc9200073cd4ca\",\n \"label\": \"Staff\",\n \"siteId\": \"IChF0zAWZjY6KZwMyyBRWg7DRDw2\",\n \"chatRoomId\": \"5f6e68a6af3dd10007ed8b28\",\n \"userId\": \"5ef64acd3cb384db63d357e5\",\n \"status\": \"APPROVED\",\n \"__v\": 0,\n \"isDashboardUser\": false\n }\n ]\n}"}],"_postman_id":"cf329d5b-fb2e-41ed-89b8-2a55a296e9e0"},{"name":"Set User as Moderator","id":"62cc120f-6967-471d-a3a9-3ac080373b33","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-api-key","type":"text","value":"YOUR_API_KEY"},{"key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"siteId\": \"[SITE_ID]\",\n\t\"userId\": \"[USER_ID_ON_MY_SYSTEM]\",\n \"chatRoomId\": \"[CHAT_ROOM_ID]\",\n \"label\": \"Staff\",\n \"visibilityFlag\": true\n}"},"url":"https://api.arena.im/customers-v1/moderation/moderators","description":"Flag an existing user as moderator. Moderators can be added globally to the site or scoped to one chat room.
\nsiteId: Required. All users are scoped within a site.
userId: Required. User's unique id, usually the same id in your own system
chatRoomId: Optional. When set, this moderator will be scoped for this chat room only. Important: This will only work if the current site has the config.globalModerationScope is defined as the value false.
label: Optional. Default is \"Mod\". A descriptive label to identify this user as a moderator: Mod, Admin, Staff, etc..
visibilityFlag: Optional. Default is true , when false, it will not show this moderator on the chat user list, even if the moderator is online.
Remove moderation permissions from the user.
\nuserId: Required. User ID on your authentication system.
\nsiteId: Required. All users are scoped within a site.
chatRoomId: Optional. It should be used only when using moderation restricted by chatRoom.
Ban a user from interacting on chat messages and comments. A user is banned on the site level and not only on a chat room level.
\nThis is a \"shadow ban\", meaning that when a banned user tries to send a message, only they will see the message, other users won't.
\nRequest payload:
\nsiteId (required)
userId user id if the user is signed up/logged in
anonymousId id of the anonymous user
name user name for easier identification on the admin
image user avatar image for easier identification on the admin
One of userId or anonymousId must be informed.
Remove user from the banned list.
\nRequest payload:
\nsiteId (required)
id ID of the Ban. This value can be obtained from the list of all banned users by looking at the key property for the ban object.
List of banned users for the site.
\nUse the key property from the Ban object in order to remove it (unban).
(optional) Return only banned users for this site. If omitted, will return all banned users for the first site
\n","type":"text/plain"},"key":"siteId","value":"[SITE_ID]"}],"variable":[]}},"response":[],"_postman_id":"d6d244d0-b67a-4388-abf6-befb888a86d5"},{"name":"Get Profanity List","id":"318e4997-63ae-4484-a469-a5dae2bd7042","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","value":"YOUR_API_KEY","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://api.arena.im/customers-v1/moderation/profanity?siteId=[SITE_ID]","description":"List of profanity words.
\nUse this dictionary to add/remove words to the profanity list.
\n","urlObject":{"protocol":"https","path":["customers-v1","moderation","profanity"],"host":["api","arena","im"],"query":[{"key":"siteId","value":"[SITE_ID]"}],"variable":[]}},"response":[{"id":"b0e6eef5-43c7-451a-9642-2e9e318c8e63","name":"Get Profanity List","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"YOUR_API_KEY","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"https://api.arena.im/customers-v1/moderation/profanity?siteId=[SITE_ID]","protocol":"https","host":["api","arena","im"],"path":["customers-v1","moderation","profanity"],"query":[{"key":"siteId","value":"[SITE_ID]"}]}},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"[\n \"badword1\",\n \"badword2\"\n]"}],"_postman_id":"318e4997-63ae-4484-a469-a5dae2bd7042"},{"name":"Update Profanity List","id":"73e9dbf7-18b6-4a3b-b12f-b0c805155f8c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-api-key","value":"YOUR_API_KEY","type":"text"}],"body":{"mode":"raw","raw":"{\n \"siteId\": \"[SITE_ID]\",\n \"dictionary\": [\n \"badword1\",\n \"badword2\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.arena.im/customers-v1/moderation/profanity","description":"Update the Profanity dictionary list.
\nThis method does a full update in profanity words.
\n","urlObject":{"protocol":"https","path":["customers-v1","moderation","profanity"],"host":["api","arena","im"],"query":[],"variable":[]}},"response":[{"id":"28b67d2e-ef08-4978-8150-031235ea953e","name":"Update Profanity List","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"YOUR_API_KEY","type":"text"}],"body":{"mode":"raw","raw":"{\n \"siteId\": \"[SITE_ID]\",\n \"dictionary\": [\n \"badword1\",\n \"badword2\",\n \"badword3\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.arena.im/customers-v1/moderation/profanity"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"true"}],"_postman_id":"73e9dbf7-18b6-4a3b-b12f-b0c805155f8c"}],"id":"d1613282-fea1-4431-968e-fcfd7bc41dc6","_postman_id":"d1613282-fea1-4431-968e-fcfd7bc41dc6","description":""},{"name":"Polls","item":[{"name":"Create Poll","id":"0eb7fd3a-f66a-499d-a84d-a4654fca3efc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-api-key","type":"text","value":"YOUR_API_KEY"},{"key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"chatRoomId\": \"CHAT_ROOM_ID\",\n \"channelId\": \"CHANNEL_ID\",\n \"duration\": 900000,\n \"options\": [\"Elvis Presley\", \"John Lenon\", \"Ozzy Osbourne\"],\n \"question\": \"Who's the biggest rockstar?\",\n \"showVotes\": true,\n \"senderId\": \"USER_ID TO DISPLAY\"\n}"},"url":"https://api.arena.im/customers-v1/polls","description":"Add a new Poll and post it to the Channel.
\nRequest fields:
\nsiteId: Site ID where this poll is being added to.
chatRoomId: Chat room to add this Poll to.
channelId: Channel to add this Poll to.
duration: The duration of the Poll (in milliseconds)
options: Array of string with the options for the poll. Each option ideally have less than 30 characters.
question: String with the question to be asked.
showVotes: true|false. When enabled users will be able to see how many total votes the poll had.
senderId: User ID that will be displayed as who published the Poll. This user must be a moderator or admin.
draft: To create polls as draft pass the argument as false. By default, they are created as true.
Delete a Poll.
\nNote: This operation is irreversible.
\n","urlObject":{"protocol":"https","path":["customers-v1","polls","{pollId}"],"host":["api","arena","im"],"query":[],"variable":[]}},"response":[],"_postman_id":"0c26f940-0734-4a39-9181-20d054afe3fe"},{"name":"Update Poll","id":"1757accd-983e-4459-9193-4731e472d8b6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"x-api-key","type":"text","value":"YOUR_API_KEY"},{"key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"duration\": 900000,\n \"options\": [\"Elvis Presley\", \"John Lenon\"],\n \"question\": \"Who's the biggest rockstar?\",\n \"showVotes\": true\n}"},"url":"https://api.arena.im/customers-v1/polls/{pollId}","description":"Update poll information.
\nNote: Only Polls in draft state can be updated.
\nRequest fields:
\nduration: The duration of the Poll (in milliseconds)
options: Array of string with the options for the poll. Each option ideally has less than 30 characters. It is not possible to remove options, only edit or add new ones.
question: String with the question to be asked.
showVotes: true|false. When enabled users will be able to see how many total votes the poll had.
draft: true|false. Changing it to false makes the Poll active and duration starts to count.
Polls are a great way to increase your audience engagement and gather opinion.
\nPolls can be added to Chat Room Channels and they will appear on a separate section and also as a message on the chat room channel feed.
\n","event":[{"listen":"prerequest","script":{"id":"382c229e-4d15-451e-b513-daeaeb73dc3f","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"df9e87b0-e5f2-4573-9d58-58be37673209","type":"text/javascript","exec":[""]}}],"_postman_id":"58ccae6c-c44b-4a42-abb4-795edc16cdba"},{"name":"Q&A","item":[{"name":"Create Q&A","id":"ef5a59d7-b377-4cf2-aeaa-29ff2ec41f23","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-api-key","type":"text","value":"YOUR_API_KEY"},{"key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"siteId\": \"YOUR_SITE_ID\",\n\t\"chatRoomId\": \"CHAT_ROOM_ID\",\n \"channelId\": \"CHANNEL_ID\",\n \"preModeration\": false\n}"},"url":"https://api.arena.im/customers-v1/qnas","description":"[Reserved for future use] Add a new Q&A to the Channel.
\nRequest fields:
\nsiteId: Site ID where this poll is being added to.
chatRoomId: Chat room to add this Q&A to.
channelId: Channel to add this Q&A to.
preModeration: true|false. When enabled the questions will need to be approved before appearing to the public.
Update Q&A.
\nRequest fields:
\npreModeration: true|false. When enabled the questions will need to be approved before appearing to the public.
status: \"OPEN\" or \"CLOSED\" (Closed QnAs cannot receive more questions)
Answer a question and post a message to the chat room channel conversation feed.
\nRequest fields:
\ntext: The answer text.
senderId: User ID that will be displayed as who answered the question. This user must be a moderator or admin.
Return a temporary link to down load questions from a Q&A.
\nPath parameters:
\nqnaId: Required. The id of Q&A
Query parameters:
\nformat : Accepts csv or json. The default value is json.
scopes : Required. A list of questions scopes separated by comma. Accepts: PRE_MODERATION, ARCHIVED , NEW , ANSWERED.
The file format. csv or json
\n","type":"text/plain"},"key":"format","value":"csv"},{"description":{"content":"A list of question scopes separated by a comma.
\n","type":"text/plain"},"key":"scopes","value":"PRE_MODERATION,ARCHIVED,NEW,ANSWERED"}],"variable":[]}},"response":[{"id":"85d68ccf-b2b8-405c-8cbc-d0cb43411e94","name":"Export Questions","originalRequest":{"method":"POST","header":[{"key":"x-api-key","type":"text","value":"YOUR_API_KEY"},{"key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":{"raw":"https://api.arena.im/customers-v1/qnas/{qnaId}/export?format=json&scopes=NEW,PRE_MODERATION","protocol":"https","host":["api","arena","im"],"path":["customers-v1","qnas","{qnaId}","export"],"query":[{"key":"format","value":"json"},{"key":"scopes","value":"NEW,PRE_MODERATION"}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n\t\"fileUrl\": \"https://arena-chat-archive-dev.signed.url\"\n}"}],"_postman_id":"a6609de0-b01f-4687-99c4-cf6dd0c8f6a0"},{"name":"List Questions","id":"d8ed49d9-435c-4c97-8fa8-d9d84ad1a808","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","type":"text","value":"YOUR_API_KEY"},{"key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://api.arena.im/customers-v1/qnas/{qnaId}/questions?orderByField=createdAt&orderByDirection=desc&limit=20&startAfter={latestId}&collection=questions","description":"List all Q&A questions.
\nqnaIsEnabled defined to true. This means that this channel has a Q&A created. You can create a Q&A using this request.qnaId - The id of Q&A. This information could be acquired in the Channels payload when the channel has Q&A activated.Field to order by, default 'createdAt'
\n","type":"text/plain"},"key":"orderByField","value":"createdAt"},{"description":{"content":"Order direction, desc or asc. Default desc.
\n","type":"text/plain"},"key":"orderByDirection","value":"desc"},{"description":{"content":"For pagination, how many results to return
\n","type":"text/plain"},"key":"limit","value":"20"},{"description":{"content":"For pagination, pass the latest _id from the previous call
\n","type":"text/plain"},"key":"startAfter","value":"{latestId}"},{"description":{"content":"\"questions\" or \"pre-moderation\"
\n","type":"text/plain"},"key":"collection","value":"questions"}],"variable":[]}},"response":[],"_postman_id":"d8ed49d9-435c-4c97-8fa8-d9d84ad1a808"}],"id":"97b1909f-e5e1-4820-a84e-9b48b9610486","description":"Q&As are a great way to engage with your audience in a more supervised way.
\nQ&As can be added to chat room channels and the audience can upvote the questions they like the most, moderators can answer/delete questions and, when answered, it will be posted to the chat room channel conversation feed.
\n","event":[{"listen":"prerequest","script":{"id":"16d6b0e4-9895-4ede-8bf3-bc9d4b0e4790","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"df956861-8af1-4e1b-8643-45db334ea0f6","type":"text/javascript","exec":[""]}}],"_postman_id":"97b1909f-e5e1-4820-a84e-9b48b9610486"},{"name":"Android SDK","item":[],"id":"e8d24750-255a-403b-955a-7c3f1c20e90a","description":"\nArena provides a ready-to-use live group chat activity that doesn't require
any development effort and it can power many of the common scenarios.
For more complex use-cases we made available the Kotlin SDK that
provides the infra-structure necessary to build your own chat experience
and at the same time leverage the powerful moderation and backoffice
tools available at the Arena Dashboard.
Installing the Chat SDK is simple if you’re familiar with using external libraries or SDKs. To install the Chat SDK using Gradle, add the following lines to a build.gradle file at the app level.
repositories {\n mavenCentral()\n}\n\ndependencies {\n implementation 'im.arena:chat:1.0.0'\n}\nWhen you build your APK with minifyEnabled true, add the following line to the module's ProGuard rules file.
\n-keep class im.arena.chat.** { *; }\n-keep class im.arena.analytics.** { *; }\n-keep class im.arena.commons.** { *; }\n-keep class im.arena.realtimedata.** { *; }\nInitialization links the SDK to the Android context, allowing you to respond to connection and status changes.\nThe ChatActivity.configure() method must be called once across your Android client app. It is recommended to initialize the in the onCreate() method of the Application instance.
\nChatActivity\n .logLevel(LogLevel.DEBUG)\n .environment(environment)\n .configure(application, writeKey, slug)\nAPPLICATION: Base class for maintaining global application state.WRITE_KEY: The write key is the one used to initialize the SDK and will be provided by Arena teamSLUG: Base class for maintaining global application state.To initialize the SDK you'll need your site slug and a chat room slug and both can be obtained from the Arena Dashboard or using the Platform API.
\nYou can find your site slug in the dashboard settings: https://dashboard.arena.im/settings/site.
\n![\"Chat\"](\"https://github.com/stationfy/Arena-SDK-Android/raw/master/showcase/Chat.png\")
To initialize the sdk it is necessary called:
\nChatActivity\n .start(activity, activityLauncher)\nACTIVITY: Scope of current running screen.ACTIVITY_RESULT_LAUNCHER: A launcher for a previously-ActivityResultCaller#registerForActivityResult to start the process of executing an ActivityResultContract.Or
\nChatActivity\n .start(fragment, activityLauncher)\nFRAGMENT: Scope of current running screen.ACTIVITY_RESULT_LAUNCHER: A launcher for a previously-ActivityResultCaller#registerForActivityResult to start the process of executing an ActivityResultContract.Chat allows the product to have its own SSO login flow. Users can now enter
the chat while logged in. This requires the SDK client, the user data calling:
ChatViewModel.externalUser( \n ExternalUser(id, name, email, image, familyName, givenName, extras) \n)\nIf the chat is started in anonymous mode and the user chooses to login with SSO, the ActivityResultCallback sent in SDK start will be called for the client to call its login flow
\nprivate val activityResultCallback = ActivityResultCallback<ActivityResult> {\n if (it.resultCode == RESULT_FIRST_USER) {\n ChatViewModel.externalUser(\n ExternalUser(id, name, email, image, familyName, givenName, extras) \n )\n \n ChatActivity.start(this, activityLauncher)\n }\n}\n