{"item":[{"id":"5f8c7af5-7ddb-42e1-b090-5a254467d853","name":"Authorization","description":{"content":"","type":"text/plain"},"item":[{"id":"360090c0-c5b5-4a37-b94f-a36b02cbfebe","name":"Refresh a Profile token","request":{"name":"Refresh a Profile token","description":{"content":"Retrieve a refreshed JWT Token to prolong the session.\n\nThe current token must still be active at the time of the request.\n\n---\n\n**API consumers:** Profile (Client), Anonymous Profile\n\n**Authentication:** Not required\n","type":"text/plain"},"url":{"path":["sauth","v3","auth","refresh","client"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"apiKey\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"1a2dd827-ff7d-453a-b36c-ee864341cbac","name":"New authorization token","originalRequest":{"url":{"path":["sauth","v3","auth","refresh","client"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"apiKey\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"token\": \"string\",\n \"expiration\": 1649283173,\n \"created\": 1649277173668,\n \"origin\": \"SYNERISE\",\n \"customId\": \"card123\",\n \"realm\": \"client\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"47125f26-6f26-42c9-8248-3b603aa76f3d","name":"Unauthorized","originalRequest":{"url":{"path":["sauth","v3","auth","refresh","client"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"apiKey\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"2019-03-19T13:57:33.244+00:00\",\n \"status\": 401,\n \"error\": \"Unauthorized\",\n \"message\": \"Full authentication is required to access this resource\",\n \"path\": \"/v3/auth/refresh/client\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"c9a9aee8-fc79-450e-bbb8-9d6e4b960169","name":"Authenticate as Profile","request":{"name":"Authenticate as Profile","description":{"content":"Obtain a new JWT for a Profile. If an account for the Profile does not exist and the `identityProvider` is different than `SYNERISE`, this request creates an account.\n\n---\n\n**Authentication:** Not required\n","type":"text/plain"},"url":{"path":["sauth","v3","auth","login","client"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":null,"body":{"mode":"raw","raw":"{\n \"apiKey\": \"string\",\n \"identityProvider\": \"GOOGLE\",\n \"identityProviderToken\": \"string\",\n \"email\": \"string\",\n \"customId\": {},\n \"password\": \"string\",\n \"uuid\": \"string\",\n \"deviceId\": \"string\",\n \"agreements\": {\n \"email\": true,\n \"sms\": true,\n \"push\": true,\n \"bluetooth\": false,\n \"rfid\": false,\n \"wifi\": false\n },\n \"attributes\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n },\n \"key_2\": {\n \"value\": \"\"\n }\n },\n \"tags\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"bc86176f-d7af-4633-80ad-193a320929a5","name":"Profile authorization token","originalRequest":{"url":{"path":["sauth","v3","auth","login","client"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"apiKey\": \"string\",\n \"identityProvider\": \"GOOGLE\",\n \"identityProviderToken\": \"string\",\n \"email\": \"string\",\n \"customId\": {},\n \"password\": \"string\",\n \"uuid\": \"string\",\n \"deviceId\": \"string\",\n \"agreements\": {\n \"email\": true,\n \"sms\": true,\n \"push\": true,\n \"bluetooth\": false,\n \"rfid\": false,\n \"wifi\": false\n },\n \"attributes\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n },\n \"key_2\": {\n \"value\": \"\"\n }\n },\n \"tags\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"token\": \"eyJhbGciOiJSUzUxMiJ9.eyJzdinvalidwYmZkM2FkNDg2ZjQ3ZGRiMjE5MSIsImF1ZCI6IkFQSSIsInJsbSI6ImFub255bW91c19jbGllbnQiLCJjdGQiOjE1NTMwMDQxNTkxNTEsImVtbCI6IjYyMjM3NmY4LTAwMDAtMjIyMi1kN2Y5LTA3MGZhOTU2ZTk2M0Bhbm9ueW1vdXMuaW52YWxpZCIsImF1dGgiOiJINHNJQUFBQUFBQUFBSXVPQlFBcHUwd05BZ0FBQUE9PSIsImlzcyI6IlN5bmVyaXNlIiwiYnBpIjo0OCwiY2xJZCI6NDMzMjMwMjg4LCJleHAiOjE1NTMwMDcxNTksImFwayI6IjVBRUFBM0Q1LUUxNDctQzdFQi1ENTlFLUJDRjUwMTA5QTNEMSJ9.QOmSqrneR4mJFv4JdxTYsw_wGcDawDsVQuB-GVTcPPwijiP7lQ_Jzqq2Mypg1BS6WFlfGB8fzqCY9iMF_TdtjmoB4xBrY95ylU8L9qto-9Cw5x5TURkfxq31eryiHe2IteRAEtoVzYg2_s9QhlH6ANVcFOVp8dMno0V9bfMYfeSQa3FkjEbxFsseHkMOiADmp9-tOGtLXO942Ir-2W_Hz3Utlpt4erz0dVJBw8a-mFavPA8EEDWR7ACJNocrVHFkS3wFISh3LqLn6KkXiowaynKlJOEHGctuahzKmF3ZOJ1BvGgKohxF9OXvQs9IdmCfWhYsLr5Q2p04TJJ-MyvTipuggKVioh8mHmOFdfnN-Zused6tXzhZtKPUWTmM8cBKoAOBHExxcMQ8SVSjxnw_7_eLKm7S2wNpu0V-tiPZPCH4wYZXtWBYjmfy0V9ydjXnNunXfgxKixLeFNnONUXxEuqPLvM_xAuonQBXVN4nYrgJv8p8U6_ZlGMPjJq1szfcuBZnzI34LSEWx_nSof0XC5Czm8iG_ihG8naivNWS8h-Q-qKMP_3PPFsLSH4Egh03pH93EJUuNAeSO4RGfUX1wzMvrv1nBC1SM660uFMbq-wkplFBbKnHKMYe-qRs1-lZPG5PwPWJJdpGqOUzbnoMOJYmiq06OHHVQyJSkcEHLCk\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"fc5d8173-d23f-40d4-942f-aeec9b4d92c4","name":"Request failed, see error message for details","originalRequest":{"url":{"path":["sauth","v3","auth","login","client"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"apiKey\": \"string\",\n \"identityProvider\": \"GOOGLE\",\n \"identityProviderToken\": \"string\",\n \"email\": \"string\",\n \"customId\": {},\n \"password\": \"string\",\n \"uuid\": \"string\",\n \"deviceId\": \"string\",\n \"agreements\": {\n \"email\": true,\n \"sms\": true,\n \"push\": true,\n \"bluetooth\": false,\n \"rfid\": false,\n \"wifi\": false\n },\n \"attributes\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n },\n \"key_2\": {\n \"value\": \"\"\n }\n },\n \"tags\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"errors\": {\n \"value\": \"\"\n },\n \"status\": {\n \"value\": \"\"\n },\n \"timestamp\": {\n \"value\": \"\"\n },\n \"path\": {\n \"value\": \"\"\n },\n \"traceId\": {\n \"value\": \"\"\n },\n \"errorCode\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"622ead42-829c-4147-bb51-de3fc05bd7b4","name":"Unauthorized.","originalRequest":{"url":{"path":["sauth","v3","auth","login","client"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"apiKey\": \"string\",\n \"identityProvider\": \"GOOGLE\",\n \"identityProviderToken\": \"string\",\n \"email\": \"string\",\n \"customId\": {},\n \"password\": \"string\",\n \"uuid\": \"string\",\n \"deviceId\": \"string\",\n \"agreements\": {\n \"email\": true,\n \"sms\": true,\n \"push\": true,\n \"bluetooth\": false,\n \"rfid\": false,\n \"wifi\": false\n },\n \"attributes\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n },\n \"key_2\": {\n \"value\": \"\"\n }\n },\n \"tags\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"2018-06-07T07:17:41.734+00:00\",\n \"status\": 401,\n \"error\": \"Unauthorized\",\n \"message\": \"Access denied\",\n \"path\": \"/v3/auth/login/client\",\n \"traceId\": \"61b4aa7c0cb1167a\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"bf1d54b7-1cf1-47cb-8127-6207105faaed","name":"Authentication failed, see error message for details","originalRequest":{"url":{"path":["sauth","v3","auth","login","client"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"apiKey\": \"string\",\n \"identityProvider\": \"GOOGLE\",\n \"identityProviderToken\": \"string\",\n \"email\": \"string\",\n \"customId\": {},\n \"password\": \"string\",\n \"uuid\": \"string\",\n \"deviceId\": \"string\",\n \"agreements\": {\n \"email\": true,\n \"sms\": true,\n \"push\": true,\n \"bluetooth\": false,\n \"rfid\": false,\n \"wifi\": false\n },\n \"attributes\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n },\n \"key_2\": {\n \"value\": \"\"\n }\n },\n \"tags\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"errors\": {\n \"value\": \"\"\n },\n \"status\": {\n \"value\": \"\"\n },\n \"timestamp\": {\n \"value\": \"\"\n },\n \"path\": {\n \"value\": \"\"\n },\n \"traceId\": {\n \"value\": \"\"\n },\n \"errorCode\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"75826175-2df2-4570-9417-2594823ee1da","name":"Profile not found","originalRequest":{"url":{"path":["sauth","v3","auth","login","client"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"apiKey\": \"string\",\n \"identityProvider\": \"GOOGLE\",\n \"identityProviderToken\": \"string\",\n \"email\": \"string\",\n \"customId\": {},\n \"password\": \"string\",\n \"uuid\": \"string\",\n \"deviceId\": \"string\",\n \"agreements\": {\n \"email\": true,\n \"sms\": true,\n \"push\": true,\n \"bluetooth\": false,\n \"rfid\": false,\n \"wifi\": false\n },\n \"attributes\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n },\n \"key_2\": {\n \"value\": \"\"\n }\n },\n \"tags\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"2018-06-07T07:17:41.734+00:00\",\n \"status\": 404,\n \"error\": \"Not Found\",\n \"message\": \"Account does not exist\",\n \"path\": \"/v3/auth/login/client\",\n \"traceId\": \"61b4aa7c0cb1167a\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"f8bcd895-8a6e-4cc5-a0f6-9a9254e2e25e","name":"Account is locked, password reset required","originalRequest":{"url":{"path":["sauth","v3","auth","login","client"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"apiKey\": \"string\",\n \"identityProvider\": \"GOOGLE\",\n \"identityProviderToken\": \"string\",\n \"email\": \"string\",\n \"customId\": {},\n \"password\": \"string\",\n \"uuid\": \"string\",\n \"deviceId\": \"string\",\n \"agreements\": {\n \"email\": true,\n \"sms\": true,\n \"push\": true,\n \"bluetooth\": false,\n \"rfid\": false,\n \"wifi\": false\n },\n \"attributes\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n },\n \"key_2\": {\n \"value\": \"\"\n }\n },\n \"tags\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"Not Acceptable","code":406,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"2021-09-15T10:01:16.203120Z\",\n \"status\": 406,\n \"error\": \"Banned\",\n \"message\": \"Log in has been blocked\",\n \"path\": \"/v2/auth/login/client\",\n \"traceId\": \"61b4aa7c0cb1167a\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"477f6cdd-85a1-455e-b1db-5023622b90e7","name":"Device control is enabled, device must be authorized (link sent by email)","originalRequest":{"url":{"path":["sauth","v3","auth","login","client"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"apiKey\": \"string\",\n \"identityProvider\": \"GOOGLE\",\n \"identityProviderToken\": \"string\",\n \"email\": \"string\",\n \"customId\": {},\n \"password\": \"string\",\n \"uuid\": \"string\",\n \"deviceId\": \"string\",\n \"agreements\": {\n \"email\": true,\n \"sms\": true,\n \"push\": true,\n \"bluetooth\": false,\n \"rfid\": false,\n \"wifi\": false\n },\n \"attributes\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n },\n \"key_2\": {\n \"value\": \"\"\n }\n },\n \"tags\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"Locked (WebDAV) (RFC 4918)","code":423,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"2021-09-15T10:01:16.203120Z\",\n \"status\": 423,\n \"error\": \"Locked\",\n \"message\": \"Device login blocked\",\n \"path\": \"/v2/auth/login/client\",\n \"traceId\": \"61b4aa7c0cb1167a\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"a77c65df-9cac-4d47-94f4-0ca52ecd8470","name":"Authenticate Profile with a server","request":{"name":"Authenticate Profile with a server","description":{"content":"Obtain a new JWT for a Profile. This method is designed to be used from a backend server that handles login requests and communicates with Synerise to execute them. \nIf an account for the Profile does not exist and the `identityProvider` is different than `SYNERISE`, this request creates an account.\n\n\n---\n\n**API consumer:** Workspace (Business Profile)\n\n**API key permission required:** `SAUTH_SERVER_LOGIN_CLIENT_CREATE`\n","type":"text/plain"},"url":{"path":["sauth","v3","auth","server","login","client"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":null,"body":{"mode":"raw","raw":"{\n \"apiKey\": {\n \"value\": \"\"\n },\n \"identityProvider\": {\n \"value\": \"\"\n },\n \"ipAddress\": \"string\",\n \"identityProviderToken\": {\n \"value\": \"\"\n },\n \"email\": {\n \"value\": \"\"\n },\n \"customId\": {\n \"value\": \"\"\n },\n \"password\": {\n \"value\": \"\"\n },\n \"uuid\": {\n \"value\": \"\"\n },\n \"deviceId\": {\n \"value\": \"\"\n },\n \"agreements\": {\n \"value\": \"\"\n },\n \"attributes\": {\n \"value\": \"\"\n },\n \"tags\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"d7dbee25-6a56-4116-a312-663639286713","name":"Profile authorization token","originalRequest":{"url":{"path":["sauth","v3","auth","server","login","client"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"apiKey\": {\n \"value\": \"\"\n },\n \"identityProvider\": {\n \"value\": \"\"\n },\n \"ipAddress\": \"string\",\n \"identityProviderToken\": {\n \"value\": \"\"\n },\n \"email\": {\n \"value\": \"\"\n },\n \"customId\": {\n \"value\": \"\"\n },\n \"password\": {\n \"value\": \"\"\n },\n \"uuid\": {\n \"value\": \"\"\n },\n \"deviceId\": {\n \"value\": \"\"\n },\n \"agreements\": {\n \"value\": \"\"\n },\n \"attributes\": {\n \"value\": \"\"\n },\n \"tags\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"token\": \"eyJhbGciOiJSUzUxMiJ9.eyJzdinvalidwYmZkM2FkNDg2ZjQ3ZGRiMjE5MSIsImF1ZCI6IkFQSSIsInJsbSI6ImFub255bW91c19jbGllbnQiLCJjdGQiOjE1NTMwMDQxNTkxNTEsImVtbCI6IjYyMjM3NmY4LTAwMDAtMjIyMi1kN2Y5LTA3MGZhOTU2ZTk2M0Bhbm9ueW1vdXMuaW52YWxpZCIsImF1dGgiOiJINHNJQUFBQUFBQUFBSXVPQlFBcHUwd05BZ0FBQUE9PSIsImlzcyI6IlN5bmVyaXNlIiwiYnBpIjo0OCwiY2xJZCI6NDMzMjMwMjg4LCJleHAiOjE1NTMwMDcxNTksImFwayI6IjVBRUFBM0Q1LUUxNDctQzdFQi1ENTlFLUJDRjUwMTA5QTNEMSJ9.QOmSqrneR4mJFv4JdxTYsw_wGcDawDsVQuB-GVTcPPwijiP7lQ_Jzqq2Mypg1BS6WFlfGB8fzqCY9iMF_TdtjmoB4xBrY95ylU8L9qto-9Cw5x5TURkfxq31eryiHe2IteRAEtoVzYg2_s9QhlH6ANVcFOVp8dMno0V9bfMYfeSQa3FkjEbxFsseHkMOiADmp9-tOGtLXO942Ir-2W_Hz3Utlpt4erz0dVJBw8a-mFavPA8EEDWR7ACJNocrVHFkS3wFISh3LqLn6KkXiowaynKlJOEHGctuahzKmF3ZOJ1BvGgKohxF9OXvQs9IdmCfWhYsLr5Q2p04TJJ-MyvTipuggKVioh8mHmOFdfnN-Zused6tXzhZtKPUWTmM8cBKoAOBHExxcMQ8SVSjxnw_7_eLKm7S2wNpu0V-tiPZPCH4wYZXtWBYjmfy0V9ydjXnNunXfgxKixLeFNnONUXxEuqPLvM_xAuonQBXVN4nYrgJv8p8U6_ZlGMPjJq1szfcuBZnzI34LSEWx_nSof0XC5Czm8iG_ihG8naivNWS8h-Q-qKMP_3PPFsLSH4Egh03pH93EJUuNAeSO4RGfUX1wzMvrv1nBC1SM660uFMbq-wkplFBbKnHKMYe-qRs1-lZPG5PwPWJJdpGqOUzbnoMOJYmiq06OHHVQyJSkcEHLCk\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"8dc15986-ddcd-4444-981f-2f5690ec53f8","name":"Request failed, see error message for details","originalRequest":{"url":{"path":["sauth","v3","auth","server","login","client"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"apiKey\": {\n \"value\": \"\"\n },\n \"identityProvider\": {\n \"value\": \"\"\n },\n \"ipAddress\": \"string\",\n \"identityProviderToken\": {\n \"value\": \"\"\n },\n \"email\": {\n \"value\": \"\"\n },\n \"customId\": {\n \"value\": \"\"\n },\n \"password\": {\n \"value\": \"\"\n },\n \"uuid\": {\n \"value\": \"\"\n },\n \"deviceId\": {\n \"value\": \"\"\n },\n \"agreements\": {\n \"value\": \"\"\n },\n \"attributes\": {\n \"value\": \"\"\n },\n \"tags\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"errors\": {\n \"value\": \"\"\n },\n \"status\": {\n \"value\": \"\"\n },\n \"timestamp\": {\n \"value\": \"\"\n },\n \"path\": {\n \"value\": \"\"\n },\n \"traceId\": {\n \"value\": \"\"\n },\n \"errorCode\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"3a666693-6960-4213-8578-1a6bb99bba6e","name":"Unauthorized.","originalRequest":{"url":{"path":["sauth","v3","auth","server","login","client"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"apiKey\": {\n \"value\": \"\"\n },\n \"identityProvider\": {\n \"value\": \"\"\n },\n \"ipAddress\": \"string\",\n \"identityProviderToken\": {\n \"value\": \"\"\n },\n \"email\": {\n \"value\": \"\"\n },\n \"customId\": {\n \"value\": \"\"\n },\n \"password\": {\n \"value\": \"\"\n },\n \"uuid\": {\n \"value\": \"\"\n },\n \"deviceId\": {\n \"value\": \"\"\n },\n \"agreements\": {\n \"value\": \"\"\n },\n \"attributes\": {\n \"value\": \"\"\n },\n \"tags\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"2018-06-07T07:17:41.734+00:00\",\n \"status\": 401,\n \"error\": \"Unauthorized\",\n \"message\": \"Access denied\",\n \"path\": \"/v3/auth/login/client\",\n \"traceId\": \"61b4aa7c0cb1167a\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"c8739fbc-76bf-460b-b125-db6b84611192","name":"Authentication failed, see error message for details","originalRequest":{"url":{"path":["sauth","v3","auth","server","login","client"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"apiKey\": {\n \"value\": \"\"\n },\n \"identityProvider\": {\n \"value\": \"\"\n },\n \"ipAddress\": \"string\",\n \"identityProviderToken\": {\n \"value\": \"\"\n },\n \"email\": {\n \"value\": \"\"\n },\n \"customId\": {\n \"value\": \"\"\n },\n \"password\": {\n \"value\": \"\"\n },\n \"uuid\": {\n \"value\": \"\"\n },\n \"deviceId\": {\n \"value\": \"\"\n },\n \"agreements\": {\n \"value\": \"\"\n },\n \"attributes\": {\n \"value\": \"\"\n },\n \"tags\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"errors\": {\n \"value\": \"\"\n },\n \"status\": {\n \"value\": \"\"\n },\n \"timestamp\": {\n \"value\": \"\"\n },\n \"path\": {\n \"value\": \"\"\n },\n \"traceId\": {\n \"value\": \"\"\n },\n \"errorCode\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"9979f800-6758-45fb-aca8-31ae79a9cd3a","name":"Profile not found","originalRequest":{"url":{"path":["sauth","v3","auth","server","login","client"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"apiKey\": {\n \"value\": \"\"\n },\n \"identityProvider\": {\n \"value\": \"\"\n },\n \"ipAddress\": \"string\",\n \"identityProviderToken\": {\n \"value\": \"\"\n },\n \"email\": {\n \"value\": \"\"\n },\n \"customId\": {\n \"value\": \"\"\n },\n \"password\": {\n \"value\": \"\"\n },\n \"uuid\": {\n \"value\": \"\"\n },\n \"deviceId\": {\n \"value\": \"\"\n },\n \"agreements\": {\n \"value\": \"\"\n },\n \"attributes\": {\n \"value\": \"\"\n },\n \"tags\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"2018-06-07T07:17:41.734+00:00\",\n \"status\": 404,\n \"error\": \"Not Found\",\n \"message\": \"Account does not exist\",\n \"path\": \"/v3/auth/login/client\",\n \"traceId\": \"61b4aa7c0cb1167a\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"dd1effba-2a0d-4558-9264-b5fb39f66035","name":"Account is locked, password reset required","originalRequest":{"url":{"path":["sauth","v3","auth","server","login","client"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"apiKey\": {\n \"value\": \"\"\n },\n \"identityProvider\": {\n \"value\": \"\"\n },\n \"ipAddress\": \"string\",\n \"identityProviderToken\": {\n \"value\": \"\"\n },\n \"email\": {\n \"value\": \"\"\n },\n \"customId\": {\n \"value\": \"\"\n },\n \"password\": {\n \"value\": \"\"\n },\n \"uuid\": {\n \"value\": \"\"\n },\n \"deviceId\": {\n \"value\": \"\"\n },\n \"agreements\": {\n \"value\": \"\"\n },\n \"attributes\": {\n \"value\": \"\"\n },\n \"tags\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Not Acceptable","code":406,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"2021-09-15T10:01:16.203120Z\",\n \"status\": 406,\n \"error\": \"Banned\",\n \"message\": \"Log in has been blocked\",\n \"path\": \"/v2/auth/login/client\",\n \"traceId\": \"61b4aa7c0cb1167a\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"df4dbf2f-e2cb-406e-8144-61296a73ef90","name":"Device control is enabled, device must be authorized (link sent by email)","originalRequest":{"url":{"path":["sauth","v3","auth","server","login","client"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"apiKey\": {\n \"value\": \"\"\n },\n \"identityProvider\": {\n \"value\": \"\"\n },\n \"ipAddress\": \"string\",\n \"identityProviderToken\": {\n \"value\": \"\"\n },\n \"email\": {\n \"value\": \"\"\n },\n \"customId\": {\n \"value\": \"\"\n },\n \"password\": {\n \"value\": \"\"\n },\n \"uuid\": {\n \"value\": \"\"\n },\n \"deviceId\": {\n \"value\": \"\"\n },\n \"agreements\": {\n \"value\": \"\"\n },\n \"attributes\": {\n \"value\": \"\"\n },\n \"tags\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Locked (WebDAV) (RFC 4918)","code":423,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"2021-09-15T10:01:16.203120Z\",\n \"status\": 423,\n \"error\": \"Locked\",\n \"message\": \"Device login blocked\",\n \"path\": \"/v2/auth/login/client\",\n \"traceId\": \"61b4aa7c0cb1167a\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"7436e2d9-58bf-4824-9f6b-90bd2860ea59","name":"Authenticate as Profile (conditional)","request":{"name":"Authenticate as Profile (conditional)","description":{"content":"Obtain a new JWT token for a Profile.\n\n- If the account does not exist, an account is not created.\n- If any additional conditions are required for logging in, the response is HTTP200 and lists the conditions.\n- Note that using this endpoint requires authenticating as an anonymous Profile first.\n\n\n---\n\n**Authentication:** Not required\n","type":"text/plain"},"url":{"path":["sauth","v3","auth","login","client","conditional"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"apiKey\": \"string\",\n \"identityProvider\": \"GOOGLE\",\n \"identityProviderToken\": \"string\",\n \"email\": \"string\",\n \"customId\": {},\n \"password\": \"string\",\n \"uuid\": \"string\",\n \"deviceId\": \"string\",\n \"agreements\": {\n \"email\": true,\n \"sms\": true,\n \"push\": true,\n \"bluetooth\": false,\n \"rfid\": false,\n \"wifi\": false\n },\n \"attributes\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n },\n \"key_2\": {\n \"value\": \"\"\n }\n },\n \"tags\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"d4af15bf-f3e2-4125-985a-fcec8f7438d9","name":"Details of the login operation","originalRequest":{"url":{"path":["sauth","v3","auth","login","client","conditional"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"apiKey\": \"string\",\n \"identityProvider\": \"GOOGLE\",\n \"identityProviderToken\": \"string\",\n \"email\": \"string\",\n \"customId\": {},\n \"password\": \"string\",\n \"uuid\": \"string\",\n \"deviceId\": \"string\",\n \"agreements\": {\n \"email\": true,\n \"sms\": true,\n \"push\": true,\n \"bluetooth\": false,\n \"rfid\": false,\n \"wifi\": false\n },\n \"attributes\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n },\n \"key_2\": {\n \"value\": \"\"\n }\n },\n \"tags\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"conditions\": [\n \"string\",\n \"string\"\n ],\n \"status\": \"UNAUTHORIZED\",\n \"token\": \"string\",\n \"expiration\": 1649283173,\n \"created\": 1649277173668,\n \"origin\": \"SYNERISE\",\n \"customId\": \"card123\",\n \"realm\": \"client\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"809af72d-b35a-4bb5-bd32-14078d3b4172","name":"Request failed, see error message for details","originalRequest":{"url":{"path":["sauth","v3","auth","login","client","conditional"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"apiKey\": \"string\",\n \"identityProvider\": \"GOOGLE\",\n \"identityProviderToken\": \"string\",\n \"email\": \"string\",\n \"customId\": {},\n \"password\": \"string\",\n \"uuid\": \"string\",\n \"deviceId\": \"string\",\n \"agreements\": {\n \"email\": true,\n \"sms\": true,\n \"push\": true,\n \"bluetooth\": false,\n \"rfid\": false,\n \"wifi\": false\n },\n \"attributes\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n },\n \"key_2\": {\n \"value\": \"\"\n }\n },\n \"tags\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"errors\": {\n \"value\": \"\"\n },\n \"status\": {\n \"value\": \"\"\n },\n \"timestamp\": {\n \"value\": \"\"\n },\n \"path\": {\n \"value\": \"\"\n },\n \"traceId\": {\n \"value\": \"\"\n },\n \"errorCode\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"a0368bfa-1d5e-4877-b9a7-bdc0d693b861","name":"See error message for details","originalRequest":{"url":{"path":["sauth","v3","auth","login","client","conditional"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"apiKey\": \"string\",\n \"identityProvider\": \"GOOGLE\",\n \"identityProviderToken\": \"string\",\n \"email\": \"string\",\n \"customId\": {},\n \"password\": \"string\",\n \"uuid\": \"string\",\n \"deviceId\": \"string\",\n \"agreements\": {\n \"email\": true,\n \"sms\": true,\n \"push\": true,\n \"bluetooth\": false,\n \"rfid\": false,\n \"wifi\": false\n },\n \"attributes\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n },\n \"key_2\": {\n \"value\": \"\"\n }\n },\n \"tags\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\",\n \"message\": \"string\",\n \"errors\": [\n {\n \"code\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"rejectedValue\": {\n \"value\": \"\"\n }\n },\n {\n \"code\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"rejectedValue\": {\n \"value\": \"\"\n }\n }\n ],\n \"status\": 8944,\n \"timestamp\": \"string\",\n \"path\": \"string\",\n \"traceId\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"44ad317e-3298-4adf-9800-db5108a421d0","name":"Authentication failed, see error message for details","originalRequest":{"url":{"path":["sauth","v3","auth","login","client","conditional"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"apiKey\": \"string\",\n \"identityProvider\": \"GOOGLE\",\n \"identityProviderToken\": \"string\",\n \"email\": \"string\",\n \"customId\": {},\n \"password\": \"string\",\n \"uuid\": \"string\",\n \"deviceId\": \"string\",\n \"agreements\": {\n \"email\": true,\n \"sms\": true,\n \"push\": true,\n \"bluetooth\": false,\n \"rfid\": false,\n \"wifi\": false\n },\n \"attributes\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n },\n \"key_2\": {\n \"value\": \"\"\n }\n },\n \"tags\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"errors\": {\n \"value\": \"\"\n },\n \"status\": {\n \"value\": \"\"\n },\n \"timestamp\": {\n \"value\": \"\"\n },\n \"path\": {\n \"value\": \"\"\n },\n \"traceId\": {\n \"value\": \"\"\n },\n \"errorCode\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"87bf7b69-5b34-47d7-9c7d-faaca983a81d","name":"Profile not found","originalRequest":{"url":{"path":["sauth","v3","auth","login","client","conditional"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"apiKey\": \"string\",\n \"identityProvider\": \"GOOGLE\",\n \"identityProviderToken\": \"string\",\n \"email\": \"string\",\n \"customId\": {},\n \"password\": \"string\",\n \"uuid\": \"string\",\n \"deviceId\": \"string\",\n \"agreements\": {\n \"email\": true,\n \"sms\": true,\n \"push\": true,\n \"bluetooth\": false,\n \"rfid\": false,\n \"wifi\": false\n },\n \"attributes\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n },\n \"key_2\": {\n \"value\": \"\"\n }\n },\n \"tags\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"2018-06-07T07:17:41.734+00:00\",\n \"status\": 404,\n \"error\": \"Not Found\",\n \"message\": \"Account does not exist\",\n \"path\": \"/v3/auth/login/client/conditional\",\n \"traceId\": \"61b4aa7c0cb1167a\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"adffb296-fb3b-4332-b1db-4551dcae40da","name":"Account is locked, password reset required","originalRequest":{"url":{"path":["sauth","v3","auth","login","client","conditional"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"apiKey\": \"string\",\n \"identityProvider\": \"GOOGLE\",\n \"identityProviderToken\": \"string\",\n \"email\": \"string\",\n \"customId\": {},\n \"password\": \"string\",\n \"uuid\": \"string\",\n \"deviceId\": \"string\",\n \"agreements\": {\n \"email\": true,\n \"sms\": true,\n \"push\": true,\n \"bluetooth\": false,\n \"rfid\": false,\n \"wifi\": false\n },\n \"attributes\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n },\n \"key_2\": {\n \"value\": \"\"\n }\n },\n \"tags\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"Not Acceptable","code":406,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"2021-09-15T10:01:16.203120Z\",\n \"status\": 406,\n \"error\": \"Banned\",\n \"message\": \"Log in has been blocked\",\n \"path\": \"/v2/auth/login/client\",\n \"traceId\": \"61b4aa7c0cb1167a\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"14311655-f8f1-47b9-b787-5e35ebd1167c","name":"Device control is enabled, device must be authorized (link sent by email)","originalRequest":{"url":{"path":["sauth","v3","auth","login","client","conditional"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"apiKey\": \"string\",\n \"identityProvider\": \"GOOGLE\",\n \"identityProviderToken\": \"string\",\n \"email\": \"string\",\n \"customId\": {},\n \"password\": \"string\",\n \"uuid\": \"string\",\n \"deviceId\": \"string\",\n \"agreements\": {\n \"email\": true,\n \"sms\": true,\n \"push\": true,\n \"bluetooth\": false,\n \"rfid\": false,\n \"wifi\": false\n },\n \"attributes\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n },\n \"key_2\": {\n \"value\": \"\"\n }\n },\n \"tags\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"Locked (WebDAV) (RFC 4918)","code":423,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"2021-09-15T10:01:16.203120Z\",\n \"status\": 423,\n \"error\": \"Locked\",\n \"message\": \"Device login blocked\",\n \"path\": \"/v2/auth/login/client\",\n \"traceId\": \"61b4aa7c0cb1167a\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"4660cb23-cb40-476d-a080-53f2984c8c8b","name":"Authenticate anonymously","request":{"name":"Authenticate anonymously","description":{"content":"Obtain a new JWT for an anonymous Profile. The token can be used and refreshed in the same way as tokens of registered Profiles.\n\n---\n\n**Authentication:** Not required\n","type":"text/plain"},"url":{"path":["sauth","v3","auth","login","client","anonymous"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":null,"body":{"mode":"raw","raw":"{\n \"apiKey\": \"string\",\n \"uuid\": \"07243772-008a-42e1-ba37-c3807cebde8f\",\n \"deviceId\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"5e90d316-65c8-490b-a2ff-83a03bb9e955","name":"Anonymous authorization token","originalRequest":{"url":{"path":["sauth","v3","auth","login","client","anonymous"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"apiKey\": \"string\",\n \"uuid\": \"07243772-008a-42e1-ba37-c3807cebde8f\",\n \"deviceId\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"token\": \"eyJhbGciOiJSUzUxMiJ9.eyJzdinvalidwYmZkM2FkNDg2ZjQ3ZGRiMjE5MSIsImF1ZCI6IkFQSSIsInJsbSI6ImFub255bW91c19jbGllbnQiLCJjdGQiOjE1NTMwMDQxNTkxNTEsImVtbCI6IjYyMjM3NmY4LTAwMDAtMjIyMi1kN2Y5LTA3MGZhOTU2ZTk2M0Bhbm9ueW1vdXMuaW52YWxpZCIsImF1dGgiOiJINHNJQUFBQUFBQUFBSXVPQlFBcHUwd05BZ0FBQUE9PSIsImlzcyI6IlN5bmVyaXNlIiwiYnBpIjo0OCwiY2xJZCI6NDMzMjMwMjg4LCJleHAiOjE1NTMwMDcxNTksImFwayI6IjVBRUFBM0Q1LUUxNDctQzdFQi1ENTlFLUJDRjUwMTA5QTNEMSJ9.QOmSqrneR4mJFv4JdxTYsw_wGcDawDsVQuB-GVTcPPwijiP7lQ_Jzqq2Mypg1BS6WFlfGB8fzqCY9iMF_TdtjmoB4xBrY95ylU8L9qto-9Cw5x5TURkfxq31eryiHe2IteRAEtoVzYg2_s9QhlH6ANVcFOVp8dMno0V9bfMYfeSQa3FkjEbxFsseHkMOiADmp9-tOGtLXO942Ir-2W_Hz3Utlpt4erz0dVJBw8a-mFavPA8EEDWR7ACJNocrVHFkS3wFISh3LqLn6KkXiowaynKlJOEHGctuahzKmF3ZOJ1BvGgKohxF9OXvQs9IdmCfWhYsLr5Q2p04TJJ-MyvTipuggKVioh8mHmOFdfnN-Zused6tXzhZtKPUWTmM8cBKoAOBHExxcMQ8SVSjxnw_7_eLKm7S2wNpu0V-tiPZPCH4wYZXtWBYjmfy0V9ydjXnNunXfgxKixLeFNnONUXxEuqPLvM_xAuonQBXVN4nYrgJv8p8U6_ZlGMPjJq1szfcuBZnzI34LSEWx_nSof0XC5Czm8iG_ihG8naivNWS8h-Q-qKMP_3PPFsLSH4Egh03pH93EJUuNAeSO4RGfUX1wzMvrv1nBC1SM660uFMbq-wkplFBbKnHKMYe-qRs1-lZPG5PwPWJJdpGqOUzbnoMOJYmiq06OHHVQyJSkcEHLCk\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"02a483ca-94b8-42a4-8cfd-b84d90891dab","name":"Unauthorized","originalRequest":{"url":{"path":["sauth","v3","auth","login","client","anonymous"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"apiKey\": \"string\",\n \"uuid\": \"07243772-008a-42e1-ba37-c3807cebde8f\",\n \"deviceId\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"2019-03-19T14:03:35.413+00:00\",\n \"status\": 401,\n \"error\": \"Unauthorized\",\n \"message\": \"Could not fetch ApiKey\",\n \"path\": \"/v3/auth/login/client/anonymous\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"86a7d430-4ca2-4f12-90fb-6047afa05d7a","name":"Log in as User","request":{"name":"Log in as User","description":{"content":"Authenticate as a User.\n\n**Note:** To perform operations within a Workspace, you must [select a Workspace](#operation/userProfileLoginUsingPOST).\n\n---\n\n**Authentication:** Not required\n","type":"text/plain"},"url":{"path":["uauth","auth","login","user"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":null,"body":{"mode":"raw","raw":"{\n \"password\": \"string\",\n \"username\": \"string\",\n \"deviceId\": \"string\",\n \"externalProviderToken\": \"string\",\n \"externalProviderType\": \"GOOGLE\",\n \"organizationName\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"4e81e21e-ccc2-46ef-a771-de68fb237e89","name":"Login details","originalRequest":{"url":{"path":["uauth","auth","login","user"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"password\": \"string\",\n \"username\": \"string\",\n \"deviceId\": \"string\",\n \"externalProviderToken\": \"string\",\n \"externalProviderType\": \"GOOGLE\",\n \"organizationName\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"consumer\": {\n \"type\": {\n \"value\": \"\"\n },\n \"businessProfileId\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n },\n \"authorities\": {\n \"value\": \"\"\n },\n \"roles\": {\n \"value\": \"\"\n }\n },\n \"mfaMethods\": [\n \"TOTP_AUTHENTICATOR\",\n \"SMS\"\n ],\n \"authorizationError\": \"USER_FORCED_TO_CHANGE_PASSWORD\",\n \"multiFactorCodeSent\": {\n \"method\": {\n \"value\": \"\"\n },\n \"status\": {\n \"value\": \"\"\n },\n \"nextTryInSeconds\": {\n \"value\": \"\"\n }\n },\n \"defaultMfaMethod\": \"SMS\",\n \"forcedToSetMfa\": true\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"fb0d2f16-18db-4fd4-b1bc-bd140edf6858","name":"Unauthorized","originalRequest":{"url":{"path":["uauth","auth","login","user"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"method":"POST","body":{"mode":"raw","raw":"{\n \"password\": \"string\",\n \"username\": \"string\",\n \"deviceId\": \"string\",\n \"externalProviderToken\": \"string\",\n \"externalProviderType\": \"GOOGLE\",\n \"organizationName\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"729ac219-5d47-4d1a-aada-a9104fa405b9","name":"Forbidden","originalRequest":{"url":{"path":["uauth","auth","login","user"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"method":"POST","body":{"mode":"raw","raw":"{\n \"password\": \"string\",\n \"username\": \"string\",\n \"deviceId\": \"string\",\n \"externalProviderToken\": \"string\",\n \"externalProviderType\": \"GOOGLE\",\n \"organizationName\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"8fd2b01f-a0a5-46bf-beee-9bebeee05778","name":"Not Found","originalRequest":{"url":{"path":["uauth","auth","login","user"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"method":"POST","body":{"mode":"raw","raw":"{\n \"password\": \"string\",\n \"username\": \"string\",\n \"deviceId\": \"string\",\n \"externalProviderToken\": \"string\",\n \"externalProviderType\": \"GOOGLE\",\n \"organizationName\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"41cfccea-193f-4353-8174-caaed7980646","name":"Verify User multi-factor authentication","request":{"name":"Verify User multi-factor authentication","description":{"content":"Authenticate as a User with multi-factor authentication.\n\n**Note:** To perform operations within a Workspace, you must [select a Workspace](#operation/userProfileLoginUsingPOST).\n\n---\n\n**API consumer:** Synerise User\n","type":"text/plain"},"url":{"path":["uauth","auth","login","user","mfa","verification"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"mfaType","value":"TOTP_AUTHENTICATOR","description":"(Required) Type of multi-factor authentication"}],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"verificationCode\": \"string\",\n \"deviceId\": \"string\",\n \"externalProviderToken\": \"string\",\n \"externalProviderType\": \"GOOGLE\",\n \"organizationName\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"1c24023e-460e-4037-8d77-502c3609ea8f","name":"Login details","originalRequest":{"url":{"path":["uauth","auth","login","user","mfa","verification"],"host":["{{baseUrl}}"],"query":[{"key":"mfaType","value":"TOTP_AUTHENTICATOR"}],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"verificationCode\": \"string\",\n \"deviceId\": \"string\",\n \"externalProviderToken\": \"string\",\n \"externalProviderType\": \"GOOGLE\",\n \"organizationName\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"consumer\": {\n \"type\": {\n \"value\": \"\"\n },\n \"businessProfileId\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n },\n \"authorities\": {\n \"value\": \"\"\n },\n \"roles\": {\n \"value\": \"\"\n }\n },\n \"mfaMethods\": [\n \"SMS\",\n \"SMS\"\n ],\n \"authorizationError\": \"USER_FORCED_TO_CHANGE_PASSWORD\",\n \"multiFactorCodeSent\": {\n \"method\": {\n \"value\": \"\"\n },\n \"status\": {\n \"value\": \"\"\n },\n \"nextTryInSeconds\": {\n \"value\": \"\"\n }\n },\n \"defaultMfaMethod\": \"EMAIL\",\n \"forcedToSetMfa\": true\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"a46ebe3b-8a1d-4df3-9efe-6054fc1405a9","name":"Unauthorized","originalRequest":{"url":{"path":["uauth","auth","login","user","mfa","verification"],"host":["{{baseUrl}}"],"query":[{"key":"mfaType","value":"TOTP_AUTHENTICATOR"}],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"POST","body":{"mode":"raw","raw":"{\n \"verificationCode\": \"string\",\n \"deviceId\": \"string\",\n \"externalProviderToken\": \"string\",\n \"externalProviderType\": \"GOOGLE\",\n \"organizationName\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"7da83723-903c-4db4-8073-238ca4baf60d","name":"Forbidden","originalRequest":{"url":{"path":["uauth","auth","login","user","mfa","verification"],"host":["{{baseUrl}}"],"query":[{"key":"mfaType","value":"TOTP_AUTHENTICATOR"}],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"POST","body":{"mode":"raw","raw":"{\n \"verificationCode\": \"string\",\n \"deviceId\": \"string\",\n \"externalProviderToken\": \"string\",\n \"externalProviderType\": \"GOOGLE\",\n \"organizationName\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"7802d8ae-b2a0-4f1d-aa5d-f7feca31b7a7","name":"Not Found","originalRequest":{"url":{"path":["uauth","auth","login","user","mfa","verification"],"host":["{{baseUrl}}"],"query":[{"key":"mfaType","value":"TOTP_AUTHENTICATOR"}],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"POST","body":{"mode":"raw","raw":"{\n \"verificationCode\": \"string\",\n \"deviceId\": \"string\",\n \"externalProviderToken\": \"string\",\n \"externalProviderType\": \"GOOGLE\",\n \"organizationName\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"ba750ad6-4e87-4c94-a832-8864906fa842","name":"Select Workspace","request":{"name":"Select Workspace","description":{"content":"After logging in as a User, select a Workspace where you want to perform operations.\n\n---\n\n**API consumer:** Synerise User\n","type":"text/plain"},"url":{"path":["uauth","auth","login","user","profile",":businessProfileUUID"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"businessProfileUUID","description":"(Required) UUID of the workspace"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"c92b762a-4ca2-4b01-9fda-211386d8608c","name":"Login details","originalRequest":{"url":{"path":["uauth","auth","login","user","profile",":businessProfileUUID"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"businessProfileUUID","description":"(Required) UUID of the workspace"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"consumer\": {\n \"type\": {\n \"value\": \"\"\n },\n \"businessProfileId\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n },\n \"authorities\": {\n \"value\": \"\"\n },\n \"roles\": {\n \"value\": \"\"\n }\n },\n \"mfaMethods\": [\n \"SMS\",\n \"SMS\"\n ],\n \"authorizationError\": \"USER_FORCED_TO_CHANGE_PASSWORD\",\n \"multiFactorCodeSent\": {\n \"method\": {\n \"value\": \"\"\n },\n \"status\": {\n \"value\": \"\"\n },\n \"nextTryInSeconds\": {\n \"value\": \"\"\n }\n },\n \"defaultMfaMethod\": \"EMAIL\",\n \"forcedToSetMfa\": true\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"48b8e354-7f53-42f9-9793-341ddb63ba5b","name":"Unauthorized","originalRequest":{"url":{"path":["uauth","auth","login","user","profile",":businessProfileUUID"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"businessProfileUUID","description":"(Required) UUID of the workspace"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"POST","body":{}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"b719bb64-34b3-4c60-aac1-5359481987ff","name":"Forbidden","originalRequest":{"url":{"path":["uauth","auth","login","user","profile",":businessProfileUUID"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"businessProfileUUID","description":"(Required) UUID of the workspace"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"POST","body":{}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"ced20690-72f1-4361-9e5d-f094a8f94910","name":"Not Found","originalRequest":{"url":{"path":["uauth","auth","login","user","profile",":businessProfileUUID"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"businessProfileUUID","description":"(Required) UUID of the workspace"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"POST","body":{}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"f1a4c036-eead-41a9-bfec-b1d445ebc83b","name":"Access denied by IP policy","originalRequest":{"url":{"path":["uauth","auth","login","user","profile",":businessProfileUUID"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"businessProfileUUID","description":"(Required) UUID of the workspace"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"Locked (WebDAV) (RFC 4918)","code":423,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1971-04-08T01:35:23.450Z\",\n \"status\": 7478,\n \"error\": \"string\",\n \"message\": \"string\",\n \"path\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"c04d1266-4a63-43e9-a20b-cbb6b4f224ae","name":"Get Workspaces","request":{"name":"Get Workspaces","description":{"content":"Retrieve a list of Workspaces available to the user.\n\n---\n\n**API consumer:** Synerise User\n","type":"text/plain"},"url":{"path":["uauth","business-profile",""],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"page","value":"0","description":"Page number"},{"disabled":false,"key":"size","value":"5000","description":"Page size"},{"disabled":false,"key":"query","value":"","description":"Search query"},{"disabled":false,"key":"sort","value":"","description":"Sort field"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"a1006e5f-65ad-4389-9dad-939127656d62","name":"OK","originalRequest":{"url":{"path":["uauth","business-profile",""],"host":["{{baseUrl}}"],"query":[{"key":"page","value":"0"},{"key":"size","value":"5000"},{"key":"query","value":""},{"key":"sort","value":""}],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"[\n {\n \"businessProfileGuid\": {\n \"value\": \"\"\n },\n \"logo\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n },\n \"created\": {\n \"value\": \"\"\n },\n \"subdomain\": {\n \"value\": \"\"\n },\n \"ipRestricted\": {\n \"value\": \"\"\n },\n \"mfaRequired\": {\n \"value\": \"\"\n }\n },\n {\n \"businessProfileGuid\": {\n \"value\": \"\"\n },\n \"logo\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n },\n \"created\": {\n \"value\": \"\"\n },\n \"subdomain\": {\n \"value\": \"\"\n },\n \"ipRestricted\": {\n \"value\": \"\"\n },\n \"mfaRequired\": {\n \"value\": \"\"\n }\n }\n]","cookie":[],"_postman_previewlanguage":"json"},{"id":"1509c4bc-3590-4260-b395-ad7b9ee1af06","name":"Unauthorized","originalRequest":{"url":{"path":["uauth","business-profile",""],"host":["{{baseUrl}}"],"query":[{"key":"page","value":"0"},{"key":"size","value":"5000"},{"key":"query","value":""},{"key":"sort","value":""}],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"GET","body":{}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"49dfc16c-3f1d-427a-ae5c-41001074f755","name":"Forbidden","originalRequest":{"url":{"path":["uauth","business-profile",""],"host":["{{baseUrl}}"],"query":[{"key":"page","value":"0"},{"key":"size","value":"5000"},{"key":"query","value":""},{"key":"sort","value":""}],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"GET","body":{}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"2a10b9f7-3f7b-4dfa-9c8a-dfcc2858c2fa","name":"Not Found","originalRequest":{"url":{"path":["uauth","business-profile",""],"host":["{{baseUrl}}"],"query":[{"key":"page","value":"0"},{"key":"size","value":"5000"},{"key":"query","value":""},{"key":"sort","value":""}],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"GET","body":{}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"393a5892-cdca-4153-86b2-a298719f6733","name":"Get Workspaces ids with user-specific data","request":{"name":"Get Workspaces ids with user-specific data","description":{"content":"Retrieve a list of workspace ids available to the user, with added user-specific data\n\n---\n\n**API consumer:** Synerise User\n","type":"text/plain"},"url":{"path":["uauth","business-profile","ids"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"23a5b057-7120-4043-8441-b79d4199ae15","name":"OK","originalRequest":{"url":{"path":["uauth","business-profile","ids"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"[\n {\n \"id\": {\n \"value\": \"\"\n },\n \"ipRestriction\": {\n \"value\": \"\"\n },\n \"mfaRestriction\": {\n \"value\": \"\"\n },\n \"favorite\": {\n \"value\": \"\"\n }\n },\n {\n \"id\": {\n \"value\": \"\"\n },\n \"ipRestriction\": {\n \"value\": \"\"\n },\n \"mfaRestriction\": {\n \"value\": \"\"\n },\n \"favorite\": {\n \"value\": \"\"\n }\n }\n]","cookie":[],"_postman_previewlanguage":"json"},{"id":"1a0e2f4c-0ca1-4820-a7ed-840dc7b64a1f","name":"Unauthorized","originalRequest":{"url":{"path":["uauth","business-profile","ids"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"GET","body":{}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"cebfcd69-fc05-40f8-9931-70ea12853d45","name":"Forbidden","originalRequest":{"url":{"path":["uauth","business-profile","ids"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"GET","body":{}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"90ebe2a8-6183-42ee-9eae-9f52feabe2b0","name":"Not Found","originalRequest":{"url":{"path":["uauth","business-profile","ids"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"GET","body":{}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"86b1da57-fe54-4704-b341-51ea57cdc5ac","name":"Get current Workspace","request":{"name":"Get current Workspace","description":{"content":"Retrieve information about the currently selected workspace.\n\n---\n\n**API consumer:** Synerise User\n","type":"text/plain"},"url":{"path":["uauth","business-profile","current"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"1d5988e5-3b3b-4f9a-a9fb-2403216c0097","name":"OK","originalRequest":{"url":{"path":["uauth","business-profile","current"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"selected\": true,\n \"data\": {\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"logo\": {\n \"value\": \"\"\n },\n \"businessProfileGuid\": {\n \"value\": \"\"\n },\n \"created\": {\n \"value\": \"\"\n },\n \"subdomain\": {\n \"value\": \"\"\n },\n \"ipRestriction\": {\n \"value\": \"\"\n },\n \"mfaRestriction\": {\n \"value\": \"\"\n },\n \"labels\": {\n \"value\": \"\"\n },\n \"emailAttributeName\": {\n \"value\": \"\"\n },\n \"organizationGuid\": {\n \"value\": \"\"\n },\n \"businessProfileGroup\": {\n \"value\": \"\"\n }\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"961837af-204e-44ee-8946-c6af62c19bde","name":"Unauthorized","originalRequest":{"url":{"path":["uauth","business-profile","current"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"GET","body":{}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"d0499657-b80c-4ed9-99b1-e59c6006d67c","name":"Forbidden","originalRequest":{"url":{"path":["uauth","business-profile","current"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"GET","body":{}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"14149b5c-5e9d-4338-b927-265a141ae9ef","name":"Not Found","originalRequest":{"url":{"path":["uauth","business-profile","current"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"GET","body":{}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"6a368140-aaf9-49ce-9a8d-44ed5f55cab2","name":"Log in as Workspace","request":{"name":"Log in as Workspace","description":{"content":"Obtain a new Workspace JWT Token.\n\n---\n\n**Authentication:** Not required\n","type":"text/plain"},"url":{"path":["uauth","v2","auth","login","profile"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":null,"body":{"mode":"raw","raw":"{\n \"apiKey\": \"64c09614-1b2a-42f7-804d-f647243eb1ab\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"e87b2bba-50b4-4e0d-ac23-36ca2ebc875d","name":"New JWT token for Workspace authentication","originalRequest":{"url":{"path":["uauth","v2","auth","login","profile"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"apiKey\": \"64c09614-1b2a-42f7-804d-f647243eb1ab\"\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"token\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"0164a567-b8be-45ab-8cb9-03aa1ac48221","name":"Request malformed","originalRequest":{"url":{"path":["uauth","v2","auth","login","profile"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"apiKey\": \"64c09614-1b2a-42f7-804d-f647243eb1ab\"\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1971-04-08T01:35:23.450Z\",\n \"status\": 7478,\n \"error\": \"string\",\n \"message\": \"string\",\n \"path\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"277e3dc5-d200-4e30-85da-eed14418a6e8","name":"Unauthorized, API key does not exist","originalRequest":{"url":{"path":["uauth","v2","auth","login","profile"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"apiKey\": \"64c09614-1b2a-42f7-804d-f647243eb1ab\"\n}","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1971-04-08T01:35:23.450Z\",\n \"status\": 7478,\n \"error\": \"string\",\n \"message\": \"string\",\n \"path\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}],"event":[]},{"id":"449ab284-0e8e-4d64-9386-51fd034d329f","name":"Authorization (deprecated)","description":{"content":"","type":"text/plain"},"item":[{"id":"a10f9c77-b9a3-4790-af22-a85309b069b6","name":"Refresh a Workspace token","request":{"name":"Refresh a Workspace token","description":{"content":"Retrieve a refreshed JWT Token to prolong the Workspace session.\n\n---\n\n**API consumer:** Workspace (Business Profile)\n\n**Authentication:** Not required\n","type":"text/plain"},"url":{"path":["v4","auth","refresh","profile"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"5a17eb28-7137-494e-837f-fb8864ad0570","name":"New authorization token","originalRequest":{"url":{"path":["v4","auth","refresh","profile"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Content-Type","value":"application/json"},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"token\": \"eyJhbGciOiinvalidI6IkFQSSIsInJsbSI6ImNsaWVudCIsImN0ZCI6MTUyODM1NTgzMjEzOCwiZW1sIjoia3J6eXN6dG9mLmN6ZXJlcGFrQGdtYWlsLmNvbSIsImlzcyI6IlN5bmVyaXNlIiwiYnBpIjo1OTQsImNsSWQiOjUyNTQ0NjU3NCwinvalidx2XwJp-QBZ94d_EEKf41KtDCE33KhP_vTAYrs-JzbnIHgKRvG6ZRwsNOL8OTnbfbUZH4XYaqBB_tZTPPKfzHutP6GEGp7PLtu2E92JbChkVyrn8VCQ5v4z2e1-zsdgbmWcQk2g9RydaydO6NYO55suT3Hz2ZRv0AYLsG8rM1biZGdREWx9OaknVVuIo2ivehBiukL7VQ6Bu8ugjep3mn-z666a-nCMh6ZuASiQ6Geq0NSWmdDQIoCa5Hg44KzMfGRlCR2uKBXeHTD0SkwJ1VJM0sHNKwSfMXKpaX8OJ5wUJpgCzDzQwKVgxgWFp4eO_sbcvxWrpI7W0lfdCy1WKirnZ6Uh3uJ06v97GQDAQqVgBZFEpS47MrGZhTNuAG4ZbfYO7yyxVO8AHQbEC-UvZ-8DC1XZjvQ6S1uNqQIlVGcthnrxg8K6vKVhNzu6ifQI0bbsCl8bGsKkXOEK1pKR3ekckcSjNeeY2LrcdXs8F2gtkm0TjXU\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"19bda54f-6599-4b15-9a68-341a135d7cbb","name":"Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc.","originalRequest":{"url":{"path":["v4","auth","refresh","profile"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Content-Type","value":"application/json"},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"Bad Request\",\n \"status\": 400,\n \"timestamp\": \"2020-10-29T13:08:16.235Z\",\n \"path\": \"/exampleEndpoint\",\n \"message\": \"Some fields did not pass validation\",\n \"errors\": [\n {\n \"code\": 120,\n \"field\": \"exampleField\",\n \"message\": \"120\",\n \"rejectedValue\": \"exampleValue\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"55c53b56-1a2a-4a73-a26d-53fcebb4f18d","name":"Forbidden; insufficient permissions (when PII protection is enabled, PII permissions are required in addition to the permissions listed in the method description)","originalRequest":{"url":{"path":["v4","auth","refresh","profile"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Content-Type","value":"application/json"},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"2018-06-07T07:29:27.489+00:00\",\n \"status\": 403,\n \"error\": \"Forbidden\",\n \"message\": \"Forbidden\",\n \"path\": \"/path_of_the_endpoint\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"989d5dba-fb06-42e6-8c12-cb3ee12bc56d","name":"Log in as Workspace","request":{"name":"Log in as Workspace","description":{"content":"This endpoint is deprecated. Use [this endpoint](#operation/profileLogin) instead.\n\n---\n\n**Authentication:** Not required\n","type":"text/plain"},"url":{"path":["v4","auth","login","profile"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":null,"body":{"mode":"raw","raw":"{\n \"apiKey\": \"64c09614-1b2a-42f7-804d-f647243eb1ab\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"a8768642-66e0-4cf7-9b0e-3fcd950bca49","name":"Workspace authorization token","originalRequest":{"url":{"path":["v4","auth","login","profile"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"apiKey\": \"64c09614-1b2a-42f7-804d-f647243eb1ab\"\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"token\": \"eyJhbGciOiinvalidI6IkFQSSIsInJsbSI6ImNsaWVudCIsImN0ZCI6MTUyODM1NTgzMjEzOCwiZW1sIjoia3J6eXN6dG9mLmN6ZXJlcGFrQGdtYWlsLmNvbSIsImlzcyI6IlN5bmVyaXNlIiwiYnBpIjo1OTQsImNsSWQiOjUyNTQ0NjU3NCwinvalidx2XwJp-QBZ94d_EEKf41KtDCE33KhP_vTAYrs-JzbnIHgKRvG6ZRwsNOL8OTnbfbUZH4XYaqBB_tZTPPKfzHutP6GEGp7PLtu2E92JbChkVyrn8VCQ5v4z2e1-zsdgbmWcQk2g9RydaydO6NYO55suT3Hz2ZRv0AYLsG8rM1biZGdREWx9OaknVVuIo2ivehBiukL7VQ6Bu8ugjep3mn-z666a-nCMh6ZuASiQ6Geq0NSWmdDQIoCa5Hg44KzMfGRlCR2uKBXeHTD0SkwJ1VJM0sHNKwSfMXKpaX8OJ5wUJpgCzDzQwKVgxgWFp4eO_sbcvxWrpI7W0lfdCy1WKirnZ6Uh3uJ06v97GQDAQqVgBZFEpS47MrGZhTNuAG4ZbfYO7yyxVO8AHQbEC-UvZ-8DC1XZjvQ6S1uNqQIlVGcthnrxg8K6vKVhNzu6ifQI0bbsCl8bGsKkXOEK1pKR3ekckcSjNeeY2LrcdXs8F2gtkm0TjXU\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"c42f3936-eff4-44ec-a4b7-277fdb1238f7","name":"Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc.","originalRequest":{"url":{"path":["v4","auth","login","profile"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"apiKey\": \"64c09614-1b2a-42f7-804d-f647243eb1ab\"\n}","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"Bad Request\",\n \"status\": 400,\n \"timestamp\": \"2020-10-29T13:08:16.235Z\",\n \"path\": \"/exampleEndpoint\",\n \"message\": \"Some fields did not pass validation\",\n \"errors\": [\n {\n \"code\": 120,\n \"field\": \"exampleField\",\n \"message\": \"120\",\n \"rejectedValue\": \"exampleValue\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"e676432f-9a96-46a1-8be9-7dd47442a2f0","name":"Authenticate as Profile","request":{"name":"Authenticate as Profile","description":{"content":"Obtain a new Profile JWT Token.\n\n---\n\n**Authentication:** Not required\n","type":"text/plain"},"url":{"path":["sauth","auth","login","client"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":null,"body":{"mode":"raw","raw":"{\n \"apiKey\": \"5AEAA3D5-E147-C7EB-invalid50109A3D1\",\n \"email\": \"testDoc@example.com\",\n \"password\": \"testPass1!\",\n \"uuid\": \"b3f56868-9667-4843-a8e5-0509456baa9b\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"e490b803-3b77-4087-baf4-b74bb144ccfe","name":"Profile authorization token","originalRequest":{"url":{"path":["sauth","auth","login","client"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"apiKey\": \"5AEAA3D5-E147-C7EB-invalid50109A3D1\",\n \"email\": \"testDoc@example.com\",\n \"password\": \"testPass1!\",\n \"uuid\": \"b3f56868-9667-4843-a8e5-0509456baa9b\"\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"token\": \"eyJhbGciOiJSUzUxMiJ9.eyJzdinvalidwYmZkM2FkNDg2ZjQ3ZGRiMjE5MSIsImF1ZCI6IkFQSSIsInJsbSI6ImFub255bW91c19jbGllbnQiLCJjdGQiOjE1NTMwMDQxNTkxNTEsImVtbCI6IjYyMjM3NmY4LTAwMDAtMjIyMi1kN2Y5LTA3MGZhOTU2ZTk2M0Bhbm9ueW1vdXMuaW52YWxpZCIsImF1dGgiOiJINHNJQUFBQUFBQUFBSXVPQlFBcHUwd05BZ0FBQUE9PSIsImlzcyI6IlN5bmVyaXNlIiwiYnBpIjo0OCwiY2xJZCI6NDMzMjMwMjg4LCJleHAiOjE1NTMwMDcxNTksImFwayI6IjVBRUFBM0Q1LUUxNDctQzdFQi1ENTlFLUJDRjUwMTA5QTNEMSJ9.QOmSqrneR4mJFv4JdxTYsw_wGcDawDsVQuB-GVTcPPwijiP7lQ_Jzqq2Mypg1BS6WFlfGB8fzqCY9iMF_TdtjmoB4xBrY95ylU8L9qto-9Cw5x5TURkfxq31eryiHe2IteRAEtoVzYg2_s9QhlH6ANVcFOVp8dMno0V9bfMYfeSQa3FkjEbxFsseHkMOiADmp9-tOGtLXO942Ir-2W_Hz3Utlpt4erz0dVJBw8a-mFavPA8EEDWR7ACJNocrVHFkS3wFISh3LqLn6KkXiowaynKlJOEHGctuahzKmF3ZOJ1BvGgKohxF9OXvQs9IdmCfWhYsLr5Q2p04TJJ-MyvTipuggKVioh8mHmOFdfnN-Zused6tXzhZtKPUWTmM8cBKoAOBHExxcMQ8SVSjxnw_7_eLKm7S2wNpu0V-tiPZPCH4wYZXtWBYjmfy0V9ydjXnNunXfgxKixLeFNnONUXxEuqPLvM_xAuonQBXVN4nYrgJv8p8U6_ZlGMPjJq1szfcuBZnzI34LSEWx_nSof0XC5Czm8iG_ihG8naivNWS8h-Q-qKMP_3PPFsLSH4Egh03pH93EJUuNAeSO4RGfUX1wzMvrv1nBC1SM660uFMbq-wkplFBbKnHKMYe-qRs1-lZPG5PwPWJJdpGqOUzbnoMOJYmiq06OHHVQyJSkcEHLCk\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"3dbd7c31-c4fb-4841-88f9-7830ccee1ce3","name":"Unauthorized","originalRequest":{"url":{"path":["sauth","auth","login","client"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"apiKey\": \"5AEAA3D5-E147-C7EB-invalid50109A3D1\",\n \"email\": \"testDoc@example.com\",\n \"password\": \"testPass1!\",\n \"uuid\": \"b3f56868-9667-4843-a8e5-0509456baa9b\"\n}","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"2018-06-07T07:17:41.734+00:00\",\n \"status\": 401,\n \"error\": \"Unauthorized\",\n \"message\": \"Access denied\",\n \"path\": \"/auth/login/client\",\n \"traceId\": \"61b4aa7c0cb1167a\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"e533c8e5-9bea-4999-90e1-51655c0a8400","name":"Profile not found","originalRequest":{"url":{"path":["sauth","auth","login","client"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"apiKey\": \"5AEAA3D5-E147-C7EB-invalid50109A3D1\",\n \"email\": \"testDoc@example.com\",\n \"password\": \"testPass1!\",\n \"uuid\": \"b3f56868-9667-4843-a8e5-0509456baa9b\"\n}","options":{"raw":{"language":"json"}}}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"2018-06-07T07:17:41.734+00:00\",\n \"status\": 404,\n \"error\": \"Not Found\",\n \"message\": \"Account does not exist\",\n \"path\": \"/auth/login/client\",\n \"traceId\": \"61b4aa7c0cb1167a\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"35eca788-cde6-4765-a4f4-4f4a67e149f3","name":"Account is locked, password reset required","originalRequest":{"url":{"path":["sauth","auth","login","client"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"apiKey\": \"5AEAA3D5-E147-C7EB-invalid50109A3D1\",\n \"email\": \"testDoc@example.com\",\n \"password\": \"testPass1!\",\n \"uuid\": \"b3f56868-9667-4843-a8e5-0509456baa9b\"\n}","options":{"raw":{"language":"json"}}}},"status":"Not Acceptable","code":406,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"2021-09-15T10:01:16.203120Z\",\n \"status\": 406,\n \"error\": \"Banned\",\n \"message\": \"Log in has been blocked\",\n \"path\": \"/v2/auth/login/client\",\n \"traceId\": \"61b4aa7c0cb1167a\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"f6011115-cf9a-41a8-95af-a4d737ebb436","name":"Device control is enabled, device must be authorized (link sent by email)","originalRequest":{"url":{"path":["sauth","auth","login","client"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"apiKey\": \"5AEAA3D5-E147-C7EB-invalid50109A3D1\",\n \"email\": \"testDoc@example.com\",\n \"password\": \"testPass1!\",\n \"uuid\": \"b3f56868-9667-4843-a8e5-0509456baa9b\"\n}","options":{"raw":{"language":"json"}}}},"status":"Locked (WebDAV) (RFC 4918)","code":423,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"2021-09-15T10:01:16.203120Z\",\n \"status\": 423,\n \"error\": \"Locked\",\n \"message\": \"Device login blocked\",\n \"path\": \"/v2/auth/login/client\",\n \"traceId\": \"61b4aa7c0cb1167a\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"d5af7c81-eac2-4579-b691-974c56087769","name":"Authenticate anonymously","request":{"name":"Authenticate anonymously","description":{"content":"Obtain a new JWT for an anonymous Profile. The token can be used and refreshed in the same way as tokens of registered Profiles.\n\n---\n\n**Authentication:** Not required\n","type":"text/plain"},"url":{"path":["sauth","auth","login","client","anonymous"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":null,"body":{"mode":"raw","raw":"{\n \"apiKey\": \"string\",\n \"deviceId\": \"string\",\n \"uuid\": \"07243772-008a-42e1-ba37-c3807cebde8f\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"e1f77040-3255-4e61-be94-cf5dd677422e","name":"Anonymous authorization token","originalRequest":{"url":{"path":["sauth","auth","login","client","anonymous"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"apiKey\": \"string\",\n \"deviceId\": \"string\",\n \"uuid\": \"07243772-008a-42e1-ba37-c3807cebde8f\"\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"token\": \"eyJhbGciOiJSUzUxMiJ9.eyJzdinvalidwYmZkM2FkNDg2ZjQ3ZGRiMjE5MSIsImF1ZCI6IkFQSSIsInJsbSI6ImFub255bW91c19jbGllbnQiLCJjdGQiOjE1NTMwMDQxNTkxNTEsImVtbCI6IjYyMjM3NmY4LTAwMDAtMjIyMi1kN2Y5LTA3MGZhOTU2ZTk2M0Bhbm9ueW1vdXMuaW52YWxpZCIsImF1dGgiOiJINHNJQUFBQUFBQUFBSXVPQlFBcHUwd05BZ0FBQUE9PSIsImlzcyI6IlN5bmVyaXNlIiwiYnBpIjo0OCwiY2xJZCI6NDMzMjMwMjg4LCJleHAiOjE1NTMwMDcxNTksImFwayI6IjVBRUFBM0Q1LUUxNDctQzdFQi1ENTlFLUJDRjUwMTA5QTNEMSJ9.QOmSqrneR4mJFv4JdxTYsw_wGcDawDsVQuB-GVTcPPwijiP7lQ_Jzqq2Mypg1BS6WFlfGB8fzqCY9iMF_TdtjmoB4xBrY95ylU8L9qto-9Cw5x5TURkfxq31eryiHe2IteRAEtoVzYg2_s9QhlH6ANVcFOVp8dMno0V9bfMYfeSQa3FkjEbxFsseHkMOiADmp9-tOGtLXO942Ir-2W_Hz3Utlpt4erz0dVJBw8a-mFavPA8EEDWR7ACJNocrVHFkS3wFISh3LqLn6KkXiowaynKlJOEHGctuahzKmF3ZOJ1BvGgKohxF9OXvQs9IdmCfWhYsLr5Q2p04TJJ-MyvTipuggKVioh8mHmOFdfnN-Zused6tXzhZtKPUWTmM8cBKoAOBHExxcMQ8SVSjxnw_7_eLKm7S2wNpu0V-tiPZPCH4wYZXtWBYjmfy0V9ydjXnNunXfgxKixLeFNnONUXxEuqPLvM_xAuonQBXVN4nYrgJv8p8U6_ZlGMPjJq1szfcuBZnzI34LSEWx_nSof0XC5Czm8iG_ihG8naivNWS8h-Q-qKMP_3PPFsLSH4Egh03pH93EJUuNAeSO4RGfUX1wzMvrv1nBC1SM660uFMbq-wkplFBbKnHKMYe-qRs1-lZPG5PwPWJJdpGqOUzbnoMOJYmiq06OHHVQyJSkcEHLCk\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"fda73a85-f373-4a30-ab9b-cabb9d4d7caa","name":"Unauthorized","originalRequest":{"url":{"path":["sauth","auth","login","client","anonymous"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"apiKey\": \"string\",\n \"deviceId\": \"string\",\n \"uuid\": \"07243772-008a-42e1-ba37-c3807cebde8f\"\n}","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"2019-03-19T14:03:35.413+00:00\",\n \"status\": 401,\n \"error\": \"Unauthorized\",\n \"message\": \"Could not fetch ApiKey\",\n \"path\": \"/auth/login/client/anonymous\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"ac19c871-1ca6-4687-a87e-6b87da103146","name":"Authenticate with Facebook","request":{"name":"Authenticate with Facebook","description":{"content":"Use a Facebook token to obtain a Profile JWT. If a Facebook account is logging on for the first time, a self-managed account for the profile is registered in Synerise.\n\n---\n\n**Authentication:** Not required\n","type":"text/plain"},"url":{"path":["sauth","auth","login","client","facebook"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":null,"body":{"mode":"raw","raw":"{\"facebookToken\":\"EAAfsMmaWLW0BAOZAqSoh8ZB5y2ZAixtSrlvvq3fpWGlcrfcoWOiAwBCZBpBDlzwHFSZB58nUBjOz2UMuopO7p2Q65QU1ZAiB2XaxRzje0bBd7Tu87f6C2pcoZAP65agWAF0ElZCNyKn4iAtFd9RhppkwU9ll0AokBZBnDroZCIaxE3IHSWGtE567AUrXkZAsQEjYsZAZAcYx0ki1w7XUToy9Wps9NA0OuBdMhruB3htuiukwOFAZDZD\",\"apiKey\":\"5AEAA3D5-E147-C7EB-invalid\",\"uuid\":\"91b8e035-dca3-4805-8915-2cfb01d31fde\",\"deviceId\":\"deviceId\",\"agreements\":{\"email\":true,\"sms\":true,\"push\":true,\"bluetooth\":true,\"rfid\":true,\"wifi\":true},\"attributes\":{\"property1\":\"string\",\"property2\":\"string\"}}","options":{"raw":{"language":"json"}}}},"response":[{"id":"16709e7d-4bf9-4ade-8449-3c2e27d21e85","name":"Profile authorization token","originalRequest":{"url":{"path":["sauth","auth","login","client","facebook"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\"facebookToken\":\"EAAfsMmaWLW0BAOZAqSoh8ZB5y2ZAixtSrlvvq3fpWGlcrfcoWOiAwBCZBpBDlzwHFSZB58nUBjOz2UMuopO7p2Q65QU1ZAiB2XaxRzje0bBd7Tu87f6C2pcoZAP65agWAF0ElZCNyKn4iAtFd9RhppkwU9ll0AokBZBnDroZCIaxE3IHSWGtE567AUrXkZAsQEjYsZAZAcYx0ki1w7XUToy9Wps9NA0OuBdMhruB3htuiukwOFAZDZD\",\"apiKey\":\"5AEAA3D5-E147-C7EB-invalid\",\"uuid\":\"91b8e035-dca3-4805-8915-2cfb01d31fde\",\"deviceId\":\"deviceId\",\"agreements\":{\"email\":true,\"sms\":true,\"push\":true,\"bluetooth\":true,\"rfid\":true,\"wifi\":true},\"attributes\":{\"property1\":\"string\",\"property2\":\"string\"}}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"token\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"414f314e-300a-4760-9571-8852693ad359","name":"Authenticate with Facebook without registration","request":{"name":"Authenticate with Facebook without registration","description":{"content":"Use a Facebook token to obtain a Profile JWT without creating a self-managed account for this Profile in Synerise.\n\n---\n\n**Authentication:** Not required\n","type":"text/plain"},"url":{"path":["sauth","auth","login","client","facebook","no-registration"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":null,"body":{"mode":"raw","raw":"{\"facebookToken\":\"EAAfsMmaWLW0BAOZAqSoh8ZB5y2ZAixtSrlvvq3fpWGlcrfcoWOiAwBCZBpBDlzwHFSZB58nUBjOz2UMuopO7p2Q65QU1ZAiB2XaxRzje0bBd7Tu87f6C2pcoZAP65agWAF0ElZCNyKn4iAtFd9RhppkwU9ll0AokBZBnDroZCIaxE3IHSWGtE567AUrXkZAsQEjYsZAZAcYx0ki1w7XUToy9Wps9NA0OuBdMhruB3htuiukwOFAZDZD\",\"apiKey\":\"5AEAA3D5-E147-C7EB-invalid\",\"uuid\":\"91b8e035-dca3-4805-8915-2cfb01d31fde\",\"deviceId\":\"deviceId\",\"agreements\":{\"email\":true,\"sms\":true,\"push\":true,\"bluetooth\":true,\"rfid\":true,\"wifi\":true},\"attributes\":{\"property1\":\"string\",\"property2\":\"string\"}}","options":{"raw":{"language":"json"}}}},"response":[{"id":"c7460324-1b1f-412d-88bf-67e3261731fd","name":"Profile authorization token","originalRequest":{"url":{"path":["sauth","auth","login","client","facebook","no-registration"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\"facebookToken\":\"EAAfsMmaWLW0BAOZAqSoh8ZB5y2ZAixtSrlvvq3fpWGlcrfcoWOiAwBCZBpBDlzwHFSZB58nUBjOz2UMuopO7p2Q65QU1ZAiB2XaxRzje0bBd7Tu87f6C2pcoZAP65agWAF0ElZCNyKn4iAtFd9RhppkwU9ll0AokBZBnDroZCIaxE3IHSWGtE567AUrXkZAsQEjYsZAZAcYx0ki1w7XUToy9Wps9NA0OuBdMhruB3htuiukwOFAZDZD\",\"apiKey\":\"5AEAA3D5-E147-C7EB-invalid\",\"uuid\":\"91b8e035-dca3-4805-8915-2cfb01d31fde\",\"deviceId\":\"deviceId\",\"agreements\":{\"email\":true,\"sms\":true,\"push\":true,\"bluetooth\":true,\"rfid\":true,\"wifi\":true},\"attributes\":{\"property1\":\"string\",\"property2\":\"string\"}}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"token\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"c325511e-759d-4398-a218-48635b6c5b9a","name":"Authenticate with OAuth","request":{"name":"Authenticate with OAuth","description":{"content":"Obtain a new JWT token by using OAuth authentication token.\n\n---\n\n**Authentication:** Not required\n","type":"text/plain"},"url":{"path":["sauth","auth","login","client","oauth"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":null,"body":{"mode":"raw","raw":"{\n \"accessToken\": \"string\",\n \"apiKey\": \"string\",\n \"uuid\": \"07243772-008a-42e1-ba37-c3807cebde8f\",\n \"deviceId\": \"string\",\n \"agreements\": {\n \"email\": true,\n \"sms\": true,\n \"push\": true,\n \"bluetooth\": false,\n \"rfid\": false,\n \"wifi\": false\n },\n \"attributes\": {\n \"key_0\": {\n \"value\": \"\"\n }\n },\n \"tags\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"customId\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"38eed616-c3f7-4c71-bbdd-3d7c99e6f99f","name":"Profile authorization token","originalRequest":{"url":{"path":["sauth","auth","login","client","oauth"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"accessToken\": \"string\",\n \"apiKey\": \"string\",\n \"uuid\": \"07243772-008a-42e1-ba37-c3807cebde8f\",\n \"deviceId\": \"string\",\n \"agreements\": {\n \"email\": true,\n \"sms\": true,\n \"push\": true,\n \"bluetooth\": false,\n \"rfid\": false,\n \"wifi\": false\n },\n \"attributes\": {\n \"key_0\": {\n \"value\": \"\"\n }\n },\n \"tags\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"customId\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"token\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"27eab91a-ac47-4a08-9cea-056f5fb8accf","name":"Authenticate with OAuth without registration","request":{"name":"Authenticate with OAuth without registration","description":{"content":"Use an OAuth token to obtain a Profile JWT. This method does not create a Profile in Synerise.\n\n---\n\n**Authentication:** Not required\n","type":"text/plain"},"url":{"path":["sauth","auth","login","client","oauth","no-registration"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":null,"body":{"mode":"raw","raw":"{\n \"accessToken\": \"string\",\n \"apiKey\": \"string\",\n \"uuid\": \"07243772-008a-42e1-ba37-c3807cebde8f\",\n \"deviceId\": \"string\",\n \"agreements\": {\n \"email\": true,\n \"sms\": true,\n \"push\": true,\n \"bluetooth\": false,\n \"rfid\": false,\n \"wifi\": false\n },\n \"attributes\": {\n \"key_0\": {\n \"value\": \"\"\n }\n },\n \"tags\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"customId\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"26f65982-791a-4b13-b8c5-1376f1e3aeb2","name":"Profile authorization token","originalRequest":{"url":{"path":["sauth","auth","login","client","oauth","no-registration"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"accessToken\": \"string\",\n \"apiKey\": \"string\",\n \"uuid\": \"07243772-008a-42e1-ba37-c3807cebde8f\",\n \"deviceId\": \"string\",\n \"agreements\": {\n \"email\": true,\n \"sms\": true,\n \"push\": true,\n \"bluetooth\": false,\n \"rfid\": false,\n \"wifi\": false\n },\n \"attributes\": {\n \"key_0\": {\n \"value\": \"\"\n }\n },\n \"tags\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"customId\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"token\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"45ed9c26-97e9-4d92-9a21-3f362990d8cc","name":"Authenticate with Sign in with Apple","request":{"name":"Authenticate with Sign in with Apple","description":{"content":"Obtain a new JWT token by using Sign in with Apple authentication token.\n\n---\n\n**Authentication:** Not required\n","type":"text/plain"},"url":{"path":["sauth","auth","login","client","apple"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":null,"body":{"mode":"raw","raw":"{\"accessToken\":\"EAAfsMmaWLW0BAOZAqSoh8ZB5y2ZAixtSrlvvq3fpWGlcrfcoWOiAwBCZBpBDlzwHFSZB58nUBjOz2UMuopO7p2Q65QU1ZAiB2XaxRzje0bBd7Tu87f6C2pcoZAP65agWAF0ElZCNyKn4iAtFd9RhppkwU9ll0AokBZBnDroZCIaxE3IHSWGtE567AUrXkZAsQEjYsZAZAcYx0ki1w7XUToy9Wps9NA0OuBdMhruB3htuiukwOFAZDZD\",\"apiKey\":\"5AEAA3D5-E147-C7EB-invalid\",\"uuid\":\"91b8e035-dca3-4805-8915-2cfb01d31fde\",\"deviceId\":\"deviceId\",\"agreements\":{\"email\":true,\"sms\":true,\"push\":true,\"bluetooth\":true,\"rfid\":true,\"wifi\":true},\"attributes\":{\"property1\":\"string\",\"property2\":\"string\"}}","options":{"raw":{"language":"json"}}}},"response":[{"id":"729039ef-7577-4d82-be1f-81ce5a2d3183","name":"Profile authorization token","originalRequest":{"url":{"path":["sauth","auth","login","client","apple"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\"accessToken\":\"EAAfsMmaWLW0BAOZAqSoh8ZB5y2ZAixtSrlvvq3fpWGlcrfcoWOiAwBCZBpBDlzwHFSZB58nUBjOz2UMuopO7p2Q65QU1ZAiB2XaxRzje0bBd7Tu87f6C2pcoZAP65agWAF0ElZCNyKn4iAtFd9RhppkwU9ll0AokBZBnDroZCIaxE3IHSWGtE567AUrXkZAsQEjYsZAZAcYx0ki1w7XUToy9Wps9NA0OuBdMhruB3htuiukwOFAZDZD\",\"apiKey\":\"5AEAA3D5-E147-C7EB-invalid\",\"uuid\":\"91b8e035-dca3-4805-8915-2cfb01d31fde\",\"deviceId\":\"deviceId\",\"agreements\":{\"email\":true,\"sms\":true,\"push\":true,\"bluetooth\":true,\"rfid\":true,\"wifi\":true},\"attributes\":{\"property1\":\"string\",\"property2\":\"string\"}}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"token\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"e891744e-0b10-4de8-ae7c-96bd8e3cc771","name":"Authenticate with Sign in with Apple without registration","request":{"name":"Authenticate with Sign in with Apple without registration","description":{"content":"Use an Apple token to obtain a Profile JWT. This method does not create a Profile in Synerise.\n\n---\n\n**Authentication:** Not required\n","type":"text/plain"},"url":{"path":["sauth","auth","login","client","apple","no-registration"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":null,"body":{"mode":"raw","raw":"{\n \"accessToken\": \"string\",\n \"apiKey\": \"string\",\n \"uuid\": \"07243772-008a-42e1-ba37-c3807cebde8f\",\n \"deviceId\": \"string\",\n \"agreements\": {\n \"email\": true,\n \"sms\": true,\n \"push\": true,\n \"bluetooth\": false,\n \"rfid\": false,\n \"wifi\": false\n },\n \"attributes\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n }\n },\n \"tags\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"41e53843-d2ae-4ced-a0dc-8b8f61a2fea9","name":"Profile authorization token","originalRequest":{"url":{"path":["sauth","auth","login","client","apple","no-registration"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"accessToken\": \"string\",\n \"apiKey\": \"string\",\n \"uuid\": \"07243772-008a-42e1-ba37-c3807cebde8f\",\n \"deviceId\": \"string\",\n \"agreements\": {\n \"email\": true,\n \"sms\": true,\n \"push\": true,\n \"bluetooth\": false,\n \"rfid\": false,\n \"wifi\": false\n },\n \"attributes\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n }\n },\n \"tags\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"token\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"ed25248a-50ca-453d-b700-1be69c54b4fc","name":"Refresh a Profile token","request":{"name":"Refresh a Profile token","description":{"content":"Retrieve a refreshed JWT Token to prolong the Profile session.\n\nThe current token must still be active at the time of the request.\n\n---\n\n**API consumers:** Profile (Client), Anonymous Profile\n\n**Authentication:** Not required\n","type":"text/plain"},"url":{"path":["sauth","auth","refresh","client"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"70cabdfd-e712-40ed-a8f4-a6a8887c0f8b","name":"New authorization token","originalRequest":{"url":{"path":["sauth","auth","refresh","client"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"token\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"9b04b183-53c5-48af-be6f-0835ee07aad4","name":"Unauthorized","originalRequest":{"url":{"path":["sauth","auth","refresh","client"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"2019-03-19T13:57:33.244+00:00\",\n \"status\": 401,\n \"error\": \"Unauthorized\",\n \"message\": \"Full authentication is required to access this resource\",\n \"path\": \"/auth/refresh/client\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"1e5a7532-7f26-4f04-9cf5-c458ff8392f8","name":"Refresh a Profile token","request":{"name":"Refresh a Profile token","description":{"content":"This method is deprecated. Use [the v3 method](#operation/RefreshAClientTokenV3) instead.\n\nRetrieve a refreshed JWT Token to prolong the session.\n\nThe current token must still be active at the time of the request.\n\n---\n\n**API consumers:** Profile (Client), Anonymous Profile\n\n**Authentication:** Not required\n","type":"text/plain"},"url":{"path":["sauth","v2","auth","refresh","client"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"apiKey\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"a80d8508-63b6-4c03-88c2-e573de65522e","name":"New authorization token","originalRequest":{"url":{"path":["sauth","v2","auth","refresh","client"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"apiKey\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"token\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"f867dc41-35b5-4d0b-b2d7-e2f1bf74f42b","name":"Unauthorized","originalRequest":{"url":{"path":["sauth","v2","auth","refresh","client"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"apiKey\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"2019-03-19T13:57:33.244+00:00\",\n \"status\": 401,\n \"error\": \"Unauthorized\",\n \"message\": \"Full authentication is required to access this resource\",\n \"path\": \"/v2/auth/refresh/client\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"6317356b-088d-4f5c-a15b-fdd8619b943f","name":"Authenticate as Profile","request":{"name":"Authenticate as Profile","description":{"content":"This method is deprecated. Use [the v3 method](#operation/authenticateUsingPOST_v3) instead.\n\nObtain a new JWT token for a Profile. If an account for the Profile does not exist and the `identityProvider` is different than `SYNERISE`, this request creates an account.\n\n\n---\n\n**Authentication:** Not required\n","type":"text/plain"},"url":{"path":["sauth","v2","auth","login","client"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":null,"body":{"mode":"raw","raw":"{\n \"apiKey\": \"string\",\n \"identityProvider\": \"GOOGLE\",\n \"identityProviderToken\": \"string\",\n \"email\": \"string\",\n \"customId\": {},\n \"password\": \"string\",\n \"uuid\": \"string\",\n \"deviceId\": \"string\",\n \"agreements\": {\n \"email\": true,\n \"sms\": true,\n \"push\": true,\n \"bluetooth\": false,\n \"rfid\": false,\n \"wifi\": false\n },\n \"attributes\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n },\n \"key_2\": {\n \"value\": \"\"\n }\n },\n \"tags\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"757f085f-2889-42a9-9e2b-82c44ed3bca7","name":"Profile authorization token","originalRequest":{"url":{"path":["sauth","v2","auth","login","client"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"apiKey\": \"string\",\n \"identityProvider\": \"GOOGLE\",\n \"identityProviderToken\": \"string\",\n \"email\": \"string\",\n \"customId\": {},\n \"password\": \"string\",\n \"uuid\": \"string\",\n \"deviceId\": \"string\",\n \"agreements\": {\n \"email\": true,\n \"sms\": true,\n \"push\": true,\n \"bluetooth\": false,\n \"rfid\": false,\n \"wifi\": false\n },\n \"attributes\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n },\n \"key_2\": {\n \"value\": \"\"\n }\n },\n \"tags\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"token\": \"eyJhbGciOiJSUzUxMiJ9.eyJzdinvalidwYmZkM2FkNDg2ZjQ3ZGRiMjE5MSIsImF1ZCI6IkFQSSIsInJsbSI6ImFub255bW91c19jbGllbnQiLCJjdGQiOjE1NTMwMDQxNTkxNTEsImVtbCI6IjYyMjM3NmY4LTAwMDAtMjIyMi1kN2Y5LTA3MGZhOTU2ZTk2M0Bhbm9ueW1vdXMuaW52YWxpZCIsImF1dGgiOiJINHNJQUFBQUFBQUFBSXVPQlFBcHUwd05BZ0FBQUE9PSIsImlzcyI6IlN5bmVyaXNlIiwiYnBpIjo0OCwiY2xJZCI6NDMzMjMwMjg4LCJleHAiOjE1NTMwMDcxNTksImFwayI6IjVBRUFBM0Q1LUUxNDctQzdFQi1ENTlFLUJDRjUwMTA5QTNEMSJ9.QOmSqrneR4mJFv4JdxTYsw_wGcDawDsVQuB-GVTcPPwijiP7lQ_Jzqq2Mypg1BS6WFlfGB8fzqCY9iMF_TdtjmoB4xBrY95ylU8L9qto-9Cw5x5TURkfxq31eryiHe2IteRAEtoVzYg2_s9QhlH6ANVcFOVp8dMno0V9bfMYfeSQa3FkjEbxFsseHkMOiADmp9-tOGtLXO942Ir-2W_Hz3Utlpt4erz0dVJBw8a-mFavPA8EEDWR7ACJNocrVHFkS3wFISh3LqLn6KkXiowaynKlJOEHGctuahzKmF3ZOJ1BvGgKohxF9OXvQs9IdmCfWhYsLr5Q2p04TJJ-MyvTipuggKVioh8mHmOFdfnN-Zused6tXzhZtKPUWTmM8cBKoAOBHExxcMQ8SVSjxnw_7_eLKm7S2wNpu0V-tiPZPCH4wYZXtWBYjmfy0V9ydjXnNunXfgxKixLeFNnONUXxEuqPLvM_xAuonQBXVN4nYrgJv8p8U6_ZlGMPjJq1szfcuBZnzI34LSEWx_nSof0XC5Czm8iG_ihG8naivNWS8h-Q-qKMP_3PPFsLSH4Egh03pH93EJUuNAeSO4RGfUX1wzMvrv1nBC1SM660uFMbq-wkplFBbKnHKMYe-qRs1-lZPG5PwPWJJdpGqOUzbnoMOJYmiq06OHHVQyJSkcEHLCk\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"03103a52-111c-4318-a4cd-a4b33321eba0","name":"Request failed, see error message for details","originalRequest":{"url":{"path":["sauth","v2","auth","login","client"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"apiKey\": \"string\",\n \"identityProvider\": \"GOOGLE\",\n \"identityProviderToken\": \"string\",\n \"email\": \"string\",\n \"customId\": {},\n \"password\": \"string\",\n \"uuid\": \"string\",\n \"deviceId\": \"string\",\n \"agreements\": {\n \"email\": true,\n \"sms\": true,\n \"push\": true,\n \"bluetooth\": false,\n \"rfid\": false,\n \"wifi\": false\n },\n \"attributes\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n },\n \"key_2\": {\n \"value\": \"\"\n }\n },\n \"tags\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"errors\": {\n \"value\": \"\"\n },\n \"status\": {\n \"value\": \"\"\n },\n \"timestamp\": {\n \"value\": \"\"\n },\n \"path\": {\n \"value\": \"\"\n },\n \"traceId\": {\n \"value\": \"\"\n },\n \"errorCode\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"9b194d1e-abd0-45ee-8988-aa114e919a02","name":"Unauthorized.","originalRequest":{"url":{"path":["sauth","v2","auth","login","client"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"apiKey\": \"string\",\n \"identityProvider\": \"GOOGLE\",\n \"identityProviderToken\": \"string\",\n \"email\": \"string\",\n \"customId\": {},\n \"password\": \"string\",\n \"uuid\": \"string\",\n \"deviceId\": \"string\",\n \"agreements\": {\n \"email\": true,\n \"sms\": true,\n \"push\": true,\n \"bluetooth\": false,\n \"rfid\": false,\n \"wifi\": false\n },\n \"attributes\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n },\n \"key_2\": {\n \"value\": \"\"\n }\n },\n \"tags\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"2018-06-07T07:17:41.734+00:00\",\n \"status\": 401,\n \"error\": \"Unauthorized\",\n \"message\": \"Access denied\",\n \"path\": \"/v2/auth/login/client\",\n \"traceId\": \"61b4aa7c0cb1167a\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"108225bc-06d5-46c1-b5d7-13de5c07fa9d","name":"Authentication failed, see error message for details","originalRequest":{"url":{"path":["sauth","v2","auth","login","client"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"apiKey\": \"string\",\n \"identityProvider\": \"GOOGLE\",\n \"identityProviderToken\": \"string\",\n \"email\": \"string\",\n \"customId\": {},\n \"password\": \"string\",\n \"uuid\": \"string\",\n \"deviceId\": \"string\",\n \"agreements\": {\n \"email\": true,\n \"sms\": true,\n \"push\": true,\n \"bluetooth\": false,\n \"rfid\": false,\n \"wifi\": false\n },\n \"attributes\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n },\n \"key_2\": {\n \"value\": \"\"\n }\n },\n \"tags\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"errors\": {\n \"value\": \"\"\n },\n \"status\": {\n \"value\": \"\"\n },\n \"timestamp\": {\n \"value\": \"\"\n },\n \"path\": {\n \"value\": \"\"\n },\n \"traceId\": {\n \"value\": \"\"\n },\n \"errorCode\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"5bed4b90-49c3-42c6-9ed3-619a0a580a69","name":"Profile not found","originalRequest":{"url":{"path":["sauth","v2","auth","login","client"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"apiKey\": \"string\",\n \"identityProvider\": \"GOOGLE\",\n \"identityProviderToken\": \"string\",\n \"email\": \"string\",\n \"customId\": {},\n \"password\": \"string\",\n \"uuid\": \"string\",\n \"deviceId\": \"string\",\n \"agreements\": {\n \"email\": true,\n \"sms\": true,\n \"push\": true,\n \"bluetooth\": false,\n \"rfid\": false,\n \"wifi\": false\n },\n \"attributes\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n },\n \"key_2\": {\n \"value\": \"\"\n }\n },\n \"tags\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"2018-06-07T07:17:41.734+00:00\",\n \"status\": 404,\n \"error\": \"Not Found\",\n \"message\": \"Account does not exist\",\n \"path\": \"/v2/auth/login/client\",\n \"traceId\": \"61b4aa7c0cb1167a\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"627e2a94-6b7a-44f4-947e-02ec536316ca","name":"Account is locked, password reset required","originalRequest":{"url":{"path":["sauth","v2","auth","login","client"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"apiKey\": \"string\",\n \"identityProvider\": \"GOOGLE\",\n \"identityProviderToken\": \"string\",\n \"email\": \"string\",\n \"customId\": {},\n \"password\": \"string\",\n \"uuid\": \"string\",\n \"deviceId\": \"string\",\n \"agreements\": {\n \"email\": true,\n \"sms\": true,\n \"push\": true,\n \"bluetooth\": false,\n \"rfid\": false,\n \"wifi\": false\n },\n \"attributes\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n },\n \"key_2\": {\n \"value\": \"\"\n }\n },\n \"tags\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"Not Acceptable","code":406,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"2021-09-15T10:01:16.203120Z\",\n \"status\": 406,\n \"error\": \"Banned\",\n \"message\": \"Log in has been blocked\",\n \"path\": \"/v2/auth/login/client\",\n \"traceId\": \"61b4aa7c0cb1167a\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"7b4964a8-bcff-4465-9215-9bc1a7c6f9df","name":"Device control is enabled, device must be authorized (link sent by email)","originalRequest":{"url":{"path":["sauth","v2","auth","login","client"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"apiKey\": \"string\",\n \"identityProvider\": \"GOOGLE\",\n \"identityProviderToken\": \"string\",\n \"email\": \"string\",\n \"customId\": {},\n \"password\": \"string\",\n \"uuid\": \"string\",\n \"deviceId\": \"string\",\n \"agreements\": {\n \"email\": true,\n \"sms\": true,\n \"push\": true,\n \"bluetooth\": false,\n \"rfid\": false,\n \"wifi\": false\n },\n \"attributes\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n },\n \"key_2\": {\n \"value\": \"\"\n }\n },\n \"tags\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"Locked (WebDAV) (RFC 4918)","code":423,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"2021-09-15T10:01:16.203120Z\",\n \"status\": 423,\n \"error\": \"Locked\",\n \"message\": \"Device login blocked\",\n \"path\": \"/v2/auth/login/client\",\n \"traceId\": \"61b4aa7c0cb1167a\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"9f24b438-57b7-475c-98d9-43f754d5c754","name":"Authenticate as Profile (conditional)","request":{"name":"Authenticate as Profile (conditional)","description":{"content":"This method is deprecated. Use [the v3 method](#operation/authenticateConditionalUsingPOSTv3) instead. \n\n\nObtain a new JWT token for a Profile.\n\n- If the account does not exist, an account is not created.\n- If any additional conditions are required for logging in, the response is HTTP200 and lists the conditions.\n- Note that using this endpoint requires authenticating as an anonymous Profile first.\n\n\n---\n\n**Authentication:** Not required\n","type":"text/plain"},"url":{"path":["sauth","v2","auth","login","client","conditional"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"apiKey\": \"string\",\n \"identityProvider\": \"GOOGLE\",\n \"identityProviderToken\": \"string\",\n \"email\": \"string\",\n \"customId\": {},\n \"password\": \"string\",\n \"uuid\": \"string\",\n \"deviceId\": \"string\",\n \"agreements\": {\n \"email\": true,\n \"sms\": true,\n \"push\": true,\n \"bluetooth\": false,\n \"rfid\": false,\n \"wifi\": false\n },\n \"attributes\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n },\n \"key_2\": {\n \"value\": \"\"\n }\n },\n \"tags\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"3890fb37-1b6e-49c0-b14e-77c3a02f8988","name":"Details of the login operation","originalRequest":{"url":{"path":["sauth","v2","auth","login","client","conditional"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"apiKey\": \"string\",\n \"identityProvider\": \"GOOGLE\",\n \"identityProviderToken\": \"string\",\n \"email\": \"string\",\n \"customId\": {},\n \"password\": \"string\",\n \"uuid\": \"string\",\n \"deviceId\": \"string\",\n \"agreements\": {\n \"email\": true,\n \"sms\": true,\n \"push\": true,\n \"bluetooth\": false,\n \"rfid\": false,\n \"wifi\": false\n },\n \"attributes\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n },\n \"key_2\": {\n \"value\": \"\"\n }\n },\n \"tags\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"conditions\": [\n \"string\",\n \"string\"\n ],\n \"status\": \"UNAUTHORIZED\",\n \"token\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"8a497c7e-805a-4892-8259-913757cddb97","name":"Request failed, see error message for details","originalRequest":{"url":{"path":["sauth","v2","auth","login","client","conditional"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"apiKey\": \"string\",\n \"identityProvider\": \"GOOGLE\",\n \"identityProviderToken\": \"string\",\n \"email\": \"string\",\n \"customId\": {},\n \"password\": \"string\",\n \"uuid\": \"string\",\n \"deviceId\": \"string\",\n \"agreements\": {\n \"email\": true,\n \"sms\": true,\n \"push\": true,\n \"bluetooth\": false,\n \"rfid\": false,\n \"wifi\": false\n },\n \"attributes\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n },\n \"key_2\": {\n \"value\": \"\"\n }\n },\n \"tags\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"errors\": {\n \"value\": \"\"\n },\n \"status\": {\n \"value\": \"\"\n },\n \"timestamp\": {\n \"value\": \"\"\n },\n \"path\": {\n \"value\": \"\"\n },\n \"traceId\": {\n \"value\": \"\"\n },\n \"errorCode\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"8115ccd9-a5e5-40ec-a12f-255b6270f796","name":"See error message for details","originalRequest":{"url":{"path":["sauth","v2","auth","login","client","conditional"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"apiKey\": \"string\",\n \"identityProvider\": \"GOOGLE\",\n \"identityProviderToken\": \"string\",\n \"email\": \"string\",\n \"customId\": {},\n \"password\": \"string\",\n \"uuid\": \"string\",\n \"deviceId\": \"string\",\n \"agreements\": {\n \"email\": true,\n \"sms\": true,\n \"push\": true,\n \"bluetooth\": false,\n \"rfid\": false,\n \"wifi\": false\n },\n \"attributes\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n },\n \"key_2\": {\n \"value\": \"\"\n }\n },\n \"tags\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\",\n \"message\": \"string\",\n \"errors\": [\n {\n \"code\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"rejectedValue\": {\n \"value\": \"\"\n }\n },\n {\n \"code\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"rejectedValue\": {\n \"value\": \"\"\n }\n }\n ],\n \"status\": 8944,\n \"timestamp\": \"string\",\n \"path\": \"string\",\n \"traceId\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"9ac1f6d8-9d9e-4086-8051-d398808f3774","name":"Authentication failed, see error message for details","originalRequest":{"url":{"path":["sauth","v2","auth","login","client","conditional"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"apiKey\": \"string\",\n \"identityProvider\": \"GOOGLE\",\n \"identityProviderToken\": \"string\",\n \"email\": \"string\",\n \"customId\": {},\n \"password\": \"string\",\n \"uuid\": \"string\",\n \"deviceId\": \"string\",\n \"agreements\": {\n \"email\": true,\n \"sms\": true,\n \"push\": true,\n \"bluetooth\": false,\n \"rfid\": false,\n \"wifi\": false\n },\n \"attributes\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n },\n \"key_2\": {\n \"value\": \"\"\n }\n },\n \"tags\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"errors\": {\n \"value\": \"\"\n },\n \"status\": {\n \"value\": \"\"\n },\n \"timestamp\": {\n \"value\": \"\"\n },\n \"path\": {\n \"value\": \"\"\n },\n \"traceId\": {\n \"value\": \"\"\n },\n \"errorCode\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"408cbe70-3733-4734-b4a4-c472a439308c","name":"Profile not found","originalRequest":{"url":{"path":["sauth","v2","auth","login","client","conditional"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"apiKey\": \"string\",\n \"identityProvider\": \"GOOGLE\",\n \"identityProviderToken\": \"string\",\n \"email\": \"string\",\n \"customId\": {},\n \"password\": \"string\",\n \"uuid\": \"string\",\n \"deviceId\": \"string\",\n \"agreements\": {\n \"email\": true,\n \"sms\": true,\n \"push\": true,\n \"bluetooth\": false,\n \"rfid\": false,\n \"wifi\": false\n },\n \"attributes\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n },\n \"key_2\": {\n \"value\": \"\"\n }\n },\n \"tags\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"2018-06-07T07:17:41.734+00:00\",\n \"status\": 404,\n \"error\": \"Not Found\",\n \"message\": \"Account does not exist\",\n \"path\": \"/v2/auth/login/client/conditional\",\n \"traceId\": \"61b4aa7c0cb1167a\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"1d232db4-64d2-4b31-bba9-aff90b0e3411","name":"Account is locked, password reset required","originalRequest":{"url":{"path":["sauth","v2","auth","login","client","conditional"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"apiKey\": \"string\",\n \"identityProvider\": \"GOOGLE\",\n \"identityProviderToken\": \"string\",\n \"email\": \"string\",\n \"customId\": {},\n \"password\": \"string\",\n \"uuid\": \"string\",\n \"deviceId\": \"string\",\n \"agreements\": {\n \"email\": true,\n \"sms\": true,\n \"push\": true,\n \"bluetooth\": false,\n \"rfid\": false,\n \"wifi\": false\n },\n \"attributes\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n },\n \"key_2\": {\n \"value\": \"\"\n }\n },\n \"tags\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"Not Acceptable","code":406,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"2021-09-15T10:01:16.203120Z\",\n \"status\": 406,\n \"error\": \"Banned\",\n \"message\": \"Log in has been blocked\",\n \"path\": \"/v2/auth/login/client\",\n \"traceId\": \"61b4aa7c0cb1167a\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"bf3bc979-d975-4a10-bba1-8a5732bafd4c","name":"Device control is enabled, device must be authorized (link sent by email)","originalRequest":{"url":{"path":["sauth","v2","auth","login","client","conditional"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"apiKey\": \"string\",\n \"identityProvider\": \"GOOGLE\",\n \"identityProviderToken\": \"string\",\n \"email\": \"string\",\n \"customId\": {},\n \"password\": \"string\",\n \"uuid\": \"string\",\n \"deviceId\": \"string\",\n \"agreements\": {\n \"email\": true,\n \"sms\": true,\n \"push\": true,\n \"bluetooth\": false,\n \"rfid\": false,\n \"wifi\": false\n },\n \"attributes\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n },\n \"key_2\": {\n \"value\": \"\"\n }\n },\n \"tags\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"Locked (WebDAV) (RFC 4918)","code":423,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"2021-09-15T10:01:16.203120Z\",\n \"status\": 423,\n \"error\": \"Locked\",\n \"message\": \"Device login blocked\",\n \"path\": \"/v2/auth/login/client\",\n \"traceId\": \"61b4aa7c0cb1167a\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"49ceabd2-2e80-4642-8dd2-328d13250dd3","name":"Authenticate anonymously","request":{"name":"Authenticate anonymously","description":{"content":"This method is deprecated. Use [the v3 method](#operation/LogInAnonymouslyV3) instead.\n\nObtain a new JWT for an anonymous Profile. The token can be used and refreshed in the same way\nas tokens of registered Profiles.\n\n\n---\n\n**Authentication:** Not required\n","type":"text/plain"},"url":{"path":["sauth","v2","auth","login","client","anonymous"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":null,"body":{"mode":"raw","raw":"{\n \"apiKey\": \"string\",\n \"deviceId\": \"string\",\n \"uuid\": \"07243772-008a-42e1-ba37-c3807cebde8f\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"60260bdd-6b00-418d-b495-7389e4a1ab74","name":"Anonymous authorization token","originalRequest":{"url":{"path":["sauth","v2","auth","login","client","anonymous"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"apiKey\": \"string\",\n \"deviceId\": \"string\",\n \"uuid\": \"07243772-008a-42e1-ba37-c3807cebde8f\"\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"token\": \"eyJhbGciOiJSUzUxMiJ9.eyJzdinvalidwYmZkM2FkNDg2ZjQ3ZGRiMjE5MSIsImF1ZCI6IkFQSSIsInJsbSI6ImFub255bW91c19jbGllbnQiLCJjdGQiOjE1NTMwMDQxNTkxNTEsImVtbCI6IjYyMjM3NmY4LTAwMDAtMjIyMi1kN2Y5LTA3MGZhOTU2ZTk2M0Bhbm9ueW1vdXMuaW52YWxpZCIsImF1dGgiOiJINHNJQUFBQUFBQUFBSXVPQlFBcHUwd05BZ0FBQUE9PSIsImlzcyI6IlN5bmVyaXNlIiwiYnBpIjo0OCwiY2xJZCI6NDMzMjMwMjg4LCJleHAiOjE1NTMwMDcxNTksImFwayI6IjVBRUFBM0Q1LUUxNDctQzdFQi1ENTlFLUJDRjUwMTA5QTNEMSJ9.QOmSqrneR4mJFv4JdxTYsw_wGcDawDsVQuB-GVTcPPwijiP7lQ_Jzqq2Mypg1BS6WFlfGB8fzqCY9iMF_TdtjmoB4xBrY95ylU8L9qto-9Cw5x5TURkfxq31eryiHe2IteRAEtoVzYg2_s9QhlH6ANVcFOVp8dMno0V9bfMYfeSQa3FkjEbxFsseHkMOiADmp9-tOGtLXO942Ir-2W_Hz3Utlpt4erz0dVJBw8a-mFavPA8EEDWR7ACJNocrVHFkS3wFISh3LqLn6KkXiowaynKlJOEHGctuahzKmF3ZOJ1BvGgKohxF9OXvQs9IdmCfWhYsLr5Q2p04TJJ-MyvTipuggKVioh8mHmOFdfnN-Zused6tXzhZtKPUWTmM8cBKoAOBHExxcMQ8SVSjxnw_7_eLKm7S2wNpu0V-tiPZPCH4wYZXtWBYjmfy0V9ydjXnNunXfgxKixLeFNnONUXxEuqPLvM_xAuonQBXVN4nYrgJv8p8U6_ZlGMPjJq1szfcuBZnzI34LSEWx_nSof0XC5Czm8iG_ihG8naivNWS8h-Q-qKMP_3PPFsLSH4Egh03pH93EJUuNAeSO4RGfUX1wzMvrv1nBC1SM660uFMbq-wkplFBbKnHKMYe-qRs1-lZPG5PwPWJJdpGqOUzbnoMOJYmiq06OHHVQyJSkcEHLCk\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"1e5bff66-8d0e-4040-b8f4-e95b22b7fc3f","name":"Unauthorized","originalRequest":{"url":{"path":["sauth","v2","auth","login","client","anonymous"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"apiKey\": \"string\",\n \"deviceId\": \"string\",\n \"uuid\": \"07243772-008a-42e1-ba37-c3807cebde8f\"\n}","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"2019-03-19T14:03:35.413+00:00\",\n \"status\": 401,\n \"error\": \"Unauthorized\",\n \"message\": \"Could not fetch ApiKey\",\n \"path\": \"/v2/auth/login/client/anonymous\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"bd43944d-ad96-4210-aef0-7f3b5353f4da","name":"Authenticate as Profile","request":{"name":"Authenticate as Profile","description":{"content":"This method is deprecated. Use [the v3 method](#operation/authenticateViaServerV3) instead.\n\nObtain a new JWT for a Profile. It is designed to be used from backend server. If an account for the Profile does not exist and the `identityProvider` is different than `SYNERISE`, this request creates an account.\n\n\n---\n\n**API consumer:** Workspace (Business Profile)\n\n**API key permission required:** `SAUTH_SERVER_LOGIN_CLIENT_CREATE`\n","type":"text/plain"},"url":{"path":["sauth","v2","auth","server","login","client"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":null,"body":{"mode":"raw","raw":"{\n \"apiKey\": {\n \"value\": \"\"\n },\n \"identityProvider\": {\n \"value\": \"\"\n },\n \"ipAddress\": \"string\",\n \"identityProviderToken\": {\n \"value\": \"\"\n },\n \"email\": {\n \"value\": \"\"\n },\n \"customId\": {\n \"value\": \"\"\n },\n \"password\": {\n \"value\": \"\"\n },\n \"uuid\": {\n \"value\": \"\"\n },\n \"deviceId\": {\n \"value\": \"\"\n },\n \"agreements\": {\n \"value\": \"\"\n },\n \"attributes\": {\n \"value\": \"\"\n },\n \"tags\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"8729e264-772c-425c-a9ac-5cb1b190cf85","name":"Profile authorization token","originalRequest":{"url":{"path":["sauth","v2","auth","server","login","client"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"apiKey\": {\n \"value\": \"\"\n },\n \"identityProvider\": {\n \"value\": \"\"\n },\n \"ipAddress\": \"string\",\n \"identityProviderToken\": {\n \"value\": \"\"\n },\n \"email\": {\n \"value\": \"\"\n },\n \"customId\": {\n \"value\": \"\"\n },\n \"password\": {\n \"value\": \"\"\n },\n \"uuid\": {\n \"value\": \"\"\n },\n \"deviceId\": {\n \"value\": \"\"\n },\n \"agreements\": {\n \"value\": \"\"\n },\n \"attributes\": {\n \"value\": \"\"\n },\n \"tags\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"token\": \"eyJhbGciOiJSUzUxMiJ9.eyJzdinvalidwYmZkM2FkNDg2ZjQ3ZGRiMjE5MSIsImF1ZCI6IkFQSSIsInJsbSI6ImFub255bW91c19jbGllbnQiLCJjdGQiOjE1NTMwMDQxNTkxNTEsImVtbCI6IjYyMjM3NmY4LTAwMDAtMjIyMi1kN2Y5LTA3MGZhOTU2ZTk2M0Bhbm9ueW1vdXMuaW52YWxpZCIsImF1dGgiOiJINHNJQUFBQUFBQUFBSXVPQlFBcHUwd05BZ0FBQUE9PSIsImlzcyI6IlN5bmVyaXNlIiwiYnBpIjo0OCwiY2xJZCI6NDMzMjMwMjg4LCJleHAiOjE1NTMwMDcxNTksImFwayI6IjVBRUFBM0Q1LUUxNDctQzdFQi1ENTlFLUJDRjUwMTA5QTNEMSJ9.QOmSqrneR4mJFv4JdxTYsw_wGcDawDsVQuB-GVTcPPwijiP7lQ_Jzqq2Mypg1BS6WFlfGB8fzqCY9iMF_TdtjmoB4xBrY95ylU8L9qto-9Cw5x5TURkfxq31eryiHe2IteRAEtoVzYg2_s9QhlH6ANVcFOVp8dMno0V9bfMYfeSQa3FkjEbxFsseHkMOiADmp9-tOGtLXO942Ir-2W_Hz3Utlpt4erz0dVJBw8a-mFavPA8EEDWR7ACJNocrVHFkS3wFISh3LqLn6KkXiowaynKlJOEHGctuahzKmF3ZOJ1BvGgKohxF9OXvQs9IdmCfWhYsLr5Q2p04TJJ-MyvTipuggKVioh8mHmOFdfnN-Zused6tXzhZtKPUWTmM8cBKoAOBHExxcMQ8SVSjxnw_7_eLKm7S2wNpu0V-tiPZPCH4wYZXtWBYjmfy0V9ydjXnNunXfgxKixLeFNnONUXxEuqPLvM_xAuonQBXVN4nYrgJv8p8U6_ZlGMPjJq1szfcuBZnzI34LSEWx_nSof0XC5Czm8iG_ihG8naivNWS8h-Q-qKMP_3PPFsLSH4Egh03pH93EJUuNAeSO4RGfUX1wzMvrv1nBC1SM660uFMbq-wkplFBbKnHKMYe-qRs1-lZPG5PwPWJJdpGqOUzbnoMOJYmiq06OHHVQyJSkcEHLCk\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"58294554-1a44-4310-982f-19b6adaf8a4b","name":"Request failed, see error message for details","originalRequest":{"url":{"path":["sauth","v2","auth","server","login","client"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"apiKey\": {\n \"value\": \"\"\n },\n \"identityProvider\": {\n \"value\": \"\"\n },\n \"ipAddress\": \"string\",\n \"identityProviderToken\": {\n \"value\": \"\"\n },\n \"email\": {\n \"value\": \"\"\n },\n \"customId\": {\n \"value\": \"\"\n },\n \"password\": {\n \"value\": \"\"\n },\n \"uuid\": {\n \"value\": \"\"\n },\n \"deviceId\": {\n \"value\": \"\"\n },\n \"agreements\": {\n \"value\": \"\"\n },\n \"attributes\": {\n \"value\": \"\"\n },\n \"tags\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"errors\": {\n \"value\": \"\"\n },\n \"status\": {\n \"value\": \"\"\n },\n \"timestamp\": {\n \"value\": \"\"\n },\n \"path\": {\n \"value\": \"\"\n },\n \"traceId\": {\n \"value\": \"\"\n },\n \"errorCode\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"0be899bf-42ad-48fb-a2ca-2b9250545de9","name":"Unauthorized.","originalRequest":{"url":{"path":["sauth","v2","auth","server","login","client"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"apiKey\": {\n \"value\": \"\"\n },\n \"identityProvider\": {\n \"value\": \"\"\n },\n \"ipAddress\": \"string\",\n \"identityProviderToken\": {\n \"value\": \"\"\n },\n \"email\": {\n \"value\": \"\"\n },\n \"customId\": {\n \"value\": \"\"\n },\n \"password\": {\n \"value\": \"\"\n },\n \"uuid\": {\n \"value\": \"\"\n },\n \"deviceId\": {\n \"value\": \"\"\n },\n \"agreements\": {\n \"value\": \"\"\n },\n \"attributes\": {\n \"value\": \"\"\n },\n \"tags\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"2018-06-07T07:17:41.734+00:00\",\n \"status\": 401,\n \"error\": \"Unauthorized\",\n \"message\": \"Access denied\",\n \"path\": \"/v3/auth/login/client\",\n \"traceId\": \"61b4aa7c0cb1167a\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"3bf71b22-7261-4ba6-827e-0c76298bb3cb","name":"Authentication failed, see error message for details","originalRequest":{"url":{"path":["sauth","v2","auth","server","login","client"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"apiKey\": {\n \"value\": \"\"\n },\n \"identityProvider\": {\n \"value\": \"\"\n },\n \"ipAddress\": \"string\",\n \"identityProviderToken\": {\n \"value\": \"\"\n },\n \"email\": {\n \"value\": \"\"\n },\n \"customId\": {\n \"value\": \"\"\n },\n \"password\": {\n \"value\": \"\"\n },\n \"uuid\": {\n \"value\": \"\"\n },\n \"deviceId\": {\n \"value\": \"\"\n },\n \"agreements\": {\n \"value\": \"\"\n },\n \"attributes\": {\n \"value\": \"\"\n },\n \"tags\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"errors\": {\n \"value\": \"\"\n },\n \"status\": {\n \"value\": \"\"\n },\n \"timestamp\": {\n \"value\": \"\"\n },\n \"path\": {\n \"value\": \"\"\n },\n \"traceId\": {\n \"value\": \"\"\n },\n \"errorCode\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"72fc0d97-8ab1-4fb7-8e82-5c0c26343b46","name":"Profile not found","originalRequest":{"url":{"path":["sauth","v2","auth","server","login","client"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"apiKey\": {\n \"value\": \"\"\n },\n \"identityProvider\": {\n \"value\": \"\"\n },\n \"ipAddress\": \"string\",\n \"identityProviderToken\": {\n \"value\": \"\"\n },\n \"email\": {\n \"value\": \"\"\n },\n \"customId\": {\n \"value\": \"\"\n },\n \"password\": {\n \"value\": \"\"\n },\n \"uuid\": {\n \"value\": \"\"\n },\n \"deviceId\": {\n \"value\": \"\"\n },\n \"agreements\": {\n \"value\": \"\"\n },\n \"attributes\": {\n \"value\": \"\"\n },\n \"tags\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"2018-06-07T07:17:41.734+00:00\",\n \"status\": 404,\n \"error\": \"Not Found\",\n \"message\": \"Account does not exist\",\n \"path\": \"/v3/auth/login/client\",\n \"traceId\": \"61b4aa7c0cb1167a\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"09ddc15c-fb92-4c61-a5e8-bb24eed734f1","name":"Account is locked, password reset required","originalRequest":{"url":{"path":["sauth","v2","auth","server","login","client"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"apiKey\": {\n \"value\": \"\"\n },\n \"identityProvider\": {\n \"value\": \"\"\n },\n \"ipAddress\": \"string\",\n \"identityProviderToken\": {\n \"value\": \"\"\n },\n \"email\": {\n \"value\": \"\"\n },\n \"customId\": {\n \"value\": \"\"\n },\n \"password\": {\n \"value\": \"\"\n },\n \"uuid\": {\n \"value\": \"\"\n },\n \"deviceId\": {\n \"value\": \"\"\n },\n \"agreements\": {\n \"value\": \"\"\n },\n \"attributes\": {\n \"value\": \"\"\n },\n \"tags\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Not Acceptable","code":406,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"2021-09-15T10:01:16.203120Z\",\n \"status\": 406,\n \"error\": \"Banned\",\n \"message\": \"Log in has been blocked\",\n \"path\": \"/v2/auth/login/client\",\n \"traceId\": \"61b4aa7c0cb1167a\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"2c52d989-b884-409b-b353-424f361f8f4e","name":"Device control is enabled, device must be authorized (link sent by email)","originalRequest":{"url":{"path":["sauth","v2","auth","server","login","client"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"apiKey\": {\n \"value\": \"\"\n },\n \"identityProvider\": {\n \"value\": \"\"\n },\n \"ipAddress\": \"string\",\n \"identityProviderToken\": {\n \"value\": \"\"\n },\n \"email\": {\n \"value\": \"\"\n },\n \"customId\": {\n \"value\": \"\"\n },\n \"password\": {\n \"value\": \"\"\n },\n \"uuid\": {\n \"value\": \"\"\n },\n \"deviceId\": {\n \"value\": \"\"\n },\n \"agreements\": {\n \"value\": \"\"\n },\n \"attributes\": {\n \"value\": \"\"\n },\n \"tags\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Locked (WebDAV) (RFC 4918)","code":423,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"2021-09-15T10:01:16.203120Z\",\n \"status\": 423,\n \"error\": \"Locked\",\n \"message\": \"Device login blocked\",\n \"path\": \"/v2/auth/login/client\",\n \"traceId\": \"61b4aa7c0cb1167a\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}],"event":[]},{"id":"46a3b4a5-f400-4f02-a164-fb4e748c0169","name":"Events","description":{"content":"","type":"text/plain"},"item":[{"id":"4265d254-3a11-4175-9fe5-5e5be2ca9cb6","name":"Create a transaction","request":{"name":"Create a transaction","description":{"content":"Create a transaction record in the database.\n\nFor each transaction, a `transaction.charge` event is generated automatically. In addition, each item in the `products` array produces a `product.buy` event.\n\nAll monetary values must use the same currency and be greater\nthan or equal to zero. `discountAmount` must be greater than zero\nor omitted.\n\n\n---\n\n**API consumer:** Workspace (Business Profile)\n\n**API key permission required:** `API_TRANSACTION_CREATE`\n","type":"text/plain"},"url":{"path":["v4","transactions"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"client\": {\n \"customId\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n },\n \"uuid\": {\n \"value\": \"\"\n },\n \"email\": {\n \"value\": \"\"\n }\n },\n \"orderId\": \"be466362-71e9-4bdd-ad11-bfacead5276b\",\n \"paymentInfo\": {\n \"method\": {\n \"value\": \"\"\n }\n },\n \"products\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"revenue\": {\n \"amount\": {\n \"value\": \"\"\n },\n \"currency\": {\n \"value\": \"\"\n }\n },\n \"value\": {\n \"amount\": 112.25,\n \"currency\": {\n \"value\": \"\"\n }\n },\n \"source\": \"MOBILE\",\n \"discountAmount\": {\n \"amount\": 3141.4098235776178,\n \"currency\": {\n \"value\": \"\"\n }\n },\n \"metadata\": {\n \"promotionCode\": {\n \"value\": \"\"\n },\n \"quantityToRedeem\": {\n \"value\": \"\"\n }\n },\n \"recordedAt\": \"2019-02-07T09:53:56.999+00:00\",\n \"eventSalt\": \"972346context.action2019-02-07T09:53:56.999+00:00\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"ea4335e2-7381-4c76-981e-283669dad5ef","name":"Accepted","originalRequest":{"url":{"path":["v4","transactions"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"client\": {\n \"customId\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n },\n \"uuid\": {\n \"value\": \"\"\n },\n \"email\": {\n \"value\": \"\"\n }\n },\n \"orderId\": \"be466362-71e9-4bdd-ad11-bfacead5276b\",\n \"paymentInfo\": {\n \"method\": {\n \"value\": \"\"\n }\n },\n \"products\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"revenue\": {\n \"amount\": {\n \"value\": \"\"\n },\n \"currency\": {\n \"value\": \"\"\n }\n },\n \"value\": {\n \"amount\": 112.25,\n \"currency\": {\n \"value\": \"\"\n }\n },\n \"source\": \"MOBILE\",\n \"discountAmount\": {\n \"amount\": 2355.213025427134,\n \"currency\": {\n \"value\": \"\"\n }\n },\n \"metadata\": {\n \"promotionCode\": {\n \"value\": \"\"\n },\n \"quantityToRedeem\": {\n \"value\": \"\"\n },\n \"key_0\": 4718\n },\n \"recordedAt\": \"2019-02-07T09:53:56.999+00:00\",\n \"eventSalt\": \"972346context.action2019-02-07T09:53:56.999+00:00\"\n}","options":{"raw":{"language":"json"}}}},"status":"Accepted","code":202,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"f019ab57-cc86-4f15-8b01-9aac8e0c6ade","name":"Bad Request","originalRequest":{"url":{"path":["v4","transactions"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"client\": {\n \"customId\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n },\n \"uuid\": {\n \"value\": \"\"\n },\n \"email\": {\n \"value\": \"\"\n }\n },\n \"orderId\": \"be466362-71e9-4bdd-ad11-bfacead5276b\",\n \"paymentInfo\": {\n \"method\": {\n \"value\": \"\"\n }\n },\n \"products\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"revenue\": {\n \"amount\": {\n \"value\": \"\"\n },\n \"currency\": {\n \"value\": \"\"\n }\n },\n \"value\": {\n \"amount\": 112.25,\n \"currency\": {\n \"value\": \"\"\n }\n },\n \"source\": \"MOBILE\",\n \"discountAmount\": {\n \"amount\": 2355.213025427134,\n \"currency\": {\n \"value\": \"\"\n }\n },\n \"metadata\": {\n \"promotionCode\": {\n \"value\": \"\"\n },\n \"quantityToRedeem\": {\n \"value\": \"\"\n },\n \"key_0\": 4718\n },\n \"recordedAt\": \"2019-02-07T09:53:56.999+00:00\",\n \"eventSalt\": \"972346context.action2019-02-07T09:53:56.999+00:00\"\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"2020-10-28T12:14:45.364+00:00\",\n \"status\": 400,\n \"error\": \"Bad Request\",\n \"message\": \"JSON parse error: Missing property: 'currency'; nested exception is com.fasterxml.jackson.databind.JsonMappingException: Missing property: 'currency'\\n at [Source: (PushbackInputStream); line: 13, column: 14] (through reference chain: com.synerise.api.endpoint.transactions.domain.model.IdentifiedTransactionData[\\\"products\\\"]->java.util.ArrayList[0]->com.synerise.api.endpoint.transactions.domain.model.ProductData[\\\"finalUnitPrice\\\"])\",\n \"path\": \"/transactions\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"e39de261-8a3e-4a5f-9b98-669cea9bebe4","name":"Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc.","originalRequest":{"url":{"path":["v4","transactions"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"client\": {\n \"customId\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n },\n \"uuid\": {\n \"value\": \"\"\n },\n \"email\": {\n \"value\": \"\"\n }\n },\n \"orderId\": \"be466362-71e9-4bdd-ad11-bfacead5276b\",\n \"paymentInfo\": {\n \"method\": {\n \"value\": \"\"\n }\n },\n \"products\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"revenue\": {\n \"amount\": {\n \"value\": \"\"\n },\n \"currency\": {\n \"value\": \"\"\n }\n },\n \"value\": {\n \"amount\": 112.25,\n \"currency\": {\n \"value\": \"\"\n }\n },\n \"source\": \"MOBILE\",\n \"discountAmount\": {\n \"amount\": 2355.213025427134,\n \"currency\": {\n \"value\": \"\"\n }\n },\n \"metadata\": {\n \"promotionCode\": {\n \"value\": \"\"\n },\n \"quantityToRedeem\": {\n \"value\": \"\"\n },\n \"key_0\": 4718\n },\n \"recordedAt\": \"2019-02-07T09:53:56.999+00:00\",\n \"eventSalt\": \"972346context.action2019-02-07T09:53:56.999+00:00\"\n}","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"Bad Request\",\n \"status\": 400,\n \"timestamp\": \"2020-10-29T13:08:16.235Z\",\n \"path\": \"/exampleEndpoint\",\n \"message\": \"Some fields did not pass validation\",\n \"errors\": [\n {\n \"code\": 120,\n \"field\": \"exampleField\",\n \"message\": \"120\",\n \"rejectedValue\": \"exampleValue\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"1bbb7a9e-5d43-4d9e-a687-15472b731385","name":"Forbidden; insufficient permissions (when PII protection is enabled, PII permissions are required in addition to the permissions listed in the method description)","originalRequest":{"url":{"path":["v4","transactions"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"client\": {\n \"customId\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n },\n \"uuid\": {\n \"value\": \"\"\n },\n \"email\": {\n \"value\": \"\"\n }\n },\n \"orderId\": \"be466362-71e9-4bdd-ad11-bfacead5276b\",\n \"paymentInfo\": {\n \"method\": {\n \"value\": \"\"\n }\n },\n \"products\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"revenue\": {\n \"amount\": {\n \"value\": \"\"\n },\n \"currency\": {\n \"value\": \"\"\n }\n },\n \"value\": {\n \"amount\": 112.25,\n \"currency\": {\n \"value\": \"\"\n }\n },\n \"source\": \"MOBILE\",\n \"discountAmount\": {\n \"amount\": 2355.213025427134,\n \"currency\": {\n \"value\": \"\"\n }\n },\n \"metadata\": {\n \"promotionCode\": {\n \"value\": \"\"\n },\n \"quantityToRedeem\": {\n \"value\": \"\"\n },\n \"key_0\": 4718\n },\n \"recordedAt\": \"2019-02-07T09:53:56.999+00:00\",\n \"eventSalt\": \"972346context.action2019-02-07T09:53:56.999+00:00\"\n}","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"2018-06-07T07:29:27.489+00:00\",\n \"status\": 403,\n \"error\": \"Forbidden\",\n \"message\": \"Forbidden\",\n \"path\": \"/path_of_the_endpoint\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"76353bca-d1f2-474f-b936-a89f779ae7e6","name":"Profile not found or access blocked by PII protection settings","originalRequest":{"url":{"path":["v4","transactions"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"client\": {\n \"customId\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n },\n \"uuid\": {\n \"value\": \"\"\n },\n \"email\": {\n \"value\": \"\"\n }\n },\n \"orderId\": \"be466362-71e9-4bdd-ad11-bfacead5276b\",\n \"paymentInfo\": {\n \"method\": {\n \"value\": \"\"\n }\n },\n \"products\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"revenue\": {\n \"amount\": {\n \"value\": \"\"\n },\n \"currency\": {\n \"value\": \"\"\n }\n },\n \"value\": {\n \"amount\": 112.25,\n \"currency\": {\n \"value\": \"\"\n }\n },\n \"source\": \"MOBILE\",\n \"discountAmount\": {\n \"amount\": 2355.213025427134,\n \"currency\": {\n \"value\": \"\"\n }\n },\n \"metadata\": {\n \"promotionCode\": {\n \"value\": \"\"\n },\n \"quantityToRedeem\": {\n \"value\": \"\"\n },\n \"key_0\": 4718\n },\n \"recordedAt\": \"2019-02-07T09:53:56.999+00:00\",\n \"eventSalt\": \"972346context.action2019-02-07T09:53:56.999+00:00\"\n}","options":{"raw":{"language":"json"}}}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"\"Client 5005535044 not found\"","cookie":[],"_postman_previewlanguage":"json"},{"id":"759b44d0-6aaf-436a-aa51-6ca86f21bb8f","name":"Unsupported Media Type","originalRequest":{"url":{"path":["v4","transactions"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"client\": {\n \"customId\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n },\n \"uuid\": {\n \"value\": \"\"\n },\n \"email\": {\n \"value\": \"\"\n }\n },\n \"orderId\": \"be466362-71e9-4bdd-ad11-bfacead5276b\",\n \"paymentInfo\": {\n \"method\": {\n \"value\": \"\"\n }\n },\n \"products\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"revenue\": {\n \"amount\": {\n \"value\": \"\"\n },\n \"currency\": {\n \"value\": \"\"\n }\n },\n \"value\": {\n \"amount\": 112.25,\n \"currency\": {\n \"value\": \"\"\n }\n },\n \"source\": \"MOBILE\",\n \"discountAmount\": {\n \"amount\": 2355.213025427134,\n \"currency\": {\n \"value\": \"\"\n }\n },\n \"metadata\": {\n \"promotionCode\": {\n \"value\": \"\"\n },\n \"quantityToRedeem\": {\n \"value\": \"\"\n },\n \"key_0\": 4718\n },\n \"recordedAt\": \"2019-02-07T09:53:56.999+00:00\",\n \"eventSalt\": \"972346context.action2019-02-07T09:53:56.999+00:00\"\n}","options":{"raw":{"language":"json"}}}},"status":"Unsupported Media Type","code":415,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"2018-06-07T07:27:23.136+00:00\",\n \"status\": 415,\n \"error\": \"Unsupported Media Type\",\n \"message\": \"Content type 'application/xml' not supported\",\n \"path\": \"/path_of_the_endpoint\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"9dc5c856-7b8d-4add-95ff-cca3c0215ff6","name":"Batch add or update transactions","request":{"name":"Batch add or update transactions","description":{"content":"Enqueue a number of add/update operations in the Synerise\napplication database. \n\nFor each transaction, a `transaction.charge` event is generated automatically. In addition, each item in the `products` array produces a `product.buy` event.\n\nIf you don't have some information about a transaction, don't insert a null-value parameter - omit the parameter entirely. Sending a null value deletes an attribute (if it's a custom attribute) or sets it to null/default value (if the attribute is Synerise-native).\n\n\n\nThe body contains an array of objects to update. The objects are\nthe same as in the *Update transaction* and *Create transaction*\nendpoints.\n\n\n\nAll monetary values must use the same currency and be greater\nthan or equal to zero. `discountAmount` must be greater than zero\nor omitted.\n\n\n---\n\n**API consumer:** Workspace (Business Profile)\n\n**API key permission required:** `API_BATCH_TRANSACTION_CREATE`\n","type":"text/plain"},"url":{"path":["v4","transactions","batch"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"[\n {\n \"client\": {\n \"value\": \"\"\n },\n \"orderId\": {\n \"value\": \"\"\n },\n \"paymentInfo\": {\n \"value\": \"\"\n },\n \"products\": {\n \"value\": \"\"\n },\n \"revenue\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n },\n \"source\": {\n \"value\": \"\"\n },\n \"discountAmount\": {\n \"value\": \"\"\n },\n \"metadata\": {\n \"value\": \"\"\n },\n \"recordedAt\": {\n \"value\": \"\"\n },\n \"eventSalt\": {\n \"value\": \"\"\n }\n },\n {\n \"client\": {\n \"value\": \"\"\n },\n \"orderId\": {\n \"value\": \"\"\n },\n \"paymentInfo\": {\n \"value\": \"\"\n },\n \"products\": {\n \"value\": \"\"\n },\n \"revenue\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n },\n \"source\": {\n \"value\": \"\"\n },\n \"discountAmount\": {\n \"value\": \"\"\n },\n \"metadata\": {\n \"value\": \"\"\n },\n \"recordedAt\": {\n \"value\": \"\"\n },\n \"eventSalt\": {\n \"value\": \"\"\n }\n }\n]","options":{"raw":{"language":"json"}}}},"response":[{"id":"b1801446-bb36-4d5f-8d84-458fa8b5551f","name":"Accepted","originalRequest":{"url":{"path":["v4","transactions","batch"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"}],"method":"POST","body":{"mode":"raw","raw":"[\n {\n \"client\": {\n \"value\": \"\"\n },\n \"orderId\": {\n \"value\": \"\"\n },\n \"paymentInfo\": {\n \"value\": \"\"\n },\n \"products\": {\n \"value\": \"\"\n },\n \"revenue\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n },\n \"source\": {\n \"value\": \"\"\n },\n \"discountAmount\": {\n \"value\": \"\"\n },\n \"metadata\": {\n \"value\": \"\"\n },\n \"recordedAt\": {\n \"value\": \"\"\n },\n \"eventSalt\": {\n \"value\": \"\"\n }\n },\n {\n \"client\": {\n \"value\": \"\"\n },\n \"orderId\": {\n \"value\": \"\"\n },\n \"paymentInfo\": {\n \"value\": \"\"\n },\n \"products\": {\n \"value\": \"\"\n },\n \"revenue\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n },\n \"source\": {\n \"value\": \"\"\n },\n \"discountAmount\": {\n \"value\": \"\"\n },\n \"metadata\": {\n \"value\": \"\"\n },\n \"recordedAt\": {\n \"value\": \"\"\n },\n \"eventSalt\": {\n \"value\": \"\"\n }\n }\n]","options":{"raw":{"language":"json"}}}},"status":"Accepted","code":202,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"8081ce15-0471-4940-b1dc-88d29d338c1c","name":"Bad Request","originalRequest":{"url":{"path":["v4","transactions","batch"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"[\n {\n \"client\": {\n \"value\": \"\"\n },\n \"orderId\": {\n \"value\": \"\"\n },\n \"paymentInfo\": {\n \"value\": \"\"\n },\n \"products\": {\n \"value\": \"\"\n },\n \"revenue\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n },\n \"source\": {\n \"value\": \"\"\n },\n \"discountAmount\": {\n \"value\": \"\"\n },\n \"metadata\": {\n \"value\": \"\"\n },\n \"recordedAt\": {\n \"value\": \"\"\n },\n \"eventSalt\": {\n \"value\": \"\"\n }\n },\n {\n \"client\": {\n \"value\": \"\"\n },\n \"orderId\": {\n \"value\": \"\"\n },\n \"paymentInfo\": {\n \"value\": \"\"\n },\n \"products\": {\n \"value\": \"\"\n },\n \"revenue\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n },\n \"source\": {\n \"value\": \"\"\n },\n \"discountAmount\": {\n \"value\": \"\"\n },\n \"metadata\": {\n \"value\": \"\"\n },\n \"recordedAt\": {\n \"value\": \"\"\n },\n \"eventSalt\": {\n \"value\": \"\"\n }\n }\n]","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"Bad Request\",\n \"status\": 400,\n \"timestamp\": \"2020-10-28T12:24:24.444Z\",\n \"path\": \"/transactions\",\n \"message\": \"Some fields did not pass validation\",\n \"errors\": [\n {\n \"code\": 14191,\n \"field\": \"client\",\n \"message\": \"Client cannot have null value\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"6cbb18ee-0dbe-4923-aaa7-45b022f1e08f","name":"Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc.","originalRequest":{"url":{"path":["v4","transactions","batch"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"[\n {\n \"client\": {\n \"value\": \"\"\n },\n \"orderId\": {\n \"value\": \"\"\n },\n \"paymentInfo\": {\n \"value\": \"\"\n },\n \"products\": {\n \"value\": \"\"\n },\n \"revenue\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n },\n \"source\": {\n \"value\": \"\"\n },\n \"discountAmount\": {\n \"value\": \"\"\n },\n \"metadata\": {\n \"value\": \"\"\n },\n \"recordedAt\": {\n \"value\": \"\"\n },\n \"eventSalt\": {\n \"value\": \"\"\n }\n },\n {\n \"client\": {\n \"value\": \"\"\n },\n \"orderId\": {\n \"value\": \"\"\n },\n \"paymentInfo\": {\n \"value\": \"\"\n },\n \"products\": {\n \"value\": \"\"\n },\n \"revenue\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n },\n \"source\": {\n \"value\": \"\"\n },\n \"discountAmount\": {\n \"value\": \"\"\n },\n \"metadata\": {\n \"value\": \"\"\n },\n \"recordedAt\": {\n \"value\": \"\"\n },\n \"eventSalt\": {\n \"value\": \"\"\n }\n }\n]","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"Bad Request\",\n \"status\": 400,\n \"timestamp\": \"2020-10-29T13:08:16.235Z\",\n \"path\": \"/exampleEndpoint\",\n \"message\": \"Some fields did not pass validation\",\n \"errors\": [\n {\n \"code\": 120,\n \"field\": \"exampleField\",\n \"message\": \"120\",\n \"rejectedValue\": \"exampleValue\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"dd8ffdc4-d048-4384-98be-1112bf018072","name":"Forbidden; insufficient permissions (when PII protection is enabled, PII permissions are required in addition to the permissions listed in the method description)","originalRequest":{"url":{"path":["v4","transactions","batch"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"[\n {\n \"client\": {\n \"value\": \"\"\n },\n \"orderId\": {\n \"value\": \"\"\n },\n \"paymentInfo\": {\n \"value\": \"\"\n },\n \"products\": {\n \"value\": \"\"\n },\n \"revenue\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n },\n \"source\": {\n \"value\": \"\"\n },\n \"discountAmount\": {\n \"value\": \"\"\n },\n \"metadata\": {\n \"value\": \"\"\n },\n \"recordedAt\": {\n \"value\": \"\"\n },\n \"eventSalt\": {\n \"value\": \"\"\n }\n },\n {\n \"client\": {\n \"value\": \"\"\n },\n \"orderId\": {\n \"value\": \"\"\n },\n \"paymentInfo\": {\n \"value\": \"\"\n },\n \"products\": {\n \"value\": \"\"\n },\n \"revenue\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n },\n \"source\": {\n \"value\": \"\"\n },\n \"discountAmount\": {\n \"value\": \"\"\n },\n \"metadata\": {\n \"value\": \"\"\n },\n \"recordedAt\": {\n \"value\": \"\"\n },\n \"eventSalt\": {\n \"value\": \"\"\n }\n }\n]","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"2018-06-07T07:29:27.489+00:00\",\n \"status\": 403,\n \"error\": \"Forbidden\",\n \"message\": \"Forbidden\",\n \"path\": \"/path_of_the_endpoint\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"3610f160-7ec1-46c1-a685-d7deb256639b","name":"Unsupported Media Type","originalRequest":{"url":{"path":["v4","transactions","batch"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"[\n {\n \"client\": {\n \"value\": \"\"\n },\n \"orderId\": {\n \"value\": \"\"\n },\n \"paymentInfo\": {\n \"value\": \"\"\n },\n \"products\": {\n \"value\": \"\"\n },\n \"revenue\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n },\n \"source\": {\n \"value\": \"\"\n },\n \"discountAmount\": {\n \"value\": \"\"\n },\n \"metadata\": {\n \"value\": \"\"\n },\n \"recordedAt\": {\n \"value\": \"\"\n },\n \"eventSalt\": {\n \"value\": \"\"\n }\n },\n {\n \"client\": {\n \"value\": \"\"\n },\n \"orderId\": {\n \"value\": \"\"\n },\n \"paymentInfo\": {\n \"value\": \"\"\n },\n \"products\": {\n \"value\": \"\"\n },\n \"revenue\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n },\n \"source\": {\n \"value\": \"\"\n },\n \"discountAmount\": {\n \"value\": \"\"\n },\n \"metadata\": {\n \"value\": \"\"\n },\n \"recordedAt\": {\n \"value\": \"\"\n },\n \"eventSalt\": {\n \"value\": \"\"\n }\n }\n]","options":{"raw":{"language":"json"}}}},"status":"Unsupported Media Type","code":415,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"2018-06-07T07:27:23.136+00:00\",\n \"status\": 415,\n \"error\": \"Unsupported Media Type\",\n \"message\": \"Content type 'application/xml' not supported\",\n \"path\": \"/path_of_the_endpoint\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"8c68787f-b3ca-449c-94c6-1917dcfb6c62","name":"Get Profile events as Workspace","request":{"name":"Get Profile events as Workspace","description":{"content":"**This endpoint is deprecated. Use [/activities-api/events/by/{identifierType}](https://developers.synerise.com/DataManagement/DataManagement.html#operation/getEventsByIdentifier) instead.** \n\nRetrieve a list of events saved in a Profile.\n\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User\n\n**API key permission required:** `API_LISTING_BY_CLIENT_EVENTS_READ`\n\n**User role permission required:** `client_activities: read`\n","type":"text/plain"},"url":{"path":["v4","events","by-client",":clientId"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"time[from]","value":"2008-02-12T03:58:30.166Z","description":"Start of the time range to query. UTC time in ISO 8601 (for example, `2020-10-19T13:47:53Z`). If no value is provided, the results are returned starting with the oldest entry in the database."},{"disabled":false,"key":"time[to]","value":"2008-02-12T03:58:30.166Z","description":"End of the time range to query. UTC time in ISO 8601 (for example, `2020-10-19T13:47:53Z`). If no value is provided, the current time applies."},{"disabled":false,"key":"action","value":"transaction.charge","description":"Filter events by action type. For example, to retrieve completed transactions, enter `transaction.charge`"},{"disabled":false,"key":"limit","value":"269","description":"The number of events to retrieve"}],"variable":[{"disabled":false,"type":"any","value":"434428563","key":"clientId","description":"(Required) The ID of the profile\n\n**Upcoming breaking change (effective July 6, 2026):** Synerise is introducing changes to how user identifiers and UUIDs are handled. These changes may affect profiles with accented or diacritical characters in identifiers, profiles with leading or trailing whitespace in identifiers, and profiles with duplicate UUIDs. For details and recommended actions, see [Upcoming changes to identifier and UUID handling](https://hub.synerise.com/docs/settings/configuration/identifier-standardization/).\n"}]},"header":[{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"727863dd-15c6-4f27-b458-2c8f3f11f2f2","name":"A list of events","originalRequest":{"url":{"path":["v4","events","by-client",":clientId"],"host":["{{baseUrl}}"],"query":[{"key":"time[from]","value":"2008-02-12T03:58:30.166Z"},{"key":"time[to]","value":"2008-02-12T03:58:30.166Z"},{"key":"action","value":"transaction.charge"},{"key":"limit","value":"269"}],"variable":[{"disabled":false,"type":"any","value":"434428563","key":"clientId","description":"(Required) The ID of the profile\n\n**Upcoming breaking change (effective July 6, 2026):** Synerise is introducing changes to how user identifiers and UUIDs are handled. These changes may affect profiles with accented or diacritical characters in identifiers, profiles with leading or trailing whitespace in identifiers, and profiles with duplicate UUIDs. For details and recommended actions, see [Upcoming changes to identifier and UUID handling](https://hub.synerise.com/docs/settings/configuration/identifier-standardization/).\n"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Content-Type","value":"application/json"},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"[\n {\n \"time\": {\n \"value\": \"\"\n },\n \"action\": {\n \"value\": \"\"\n },\n \"label\": {\n \"value\": \"\"\n },\n \"client\": {\n \"value\": \"\"\n },\n \"params\": {\n \"value\": \"\"\n }\n },\n {\n \"time\": {\n \"value\": \"\"\n },\n \"action\": {\n \"value\": \"\"\n },\n \"label\": {\n \"value\": \"\"\n },\n \"client\": {\n \"value\": \"\"\n },\n \"params\": {\n \"value\": \"\"\n }\n }\n]","cookie":[],"_postman_previewlanguage":"json"},{"id":"f1bb8f4b-06b3-4ca9-b0e2-c35af51e9d3c","name":"Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc.","originalRequest":{"url":{"path":["v4","events","by-client",":clientId"],"host":["{{baseUrl}}"],"query":[{"key":"time[from]","value":"2008-02-12T03:58:30.166Z"},{"key":"time[to]","value":"2008-02-12T03:58:30.166Z"},{"key":"action","value":"transaction.charge"},{"key":"limit","value":"269"}],"variable":[{"disabled":false,"type":"any","value":"434428563","key":"clientId","description":"(Required) The ID of the profile\n\n**Upcoming breaking change (effective July 6, 2026):** Synerise is introducing changes to how user identifiers and UUIDs are handled. These changes may affect profiles with accented or diacritical characters in identifiers, profiles with leading or trailing whitespace in identifiers, and profiles with duplicate UUIDs. For details and recommended actions, see [Upcoming changes to identifier and UUID handling](https://hub.synerise.com/docs/settings/configuration/identifier-standardization/).\n"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Content-Type","value":"application/json"},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"Bad Request\",\n \"status\": 400,\n \"timestamp\": \"2020-10-29T13:08:16.235Z\",\n \"path\": \"/exampleEndpoint\",\n \"message\": \"Some fields did not pass validation\",\n \"errors\": [\n {\n \"code\": 120,\n \"field\": \"exampleField\",\n \"message\": \"120\",\n \"rejectedValue\": \"exampleValue\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"4fd6f353-1456-4a08-92bb-b01feb8fad93","name":"Forbidden; insufficient permissions (when PII protection is enabled, PII permissions are required in addition to the permissions listed in the method description)","originalRequest":{"url":{"path":["v4","events","by-client",":clientId"],"host":["{{baseUrl}}"],"query":[{"key":"time[from]","value":"2008-02-12T03:58:30.166Z"},{"key":"time[to]","value":"2008-02-12T03:58:30.166Z"},{"key":"action","value":"transaction.charge"},{"key":"limit","value":"269"}],"variable":[{"disabled":false,"type":"any","value":"434428563","key":"clientId","description":"(Required) The ID of the profile\n\n**Upcoming breaking change (effective July 6, 2026):** Synerise is introducing changes to how user identifiers and UUIDs are handled. These changes may affect profiles with accented or diacritical characters in identifiers, profiles with leading or trailing whitespace in identifiers, and profiles with duplicate UUIDs. For details and recommended actions, see [Upcoming changes to identifier and UUID handling](https://hub.synerise.com/docs/settings/configuration/identifier-standardization/).\n"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Content-Type","value":"application/json"},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"2018-06-07T07:29:27.489+00:00\",\n \"status\": 403,\n \"error\": \"Forbidden\",\n \"message\": \"Forbidden\",\n \"path\": \"/path_of_the_endpoint\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"fe89a2fb-2b27-4de0-b112-0305a8925739","name":"Get Profile's own events","request":{"name":"Get Profile's own events","description":{"content":"**This endpoint is deprecated. Use [/activities-api/events](https://developers.synerise.com/DataManagement/DataManagement.html#operation/getEvents) instead.** \n\nA Profile can retrieve a list of its own events saved in the database.\n\n\n---\n\n**API consumer:** Profile (Client)\n","type":"text/plain"},"url":{"path":["v4","events"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"time[from]","value":"2008-02-12T03:58:30.166Z","description":"Start of the time range to query. UTC time in ISO 8601 (for example, `2020-10-19T13:47:53Z`). If no value is provided, the results are returned starting with the oldest entry in the database."},{"disabled":false,"key":"time[to]","value":"2008-02-12T03:58:30.166Z","description":"End of the time range to query. UTC time in ISO 8601 (for example, `2020-10-19T13:47:53Z`). If no value is provided, the current time applies."},{"disabled":false,"key":"action","value":"transaction.charge","description":"Filter events by action type. For example, to retrieve completed transactions, enter `transaction.charge`"},{"disabled":false,"key":"limit","value":"269","description":"The number of events to retrieve"}],"variable":[]},"header":[{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"4142aa8e-e978-4ad9-ab14-2912f541eaf4","name":"A list of events","originalRequest":{"url":{"path":["v4","events"],"host":["{{baseUrl}}"],"query":[{"key":"time[from]","value":"2008-02-12T03:58:30.166Z"},{"key":"time[to]","value":"2008-02-12T03:58:30.166Z"},{"key":"action","value":"transaction.charge"},{"key":"limit","value":"269"}],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Content-Type","value":"application/json"},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"[\n {\n \"time\": {\n \"value\": \"\"\n },\n \"action\": {\n \"value\": \"\"\n },\n \"label\": {\n \"value\": \"\"\n },\n \"client\": {\n \"value\": \"\"\n },\n \"params\": {\n \"value\": \"\"\n }\n },\n {\n \"time\": {\n \"value\": \"\"\n },\n \"action\": {\n \"value\": \"\"\n },\n \"label\": {\n \"value\": \"\"\n },\n \"client\": {\n \"value\": \"\"\n },\n \"params\": {\n \"value\": \"\"\n }\n }\n]","cookie":[],"_postman_previewlanguage":"json"},{"id":"5ec1f90c-6346-4df3-9af3-6399b2dd5f92","name":"Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc.","originalRequest":{"url":{"path":["v4","events"],"host":["{{baseUrl}}"],"query":[{"key":"time[from]","value":"2008-02-12T03:58:30.166Z"},{"key":"time[to]","value":"2008-02-12T03:58:30.166Z"},{"key":"action","value":"transaction.charge"},{"key":"limit","value":"269"}],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Content-Type","value":"application/json"},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"Bad Request\",\n \"status\": 400,\n \"timestamp\": \"2020-10-29T13:08:16.235Z\",\n \"path\": \"/exampleEndpoint\",\n \"message\": \"Some fields did not pass validation\",\n \"errors\": [\n {\n \"code\": 120,\n \"field\": \"exampleField\",\n \"message\": \"120\",\n \"rejectedValue\": \"exampleValue\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"6b625c94-195e-4161-9ef1-115608e3ac17","name":"Forbidden; insufficient permissions (when PII protection is enabled, PII permissions are required in addition to the permissions listed in the method description)","originalRequest":{"url":{"path":["v4","events"],"host":["{{baseUrl}}"],"query":[{"key":"time[from]","value":"2008-02-12T03:58:30.166Z"},{"key":"time[to]","value":"2008-02-12T03:58:30.166Z"},{"key":"action","value":"transaction.charge"},{"key":"limit","value":"269"}],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Content-Type","value":"application/json"},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"2018-06-07T07:29:27.489+00:00\",\n \"status\": 403,\n \"error\": \"Forbidden\",\n \"message\": \"Forbidden\",\n \"path\": \"/path_of_the_endpoint\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"ce18f448-b5d8-4ae9-b26b-895e208aad0b","name":"Unsupported Media Type","originalRequest":{"url":{"path":["v4","events"],"host":["{{baseUrl}}"],"query":[{"key":"time[from]","value":"2008-02-12T03:58:30.166Z"},{"key":"time[to]","value":"2008-02-12T03:58:30.166Z"},{"key":"action","value":"transaction.charge"},{"key":"limit","value":"269"}],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Content-Type","value":"application/json"},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Unsupported Media Type","code":415,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"2018-06-07T07:27:23.136+00:00\",\n \"status\": 415,\n \"error\": \"Unsupported Media Type\",\n \"message\": \"Content type 'application/xml' not supported\",\n \"path\": \"/path_of_the_endpoint\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"1c32de7b-1bbe-4e78-923b-1d2b932d851a","name":"Internal Server Error","originalRequest":{"url":{"path":["v4","events"],"host":["{{baseUrl}}"],"query":[{"key":"time[from]","value":"2008-02-12T03:58:30.166Z"},{"key":"time[to]","value":"2008-02-12T03:58:30.166Z"},{"key":"action","value":"transaction.charge"},{"key":"limit","value":"269"}],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Content-Type","value":"application/json"},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"2018-06-07T09:50:43.947+00:00\",\n \"status\": 500,\n \"error\": \"Internal Server Error\",\n \"message\": \"Duration between time[from] and time[to] cannot be greater than 7 days\",\n \"path\": \"/events/by-client/525446574\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"dfeca57f-19ed-49c7-aa22-ce9074da8abc","name":"Application started","request":{"name":"Application started","description":{"content":"Send a 'client application started' event.\n\nThis endpoint is available from API version 4.1.2.\n\nWhen you send an event to this endpoint, the `action` field is set to `client.applicationStarted` by the backend.\n\n---\n\n**API consumers:** Workspace (Business Profile), Profile (Client), Anonymous Profile\n\n**API key permission required:** `API_APPLICATION_STARTED_EVENTS_CREATE`\n","type":"text/plain"},"url":{"path":["v4","events","application-started"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"client\": {\n \"value\": \"\"\n },\n \"label\": {\n \"value\": \"\"\n },\n \"params\": {\n \"value\": \"\"\n },\n \"time\": {\n \"value\": \"\"\n },\n \"eventSalt\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"bcdf3a57-a587-45e3-9fd1-ef06f3e73397","name":"Accepted","originalRequest":{"url":{"path":["v4","events","application-started"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"client\": {\n \"value\": \"\"\n },\n \"label\": {\n \"value\": \"\"\n },\n \"params\": {\n \"value\": \"\"\n },\n \"time\": {\n \"value\": \"\"\n },\n \"eventSalt\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Accepted","code":202,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"320a5c41-4467-48b1-9e93-2d59e4dceaab","name":"Bad request: input data missing or malformed","originalRequest":{"url":{"path":["v4","events","application-started"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"client\": {\n \"value\": \"\"\n },\n \"label\": {\n \"value\": \"\"\n },\n \"params\": {\n \"value\": \"\"\n },\n \"time\": {\n \"value\": \"\"\n },\n \"eventSalt\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"2018-06-07T07:28:26.078+00:00\",\n \"status\": 400,\n \"error\": \"Bad Request\",\n \"message\": \"Version header content is invalid\",\n \"path\": \"/path_of_the_endpoint\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"8923c0d4-1e6f-452a-914b-861c85513a27","name":"Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc.","originalRequest":{"url":{"path":["v4","events","application-started"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"client\": {\n \"value\": \"\"\n },\n \"label\": {\n \"value\": \"\"\n },\n \"params\": {\n \"value\": \"\"\n },\n \"time\": {\n \"value\": \"\"\n },\n \"eventSalt\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"Bad Request\",\n \"status\": 400,\n \"timestamp\": \"2020-10-29T13:08:16.235Z\",\n \"path\": \"/exampleEndpoint\",\n \"message\": \"Some fields did not pass validation\",\n \"errors\": [\n {\n \"code\": 120,\n \"field\": \"exampleField\",\n \"message\": \"120\",\n \"rejectedValue\": \"exampleValue\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"817bd6aa-4315-4e63-94af-a4d56ff351ae","name":"Forbidden; insufficient permissions (when PII protection is enabled, PII permissions are required in addition to the permissions listed in the method description)","originalRequest":{"url":{"path":["v4","events","application-started"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"client\": {\n \"value\": \"\"\n },\n \"label\": {\n \"value\": \"\"\n },\n \"params\": {\n \"value\": \"\"\n },\n \"time\": {\n \"value\": \"\"\n },\n \"eventSalt\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"2018-06-07T07:29:27.489+00:00\",\n \"status\": 403,\n \"error\": \"Forbidden\",\n \"message\": \"Forbidden\",\n \"path\": \"/path_of_the_endpoint\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"5213bc40-a811-407a-b0b4-5af479608975","name":"Unsupported Media Type","originalRequest":{"url":{"path":["v4","events","application-started"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"client\": {\n \"value\": \"\"\n },\n \"label\": {\n \"value\": \"\"\n },\n \"params\": {\n \"value\": \"\"\n },\n \"time\": {\n \"value\": \"\"\n },\n \"eventSalt\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Unsupported Media Type","code":415,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"2018-06-07T07:27:23.136+00:00\",\n \"status\": 415,\n \"error\": \"Unsupported Media Type\",\n \"message\": \"Content type 'application/xml' not supported\",\n \"path\": \"/path_of_the_endpoint\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"18f467af-ca03-414c-9a78-31bfa9eb2fcf","name":"Internal Server Error","originalRequest":{"url":{"path":["v4","events","application-started"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"client\": {\n \"value\": \"\"\n },\n \"label\": {\n \"value\": \"\"\n },\n \"params\": {\n \"value\": \"\"\n },\n \"time\": {\n \"value\": \"\"\n },\n \"eventSalt\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"2018-06-07T09:53:56.999+00:00\",\n \"status\": 500,\n \"error\": \"Internal Server Error\",\n \"message\": \"Error occurred during event publication\",\n \"path\": \"/events/application-started\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"136a8845-0a4f-435d-be76-570eb23e652d","name":"Profile account registered","request":{"name":"Profile account registered","description":{"content":"Send a 'profile account registered' event.

If you don't have a value for a field, omit that field. Do not send null values.\n\nWhen you send an event to this endpoint, the `action` field is set to `client.register` by the backend.\n\n---\n\n**API consumers:** Workspace (Business Profile), Profile (Client), Anonymous Profile\n\n**API key permission required:** `API_REGISTERED_EVENTS_CREATE`\n","type":"text/plain"},"url":{"path":["v4","events","registered"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"label\": {\n \"value\": \"\"\n },\n \"client\": {\n \"value\": \"\"\n },\n \"time\": {\n \"value\": \"\"\n },\n \"eventSalt\": {\n \"value\": \"\"\n },\n \"params\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"565bc376-a1bb-4f92-ac71-f32e573718c0","name":"Accepted","originalRequest":{"url":{"path":["v4","events","registered"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"label\": {\n \"value\": \"\"\n },\n \"client\": {\n \"value\": \"\"\n },\n \"time\": {\n \"value\": \"\"\n },\n \"eventSalt\": {\n \"value\": \"\"\n },\n \"params\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Accepted","code":202,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"bdb0d092-7d1e-444a-ab81-205b80c065c8","name":"Bad request: input data missing or malformed","originalRequest":{"url":{"path":["v4","events","registered"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"label\": {\n \"value\": \"\"\n },\n \"client\": {\n \"value\": \"\"\n },\n \"time\": {\n \"value\": \"\"\n },\n \"eventSalt\": {\n \"value\": \"\"\n },\n \"params\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"2018-06-07T07:28:26.078+00:00\",\n \"status\": 400,\n \"error\": \"Bad Request\",\n \"message\": \"Version header content is invalid\",\n \"path\": \"/path_of_the_endpoint\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"6c006000-7e1b-481e-9a80-1ec34107f952","name":"Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc.","originalRequest":{"url":{"path":["v4","events","registered"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"label\": {\n \"value\": \"\"\n },\n \"client\": {\n \"value\": \"\"\n },\n \"time\": {\n \"value\": \"\"\n },\n \"eventSalt\": {\n \"value\": \"\"\n },\n \"params\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"Bad Request\",\n \"status\": 400,\n \"timestamp\": \"2020-10-29T13:08:16.235Z\",\n \"path\": \"/exampleEndpoint\",\n \"message\": \"Some fields did not pass validation\",\n \"errors\": [\n {\n \"code\": 120,\n \"field\": \"exampleField\",\n \"message\": \"120\",\n \"rejectedValue\": \"exampleValue\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"ba50dae5-75db-4b28-b04b-4ebb43f61918","name":"Forbidden; insufficient permissions (when PII protection is enabled, PII permissions are required in addition to the permissions listed in the method description)","originalRequest":{"url":{"path":["v4","events","registered"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"label\": {\n \"value\": \"\"\n },\n \"client\": {\n \"value\": \"\"\n },\n \"time\": {\n \"value\": \"\"\n },\n \"eventSalt\": {\n \"value\": \"\"\n },\n \"params\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"2018-06-07T07:29:27.489+00:00\",\n \"status\": 403,\n \"error\": \"Forbidden\",\n \"message\": \"Forbidden\",\n \"path\": \"/path_of_the_endpoint\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"4b800bad-409d-47ef-b358-64be67caa08f","name":"Unsupported Media Type","originalRequest":{"url":{"path":["v4","events","registered"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"label\": {\n \"value\": \"\"\n },\n \"client\": {\n \"value\": \"\"\n },\n \"time\": {\n \"value\": \"\"\n },\n \"eventSalt\": {\n \"value\": \"\"\n },\n \"params\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Unsupported Media Type","code":415,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"2018-06-07T07:27:23.136+00:00\",\n \"status\": 415,\n \"error\": \"Unsupported Media Type\",\n \"message\": \"Content type 'application/xml' not supported\",\n \"path\": \"/path_of_the_endpoint\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"6ef837f9-733b-4e25-a704-0d77da9358e0","name":"Profile logged in","request":{"name":"Profile logged in","description":{"content":"Send a 'profile logged in' event.

If you don't have a value for a field, omit that field. Do not send null values.\n\nWhen you send an event to this endpoint, the `action` field is set to `client.login` by the backend.\n\n---\n\n**API consumers:** Workspace (Business Profile), Profile (Client), Anonymous Profile\n\n**API key permission required:** `API_LOGGED_IN_EVENTS_CREATE`\n","type":"text/plain"},"url":{"path":["v4","events","logged-in"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"label\": {\n \"value\": \"\"\n },\n \"client\": {\n \"value\": \"\"\n },\n \"time\": {\n \"value\": \"\"\n },\n \"eventSalt\": {\n \"value\": \"\"\n },\n \"params\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"3c793293-b460-4907-9af9-5785553c578c","name":"Accepted","originalRequest":{"url":{"path":["v4","events","logged-in"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"label\": {\n \"value\": \"\"\n },\n \"client\": {\n \"value\": \"\"\n },\n \"time\": {\n \"value\": \"\"\n },\n \"eventSalt\": {\n \"value\": \"\"\n },\n \"params\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Accepted","code":202,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"ab82ad42-69ec-4dee-9740-3089125fa9f1","name":"Bad request: input data missing or malformed","originalRequest":{"url":{"path":["v4","events","logged-in"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"label\": {\n \"value\": \"\"\n },\n \"client\": {\n \"value\": \"\"\n },\n \"time\": {\n \"value\": \"\"\n },\n \"eventSalt\": {\n \"value\": \"\"\n },\n \"params\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"2018-06-07T07:28:26.078+00:00\",\n \"status\": 400,\n \"error\": \"Bad Request\",\n \"message\": \"Version header content is invalid\",\n \"path\": \"/path_of_the_endpoint\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"9bb269c8-f93c-4862-a6fd-e1d0d4244227","name":"Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc.","originalRequest":{"url":{"path":["v4","events","logged-in"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"label\": {\n \"value\": \"\"\n },\n \"client\": {\n \"value\": \"\"\n },\n \"time\": {\n \"value\": \"\"\n },\n \"eventSalt\": {\n \"value\": \"\"\n },\n \"params\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"Bad Request\",\n \"status\": 400,\n \"timestamp\": \"2020-10-29T13:08:16.235Z\",\n \"path\": \"/exampleEndpoint\",\n \"message\": \"Some fields did not pass validation\",\n \"errors\": [\n {\n \"code\": 120,\n \"field\": \"exampleField\",\n \"message\": \"120\",\n \"rejectedValue\": \"exampleValue\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"12314260-4aff-4967-9e09-32a229644db9","name":"Forbidden; insufficient permissions (when PII protection is enabled, PII permissions are required in addition to the permissions listed in the method description)","originalRequest":{"url":{"path":["v4","events","logged-in"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"label\": {\n \"value\": \"\"\n },\n \"client\": {\n \"value\": \"\"\n },\n \"time\": {\n \"value\": \"\"\n },\n \"eventSalt\": {\n \"value\": \"\"\n },\n \"params\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"2018-06-07T07:29:27.489+00:00\",\n \"status\": 403,\n \"error\": \"Forbidden\",\n \"message\": \"Forbidden\",\n \"path\": \"/path_of_the_endpoint\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"71483cc2-86a7-4b0c-a369-49778a51fe4d","name":"Unsupported Media Type","originalRequest":{"url":{"path":["v4","events","logged-in"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"label\": {\n \"value\": \"\"\n },\n \"client\": {\n \"value\": \"\"\n },\n \"time\": {\n \"value\": \"\"\n },\n \"eventSalt\": {\n \"value\": \"\"\n },\n \"params\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Unsupported Media Type","code":415,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"2018-06-07T07:27:23.136+00:00\",\n \"status\": 415,\n \"error\": \"Unsupported Media Type\",\n \"message\": \"Content type 'application/xml' not supported\",\n \"path\": \"/path_of_the_endpoint\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"d450ffc5-8f4f-4835-bd94-f10eb7317993","name":"Profile logged out","request":{"name":"Profile logged out","description":{"content":"Send a 'profile logged out' event.

If you don't have a value for a field, omit that field. Do not send null values.\n\nWhen you send an event to this endpoint, the `action` field is set to `client.logout` by the backend.\n\n---\n\n**API consumers:** Workspace (Business Profile), Profile (Client), Anonymous Profile\n\n**API key permission required:** `API_LOGGED_OUT_EVENTS_CREATE`\n","type":"text/plain"},"url":{"path":["v4","events","logged-out"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"label\": {\n \"value\": \"\"\n },\n \"client\": {\n \"value\": \"\"\n },\n \"time\": {\n \"value\": \"\"\n },\n \"eventSalt\": {\n \"value\": \"\"\n },\n \"params\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"e66ee4fe-080d-4a8e-aca3-737f0424572a","name":"Accepted","originalRequest":{"url":{"path":["v4","events","logged-out"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"label\": {\n \"value\": \"\"\n },\n \"client\": {\n \"value\": \"\"\n },\n \"time\": {\n \"value\": \"\"\n },\n \"eventSalt\": {\n \"value\": \"\"\n },\n \"params\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Accepted","code":202,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"7b5aa311-2c03-4085-89e3-cc995036357c","name":"Bad request: input data missing or malformed","originalRequest":{"url":{"path":["v4","events","logged-out"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"label\": {\n \"value\": \"\"\n },\n \"client\": {\n \"value\": \"\"\n },\n \"time\": {\n \"value\": \"\"\n },\n \"eventSalt\": {\n \"value\": \"\"\n },\n \"params\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"2018-06-07T07:28:26.078+00:00\",\n \"status\": 400,\n \"error\": \"Bad Request\",\n \"message\": \"Version header content is invalid\",\n \"path\": \"/path_of_the_endpoint\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"80542e3f-2a41-4c99-9e21-62b2e2c49103","name":"Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc.","originalRequest":{"url":{"path":["v4","events","logged-out"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"label\": {\n \"value\": \"\"\n },\n \"client\": {\n \"value\": \"\"\n },\n \"time\": {\n \"value\": \"\"\n },\n \"eventSalt\": {\n \"value\": \"\"\n },\n \"params\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"Bad Request\",\n \"status\": 400,\n \"timestamp\": \"2020-10-29T13:08:16.235Z\",\n \"path\": \"/exampleEndpoint\",\n \"message\": \"Some fields did not pass validation\",\n \"errors\": [\n {\n \"code\": 120,\n \"field\": \"exampleField\",\n \"message\": \"120\",\n \"rejectedValue\": \"exampleValue\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"d472f118-2da6-46e3-8f1d-3d9f040c9c35","name":"Forbidden; insufficient permissions (when PII protection is enabled, PII permissions are required in addition to the permissions listed in the method description)","originalRequest":{"url":{"path":["v4","events","logged-out"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"label\": {\n \"value\": \"\"\n },\n \"client\": {\n \"value\": \"\"\n },\n \"time\": {\n \"value\": \"\"\n },\n \"eventSalt\": {\n \"value\": \"\"\n },\n \"params\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"2018-06-07T07:29:27.489+00:00\",\n \"status\": 403,\n \"error\": \"Forbidden\",\n \"message\": \"Forbidden\",\n \"path\": \"/path_of_the_endpoint\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"477ad44e-9abd-4169-ad25-8c90dcdb9ec5","name":"Unsupported Media Type","originalRequest":{"url":{"path":["v4","events","logged-out"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"label\": {\n \"value\": \"\"\n },\n \"client\": {\n \"value\": \"\"\n },\n \"time\": {\n \"value\": \"\"\n },\n \"eventSalt\": {\n \"value\": \"\"\n },\n \"params\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Unsupported Media Type","code":415,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"2018-06-07T07:27:23.136+00:00\",\n \"status\": 415,\n \"error\": \"Unsupported Media Type\",\n \"message\": \"Content type 'application/xml' not supported\",\n \"path\": \"/path_of_the_endpoint\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"dbf2d322-eab2-401c-8549-0be0a87838bd","name":"Item added to cart","request":{"name":"Item added to cart","description":{"content":"Send an 'item added to cart' event.

If you don't have a value for a field, omit that field. Do not send null values.\n\n\nWhen you send an event to this endpoint, the `action` field is set to `product.addToCart` by the backend.\n\n---\n\n**API consumers:** Workspace (Business Profile), Profile (Client), Anonymous Profile\n\n**API key permission required:** `API_ADDED_TO_CART_EVENTS_CREATE`\n","type":"text/plain"},"url":{"path":["v4","events","added-to-cart"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"client\": {\n \"value\": \"\"\n },\n \"label\": {\n \"value\": \"\"\n },\n \"params\": {\n \"sku\": {\n \"value\": \"\"\n },\n \"source\": {\n \"value\": \"\"\n },\n \"finalUnitPrice\": {\n \"value\": \"\"\n },\n \"quantity\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"category\": {\n \"value\": \"\"\n },\n \"categories\": {\n \"value\": \"\"\n },\n \"offline\": {\n \"value\": \"\"\n },\n \"regularUnitPrice\": {\n \"value\": \"\"\n },\n \"discountedUnitPrice\": {\n \"value\": \"\"\n },\n \"ItemUrlAddress\": {\n \"value\": \"\"\n },\n \"producer\": {\n \"value\": \"\"\n }\n },\n \"time\": {\n \"value\": \"\"\n },\n \"eventSalt\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"55413e06-f596-440e-aca8-03ebf031dfc8","name":"Accepted","originalRequest":{"url":{"path":["v4","events","added-to-cart"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"client\": {\n \"value\": \"\"\n },\n \"label\": {\n \"value\": \"\"\n },\n \"params\": {\n \"sku\": {\n \"value\": \"\"\n },\n \"source\": {\n \"value\": \"\"\n },\n \"finalUnitPrice\": {\n \"value\": \"\"\n },\n \"quantity\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"category\": {\n \"value\": \"\"\n },\n \"categories\": {\n \"value\": \"\"\n },\n \"offline\": {\n \"value\": \"\"\n },\n \"regularUnitPrice\": {\n \"value\": \"\"\n },\n \"discountedUnitPrice\": {\n \"value\": \"\"\n },\n \"ItemUrlAddress\": {\n \"value\": \"\"\n },\n \"producer\": {\n \"value\": \"\"\n }\n },\n \"time\": {\n \"value\": \"\"\n },\n \"eventSalt\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Accepted","code":202,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"e02cb5d9-44d0-4ec6-ac32-f4a0c74e8a80","name":"Bad request: input data missing or malformed","originalRequest":{"url":{"path":["v4","events","added-to-cart"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"client\": {\n \"value\": \"\"\n },\n \"label\": {\n \"value\": \"\"\n },\n \"params\": {\n \"sku\": {\n \"value\": \"\"\n },\n \"source\": {\n \"value\": \"\"\n },\n \"finalUnitPrice\": {\n \"value\": \"\"\n },\n \"quantity\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"category\": {\n \"value\": \"\"\n },\n \"categories\": {\n \"value\": \"\"\n },\n \"offline\": {\n \"value\": \"\"\n },\n \"regularUnitPrice\": {\n \"value\": \"\"\n },\n \"discountedUnitPrice\": {\n \"value\": \"\"\n },\n \"ItemUrlAddress\": {\n \"value\": \"\"\n },\n \"producer\": {\n \"value\": \"\"\n }\n },\n \"time\": {\n \"value\": \"\"\n },\n \"eventSalt\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"Bad Request\",\n \"status\": 400,\n \"timestamp\": \"2018-06-07T09:55:20.563Z\",\n \"message\": \"Some fields did not pass validation\",\n \"path\": \"/events/added-to-cart\",\n \"errors\": [\n {\n \"path\": \"label\",\n \"message\": \"cannot be empty\",\n \"rejectedValue\": \"\"\n },\n {\n \"path\": \"label\",\n \"message\": \"length must be between 1 and 64\",\n \"rejectedValue\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"97cbabe9-c2bc-4aa7-ac91-e8052df4eacf","name":"Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc.","originalRequest":{"url":{"path":["v4","events","added-to-cart"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"client\": {\n \"value\": \"\"\n },\n \"label\": {\n \"value\": \"\"\n },\n \"params\": {\n \"sku\": {\n \"value\": \"\"\n },\n \"source\": {\n \"value\": \"\"\n },\n \"finalUnitPrice\": {\n \"value\": \"\"\n },\n \"quantity\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"category\": {\n \"value\": \"\"\n },\n \"categories\": {\n \"value\": \"\"\n },\n \"offline\": {\n \"value\": \"\"\n },\n \"regularUnitPrice\": {\n \"value\": \"\"\n },\n \"discountedUnitPrice\": {\n \"value\": \"\"\n },\n \"ItemUrlAddress\": {\n \"value\": \"\"\n },\n \"producer\": {\n \"value\": \"\"\n }\n },\n \"time\": {\n \"value\": \"\"\n },\n \"eventSalt\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"Bad Request\",\n \"status\": 400,\n \"timestamp\": \"2020-10-29T13:08:16.235Z\",\n \"path\": \"/exampleEndpoint\",\n \"message\": \"Some fields did not pass validation\",\n \"errors\": [\n {\n \"code\": 120,\n \"field\": \"exampleField\",\n \"message\": \"120\",\n \"rejectedValue\": \"exampleValue\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"d3415605-81ba-4f4c-a50b-74d6c661473a","name":"Forbidden; insufficient permissions (when PII protection is enabled, PII permissions are required in addition to the permissions listed in the method description)","originalRequest":{"url":{"path":["v4","events","added-to-cart"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"client\": {\n \"value\": \"\"\n },\n \"label\": {\n \"value\": \"\"\n },\n \"params\": {\n \"sku\": {\n \"value\": \"\"\n },\n \"source\": {\n \"value\": \"\"\n },\n \"finalUnitPrice\": {\n \"value\": \"\"\n },\n \"quantity\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"category\": {\n \"value\": \"\"\n },\n \"categories\": {\n \"value\": \"\"\n },\n \"offline\": {\n \"value\": \"\"\n },\n \"regularUnitPrice\": {\n \"value\": \"\"\n },\n \"discountedUnitPrice\": {\n \"value\": \"\"\n },\n \"ItemUrlAddress\": {\n \"value\": \"\"\n },\n \"producer\": {\n \"value\": \"\"\n }\n },\n \"time\": {\n \"value\": \"\"\n },\n \"eventSalt\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"2018-06-07T07:29:27.489+00:00\",\n \"status\": 403,\n \"error\": \"Forbidden\",\n \"message\": \"Forbidden\",\n \"path\": \"/path_of_the_endpoint\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"eeb496ca-350a-401e-af33-7784fd82b703","name":"Unsupported Media Type","originalRequest":{"url":{"path":["v4","events","added-to-cart"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"client\": {\n \"value\": \"\"\n },\n \"label\": {\n \"value\": \"\"\n },\n \"params\": {\n \"sku\": {\n \"value\": \"\"\n },\n \"source\": {\n \"value\": \"\"\n },\n \"finalUnitPrice\": {\n \"value\": \"\"\n },\n \"quantity\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"category\": {\n \"value\": \"\"\n },\n \"categories\": {\n \"value\": \"\"\n },\n \"offline\": {\n \"value\": \"\"\n },\n \"regularUnitPrice\": {\n \"value\": \"\"\n },\n \"discountedUnitPrice\": {\n \"value\": \"\"\n },\n \"ItemUrlAddress\": {\n \"value\": \"\"\n },\n \"producer\": {\n \"value\": \"\"\n }\n },\n \"time\": {\n \"value\": \"\"\n },\n \"eventSalt\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Unsupported Media Type","code":415,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"2018-06-07T07:27:23.136+00:00\",\n \"status\": 415,\n \"error\": \"Unsupported Media Type\",\n \"message\": \"Content type 'application/xml' not supported\",\n \"path\": \"/path_of_the_endpoint\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"e69c3e48-748e-4871-bc3a-aa4f5e15e5c4","name":"Item removed from cart","request":{"name":"Item removed from cart","description":{"content":"Send an 'item removed from cart' event.

If you don't have a value for a field, omit that field. Do not send null values.\n\n\nWhen you send an event to this endpoint, the `action` field is set to `product.removeFromCart` by the backend.\n\n---\n\n**API consumers:** Workspace (Business Profile), Profile (Client), Anonymous Profile\n\n**API key permission required:** `API_REMOVED_FROM_CART_EVENTS_CREATE`\n","type":"text/plain"},"url":{"path":["v4","events","removed-from-cart"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"client\": {\n \"value\": \"\"\n },\n \"label\": {\n \"value\": \"\"\n },\n \"params\": {\n \"sku\": {\n \"value\": \"\"\n },\n \"source\": {\n \"value\": \"\"\n },\n \"finalUnitPrice\": {\n \"value\": \"\"\n },\n \"quantity\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"category\": {\n \"value\": \"\"\n },\n \"categories\": {\n \"value\": \"\"\n },\n \"offline\": {\n \"value\": \"\"\n },\n \"regularUnitPrice\": {\n \"value\": \"\"\n },\n \"discountedUnitPrice\": {\n \"value\": \"\"\n },\n \"ItemUrlAddress\": {\n \"value\": \"\"\n },\n \"producer\": {\n \"value\": \"\"\n }\n },\n \"time\": {\n \"value\": \"\"\n },\n \"eventSalt\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"6c182f86-c599-4bd3-ae48-7bce3a8b7c19","name":"Accepted","originalRequest":{"url":{"path":["v4","events","removed-from-cart"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"client\": {\n \"value\": \"\"\n },\n \"label\": {\n \"value\": \"\"\n },\n \"params\": {\n \"sku\": {\n \"value\": \"\"\n },\n \"source\": {\n \"value\": \"\"\n },\n \"finalUnitPrice\": {\n \"value\": \"\"\n },\n \"quantity\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"category\": {\n \"value\": \"\"\n },\n \"categories\": {\n \"value\": \"\"\n },\n \"offline\": {\n \"value\": \"\"\n },\n \"regularUnitPrice\": {\n \"value\": \"\"\n },\n \"discountedUnitPrice\": {\n \"value\": \"\"\n },\n \"ItemUrlAddress\": {\n \"value\": \"\"\n },\n \"producer\": {\n \"value\": \"\"\n }\n },\n \"time\": {\n \"value\": \"\"\n },\n \"eventSalt\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Accepted","code":202,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"1529030b-8111-42da-878e-b4f4fc20aa62","name":"Bad request: input data missing or malformed","originalRequest":{"url":{"path":["v4","events","removed-from-cart"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"client\": {\n \"value\": \"\"\n },\n \"label\": {\n \"value\": \"\"\n },\n \"params\": {\n \"sku\": {\n \"value\": \"\"\n },\n \"source\": {\n \"value\": \"\"\n },\n \"finalUnitPrice\": {\n \"value\": \"\"\n },\n \"quantity\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"category\": {\n \"value\": \"\"\n },\n \"categories\": {\n \"value\": \"\"\n },\n \"offline\": {\n \"value\": \"\"\n },\n \"regularUnitPrice\": {\n \"value\": \"\"\n },\n \"discountedUnitPrice\": {\n \"value\": \"\"\n },\n \"ItemUrlAddress\": {\n \"value\": \"\"\n },\n \"producer\": {\n \"value\": \"\"\n }\n },\n \"time\": {\n \"value\": \"\"\n },\n \"eventSalt\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"2018-06-07T07:28:26.078+00:00\",\n \"status\": 400,\n \"error\": \"Bad Request\",\n \"message\": \"Version header content is invalid\",\n \"path\": \"/path_of_the_endpoint\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"9cbf13fa-464c-4f13-8319-484ff9053b07","name":"Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc.","originalRequest":{"url":{"path":["v4","events","removed-from-cart"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"client\": {\n \"value\": \"\"\n },\n \"label\": {\n \"value\": \"\"\n },\n \"params\": {\n \"sku\": {\n \"value\": \"\"\n },\n \"source\": {\n \"value\": \"\"\n },\n \"finalUnitPrice\": {\n \"value\": \"\"\n },\n \"quantity\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"category\": {\n \"value\": \"\"\n },\n \"categories\": {\n \"value\": \"\"\n },\n \"offline\": {\n \"value\": \"\"\n },\n \"regularUnitPrice\": {\n \"value\": \"\"\n },\n \"discountedUnitPrice\": {\n \"value\": \"\"\n },\n \"ItemUrlAddress\": {\n \"value\": \"\"\n },\n \"producer\": {\n \"value\": \"\"\n }\n },\n \"time\": {\n \"value\": \"\"\n },\n \"eventSalt\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"Bad Request\",\n \"status\": 400,\n \"timestamp\": \"2020-10-29T13:08:16.235Z\",\n \"path\": \"/exampleEndpoint\",\n \"message\": \"Some fields did not pass validation\",\n \"errors\": [\n {\n \"code\": 120,\n \"field\": \"exampleField\",\n \"message\": \"120\",\n \"rejectedValue\": \"exampleValue\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"5146a114-d190-419b-a782-cfcd0a5c473a","name":"Forbidden; insufficient permissions (when PII protection is enabled, PII permissions are required in addition to the permissions listed in the method description)","originalRequest":{"url":{"path":["v4","events","removed-from-cart"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"client\": {\n \"value\": \"\"\n },\n \"label\": {\n \"value\": \"\"\n },\n \"params\": {\n \"sku\": {\n \"value\": \"\"\n },\n \"source\": {\n \"value\": \"\"\n },\n \"finalUnitPrice\": {\n \"value\": \"\"\n },\n \"quantity\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"category\": {\n \"value\": \"\"\n },\n \"categories\": {\n \"value\": \"\"\n },\n \"offline\": {\n \"value\": \"\"\n },\n \"regularUnitPrice\": {\n \"value\": \"\"\n },\n \"discountedUnitPrice\": {\n \"value\": \"\"\n },\n \"ItemUrlAddress\": {\n \"value\": \"\"\n },\n \"producer\": {\n \"value\": \"\"\n }\n },\n \"time\": {\n \"value\": \"\"\n },\n \"eventSalt\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"2018-06-07T07:29:27.489+00:00\",\n \"status\": 403,\n \"error\": \"Forbidden\",\n \"message\": \"Forbidden\",\n \"path\": \"/path_of_the_endpoint\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"5e906927-25bd-4e3d-a7b6-9ff4ab0c2751","name":"Unsupported Media Type","originalRequest":{"url":{"path":["v4","events","removed-from-cart"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"client\": {\n \"value\": \"\"\n },\n \"label\": {\n \"value\": \"\"\n },\n \"params\": {\n \"sku\": {\n \"value\": \"\"\n },\n \"source\": {\n \"value\": \"\"\n },\n \"finalUnitPrice\": {\n \"value\": \"\"\n },\n \"quantity\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"category\": {\n \"value\": \"\"\n },\n \"categories\": {\n \"value\": \"\"\n },\n \"offline\": {\n \"value\": \"\"\n },\n \"regularUnitPrice\": {\n \"value\": \"\"\n },\n \"discountedUnitPrice\": {\n \"value\": \"\"\n },\n \"ItemUrlAddress\": {\n \"value\": \"\"\n },\n \"producer\": {\n \"value\": \"\"\n }\n },\n \"time\": {\n \"value\": \"\"\n },\n \"eventSalt\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Unsupported Media Type","code":415,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"2018-06-07T07:27:23.136+00:00\",\n \"status\": 415,\n \"error\": \"Unsupported Media Type\",\n \"message\": \"Content type 'application/xml' not supported\",\n \"path\": \"/path_of_the_endpoint\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"c70f734f-8e61-429a-a623-9eac68b6bf18","name":"Product added to favorites","request":{"name":"Product added to favorites","description":{"content":"Send an 'item added to favorites' event.

If you don't have a value for a field, omit that field. Do not send null values.\n\n\nWhen you send an event to this endpoint, the `action` field is set to `product.addToFavorite` by the backend.\n\n---\n\n**API consumers:** Workspace (Business Profile), Profile (Client), Anonymous Profile\n\n**API key permission required:** `API_ADDED_TO_FAVORITES_EVENTS_CREATE`\n","type":"text/plain"},"url":{"path":["v4","events","added-to-favorites"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"label\": {\n \"value\": \"\"\n },\n \"client\": {\n \"value\": \"\"\n },\n \"time\": {\n \"value\": \"\"\n },\n \"eventSalt\": {\n \"value\": \"\"\n },\n \"params\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"ce9a6215-90b3-4a31-b48e-277748549424","name":"Accepted","originalRequest":{"url":{"path":["v4","events","added-to-favorites"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"label\": {\n \"value\": \"\"\n },\n \"client\": {\n \"value\": \"\"\n },\n \"time\": {\n \"value\": \"\"\n },\n \"eventSalt\": {\n \"value\": \"\"\n },\n \"params\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Accepted","code":202,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"20e534c1-7eaa-4e37-a0d8-fb823062c1a2","name":"Bad request: input data missing or malformed","originalRequest":{"url":{"path":["v4","events","added-to-favorites"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"label\": {\n \"value\": \"\"\n },\n \"client\": {\n \"value\": \"\"\n },\n \"time\": {\n \"value\": \"\"\n },\n \"eventSalt\": {\n \"value\": \"\"\n },\n \"params\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"2018-06-07T07:28:26.078+00:00\",\n \"status\": 400,\n \"error\": \"Bad Request\",\n \"message\": \"Version header content is invalid\",\n \"path\": \"/path_of_the_endpoint\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"feadda16-3da0-44b5-8e40-471602e0a235","name":"Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc.","originalRequest":{"url":{"path":["v4","events","added-to-favorites"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"label\": {\n \"value\": \"\"\n },\n \"client\": {\n \"value\": \"\"\n },\n \"time\": {\n \"value\": \"\"\n },\n \"eventSalt\": {\n \"value\": \"\"\n },\n \"params\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"Bad Request\",\n \"status\": 400,\n \"timestamp\": \"2020-10-29T13:08:16.235Z\",\n \"path\": \"/exampleEndpoint\",\n \"message\": \"Some fields did not pass validation\",\n \"errors\": [\n {\n \"code\": 120,\n \"field\": \"exampleField\",\n \"message\": \"120\",\n \"rejectedValue\": \"exampleValue\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"d53113b7-7e62-4969-b151-db34bf2b9bb4","name":"Forbidden; insufficient permissions (when PII protection is enabled, PII permissions are required in addition to the permissions listed in the method description)","originalRequest":{"url":{"path":["v4","events","added-to-favorites"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"label\": {\n \"value\": \"\"\n },\n \"client\": {\n \"value\": \"\"\n },\n \"time\": {\n \"value\": \"\"\n },\n \"eventSalt\": {\n \"value\": \"\"\n },\n \"params\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"2018-06-07T07:29:27.489+00:00\",\n \"status\": 403,\n \"error\": \"Forbidden\",\n \"message\": \"Forbidden\",\n \"path\": \"/path_of_the_endpoint\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"cb99cb31-c4bb-492c-9f83-d4417cb02620","name":"Unsupported Media Type","originalRequest":{"url":{"path":["v4","events","added-to-favorites"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"label\": {\n \"value\": \"\"\n },\n \"client\": {\n \"value\": \"\"\n },\n \"time\": {\n \"value\": \"\"\n },\n \"eventSalt\": {\n \"value\": \"\"\n },\n \"params\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Unsupported Media Type","code":415,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"2018-06-07T07:27:23.136+00:00\",\n \"status\": 415,\n \"error\": \"Unsupported Media Type\",\n \"message\": \"Content type 'application/xml' not supported\",\n \"path\": \"/path_of_the_endpoint\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"bbedbac0-89e0-49cf-83b5-a5e5951e22f2","name":"Item viewed","request":{"name":"Item viewed","description":{"content":"Send an 'item viewed' event.\n\nWhen you send an event to this endpoint, the `action` field is set to `product.view` by the backend.\n\n---\n\n**API consumers:** Workspace (Business Profile), Profile (Client), Anonymous Profile\n\n**API key permission required:** `API_PRODUCT_VIEW_EVENTS_CREATE`\n","type":"text/plain"},"url":{"path":["v4","events","product-view"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"label\": {\n \"value\": \"\"\n },\n \"client\": {\n \"value\": \"\"\n },\n \"time\": {\n \"value\": \"\"\n },\n \"eventSalt\": {\n \"value\": \"\"\n },\n \"params\": {\n \"productId\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"fromRecommendation\": {\n \"value\": \"\"\n },\n \"source\": {\n \"value\": \"\"\n },\n \"category\": {\n \"value\": \"\"\n },\n \"url\": {\n \"value\": \"\"\n },\n \"campaignHash\": {\n \"value\": \"\"\n },\n \"key_0\": \"string\",\n \"key_1\": true\n }\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"dab7a2fe-2dc2-4c8c-9a30-8567d45cb112","name":"Accepted","originalRequest":{"url":{"path":["v4","events","product-view"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"label\": {\n \"value\": \"\"\n },\n \"client\": {\n \"value\": \"\"\n },\n \"time\": {\n \"value\": \"\"\n },\n \"eventSalt\": {\n \"value\": \"\"\n },\n \"params\": {\n \"productId\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"fromRecommendation\": {\n \"value\": \"\"\n },\n \"source\": {\n \"value\": \"\"\n },\n \"category\": {\n \"value\": \"\"\n },\n \"url\": {\n \"value\": \"\"\n },\n \"campaignHash\": {\n \"value\": \"\"\n },\n \"key_0\": \"string\",\n \"key_1\": true\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Accepted","code":202,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"8925991a-e2fb-4343-a367-54df06c24f61","name":"Bad request: input data missing or malformed","originalRequest":{"url":{"path":["v4","events","product-view"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"label\": {\n \"value\": \"\"\n },\n \"client\": {\n \"value\": \"\"\n },\n \"time\": {\n \"value\": \"\"\n },\n \"eventSalt\": {\n \"value\": \"\"\n },\n \"params\": {\n \"productId\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"fromRecommendation\": {\n \"value\": \"\"\n },\n \"source\": {\n \"value\": \"\"\n },\n \"category\": {\n \"value\": \"\"\n },\n \"url\": {\n \"value\": \"\"\n },\n \"campaignHash\": {\n \"value\": \"\"\n },\n \"key_0\": \"string\",\n \"key_1\": true\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"2018-06-07T07:28:26.078+00:00\",\n \"status\": 400,\n \"error\": \"Bad Request\",\n \"message\": \"Version header content is invalid\",\n \"path\": \"/path_of_the_endpoint\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"4b1d8dd8-57be-47eb-9b0d-2696b9f30733","name":"Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc.","originalRequest":{"url":{"path":["v4","events","product-view"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"label\": {\n \"value\": \"\"\n },\n \"client\": {\n \"value\": \"\"\n },\n \"time\": {\n \"value\": \"\"\n },\n \"eventSalt\": {\n \"value\": \"\"\n },\n \"params\": {\n \"productId\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"fromRecommendation\": {\n \"value\": \"\"\n },\n \"source\": {\n \"value\": \"\"\n },\n \"category\": {\n \"value\": \"\"\n },\n \"url\": {\n \"value\": \"\"\n },\n \"campaignHash\": {\n \"value\": \"\"\n },\n \"key_0\": \"string\",\n \"key_1\": true\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"Bad Request\",\n \"status\": 400,\n \"timestamp\": \"2020-10-29T13:08:16.235Z\",\n \"path\": \"/exampleEndpoint\",\n \"message\": \"Some fields did not pass validation\",\n \"errors\": [\n {\n \"code\": 120,\n \"field\": \"exampleField\",\n \"message\": \"120\",\n \"rejectedValue\": \"exampleValue\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"70e33349-77ca-461d-a628-99bd6dc047a6","name":"Forbidden; insufficient permissions (when PII protection is enabled, PII permissions are required in addition to the permissions listed in the method description)","originalRequest":{"url":{"path":["v4","events","product-view"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"label\": {\n \"value\": \"\"\n },\n \"client\": {\n \"value\": \"\"\n },\n \"time\": {\n \"value\": \"\"\n },\n \"eventSalt\": {\n \"value\": \"\"\n },\n \"params\": {\n \"productId\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"fromRecommendation\": {\n \"value\": \"\"\n },\n \"source\": {\n \"value\": \"\"\n },\n \"category\": {\n \"value\": \"\"\n },\n \"url\": {\n \"value\": \"\"\n },\n \"campaignHash\": {\n \"value\": \"\"\n },\n \"key_0\": \"string\",\n \"key_1\": true\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"2018-06-07T07:29:27.489+00:00\",\n \"status\": 403,\n \"error\": \"Forbidden\",\n \"message\": \"Forbidden\",\n \"path\": \"/path_of_the_endpoint\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"b947e788-41d4-4b05-903c-f2c76897b648","name":"Unsupported Media Type","originalRequest":{"url":{"path":["v4","events","product-view"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"label\": {\n \"value\": \"\"\n },\n \"client\": {\n \"value\": \"\"\n },\n \"time\": {\n \"value\": \"\"\n },\n \"eventSalt\": {\n \"value\": \"\"\n },\n \"params\": {\n \"productId\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"fromRecommendation\": {\n \"value\": \"\"\n },\n \"source\": {\n \"value\": \"\"\n },\n \"category\": {\n \"value\": \"\"\n },\n \"url\": {\n \"value\": \"\"\n },\n \"campaignHash\": {\n \"value\": \"\"\n },\n \"key_0\": \"string\",\n \"key_1\": true\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Unsupported Media Type","code":415,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"2018-06-07T07:27:23.136+00:00\",\n \"status\": 415,\n \"error\": \"Unsupported Media Type\",\n \"message\": \"Content type 'application/xml' not supported\",\n \"path\": \"/path_of_the_endpoint\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"11d0505d-25a1-4add-bd03-0ccafa55c664","name":"Profile assigned to company","request":{"name":"Profile assigned to company","description":{"content":"Send a 'profile assigned to company' event.\n\nWhen you send an event to this endpoint, the `action` field is set to `client.assignToCompany` by the backend.\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User, Profile (Client), Anonymous Profile\n\n**API key permission required:** `API_ASSIGNED_TO_COMPANY_EVENTS_CREATE`\n\n**User role permission required:** `client_activities: create`\n","type":"text/plain"},"url":{"path":["v4","events","assigned-to-company"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"client\": {\n \"value\": \"\"\n },\n \"label\": {\n \"value\": \"\"\n },\n \"params\": {\n \"companyId\": {\n \"value\": \"\"\n },\n \"key_0\": true\n },\n \"time\": {\n \"value\": \"\"\n },\n \"eventSalt\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"44a2a2e5-cef9-4b5a-8327-23b8eacbce5a","name":"Accepted","originalRequest":{"url":{"path":["v4","events","assigned-to-company"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"client\": {\n \"value\": \"\"\n },\n \"label\": {\n \"value\": \"\"\n },\n \"params\": {\n \"companyId\": {\n \"value\": \"\"\n },\n \"key_0\": true\n },\n \"time\": {\n \"value\": \"\"\n },\n \"eventSalt\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Accepted","code":202,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"1467a790-6078-487c-9e85-018274bdfe1d","name":"Bad request: input data missing or malformed","originalRequest":{"url":{"path":["v4","events","assigned-to-company"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"client\": {\n \"value\": \"\"\n },\n \"label\": {\n \"value\": \"\"\n },\n \"params\": {\n \"companyId\": {\n \"value\": \"\"\n },\n \"key_0\": true\n },\n \"time\": {\n \"value\": \"\"\n },\n \"eventSalt\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"2018-06-07T07:28:26.078+00:00\",\n \"status\": 400,\n \"error\": \"Bad Request\",\n \"message\": \"Version header content is invalid\",\n \"path\": \"/path_of_the_endpoint\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"26d62c72-6858-4731-a222-a9b65792685f","name":"Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc.","originalRequest":{"url":{"path":["v4","events","assigned-to-company"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"client\": {\n \"value\": \"\"\n },\n \"label\": {\n \"value\": \"\"\n },\n \"params\": {\n \"companyId\": {\n \"value\": \"\"\n },\n \"key_0\": true\n },\n \"time\": {\n \"value\": \"\"\n },\n \"eventSalt\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"Bad Request\",\n \"status\": 400,\n \"timestamp\": \"2020-10-29T13:08:16.235Z\",\n \"path\": \"/exampleEndpoint\",\n \"message\": \"Some fields did not pass validation\",\n \"errors\": [\n {\n \"code\": 120,\n \"field\": \"exampleField\",\n \"message\": \"120\",\n \"rejectedValue\": \"exampleValue\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"754946b2-2ce2-4b9d-ab32-c77745c4dc5c","name":"Forbidden; insufficient permissions (when PII protection is enabled, PII permissions are required in addition to the permissions listed in the method description)","originalRequest":{"url":{"path":["v4","events","assigned-to-company"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"client\": {\n \"value\": \"\"\n },\n \"label\": {\n \"value\": \"\"\n },\n \"params\": {\n \"companyId\": {\n \"value\": \"\"\n },\n \"key_0\": true\n },\n \"time\": {\n \"value\": \"\"\n },\n \"eventSalt\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"2018-06-07T07:29:27.489+00:00\",\n \"status\": 403,\n \"error\": \"Forbidden\",\n \"message\": \"Forbidden\",\n \"path\": \"/path_of_the_endpoint\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"16f68bbe-0b48-40f7-b5b7-73b7ad07e580","name":"Unsupported Media Type","originalRequest":{"url":{"path":["v4","events","assigned-to-company"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"client\": {\n \"value\": \"\"\n },\n \"label\": {\n \"value\": \"\"\n },\n \"params\": {\n \"companyId\": {\n \"value\": \"\"\n },\n \"key_0\": true\n },\n \"time\": {\n \"value\": \"\"\n },\n \"eventSalt\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Unsupported Media Type","code":415,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"2018-06-07T07:27:23.136+00:00\",\n \"status\": 415,\n \"error\": \"Unsupported Media Type\",\n \"message\": \"Content type 'application/xml' not supported\",\n \"path\": \"/path_of_the_endpoint\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"bb02af4b-56fa-45d2-afcd-57c1533b5679","name":"Profile logged location","request":{"name":"Profile logged location","description":{"content":"Send an event when a profile submits its location.

If you don't have a value for a field, omit that field. Do not send null values.\n\nWhen you send an event to this endpoint, the `action` field is set to `client.location` by the backend.\n\n---\n\n**API consumers:** Workspace (Business Profile), Profile (Client), Anonymous Profile\n\n**API key permission required:** `API_APPEARED_IN_LOCATION_EVENTS_CREATE`\n","type":"text/plain"},"url":{"path":["v4","events","appeared-in-location"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"label\": {\n \"value\": \"\"\n },\n \"client\": {\n \"value\": \"\"\n },\n \"time\": {\n \"value\": \"\"\n },\n \"eventSalt\": {\n \"value\": \"\"\n },\n \"params\": {\n \"lat\": {\n \"value\": \"\"\n },\n \"lon\": {\n \"value\": \"\"\n }\n }\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"49b6bcb2-b4f5-42b5-bf96-44bc77a584fd","name":"Accepted","originalRequest":{"url":{"path":["v4","events","appeared-in-location"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"label\": {\n \"value\": \"\"\n },\n \"client\": {\n \"value\": \"\"\n },\n \"time\": {\n \"value\": \"\"\n },\n \"eventSalt\": {\n \"value\": \"\"\n },\n \"params\": {\n \"lat\": {\n \"value\": \"\"\n },\n \"lon\": {\n \"value\": \"\"\n }\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Accepted","code":202,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"a5937dbd-07b3-4b3a-bb8d-0d1772b5f3f1","name":"Bad request: input data missing or malformed","originalRequest":{"url":{"path":["v4","events","appeared-in-location"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"label\": {\n \"value\": \"\"\n },\n \"client\": {\n \"value\": \"\"\n },\n \"time\": {\n \"value\": \"\"\n },\n \"eventSalt\": {\n \"value\": \"\"\n },\n \"params\": {\n \"lat\": {\n \"value\": \"\"\n },\n \"lon\": {\n \"value\": \"\"\n }\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"2018-06-07T07:28:26.078+00:00\",\n \"status\": 400,\n \"error\": \"Bad Request\",\n \"message\": \"Version header content is invalid\",\n \"path\": \"/path_of_the_endpoint\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"5bb38164-e1d9-42ef-83b3-9c74f50951f9","name":"Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc.","originalRequest":{"url":{"path":["v4","events","appeared-in-location"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"label\": {\n \"value\": \"\"\n },\n \"client\": {\n \"value\": \"\"\n },\n \"time\": {\n \"value\": \"\"\n },\n \"eventSalt\": {\n \"value\": \"\"\n },\n \"params\": {\n \"lat\": {\n \"value\": \"\"\n },\n \"lon\": {\n \"value\": \"\"\n }\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"Bad Request\",\n \"status\": 400,\n \"timestamp\": \"2020-10-29T13:08:16.235Z\",\n \"path\": \"/exampleEndpoint\",\n \"message\": \"Some fields did not pass validation\",\n \"errors\": [\n {\n \"code\": 120,\n \"field\": \"exampleField\",\n \"message\": \"120\",\n \"rejectedValue\": \"exampleValue\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"113215f8-e206-4e37-9fe7-e8fd33f85973","name":"Forbidden; insufficient permissions (when PII protection is enabled, PII permissions are required in addition to the permissions listed in the method description)","originalRequest":{"url":{"path":["v4","events","appeared-in-location"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"label\": {\n \"value\": \"\"\n },\n \"client\": {\n \"value\": \"\"\n },\n \"time\": {\n \"value\": \"\"\n },\n \"eventSalt\": {\n \"value\": \"\"\n },\n \"params\": {\n \"lat\": {\n \"value\": \"\"\n },\n \"lon\": {\n \"value\": \"\"\n }\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"2018-06-07T07:29:27.489+00:00\",\n \"status\": 403,\n \"error\": \"Forbidden\",\n \"message\": \"Forbidden\",\n \"path\": \"/path_of_the_endpoint\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"aa70977e-7818-48dc-acc0-ef5df3d0947b","name":"Unsupported Media Type","originalRequest":{"url":{"path":["v4","events","appeared-in-location"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"label\": {\n \"value\": \"\"\n },\n \"client\": {\n \"value\": \"\"\n },\n \"time\": {\n \"value\": \"\"\n },\n \"eventSalt\": {\n \"value\": \"\"\n },\n \"params\": {\n \"lat\": {\n \"value\": \"\"\n },\n \"lon\": {\n \"value\": \"\"\n }\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Unsupported Media Type","code":415,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"2018-06-07T07:27:23.136+00:00\",\n \"status\": 415,\n \"error\": \"Unsupported Media Type\",\n \"message\": \"Content type 'application/xml' not supported\",\n \"path\": \"/path_of_the_endpoint\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"ecad3fb1-3196-47a6-a15e-afa3040ec6ce","name":"Push notification received","request":{"name":"Push notification received","description":{"content":"Record a 'push notification was received' event. It is used for push message interaction tracking.\n\nThis endpoint is available from API version 4.1.2.\n\nWhen you send an event to this endpoint, the `action` field is set to `push.receiveInBackground` by the backend.\n\n---\n\n**API consumers:** Workspace (Business Profile), Profile (Client), Anonymous Profile\n\n**API key permission required:** `API_PUSH_RECIVED_EVENTS_CREATE`\n","type":"text/plain"},"url":{"path":["v4","events","push","received"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"label\": {\n \"value\": \"\"\n },\n \"client\": {\n \"value\": \"\"\n },\n \"time\": {\n \"value\": \"\"\n },\n \"eventSalt\": {\n \"value\": \"\"\n },\n \"params\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"dda19b64-e9fe-4241-a685-e3babc63a71f","name":"Accepted","originalRequest":{"url":{"path":["v4","events","push","received"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"label\": {\n \"value\": \"\"\n },\n \"client\": {\n \"value\": \"\"\n },\n \"time\": {\n \"value\": \"\"\n },\n \"eventSalt\": {\n \"value\": \"\"\n },\n \"params\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Accepted","code":202,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"ee0e0f34-5486-4a49-a9b5-96ab4cb94d1d","name":"Bad request: input data missing or malformed","originalRequest":{"url":{"path":["v4","events","push","received"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"label\": {\n \"value\": \"\"\n },\n \"client\": {\n \"value\": \"\"\n },\n \"time\": {\n \"value\": \"\"\n },\n \"eventSalt\": {\n \"value\": \"\"\n },\n \"params\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"2018-06-07T07:28:26.078+00:00\",\n \"status\": 400,\n \"error\": \"Bad Request\",\n \"message\": \"Version header content is invalid\",\n \"path\": \"/path_of_the_endpoint\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"887e190d-5661-483a-a1f0-f0e1d5313c24","name":"Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc.","originalRequest":{"url":{"path":["v4","events","push","received"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"label\": {\n \"value\": \"\"\n },\n \"client\": {\n \"value\": \"\"\n },\n \"time\": {\n \"value\": \"\"\n },\n \"eventSalt\": {\n \"value\": \"\"\n },\n \"params\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"Bad Request\",\n \"status\": 400,\n \"timestamp\": \"2020-10-29T13:08:16.235Z\",\n \"path\": \"/exampleEndpoint\",\n \"message\": \"Some fields did not pass validation\",\n \"errors\": [\n {\n \"code\": 120,\n \"field\": \"exampleField\",\n \"message\": \"120\",\n \"rejectedValue\": \"exampleValue\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"91117fb3-6823-4202-bc1c-758076bebf9b","name":"Forbidden; insufficient permissions (when PII protection is enabled, PII permissions are required in addition to the permissions listed in the method description)","originalRequest":{"url":{"path":["v4","events","push","received"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"label\": {\n \"value\": \"\"\n },\n \"client\": {\n \"value\": \"\"\n },\n \"time\": {\n \"value\": \"\"\n },\n \"eventSalt\": {\n \"value\": \"\"\n },\n \"params\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"2018-06-07T07:29:27.489+00:00\",\n \"status\": 403,\n \"error\": \"Forbidden\",\n \"message\": \"Forbidden\",\n \"path\": \"/path_of_the_endpoint\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"87c74920-ae80-4650-a490-6f467a79fa8a","name":"Unsupported Media Type","originalRequest":{"url":{"path":["v4","events","push","received"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"label\": {\n \"value\": \"\"\n },\n \"client\": {\n \"value\": \"\"\n },\n \"time\": {\n \"value\": \"\"\n },\n \"eventSalt\": {\n \"value\": \"\"\n },\n \"params\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Unsupported Media Type","code":415,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"2018-06-07T07:27:23.136+00:00\",\n \"status\": 415,\n \"error\": \"Unsupported Media Type\",\n \"message\": \"Content type 'application/xml' not supported\",\n \"path\": \"/path_of_the_endpoint\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"756ae900-f8fc-436f-883c-781b31b80a70","name":"Push notification viewed","request":{"name":"Push notification viewed","description":{"content":"Record a 'push notification was viewed' event. It is used for push message interaction tracking.\n\nWhen you send an event to this endpoint, the `action` field is set to `push.view` by the backend.\n\n---\n\n**API consumers:** Workspace (Business Profile), Profile (Client), Anonymous Profile\n\n**API key permission required:** `API_PUSH_VIEWED_EVENTS_CREATE`\n","type":"text/plain"},"url":{"path":["v4","events","push","viewed"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"label\": {\n \"value\": \"\"\n },\n \"client\": {\n \"value\": \"\"\n },\n \"time\": {\n \"value\": \"\"\n },\n \"eventSalt\": {\n \"value\": \"\"\n },\n \"params\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"9e561fbc-1a50-4343-b870-5eb65a5d28a9","name":"Accepted","originalRequest":{"url":{"path":["v4","events","push","viewed"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"label\": {\n \"value\": \"\"\n },\n \"client\": {\n \"value\": \"\"\n },\n \"time\": {\n \"value\": \"\"\n },\n \"eventSalt\": {\n \"value\": \"\"\n },\n \"params\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Accepted","code":202,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"434219b8-fb78-4376-87de-b087122cb20a","name":"Bad request: input data missing or malformed","originalRequest":{"url":{"path":["v4","events","push","viewed"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"label\": {\n \"value\": \"\"\n },\n \"client\": {\n \"value\": \"\"\n },\n \"time\": {\n \"value\": \"\"\n },\n \"eventSalt\": {\n \"value\": \"\"\n },\n \"params\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"2018-06-07T07:28:26.078+00:00\",\n \"status\": 400,\n \"error\": \"Bad Request\",\n \"message\": \"Version header content is invalid\",\n \"path\": \"/path_of_the_endpoint\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"427cb268-38a5-4044-9a94-d5bf3a4ed9f5","name":"Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc.","originalRequest":{"url":{"path":["v4","events","push","viewed"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"label\": {\n \"value\": \"\"\n },\n \"client\": {\n \"value\": \"\"\n },\n \"time\": {\n \"value\": \"\"\n },\n \"eventSalt\": {\n \"value\": \"\"\n },\n \"params\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"Bad Request\",\n \"status\": 400,\n \"timestamp\": \"2020-10-29T13:08:16.235Z\",\n \"path\": \"/exampleEndpoint\",\n \"message\": \"Some fields did not pass validation\",\n \"errors\": [\n {\n \"code\": 120,\n \"field\": \"exampleField\",\n \"message\": \"120\",\n \"rejectedValue\": \"exampleValue\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"8a13780e-14c6-4415-ba83-d9e004a6e365","name":"Forbidden; insufficient permissions (when PII protection is enabled, PII permissions are required in addition to the permissions listed in the method description)","originalRequest":{"url":{"path":["v4","events","push","viewed"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"label\": {\n \"value\": \"\"\n },\n \"client\": {\n \"value\": \"\"\n },\n \"time\": {\n \"value\": \"\"\n },\n \"eventSalt\": {\n \"value\": \"\"\n },\n \"params\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"2018-06-07T07:29:27.489+00:00\",\n \"status\": 403,\n \"error\": \"Forbidden\",\n \"message\": \"Forbidden\",\n \"path\": \"/path_of_the_endpoint\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"476f18c4-4f9a-45ab-8090-f023cc2b339b","name":"Unsupported Media Type","originalRequest":{"url":{"path":["v4","events","push","viewed"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"label\": {\n \"value\": \"\"\n },\n \"client\": {\n \"value\": \"\"\n },\n \"time\": {\n \"value\": \"\"\n },\n \"eventSalt\": {\n \"value\": \"\"\n },\n \"params\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Unsupported Media Type","code":415,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"2018-06-07T07:27:23.136+00:00\",\n \"status\": 415,\n \"error\": \"Unsupported Media Type\",\n \"message\": \"Content type 'application/xml' not supported\",\n \"path\": \"/path_of_the_endpoint\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"8452ec3f-be06-4969-97c0-7f63f343cc93","name":"Push notification clicked","request":{"name":"Push notification clicked","description":{"content":"Send a 'Push notification was clicked' event. It's used for push message interaction tracking.\n\nWhen you send an event to this endpoint, the `action` field is set to `push.click` by the backend.\n\n---\n\n**API consumers:** Workspace (Business Profile), Profile (Client), Anonymous Profile\n\n**API key permission required:** `API_PUSH_CLICKED_EVENTS_CREATE`\n","type":"text/plain"},"url":{"path":["v4","events","push","clicked"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"label\": {\n \"value\": \"\"\n },\n \"client\": {\n \"value\": \"\"\n },\n \"time\": {\n \"value\": \"\"\n },\n \"eventSalt\": {\n \"value\": \"\"\n },\n \"params\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"a3aab61f-98b9-400d-b50e-a857413428f8","name":"Accepted","originalRequest":{"url":{"path":["v4","events","push","clicked"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"label\": {\n \"value\": \"\"\n },\n \"client\": {\n \"value\": \"\"\n },\n \"time\": {\n \"value\": \"\"\n },\n \"eventSalt\": {\n \"value\": \"\"\n },\n \"params\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Accepted","code":202,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"92a577f6-871b-401a-af8c-9287b068f571","name":"Bad request: input data missing or malformed","originalRequest":{"url":{"path":["v4","events","push","clicked"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"label\": {\n \"value\": \"\"\n },\n \"client\": {\n \"value\": \"\"\n },\n \"time\": {\n \"value\": \"\"\n },\n \"eventSalt\": {\n \"value\": \"\"\n },\n \"params\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"2018-06-07T07:28:26.078+00:00\",\n \"status\": 400,\n \"error\": \"Bad Request\",\n \"message\": \"Version header content is invalid\",\n \"path\": \"/path_of_the_endpoint\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"a48f1440-a4cf-47e4-8084-f5afa095a6e8","name":"Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc.","originalRequest":{"url":{"path":["v4","events","push","clicked"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"label\": {\n \"value\": \"\"\n },\n \"client\": {\n \"value\": \"\"\n },\n \"time\": {\n \"value\": \"\"\n },\n \"eventSalt\": {\n \"value\": \"\"\n },\n \"params\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"Bad Request\",\n \"status\": 400,\n \"timestamp\": \"2020-10-29T13:08:16.235Z\",\n \"path\": \"/exampleEndpoint\",\n \"message\": \"Some fields did not pass validation\",\n \"errors\": [\n {\n \"code\": 120,\n \"field\": \"exampleField\",\n \"message\": \"120\",\n \"rejectedValue\": \"exampleValue\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"bd5e18e7-c6b8-4e2b-9e89-1f27841d689c","name":"Forbidden; insufficient permissions (when PII protection is enabled, PII permissions are required in addition to the permissions listed in the method description)","originalRequest":{"url":{"path":["v4","events","push","clicked"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"label\": {\n \"value\": \"\"\n },\n \"client\": {\n \"value\": \"\"\n },\n \"time\": {\n \"value\": \"\"\n },\n \"eventSalt\": {\n \"value\": \"\"\n },\n \"params\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"2018-06-07T07:29:27.489+00:00\",\n \"status\": 403,\n \"error\": \"Forbidden\",\n \"message\": \"Forbidden\",\n \"path\": \"/path_of_the_endpoint\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"38db9314-9cb0-42f4-9dfa-50f3b3169ff7","name":"Unsupported Media Type","originalRequest":{"url":{"path":["v4","events","push","clicked"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"label\": {\n \"value\": \"\"\n },\n \"client\": {\n \"value\": \"\"\n },\n \"time\": {\n \"value\": \"\"\n },\n \"eventSalt\": {\n \"value\": \"\"\n },\n \"params\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Unsupported Media Type","code":415,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"2018-06-07T07:27:23.136+00:00\",\n \"status\": 415,\n \"error\": \"Unsupported Media Type\",\n \"message\": \"Content type 'application/xml' not supported\",\n \"path\": \"/path_of_the_endpoint\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"63a429da-e968-4f5d-bfea-72dba1fec511","name":"Push notifications cancelled","request":{"name":"Push notifications cancelled","description":{"content":"Send a 'push notifications cancelled' event. It's used for push message interaction tracking.\n\nWhen you send an event to this endpoint, the `action` field is set to `push.cancel` by the backend.\n\n---\n\n**API consumers:** Workspace (Business Profile), Profile (Client), Anonymous Profile\n\n**API key permission required:** `API_PUSH_CANCELLED_EVENTS_CREATE`\n","type":"text/plain"},"url":{"path":["v4","events","push","cancelled"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"label\": {\n \"value\": \"\"\n },\n \"client\": {\n \"value\": \"\"\n },\n \"time\": {\n \"value\": \"\"\n },\n \"eventSalt\": {\n \"value\": \"\"\n },\n \"params\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"8df2e99d-7d55-48a8-a5f4-b6a8fdabde9c","name":"Accepted","originalRequest":{"url":{"path":["v4","events","push","cancelled"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"label\": {\n \"value\": \"\"\n },\n \"client\": {\n \"value\": \"\"\n },\n \"time\": {\n \"value\": \"\"\n },\n \"eventSalt\": {\n \"value\": \"\"\n },\n \"params\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Accepted","code":202,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"557749eb-5169-4edc-b21c-8c8c58ce1542","name":"Bad request: input data missing or malformed","originalRequest":{"url":{"path":["v4","events","push","cancelled"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"label\": {\n \"value\": \"\"\n },\n \"client\": {\n \"value\": \"\"\n },\n \"time\": {\n \"value\": \"\"\n },\n \"eventSalt\": {\n \"value\": \"\"\n },\n \"params\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"2018-06-07T07:28:26.078+00:00\",\n \"status\": 400,\n \"error\": \"Bad Request\",\n \"message\": \"Version header content is invalid\",\n \"path\": \"/path_of_the_endpoint\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"3a0aa769-931e-4dbf-9e4a-d2fb00788281","name":"Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc.","originalRequest":{"url":{"path":["v4","events","push","cancelled"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"label\": {\n \"value\": \"\"\n },\n \"client\": {\n \"value\": \"\"\n },\n \"time\": {\n \"value\": \"\"\n },\n \"eventSalt\": {\n \"value\": \"\"\n },\n \"params\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"Bad Request\",\n \"status\": 400,\n \"timestamp\": \"2020-10-29T13:08:16.235Z\",\n \"path\": \"/exampleEndpoint\",\n \"message\": \"Some fields did not pass validation\",\n \"errors\": [\n {\n \"code\": 120,\n \"field\": \"exampleField\",\n \"message\": \"120\",\n \"rejectedValue\": \"exampleValue\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"bcec486b-6245-42b1-8cd5-fa0da566d63e","name":"Forbidden; insufficient permissions (when PII protection is enabled, PII permissions are required in addition to the permissions listed in the method description)","originalRequest":{"url":{"path":["v4","events","push","cancelled"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"label\": {\n \"value\": \"\"\n },\n \"client\": {\n \"value\": \"\"\n },\n \"time\": {\n \"value\": \"\"\n },\n \"eventSalt\": {\n \"value\": \"\"\n },\n \"params\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"2018-06-07T07:29:27.489+00:00\",\n \"status\": 403,\n \"error\": \"Forbidden\",\n \"message\": \"Forbidden\",\n \"path\": \"/path_of_the_endpoint\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"584324e0-e1a9-4446-88c1-e2e16287d19c","name":"Unsupported Media Type","originalRequest":{"url":{"path":["v4","events","push","cancelled"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"label\": {\n \"value\": \"\"\n },\n \"client\": {\n \"value\": \"\"\n },\n \"time\": {\n \"value\": \"\"\n },\n \"eventSalt\": {\n \"value\": \"\"\n },\n \"params\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Unsupported Media Type","code":415,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"2018-06-07T07:27:23.136+00:00\",\n \"status\": 415,\n \"error\": \"Unsupported Media Type\",\n \"message\": \"Content type 'application/xml' not supported\",\n \"path\": \"/path_of_the_endpoint\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"1e7f6523-51ed-4761-9aa4-74fa7f7d7c78","name":"Transaction cancelled","request":{"name":"Transaction cancelled","description":{"content":"Send a 'transaction cancelled' event.

If you don't have a value for a field, omit that field. Do not send null values.\n\nWhen you send an event to this endpoint, the `action` field is set to `transaction.cancel` by the backend.\n\n---\n\n**API consumer:** Workspace (Business Profile)\n\n**API key permission required:** `API_CANCELLED_TRANSACTION_EVENTS_CREATE`\n","type":"text/plain"},"url":{"path":["v4","events","cancelled-transaction"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"label\": {\n \"value\": \"\"\n },\n \"client\": {\n \"value\": \"\"\n },\n \"time\": {\n \"value\": \"\"\n },\n \"eventSalt\": {\n \"value\": \"\"\n },\n \"params\": {\n \"orderId\": {\n \"value\": \"\"\n },\n \"orderStatus\": {\n \"value\": \"\"\n },\n \"discountAmount\": {\n \"value\": \"\"\n },\n \"discountPercent\": {\n \"value\": \"\"\n },\n \"discountCode\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n },\n \"revenue\": {\n \"value\": \"\"\n },\n \"products\": {\n \"value\": \"\"\n },\n \"source\": {\n \"value\": \"\"\n },\n \"paymentInfo\": {\n \"value\": \"\"\n }\n }\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"385c5569-1f55-4ed2-a574-f8745f06639a","name":"Accepted","originalRequest":{"url":{"path":["v4","events","cancelled-transaction"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"label\": {\n \"value\": \"\"\n },\n \"client\": {\n \"value\": \"\"\n },\n \"time\": {\n \"value\": \"\"\n },\n \"eventSalt\": {\n \"value\": \"\"\n },\n \"params\": {\n \"orderId\": {\n \"value\": \"\"\n },\n \"orderStatus\": {\n \"value\": \"\"\n },\n \"discountAmount\": {\n \"value\": \"\"\n },\n \"discountPercent\": {\n \"value\": \"\"\n },\n \"discountCode\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n },\n \"revenue\": {\n \"value\": \"\"\n },\n \"products\": {\n \"value\": \"\"\n },\n \"source\": {\n \"value\": \"\"\n },\n \"paymentInfo\": {\n \"value\": \"\"\n }\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Accepted","code":202,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"538b16fd-d4ee-4b30-886b-e3c22a7d5aa8","name":"Bad request: input data missing or malformed","originalRequest":{"url":{"path":["v4","events","cancelled-transaction"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"label\": {\n \"value\": \"\"\n },\n \"client\": {\n \"value\": \"\"\n },\n \"time\": {\n \"value\": \"\"\n },\n \"eventSalt\": {\n \"value\": \"\"\n },\n \"params\": {\n \"orderId\": {\n \"value\": \"\"\n },\n \"orderStatus\": {\n \"value\": \"\"\n },\n \"discountAmount\": {\n \"value\": \"\"\n },\n \"discountPercent\": {\n \"value\": \"\"\n },\n \"discountCode\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n },\n \"revenue\": {\n \"value\": \"\"\n },\n \"products\": {\n \"value\": \"\"\n },\n \"source\": {\n \"value\": \"\"\n },\n \"paymentInfo\": {\n \"value\": \"\"\n }\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"2018-06-07T07:28:26.078+00:00\",\n \"status\": 400,\n \"error\": \"Bad Request\",\n \"message\": \"Version header content is invalid\",\n \"path\": \"/path_of_the_endpoint\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"996cf2c6-8aca-4549-8a57-d8732e12c6a7","name":"Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc.","originalRequest":{"url":{"path":["v4","events","cancelled-transaction"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"label\": {\n \"value\": \"\"\n },\n \"client\": {\n \"value\": \"\"\n },\n \"time\": {\n \"value\": \"\"\n },\n \"eventSalt\": {\n \"value\": \"\"\n },\n \"params\": {\n \"orderId\": {\n \"value\": \"\"\n },\n \"orderStatus\": {\n \"value\": \"\"\n },\n \"discountAmount\": {\n \"value\": \"\"\n },\n \"discountPercent\": {\n \"value\": \"\"\n },\n \"discountCode\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n },\n \"revenue\": {\n \"value\": \"\"\n },\n \"products\": {\n \"value\": \"\"\n },\n \"source\": {\n \"value\": \"\"\n },\n \"paymentInfo\": {\n \"value\": \"\"\n }\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"Bad Request\",\n \"status\": 400,\n \"timestamp\": \"2020-10-29T13:08:16.235Z\",\n \"path\": \"/exampleEndpoint\",\n \"message\": \"Some fields did not pass validation\",\n \"errors\": [\n {\n \"code\": 120,\n \"field\": \"exampleField\",\n \"message\": \"120\",\n \"rejectedValue\": \"exampleValue\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"76cc1abb-d738-43ec-8f37-3acc4c4ff5fc","name":"Forbidden; insufficient permissions (when PII protection is enabled, PII permissions are required in addition to the permissions listed in the method description)","originalRequest":{"url":{"path":["v4","events","cancelled-transaction"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"label\": {\n \"value\": \"\"\n },\n \"client\": {\n \"value\": \"\"\n },\n \"time\": {\n \"value\": \"\"\n },\n \"eventSalt\": {\n \"value\": \"\"\n },\n \"params\": {\n \"orderId\": {\n \"value\": \"\"\n },\n \"orderStatus\": {\n \"value\": \"\"\n },\n \"discountAmount\": {\n \"value\": \"\"\n },\n \"discountPercent\": {\n \"value\": \"\"\n },\n \"discountCode\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n },\n \"revenue\": {\n \"value\": \"\"\n },\n \"products\": {\n \"value\": \"\"\n },\n \"source\": {\n \"value\": \"\"\n },\n \"paymentInfo\": {\n \"value\": \"\"\n }\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"2018-06-07T07:29:27.489+00:00\",\n \"status\": 403,\n \"error\": \"Forbidden\",\n \"message\": \"Forbidden\",\n \"path\": \"/path_of_the_endpoint\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"af22f5a9-1470-4291-b9ff-deb5f544299f","name":"Unsupported Media Type","originalRequest":{"url":{"path":["v4","events","cancelled-transaction"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"label\": {\n \"value\": \"\"\n },\n \"client\": {\n \"value\": \"\"\n },\n \"time\": {\n \"value\": \"\"\n },\n \"eventSalt\": {\n \"value\": \"\"\n },\n \"params\": {\n \"orderId\": {\n \"value\": \"\"\n },\n \"orderStatus\": {\n \"value\": \"\"\n },\n \"discountAmount\": {\n \"value\": \"\"\n },\n \"discountPercent\": {\n \"value\": \"\"\n },\n \"discountCode\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n },\n \"revenue\": {\n \"value\": \"\"\n },\n \"products\": {\n \"value\": \"\"\n },\n \"source\": {\n \"value\": \"\"\n },\n \"paymentInfo\": {\n \"value\": \"\"\n }\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Unsupported Media Type","code":415,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"2018-06-07T07:27:23.136+00:00\",\n \"status\": 415,\n \"error\": \"Unsupported Media Type\",\n \"message\": \"Content type 'application/xml' not supported\",\n \"path\": \"/path_of_the_endpoint\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"e63f8363-ecbd-43ec-85a4-7662cee9f97d","name":"Timer hit","request":{"name":"Timer hit","description":{"content":"Send a 'timer' event.\n\n\nTimers are used for analytics. For example, if you send a event when a profiles starts doing something and another one when they finish, you can collect data about average activity time.

If you don't have a value for a field, omit that field. Do not send null values.\n\n\nWhen you send an event to this endpoint, the `action` field is set to `client.hitTimer` by the backend.\n\n---\n\n**API consumers:** Workspace (Business Profile), Profile (Client), Anonymous Profile\n\n**API key permission required:** `API_HIT_TIMER_EVENTS_CREATE`\n","type":"text/plain"},"url":{"path":["v4","events","hit-timer"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"label\": {\n \"value\": \"\"\n },\n \"client\": {\n \"value\": \"\"\n },\n \"time\": {\n \"value\": \"\"\n },\n \"eventSalt\": {\n \"value\": \"\"\n },\n \"params\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"d30680ad-8dfe-4d55-8280-0a719478f3b3","name":"Accepted","originalRequest":{"url":{"path":["v4","events","hit-timer"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"label\": {\n \"value\": \"\"\n },\n \"client\": {\n \"value\": \"\"\n },\n \"time\": {\n \"value\": \"\"\n },\n \"eventSalt\": {\n \"value\": \"\"\n },\n \"params\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Accepted","code":202,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"68fd3eb2-41f7-4b40-8780-4406a162b276","name":"Bad request: input data missing or malformed","originalRequest":{"url":{"path":["v4","events","hit-timer"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"label\": {\n \"value\": \"\"\n },\n \"client\": {\n \"value\": \"\"\n },\n \"time\": {\n \"value\": \"\"\n },\n \"eventSalt\": {\n \"value\": \"\"\n },\n \"params\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"2018-06-07T07:28:26.078+00:00\",\n \"status\": 400,\n \"error\": \"Bad Request\",\n \"message\": \"Version header content is invalid\",\n \"path\": \"/path_of_the_endpoint\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"3360150a-1539-42d1-8b32-837ab11e3f85","name":"Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc.","originalRequest":{"url":{"path":["v4","events","hit-timer"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"label\": {\n \"value\": \"\"\n },\n \"client\": {\n \"value\": \"\"\n },\n \"time\": {\n \"value\": \"\"\n },\n \"eventSalt\": {\n \"value\": \"\"\n },\n \"params\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"Bad Request\",\n \"status\": 400,\n \"timestamp\": \"2020-10-29T13:08:16.235Z\",\n \"path\": \"/exampleEndpoint\",\n \"message\": \"Some fields did not pass validation\",\n \"errors\": [\n {\n \"code\": 120,\n \"field\": \"exampleField\",\n \"message\": \"120\",\n \"rejectedValue\": \"exampleValue\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"92c17757-b3df-4241-94e4-ba3e397f44ef","name":"Forbidden; insufficient permissions (when PII protection is enabled, PII permissions are required in addition to the permissions listed in the method description)","originalRequest":{"url":{"path":["v4","events","hit-timer"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"label\": {\n \"value\": \"\"\n },\n \"client\": {\n \"value\": \"\"\n },\n \"time\": {\n \"value\": \"\"\n },\n \"eventSalt\": {\n \"value\": \"\"\n },\n \"params\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"2018-06-07T07:29:27.489+00:00\",\n \"status\": 403,\n \"error\": \"Forbidden\",\n \"message\": \"Forbidden\",\n \"path\": \"/path_of_the_endpoint\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"d0726df7-3486-4d06-b00d-716683b02b6b","name":"Unsupported Media Type","originalRequest":{"url":{"path":["v4","events","hit-timer"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"label\": {\n \"value\": \"\"\n },\n \"client\": {\n \"value\": \"\"\n },\n \"time\": {\n \"value\": \"\"\n },\n \"eventSalt\": {\n \"value\": \"\"\n },\n \"params\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Unsupported Media Type","code":415,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"2018-06-07T07:27:23.136+00:00\",\n \"status\": 415,\n \"error\": \"Unsupported Media Type\",\n \"message\": \"Content type 'application/xml' not supported\",\n \"path\": \"/path_of_the_endpoint\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"7111684c-7187-4bd8-9bf2-dd29ca8edf84","name":"Search requested","request":{"name":"Search requested","description":{"content":"Send a 'search requested' event.

If you don't have a value for a field, omit that field. Do not send null values.\n\n\nWhen you send an event to this endpoint, the `action` field is set to `client.search` by the backend.\n\n---\n\n**API consumers:** Workspace (Business Profile), Profile (Client), Anonymous Profile\n\n**API key permission required:** `API_SEARCHED_EVENTS_CREATE`\n","type":"text/plain"},"url":{"path":["v4","events","searched"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"label\": {\n \"value\": \"\"\n },\n \"client\": {\n \"value\": \"\"\n },\n \"time\": {\n \"value\": \"\"\n },\n \"eventSalt\": {\n \"value\": \"\"\n },\n \"params\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"51732dd2-5f7a-4ef6-85b0-4959809b613f","name":"Accepted","originalRequest":{"url":{"path":["v4","events","searched"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"label\": {\n \"value\": \"\"\n },\n \"client\": {\n \"value\": \"\"\n },\n \"time\": {\n \"value\": \"\"\n },\n \"eventSalt\": {\n \"value\": \"\"\n },\n \"params\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Accepted","code":202,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"0cd4822f-c626-4df6-8b3d-1bbd0cf09960","name":"Bad request: input data missing or malformed","originalRequest":{"url":{"path":["v4","events","searched"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"label\": {\n \"value\": \"\"\n },\n \"client\": {\n \"value\": \"\"\n },\n \"time\": {\n \"value\": \"\"\n },\n \"eventSalt\": {\n \"value\": \"\"\n },\n \"params\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"2018-06-07T07:28:26.078+00:00\",\n \"status\": 400,\n \"error\": \"Bad Request\",\n \"message\": \"Version header content is invalid\",\n \"path\": \"/path_of_the_endpoint\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"45c562fd-4d35-442c-9ee1-a0ea9e0167b5","name":"Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc.","originalRequest":{"url":{"path":["v4","events","searched"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"label\": {\n \"value\": \"\"\n },\n \"client\": {\n \"value\": \"\"\n },\n \"time\": {\n \"value\": \"\"\n },\n \"eventSalt\": {\n \"value\": \"\"\n },\n \"params\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"Bad Request\",\n \"status\": 400,\n \"timestamp\": \"2020-10-29T13:08:16.235Z\",\n \"path\": \"/exampleEndpoint\",\n \"message\": \"Some fields did not pass validation\",\n \"errors\": [\n {\n \"code\": 120,\n \"field\": \"exampleField\",\n \"message\": \"120\",\n \"rejectedValue\": \"exampleValue\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"ff913004-b83e-4311-a20f-623a9fa99bff","name":"Forbidden; insufficient permissions (when PII protection is enabled, PII permissions are required in addition to the permissions listed in the method description)","originalRequest":{"url":{"path":["v4","events","searched"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"label\": {\n \"value\": \"\"\n },\n \"client\": {\n \"value\": \"\"\n },\n \"time\": {\n \"value\": \"\"\n },\n \"eventSalt\": {\n \"value\": \"\"\n },\n \"params\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"2018-06-07T07:29:27.489+00:00\",\n \"status\": 403,\n \"error\": \"Forbidden\",\n \"message\": \"Forbidden\",\n \"path\": \"/path_of_the_endpoint\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"10f55cb8-d96f-407f-a3b6-a2c63144a851","name":"Unsupported Media Type","originalRequest":{"url":{"path":["v4","events","searched"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"label\": {\n \"value\": \"\"\n },\n \"client\": {\n \"value\": \"\"\n },\n \"time\": {\n \"value\": \"\"\n },\n \"eventSalt\": {\n \"value\": \"\"\n },\n \"params\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Unsupported Media Type","code":415,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"2018-06-07T07:27:23.136+00:00\",\n \"status\": 415,\n \"error\": \"Unsupported Media Type\",\n \"message\": \"Content type 'application/xml' not supported\",\n \"path\": \"/path_of_the_endpoint\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"74497f7e-dc7f-4f30-950c-2336759e53f5","name":"Content shared","request":{"name":"Content shared","description":{"content":"Send a 'content shared' event.

If you don't have a value for a field, omit that field. Do not send null values.\n\n\nWhen you send an event to this endpoint, the `action` field is set to `client.shared` by the backend.\n\n---\n\n**API consumers:** Workspace (Business Profile), Profile (Client), Anonymous Profile\n\n**API key permission required:** `API_SHARED_EVENTS_CREATE`\n","type":"text/plain"},"url":{"path":["v4","events","shared"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"label\": {\n \"value\": \"\"\n },\n \"client\": {\n \"value\": \"\"\n },\n \"time\": {\n \"value\": \"\"\n },\n \"eventSalt\": {\n \"value\": \"\"\n },\n \"params\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"f9515885-6e6b-472d-9bf2-7d6971a88153","name":"Accepted","originalRequest":{"url":{"path":["v4","events","shared"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"label\": {\n \"value\": \"\"\n },\n \"client\": {\n \"value\": \"\"\n },\n \"time\": {\n \"value\": \"\"\n },\n \"eventSalt\": {\n \"value\": \"\"\n },\n \"params\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Accepted","code":202,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"3b8cfbcc-4fa5-427c-a9f0-f9ffaa32f9a2","name":"Bad request: input data missing or malformed","originalRequest":{"url":{"path":["v4","events","shared"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"label\": {\n \"value\": \"\"\n },\n \"client\": {\n \"value\": \"\"\n },\n \"time\": {\n \"value\": \"\"\n },\n \"eventSalt\": {\n \"value\": \"\"\n },\n \"params\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"2018-06-07T07:28:26.078+00:00\",\n \"status\": 400,\n \"error\": \"Bad Request\",\n \"message\": \"Version header content is invalid\",\n \"path\": \"/path_of_the_endpoint\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"1612a4e7-4cb7-415b-9592-345adb97f628","name":"Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc.","originalRequest":{"url":{"path":["v4","events","shared"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"label\": {\n \"value\": \"\"\n },\n \"client\": {\n \"value\": \"\"\n },\n \"time\": {\n \"value\": \"\"\n },\n \"eventSalt\": {\n \"value\": \"\"\n },\n \"params\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"Bad Request\",\n \"status\": 400,\n \"timestamp\": \"2020-10-29T13:08:16.235Z\",\n \"path\": \"/exampleEndpoint\",\n \"message\": \"Some fields did not pass validation\",\n \"errors\": [\n {\n \"code\": 120,\n \"field\": \"exampleField\",\n \"message\": \"120\",\n \"rejectedValue\": \"exampleValue\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"61c048cd-4668-4a62-9cbf-8ccf35253001","name":"Forbidden; insufficient permissions (when PII protection is enabled, PII permissions are required in addition to the permissions listed in the method description)","originalRequest":{"url":{"path":["v4","events","shared"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"label\": {\n \"value\": \"\"\n },\n \"client\": {\n \"value\": \"\"\n },\n \"time\": {\n \"value\": \"\"\n },\n \"eventSalt\": {\n \"value\": \"\"\n },\n \"params\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"2018-06-07T07:29:27.489+00:00\",\n \"status\": 403,\n \"error\": \"Forbidden\",\n \"message\": \"Forbidden\",\n \"path\": \"/path_of_the_endpoint\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"e5a32ff4-af24-4516-93aa-d497c84cc80d","name":"Unsupported Media Type","originalRequest":{"url":{"path":["v4","events","shared"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"label\": {\n \"value\": \"\"\n },\n \"client\": {\n \"value\": \"\"\n },\n \"time\": {\n \"value\": \"\"\n },\n \"eventSalt\": {\n \"value\": \"\"\n },\n \"params\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Unsupported Media Type","code":415,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"2018-06-07T07:27:23.136+00:00\",\n \"status\": 415,\n \"error\": \"Unsupported Media Type\",\n \"message\": \"Content type 'application/xml' not supported\",\n \"path\": \"/path_of_the_endpoint\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"fab8f09f-deb3-491b-b157-5e1cfb915b64","name":"Recommendation viewed","request":{"name":"Recommendation viewed","description":{"content":"This endpoint is deprecated. Use the [AI Events](https://developers.synerise.com/DataManagement/DataManagement.html#tag/AI-Events) endpoints instead.\n\nSend a 'recommendation was viewed' event.\n\n\nWhen you send an event to this endpoint, the `action` field is set to `recommendation.view` by the backend.\n\n---\n\n**API consumers:** Workspace (Business Profile), Profile (Client), Anonymous Profile, Web SDK Tracker, AI API key (legacy)\n\n**API key permission required:** `API_RECOMENDATION_SEEN_EVENTS_CREATE`\n","type":"text/plain"},"url":{"path":["v4","events","recommendation-seen"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"label\": {\n \"value\": \"\"\n },\n \"client\": {\n \"value\": \"\"\n },\n \"time\": {\n \"value\": \"\"\n },\n \"eventSalt\": {\n \"value\": \"\"\n },\n \"params\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"d89a7ba4-277b-4e50-8b24-57df81f2a10e","name":"Accepted","originalRequest":{"url":{"path":["v4","events","recommendation-seen"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"label\": {\n \"value\": \"\"\n },\n \"client\": {\n \"value\": \"\"\n },\n \"time\": {\n \"value\": \"\"\n },\n \"eventSalt\": {\n \"value\": \"\"\n },\n \"params\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Accepted","code":202,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"b4db64a5-773b-42d6-97ab-96752b128d4c","name":"Bad request: input data missing or malformed","originalRequest":{"url":{"path":["v4","events","recommendation-seen"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"label\": {\n \"value\": \"\"\n },\n \"client\": {\n \"value\": \"\"\n },\n \"time\": {\n \"value\": \"\"\n },\n \"eventSalt\": {\n \"value\": \"\"\n },\n \"params\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"2018-06-07T07:28:26.078+00:00\",\n \"status\": 400,\n \"error\": \"Bad Request\",\n \"message\": \"Version header content is invalid\",\n \"path\": \"/path_of_the_endpoint\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"d0448789-3cdd-4188-9834-7ecc634154a0","name":"Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc.","originalRequest":{"url":{"path":["v4","events","recommendation-seen"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"label\": {\n \"value\": \"\"\n },\n \"client\": {\n \"value\": \"\"\n },\n \"time\": {\n \"value\": \"\"\n },\n \"eventSalt\": {\n \"value\": \"\"\n },\n \"params\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"Bad Request\",\n \"status\": 400,\n \"timestamp\": \"2020-10-29T13:08:16.235Z\",\n \"path\": \"/exampleEndpoint\",\n \"message\": \"Some fields did not pass validation\",\n \"errors\": [\n {\n \"code\": 120,\n \"field\": \"exampleField\",\n \"message\": \"120\",\n \"rejectedValue\": \"exampleValue\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"c3769e7d-1cef-44e2-8ffb-a79d6ed30cac","name":"Forbidden; insufficient permissions (when PII protection is enabled, PII permissions are required in addition to the permissions listed in the method description)","originalRequest":{"url":{"path":["v4","events","recommendation-seen"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"label\": {\n \"value\": \"\"\n },\n \"client\": {\n \"value\": \"\"\n },\n \"time\": {\n \"value\": \"\"\n },\n \"eventSalt\": {\n \"value\": \"\"\n },\n \"params\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"2018-06-07T07:29:27.489+00:00\",\n \"status\": 403,\n \"error\": \"Forbidden\",\n \"message\": \"Forbidden\",\n \"path\": \"/path_of_the_endpoint\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"1357bba7-f149-47b8-b83b-e5159acf82e5","name":"Unsupported Media Type","originalRequest":{"url":{"path":["v4","events","recommendation-seen"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"label\": {\n \"value\": \"\"\n },\n \"client\": {\n \"value\": \"\"\n },\n \"time\": {\n \"value\": \"\"\n },\n \"eventSalt\": {\n \"value\": \"\"\n },\n \"params\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Unsupported Media Type","code":415,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"2018-06-07T07:27:23.136+00:00\",\n \"status\": 415,\n \"error\": \"Unsupported Media Type\",\n \"message\": \"Content type 'application/xml' not supported\",\n \"path\": \"/path_of_the_endpoint\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"1a0987d7-351e-469f-9f95-7255337d550e","name":"Recommendation clicked","request":{"name":"Recommendation clicked","description":{"content":"Send a 'recommendation clicked' event.\nThis endpoint is deprecated. Use the [AI Events](https://developers.synerise.com/DataManagement/DataManagement.html#tag/AI-Events) endpoints instead.\n\n\nWhen you send an event to this endpoint, the `action` field is set to `recommendation.click` by the backend.\n\n---\n\n**API consumers:** Workspace (Business Profile), Profile (Client), Anonymous Profile, Web SDK Tracker, AI API key (legacy)\n\n**API key permission required:** `API_RECOMMENDATION_CLICK_EVENTS_CREATE`\n","type":"text/plain"},"url":{"path":["v4","events","recommendation-click"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"label\": {\n \"value\": \"\"\n },\n \"client\": {\n \"value\": \"\"\n },\n \"time\": {\n \"value\": \"\"\n },\n \"eventSalt\": {\n \"value\": \"\"\n },\n \"params\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"c90f2028-c0ff-40d5-98b2-7d5b4444e52a","name":"Accepted","originalRequest":{"url":{"path":["v4","events","recommendation-click"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"label\": {\n \"value\": \"\"\n },\n \"client\": {\n \"value\": \"\"\n },\n \"time\": {\n \"value\": \"\"\n },\n \"eventSalt\": {\n \"value\": \"\"\n },\n \"params\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Accepted","code":202,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"b413b94b-0655-4014-84c5-49f01d3468a5","name":"Bad request: input data missing or malformed","originalRequest":{"url":{"path":["v4","events","recommendation-click"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"label\": {\n \"value\": \"\"\n },\n \"client\": {\n \"value\": \"\"\n },\n \"time\": {\n \"value\": \"\"\n },\n \"eventSalt\": {\n \"value\": \"\"\n },\n \"params\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"2018-06-07T07:28:26.078+00:00\",\n \"status\": 400,\n \"error\": \"Bad Request\",\n \"message\": \"Version header content is invalid\",\n \"path\": \"/path_of_the_endpoint\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"fc84572d-26e3-4d55-9745-1608ed6a144b","name":"Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc.","originalRequest":{"url":{"path":["v4","events","recommendation-click"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"label\": {\n \"value\": \"\"\n },\n \"client\": {\n \"value\": \"\"\n },\n \"time\": {\n \"value\": \"\"\n },\n \"eventSalt\": {\n \"value\": \"\"\n },\n \"params\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"Bad Request\",\n \"status\": 400,\n \"timestamp\": \"2020-10-29T13:08:16.235Z\",\n \"path\": \"/exampleEndpoint\",\n \"message\": \"Some fields did not pass validation\",\n \"errors\": [\n {\n \"code\": 120,\n \"field\": \"exampleField\",\n \"message\": \"120\",\n \"rejectedValue\": \"exampleValue\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"f35eceb4-66a9-4141-abda-1f44dc670625","name":"Forbidden; insufficient permissions (when PII protection is enabled, PII permissions are required in addition to the permissions listed in the method description)","originalRequest":{"url":{"path":["v4","events","recommendation-click"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"label\": {\n \"value\": \"\"\n },\n \"client\": {\n \"value\": \"\"\n },\n \"time\": {\n \"value\": \"\"\n },\n \"eventSalt\": {\n \"value\": \"\"\n },\n \"params\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"2018-06-07T07:29:27.489+00:00\",\n \"status\": 403,\n \"error\": \"Forbidden\",\n \"message\": \"Forbidden\",\n \"path\": \"/path_of_the_endpoint\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"150a3dad-da71-4109-a962-6fdc7043c2ef","name":"Unsupported Media Type","originalRequest":{"url":{"path":["v4","events","recommendation-click"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"label\": {\n \"value\": \"\"\n },\n \"client\": {\n \"value\": \"\"\n },\n \"time\": {\n \"value\": \"\"\n },\n \"eventSalt\": {\n \"value\": \"\"\n },\n \"params\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Unsupported Media Type","code":415,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"2018-06-07T07:27:23.136+00:00\",\n \"status\": 415,\n \"error\": \"Unsupported Media Type\",\n \"message\": \"Content type 'application/xml' not supported\",\n \"path\": \"/path_of_the_endpoint\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"4bdcbc3a-2a47-4741-aa6c-b9d4275f3b98","name":"Mobile app screen visited","request":{"name":"Mobile app screen visited","description":{"content":"Send a 'screen in a mobile app was visited' event. This can be used for mobile screen usage tracking.

If you don't have a value for a field, omit that field. Do not send null values.\n\nWhen you send an event to this endpoint, the `action` field is set to `screen.view` by the backend.\n\n---\n\n**API consumers:** Workspace (Business Profile), Profile (Client), Anonymous Profile\n\n**API key permission required:** `API_VISITED_SCREEN_EVENTS_CREATE`\n","type":"text/plain"},"url":{"path":["v4","events","visited-screen"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"label\": {\n \"value\": \"\"\n },\n \"client\": {\n \"value\": \"\"\n },\n \"time\": {\n \"value\": \"\"\n },\n \"eventSalt\": {\n \"value\": \"\"\n },\n \"params\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"04c9799f-2822-4a57-8801-29b999550431","name":"Accepted","originalRequest":{"url":{"path":["v4","events","visited-screen"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"label\": {\n \"value\": \"\"\n },\n \"client\": {\n \"value\": \"\"\n },\n \"time\": {\n \"value\": \"\"\n },\n \"eventSalt\": {\n \"value\": \"\"\n },\n \"params\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Accepted","code":202,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"e18ef52d-2d5b-4acf-aaba-f764cc856220","name":"Bad request: input data missing or malformed","originalRequest":{"url":{"path":["v4","events","visited-screen"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"label\": {\n \"value\": \"\"\n },\n \"client\": {\n \"value\": \"\"\n },\n \"time\": {\n \"value\": \"\"\n },\n \"eventSalt\": {\n \"value\": \"\"\n },\n \"params\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"2018-06-07T07:28:26.078+00:00\",\n \"status\": 400,\n \"error\": \"Bad Request\",\n \"message\": \"Version header content is invalid\",\n \"path\": \"/path_of_the_endpoint\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"092e9ea6-3d6b-412b-931a-23d0652f74ea","name":"Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc.","originalRequest":{"url":{"path":["v4","events","visited-screen"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"label\": {\n \"value\": \"\"\n },\n \"client\": {\n \"value\": \"\"\n },\n \"time\": {\n \"value\": \"\"\n },\n \"eventSalt\": {\n \"value\": \"\"\n },\n \"params\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"Bad Request\",\n \"status\": 400,\n \"timestamp\": \"2020-10-29T13:08:16.235Z\",\n \"path\": \"/exampleEndpoint\",\n \"message\": \"Some fields did not pass validation\",\n \"errors\": [\n {\n \"code\": 120,\n \"field\": \"exampleField\",\n \"message\": \"120\",\n \"rejectedValue\": \"exampleValue\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"028bba3d-8e24-464b-9089-8643563aef6b","name":"Forbidden; insufficient permissions (when PII protection is enabled, PII permissions are required in addition to the permissions listed in the method description)","originalRequest":{"url":{"path":["v4","events","visited-screen"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"label\": {\n \"value\": \"\"\n },\n \"client\": {\n \"value\": \"\"\n },\n \"time\": {\n \"value\": \"\"\n },\n \"eventSalt\": {\n \"value\": \"\"\n },\n \"params\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"2018-06-07T07:29:27.489+00:00\",\n \"status\": 403,\n \"error\": \"Forbidden\",\n \"message\": \"Forbidden\",\n \"path\": \"/path_of_the_endpoint\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"a9bcefa0-d6bb-4932-98cf-d73e00e877f4","name":"Unsupported Media Type","originalRequest":{"url":{"path":["v4","events","visited-screen"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"label\": {\n \"value\": \"\"\n },\n \"client\": {\n \"value\": \"\"\n },\n \"time\": {\n \"value\": \"\"\n },\n \"eventSalt\": {\n \"value\": \"\"\n },\n \"params\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Unsupported Media Type","code":415,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"2018-06-07T07:27:23.136+00:00\",\n \"status\": 415,\n \"error\": \"Unsupported Media Type\",\n \"message\": \"Content type 'application/xml' not supported\",\n \"path\": \"/path_of_the_endpoint\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"76ffc424-a348-441d-a9ba-a09bce0e3544","name":"Custom event","request":{"name":"Custom event","description":{"content":"Send a custom event.\n\nWARNING: This endpoint doesn't create `product.buy` events from `transaction.charge` events! Use [Create a transaction](#operation/CreateATransaction) or [Batch add or update transactions](#operation/BatchAddOrUpdateTransactions) instead.\n\nIf you don't have a value for a field, omit that field. Do not send null values.\n\n\n---\n\n**API consumers:** Workspace (Business Profile), Profile (Client), Anonymous Profile, Synerise User\n\n**API key permission required:** `API_CUSTOM_EVENTS_CREATE`\n\n**User role permission required:** `client_activities: create`\n","type":"text/plain"},"url":{"path":["v4","events","custom"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"action\": {\n \"value\": \"\"\n },\n \"client\": {\n \"value\": \"\"\n },\n \"label\": {\n \"value\": \"\"\n },\n \"time\": {\n \"value\": \"\"\n },\n \"eventSalt\": {\n \"value\": \"\"\n },\n \"params\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"298dddc4-caa4-490a-be3a-ece8adbff2c4","name":"Accepted","originalRequest":{"url":{"path":["v4","events","custom"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"action\": {\n \"value\": \"\"\n },\n \"client\": {\n \"value\": \"\"\n },\n \"label\": {\n \"value\": \"\"\n },\n \"time\": {\n \"value\": \"\"\n },\n \"eventSalt\": {\n \"value\": \"\"\n },\n \"params\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Accepted","code":202,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"e734e0c0-e538-4f2b-937a-6b090b3ea2e7","name":"Bad request: input data missing or malformed","originalRequest":{"url":{"path":["v4","events","custom"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"action\": {\n \"value\": \"\"\n },\n \"client\": {\n \"value\": \"\"\n },\n \"label\": {\n \"value\": \"\"\n },\n \"time\": {\n \"value\": \"\"\n },\n \"eventSalt\": {\n \"value\": \"\"\n },\n \"params\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"2018-06-07T07:28:26.078+00:00\",\n \"status\": 400,\n \"error\": \"Bad Request\",\n \"message\": \"Version header content is invalid\",\n \"path\": \"/path_of_the_endpoint\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"07f885fb-1acb-425e-90ee-8693ce7266a3","name":"Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc.","originalRequest":{"url":{"path":["v4","events","custom"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"action\": {\n \"value\": \"\"\n },\n \"client\": {\n \"value\": \"\"\n },\n \"label\": {\n \"value\": \"\"\n },\n \"time\": {\n \"value\": \"\"\n },\n \"eventSalt\": {\n \"value\": \"\"\n },\n \"params\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"Bad Request\",\n \"status\": 400,\n \"timestamp\": \"2020-10-29T13:08:16.235Z\",\n \"path\": \"/exampleEndpoint\",\n \"message\": \"Some fields did not pass validation\",\n \"errors\": [\n {\n \"code\": 120,\n \"field\": \"exampleField\",\n \"message\": \"120\",\n \"rejectedValue\": \"exampleValue\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"696e25a9-82f1-4727-a6b0-c7654b0b1083","name":"Forbidden; insufficient permissions (when PII protection is enabled, PII permissions are required in addition to the permissions listed in the method description)","originalRequest":{"url":{"path":["v4","events","custom"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"action\": {\n \"value\": \"\"\n },\n \"client\": {\n \"value\": \"\"\n },\n \"label\": {\n \"value\": \"\"\n },\n \"time\": {\n \"value\": \"\"\n },\n \"eventSalt\": {\n \"value\": \"\"\n },\n \"params\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"2018-06-07T07:29:27.489+00:00\",\n \"status\": 403,\n \"error\": \"Forbidden\",\n \"message\": \"Forbidden\",\n \"path\": \"/path_of_the_endpoint\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"696c06d0-b7bd-4e77-989a-a4b76a1bdf99","name":"Unsupported Media Type","originalRequest":{"url":{"path":["v4","events","custom"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"action\": {\n \"value\": \"\"\n },\n \"client\": {\n \"value\": \"\"\n },\n \"label\": {\n \"value\": \"\"\n },\n \"time\": {\n \"value\": \"\"\n },\n \"eventSalt\": {\n \"value\": \"\"\n },\n \"params\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Unsupported Media Type","code":415,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"2018-06-07T07:27:23.136+00:00\",\n \"status\": 415,\n \"error\": \"Unsupported Media Type\",\n \"message\": \"Content type 'application/xml' not supported\",\n \"path\": \"/path_of_the_endpoint\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"4e648e0e-74d3-4fb1-8727-07c5d93ca829","name":"Batch send events","request":{"name":"Batch send events","description":{"content":"Send a batch of events as an array of objects. You can send up to a 1000 events and the size of the request can't be more than 1 MB.\n\nWARNING: This endpoint doesn't create `product.buy` events from `transaction.charge` events! Use [Create a transaction](#operation/CreateATransaction) or [Batch add or update transactions](#operation/BatchAddOrUpdateTransactions) instead.\n\nIf you don't have a value for a field, omit that field. Do not\nsend null values.\n\n\n---\n\n**API consumers:** Workspace (Business Profile), Profile (Client), Anonymous Profile\n\n**API key permission required:** `API_BATCH_EVENTS_CREATE`\n","type":"text/plain"},"url":{"path":["v4","events","batch"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"[\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n]","options":{"raw":{"language":"json"}}}},"response":[{"id":"e901d1dd-ee4b-4cf8-8f2d-eda5858140ba","name":"Accepted","originalRequest":{"url":{"path":["v4","events","batch"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"}],"method":"POST","body":{"mode":"raw","raw":"[\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n]","options":{"raw":{"language":"json"}}}},"status":"Accepted","code":202,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"4cd629be-b0d1-4953-b700-dc41f5cebd96","name":"Bad request: input data missing or malformed","originalRequest":{"url":{"path":["v4","events","batch"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"[\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n]","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"2018-06-07T07:28:26.078+00:00\",\n \"status\": 400,\n \"error\": \"Bad Request\",\n \"message\": \"Version header content is invalid\",\n \"path\": \"/path_of_the_endpoint\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"634678b1-fae7-4547-88c1-657ae95d8769","name":"Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc.","originalRequest":{"url":{"path":["v4","events","batch"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"[\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n]","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"Bad Request\",\n \"status\": 400,\n \"timestamp\": \"2020-10-29T13:08:16.235Z\",\n \"path\": \"/exampleEndpoint\",\n \"message\": \"Some fields did not pass validation\",\n \"errors\": [\n {\n \"code\": 120,\n \"field\": \"exampleField\",\n \"message\": \"120\",\n \"rejectedValue\": \"exampleValue\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"d66f99d1-b834-4f70-949b-3ff0394ab588","name":"Forbidden; insufficient permissions (when PII protection is enabled, PII permissions are required in addition to the permissions listed in the method description)","originalRequest":{"url":{"path":["v4","events","batch"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"[\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n]","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"2018-06-07T07:29:27.489+00:00\",\n \"status\": 403,\n \"error\": \"Forbidden\",\n \"message\": \"Forbidden\",\n \"path\": \"/path_of_the_endpoint\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"48828d27-9154-41f2-9195-8e99ccdc3ab9","name":"Unsupported Media Type","originalRequest":{"url":{"path":["v4","events","batch"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"[\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n]","options":{"raw":{"language":"json"}}}},"status":"Unsupported Media Type","code":415,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"2018-06-07T07:27:23.136+00:00\",\n \"status\": 415,\n \"error\": \"Unsupported Media Type\",\n \"message\": \"Content type 'application/xml' not supported\",\n \"path\": \"/path_of_the_endpoint\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"0a972ccf-4b52-4881-a240-45a91291d918","name":"Get server time","request":{"name":"Get server time","description":{"content":"Get current server time, needed to send events with a correct timestamp.\n\n---\n\n**API consumers:** Workspace (Business Profile), Profile (Client), Anonymous Profile\n\n**Authentication:** Not required\n","type":"text/plain"},"url":{"path":["v4","server","time"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"59871f40-c4d0-4fde-8a42-3dab0042bef8","name":"OK","originalRequest":{"url":{"path":["v4","server","time"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"serverTime\": \"1967-02-12T04:28:51.341Z\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"64e1440b-720b-4d36-a6a9-8f08990fa113","name":"Bad Request","originalRequest":{"url":{"path":["v4","server","time"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\",\n \"status\": 2802,\n \"timestamp\": \"string\",\n \"path\": \"string\",\n \"message\": \"string\",\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"9f909b2e-fda7-41e6-acab-f2ef79cc05fc","name":"Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc.","originalRequest":{"url":{"path":["v4","server","time"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"Bad Request\",\n \"status\": 400,\n \"timestamp\": \"2020-10-29T13:08:16.235Z\",\n \"path\": \"/exampleEndpoint\",\n \"message\": \"Some fields did not pass validation\",\n \"errors\": [\n {\n \"code\": 120,\n \"field\": \"exampleField\",\n \"message\": \"120\",\n \"rejectedValue\": \"exampleValue\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"9b4bba87-5adf-41b0-bf5b-ccbbbc0aa244","name":"Forbidden; insufficient permissions (when PII protection is enabled, PII permissions are required in addition to the permissions listed in the method description)","originalRequest":{"url":{"path":["v4","server","time"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"2018-06-07T07:29:27.489+00:00\",\n \"status\": 403,\n \"error\": \"Forbidden\",\n \"message\": \"Forbidden\",\n \"path\": \"/path_of_the_endpoint\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"98582925-4435-4b29-b925-13c24c310b51","name":"Recommendation viewed","request":{"name":"Recommendation viewed","description":{"content":"A recommendation was displayed to a customer.\n\n---\n\n**API consumers:** Workspace (Business Profile), Profile (Client), Anonymous Profile, Web SDK Tracker, AI API key (legacy)\n\n**API key permission required:** `API_RECOMMENDATION_VIEW_EVENT_CREATE`\n","type":"text/plain"},"url":{"path":["v4","events","recommendation-view"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"client\": {\n \"value\": \"\"\n },\n \"label\": {\n \"value\": \"\"\n },\n \"params\": {\n \"items\": {\n \"value\": \"\"\n },\n \"correlationId\": {\n \"value\": \"\"\n },\n \"campaignId\": {\n \"value\": \"\"\n }\n },\n \"time\": {\n \"value\": \"\"\n },\n \"eventSalt\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"11ac3b9a-fa2f-4333-b7aa-3a80a3030c11","name":"OK","originalRequest":{"url":{"path":["v4","events","recommendation-view"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"client\": {\n \"value\": \"\"\n },\n \"label\": {\n \"value\": \"\"\n },\n \"params\": {\n \"items\": {\n \"value\": \"\"\n },\n \"correlationId\": {\n \"value\": \"\"\n },\n \"campaignId\": {\n \"value\": \"\"\n }\n },\n \"time\": {\n \"value\": \"\"\n },\n \"eventSalt\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"431a6957-5a54-4b15-9c80-cf08b48a1c96","name":"Bad request: input data missing or malformed","originalRequest":{"url":{"path":["v4","events","recommendation-view"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"client\": {\n \"value\": \"\"\n },\n \"label\": {\n \"value\": \"\"\n },\n \"params\": {\n \"items\": {\n \"value\": \"\"\n },\n \"correlationId\": {\n \"value\": \"\"\n },\n \"campaignId\": {\n \"value\": \"\"\n }\n },\n \"time\": {\n \"value\": \"\"\n },\n \"eventSalt\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"2018-06-07T07:28:26.078+00:00\",\n \"status\": 400,\n \"error\": \"Bad Request\",\n \"message\": \"Version header content is invalid\",\n \"path\": \"/path_of_the_endpoint\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"c99bf2d2-c60d-459f-bff3-4103e6ce630d","name":"Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc.","originalRequest":{"url":{"path":["v4","events","recommendation-view"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"client\": {\n \"value\": \"\"\n },\n \"label\": {\n \"value\": \"\"\n },\n \"params\": {\n \"items\": {\n \"value\": \"\"\n },\n \"correlationId\": {\n \"value\": \"\"\n },\n \"campaignId\": {\n \"value\": \"\"\n }\n },\n \"time\": {\n \"value\": \"\"\n },\n \"eventSalt\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"Bad Request\",\n \"status\": 400,\n \"timestamp\": \"2020-10-29T13:08:16.235Z\",\n \"path\": \"/exampleEndpoint\",\n \"message\": \"Some fields did not pass validation\",\n \"errors\": [\n {\n \"code\": 120,\n \"field\": \"exampleField\",\n \"message\": \"120\",\n \"rejectedValue\": \"exampleValue\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"7455e22d-071d-4d98-9893-8ba757e6a4ff","name":"Forbidden; insufficient permissions (when PII protection is enabled, PII permissions are required in addition to the permissions listed in the method description)","originalRequest":{"url":{"path":["v4","events","recommendation-view"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"client\": {\n \"value\": \"\"\n },\n \"label\": {\n \"value\": \"\"\n },\n \"params\": {\n \"items\": {\n \"value\": \"\"\n },\n \"correlationId\": {\n \"value\": \"\"\n },\n \"campaignId\": {\n \"value\": \"\"\n }\n },\n \"time\": {\n \"value\": \"\"\n },\n \"eventSalt\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"2018-06-07T07:29:27.489+00:00\",\n \"status\": 403,\n \"error\": \"Forbidden\",\n \"message\": \"Forbidden\",\n \"path\": \"/path_of_the_endpoint\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"f1c08517-4e61-458b-93ed-d321b98bf62d","name":"Unsupported Media Type","originalRequest":{"url":{"path":["v4","events","recommendation-view"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"client\": {\n \"value\": \"\"\n },\n \"label\": {\n \"value\": \"\"\n },\n \"params\": {\n \"items\": {\n \"value\": \"\"\n },\n \"correlationId\": {\n \"value\": \"\"\n },\n \"campaignId\": {\n \"value\": \"\"\n }\n },\n \"time\": {\n \"value\": \"\"\n },\n \"eventSalt\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Unsupported Media Type","code":415,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"2018-06-07T07:27:23.136+00:00\",\n \"status\": 415,\n \"error\": \"Unsupported Media Type\",\n \"message\": \"Content type 'application/xml' not supported\",\n \"path\": \"/path_of_the_endpoint\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"5f345a97-a784-405f-9e7b-d70966d86b1a","name":"Search result clicked","request":{"name":"Search result clicked","description":{"content":"An item in a search result was clicked or tapped.\n\n---\n\n**API consumers:** Workspace (Business Profile), Profile (Client), Anonymous Profile, Web SDK Tracker, AI API key (legacy)\n\n**API key permission required:** `API_ITEM_SEARCH_CLICK_EVENT_CREATE`\n","type":"text/plain"},"url":{"path":["v4","events","item-search-click"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"client\": {\n \"value\": \"\"\n },\n \"label\": {\n \"value\": \"\"\n },\n \"params\": {\n \"item\": {\n \"value\": \"\"\n },\n \"correlationId\": {\n \"value\": \"\"\n },\n \"position\": {\n \"value\": \"\"\n },\n \"searchType\": {\n \"value\": \"\"\n }\n },\n \"time\": {\n \"value\": \"\"\n },\n \"eventSalt\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"23e4a9da-c613-4998-ae71-b8288e91d49e","name":"OK","originalRequest":{"url":{"path":["v4","events","item-search-click"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"client\": {\n \"value\": \"\"\n },\n \"label\": {\n \"value\": \"\"\n },\n \"params\": {\n \"item\": {\n \"value\": \"\"\n },\n \"correlationId\": {\n \"value\": \"\"\n },\n \"position\": {\n \"value\": \"\"\n },\n \"searchType\": {\n \"value\": \"\"\n }\n },\n \"time\": {\n \"value\": \"\"\n },\n \"eventSalt\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"601c15be-3d32-4095-8dc3-7191b859acb5","name":"Bad request: input data missing or malformed","originalRequest":{"url":{"path":["v4","events","item-search-click"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"client\": {\n \"value\": \"\"\n },\n \"label\": {\n \"value\": \"\"\n },\n \"params\": {\n \"item\": {\n \"value\": \"\"\n },\n \"correlationId\": {\n \"value\": \"\"\n },\n \"position\": {\n \"value\": \"\"\n },\n \"searchType\": {\n \"value\": \"\"\n }\n },\n \"time\": {\n \"value\": \"\"\n },\n \"eventSalt\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"2018-06-07T07:28:26.078+00:00\",\n \"status\": 400,\n \"error\": \"Bad Request\",\n \"message\": \"Version header content is invalid\",\n \"path\": \"/path_of_the_endpoint\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"98707178-e4f1-44aa-a3ce-b637b8fba07b","name":"Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc.","originalRequest":{"url":{"path":["v4","events","item-search-click"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"client\": {\n \"value\": \"\"\n },\n \"label\": {\n \"value\": \"\"\n },\n \"params\": {\n \"item\": {\n \"value\": \"\"\n },\n \"correlationId\": {\n \"value\": \"\"\n },\n \"position\": {\n \"value\": \"\"\n },\n \"searchType\": {\n \"value\": \"\"\n }\n },\n \"time\": {\n \"value\": \"\"\n },\n \"eventSalt\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"Bad Request\",\n \"status\": 400,\n \"timestamp\": \"2020-10-29T13:08:16.235Z\",\n \"path\": \"/exampleEndpoint\",\n \"message\": \"Some fields did not pass validation\",\n \"errors\": [\n {\n \"code\": 120,\n \"field\": \"exampleField\",\n \"message\": \"120\",\n \"rejectedValue\": \"exampleValue\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"9a6f930d-35de-4583-9243-0b60973dccec","name":"Forbidden; insufficient permissions (when PII protection is enabled, PII permissions are required in addition to the permissions listed in the method description)","originalRequest":{"url":{"path":["v4","events","item-search-click"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"client\": {\n \"value\": \"\"\n },\n \"label\": {\n \"value\": \"\"\n },\n \"params\": {\n \"item\": {\n \"value\": \"\"\n },\n \"correlationId\": {\n \"value\": \"\"\n },\n \"position\": {\n \"value\": \"\"\n },\n \"searchType\": {\n \"value\": \"\"\n }\n },\n \"time\": {\n \"value\": \"\"\n },\n \"eventSalt\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"2018-06-07T07:29:27.489+00:00\",\n \"status\": 403,\n \"error\": \"Forbidden\",\n \"message\": \"Forbidden\",\n \"path\": \"/path_of_the_endpoint\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"1560cb42-2338-4080-a43a-54700d9db906","name":"Unsupported Media Type","originalRequest":{"url":{"path":["v4","events","item-search-click"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"client\": {\n \"value\": \"\"\n },\n \"label\": {\n \"value\": \"\"\n },\n \"params\": {\n \"item\": {\n \"value\": \"\"\n },\n \"correlationId\": {\n \"value\": \"\"\n },\n \"position\": {\n \"value\": \"\"\n },\n \"searchType\": {\n \"value\": \"\"\n }\n },\n \"time\": {\n \"value\": \"\"\n },\n \"eventSalt\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Unsupported Media Type","code":415,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"2018-06-07T07:27:23.136+00:00\",\n \"status\": 415,\n \"error\": \"Unsupported Media Type\",\n \"message\": \"Content type 'application/xml' not supported\",\n \"path\": \"/path_of_the_endpoint\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}],"event":[]},{"id":"53aba3f3-83c8-4a0b-b183-f0dd4de7a3a2","name":"AI Events","description":{"content":"","type":"text/plain"},"item":[{"id":"c1f83ef9-d07d-4b01-8e98-7810513c1fb6","name":"Batch upload AI events","request":{"name":"Batch upload AI events","description":{"content":"Upload a batch of events to the AI engine. A request can only include events of one type.\n\n---\n\n**API consumers:** Workspace (Business Profile), Profile (Client), Anonymous Profile, Web SDK Tracker, AI API key (legacy)\n\n**API key permission required:** `API_BATCH_EVENTS_CREATE`\n","type":"text/plain"},"url":{"path":["v4","events","ai-compat","batch"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"eventType\": \"recommendation.click\",\n \"items\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"706a636d-7a0a-48f7-b812-0cc391d7e0bb","name":"Accepted","originalRequest":{"url":{"path":["v4","events","ai-compat","batch"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"POST","body":{"mode":"raw","raw":"{\n \"eventType\": \"recommendation.view\",\n \"items\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"Accepted","code":202,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"09310cbc-5478-43eb-9e1e-0d838e23b926","name":"Bad request: input data missing or malformed","originalRequest":{"url":{"path":["v4","events","ai-compat","batch"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"eventType\": \"recommendation.view\",\n \"items\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"2018-06-07T07:28:26.078+00:00\",\n \"status\": 400,\n \"error\": \"Bad Request\",\n \"message\": \"Version header content is invalid\",\n \"path\": \"/path_of_the_endpoint\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"fcc73f8f-5bb1-4725-991a-606d626be2c5","name":"Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc.","originalRequest":{"url":{"path":["v4","events","ai-compat","batch"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"eventType\": \"recommendation.view\",\n \"items\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"Bad Request\",\n \"status\": 400,\n \"timestamp\": \"2020-10-29T13:08:16.235Z\",\n \"path\": \"/exampleEndpoint\",\n \"message\": \"Some fields did not pass validation\",\n \"errors\": [\n {\n \"code\": 120,\n \"field\": \"exampleField\",\n \"message\": \"120\",\n \"rejectedValue\": \"exampleValue\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"2834d13b-7c2d-47bc-96dd-18aaf9e00b69","name":"Forbidden; insufficient permissions (when PII protection is enabled, PII permissions are required in addition to the permissions listed in the method description)","originalRequest":{"url":{"path":["v4","events","ai-compat","batch"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"eventType\": \"recommendation.view\",\n \"items\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"2018-06-07T07:29:27.489+00:00\",\n \"status\": 403,\n \"error\": \"Forbidden\",\n \"message\": \"Forbidden\",\n \"path\": \"/path_of_the_endpoint\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"7fd6c65b-9ee7-4748-9923-b849f218caed","name":"Unsupported Media Type","originalRequest":{"url":{"path":["v4","events","ai-compat","batch"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"eventType\": \"recommendation.view\",\n \"items\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"Unsupported Media Type","code":415,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"2018-06-07T07:27:23.136+00:00\",\n \"status\": 415,\n \"error\": \"Unsupported Media Type\",\n \"message\": \"Content type 'application/xml' not supported\",\n \"path\": \"/path_of_the_endpoint\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"df31fd27-3796-45cf-95bb-cb1bfb97439b","name":"Item clicked in search","request":{"name":"Item clicked in search","description":{"content":"Upload an item.search.click event to the AI engine.\n\n---\n\n**API consumers:** Workspace (Business Profile), Profile (Client), Anonymous Profile, Web SDK Tracker, AI API key (legacy)\n\n**API key permission required:** `API_ITEM_SEARCH_CLICK_EVENT_CREATE`\n","type":"text/plain"},"url":{"path":["v4","events","ai-compat","item.search.click"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"correlationId\": \"string\",\n \"clientUUID\": \"07243772-008a-42e1-ba37-c3807cebde8f\",\n \"position\": 3240,\n \"searchType\": \"full-text-search\",\n \"item\": \"string\",\n \"EventTimestamp\": \"2019-02-07T09:53:56.999+00:00\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"1ce1543e-8d4e-4f39-a9b2-4292ce7d3b34","name":"No Content","originalRequest":{"url":{"path":["v4","events","ai-compat","item.search.click"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"POST","body":{"mode":"raw","raw":"{\n \"correlationId\": \"string\",\n \"clientUUID\": \"07243772-008a-42e1-ba37-c3807cebde8f\",\n \"position\": 3240,\n \"searchType\": \"full-text-search\",\n \"item\": \"string\",\n \"EventTimestamp\": \"2019-02-07T09:53:56.999+00:00\"\n}","options":{"raw":{"language":"json"}}}},"status":"No Content","code":204,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"98b562c5-16c2-4c08-9de8-a10c563e9e4c","name":"Bad request: input data missing or malformed","originalRequest":{"url":{"path":["v4","events","ai-compat","item.search.click"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"correlationId\": \"string\",\n \"clientUUID\": \"07243772-008a-42e1-ba37-c3807cebde8f\",\n \"position\": 3240,\n \"searchType\": \"full-text-search\",\n \"item\": \"string\",\n \"EventTimestamp\": \"2019-02-07T09:53:56.999+00:00\"\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"2018-06-07T07:28:26.078+00:00\",\n \"status\": 400,\n \"error\": \"Bad Request\",\n \"message\": \"Version header content is invalid\",\n \"path\": \"/path_of_the_endpoint\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"a5f88be3-b66b-411d-a452-f3c6fb2fde17","name":"Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc.","originalRequest":{"url":{"path":["v4","events","ai-compat","item.search.click"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"correlationId\": \"string\",\n \"clientUUID\": \"07243772-008a-42e1-ba37-c3807cebde8f\",\n \"position\": 3240,\n \"searchType\": \"full-text-search\",\n \"item\": \"string\",\n \"EventTimestamp\": \"2019-02-07T09:53:56.999+00:00\"\n}","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"Bad Request\",\n \"status\": 400,\n \"timestamp\": \"2020-10-29T13:08:16.235Z\",\n \"path\": \"/exampleEndpoint\",\n \"message\": \"Some fields did not pass validation\",\n \"errors\": [\n {\n \"code\": 120,\n \"field\": \"exampleField\",\n \"message\": \"120\",\n \"rejectedValue\": \"exampleValue\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"73d699a0-b0f9-489b-bc5d-c7c211213c1f","name":"Forbidden; insufficient permissions (when PII protection is enabled, PII permissions are required in addition to the permissions listed in the method description)","originalRequest":{"url":{"path":["v4","events","ai-compat","item.search.click"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"correlationId\": \"string\",\n \"clientUUID\": \"07243772-008a-42e1-ba37-c3807cebde8f\",\n \"position\": 3240,\n \"searchType\": \"full-text-search\",\n \"item\": \"string\",\n \"EventTimestamp\": \"2019-02-07T09:53:56.999+00:00\"\n}","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"2018-06-07T07:29:27.489+00:00\",\n \"status\": 403,\n \"error\": \"Forbidden\",\n \"message\": \"Forbidden\",\n \"path\": \"/path_of_the_endpoint\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"e2d5c19b-faab-43bf-8c4a-558ffb2d9d44","name":"Unsupported Media Type","originalRequest":{"url":{"path":["v4","events","ai-compat","item.search.click"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"correlationId\": \"string\",\n \"clientUUID\": \"07243772-008a-42e1-ba37-c3807cebde8f\",\n \"position\": 3240,\n \"searchType\": \"full-text-search\",\n \"item\": \"string\",\n \"EventTimestamp\": \"2019-02-07T09:53:56.999+00:00\"\n}","options":{"raw":{"language":"json"}}}},"status":"Unsupported Media Type","code":415,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"2018-06-07T07:27:23.136+00:00\",\n \"status\": 415,\n \"error\": \"Unsupported Media Type\",\n \"message\": \"Content type 'application/xml' not supported\",\n \"path\": \"/path_of_the_endpoint\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"cb22c487-b4a9-478a-9c08-ac577b0fbae0","name":"Suggestion clicked in search","request":{"name":"Suggestion clicked in search","description":{"content":"Upload a suggestion.search.click event to the AI engine.\n\n---\n\n**API consumers:** Workspace (Business Profile), Profile (Client), Anonymous Profile, Web SDK Tracker, AI API key (legacy)\n\n**API key permission required:** `API_SUGGESTION_SEARCH_CLICK_EVENT_CREATE`\n","type":"text/plain"},"url":{"path":["v4","events","ai-compat","suggestion.search.click"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"correlationId\": \"string\",\n \"clientUUID\": \"07243772-008a-42e1-ba37-c3807cebde8f\",\n \"position\": 5147,\n \"searchType\": \"listing\",\n \"suggestion\": \"string\",\n \"EventTimestamp\": \"2019-02-07T09:53:56.999+00:00\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"a9f6abaa-c430-4f61-8ccf-45a7faa2c1e1","name":"No Content","originalRequest":{"url":{"path":["v4","events","ai-compat","suggestion.search.click"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"POST","body":{"mode":"raw","raw":"{\n \"correlationId\": \"string\",\n \"clientUUID\": \"07243772-008a-42e1-ba37-c3807cebde8f\",\n \"position\": 5147,\n \"searchType\": \"listing\",\n \"suggestion\": \"string\",\n \"EventTimestamp\": \"2019-02-07T09:53:56.999+00:00\"\n}","options":{"raw":{"language":"json"}}}},"status":"No Content","code":204,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"dd110d51-1aad-4010-bf13-52254b9e9c21","name":"Bad request: input data missing or malformed","originalRequest":{"url":{"path":["v4","events","ai-compat","suggestion.search.click"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"correlationId\": \"string\",\n \"clientUUID\": \"07243772-008a-42e1-ba37-c3807cebde8f\",\n \"position\": 5147,\n \"searchType\": \"listing\",\n \"suggestion\": \"string\",\n \"EventTimestamp\": \"2019-02-07T09:53:56.999+00:00\"\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"2018-06-07T07:28:26.078+00:00\",\n \"status\": 400,\n \"error\": \"Bad Request\",\n \"message\": \"Version header content is invalid\",\n \"path\": \"/path_of_the_endpoint\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"a28f0c65-b053-43c6-8031-facb042d353d","name":"Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc.","originalRequest":{"url":{"path":["v4","events","ai-compat","suggestion.search.click"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"correlationId\": \"string\",\n \"clientUUID\": \"07243772-008a-42e1-ba37-c3807cebde8f\",\n \"position\": 5147,\n \"searchType\": \"listing\",\n \"suggestion\": \"string\",\n \"EventTimestamp\": \"2019-02-07T09:53:56.999+00:00\"\n}","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"Bad Request\",\n \"status\": 400,\n \"timestamp\": \"2020-10-29T13:08:16.235Z\",\n \"path\": \"/exampleEndpoint\",\n \"message\": \"Some fields did not pass validation\",\n \"errors\": [\n {\n \"code\": 120,\n \"field\": \"exampleField\",\n \"message\": \"120\",\n \"rejectedValue\": \"exampleValue\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"8c7a2842-7ca4-4274-8b34-a57b0395c7c2","name":"Forbidden; insufficient permissions (when PII protection is enabled, PII permissions are required in addition to the permissions listed in the method description)","originalRequest":{"url":{"path":["v4","events","ai-compat","suggestion.search.click"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"correlationId\": \"string\",\n \"clientUUID\": \"07243772-008a-42e1-ba37-c3807cebde8f\",\n \"position\": 5147,\n \"searchType\": \"listing\",\n \"suggestion\": \"string\",\n \"EventTimestamp\": \"2019-02-07T09:53:56.999+00:00\"\n}","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"2018-06-07T07:29:27.489+00:00\",\n \"status\": 403,\n \"error\": \"Forbidden\",\n \"message\": \"Forbidden\",\n \"path\": \"/path_of_the_endpoint\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"cfd7f233-c703-4224-825a-438d4f0346ef","name":"Unsupported Media Type","originalRequest":{"url":{"path":["v4","events","ai-compat","suggestion.search.click"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"correlationId\": \"string\",\n \"clientUUID\": \"07243772-008a-42e1-ba37-c3807cebde8f\",\n \"position\": 5147,\n \"searchType\": \"listing\",\n \"suggestion\": \"string\",\n \"EventTimestamp\": \"2019-02-07T09:53:56.999+00:00\"\n}","options":{"raw":{"language":"json"}}}},"status":"Unsupported Media Type","code":415,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"2018-06-07T07:27:23.136+00:00\",\n \"status\": 415,\n \"error\": \"Unsupported Media Type\",\n \"message\": \"Content type 'application/xml' not supported\",\n \"path\": \"/path_of_the_endpoint\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"bb1e1f99-3f9d-47c1-a20d-07d12b7de06f","name":"Product clicked in search","request":{"name":"Product clicked in search","description":{"content":"Upload a product.search.click event to the AI engine.\n\n---\n\n**API consumers:** Workspace (Business Profile), Profile (Client), Anonymous Profile, Web SDK Tracker, AI API key (legacy)\n\n**API key permission required:** `API_PRODUCT_SEARCH_CLICK_EVENT_CREATE`\n","type":"text/plain"},"url":{"path":["v4","events","ai-compat","product.search.click"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"correlationId\": \"string\",\n \"clientUUID\": \"07243772-008a-42e1-ba37-c3807cebde8f\",\n \"position\": 6368,\n \"searchType\": \"full-text-search\",\n \"productId\": \"string\",\n \"EventTimestamp\": \"2019-02-07T09:53:56.999+00:00\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"582e59a8-024b-4dd8-9fdb-f9e3bd40b134","name":"Accepted","originalRequest":{"url":{"path":["v4","events","ai-compat","product.search.click"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"POST","body":{"mode":"raw","raw":"{\n \"correlationId\": \"string\",\n \"clientUUID\": \"07243772-008a-42e1-ba37-c3807cebde8f\",\n \"position\": 6368,\n \"searchType\": \"full-text-search\",\n \"productId\": \"string\",\n \"EventTimestamp\": \"2019-02-07T09:53:56.999+00:00\"\n}","options":{"raw":{"language":"json"}}}},"status":"Accepted","code":202,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"4a2e653e-aac8-49f3-b05d-40fe28707882","name":"Bad request: input data missing or malformed","originalRequest":{"url":{"path":["v4","events","ai-compat","product.search.click"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"correlationId\": \"string\",\n \"clientUUID\": \"07243772-008a-42e1-ba37-c3807cebde8f\",\n \"position\": 6368,\n \"searchType\": \"full-text-search\",\n \"productId\": \"string\",\n \"EventTimestamp\": \"2019-02-07T09:53:56.999+00:00\"\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"2018-06-07T07:28:26.078+00:00\",\n \"status\": 400,\n \"error\": \"Bad Request\",\n \"message\": \"Version header content is invalid\",\n \"path\": \"/path_of_the_endpoint\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"7e4d76f5-dedd-456d-8c86-2539ad9d007c","name":"Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc.","originalRequest":{"url":{"path":["v4","events","ai-compat","product.search.click"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"correlationId\": \"string\",\n \"clientUUID\": \"07243772-008a-42e1-ba37-c3807cebde8f\",\n \"position\": 6368,\n \"searchType\": \"full-text-search\",\n \"productId\": \"string\",\n \"EventTimestamp\": \"2019-02-07T09:53:56.999+00:00\"\n}","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"Bad Request\",\n \"status\": 400,\n \"timestamp\": \"2020-10-29T13:08:16.235Z\",\n \"path\": \"/exampleEndpoint\",\n \"message\": \"Some fields did not pass validation\",\n \"errors\": [\n {\n \"code\": 120,\n \"field\": \"exampleField\",\n \"message\": \"120\",\n \"rejectedValue\": \"exampleValue\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"52d22cc8-3b1f-4f6f-9df7-19c2ded6f02c","name":"Forbidden; insufficient permissions (when PII protection is enabled, PII permissions are required in addition to the permissions listed in the method description)","originalRequest":{"url":{"path":["v4","events","ai-compat","product.search.click"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"correlationId\": \"string\",\n \"clientUUID\": \"07243772-008a-42e1-ba37-c3807cebde8f\",\n \"position\": 6368,\n \"searchType\": \"full-text-search\",\n \"productId\": \"string\",\n \"EventTimestamp\": \"2019-02-07T09:53:56.999+00:00\"\n}","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"2018-06-07T07:29:27.489+00:00\",\n \"status\": 403,\n \"error\": \"Forbidden\",\n \"message\": \"Forbidden\",\n \"path\": \"/path_of_the_endpoint\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"f81bfd61-d617-4fe2-a2ad-3853f45319d8","name":"Unsupported Media Type","originalRequest":{"url":{"path":["v4","events","ai-compat","product.search.click"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"correlationId\": \"string\",\n \"clientUUID\": \"07243772-008a-42e1-ba37-c3807cebde8f\",\n \"position\": 6368,\n \"searchType\": \"full-text-search\",\n \"productId\": \"string\",\n \"EventTimestamp\": \"2019-02-07T09:53:56.999+00:00\"\n}","options":{"raw":{"language":"json"}}}},"status":"Unsupported Media Type","code":415,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"2018-06-07T07:27:23.136+00:00\",\n \"status\": 415,\n \"error\": \"Unsupported Media Type\",\n \"message\": \"Content type 'application/xml' not supported\",\n \"path\": \"/path_of_the_endpoint\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"6f39e071-c7b0-44ab-acf8-ee608c6b53a1","name":"Item clicked in recommendation","request":{"name":"Item clicked in recommendation","description":{"content":"Upload a recommendation.click event to the AI engine.\n\n---\n\n**API consumers:** Workspace (Business Profile), Profile (Client), Anonymous Profile, Web SDK Tracker, AI API key (legacy)\n\n**API key permission required:** `API_RECOMMENDATION_CLICK_EVENT_CREATE`\n","type":"text/plain"},"url":{"path":["v4","events","ai-compat","recommendation.click"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"correlationId\": \"string\",\n \"clientUUID\": \"07243772-008a-42e1-ba37-c3807cebde8f\",\n \"item\": \"string\",\n \"campaignId\": \"string\",\n \"sessionId\": \"string\",\n \"EventTimestamp\": \"2019-02-07T09:53:56.999+00:00\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"467600c7-daae-4e27-9d3f-5bac0afe5b9e","name":"No Content","originalRequest":{"url":{"path":["v4","events","ai-compat","recommendation.click"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"POST","body":{"mode":"raw","raw":"{\n \"correlationId\": \"string\",\n \"clientUUID\": \"07243772-008a-42e1-ba37-c3807cebde8f\",\n \"item\": \"string\",\n \"campaignId\": \"string\",\n \"sessionId\": \"string\",\n \"EventTimestamp\": \"2019-02-07T09:53:56.999+00:00\"\n}","options":{"raw":{"language":"json"}}}},"status":"No Content","code":204,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"90eda460-3a45-49aa-8e95-a8e4427766dc","name":"Bad request: input data missing or malformed","originalRequest":{"url":{"path":["v4","events","ai-compat","recommendation.click"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"correlationId\": \"string\",\n \"clientUUID\": \"07243772-008a-42e1-ba37-c3807cebde8f\",\n \"item\": \"string\",\n \"campaignId\": \"string\",\n \"sessionId\": \"string\",\n \"EventTimestamp\": \"2019-02-07T09:53:56.999+00:00\"\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"2018-06-07T07:28:26.078+00:00\",\n \"status\": 400,\n \"error\": \"Bad Request\",\n \"message\": \"Version header content is invalid\",\n \"path\": \"/path_of_the_endpoint\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"8c98021c-ce90-43fa-a7a5-d7619435ae58","name":"Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc.","originalRequest":{"url":{"path":["v4","events","ai-compat","recommendation.click"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"correlationId\": \"string\",\n \"clientUUID\": \"07243772-008a-42e1-ba37-c3807cebde8f\",\n \"item\": \"string\",\n \"campaignId\": \"string\",\n \"sessionId\": \"string\",\n \"EventTimestamp\": \"2019-02-07T09:53:56.999+00:00\"\n}","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"Bad Request\",\n \"status\": 400,\n \"timestamp\": \"2020-10-29T13:08:16.235Z\",\n \"path\": \"/exampleEndpoint\",\n \"message\": \"Some fields did not pass validation\",\n \"errors\": [\n {\n \"code\": 120,\n \"field\": \"exampleField\",\n \"message\": \"120\",\n \"rejectedValue\": \"exampleValue\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"dc9e83ef-a1d5-405d-b40b-31409c31f124","name":"Forbidden; insufficient permissions (when PII protection is enabled, PII permissions are required in addition to the permissions listed in the method description)","originalRequest":{"url":{"path":["v4","events","ai-compat","recommendation.click"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"correlationId\": \"string\",\n \"clientUUID\": \"07243772-008a-42e1-ba37-c3807cebde8f\",\n \"item\": \"string\",\n \"campaignId\": \"string\",\n \"sessionId\": \"string\",\n \"EventTimestamp\": \"2019-02-07T09:53:56.999+00:00\"\n}","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"2018-06-07T07:29:27.489+00:00\",\n \"status\": 403,\n \"error\": \"Forbidden\",\n \"message\": \"Forbidden\",\n \"path\": \"/path_of_the_endpoint\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"670ccf7b-517b-4ed3-843c-5db55c88ab9f","name":"Unsupported Media Type","originalRequest":{"url":{"path":["v4","events","ai-compat","recommendation.click"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"correlationId\": \"string\",\n \"clientUUID\": \"07243772-008a-42e1-ba37-c3807cebde8f\",\n \"item\": \"string\",\n \"campaignId\": \"string\",\n \"sessionId\": \"string\",\n \"EventTimestamp\": \"2019-02-07T09:53:56.999+00:00\"\n}","options":{"raw":{"language":"json"}}}},"status":"Unsupported Media Type","code":415,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"2018-06-07T07:27:23.136+00:00\",\n \"status\": 415,\n \"error\": \"Unsupported Media Type\",\n \"message\": \"Content type 'application/xml' not supported\",\n \"path\": \"/path_of_the_endpoint\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"9afd1f0f-abf0-4c6e-b043-ab796feadbe0","name":"Recommendation viewed","request":{"name":"Recommendation viewed","description":{"content":"Upload a recommendation.view event to the AI engine.\n\n---\n\n**API consumers:** Workspace (Business Profile), Profile (Client), Anonymous Profile, Web SDK Tracker, AI API key (legacy)\n\n**API key permission required:** `API_RECOMMENDATION_VIEW_EVENT_CREATE`\n","type":"text/plain"},"url":{"path":["v4","events","ai-compat","recommendation.view"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"correlationId\": \"string\",\n \"clientUUID\": \"07243772-008a-42e1-ba37-c3807cebde8f\",\n \"items\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"EventTimestamp\": \"2019-02-07T09:53:56.999+00:00\",\n \"campaignId\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"6e77aa41-16ea-4101-ac66-ba8abb09ad2f","name":"No Content","originalRequest":{"url":{"path":["v4","events","ai-compat","recommendation.view"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"POST","body":{"mode":"raw","raw":"{\n \"correlationId\": \"string\",\n \"clientUUID\": \"07243772-008a-42e1-ba37-c3807cebde8f\",\n \"items\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"EventTimestamp\": \"2019-02-07T09:53:56.999+00:00\",\n \"campaignId\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"No Content","code":204,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"d4df84ed-9d5c-467d-a59b-a3e2ddc01182","name":"Bad request: input data missing or malformed","originalRequest":{"url":{"path":["v4","events","ai-compat","recommendation.view"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"correlationId\": \"string\",\n \"clientUUID\": \"07243772-008a-42e1-ba37-c3807cebde8f\",\n \"items\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"EventTimestamp\": \"2019-02-07T09:53:56.999+00:00\",\n \"campaignId\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"2018-06-07T07:28:26.078+00:00\",\n \"status\": 400,\n \"error\": \"Bad Request\",\n \"message\": \"Version header content is invalid\",\n \"path\": \"/path_of_the_endpoint\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"96038cfd-98f5-40ff-84eb-7595fdf94612","name":"Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc.","originalRequest":{"url":{"path":["v4","events","ai-compat","recommendation.view"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"correlationId\": \"string\",\n \"clientUUID\": \"07243772-008a-42e1-ba37-c3807cebde8f\",\n \"items\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"EventTimestamp\": \"2019-02-07T09:53:56.999+00:00\",\n \"campaignId\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"Bad Request\",\n \"status\": 400,\n \"timestamp\": \"2020-10-29T13:08:16.235Z\",\n \"path\": \"/exampleEndpoint\",\n \"message\": \"Some fields did not pass validation\",\n \"errors\": [\n {\n \"code\": 120,\n \"field\": \"exampleField\",\n \"message\": \"120\",\n \"rejectedValue\": \"exampleValue\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"cb0f2d82-276f-4949-b268-437dc0284f5b","name":"Forbidden; insufficient permissions (when PII protection is enabled, PII permissions are required in addition to the permissions listed in the method description)","originalRequest":{"url":{"path":["v4","events","ai-compat","recommendation.view"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"correlationId\": \"string\",\n \"clientUUID\": \"07243772-008a-42e1-ba37-c3807cebde8f\",\n \"items\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"EventTimestamp\": \"2019-02-07T09:53:56.999+00:00\",\n \"campaignId\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"2018-06-07T07:29:27.489+00:00\",\n \"status\": 403,\n \"error\": \"Forbidden\",\n \"message\": \"Forbidden\",\n \"path\": \"/path_of_the_endpoint\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"69ce9b85-f012-483c-868e-7300bd49264d","name":"Unsupported Media Type","originalRequest":{"url":{"path":["v4","events","ai-compat","recommendation.view"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"correlationId\": \"string\",\n \"clientUUID\": \"07243772-008a-42e1-ba37-c3807cebde8f\",\n \"items\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"EventTimestamp\": \"2019-02-07T09:53:56.999+00:00\",\n \"campaignId\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Unsupported Media Type","code":415,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"2018-06-07T07:27:23.136+00:00\",\n \"status\": 415,\n \"error\": \"Unsupported Media Type\",\n \"message\": \"Content type 'application/xml' not supported\",\n \"path\": \"/path_of_the_endpoint\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}],"event":[]},{"id":"e3939d38-2bd3-49f8-b9b5-dc9882b05386","name":"Activities","description":{"content":"","type":"text/plain"},"item":[{"id":"670667fa-715e-45e3-beed-72bfed6ced29","name":"Get profile activities","request":{"name":"Get profile activities","description":{"content":"Retrieve a list of activities from a single profile.\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `ACTIVITIES_API_ACTIVITIES_READ`\n\n**User role permission required:** `client_activities: read`\n","type":"text/plain"},"url":{"path":["activities-api","activities",":clientId"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"dateFrom","value":"2646.974270446586","description":"Lower value of the time range, as a Unix timestamp in milliseconds. Defaults to current time minus 2 hours."},{"disabled":false,"key":"dateTo","value":"2646.974270446586","description":"Upper limit of the time range to fetch, as a Unix timestamp in milliseconds. Defaults to current time."},{"disabled":false,"key":"actions","value":"page.visit","description":"A comma-separated list of actions (or a single action) that will be included in the response"},{"disabled":false,"key":"limit","value":"648.0022780395147","description":"The maximum number of events to retrieve"},{"disabled":false,"key":"raw","value":"false","description":"When `true`, the response returns raw data. If raw data is not available, processed data from event storage (like from `\"raw\": false`) is returned instead."},{"disabled":false,"key":"format","value":"json","description":"The format of the retrieved data"}],"variable":[{"disabled":false,"type":"any","value":"3005.370924836693","key":"clientId","description":"(Required) The ID of the profile"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"1e769d2d-bda3-4db5-b448-1e1234e1102e","name":"Activities","originalRequest":{"url":{"path":["activities-api","activities",":clientId"],"host":["{{baseUrl}}"],"query":[{"key":"dateFrom","value":"2646.974270446586"},{"key":"dateTo","value":"2646.974270446586"},{"key":"actions","value":"page.visit"},{"key":"limit","value":"648.0022780395147"},{"key":"raw","value":"false"},{"key":"format","value":"json"}],"variable":[{"disabled":false,"type":"any","value":"3005.370924836693","key":"clientId","description":"(Required) The ID of the profile"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"[\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n]","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"f4818a8d-5430-4566-9826-845809ce80b5","name":"Get a single activity","request":{"name":"Get a single activity","description":{"content":"Retrieve the details of a single activity.\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `ACTIVITIES_API_ACTIVITIES_READ`\n\n**User role permission required:** `client_activities: read`\n","type":"text/plain"},"url":{"path":["activities-api","activity","by",":identifierType"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"uuid","key":"identifierType","description":"(Required) Profile identifier type"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"identifierValue\": \"string\",\n \"additionalData\": {\n \"time\": {\n \"value\": \"\"\n },\n \"unique\": {\n \"value\": \"\"\n }\n }\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"3921db00-85a1-4007-affe-54fcccb68cba","name":"Activity","originalRequest":{"url":{"path":["activities-api","activity","by",":identifierType"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"uuid","key":"identifierType","description":"(Required) Profile identifier type"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"identifierValue\": \"string\",\n \"additionalData\": {\n \"time\": {\n \"value\": \"\"\n },\n \"unique\": {\n \"value\": \"\"\n }\n }\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"action\": {\n \"value\": \"\"\n },\n \"eventUUID\": {\n \"value\": \"\"\n },\n \"unique\": {\n \"value\": \"\"\n },\n \"createDate\": {\n \"value\": \"\"\n },\n \"label\": {\n \"value\": \"\"\n },\n \"params\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"3391d0a4-2bb6-409a-8196-268ada78c9d3","name":"Add description mapping","request":{"name":"Add description mapping","description":{"content":"For each event, you can add a custom, human-readable description that's displayed in the Synerise Web Application\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `ACTIVITIES_API_ACTIVITIES_UPDATE`\n\n**User role permission required:** `client_activities: update`\n","type":"text/plain"},"url":{"path":["activities-api","descriptions"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"action\": \"page.visit\",\n \"description\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"04cf9ff3-9171-48af-86a3-f8aaa8296aee","name":"Description mapping","originalRequest":{"url":{"path":["activities-api","descriptions"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"action\": \"page.visit\",\n \"description\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"id\": 9503.098478877215,\n \"businessProfileId\": 8864.547619308003,\n \"action\": \"page.visit\",\n \"description\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"aac9a9ed-7a53-41aa-8de2-937b953c6a68","name":"Get description mappings","request":{"name":"Get description mappings","description":{"content":"Retrieve a list of existing event-description mappings\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `ACTIVITIES_API_ACTIVITIES_READ`\n\n**User role permission required:** `client_activities: read`\n","type":"text/plain"},"url":{"path":["activities-api","descriptions"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"153c2635-1b47-462d-9e5d-6d93a6d934ed","name":"Description mappings","originalRequest":{"url":{"path":["activities-api","descriptions"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"[\n {\n \"id\": {\n \"value\": \"\"\n },\n \"businessProfileId\": {\n \"value\": \"\"\n },\n \"action\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n }\n },\n {\n \"id\": {\n \"value\": \"\"\n },\n \"businessProfileId\": {\n \"value\": \"\"\n },\n \"action\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n }\n }\n]","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"9d54e177-9975-4c60-bb47-37d194afbd9e","name":"Update description mapping","request":{"name":"Update description mapping","description":{"content":"Modify an existing description mapping\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `ACTIVITIES_API_ACTIVITIES_UPDATE`\n\n**User role permission required:** `client_activities: update`\n","type":"text/plain"},"url":{"path":["activities-api","descriptions",":descriptionId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"2646.974270446586","key":"descriptionId","description":"(Required) ID of the mapping"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"action\": \"page.visit\",\n \"description\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"f2b4a393-0095-435d-a0c6-66b3eda2e2ee","name":"Description mapping","originalRequest":{"url":{"path":["activities-api","descriptions",":descriptionId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"2646.974270446586","key":"descriptionId","description":"(Required) ID of the mapping"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"action\": \"page.visit\",\n \"description\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"id\": 9503.098478877215,\n \"businessProfileId\": 8864.547619308003,\n \"action\": \"page.visit\",\n \"description\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"4e1fd610-cead-4c6b-8db2-9163227bfd3e","name":"Add label mapping","request":{"name":"Add label mapping","description":{"content":"For each event, you can add a custom, human-readable label that's displayed in the Synerise Web Application\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `ACTIVITIES_API_ACTIVITIES_UPDATE`\n\n**User role permission required:** `client_activities: update`\n","type":"text/plain"},"url":{"path":["activities-api","labels"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"action\": \"page.visit\",\n \"label\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"072eb61e-e310-4129-a62f-3f25fc74a03c","name":"Label mapping","originalRequest":{"url":{"path":["activities-api","labels"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"action\": \"page.visit\",\n \"label\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"id\": 1862.7882559506415,\n \"businessProfileId\": 8965.823741030112,\n \"action\": \"page.visit\",\n \"label\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"df1b384a-d7cc-4948-8b51-7dba21e180ee","name":"Get label mappings","request":{"name":"Get label mappings","description":{"content":"Retrieve a list of existing event-label mappings\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `ACTIVITIES_API_ACTIVITIES_READ`\n\n**User role permission required:** `client_activities: read`\n","type":"text/plain"},"url":{"path":["activities-api","labels"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"bc1f755e-90cb-471a-8450-bc34a5bcf93e","name":"Label mappings","originalRequest":{"url":{"path":["activities-api","labels"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"[\n {\n \"id\": {\n \"value\": \"\"\n },\n \"businessProfileId\": {\n \"value\": \"\"\n },\n \"action\": {\n \"value\": \"\"\n },\n \"label\": {\n \"value\": \"\"\n }\n },\n {\n \"id\": {\n \"value\": \"\"\n },\n \"businessProfileId\": {\n \"value\": \"\"\n },\n \"action\": {\n \"value\": \"\"\n },\n \"label\": {\n \"value\": \"\"\n }\n }\n]","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"3eef20f4-b85b-42b0-aff2-8dfeec241a20","name":"Update label mapping","request":{"name":"Update label mapping","description":{"content":"Modify an existing label mapping\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `ACTIVITIES_API_ACTIVITIES_UPDATE`\n\n**User role permission required:** `client_activities: update`\n","type":"text/plain"},"url":{"path":["activities-api","labels",":labelId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"2646.974270446586","key":"labelId","description":"(Required) ID of the mapping"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"action\": \"page.visit\",\n \"label\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"0e84f057-afa5-4008-b3b5-2660c333dea4","name":"Label mapping","originalRequest":{"url":{"path":["activities-api","labels",":labelId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"2646.974270446586","key":"labelId","description":"(Required) ID of the mapping"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"action\": \"page.visit\",\n \"label\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"id\": 1862.7882559506415,\n \"businessProfileId\": 8965.823741030112,\n \"action\": \"page.visit\",\n \"label\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"31c72abd-fd69-4074-b39e-66cde6e7b296","name":"Add icon mapping","request":{"name":"Add icon mapping","description":{"content":"For each event, you can add a custom icon that's displayed in the Synerise Web Application\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `ACTIVITIES_API_ACTIVITIES_UPDATE`\n\n**User role permission required:** `client_activities: update`\n","type":"text/plain"},"url":{"path":["activities-api","icons"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"action\": \"page.visit\",\n \"icons\": {\n \"primary\": {\n \"value\": \"\"\n },\n \"secondary\": {\n \"value\": \"\"\n },\n \"color\": {\n \"value\": \"\"\n }\n }\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"5eeb839b-9d08-4b95-88d9-d73cd1f30de0","name":"Icon","originalRequest":{"url":{"path":["activities-api","icons"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"action\": \"page.visit\",\n \"icons\": {\n \"primary\": {\n \"value\": \"\"\n },\n \"secondary\": {\n \"value\": \"\"\n },\n \"color\": {\n \"value\": \"\"\n }\n }\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"id\": 4420.407073375099,\n \"businessProfileId\": 3405.4911276734956,\n \"action\": \"page.visit\",\n \"icons\": {\n \"primary\": {\n \"value\": \"\"\n },\n \"secondary\": {\n \"value\": \"\"\n },\n \"color\": {\n \"value\": \"\"\n }\n }\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"0ce3d893-2f51-4735-9dbe-99b130c73f56","name":"Get icon mappings","request":{"name":"Get icon mappings","description":{"content":"Retrieve a list of existing event-icon mappings\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `ACTIVITIES_API_ACTIVITIES_READ`\n\n**User role permission required:** `client_activities: read`\n","type":"text/plain"},"url":{"path":["activities-api","icons"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"16aeab0a-d9b6-4f8b-a2e0-f4e6b8e3f874","name":"Icon mappings","originalRequest":{"url":{"path":["activities-api","icons"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"[\n {\n \"id\": {\n \"value\": \"\"\n },\n \"businessProfileId\": {\n \"value\": \"\"\n },\n \"action\": {\n \"value\": \"\"\n },\n \"icons\": {\n \"value\": \"\"\n }\n },\n {\n \"id\": {\n \"value\": \"\"\n },\n \"businessProfileId\": {\n \"value\": \"\"\n },\n \"action\": {\n \"value\": \"\"\n },\n \"icons\": {\n \"value\": \"\"\n }\n }\n]","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"5ffd51a6-c792-4990-8227-a3df1976e6fd","name":"Update icon mapping","request":{"name":"Update icon mapping","description":{"content":"Modify an existing icon mapping\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `ACTIVITIES_API_ACTIVITIES_UPDATE`\n\n**User role permission required:** `client_activities: update`\n","type":"text/plain"},"url":{"path":["activities-api","icons",":iconID"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"2646.974270446586","key":"iconID","description":"(Required) ID of the icon"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"action\": \"page.visit\",\n \"icons\": {\n \"primary\": {\n \"value\": \"\"\n },\n \"secondary\": {\n \"value\": \"\"\n },\n \"color\": {\n \"value\": \"\"\n }\n }\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"3d659838-2d41-4d2c-b206-e0dd3788bee1","name":"Icon mapping","originalRequest":{"url":{"path":["activities-api","icons",":iconID"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"2646.974270446586","key":"iconID","description":"(Required) ID of the icon"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"action\": \"page.visit\",\n \"icons\": {\n \"primary\": {\n \"value\": \"\"\n },\n \"secondary\": {\n \"value\": \"\"\n },\n \"color\": {\n \"value\": \"\"\n }\n }\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"[\n {\n \"id\": {\n \"value\": \"\"\n },\n \"businessProfileId\": {\n \"value\": \"\"\n },\n \"action\": {\n \"value\": \"\"\n },\n \"icons\": {\n \"value\": \"\"\n }\n },\n {\n \"id\": {\n \"value\": \"\"\n },\n \"businessProfileId\": {\n \"value\": \"\"\n },\n \"action\": {\n \"value\": \"\"\n },\n \"icons\": {\n \"value\": \"\"\n }\n }\n]","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"810fe2d0-df52-4981-96b2-de2c4e0c0fd7","name":"Get profile's own events","request":{"name":"Get profile's own events","description":{"content":"As a profile, retrieve a list of your own events.\n\n\n---\n\n**API consumer:** Profile (Client)\n\n**User role permission required:** `client_activities: read`\n","type":"text/plain"},"url":{"path":["activities-api","events"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"actions","value":"page.visit","description":"A comma-separated list of actions (or a single action) that will be included in the response"},{"disabled":false,"key":"dateFrom","value":"2646.974270446586","description":"Lower value of the time range, as a Unix timestamp in milliseconds."},{"disabled":false,"key":"dateTo","value":"2646.974270446586","description":"Upper limit of the time range to fetch, as a Unix timestamp in milliseconds."},{"disabled":false,"key":"limit","value":"648.0022780395147","description":"The maximum number of events to retrieve"},{"disabled":false,"key":"raw","value":"false","description":"When `true`, the response returns raw data. If raw data is not available, processed data from event storage (like from `\"raw\": false`) is returned instead."},{"disabled":false,"key":"pageToken","value":"string","description":"The token of the page to retrieve. You can check the tokens of the next/previous page in the response to this endpoint. If not provided, the first page is retrieved."},{"disabled":false,"key":"sortBy","value":"time:desc","description":"Sorting order. `time:desc` (default) returns newest events first."}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"b71a18e4-aa60-4e9d-ba99-271f48b8bbc0","name":"Events","originalRequest":{"url":{"path":["activities-api","events"],"host":["{{baseUrl}}"],"query":[{"key":"actions","value":"page.visit"},{"key":"dateFrom","value":"2646.974270446586"},{"key":"dateTo","value":"2646.974270446586"},{"key":"limit","value":"648.0022780395147"},{"key":"raw","value":"false"},{"key":"pageToken","value":"string"},{"key":"sortBy","value":"time:desc"}],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"meta\": {\n \"links\": {\n \"value\": \"\"\n },\n \"cursors\": {\n \"value\": \"\"\n },\n \"limit\": {\n \"value\": \"\"\n },\n \"count\": {\n \"value\": \"\"\n }\n },\n \"data\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"084d94e0-9e1a-4078-ae76-a117b4247456","name":"Get profile events as a workspace/Synerise user","request":{"name":"Get profile events as a workspace/Synerise user","description":{"content":"Retrieve a list of events for the single profile.\n\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User\n\n**API key permission required:** `ACTIVITIES_API_ACTIVITIES_READ`\n\n**User role permission required:** `client_activities: read`\n","type":"text/plain"},"url":{"path":["activities-api","events","by",":identifierType"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"pageToken","value":"string","description":"The token of the page to retrieve. You can check the tokens of the next/previous page in the response to this endpoint. If not provided, the first page is retrieved."}],"variable":[{"disabled":false,"type":"any","value":"uuid","key":"identifierType","description":"(Required) Profile identifier type"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"identifierValue\": \"string\",\n \"additionalData\": {\n \"actions\": {\n \"value\": \"\"\n },\n \"dateFrom\": {\n \"value\": \"\"\n },\n \"dateTo\": {\n \"value\": \"\"\n },\n \"limit\": {\n \"value\": \"\"\n },\n \"raw\": {\n \"value\": \"\"\n },\n \"pageToken\": {\n \"value\": \"\"\n },\n \"sortBy\": {\n \"value\": \"\"\n }\n }\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"87eef7d3-6598-4292-bf2d-33ea1919c388","name":"Events","originalRequest":{"url":{"path":["activities-api","events","by",":identifierType"],"host":["{{baseUrl}}"],"query":[{"key":"pageToken","value":"string"}],"variable":[{"disabled":false,"type":"any","value":"uuid","key":"identifierType","description":"(Required) Profile identifier type"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"identifierValue\": \"string\",\n \"additionalData\": {\n \"actions\": {\n \"value\": \"\"\n },\n \"dateFrom\": {\n \"value\": \"\"\n },\n \"dateTo\": {\n \"value\": \"\"\n },\n \"limit\": {\n \"value\": \"\"\n },\n \"raw\": {\n \"value\": \"\"\n },\n \"pageToken\": {\n \"value\": \"\"\n },\n \"sortBy\": {\n \"value\": \"\"\n }\n }\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"meta\": {\n \"links\": {\n \"value\": \"\"\n },\n \"cursors\": {\n \"value\": \"\"\n },\n \"limit\": {\n \"value\": \"\"\n },\n \"count\": {\n \"value\": \"\"\n }\n },\n \"data\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}],"event":[]},{"id":"8e0ffcfe-ff14-4ae7-a718-d5a62990c982","name":"Catalogs","description":{"content":"","type":"text/plain"},"item":[{"id":"c65e1675-f66e-46a9-b35c-d7f3f6769648","name":"Get all items as CSV file","request":{"name":"Get all items as CSV file","description":{"content":"Download a CSV with all items in the catalog. The unique identifier of an item is saved in the `item_key` column.\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `CATALOGS_CATALOG_READ`\n\n**User role permission required:** `assets_catalogs: read`\n","type":"text/plain"},"url":{"path":["catalogs","bags",":catalogId","csv"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"delimiter","value":"string","description":"The delimiter to use in csv. You can use `;` or `,`. Default: `,`"}],"variable":[{"disabled":false,"type":"any","value":"5612","key":"catalogId","description":"(Required) ID of the catalog"}]},"header":[{"key":"Accept","value":"text/csv"}],"method":"GET","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"2451e1b6-df1f-42bb-86c5-ded0b3cc4b9c","name":"CSV file. The unique identifier of an item is in the `item_key` column.","originalRequest":{"url":{"path":["catalogs","bags",":catalogId","csv"],"host":["{{baseUrl}}"],"query":[{"key":"delimiter","value":"string"}],"variable":[{"disabled":false,"type":"any","value":"5612","key":"catalogId","description":"(Required) ID of the catalog"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"text/csv"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"text/csv"}],"body":"item_key,color,type\n3a9d38e8,blue,sneaker\ne96b17b7,red,sneaker\n","cookie":[],"_postman_previewlanguage":"text"},{"id":"db846461-fff4-4afc-aaa9-69b760cac595","name":"Unauthorized: token missing/expired/invalid; invalid API key; etc.","originalRequest":{"url":{"path":["catalogs","bags",":catalogId","csv"],"host":["{{baseUrl}}"],"query":[{"key":"delimiter","value":"string"}],"variable":[{"disabled":false,"type":"any","value":"5612","key":"catalogId","description":"(Required) ID of the catalog"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"status\": 1541,\n \"error\": \"string\",\n \"message\": \"string\",\n \"timestamp\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"57930eb8-84b9-4f12-ae0e-acc0d1ce00ff","name":"Forbidden: insufficient permissions; wrong consumer scope","originalRequest":{"url":{"path":["catalogs","bags",":catalogId","csv"],"host":["{{baseUrl}}"],"query":[{"key":"delimiter","value":"string"}],"variable":[{"disabled":false,"type":"any","value":"5612","key":"catalogId","description":"(Required) ID of the catalog"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"status\": 1541,\n \"error\": \"string\",\n \"message\": \"string\",\n \"timestamp\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"369ecf7c-f770-4f8f-98f4-4f5892ee0211","name":"Entity not found","originalRequest":{"url":{"path":["catalogs","bags",":catalogId","csv"],"host":["{{baseUrl}}"],"query":[{"key":"delimiter","value":"string"}],"variable":[{"disabled":false,"type":"any","value":"5612","key":"catalogId","description":"(Required) ID of the catalog"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"text/plain"}],"method":"GET","body":{}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"string","cookie":[],"_postman_previewlanguage":"text"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"7c521abc-c9e1-4374-8f36-e9a7a64c4fa7","name":"Add items from CSV","request":{"name":"Add items from CSV","description":{"content":"Upload items to a catalog from a CSV file\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `CATALOGS_CATALOG_UPDATE`\n\n**User role permission required:** `assets_catalogs: update`\n","type":"text/plain"},"url":{"path":["catalogs","bags",":catalogId","items","upload"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"5612","key":"catalogId","description":"(Required) ID of the catalog"}]},"header":[{"key":"Content-Type","value":"multipart/form-data"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"formdata","formdata":[{"key":"itemKey","value":"string","type":"text","description":"(Required) The name of the CSV column that contains unique identifiers. Slashes (`/`) are not allowed in the identifier values."},{"key":"file","type":"file","description":"(Required) CSV file"}]}},"response":[{"id":"650f44d2-eefd-485e-a72e-8b73ed6d11ed","name":"Upload status","originalRequest":{"url":{"path":["catalogs","bags",":catalogId","items","upload"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"5612","key":"catalogId","description":"(Required) ID of the catalog"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"formdata","formdata":[{"description":{"content":"(Required) The name of the CSV column that contains unique identifiers. Slashes (`/`) are not allowed in the identifier values.","type":"text/plain"},"key":"itemKey","value":"string","type":"text"},{"description":{"content":"(Required) CSV file","type":"text/plain"},"key":"file","type":"file"}]}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"false","cookie":[],"_postman_previewlanguage":"json"},{"id":"6910699a-09ad-404c-85e4-6e777a8d4dc7","name":"Invalid or insufficient data","originalRequest":{"url":{"path":["catalogs","bags",":catalogId","items","upload"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"5612","key":"catalogId","description":"(Required) ID of the catalog"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"text/plain"}],"method":"POST","body":{"mode":"formdata","formdata":[{"description":{"content":"(Required) The name of the CSV column that contains unique identifiers. Slashes (`/`) are not allowed in the identifier values.","type":"text/plain"},"key":"itemKey","value":"string","type":"text"},{"description":{"content":"(Required) CSV file","type":"text/plain"},"key":"file","type":"file"}]}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"string","cookie":[],"_postman_previewlanguage":"text"},{"id":"b9a5be95-44a7-4961-ac9f-b13f10b7314a","name":"Unauthorized: token missing/expired/invalid; invalid API key; etc.","originalRequest":{"url":{"path":["catalogs","bags",":catalogId","items","upload"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"5612","key":"catalogId","description":"(Required) ID of the catalog"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"formdata","formdata":[{"description":{"content":"(Required) The name of the CSV column that contains unique identifiers. Slashes (`/`) are not allowed in the identifier values.","type":"text/plain"},"key":"itemKey","value":"string","type":"text"},{"description":{"content":"(Required) CSV file","type":"text/plain"},"key":"file","type":"file"}]}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"status\": 1541,\n \"error\": \"string\",\n \"message\": \"string\",\n \"timestamp\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"ad79ceaa-6ca6-4dda-a458-65c5a20c9b88","name":"Forbidden: insufficient permissions; wrong consumer scope","originalRequest":{"url":{"path":["catalogs","bags",":catalogId","items","upload"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"5612","key":"catalogId","description":"(Required) ID of the catalog"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"formdata","formdata":[{"description":{"content":"(Required) The name of the CSV column that contains unique identifiers. Slashes (`/`) are not allowed in the identifier values.","type":"text/plain"},"key":"itemKey","value":"string","type":"text"},{"description":{"content":"(Required) CSV file","type":"text/plain"},"key":"file","type":"file"}]}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"status\": 1541,\n \"error\": \"string\",\n \"message\": \"string\",\n \"timestamp\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"b779a3fd-2df8-43cf-8842-556bb287b426","name":"Entity not found","originalRequest":{"url":{"path":["catalogs","bags",":catalogId","items","upload"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"5612","key":"catalogId","description":"(Required) ID of the catalog"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"text/plain"}],"method":"POST","body":{"mode":"formdata","formdata":[{"description":{"content":"(Required) The name of the CSV column that contains unique identifiers. Slashes (`/`) are not allowed in the identifier values.","type":"text/plain"},"key":"itemKey","value":"string","type":"text"},{"description":{"content":"(Required) CSV file","type":"text/plain"},"key":"file","type":"file"}]}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"string","cookie":[],"_postman_previewlanguage":"text"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"cb27bf60-8130-4256-b8c6-29d211e06db5","name":"Add catalog","request":{"name":"Add catalog","description":{"content":"Create a new, empty catalog.\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `CATALOGS_CATALOG_CREATE`\n\n**User role permission required:** `assets_catalogs: create`\n","type":"text/plain"},"url":{"path":["catalogs","bags"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"name\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"1956e854-0b51-47b5-b099-fdfe118f3495","name":"Details of the created catalog","originalRequest":{"url":{"path":["catalogs","bags"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"name\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"data\": {\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"businessProfileId\": {\n \"value\": \"\"\n },\n \"createdBy\": {\n \"value\": \"\"\n },\n \"creationDate\": {\n \"value\": \"\"\n },\n \"modifiedBy\": {\n \"value\": \"\"\n },\n \"lastModified\": {\n \"value\": \"\"\n },\n \"primaryKey\": {\n \"value\": \"\"\n },\n \"mappings\": {\n \"value\": \"\"\n },\n \"beforeFiltering\": {\n \"value\": \"\"\n },\n \"fields\": {\n \"value\": \"\"\n }\n },\n \"metaData\": {\n \"totalCount\": {\n \"value\": \"\"\n },\n \"requestTime\": {\n \"value\": \"\"\n }\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"95186405-610e-4e84-ba30-e1bed0c1be26","name":"Invalid or insufficient data","originalRequest":{"url":{"path":["catalogs","bags"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"text/plain"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"name\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"string","cookie":[],"_postman_previewlanguage":"text"},{"id":"e7fab522-3f2a-4fcd-b8d9-74558eb915d1","name":"Unauthorized: token missing/expired/invalid; invalid API key; etc.","originalRequest":{"url":{"path":["catalogs","bags"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"name\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"status\": 1541,\n \"error\": \"string\",\n \"message\": \"string\",\n \"timestamp\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"ff8a0a90-4cd3-444c-8773-c0fd0d38f28d","name":"Forbidden: insufficient permissions; wrong consumer scope","originalRequest":{"url":{"path":["catalogs","bags"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"name\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"status\": 1541,\n \"error\": \"string\",\n \"message\": \"string\",\n \"timestamp\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"92ce486c-01e1-46e7-932a-4ddbf8f922fe","name":"Get catalogs","request":{"name":"Get catalogs","description":{"content":"Retrieve all catalogs from the Workspace. You can filter and sort the results.\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `CATALOGS_CATALOG_READ`\n\n**User role permission required:** `assets_catalogs: read`\n","type":"text/plain"},"url":{"path":["catalogs","bags"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"searchBy","value":"string","description":"A search string. You can search the catalogs by their name or the first or last name of the author."},{"disabled":false,"key":"orderBy","value":"creationDate","description":"The parameter to order the results by. Order is always ascending."},{"disabled":false,"key":"offset","value":"5612","description":"The offset for the search. For example, if your `limit` is 10 and you want to retrieve the third page of items, set the offset to 20. Items with indexes 20 to 29 are returned (the first item on the first page has the index 0)."},{"disabled":false,"key":"limit","value":"5612","description":"The maximum number of items to include in the response. `offset` must be defined. Default: 100"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"ed43a3a3-755c-4d33-8320-c663c165595a","name":"List of catalogs","originalRequest":{"url":{"path":["catalogs","bags"],"host":["{{baseUrl}}"],"query":[{"key":"searchBy","value":"string"},{"key":"orderBy","value":"creationDate"},{"key":"offset","value":"5612"},{"key":"limit","value":"5612"}],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"data\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"metaData\": {\n \"totalCount\": {\n \"value\": \"\"\n },\n \"requestTime\": {\n \"value\": \"\"\n }\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"e0186490-73ac-4be6-80a3-4740b5cab208","name":"Unauthorized: token missing/expired/invalid; invalid API key; etc.","originalRequest":{"url":{"path":["catalogs","bags"],"host":["{{baseUrl}}"],"query":[{"key":"searchBy","value":"string"},{"key":"orderBy","value":"creationDate"},{"key":"offset","value":"5612"},{"key":"limit","value":"5612"}],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"status\": 1541,\n \"error\": \"string\",\n \"message\": \"string\",\n \"timestamp\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"8cec046a-f024-474f-9724-4f805e19edb4","name":"Forbidden: insufficient permissions; wrong consumer scope","originalRequest":{"url":{"path":["catalogs","bags"],"host":["{{baseUrl}}"],"query":[{"key":"searchBy","value":"string"},{"key":"orderBy","value":"creationDate"},{"key":"offset","value":"5612"},{"key":"limit","value":"5612"}],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"status\": 1541,\n \"error\": \"string\",\n \"message\": \"string\",\n \"timestamp\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"c4a7c95b-bce5-4e08-b805-b2d6014300d1","name":"Delete catalogs","request":{"name":"Delete catalogs","description":{"content":"\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `CATALOGS_CATALOG_DELETE`\n\n**User role permission required:** `assets_catalogs: delete`\n","type":"text/plain"},"url":{"path":["catalogs","bags"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"DELETE","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"[\n \"string\",\n \"string\"\n]","options":{"raw":{"language":"json"}}}},"response":[{"id":"6ae933d2-de56-41cc-b8cb-8db7f45c8719","name":"Deletion status","originalRequest":{"url":{"path":["catalogs","bags"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{"mode":"raw","raw":"[\n \"string\",\n \"string\"\n]","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"data\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"metaData\": {\n \"totalCount\": {\n \"value\": \"\"\n },\n \"requestTime\": {\n \"value\": \"\"\n }\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"92ecb3cf-1c8c-45dd-8238-ed9a4a7d780a","name":"Invalid or insufficient data","originalRequest":{"url":{"path":["catalogs","bags"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"text/plain"}],"method":"DELETE","body":{"mode":"raw","raw":"[\n \"string\",\n \"string\"\n]","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"string","cookie":[],"_postman_previewlanguage":"text"},{"id":"a5abb267-617b-42ba-8747-1bce59ada5d1","name":"Unauthorized: token missing/expired/invalid; invalid API key; etc.","originalRequest":{"url":{"path":["catalogs","bags"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{"mode":"raw","raw":"[\n \"string\",\n \"string\"\n]","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"status\": 1541,\n \"error\": \"string\",\n \"message\": \"string\",\n \"timestamp\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"409004d6-cecf-45f8-a720-9e98a0ee8af4","name":"Forbidden: insufficient permissions; wrong consumer scope","originalRequest":{"url":{"path":["catalogs","bags"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{"mode":"raw","raw":"[\n \"string\",\n \"string\"\n]","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"status\": 1541,\n \"error\": \"string\",\n \"message\": \"string\",\n \"timestamp\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"1311e727-52b8-45f1-9e4c-e60180e154a8","name":"Get catalog keys","request":{"name":"Get catalog keys","description":{"content":"Retrieve the list of keys from a catalog.\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `CATALOGS_CATALOG_READ`\n\n**User role permission required:** `assets_catalogs: read`\n","type":"text/plain"},"url":{"path":["catalogs","bags",":catalogId","keys"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"5612","key":"catalogId","description":"(Required) ID of the catalog"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"8f68e576-cc9b-4128-97c6-e4f58354cc00","name":"List of keys","originalRequest":{"url":{"path":["catalogs","bags",":catalogId","keys"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"5612","key":"catalogId","description":"(Required) ID of the catalog"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"data\": [\n \"string\",\n \"string\"\n ],\n \"metaData\": {\n \"totalCount\": {\n \"value\": \"\"\n },\n \"requestTime\": {\n \"value\": \"\"\n }\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"ed3289bf-bc64-4415-9976-ae442ab10a3f","name":"Unauthorized: token missing/expired/invalid; invalid API key; etc.","originalRequest":{"url":{"path":["catalogs","bags",":catalogId","keys"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"5612","key":"catalogId","description":"(Required) ID of the catalog"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"status\": 1541,\n \"error\": \"string\",\n \"message\": \"string\",\n \"timestamp\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"75112511-d486-41ce-acb7-eaf4417cea70","name":"Forbidden: insufficient permissions; wrong consumer scope","originalRequest":{"url":{"path":["catalogs","bags",":catalogId","keys"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"5612","key":"catalogId","description":"(Required) ID of the catalog"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"status\": 1541,\n \"error\": \"string\",\n \"message\": \"string\",\n \"timestamp\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"4fdf1fef-046a-41e1-a25f-fe686d3857d3","name":"Entity not found","originalRequest":{"url":{"path":["catalogs","bags",":catalogId","keys"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"5612","key":"catalogId","description":"(Required) ID of the catalog"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"text/plain"}],"method":"GET","body":{}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"string","cookie":[],"_postman_previewlanguage":"text"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"017dba55-e936-40e0-b832-c16acf2a9edc","name":"Get catalog info","request":{"name":"Get catalog info","description":{"content":"Retrieve the metadata of a catalog\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `CATALOGS_CATALOG_READ`\n\n**User role permission required:** `assets_catalogs: read`\n","type":"text/plain"},"url":{"path":["catalogs","bags",":catalogId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"5612","key":"catalogId","description":"(Required) ID of the catalog"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"983e3d5d-7571-42a2-a349-9ef1745da55a","name":"Details of the catalog","originalRequest":{"url":{"path":["catalogs","bags",":catalogId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"5612","key":"catalogId","description":"(Required) ID of the catalog"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"data\": {\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"businessProfileId\": {\n \"value\": \"\"\n },\n \"createdBy\": {\n \"value\": \"\"\n },\n \"creationDate\": {\n \"value\": \"\"\n },\n \"modifiedBy\": {\n \"value\": \"\"\n },\n \"lastModified\": {\n \"value\": \"\"\n },\n \"primaryKey\": {\n \"value\": \"\"\n },\n \"mappings\": {\n \"value\": \"\"\n },\n \"beforeFiltering\": {\n \"value\": \"\"\n },\n \"fields\": {\n \"value\": \"\"\n }\n },\n \"metaData\": {\n \"totalCount\": {\n \"value\": \"\"\n },\n \"requestTime\": {\n \"value\": \"\"\n }\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"c50c6404-fce1-4ba0-a9e7-abcf67e67ee5","name":"Unauthorized: token missing/expired/invalid; invalid API key; etc.","originalRequest":{"url":{"path":["catalogs","bags",":catalogId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"5612","key":"catalogId","description":"(Required) ID of the catalog"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"status\": 1541,\n \"error\": \"string\",\n \"message\": \"string\",\n \"timestamp\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"93587866-641f-4a97-8dfc-f0e73c58a4ba","name":"Forbidden: insufficient permissions; wrong consumer scope","originalRequest":{"url":{"path":["catalogs","bags",":catalogId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"5612","key":"catalogId","description":"(Required) ID of the catalog"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"status\": 1541,\n \"error\": \"string\",\n \"message\": \"string\",\n \"timestamp\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"4a7a7e64-da49-4574-a983-a7418750375c","name":"Entity not found","originalRequest":{"url":{"path":["catalogs","bags",":catalogId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"5612","key":"catalogId","description":"(Required) ID of the catalog"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"text/plain"}],"method":"GET","body":{}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"string","cookie":[],"_postman_previewlanguage":"text"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"96a811d0-9a7c-4a11-9f30-95c516b23ba4","name":"Delete catalog","request":{"name":"Delete catalog","description":{"content":"Delete a single catalog. This operation is irreversible.\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `CATALOGS_CATALOG_DELETE`\n\n**User role permission required:** `assets_catalogs: delete`\n","type":"text/plain"},"url":{"path":["catalogs","bags",":catalogId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"5612","key":"catalogId","description":"(Required) ID of the catalog"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"54a48e7b-e739-4314-be88-89165c558dd5","name":"Deletion status","originalRequest":{"url":{"path":["catalogs","bags",":catalogId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"5612","key":"catalogId","description":"(Required) ID of the catalog"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"data\": true,\n \"metaData\": {\n \"totalCount\": {\n \"value\": \"\"\n },\n \"requestTime\": {\n \"value\": \"\"\n }\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"bdc09d0a-52c2-4bbe-bf35-cefb5fdeb008","name":"Unauthorized: token missing/expired/invalid; invalid API key; etc.","originalRequest":{"url":{"path":["catalogs","bags",":catalogId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"5612","key":"catalogId","description":"(Required) ID of the catalog"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"status\": 1541,\n \"error\": \"string\",\n \"message\": \"string\",\n \"timestamp\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"ab56b252-4ed4-42f6-bb07-d40c61cc974e","name":"Forbidden: insufficient permissions; wrong consumer scope","originalRequest":{"url":{"path":["catalogs","bags",":catalogId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"5612","key":"catalogId","description":"(Required) ID of the catalog"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"status\": 1541,\n \"error\": \"string\",\n \"message\": \"string\",\n \"timestamp\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"98fd076e-41f0-4ada-93ce-d676b6ce0659","name":"Entity not found","originalRequest":{"url":{"path":["catalogs","bags",":catalogId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"5612","key":"catalogId","description":"(Required) ID of the catalog"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"text/plain"}],"method":"DELETE","body":{}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"string","cookie":[],"_postman_previewlanguage":"text"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"45e2f83a-2428-4196-993c-553b4ca36e02","name":"Add item","request":{"name":"Add item","description":{"content":"Add a single item to the catalog.\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `CATALOGS_ITEM_BATCH_CATALOG_CREATE`\n\n**User role permission required:** `assets_catalogs: create`\n","type":"text/plain"},"url":{"path":["catalogs","bags",":catalogId","items"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"5612","key":"catalogId","description":"(Required) ID of the catalog"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"itemKey\": \"sku1357\",\n \"value\": {\n \"itemCategory\": \"smartphone\",\n \"itemColor\": \"blue\"\n }\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"ed804a92-2eb4-4005-b03d-fd403ae7560b","name":"Upload status","originalRequest":{"url":{"path":["catalogs","bags",":catalogId","items"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"5612","key":"catalogId","description":"(Required) ID of the catalog"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"itemKey\": \"sku1357\",\n \"value\": {\n \"itemCategory\": \"smartphone\",\n \"itemColor\": \"blue\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"true","cookie":[],"_postman_previewlanguage":"json"},{"id":"2a59320d-9eb5-4074-a486-42139d4c2c7c","name":"Invalid or insufficient data","originalRequest":{"url":{"path":["catalogs","bags",":catalogId","items"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"5612","key":"catalogId","description":"(Required) ID of the catalog"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"text/plain"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"itemKey\": \"sku1357\",\n \"value\": {\n \"itemCategory\": \"smartphone\",\n \"itemColor\": \"blue\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"string","cookie":[],"_postman_previewlanguage":"text"},{"id":"39823257-b5d2-4d7c-888e-9f43098d7d09","name":"Unauthorized: token missing/expired/invalid; invalid API key; etc.","originalRequest":{"url":{"path":["catalogs","bags",":catalogId","items"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"5612","key":"catalogId","description":"(Required) ID of the catalog"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"itemKey\": \"sku1357\",\n \"value\": {\n \"itemCategory\": \"smartphone\",\n \"itemColor\": \"blue\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"status\": 1541,\n \"error\": \"string\",\n \"message\": \"string\",\n \"timestamp\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"bef9e9f0-0456-4db6-a9be-72913df33fd5","name":"Forbidden: insufficient permissions; wrong consumer scope","originalRequest":{"url":{"path":["catalogs","bags",":catalogId","items"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"5612","key":"catalogId","description":"(Required) ID of the catalog"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"itemKey\": \"sku1357\",\n \"value\": {\n \"itemCategory\": \"smartphone\",\n \"itemColor\": \"blue\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"status\": 1541,\n \"error\": \"string\",\n \"message\": \"string\",\n \"timestamp\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"509ea046-e3bc-4d7e-b57b-e7067cf4fc0a","name":"Entity not found","originalRequest":{"url":{"path":["catalogs","bags",":catalogId","items"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"5612","key":"catalogId","description":"(Required) ID of the catalog"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"text/plain"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"itemKey\": \"sku1357\",\n \"value\": {\n \"itemCategory\": \"smartphone\",\n \"itemColor\": \"blue\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"string","cookie":[],"_postman_previewlanguage":"text"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"767fa5a0-0259-4b59-85b7-1c6b5567e1d4","name":"Get items from catalog","request":{"name":"Get items from catalog","description":{"content":"Retrieve the entries from a single catalog.\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `CATALOGS_CATALOG_READ`\n\n**User role permission required:** `assets_catalogs: read`\n","type":"text/plain"},"url":{"path":["catalogs","bags",":catalogId","items"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"itemKey","value":"string","description":"Filter by the value of the unique identifier of the item (exact match)"},{"disabled":false,"key":"offset","value":"5612","description":"The offset for the search. For example, if your `limit` is 10 and you want to retrieve the third page of items, set the offset to 20. Items with indexes 20 to 29 are returned (the first item on the first page has the index 0)."},{"disabled":false,"key":"limit","value":"5612","description":"The maximum number of items to include in the response. `offset` must be defined. Default: 100"}],"variable":[{"disabled":false,"type":"any","value":"5612","key":"catalogId","description":"(Required) ID of the catalog"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"1ff3b5df-8267-496a-885d-bf0732adb538","name":"A list of items in the catalog","originalRequest":{"url":{"path":["catalogs","bags",":catalogId","items"],"host":["{{baseUrl}}"],"query":[{"key":"itemKey","value":"string"},{"key":"offset","value":"5612"},{"key":"limit","value":"5612"}],"variable":[{"disabled":false,"type":"any","value":"5612","key":"catalogId","description":"(Required) ID of the catalog"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"data\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"metaData\": {\n \"totalCount\": {\n \"value\": \"\"\n },\n \"requestTime\": {\n \"value\": \"\"\n }\n }\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"1c18a4ee-3bf4-463f-8c48-c84c5b4d6afc","name":"Batch add items","request":{"name":"Batch add items","description":{"content":"Add a number of items at once.\n\nFor better performance, we recommend using the [`/v1/async/bags/{catalogId}/items` endpoint](#operation/addItemsBatchAsync).\n\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `CATALOGS_ITEM_BATCH_CATALOG_CREATE`\n\n**User role permission required:** `assets_catalogs: create`\n","type":"text/plain"},"url":{"path":["catalogs","bags",":catalogId","items","batch"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"5612","key":"catalogId","description":"(Required) ID of the catalog"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"[\n {\n \"itemKey\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n {\n \"itemKey\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n }\n]","options":{"raw":{"language":"json"}}}},"response":[{"id":"5a0dd1e1-442b-4f96-9557-beee903e07f0","name":"Upload status","originalRequest":{"url":{"path":["catalogs","bags",":catalogId","items","batch"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"5612","key":"catalogId","description":"(Required) ID of the catalog"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"[\n {\n \"itemKey\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n {\n \"itemKey\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n }\n]","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"true","cookie":[],"_postman_previewlanguage":"json"},{"id":"75daa239-08ca-4550-8078-4574fa404a88","name":"Invalid or insufficient data","originalRequest":{"url":{"path":["catalogs","bags",":catalogId","items","batch"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"5612","key":"catalogId","description":"(Required) ID of the catalog"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"text/plain"}],"method":"POST","body":{"mode":"raw","raw":"[\n {\n \"itemKey\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n {\n \"itemKey\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n }\n]","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"string","cookie":[],"_postman_previewlanguage":"text"},{"id":"b78fae1a-0ae6-4606-98d2-70212acfcaa6","name":"Unauthorized: token missing/expired/invalid; invalid API key; etc.","originalRequest":{"url":{"path":["catalogs","bags",":catalogId","items","batch"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"5612","key":"catalogId","description":"(Required) ID of the catalog"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"[\n {\n \"itemKey\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n {\n \"itemKey\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n }\n]","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"status\": 1541,\n \"error\": \"string\",\n \"message\": \"string\",\n \"timestamp\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"ff197792-6454-4330-8dfd-f2429081e0ad","name":"Forbidden: insufficient permissions; wrong consumer scope","originalRequest":{"url":{"path":["catalogs","bags",":catalogId","items","batch"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"5612","key":"catalogId","description":"(Required) ID of the catalog"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"[\n {\n \"itemKey\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n {\n \"itemKey\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n }\n]","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"status\": 1541,\n \"error\": \"string\",\n \"message\": \"string\",\n \"timestamp\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"28906435-768d-4607-9b4e-676da9ba526c","name":"Entity not found","originalRequest":{"url":{"path":["catalogs","bags",":catalogId","items","batch"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"5612","key":"catalogId","description":"(Required) ID of the catalog"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"text/plain"}],"method":"POST","body":{"mode":"raw","raw":"[\n {\n \"itemKey\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n {\n \"itemKey\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n }\n]","options":{"raw":{"language":"json"}}}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"string","cookie":[],"_postman_previewlanguage":"text"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"c3297209-69c8-4d8d-b3cf-1f8b6e86ac40","name":"Update enrichment fields","request":{"name":"Update enrichment fields","description":{"content":"Change enrichment fields for given mapping\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `CATALOGS_MAPPING_CATALOG_CREATE`\n\n**User role permission required:** `assets_catalogs: create`\n","type":"text/plain"},"url":{"path":["catalogs","bags",":catalogId","enrichment","fields"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"5612","key":"catalogId","description":"(Required) ID of the catalog"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PATCH","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"action\": \"string\",\n \"paramKey\": \"string\",\n \"enrichmentFields\": [\n \"string\",\n \"string\"\n ]\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"05b0aa24-59c5-4528-b535-495c4b296ad8","name":"Upload status","originalRequest":{"url":{"path":["catalogs","bags",":catalogId","enrichment","fields"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"5612","key":"catalogId","description":"(Required) ID of the catalog"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"{\n \"action\": \"string\",\n \"paramKey\": \"string\",\n \"enrichmentFields\": [\n \"string\",\n \"string\"\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"8332","cookie":[],"_postman_previewlanguage":"json"},{"id":"66d20ea5-dedd-42db-a69b-6a12bd5e444a","name":"Invalid or insufficient data","originalRequest":{"url":{"path":["catalogs","bags",":catalogId","enrichment","fields"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"5612","key":"catalogId","description":"(Required) ID of the catalog"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"text/plain"}],"method":"PATCH","body":{"mode":"raw","raw":"{\n \"action\": \"string\",\n \"paramKey\": \"string\",\n \"enrichmentFields\": [\n \"string\",\n \"string\"\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"string","cookie":[],"_postman_previewlanguage":"text"},{"id":"e38153af-4bc7-464d-a923-36ff80e92b91","name":"Unauthorized: token missing/expired/invalid; invalid API key; etc.","originalRequest":{"url":{"path":["catalogs","bags",":catalogId","enrichment","fields"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"5612","key":"catalogId","description":"(Required) ID of the catalog"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"{\n \"action\": \"string\",\n \"paramKey\": \"string\",\n \"enrichmentFields\": [\n \"string\",\n \"string\"\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"status\": 1541,\n \"error\": \"string\",\n \"message\": \"string\",\n \"timestamp\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"536364e0-3cc9-4edd-8392-2ddde281041f","name":"Forbidden: insufficient permissions; wrong consumer scope","originalRequest":{"url":{"path":["catalogs","bags",":catalogId","enrichment","fields"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"5612","key":"catalogId","description":"(Required) ID of the catalog"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"{\n \"action\": \"string\",\n \"paramKey\": \"string\",\n \"enrichmentFields\": [\n \"string\",\n \"string\"\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"status\": 1541,\n \"error\": \"string\",\n \"message\": \"string\",\n \"timestamp\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"38e99dd8-ceba-4435-a6f1-a0e5d007c0f4","name":"Entity not found","originalRequest":{"url":{"path":["catalogs","bags",":catalogId","enrichment","fields"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"5612","key":"catalogId","description":"(Required) ID of the catalog"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"text/plain"}],"method":"PATCH","body":{"mode":"raw","raw":"{\n \"action\": \"string\",\n \"paramKey\": \"string\",\n \"enrichmentFields\": [\n \"string\",\n \"string\"\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"string","cookie":[],"_postman_previewlanguage":"text"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"4f28789f-b0d1-4afa-8368-149e394ce660","name":"Get single item by itemKey","request":{"name":"Get single item by itemKey","description":{"content":"Retrieve a single item from a catalog by using the item key (unique identifier of an item in the catalog, for example a product's SKU) of the entry in the Synerise database.\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `CATALOGS_CATALOG_READ`\n\n**User role permission required:** `assets_catalogs: read`\n","type":"text/plain"},"url":{"path":["catalogs","bags",":catalogId","items","itemKey",":itemKey"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"5612","key":"catalogId","description":"(Required) ID of the catalog"},{"disabled":false,"type":"any","value":"string","key":"itemKey","description":"(Required) `itemKey` parameter of the item to retrieve"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"09383584-a1f1-43cc-b3a1-8655c41ab3bb","name":"A single item","originalRequest":{"url":{"path":["catalogs","bags",":catalogId","items","itemKey",":itemKey"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"5612","key":"catalogId","description":"(Required) ID of the catalog"},{"disabled":false,"type":"any","value":"string","key":"itemKey","description":"(Required) `itemKey` parameter of the item to retrieve"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"data\": {\n \"bag\": {\n \"value\": \"\"\n },\n \"itemKey\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n },\n \"creationDate\": {\n \"value\": \"\"\n },\n \"lastModified\": {\n \"value\": \"\"\n }\n },\n \"metaData\": {\n \"totalCount\": {\n \"value\": \"\"\n },\n \"requestTime\": {\n \"value\": \"\"\n }\n }\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"0becbd31-40c9-47a6-b80c-dd0498867e7c","name":"Delete single item by itemKey","request":{"name":"Delete single item by itemKey","description":{"content":"Delete a single item by itemKey (unique identifier of an item in the catalog, for example a product's SKU).\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `CATALOGS_CATALOG_DELETE`\n\n**User role permission required:** `assets_catalogs: delete`\n","type":"text/plain"},"url":{"path":["catalogs","bags",":catalogId","items","itemKey",":itemKey"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"5612","key":"catalogId","description":"(Required) ID of the catalog"},{"disabled":false,"type":"any","value":"string","key":"itemKey","description":"(Required) `itemKey` parameter of the item to delete"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"9e36317a-f3f0-455f-ab04-1ad0724f37cc","name":"Success","originalRequest":{"url":{"path":["catalogs","bags",":catalogId","items","itemKey",":itemKey"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"5612","key":"catalogId","description":"(Required) ID of the catalog"},{"disabled":false,"type":"any","value":"string","key":"itemKey","description":"(Required) `itemKey` parameter of the item to delete"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"data\": true,\n \"metaData\": {\n \"totalCount\": {\n \"value\": \"\"\n },\n \"requestTime\": {\n \"value\": \"\"\n }\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"cd8f1f06-ad0d-4445-80b6-70814507adc7","name":"Unauthorized: token missing/expired/invalid; invalid API key; etc.","originalRequest":{"url":{"path":["catalogs","bags",":catalogId","items","itemKey",":itemKey"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"5612","key":"catalogId","description":"(Required) ID of the catalog"},{"disabled":false,"type":"any","value":"string","key":"itemKey","description":"(Required) `itemKey` parameter of the item to delete"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"status\": 1541,\n \"error\": \"string\",\n \"message\": \"string\",\n \"timestamp\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"50154967-4f76-4d11-86bf-a36c3aa934b8","name":"Forbidden: insufficient permissions; wrong consumer scope","originalRequest":{"url":{"path":["catalogs","bags",":catalogId","items","itemKey",":itemKey"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"5612","key":"catalogId","description":"(Required) ID of the catalog"},{"disabled":false,"type":"any","value":"string","key":"itemKey","description":"(Required) `itemKey` parameter of the item to delete"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"status\": 1541,\n \"error\": \"string\",\n \"message\": \"string\",\n \"timestamp\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"17e8f846-b066-49d1-8d74-9c53dd75c9a5","name":"Entity not found","originalRequest":{"url":{"path":["catalogs","bags",":catalogId","items","itemKey",":itemKey"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"5612","key":"catalogId","description":"(Required) ID of the catalog"},{"disabled":false,"type":"any","value":"string","key":"itemKey","description":"(Required) `itemKey` parameter of the item to delete"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"text/plain"}],"method":"DELETE","body":{}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"string","cookie":[],"_postman_previewlanguage":"text"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"5465af78-a02d-4768-926d-f6cf49399abd","name":"Update single item by database ID","request":{"name":"Update single item by database ID","description":{"content":"Update a single item from a catalog by using the ID of the entry in the Synerise database.\n\nUpdate requests are processed according to the time they reach the service. \nThis means that updates from the synchronous `/bags/{catalogId}/items/{itemId}` endpoint may overwrite asynchronous operations (see [`/v1/async/*` endpoints](#operation/updateItemAsync)) which were sent earlier and queued due to high traffic. \nThis behavior also applies to requests from Automation and AI feed synchronization, which use the asynchronous mechanism.\n\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `CATALOGS_CATALOG_UPDATE`\n\n**User role permission required:** `assets_catalogs: update`\n","type":"text/plain"},"url":{"path":["catalogs","bags",":catalogId","items",":itemId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"5612","key":"catalogId","description":"(Required) ID of the catalog"},{"disabled":false,"type":"any","value":"5612","key":"itemId","description":"(Required) ID of the item. This is the ID of the entry in the Synerise\ndatabase, not the unique identifier that you're using in your\ncatalog. The itemId is available in the `id` field of the catalog item when you [retrieve items from a catalog](#operation/getItemsByBag):\n\n```\n{\n \"creationDate\": \"2020-09-30T11:31:16.314Z\",\n \"id\": 73753, // this is the itemId\n \"itemKey\": \"uniqueValue\",\n \"lastModified\": null,\n \"value\": \"{\\\"exampleKey\\\":\\\"uniqueValue\\\",\\\"exampleKey2\\\":\\\"exampleValue\\\"}\",\n \"bag\": {\n \"author\": \"authorName\",\n \"creationDate\": \"2020-09-30T10:52:31.264Z\",\n \"id\": 1053, // this is the ID of the catalog\n \"lastModified\": \"2020-09-30T11:41:11.808Z\",\n \"name\": \"sampleCatalog\"\n }\n},\n```\n"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"key_0\": {},\n \"key_1\": {}\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"a3c2cdd5-4c3a-4d3f-9634-d7e4911aa841","name":"A single item","originalRequest":{"url":{"path":["catalogs","bags",":catalogId","items",":itemId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"5612","key":"catalogId","description":"(Required) ID of the catalog"},{"disabled":false,"type":"any","value":"5612","key":"itemId","description":"(Required) ID of the item. This is the ID of the entry in the Synerise\ndatabase, not the unique identifier that you're using in your\ncatalog. The itemId is available in the `id` field of the catalog item when you [retrieve items from a catalog](#operation/getItemsByBag):\n\n```\n{\n \"creationDate\": \"2020-09-30T11:31:16.314Z\",\n \"id\": 73753, // this is the itemId\n \"itemKey\": \"uniqueValue\",\n \"lastModified\": null,\n \"value\": \"{\\\"exampleKey\\\":\\\"uniqueValue\\\",\\\"exampleKey2\\\":\\\"exampleValue\\\"}\",\n \"bag\": {\n \"author\": \"authorName\",\n \"creationDate\": \"2020-09-30T10:52:31.264Z\",\n \"id\": 1053, // this is the ID of the catalog\n \"lastModified\": \"2020-09-30T11:41:11.808Z\",\n \"name\": \"sampleCatalog\"\n }\n},\n```\n"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"key_0\": {},\n \"key_1\": {}\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"data\": {\n \"bag\": {\n \"value\": \"\"\n },\n \"itemKey\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n },\n \"creationDate\": {\n \"value\": \"\"\n },\n \"lastModified\": {\n \"value\": \"\"\n }\n },\n \"metaData\": {\n \"totalCount\": {\n \"value\": \"\"\n },\n \"requestTime\": {\n \"value\": \"\"\n }\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"3478baa4-27c5-4d72-9fa4-49be9f73717b","name":"Unauthorized: token missing/expired/invalid; invalid API key; etc.","originalRequest":{"url":{"path":["catalogs","bags",":catalogId","items",":itemId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"5612","key":"catalogId","description":"(Required) ID of the catalog"},{"disabled":false,"type":"any","value":"5612","key":"itemId","description":"(Required) ID of the item. This is the ID of the entry in the Synerise\ndatabase, not the unique identifier that you're using in your\ncatalog. The itemId is available in the `id` field of the catalog item when you [retrieve items from a catalog](#operation/getItemsByBag):\n\n```\n{\n \"creationDate\": \"2020-09-30T11:31:16.314Z\",\n \"id\": 73753, // this is the itemId\n \"itemKey\": \"uniqueValue\",\n \"lastModified\": null,\n \"value\": \"{\\\"exampleKey\\\":\\\"uniqueValue\\\",\\\"exampleKey2\\\":\\\"exampleValue\\\"}\",\n \"bag\": {\n \"author\": \"authorName\",\n \"creationDate\": \"2020-09-30T10:52:31.264Z\",\n \"id\": 1053, // this is the ID of the catalog\n \"lastModified\": \"2020-09-30T11:41:11.808Z\",\n \"name\": \"sampleCatalog\"\n }\n},\n```\n"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"key_0\": {},\n \"key_1\": {}\n}","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"status\": 1541,\n \"error\": \"string\",\n \"message\": \"string\",\n \"timestamp\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"5e86c50a-b2a4-4f15-ab66-c39ce0ac9c95","name":"Forbidden: insufficient permissions; wrong consumer scope","originalRequest":{"url":{"path":["catalogs","bags",":catalogId","items",":itemId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"5612","key":"catalogId","description":"(Required) ID of the catalog"},{"disabled":false,"type":"any","value":"5612","key":"itemId","description":"(Required) ID of the item. This is the ID of the entry in the Synerise\ndatabase, not the unique identifier that you're using in your\ncatalog. The itemId is available in the `id` field of the catalog item when you [retrieve items from a catalog](#operation/getItemsByBag):\n\n```\n{\n \"creationDate\": \"2020-09-30T11:31:16.314Z\",\n \"id\": 73753, // this is the itemId\n \"itemKey\": \"uniqueValue\",\n \"lastModified\": null,\n \"value\": \"{\\\"exampleKey\\\":\\\"uniqueValue\\\",\\\"exampleKey2\\\":\\\"exampleValue\\\"}\",\n \"bag\": {\n \"author\": \"authorName\",\n \"creationDate\": \"2020-09-30T10:52:31.264Z\",\n \"id\": 1053, // this is the ID of the catalog\n \"lastModified\": \"2020-09-30T11:41:11.808Z\",\n \"name\": \"sampleCatalog\"\n }\n},\n```\n"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"key_0\": {},\n \"key_1\": {}\n}","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"status\": 1541,\n \"error\": \"string\",\n \"message\": \"string\",\n \"timestamp\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"e6797e0e-f46d-42ac-b426-62cd2f63c204","name":"Entity not found","originalRequest":{"url":{"path":["catalogs","bags",":catalogId","items",":itemId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"5612","key":"catalogId","description":"(Required) ID of the catalog"},{"disabled":false,"type":"any","value":"5612","key":"itemId","description":"(Required) ID of the item. This is the ID of the entry in the Synerise\ndatabase, not the unique identifier that you're using in your\ncatalog. The itemId is available in the `id` field of the catalog item when you [retrieve items from a catalog](#operation/getItemsByBag):\n\n```\n{\n \"creationDate\": \"2020-09-30T11:31:16.314Z\",\n \"id\": 73753, // this is the itemId\n \"itemKey\": \"uniqueValue\",\n \"lastModified\": null,\n \"value\": \"{\\\"exampleKey\\\":\\\"uniqueValue\\\",\\\"exampleKey2\\\":\\\"exampleValue\\\"}\",\n \"bag\": {\n \"author\": \"authorName\",\n \"creationDate\": \"2020-09-30T10:52:31.264Z\",\n \"id\": 1053, // this is the ID of the catalog\n \"lastModified\": \"2020-09-30T11:41:11.808Z\",\n \"name\": \"sampleCatalog\"\n }\n},\n```\n"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"text/plain"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"key_0\": {},\n \"key_1\": {}\n}","options":{"raw":{"language":"json"}}}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"string","cookie":[],"_postman_previewlanguage":"text"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"acb97b5f-f8a4-4681-ad5a-2b13d2800bca","name":"Get single item by database ID","request":{"name":"Get single item by database ID","description":{"content":"Retrieve a single item from a catalog by using the ID of the entry in the Synerise database. If you want to retrieve an item by its unique identifier in the catalog, use [/bags/{catalogId}/items/itemKey/{itemKey}](#operation/getItemByKey).\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `CATALOGS_CATALOG_READ`\n\n**User role permission required:** `assets_catalogs: read`\n","type":"text/plain"},"url":{"path":["catalogs","bags",":catalogId","items",":itemId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"5612","key":"catalogId","description":"(Required) ID of the catalog"},{"disabled":false,"type":"any","value":"5612","key":"itemId","description":"(Required) ID of the item. This is the ID of the entry in the Synerise\ndatabase, not the unique identifier that you're using in your\ncatalog. The itemId is available in the `id` field of the catalog item when you [retrieve items from a catalog](#operation/getItemsByBag):\n\n```\n{\n \"creationDate\": \"2020-09-30T11:31:16.314Z\",\n \"id\": 73753, // this is the itemId\n \"itemKey\": \"uniqueValue\",\n \"lastModified\": null,\n \"value\": \"{\\\"exampleKey\\\":\\\"uniqueValue\\\",\\\"exampleKey2\\\":\\\"exampleValue\\\"}\",\n \"bag\": {\n \"author\": \"authorName\",\n \"creationDate\": \"2020-09-30T10:52:31.264Z\",\n \"id\": 1053, // this is the ID of the catalog\n \"lastModified\": \"2020-09-30T11:41:11.808Z\",\n \"name\": \"sampleCatalog\"\n }\n},\n```\n"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"4f2b2458-bf90-4152-a3b5-99b506ba01aa","name":"A single item","originalRequest":{"url":{"path":["catalogs","bags",":catalogId","items",":itemId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"5612","key":"catalogId","description":"(Required) ID of the catalog"},{"disabled":false,"type":"any","value":"5612","key":"itemId","description":"(Required) ID of the item. This is the ID of the entry in the Synerise\ndatabase, not the unique identifier that you're using in your\ncatalog. The itemId is available in the `id` field of the catalog item when you [retrieve items from a catalog](#operation/getItemsByBag):\n\n```\n{\n \"creationDate\": \"2020-09-30T11:31:16.314Z\",\n \"id\": 73753, // this is the itemId\n \"itemKey\": \"uniqueValue\",\n \"lastModified\": null,\n \"value\": \"{\\\"exampleKey\\\":\\\"uniqueValue\\\",\\\"exampleKey2\\\":\\\"exampleValue\\\"}\",\n \"bag\": {\n \"author\": \"authorName\",\n \"creationDate\": \"2020-09-30T10:52:31.264Z\",\n \"id\": 1053, // this is the ID of the catalog\n \"lastModified\": \"2020-09-30T11:41:11.808Z\",\n \"name\": \"sampleCatalog\"\n }\n},\n```\n"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"data\": {\n \"bag\": {\n \"value\": \"\"\n },\n \"itemKey\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n },\n \"creationDate\": {\n \"value\": \"\"\n },\n \"lastModified\": {\n \"value\": \"\"\n }\n },\n \"metaData\": {\n \"totalCount\": {\n \"value\": \"\"\n },\n \"requestTime\": {\n \"value\": \"\"\n }\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"14e90a4e-427f-4dac-8958-b902c7fa1dc5","name":"Unauthorized: token missing/expired/invalid; invalid API key; etc.","originalRequest":{"url":{"path":["catalogs","bags",":catalogId","items",":itemId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"5612","key":"catalogId","description":"(Required) ID of the catalog"},{"disabled":false,"type":"any","value":"5612","key":"itemId","description":"(Required) ID of the item. This is the ID of the entry in the Synerise\ndatabase, not the unique identifier that you're using in your\ncatalog. The itemId is available in the `id` field of the catalog item when you [retrieve items from a catalog](#operation/getItemsByBag):\n\n```\n{\n \"creationDate\": \"2020-09-30T11:31:16.314Z\",\n \"id\": 73753, // this is the itemId\n \"itemKey\": \"uniqueValue\",\n \"lastModified\": null,\n \"value\": \"{\\\"exampleKey\\\":\\\"uniqueValue\\\",\\\"exampleKey2\\\":\\\"exampleValue\\\"}\",\n \"bag\": {\n \"author\": \"authorName\",\n \"creationDate\": \"2020-09-30T10:52:31.264Z\",\n \"id\": 1053, // this is the ID of the catalog\n \"lastModified\": \"2020-09-30T11:41:11.808Z\",\n \"name\": \"sampleCatalog\"\n }\n},\n```\n"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"status\": 1541,\n \"error\": \"string\",\n \"message\": \"string\",\n \"timestamp\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"1d0a9faf-da5e-4857-80b1-6579029c5625","name":"Forbidden: insufficient permissions; wrong consumer scope","originalRequest":{"url":{"path":["catalogs","bags",":catalogId","items",":itemId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"5612","key":"catalogId","description":"(Required) ID of the catalog"},{"disabled":false,"type":"any","value":"5612","key":"itemId","description":"(Required) ID of the item. This is the ID of the entry in the Synerise\ndatabase, not the unique identifier that you're using in your\ncatalog. The itemId is available in the `id` field of the catalog item when you [retrieve items from a catalog](#operation/getItemsByBag):\n\n```\n{\n \"creationDate\": \"2020-09-30T11:31:16.314Z\",\n \"id\": 73753, // this is the itemId\n \"itemKey\": \"uniqueValue\",\n \"lastModified\": null,\n \"value\": \"{\\\"exampleKey\\\":\\\"uniqueValue\\\",\\\"exampleKey2\\\":\\\"exampleValue\\\"}\",\n \"bag\": {\n \"author\": \"authorName\",\n \"creationDate\": \"2020-09-30T10:52:31.264Z\",\n \"id\": 1053, // this is the ID of the catalog\n \"lastModified\": \"2020-09-30T11:41:11.808Z\",\n \"name\": \"sampleCatalog\"\n }\n},\n```\n"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"status\": 1541,\n \"error\": \"string\",\n \"message\": \"string\",\n \"timestamp\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"48991d00-748d-4312-a23d-aadfd6536eca","name":"Entity not found","originalRequest":{"url":{"path":["catalogs","bags",":catalogId","items",":itemId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"5612","key":"catalogId","description":"(Required) ID of the catalog"},{"disabled":false,"type":"any","value":"5612","key":"itemId","description":"(Required) ID of the item. This is the ID of the entry in the Synerise\ndatabase, not the unique identifier that you're using in your\ncatalog. The itemId is available in the `id` field of the catalog item when you [retrieve items from a catalog](#operation/getItemsByBag):\n\n```\n{\n \"creationDate\": \"2020-09-30T11:31:16.314Z\",\n \"id\": 73753, // this is the itemId\n \"itemKey\": \"uniqueValue\",\n \"lastModified\": null,\n \"value\": \"{\\\"exampleKey\\\":\\\"uniqueValue\\\",\\\"exampleKey2\\\":\\\"exampleValue\\\"}\",\n \"bag\": {\n \"author\": \"authorName\",\n \"creationDate\": \"2020-09-30T10:52:31.264Z\",\n \"id\": 1053, // this is the ID of the catalog\n \"lastModified\": \"2020-09-30T11:41:11.808Z\",\n \"name\": \"sampleCatalog\"\n }\n},\n```\n"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"text/plain"}],"method":"GET","body":{}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"string","cookie":[],"_postman_previewlanguage":"text"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"d72102dc-50dc-4b47-a53c-b2336f1b7720","name":"Delete single item by database ID","request":{"name":"Delete single item by database ID","description":{"content":"Delete a single item by ID.\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `CATALOGS_CATALOG_DELETE`\n\n**User role permission required:** `assets_catalogs: delete`\n","type":"text/plain"},"url":{"path":["catalogs","bags",":catalogId","items",":itemId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"5612","key":"catalogId","description":"(Required) ID of the catalog"},{"disabled":false,"type":"any","value":"5612","key":"itemId","description":"(Required) ID of the item. This is the ID of the entry in the Synerise\ndatabase, not the unique identifier that you're using in your\ncatalog. The itemId is available in the `id` field of the catalog item when you [retrieve items from a catalog](#operation/getItemsByBag):\n\n```\n{\n \"creationDate\": \"2020-09-30T11:31:16.314Z\",\n \"id\": 73753, // this is the itemId\n \"itemKey\": \"uniqueValue\",\n \"lastModified\": null,\n \"value\": \"{\\\"exampleKey\\\":\\\"uniqueValue\\\",\\\"exampleKey2\\\":\\\"exampleValue\\\"}\",\n \"bag\": {\n \"author\": \"authorName\",\n \"creationDate\": \"2020-09-30T10:52:31.264Z\",\n \"id\": 1053, // this is the ID of the catalog\n \"lastModified\": \"2020-09-30T11:41:11.808Z\",\n \"name\": \"sampleCatalog\"\n }\n},\n```\n"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"e4aa23bf-9c23-4635-95aa-2a327fe39b6b","name":"Success","originalRequest":{"url":{"path":["catalogs","bags",":catalogId","items",":itemId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"5612","key":"catalogId","description":"(Required) ID of the catalog"},{"disabled":false,"type":"any","value":"5612","key":"itemId","description":"(Required) ID of the item. This is the ID of the entry in the Synerise\ndatabase, not the unique identifier that you're using in your\ncatalog. The itemId is available in the `id` field of the catalog item when you [retrieve items from a catalog](#operation/getItemsByBag):\n\n```\n{\n \"creationDate\": \"2020-09-30T11:31:16.314Z\",\n \"id\": 73753, // this is the itemId\n \"itemKey\": \"uniqueValue\",\n \"lastModified\": null,\n \"value\": \"{\\\"exampleKey\\\":\\\"uniqueValue\\\",\\\"exampleKey2\\\":\\\"exampleValue\\\"}\",\n \"bag\": {\n \"author\": \"authorName\",\n \"creationDate\": \"2020-09-30T10:52:31.264Z\",\n \"id\": 1053, // this is the ID of the catalog\n \"lastModified\": \"2020-09-30T11:41:11.808Z\",\n \"name\": \"sampleCatalog\"\n }\n},\n```\n"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"data\": true,\n \"metaData\": {\n \"totalCount\": {\n \"value\": \"\"\n },\n \"requestTime\": {\n \"value\": \"\"\n }\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"088e5d0b-bfa4-45a6-b0fc-1216ab1a1d28","name":"Unauthorized: token missing/expired/invalid; invalid API key; etc.","originalRequest":{"url":{"path":["catalogs","bags",":catalogId","items",":itemId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"5612","key":"catalogId","description":"(Required) ID of the catalog"},{"disabled":false,"type":"any","value":"5612","key":"itemId","description":"(Required) ID of the item. This is the ID of the entry in the Synerise\ndatabase, not the unique identifier that you're using in your\ncatalog. The itemId is available in the `id` field of the catalog item when you [retrieve items from a catalog](#operation/getItemsByBag):\n\n```\n{\n \"creationDate\": \"2020-09-30T11:31:16.314Z\",\n \"id\": 73753, // this is the itemId\n \"itemKey\": \"uniqueValue\",\n \"lastModified\": null,\n \"value\": \"{\\\"exampleKey\\\":\\\"uniqueValue\\\",\\\"exampleKey2\\\":\\\"exampleValue\\\"}\",\n \"bag\": {\n \"author\": \"authorName\",\n \"creationDate\": \"2020-09-30T10:52:31.264Z\",\n \"id\": 1053, // this is the ID of the catalog\n \"lastModified\": \"2020-09-30T11:41:11.808Z\",\n \"name\": \"sampleCatalog\"\n }\n},\n```\n"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"status\": 1541,\n \"error\": \"string\",\n \"message\": \"string\",\n \"timestamp\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"3e8d8a2f-b966-4ac3-843c-34b97ff8e93d","name":"Forbidden: insufficient permissions; wrong consumer scope","originalRequest":{"url":{"path":["catalogs","bags",":catalogId","items",":itemId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"5612","key":"catalogId","description":"(Required) ID of the catalog"},{"disabled":false,"type":"any","value":"5612","key":"itemId","description":"(Required) ID of the item. This is the ID of the entry in the Synerise\ndatabase, not the unique identifier that you're using in your\ncatalog. The itemId is available in the `id` field of the catalog item when you [retrieve items from a catalog](#operation/getItemsByBag):\n\n```\n{\n \"creationDate\": \"2020-09-30T11:31:16.314Z\",\n \"id\": 73753, // this is the itemId\n \"itemKey\": \"uniqueValue\",\n \"lastModified\": null,\n \"value\": \"{\\\"exampleKey\\\":\\\"uniqueValue\\\",\\\"exampleKey2\\\":\\\"exampleValue\\\"}\",\n \"bag\": {\n \"author\": \"authorName\",\n \"creationDate\": \"2020-09-30T10:52:31.264Z\",\n \"id\": 1053, // this is the ID of the catalog\n \"lastModified\": \"2020-09-30T11:41:11.808Z\",\n \"name\": \"sampleCatalog\"\n }\n},\n```\n"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"status\": 1541,\n \"error\": \"string\",\n \"message\": \"string\",\n \"timestamp\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"eaaf0e51-bd4d-431e-8c6e-b071b3d0033b","name":"Entity not found","originalRequest":{"url":{"path":["catalogs","bags",":catalogId","items",":itemId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"5612","key":"catalogId","description":"(Required) ID of the catalog"},{"disabled":false,"type":"any","value":"5612","key":"itemId","description":"(Required) ID of the item. This is the ID of the entry in the Synerise\ndatabase, not the unique identifier that you're using in your\ncatalog. The itemId is available in the `id` field of the catalog item when you [retrieve items from a catalog](#operation/getItemsByBag):\n\n```\n{\n \"creationDate\": \"2020-09-30T11:31:16.314Z\",\n \"id\": 73753, // this is the itemId\n \"itemKey\": \"uniqueValue\",\n \"lastModified\": null,\n \"value\": \"{\\\"exampleKey\\\":\\\"uniqueValue\\\",\\\"exampleKey2\\\":\\\"exampleValue\\\"}\",\n \"bag\": {\n \"author\": \"authorName\",\n \"creationDate\": \"2020-09-30T10:52:31.264Z\",\n \"id\": 1053, // this is the ID of the catalog\n \"lastModified\": \"2020-09-30T11:41:11.808Z\",\n \"name\": \"sampleCatalog\"\n }\n},\n```\n"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"text/plain"}],"method":"DELETE","body":{}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"string","cookie":[],"_postman_previewlanguage":"text"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"30f436fd-0054-4f26-ba7a-9a8458f75d3d","name":"Get all items","request":{"name":"Get all items","description":{"content":"Retrieve all items from all catalogs in the Workspace.\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `CATALOGS_CATALOG_READ`\n\n**User role permission required:** `assets_catalogs: read`\n","type":"text/plain"},"url":{"path":["catalogs","items"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"offset","value":"5612","description":"The offset for the search. For example, if your `limit` is 10 and you want to retrieve the third page of items, set the offset to 20. Items with indexes 20 to 29 are returned (the first item on the first page has the index 0)."},{"disabled":false,"key":"limit","value":"5612","description":"The maximum number of items to include in the response. `offset` must be defined. Default: 100"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"55fe9bfc-3171-4ded-a1eb-5e13822f22f8","name":"A list of items in the Workspace","originalRequest":{"url":{"path":["catalogs","items"],"host":["{{baseUrl}}"],"query":[{"key":"offset","value":"5612"},{"key":"limit","value":"5612"}],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"data\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"metaData\": {\n \"totalCount\": {\n \"value\": \"\"\n },\n \"requestTime\": {\n \"value\": \"\"\n }\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"63b2a032-4231-4a05-ae1f-e7fb51deacd0","name":"Unauthorized: token missing/expired/invalid; invalid API key; etc.","originalRequest":{"url":{"path":["catalogs","items"],"host":["{{baseUrl}}"],"query":[{"key":"offset","value":"5612"},{"key":"limit","value":"5612"}],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"status\": 1541,\n \"error\": \"string\",\n \"message\": \"string\",\n \"timestamp\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"4f1fd7d1-d050-4788-a7db-04ab7356833a","name":"Forbidden: insufficient permissions; wrong consumer scope","originalRequest":{"url":{"path":["catalogs","items"],"host":["{{baseUrl}}"],"query":[{"key":"offset","value":"5612"},{"key":"limit","value":"5612"}],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"status\": 1541,\n \"error\": \"string\",\n \"message\": \"string\",\n \"timestamp\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"1201c251-65e6-4c7b-a011-d63a8f0cd79f","name":"Add mapping","request":{"name":"Add mapping","description":{"content":"Add a new mapping. Mappings can be used to enrich events with data from catalogs.\n\nFor example, you can map the product's SKU from the \"product.buy\" event to the column in the catalog that includes the SKU. Whenever someone purchases an item with that SKU, you can extract data from the catalog (for example, the product's brand and category) and show that additional in the event log in the Synerise GUI.\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `CATALOGS_MAPPING_CATALOG_CREATE`\n\n**User role permission required:** `assets_catalogs: create`\n","type":"text/plain"},"url":{"path":["catalogs","bags",":catalogId","mappings"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"5612","key":"catalogId","description":"(Required) ID of the catalog"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"action\": \"transaction.charge\",\n \"paramKey\": \"sku\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"70f91fcc-d3b1-4299-ac62-baa2c8edaaa3","name":"Mapping data","originalRequest":{"url":{"path":["catalogs","bags",":catalogId","mappings"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"5612","key":"catalogId","description":"(Required) ID of the catalog"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"action\": \"transaction.charge\",\n \"paramKey\": \"sku\"\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"data\": {\n \"bpActionParamKey\": {\n \"value\": \"\"\n },\n \"bagId\": {\n \"value\": \"\"\n },\n \"action\": {\n \"value\": \"\"\n },\n \"paramKey\": {\n \"value\": \"\"\n },\n \"enrichmentFields\": {\n \"value\": \"\"\n }\n },\n \"metaData\": {\n \"totalCount\": {\n \"value\": \"\"\n },\n \"requestTime\": {\n \"value\": \"\"\n }\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"b702025a-7bee-4603-a23e-e1e5140111de","name":"Invalid or insufficient data","originalRequest":{"url":{"path":["catalogs","bags",":catalogId","mappings"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"5612","key":"catalogId","description":"(Required) ID of the catalog"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"text/plain"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"action\": \"transaction.charge\",\n \"paramKey\": \"sku\"\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"string","cookie":[],"_postman_previewlanguage":"text"},{"id":"261b8c09-1e59-44f2-9825-33e38b183eaf","name":"Unauthorized: token missing/expired/invalid; invalid API key; etc.","originalRequest":{"url":{"path":["catalogs","bags",":catalogId","mappings"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"5612","key":"catalogId","description":"(Required) ID of the catalog"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"action\": \"transaction.charge\",\n \"paramKey\": \"sku\"\n}","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"status\": 1541,\n \"error\": \"string\",\n \"message\": \"string\",\n \"timestamp\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"5bc576eb-e990-4315-beaf-6472485d75f8","name":"Forbidden: insufficient permissions; wrong consumer scope","originalRequest":{"url":{"path":["catalogs","bags",":catalogId","mappings"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"5612","key":"catalogId","description":"(Required) ID of the catalog"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"action\": \"transaction.charge\",\n \"paramKey\": \"sku\"\n}","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"status\": 1541,\n \"error\": \"string\",\n \"message\": \"string\",\n \"timestamp\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"4740d10d-4b36-4f3f-9dfb-586d18af6a41","name":"Entity not found","originalRequest":{"url":{"path":["catalogs","bags",":catalogId","mappings"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"5612","key":"catalogId","description":"(Required) ID of the catalog"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"text/plain"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"action\": \"transaction.charge\",\n \"paramKey\": \"sku\"\n}","options":{"raw":{"language":"json"}}}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"string","cookie":[],"_postman_previewlanguage":"text"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"cd989120-a4e2-4ded-a94f-1752e75a7771","name":"Get all mappings","request":{"name":"Get all mappings","description":{"content":"Retrieve all mappings from the Workspace.\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `CATALOGS_MAPPING_CATALOG_READ`\n\n**User role permission required:** `assets_catalogs: read`\n","type":"text/plain"},"url":{"path":["catalogs","mappings"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"ab8960cc-3e01-4444-a9c0-2baedb576e56","name":"List of mappings","originalRequest":{"url":{"path":["catalogs","mappings"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"data\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"metaData\": {\n \"totalCount\": {\n \"value\": \"\"\n },\n \"requestTime\": {\n \"value\": \"\"\n }\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"696a7a4a-d884-4967-8674-3e88e5f1dc2e","name":"Unauthorized: token missing/expired/invalid; invalid API key; etc.","originalRequest":{"url":{"path":["catalogs","mappings"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"status\": 1541,\n \"error\": \"string\",\n \"message\": \"string\",\n \"timestamp\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"53db17cd-483a-420b-8f47-2e454eda9e1a","name":"Forbidden: insufficient permissions; wrong consumer scope","originalRequest":{"url":{"path":["catalogs","mappings"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"status\": 1541,\n \"error\": \"string\",\n \"message\": \"string\",\n \"timestamp\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"d876825c-5f19-4a6d-a426-80efc7044686","name":"Delete mapping","request":{"name":"Delete mapping","description":{"content":"Delete a single mapping.\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `CATALOGS_MAPPING_CATALOG_DELETE`\n\n**User role permission required:** `assets_catalogs: delete`\n","type":"text/plain"},"url":{"path":["catalogs","mappings",":bpActionParamKey"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"bpActionParamKey","description":"(Required) The unique identifier of the mapping"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"05529736-0eb1-4fb9-9e5f-420b7579981b","name":"Deletion status","originalRequest":{"url":{"path":["catalogs","mappings",":bpActionParamKey"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"bpActionParamKey","description":"(Required) The unique identifier of the mapping"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"data\": false,\n \"metaData\": {\n \"totalCount\": {\n \"value\": \"\"\n },\n \"requestTime\": {\n \"value\": \"\"\n }\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"7378285f-3df3-43f7-adc9-6fd59bb07cd1","name":"Unauthorized: token missing/expired/invalid; invalid API key; etc.","originalRequest":{"url":{"path":["catalogs","mappings",":bpActionParamKey"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"bpActionParamKey","description":"(Required) The unique identifier of the mapping"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"status\": 1541,\n \"error\": \"string\",\n \"message\": \"string\",\n \"timestamp\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"75069068-ef6e-4c7f-89da-ea2d34c36c93","name":"Forbidden: insufficient permissions; wrong consumer scope","originalRequest":{"url":{"path":["catalogs","mappings",":bpActionParamKey"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"bpActionParamKey","description":"(Required) The unique identifier of the mapping"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"status\": 1541,\n \"error\": \"string\",\n \"message\": \"string\",\n \"timestamp\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"8115f022-6ec6-4562-8011-956fc94bbca8","name":"Entity not found","originalRequest":{"url":{"path":["catalogs","mappings",":bpActionParamKey"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"bpActionParamKey","description":"(Required) The unique identifier of the mapping"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"text/plain"}],"method":"DELETE","body":{}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"string","cookie":[],"_postman_previewlanguage":"text"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"2490feeb-ebb8-4095-9d9c-2dca254c3afd","name":"Get single item by unique key","request":{"name":"Get single item by unique key","description":{"content":"Retrieve a single item from a catalog by using the value of the unique identifier (key) in the catalog. If you want to retrieve an item by its ID in the Synerise database, use [/bags/{catalogId}/items/{itemId}](#operation/getItem).\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `ITEMS_COLLECTOR_CATALOG_READ`\n\n**User role permission required:** `assets_catalogs: read`\n","type":"text/plain"},"url":{"path":["catalogs","itemDetail"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"catalogName","value":"string","description":"(Required) Name of the catalog"},{"disabled":false,"key":"key","value":"string","description":"(Required) Value of the unique identifier of the item in the catalog. When you retrieve an item using [this endpoint](#operation/getItemsByBag), the identifier is in the `itemKey` field.\n\n```\n{\n \"creationDate\": \"2020-09-30T11:31:16.314Z\",\n \"id\": 73753,\n \"itemKey\": \"uniqueValue\", // this is the value of the key\n \"lastModified\": null,\n \"value\": \"{\\\"exampleKey\\\":\\\"uniqueValue\\\",\\\"exampleKey2\\\":\\\"exampleValue\\\"}\",\n \"bag\": {\n \"author\": \"authorName\",\n \"creationDate\": \"2020-09-30T10:52:31.264Z\",\n \"id\": 1053,\n \"lastModified\": \"2020-09-30T11:41:11.808Z\",\n \"name\": \"sampleCatalog\"\n }\n},\n```\n"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"01f8f6eb-71c7-427d-b965-e3e26c73948c","name":"A single item","originalRequest":{"url":{"path":["catalogs","itemDetail"],"host":["{{baseUrl}}"],"query":[{"key":"catalogName","value":"string"},{"key":"key","value":"string"}],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"data\": {\n \"itemId\": \"string\"\n },\n \"metaData\": {\n \"totalCount\": {\n \"value\": \"\"\n },\n \"requestTime\": {\n \"value\": \"\"\n }\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"19480d62-fa8b-4db1-8a2a-907a1bad085f","name":"Unauthorized: token missing/expired/invalid; invalid API key; etc.","originalRequest":{"url":{"path":["catalogs","itemDetail"],"host":["{{baseUrl}}"],"query":[{"key":"catalogName","value":"string"},{"key":"key","value":"string"}],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"status\": 1541,\n \"error\": \"string\",\n \"message\": \"string\",\n \"timestamp\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"e420f779-a156-43c0-8f4d-f8ee87bc10a6","name":"Forbidden: insufficient permissions; wrong consumer scope","originalRequest":{"url":{"path":["catalogs","itemDetail"],"host":["{{baseUrl}}"],"query":[{"key":"catalogName","value":"string"},{"key":"key","value":"string"}],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"status\": 1541,\n \"error\": \"string\",\n \"message\": \"string\",\n \"timestamp\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"abc1fbd0-be1b-4285-a1c6-a41695c82031","name":"Entity not found","originalRequest":{"url":{"path":["catalogs","itemDetail"],"host":["{{baseUrl}}"],"query":[{"key":"catalogName","value":"string"},{"key":"key","value":"string"}],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"text/plain"}],"method":"GET","body":{}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"string","cookie":[],"_postman_previewlanguage":"text"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"426ad773-b9b7-4679-bc0c-6d27bfd895e6","name":"Delete all items from a catalog","request":{"name":"Delete all items from a catalog","description":{"content":"Delete all the contents of a catalog.\n\nInformation about the keys (columns) remains.\n\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `CATALOGS_CATALOG_DELETE`\n\n**User role permission required:** `assets_catalogs: delete`\n","type":"text/plain"},"url":{"path":["catalogs","v2","bags",":catalogId","items"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"5612","key":"catalogId","description":"(Required) ID of the catalog"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"5d536b38-1536-4b74-90f3-0a52c0079d7c","name":"Items deleted. The `metaData` object always shows a `totalCount` of 1, regardless of the number of deleted items.","originalRequest":{"url":{"path":["catalogs","v2","bags",":catalogId","items"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"5612","key":"catalogId","description":"(Required) ID of the catalog"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"data\": \"c241505c-39fc-1b15-e7a2-cf17a4b89064\",\n \"metaData\": {\n \"totalCount\": {\n \"value\": \"\"\n },\n \"requestTime\": {\n \"value\": \"\"\n }\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"6b7dec1d-b381-421f-a659-a720e7e71bc8","name":"A problem occurred. See the error message for details.","originalRequest":{"url":{"path":["catalogs","v2","bags",":catalogId","items"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"5612","key":"catalogId","description":"(Required) ID of the catalog"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"string\",\n \"errorCode\": \"string\",\n \"httpStatus\": 6393,\n \"message\": \"string\",\n \"traceId\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"d2b8bf61-63f2-4ddf-9f41-0fe267b3101e","name":"Delete items by itemKeys","request":{"name":"Delete items by itemKeys","description":{"content":"Delete items by itemKeys (unique identifier of an item in the catalog, for example a product's SKU). In the Synerise Portal, it's called the **Primary key**.\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `CATALOGS_CATALOG_DELETE`\n\n**User role permission required:** `assets_catalogs: delete`\n","type":"text/plain"},"url":{"path":["catalogs","v2","bags",":catalogId","items","batch"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"5612","key":"catalogId","description":"(Required) ID of the catalog"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"DELETE","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"[\n \"string\",\n \"string\"\n]","options":{"raw":{"language":"json"}}}},"response":[{"id":"13695764-f034-4fc2-a276-7ac0650e63d6","name":"No Content","originalRequest":{"url":{"path":["catalogs","v2","bags",":catalogId","items","batch"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"5612","key":"catalogId","description":"(Required) ID of the catalog"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"DELETE","body":{"mode":"raw","raw":"[\n \"string\",\n \"string\"\n]","options":{"raw":{"language":"json"}}}},"status":"No Content","code":204,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"dc86740c-0613-413e-ae3e-d218c30552c2","name":"Unauthorized: token missing/expired/invalid; invalid API key; etc.","originalRequest":{"url":{"path":["catalogs","v2","bags",":catalogId","items","batch"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"5612","key":"catalogId","description":"(Required) ID of the catalog"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{"mode":"raw","raw":"[\n \"string\",\n \"string\"\n]","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"status\": 1541,\n \"error\": \"string\",\n \"message\": \"string\",\n \"timestamp\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"e83327fa-dbc6-49cc-981b-12d55fa71d6e","name":"Forbidden: insufficient permissions; wrong consumer scope","originalRequest":{"url":{"path":["catalogs","v2","bags",":catalogId","items","batch"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"5612","key":"catalogId","description":"(Required) ID of the catalog"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{"mode":"raw","raw":"[\n \"string\",\n \"string\"\n]","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"status\": 1541,\n \"error\": \"string\",\n \"message\": \"string\",\n \"timestamp\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"932c333f-2097-4e3b-9fc4-6e22dbd74bed","name":"Entity not found","originalRequest":{"url":{"path":["catalogs","v2","bags",":catalogId","items","batch"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"5612","key":"catalogId","description":"(Required) ID of the catalog"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"text/plain"}],"method":"DELETE","body":{"mode":"raw","raw":"[\n \"string\",\n \"string\"\n]","options":{"raw":{"language":"json"}}}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"string","cookie":[],"_postman_previewlanguage":"text"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"71b1f2e0-d043-4079-b6ba-ec3e08d5efe8","name":"Enable filtering","request":{"name":"Enable filtering","description":{"content":"Enable filtering for a catalog on selected fields\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `CATALOGS_CATALOG_UPDATE`\n\n**User role permission required:** `assets_catalogs: update`\n","type":"text/plain"},"url":{"path":["catalogs","v2","bags",":catalogId","enable","filtering"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"5612","key":"catalogId","description":"(Required) ID of the catalog"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PATCH","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"fields\": [\n \"string\",\n \"string\"\n ]\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"33db8a05-733a-4ba3-809f-b5bf8b63efb8","name":"Upload status","originalRequest":{"url":{"path":["catalogs","v2","bags",":catalogId","enable","filtering"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"5612","key":"catalogId","description":"(Required) ID of the catalog"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"{\n \"fields\": [\n \"string\",\n \"string\"\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"data\": \"b3878cf7-f5c2-3b7b-0069-f4f6c61c838c\",\n \"metaData\": {\n \"totalCount\": {\n \"value\": \"\"\n },\n \"requestTime\": {\n \"value\": \"\"\n }\n }\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"ca213765-021e-48bd-8996-c2bc1c600f2d","name":"Disable filtering","request":{"name":"Disable filtering","description":{"content":"Disable filtering for a catalog on selected fields\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `CATALOGS_CATALOG_UPDATE`\n\n**User role permission required:** `assets_catalogs: update`\n","type":"text/plain"},"url":{"path":["catalogs","v2","bags",":catalogId","disable","filtering"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"5612","key":"catalogId","description":"(Required) ID of the catalog"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PATCH","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"removeFilters\": true\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"ba6dbeb0-5fca-4ca2-a752-bb424fb8dc95","name":"Number of rows changed","originalRequest":{"url":{"path":["catalogs","v2","bags",":catalogId","disable","filtering"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"5612","key":"catalogId","description":"(Required) ID of the catalog"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"{\n \"removeFilters\": true\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"data\": 2495,\n \"metaData\": {\n \"totalCount\": {\n \"value\": \"\"\n },\n \"requestTime\": {\n \"value\": \"\"\n }\n }\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"71567bed-bc8d-44ff-99dc-562d3c2c4fba","name":"Add or update item asynchronously","request":{"name":"Add or update item asynchronously","description":{"content":"Add a single item asynchronously to the catalog. If the item already exists, it's entirely overwritten by the item you send.\n\nAsynchronous requests are processed according to the time they reach the service. \nThis means that requests to synchronous endpoints (for example, [`/bags/{catalogId}/items/{itemId}`](#operation/updateItem) may overwrite asynchronous operations which were sent earlier and queued due to high traffic. \nThis behavior also applies to requests from Automation and AI feed synchronization, which use the asynchronous mechanism.\n\nThe request body can't exceed 256KB.\n\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permissions required (at least one):** `CATALOGS_ITEM_BATCH_CREATE`, `CATALOGS_ITEM_BATCH_CATALOG_CREATE`\n\n**User role permission required:** `assets_catalogs: create`\n","type":"text/plain"},"url":{"path":["catalogs","v1","async","bags",":catalogId","item"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"5612","key":"catalogId","description":"(Required) ID of the catalog"}]},"header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"itemKey\": \"sku1357\",\n \"value\": {\n \"itemCategory\": \"smartphone\",\n \"itemColor\": \"blue\"\n }\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"adad88fa-1b65-48c2-a6fa-9bbfce2607bb","name":"Operation added to queue","originalRequest":{"url":{"path":["catalogs","v1","async","bags",":catalogId","item"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"5612","key":"catalogId","description":"(Required) ID of the catalog"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"POST","body":{"mode":"raw","raw":"{\n \"itemKey\": \"sku1357\",\n \"value\": {\n \"itemCategory\": \"smartphone\",\n \"itemColor\": \"blue\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"No Content","code":204,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"eb8f1eca-2890-48a8-ab1e-0a4b8c468964","name":"Add or update (partial) item asynchronously","request":{"name":"Add or update (partial) item asynchronously","description":{"content":"Update a single item asynchronously to the catalog. If the item doesn't exist, it will be created.\n\nThis endpoint allows you to perform partial updates - you can send only the properties that you want to add/modify, instead of sending the entire item.\n\nAsynchronous requests are processed according to the time they reach the service. \nThis means that requests to synchronous endpoints (for example, [`/bags/{catalogId}/items/{itemId}`](#operation/updateItem) may overwrite asynchronous operations which were sent earlier and queued due to high traffic. \nThis behavior also applies to requests from Automation and AI feed synchronization, which use the asynchronous mechanism.\n\nThe request body can't exceed 256KB.\n\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permissions required (at least one):** `CATALOGS_ITEM_BATCH_UPDATE`, `CATALOGS_ITEM_BATCH_CATALOG_UPDATE`\n\n**User role permission required:** `assets_catalogs: update`\n","type":"text/plain"},"url":{"path":["catalogs","v1","async","bags",":catalogId","item"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"5612","key":"catalogId","description":"(Required) ID of the catalog"}]},"header":[{"key":"Content-Type","value":"application/json"}],"method":"PATCH","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"itemKey\": \"sku1357\",\n \"value\": {\n \"itemCategory\": \"smartphone\",\n \"itemColor\": \"blue\"\n }\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"af3dedd8-e4f6-4596-876f-8bbf1a1e8509","name":"Operation added to queue","originalRequest":{"url":{"path":["catalogs","v1","async","bags",":catalogId","item"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"5612","key":"catalogId","description":"(Required) ID of the catalog"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"PATCH","body":{"mode":"raw","raw":"{\n \"itemKey\": \"sku1357\",\n \"value\": {\n \"itemCategory\": \"smartphone\",\n \"itemColor\": \"blue\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"No Content","code":204,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"8f5d9c9f-6f89-457d-940f-c7e5a35ee7a3","name":"Batch add or update items asynchronously","request":{"name":"Batch add or update items asynchronously","description":{"content":"Add a number of items asynchronously at once. If an item already exists, it's entirely overwritten by the item you send.\n\nAsynchronous requests are processed according to the time they reach the service. \nThis means that requests to synchronous endpoints (for example, [`/bags/{catalogId}/items/{itemId}`](#operation/updateItem) may overwrite asynchronous operations which were sent earlier and queued due to high traffic. \nThis behavior also applies to requests from Automation and AI feed synchronization, which use the asynchronous mechanism.\n\nThe request body can't exceed 256KB.\n\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permissions required (at least one):** `CATALOGS_ITEM_BATCH_CREATE`, `CATALOGS_ITEM_BATCH_CATALOG_CREATE`\n\n**User role permission required:** `assets_catalogs: create`\n","type":"text/plain"},"url":{"path":["catalogs","v1","async","bags",":catalogId","items"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"5612","key":"catalogId","description":"(Required) ID of the catalog"}]},"header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"[\n {\n \"itemKey\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n {\n \"itemKey\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n }\n]","options":{"raw":{"language":"json"}}}},"response":[{"id":"3494b8ee-0642-4789-ada5-0a91851134bc","name":"Operation added to queue","originalRequest":{"url":{"path":["catalogs","v1","async","bags",":catalogId","items"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"5612","key":"catalogId","description":"(Required) ID of the catalog"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"POST","body":{"mode":"raw","raw":"[\n {\n \"itemKey\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n {\n \"itemKey\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n }\n]","options":{"raw":{"language":"json"}}}},"status":"No Content","code":204,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"f6fd4dcc-d6e4-40f9-9541-fdef1387840e","name":"Batch add or update (partial) items asynchronously","request":{"name":"Batch add or update (partial) items asynchronously","description":{"content":"Update a number of items asynchronously at once. If an item doesn't exist, it will be created.\n\nThis endpoint allows you to perform partial updates - you can send only the properties that you want to add/modify, instead of sending the entire item.\n\nAsynchronous requests are processed according to the time they reach the service. \nThis means that requests to synchronous endpoints (for example, [`/bags/{catalogId}/items/{itemId}`](#operation/updateItem) may overwrite asynchronous operations which were sent earlier and queued due to high traffic. \nThis behavior also applies to requests from Automation and AI feed synchronization, which use the asynchronous mechanism.\n\nThe request body can't exceed 256KB.\n\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permissions required (at least one):** `CATALOGS_ITEM_BATCH_UPDATE`, `CATALOGS_ITEM_BATCH_CATALOG_UPDATE`\n\n**User role permission required:** `assets_catalogs: update`\n","type":"text/plain"},"url":{"path":["catalogs","v1","async","bags",":catalogId","items"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"5612","key":"catalogId","description":"(Required) ID of the catalog"}]},"header":[{"key":"Content-Type","value":"application/json"}],"method":"PATCH","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"[\n {\n \"itemKey\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n {\n \"itemKey\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n }\n]","options":{"raw":{"language":"json"}}}},"response":[{"id":"0f8f98aa-6b97-4301-a47e-858a3e304a7a","name":"Operation added to queue","originalRequest":{"url":{"path":["catalogs","v1","async","bags",":catalogId","items"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"5612","key":"catalogId","description":"(Required) ID of the catalog"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"PATCH","body":{"mode":"raw","raw":"[\n {\n \"itemKey\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n {\n \"itemKey\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n }\n]","options":{"raw":{"language":"json"}}}},"status":"No Content","code":204,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}],"event":[]},{"id":"e9548835-a4d1-48f4-9657-dd07054cd0f6","name":"Asset tags","description":{"content":"","type":"text/plain"},"item":[{"id":"437183ad-8db0-4f3d-8331-78d7c9e2c41c","name":"Get all directories","request":{"name":"Get all directories","description":{"content":"Gets all tag directories from the Workspace.\n\n---\n\n**API consumers:** Synerise User, Profile (Client), Workspace (Business Profile)\n\n**API key permission required:** `TAGS_COLLECTOR_DIRECTORY_READ`\n\n**User role permission required:** `assets_tags: read`\n","type":"text/plain"},"url":{"path":["tags-collector","directories"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":null},"response":[{"id":"3332d2f5-770c-4a4d-80a3-8e25136e2cb8","name":"OK","originalRequest":{"url":{"path":["tags-collector","directories"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"[\n {\n \"createdAt\": {\n \"value\": \"\"\n },\n \"hash\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"params\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n }\n },\n {\n \"createdAt\": {\n \"value\": \"\"\n },\n \"hash\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"params\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n }\n }\n]","cookie":[],"_postman_previewlanguage":"json"},{"id":"59dede04-e3e0-4a10-a986-56f3902263ff","name":"Unauthorized","originalRequest":{"url":{"path":["tags-collector","directories"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"method":"GET","body":{}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"d48897d8-c937-4c3b-8562-a6ab57eb0c3c","name":"Forbidden","originalRequest":{"url":{"path":["tags-collector","directories"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"method":"GET","body":{}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"d7dd52c1-4b4c-4c3b-b87c-6b27984b08dd","name":"Create directory","request":{"name":"Create directory","description":{"content":"Creates a directory.\n\n---\n\n**API consumers:** Synerise User, Profile (Client), Workspace (Business Profile)\n\n**API key permission required:** `TAGS_COLLECTOR_DIRECTORY_CREATE`\n\n**User role permission required:** `assets_tags: create`\n","type":"text/plain"},"url":{"path":["tags-collector","directories"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":null,"body":{"mode":"raw","raw":"{\n \"name\": \"string\",\n \"params\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n },\n \"key_2\": {\n \"value\": \"\"\n }\n },\n \"type\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"55dddace-948a-4ea5-9b62-e8afa017cf42","name":"Created","originalRequest":{"url":{"path":["tags-collector","directories"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"name\": \"string\",\n \"params\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n },\n \"key_2\": {\n \"value\": \"\"\n }\n },\n \"type\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Created","code":201,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"createdAt\": \"2002-08-18T04:26:47.611Z\",\n \"hash\": \"string\",\n \"name\": \"string\",\n \"params\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n }\n },\n \"type\": {\n \"createdAt\": {\n \"value\": \"\"\n },\n \"hash\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"63613899-0360-4283-bc9f-1768e5ed4986","name":"Unauthorized","originalRequest":{"url":{"path":["tags-collector","directories"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"method":"POST","body":{"mode":"raw","raw":"{\n \"name\": \"string\",\n \"params\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n },\n \"key_2\": {\n \"value\": \"\"\n }\n },\n \"type\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"60a78dc6-d62d-4c28-a34c-c329bd81b766","name":"Forbidden","originalRequest":{"url":{"path":["tags-collector","directories"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"method":"POST","body":{"mode":"raw","raw":"{\n \"name\": \"string\",\n \"params\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n },\n \"key_2\": {\n \"value\": \"\"\n }\n },\n \"type\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"03dcf7d8-b31f-4eeb-ba7f-fcb14a0a1e46","name":"Not Found","originalRequest":{"url":{"path":["tags-collector","directories"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"method":"POST","body":{"mode":"raw","raw":"{\n \"name\": \"string\",\n \"params\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n },\n \"key_2\": {\n \"value\": \"\"\n }\n },\n \"type\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"56c08533-f4ce-463d-ac8e-93c644b12388","name":"Get directory types","request":{"name":"Get directory types","description":{"content":"Gets all directory types.\n\n---\n\n**API consumers:** Synerise User, Profile (Client), Workspace (Business Profile)\n\n**API key permission required:** `TAGS_COLLECTOR_DIRECTORY_READ`\n\n**User role permission required:** `assets_tags: read`\n","type":"text/plain"},"url":{"path":["tags-collector","directories","types"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":null},"response":[{"id":"29b6915f-5c36-4812-882d-a1e1e08afa3b","name":"OK","originalRequest":{"url":{"path":["tags-collector","directories","types"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"[\n {\n \"createdAt\": {\n \"value\": \"\"\n },\n \"hash\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n },\n {\n \"createdAt\": {\n \"value\": \"\"\n },\n \"hash\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n }\n]","cookie":[],"_postman_previewlanguage":"json"},{"id":"7baf502f-8f11-44c2-aa74-4826d3c2fdc3","name":"Unauthorized","originalRequest":{"url":{"path":["tags-collector","directories","types"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"method":"GET","body":{}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"30e403e3-c216-42c0-9dab-9813288b4520","name":"Forbidden","originalRequest":{"url":{"path":["tags-collector","directories","types"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"method":"GET","body":{}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"c840f76f-11d9-41af-a4fc-efbc44a8c163","name":"Not Found","originalRequest":{"url":{"path":["tags-collector","directories","types"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"method":"GET","body":{}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"9eccc399-9168-4c69-aa30-3baa77d02db0","name":"Create directory type","request":{"name":"Create directory type","description":{"content":"Creates a directory type.\n\n---\n\n**API consumers:** Synerise User, Profile (Client), Workspace (Business Profile)\n\n**API key permission required:** `TAGS_COLLECTOR_DIRECTORY_UPDATE`\n\n**User role permission required:** `assets_tags: update`\n","type":"text/plain"},"url":{"path":["tags-collector","directories","types"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":null,"body":{"mode":"raw","raw":"{\n \"name\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"2ebd33cf-db2c-4993-92cf-bd7fd7fa1f2e","name":"Created","originalRequest":{"url":{"path":["tags-collector","directories","types"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"name\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Created","code":201,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"createdAt\": \"1984-09-26T01:11:16.189Z\",\n \"hash\": \"string\",\n \"name\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"db6329a0-84a2-4a62-9d6e-f2bd0fcbbb35","name":"Unauthorized","originalRequest":{"url":{"path":["tags-collector","directories","types"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"method":"POST","body":{"mode":"raw","raw":"{\n \"name\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"be20d5a1-f298-4376-ad9e-01331b6d2162","name":"Forbidden","originalRequest":{"url":{"path":["tags-collector","directories","types"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"method":"POST","body":{"mode":"raw","raw":"{\n \"name\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"8cf42b78-6261-4afd-a81e-7701d67e58e7","name":"Not Found","originalRequest":{"url":{"path":["tags-collector","directories","types"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"method":"POST","body":{"mode":"raw","raw":"{\n \"name\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"fc085c79-3aad-4138-9b7b-0edf96375477","name":"Delete directory","request":{"name":"Delete directory","description":{"content":"Deletes a directory.\n\n---\n\n**API consumers:** Synerise User, Profile (Client), Workspace (Business Profile)\n\n**API key permission required:** `TAGS_COLLECTOR_DIRECTORY_DELETE`\n\n**User role permission required:** `assets_tags: delete`\n","type":"text/plain"},"url":{"path":["tags-collector","directories",":directoryHash"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"directoryHash","description":"(Required) Hash ID of the directory"}]},"method":"DELETE","auth":null},"response":[{"id":"401afefc-1728-4c4d-a0d9-fba993befe91","name":"OK","originalRequest":{"url":{"path":["tags-collector","directories",":directoryHash"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"directoryHash","description":"(Required) Hash ID of the directory"}]},"method":"DELETE","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"fbcbdde2-16cf-4d9f-af43-d7bf1c32fb33","name":"No Content","originalRequest":{"url":{"path":["tags-collector","directories",":directoryHash"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"directoryHash","description":"(Required) Hash ID of the directory"}]},"method":"DELETE","body":{}},"status":"No Content","code":204,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"24471992-2568-4825-9193-105b8541eefd","name":"Unauthorized","originalRequest":{"url":{"path":["tags-collector","directories",":directoryHash"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"directoryHash","description":"(Required) Hash ID of the directory"}]},"method":"DELETE","body":{}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"23037549-7d9d-4025-be76-365a6588b7e0","name":"Forbidden","originalRequest":{"url":{"path":["tags-collector","directories",":directoryHash"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"directoryHash","description":"(Required) Hash ID of the directory"}]},"method":"DELETE","body":{}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"45cf856a-7b35-484a-aadc-3e69d4a3b802","name":"Update directory","request":{"name":"Update directory","description":{"content":"Updates a directory.\n\n---\n\n**API consumers:** Synerise User, Profile (Client), Workspace (Business Profile)\n\n**API key permission required:** `TAGS_COLLECTOR_DIRECTORY_UPDATE`\n\n**User role permission required:** `assets_tags: update`\n","type":"text/plain"},"url":{"path":["tags-collector","directories",":directoryHash"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"directoryHash","description":"(Required) Hash ID of the directory"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PATCH","auth":null,"body":{"mode":"raw","raw":"{\n \"name\": \"string\",\n \"params\": {\n \"key_0\": {\n \"value\": \"\"\n }\n }\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"d6fd8197-0aeb-487d-8cc1-46c3f0c2c46e","name":"OK","originalRequest":{"url":{"path":["tags-collector","directories",":directoryHash"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"directoryHash","description":"(Required) Hash ID of the directory"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"{\n \"name\": \"string\",\n \"params\": {\n \"key_0\": {\n \"value\": \"\"\n }\n }\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"createdAt\": \"2002-08-18T04:26:47.611Z\",\n \"hash\": \"string\",\n \"name\": \"string\",\n \"params\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n }\n },\n \"type\": {\n \"createdAt\": {\n \"value\": \"\"\n },\n \"hash\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"c9433520-79b2-4a01-b1b4-e4a12c00486f","name":"No Content","originalRequest":{"url":{"path":["tags-collector","directories",":directoryHash"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"directoryHash","description":"(Required) Hash ID of the directory"}]},"method":"PATCH","body":{"mode":"raw","raw":"{\n \"name\": \"string\",\n \"params\": {\n \"key_0\": {\n \"value\": \"\"\n }\n }\n}","options":{"raw":{"language":"json"}}}},"status":"No Content","code":204,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"ced12dc1-9f83-4d1c-a83b-529b9cca989e","name":"Unauthorized","originalRequest":{"url":{"path":["tags-collector","directories",":directoryHash"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"directoryHash","description":"(Required) Hash ID of the directory"}]},"method":"PATCH","body":{"mode":"raw","raw":"{\n \"name\": \"string\",\n \"params\": {\n \"key_0\": {\n \"value\": \"\"\n }\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"7d43f86d-f023-4437-9991-ca051d565fde","name":"Forbidden","originalRequest":{"url":{"path":["tags-collector","directories",":directoryHash"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"directoryHash","description":"(Required) Hash ID of the directory"}]},"method":"PATCH","body":{"mode":"raw","raw":"{\n \"name\": \"string\",\n \"params\": {\n \"key_0\": {\n \"value\": \"\"\n }\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"5338a761-e588-4925-99a3-e0cbc99336c4","name":"Get tags from directory","request":{"name":"Get tags from directory","description":{"content":"Retrieve tags from a directory.\n\n---\n\n**API consumers:** Synerise User, Profile (Client), Workspace (Business Profile)\n\n**API key permission required:** `TAGS_COLLECTOR_DIRECTORY_READ`\n\n**User role permission required:** `assets_tags: read`\n","type":"text/plain"},"url":{"path":["tags-collector","directories",":directoryHash","tags"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"directoryHash","description":"(Required) Hash ID of the directory"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":null},"response":[{"id":"02a05028-8bde-4e33-ae61-749737195348","name":"OK","originalRequest":{"url":{"path":["tags-collector","directories",":directoryHash","tags"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"directoryHash","description":"(Required) Hash ID of the directory"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"[\n {\n \"authorId\": {\n \"value\": \"\"\n },\n \"color\": {\n \"value\": \"\"\n },\n \"createdAt\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n },\n \"directory\": {\n \"value\": \"\"\n },\n \"hash\": {\n \"value\": \"\"\n },\n \"icon\": {\n \"value\": \"\"\n },\n \"priority\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n {\n \"authorId\": {\n \"value\": \"\"\n },\n \"color\": {\n \"value\": \"\"\n },\n \"createdAt\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n },\n \"directory\": {\n \"value\": \"\"\n },\n \"hash\": {\n \"value\": \"\"\n },\n \"icon\": {\n \"value\": \"\"\n },\n \"priority\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n }\n]","cookie":[],"_postman_previewlanguage":"json"},{"id":"e87512ff-83d3-4c5f-be46-f4f7e3187391","name":"Unauthorized","originalRequest":{"url":{"path":["tags-collector","directories",":directoryHash","tags"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"directoryHash","description":"(Required) Hash ID of the directory"}]},"method":"GET","body":{}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"987d7b3f-7017-4d43-8bca-73cc0f5fac02","name":"Forbidden","originalRequest":{"url":{"path":["tags-collector","directories",":directoryHash","tags"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"directoryHash","description":"(Required) Hash ID of the directory"}]},"method":"GET","body":{}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"8711813b-79a6-456f-8a9b-4b75455c5bee","name":"Not Found","originalRequest":{"url":{"path":["tags-collector","directories",":directoryHash","tags"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"directoryHash","description":"(Required) Hash ID of the directory"}]},"method":"GET","body":{}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"c7c4f34b-f2a7-4e94-a08a-1aaa914ebf70","name":"Assign tags to directory","request":{"name":"Assign tags to directory","description":{"content":"Assign tags to a directory.\n\n---\n\n**API consumers:** Synerise User, Profile (Client), Workspace (Business Profile)\n\n**API key permission required:** `TAGS_COLLECTOR_DIRECTORY_UPDATE`\n\n**User role permission required:** `assets_tags: update`\n","type":"text/plain"},"url":{"path":["tags-collector","directories",":directoryHash","tags"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"directoryHash","description":"(Required) Hash ID of the directory"}]},"header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","auth":null,"body":{"mode":"raw","raw":"[\n \"string\",\n \"string\"\n]","options":{"raw":{"language":"json"}}}},"response":[{"id":"3c22f2c5-99fa-49af-a57d-a368a7bf1434","name":"OK","originalRequest":{"url":{"path":["tags-collector","directories",":directoryHash","tags"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"directoryHash","description":"(Required) Hash ID of the directory"}]},"method":"POST","body":{"mode":"raw","raw":"[\n \"string\",\n \"string\"\n]","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"53dcc40c-c9c3-405e-bfea-dab1d34a6840","name":"Created","originalRequest":{"url":{"path":["tags-collector","directories",":directoryHash","tags"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"directoryHash","description":"(Required) Hash ID of the directory"}]},"method":"POST","body":{"mode":"raw","raw":"[\n \"string\",\n \"string\"\n]","options":{"raw":{"language":"json"}}}},"status":"Created","code":201,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"d73c4476-fc43-4019-8f64-9bca44f5d52a","name":"Unauthorized","originalRequest":{"url":{"path":["tags-collector","directories",":directoryHash","tags"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"directoryHash","description":"(Required) Hash ID of the directory"}]},"method":"POST","body":{"mode":"raw","raw":"[\n \"string\",\n \"string\"\n]","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"375b3d93-bb63-4653-85f0-987ea247c505","name":"Forbidden","originalRequest":{"url":{"path":["tags-collector","directories",":directoryHash","tags"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"directoryHash","description":"(Required) Hash ID of the directory"}]},"method":"POST","body":{"mode":"raw","raw":"[\n \"string\",\n \"string\"\n]","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"c5453ad7-ca9e-4e08-b918-991f3bbef73a","name":"Not Found","originalRequest":{"url":{"path":["tags-collector","directories",":directoryHash","tags"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"directoryHash","description":"(Required) Hash ID of the directory"}]},"method":"POST","body":{"mode":"raw","raw":"[\n \"string\",\n \"string\"\n]","options":{"raw":{"language":"json"}}}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"ac06336d-3cc1-4c29-b22c-9d4f59651e26","name":"Unassign tags from directory","request":{"name":"Unassign tags from directory","description":{"content":"Unassign tags from a directory. This does not delete the tags or the directory.\n\n---\n\n**API consumers:** Synerise User, Profile (Client), Workspace (Business Profile)\n\n**API key permission required:** `TAGS_COLLECTOR_DIRECTORY_DELETE`\n\n**User role permission required:** `assets_tags: delete`\n","type":"text/plain"},"url":{"path":["tags-collector","directories",":directoryHash","tags"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"directoryHash","description":"(Required) Hash ID of the directory"}]},"header":[{"key":"Content-Type","value":"application/json"}],"method":"DELETE","auth":null,"body":{"mode":"raw","raw":"[\n \"string\",\n \"string\"\n]","options":{"raw":{"language":"json"}}}},"response":[{"id":"ea3c544a-bb3d-41f6-9c67-9fb84e97746e","name":"OK","originalRequest":{"url":{"path":["tags-collector","directories",":directoryHash","tags"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"directoryHash","description":"(Required) Hash ID of the directory"}]},"method":"DELETE","body":{"mode":"raw","raw":"[\n \"string\",\n \"string\"\n]","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"b9f6ddfa-742f-4d7b-9ffa-294b491fe3dc","name":"No Content","originalRequest":{"url":{"path":["tags-collector","directories",":directoryHash","tags"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"directoryHash","description":"(Required) Hash ID of the directory"}]},"method":"DELETE","body":{"mode":"raw","raw":"[\n \"string\",\n \"string\"\n]","options":{"raw":{"language":"json"}}}},"status":"No Content","code":204,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"6349bab4-df03-4bfb-8b2b-e2e28fbf1384","name":"Unauthorized","originalRequest":{"url":{"path":["tags-collector","directories",":directoryHash","tags"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"directoryHash","description":"(Required) Hash ID of the directory"}]},"method":"DELETE","body":{"mode":"raw","raw":"[\n \"string\",\n \"string\"\n]","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"76a062e1-2a3b-4f50-abf5-b435b6cd479a","name":"Forbidden","originalRequest":{"url":{"path":["tags-collector","directories",":directoryHash","tags"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"directoryHash","description":"(Required) Hash ID of the directory"}]},"method":"DELETE","body":{"mode":"raw","raw":"[\n \"string\",\n \"string\"\n]","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"1db9fce9-5c64-4ecc-81a1-6662c7e4ca12","name":"Update directory type","request":{"name":"Update directory type","description":{"content":"Update the type of a directory.\n\n---\n\n**API consumers:** Synerise User, Profile (Client), Workspace (Business Profile)\n\n**API key permission required:** `TAGS_COLLECTOR_DIRECTORY_UPDATE`\n\n**User role permission required:** `assets_tags: update`\n","type":"text/plain"},"url":{"path":["tags-collector","directories",":directoryHash","types"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"directoryHash","description":"(Required) Hash ID of the directory"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PUT","auth":null,"body":{"mode":"raw","raw":"{\n \"directoryTypeHash\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"0fdd7c9d-c65f-4700-8480-480aa83ab6bb","name":"OK","originalRequest":{"url":{"path":["tags-collector","directories",":directoryHash","types"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"directoryHash","description":"(Required) Hash ID of the directory"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"{\n \"directoryTypeHash\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"createdAt\": \"2002-08-18T04:26:47.611Z\",\n \"hash\": \"string\",\n \"name\": \"string\",\n \"params\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n }\n },\n \"type\": {\n \"createdAt\": {\n \"value\": \"\"\n },\n \"hash\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"453d3541-e4db-4ea5-968f-cd7b6cbc3372","name":"Created","originalRequest":{"url":{"path":["tags-collector","directories",":directoryHash","types"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"directoryHash","description":"(Required) Hash ID of the directory"}]},"method":"PUT","body":{"mode":"raw","raw":"{\n \"directoryTypeHash\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Created","code":201,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"8ae13314-546c-4778-a0be-b490220da2b4","name":"Unauthorized","originalRequest":{"url":{"path":["tags-collector","directories",":directoryHash","types"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"directoryHash","description":"(Required) Hash ID of the directory"}]},"method":"PUT","body":{"mode":"raw","raw":"{\n \"directoryTypeHash\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"c6d7280c-5bdc-4617-a5a6-41fe673b042f","name":"Forbidden","originalRequest":{"url":{"path":["tags-collector","directories",":directoryHash","types"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"directoryHash","description":"(Required) Hash ID of the directory"}]},"method":"PUT","body":{"mode":"raw","raw":"{\n \"directoryTypeHash\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"e1d112f1-65f7-4e4a-b2fe-530323a725b4","name":"Not Found","originalRequest":{"url":{"path":["tags-collector","directories",":directoryHash","types"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"directoryHash","description":"(Required) Hash ID of the directory"}]},"method":"PUT","body":{"mode":"raw","raw":"{\n \"directoryTypeHash\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"8eaf00ee-6577-4e3d-b663-f064b25e61e1","name":"Get tag list","request":{"name":"Get tag list","description":{"content":"Gets a paginated list of tags that can be assigned to assets, for example promotions.\n\n---\n\n**API consumers:** Synerise User, Profile (Client), Workspace (Business Profile)\n\n**API key permission required:** `TAGS_COLLECTOR_TAG_READ`\n\n**User role permission required:** `assets_tags: read`\n","type":"text/plain"},"url":{"path":["tags-collector","tags"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"page","value":"0","description":"Page to retrieve"},{"disabled":false,"key":"size","value":"10","description":"Limit of items per page"},{"disabled":false,"key":"directoryType","value":"string","description":"Directory type"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":null},"response":[{"id":"78b2c2d3-e4fc-4f0c-a3ec-c0eec539ea88","name":"OK","originalRequest":{"url":{"path":["tags-collector","tags"],"host":["{{baseUrl}}"],"query":[{"key":"page","value":"0"},{"key":"size","value":"10"},{"key":"directoryType","value":"string"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"data\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"pagination\": {\n \"limit\": {\n \"value\": \"\"\n },\n \"page\": {\n \"value\": \"\"\n },\n \"pages\": {\n \"value\": \"\"\n },\n \"total\": {\n \"value\": \"\"\n }\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"52934795-908b-49d3-bf92-a3b3e9f1e84f","name":"Unauthorized","originalRequest":{"url":{"path":["tags-collector","tags"],"host":["{{baseUrl}}"],"query":[{"key":"page","value":"0"},{"key":"size","value":"10"},{"key":"directoryType","value":"string"}],"variable":[]},"method":"GET","body":{}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"9ce718eb-d997-4922-8572-ca75bfc9b08a","name":"Forbidden","originalRequest":{"url":{"path":["tags-collector","tags"],"host":["{{baseUrl}}"],"query":[{"key":"page","value":"0"},{"key":"size","value":"10"},{"key":"directoryType","value":"string"}],"variable":[]},"method":"GET","body":{}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"9ca186bb-bf29-496e-9924-15d05e752355","name":"Not Found","originalRequest":{"url":{"path":["tags-collector","tags"],"host":["{{baseUrl}}"],"query":[{"key":"page","value":"0"},{"key":"size","value":"10"},{"key":"directoryType","value":"string"}],"variable":[]},"method":"GET","body":{}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"4cadebac-4225-48b8-8845-9fd8c05e03fb","name":"Create tag","request":{"name":"Create tag","description":{"content":"Creates a tag that can be assigned to assets, for example promotions.\n\n---\n\n**API consumers:** Synerise User, Profile (Client), Workspace (Business Profile)\n\n**API key permission required:** `TAGS_COLLECTOR_TAG_CREATE`\n\n**User role permission required:** `assets_tags: create`\n","type":"text/plain"},"url":{"path":["tags-collector","tags"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":null,"body":{"mode":"raw","raw":"{\n \"value\": \"string\",\n \"priority\": 0,\n \"color\": \"string\",\n \"description\": \"string\",\n \"directory\": \"string\",\n \"icon\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"c1804ff0-1bc9-44d4-b012-76265ebb7fcf","name":"Created","originalRequest":{"url":{"path":["tags-collector","tags"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"value\": \"string\",\n \"priority\": 0,\n \"color\": \"string\",\n \"description\": \"string\",\n \"directory\": \"string\",\n \"icon\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Created","code":201,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"authorId\": 8251,\n \"color\": \"string\",\n \"createdAt\": \"1985-06-07T12:17:56.622Z\",\n \"description\": \"string\",\n \"directory\": {\n \"createdAt\": {\n \"value\": \"\"\n },\n \"hash\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"params\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n }\n },\n \"hash\": \"string\",\n \"icon\": \"string\",\n \"priority\": 0,\n \"value\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"437f5768-9188-414a-b6a9-d2f60d5b649f","name":"Unauthorized","originalRequest":{"url":{"path":["tags-collector","tags"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"method":"POST","body":{"mode":"raw","raw":"{\n \"value\": \"string\",\n \"priority\": 0,\n \"color\": \"string\",\n \"description\": \"string\",\n \"directory\": \"string\",\n \"icon\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"939dfe17-49c3-42b2-b5b8-0a7912c6f419","name":"Forbidden","originalRequest":{"url":{"path":["tags-collector","tags"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"method":"POST","body":{"mode":"raw","raw":"{\n \"value\": \"string\",\n \"priority\": 0,\n \"color\": \"string\",\n \"description\": \"string\",\n \"directory\": \"string\",\n \"icon\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"9ab51c42-301c-46bd-ae47-48ea0509bf3b","name":"Not Found","originalRequest":{"url":{"path":["tags-collector","tags"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"method":"POST","body":{"mode":"raw","raw":"{\n \"value\": \"string\",\n \"priority\": 0,\n \"color\": \"string\",\n \"description\": \"string\",\n \"directory\": \"string\",\n \"icon\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"bd729dc6-5b1e-468e-8bbe-22b621a08862","name":"Update tag","request":{"name":"Update tag","description":{"content":"Updates a tag definition.\n\n---\n\n**API consumers:** Synerise User, Profile (Client), Workspace (Business Profile)\n\n**API key permission required:** `TAGS_COLLECTOR_TAG_UPDATE`\n\n**User role permission required:** `assets_tags: update`\n","type":"text/plain"},"url":{"path":["tags-collector","tags",":tagHash"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"tagHash","description":"(Required) HashID of a tag"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PATCH","auth":null,"body":{"mode":"raw","raw":"{\n \"color\": \"string\",\n \"description\": \"string\",\n \"directory\": \"string\",\n \"icon\": \"string\",\n \"priority\": 0,\n \"value\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"8ed903a0-eede-45a1-b5ce-1942deeaa504","name":"OK","originalRequest":{"url":{"path":["tags-collector","tags",":tagHash"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"tagHash","description":"(Required) HashID of a tag"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"{\n \"color\": \"string\",\n \"description\": \"string\",\n \"directory\": \"string\",\n \"icon\": \"string\",\n \"priority\": 0,\n \"value\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"authorId\": 8251,\n \"color\": \"string\",\n \"createdAt\": \"1985-06-07T12:17:56.622Z\",\n \"description\": \"string\",\n \"directory\": {\n \"createdAt\": {\n \"value\": \"\"\n },\n \"hash\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"params\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n }\n },\n \"hash\": \"string\",\n \"icon\": \"string\",\n \"priority\": 0,\n \"value\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"b4d6388e-405d-4088-8a08-ea1326968465","name":"Unauthorized","originalRequest":{"url":{"path":["tags-collector","tags",":tagHash"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"tagHash","description":"(Required) HashID of a tag"}]},"method":"PATCH","body":{"mode":"raw","raw":"{\n \"color\": \"string\",\n \"description\": \"string\",\n \"directory\": \"string\",\n \"icon\": \"string\",\n \"priority\": 0,\n \"value\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"e59bc1eb-8fd1-402a-913d-147d6ec7d6fa","name":"Forbidden","originalRequest":{"url":{"path":["tags-collector","tags",":tagHash"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"tagHash","description":"(Required) HashID of a tag"}]},"method":"PATCH","body":{"mode":"raw","raw":"{\n \"color\": \"string\",\n \"description\": \"string\",\n \"directory\": \"string\",\n \"icon\": \"string\",\n \"priority\": 0,\n \"value\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}],"event":[]},{"id":"5c152650-d87f-4817-b795-248efb71c9af","name":"Tags","description":{"content":"","type":"text/plain"},"item":[{"id":"45c9d3de-6906-434c-8628-58b88d469439","name":"Get all tags","request":{"name":"Get all tags","description":{"content":"\nRetrieve all tags that can be assigned to profiles.\n\nThis endpoint is available from version 4.1.0\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `API_TAGS_CLIENT_READ`\n\n**User role permission required:** `client_tags: read`\n","type":"text/plain"},"url":{"path":["v4","clients","tags"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"8109aae6-8bc6-4c22-845c-6bcbdcb4dfeb","name":"A list of tags","originalRequest":{"url":{"path":["v4","clients","tags"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"[\n {\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"color\": {\n \"value\": \"\"\n }\n },\n {\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"color\": {\n \"value\": \"\"\n }\n }\n]","cookie":[],"_postman_previewlanguage":"json"},{"id":"19252dd6-bcd5-4807-b606-47e31ce3055f","name":"Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc.","originalRequest":{"url":{"path":["v4","clients","tags"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"Bad Request\",\n \"status\": 400,\n \"timestamp\": \"2020-10-29T13:08:16.235Z\",\n \"path\": \"/exampleEndpoint\",\n \"message\": \"Some fields did not pass validation\",\n \"errors\": [\n {\n \"code\": 120,\n \"field\": \"exampleField\",\n \"message\": \"120\",\n \"rejectedValue\": \"exampleValue\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"93c14863-8dc3-48cc-894d-bb3d4c30538e","name":"Forbidden; insufficient permissions (when PII protection is enabled, PII permissions are required in addition to the permissions listed in the method description)","originalRequest":{"url":{"path":["v4","clients","tags"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"2018-06-07T07:29:27.489+00:00\",\n \"status\": 403,\n \"error\": \"Forbidden\",\n \"message\": \"Forbidden\",\n \"path\": \"/path_of_the_endpoint\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"e0c059bb-abeb-46df-bb33-a9d8333c7846","name":"Create a tag","request":{"name":"Create a tag","description":{"content":"Create a new tag that can be assigned to profiles. If you try to create a tag that already exists, the response is the existing tag.\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User\n\n**API key permission required:** `API_TAGS_CREATE`\n\n**User role permission required:** `client_tags: create`\n","type":"text/plain"},"url":{"path":["v4","tags"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"name\": \"nice tag\",\n \"color\": \"#0768ff\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"d2893dd2-9bfa-4ca7-9d82-9742e35f2a5e","name":"Tag created","originalRequest":{"url":{"path":["v4","tags"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"name\": \"nice tag\",\n \"color\": \"#0768ff\"\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"businessProfileId\": 100005,\n \"id\": 645,\n \"name\": \"nice tag\",\n \"color\": \"#0768ff\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"0427335f-4a56-4809-871d-8429dbdce9f5","name":"Invalid or incomplete data","originalRequest":{"url":{"path":["v4","tags"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"name\": \"nice tag\",\n \"color\": \"#0768ff\"\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"Bad Request\",\n \"status\": 400,\n \"timestamp\": \"2020-10-29T11:02:25.939Z\",\n \"path\": \"/tags\",\n \"message\": \"Some fields did not pass validation\",\n \"errors\": [\n {\n \"code\": 16213,\n \"field\": \"name\",\n \"message\": \"Scripts are not allowed\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"36cc94d7-3d5e-4273-8bb6-19166c54c260","name":"Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc.","originalRequest":{"url":{"path":["v4","tags"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"name\": \"nice tag\",\n \"color\": \"#0768ff\"\n}","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"Bad Request\",\n \"status\": 400,\n \"timestamp\": \"2020-10-29T13:08:16.235Z\",\n \"path\": \"/exampleEndpoint\",\n \"message\": \"Some fields did not pass validation\",\n \"errors\": [\n {\n \"code\": 120,\n \"field\": \"exampleField\",\n \"message\": \"120\",\n \"rejectedValue\": \"exampleValue\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"4d1d43d0-cb1d-4ea4-88c0-3883b5b9a169","name":"Forbidden; insufficient permissions (when PII protection is enabled, PII permissions are required in addition to the permissions listed in the method description)","originalRequest":{"url":{"path":["v4","tags"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"name\": \"nice tag\",\n \"color\": \"#0768ff\"\n}","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"2018-06-07T07:29:27.489+00:00\",\n \"status\": 403,\n \"error\": \"Forbidden\",\n \"message\": \"Forbidden\",\n \"path\": \"/path_of_the_endpoint\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"8f7ba25d-d702-4187-9ddc-5326e2e8f437","name":"Unsupported Media Type","originalRequest":{"url":{"path":["v4","tags"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"name\": \"nice tag\",\n \"color\": \"#0768ff\"\n}","options":{"raw":{"language":"json"}}}},"status":"Unsupported Media Type","code":415,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"2018-06-07T07:27:23.136+00:00\",\n \"status\": 415,\n \"error\": \"Unsupported Media Type\",\n \"message\": \"Content type 'application/xml' not supported\",\n \"path\": \"/path_of_the_endpoint\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"2b0cd09f-d71e-46d9-a7c2-f23a926e0666","name":"Update a tag","request":{"name":"Update a tag","description":{"content":"Update a tag. This method currently only allows modifying the `color` field.\n\nIf the tag has been already deleted, the response is a 404 error.\n\n**Important**: This method doesn't update global tags (not related to any workspace). If you try to update a global tag, the response is a 404 error.\n\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User\n\n**API key permission required:** `API_TAGS_CREATE`\n\n**User role permission required:** `client_tags: create`\n","type":"text/plain"},"url":{"path":["v4","tags",":tagID"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"645","key":"tagID","description":"(Required) ID of the tag"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PUT","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"color\": \"#0768ff\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"13cbe921-4091-469e-9e10-f5e203d10e28","name":"Tag updated","originalRequest":{"url":{"path":["v4","tags",":tagID"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"645","key":"tagID","description":"(Required) ID of the tag"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"{\n \"color\": \"#0768ff\"\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"businessProfileId\": 100005,\n \"id\": 645,\n \"name\": \"nice tag\",\n \"color\": \"#0768ff\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"e8685280-d1f4-459e-8bc0-d4567fa002ce","name":"Invalid or incomplete data","originalRequest":{"url":{"path":["v4","tags",":tagID"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"645","key":"tagID","description":"(Required) ID of the tag"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"{\n \"color\": \"#0768ff\"\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\",\n \"status\": 2802,\n \"timestamp\": \"string\",\n \"path\": \"string\",\n \"message\": \"string\",\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"a3957343-e25d-4c2a-86a8-07de71ac5715","name":"Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc.","originalRequest":{"url":{"path":["v4","tags",":tagID"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"645","key":"tagID","description":"(Required) ID of the tag"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"{\n \"color\": \"#0768ff\"\n}","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"Bad Request\",\n \"status\": 400,\n \"timestamp\": \"2020-10-29T13:08:16.235Z\",\n \"path\": \"/exampleEndpoint\",\n \"message\": \"Some fields did not pass validation\",\n \"errors\": [\n {\n \"code\": 120,\n \"field\": \"exampleField\",\n \"message\": \"120\",\n \"rejectedValue\": \"exampleValue\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"b2c52099-4ccc-458b-937f-1a9b85c34b11","name":"Forbidden; insufficient permissions (when PII protection is enabled, PII permissions are required in addition to the permissions listed in the method description)","originalRequest":{"url":{"path":["v4","tags",":tagID"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"645","key":"tagID","description":"(Required) ID of the tag"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"{\n \"color\": \"#0768ff\"\n}","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"2018-06-07T07:29:27.489+00:00\",\n \"status\": 403,\n \"error\": \"Forbidden\",\n \"message\": \"Forbidden\",\n \"path\": \"/path_of_the_endpoint\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"fa3ce9c6-9ebf-42ba-b144-d78f12dc91f8","name":"Tag doesn't exist or it is a global tag (not related to any workspace).","originalRequest":{"url":{"path":["v4","tags",":tagID"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"645","key":"tagID","description":"(Required) ID of the tag"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"{\n \"color\": \"#0768ff\"\n}","options":{"raw":{"language":"json"}}}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\",\n \"status\": 2802,\n \"timestamp\": \"string\",\n \"path\": \"string\",\n \"message\": \"string\",\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"416849db-0c12-4899-a427-24e392deea9a","name":"Unsupported Media Type","originalRequest":{"url":{"path":["v4","tags",":tagID"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"645","key":"tagID","description":"(Required) ID of the tag"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"{\n \"color\": \"#0768ff\"\n}","options":{"raw":{"language":"json"}}}},"status":"Unsupported Media Type","code":415,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"2018-06-07T07:27:23.136+00:00\",\n \"status\": 415,\n \"error\": \"Unsupported Media Type\",\n \"message\": \"Content type 'application/xml' not supported\",\n \"path\": \"/path_of_the_endpoint\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"05938a2a-1f42-47bc-99f5-5d2ad653516e","name":"Remove a tag","request":{"name":"Remove a tag","description":{"content":"Remove a tag definition from the workspace.\n\nIf the tag has been already deleted, the response is a 404 error.\n\n**Important**: This method does not remove global tag (not related to any workspace). In this case, the response is a 404 error.\n\n**Note**: After removing a tag definition, the tag is still cached for a while. In that time, it is still possible for a while to remove or add this tag in profiles.\n\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User\n\n**API key permission required:** `API_TAGS_CREATE`\n\n**User role permission required:** `client_tags: create`\n","type":"text/plain"},"url":{"path":["v4","tags",":tagID"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"645","key":"tagID","description":"(Required) ID of the tag"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"e1fe4dee-83f8-4a2f-b960-374ed8e3b374","name":"Tag removed","originalRequest":{"url":{"path":["v4","tags",":tagID"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"645","key":"tagID","description":"(Required) ID of the tag"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"DELETE","body":{}},"status":"Accepted","code":202,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"56b966fe-c916-4498-acd2-67e1f2280c7e","name":"Invalid or incomplete data","originalRequest":{"url":{"path":["v4","tags",":tagID"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"645","key":"tagID","description":"(Required) ID of the tag"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\",\n \"status\": 2802,\n \"timestamp\": \"string\",\n \"path\": \"string\",\n \"message\": \"string\",\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"87847fc6-8d2d-4b71-861a-9bac2916825b","name":"Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc.","originalRequest":{"url":{"path":["v4","tags",":tagID"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"645","key":"tagID","description":"(Required) ID of the tag"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"Bad Request\",\n \"status\": 400,\n \"timestamp\": \"2020-10-29T13:08:16.235Z\",\n \"path\": \"/exampleEndpoint\",\n \"message\": \"Some fields did not pass validation\",\n \"errors\": [\n {\n \"code\": 120,\n \"field\": \"exampleField\",\n \"message\": \"120\",\n \"rejectedValue\": \"exampleValue\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"ab43a2fe-016e-46cc-94dc-5169e80ee64d","name":"Forbidden; insufficient permissions (when PII protection is enabled, PII permissions are required in addition to the permissions listed in the method description)","originalRequest":{"url":{"path":["v4","tags",":tagID"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"645","key":"tagID","description":"(Required) ID of the tag"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"2018-06-07T07:29:27.489+00:00\",\n \"status\": 403,\n \"error\": \"Forbidden\",\n \"message\": \"Forbidden\",\n \"path\": \"/path_of_the_endpoint\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"4f366ba4-143e-47c1-8f7f-4db7d6455bea","name":"Tag doesn't exist, was already deleted, or is a global tag (not related to any workspace).","originalRequest":{"url":{"path":["v4","tags",":tagID"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"645","key":"tagID","description":"(Required) ID of the tag"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\",\n \"status\": 2802,\n \"timestamp\": \"string\",\n \"path\": \"string\",\n \"message\": \"string\",\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"47aa1504-f450-413c-bf40-4ac863bc2704","name":"Unsupported Media Type","originalRequest":{"url":{"path":["v4","tags",":tagID"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"645","key":"tagID","description":"(Required) ID of the tag"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{}},"status":"Unsupported Media Type","code":415,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"2018-06-07T07:27:23.136+00:00\",\n \"status\": 415,\n \"error\": \"Unsupported Media Type\",\n \"message\": \"Content type 'application/xml' not supported\",\n \"path\": \"/path_of_the_endpoint\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"ba60564d-028a-4b95-b081-5a0373c51b94","name":"Get profile tags","request":{"name":"Get profile tags","description":{"content":"Retrieve a list of tags assigned to a profile.\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User\n\n**API key permission required:** `API_TAGS_READ`\n\n**User role permission required:** `client_tags: read`\n","type":"text/plain"},"url":{"path":["v4","clients",":clientId","tags"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"434428563","key":"clientId","description":"(Required) The ID of the profile\n\n**Upcoming breaking change (effective July 6, 2026):** Synerise is introducing changes to how user identifiers and UUIDs are handled. These changes may affect profiles with accented or diacritical characters in identifiers, profiles with leading or trailing whitespace in identifiers, and profiles with duplicate UUIDs. For details and recommended actions, see [Upcoming changes to identifier and UUID handling](https://hub.synerise.com/docs/settings/configuration/identifier-standardization/).\n"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"838a6c8f-e505-448f-bd36-78c97fb60ac8","name":"OK","originalRequest":{"url":{"path":["v4","clients",":clientId","tags"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"434428563","key":"clientId","description":"(Required) The ID of the profile\n\n**Upcoming breaking change (effective July 6, 2026):** Synerise is introducing changes to how user identifiers and UUIDs are handled. These changes may affect profiles with accented or diacritical characters in identifiers, profiles with leading or trailing whitespace in identifiers, and profiles with duplicate UUIDs. For details and recommended actions, see [Upcoming changes to identifier and UUID handling](https://hub.synerise.com/docs/settings/configuration/identifier-standardization/).\n"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"[\n {\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"color\": {\n \"value\": \"\"\n }\n },\n {\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"color\": {\n \"value\": \"\"\n }\n }\n]","cookie":[],"_postman_previewlanguage":"json"},{"id":"40f2f33d-798c-4700-9207-b52c19413ae8","name":"Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc.","originalRequest":{"url":{"path":["v4","clients",":clientId","tags"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"434428563","key":"clientId","description":"(Required) The ID of the profile\n\n**Upcoming breaking change (effective July 6, 2026):** Synerise is introducing changes to how user identifiers and UUIDs are handled. These changes may affect profiles with accented or diacritical characters in identifiers, profiles with leading or trailing whitespace in identifiers, and profiles with duplicate UUIDs. For details and recommended actions, see [Upcoming changes to identifier and UUID handling](https://hub.synerise.com/docs/settings/configuration/identifier-standardization/).\n"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"Bad Request\",\n \"status\": 400,\n \"timestamp\": \"2020-10-29T13:08:16.235Z\",\n \"path\": \"/exampleEndpoint\",\n \"message\": \"Some fields did not pass validation\",\n \"errors\": [\n {\n \"code\": 120,\n \"field\": \"exampleField\",\n \"message\": \"120\",\n \"rejectedValue\": \"exampleValue\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"c10839d7-6a91-426b-b510-5c8e8984bd6d","name":"Forbidden; insufficient permissions (when PII protection is enabled, PII permissions are required in addition to the permissions listed in the method description)","originalRequest":{"url":{"path":["v4","clients",":clientId","tags"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"434428563","key":"clientId","description":"(Required) The ID of the profile\n\n**Upcoming breaking change (effective July 6, 2026):** Synerise is introducing changes to how user identifiers and UUIDs are handled. These changes may affect profiles with accented or diacritical characters in identifiers, profiles with leading or trailing whitespace in identifiers, and profiles with duplicate UUIDs. For details and recommended actions, see [Upcoming changes to identifier and UUID handling](https://hub.synerise.com/docs/settings/configuration/identifier-standardization/).\n"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"2018-06-07T07:29:27.489+00:00\",\n \"status\": 403,\n \"error\": \"Forbidden\",\n \"message\": \"Forbidden\",\n \"path\": \"/path_of_the_endpoint\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"d543acf1-a510-49f2-828b-0c4cdd7e2023","name":"Assign tag to profile","request":{"name":"Assign tag to profile","description":{"content":"Assign a tag to a profile.\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User\n\n**API key permission required:** `API_ASSIGN_TAGS_EXECUTE`\n\n**User role permission required:** `client_tags: execute`\n","type":"text/plain"},"url":{"path":["v4","clients",":clientId","tags",":tagID"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"434428563","key":"clientId","description":"(Required) The ID of the profile\n\n**Upcoming breaking change (effective July 6, 2026):** Synerise is introducing changes to how user identifiers and UUIDs are handled. These changes may affect profiles with accented or diacritical characters in identifiers, profiles with leading or trailing whitespace in identifiers, and profiles with duplicate UUIDs. For details and recommended actions, see [Upcoming changes to identifier and UUID handling](https://hub.synerise.com/docs/settings/configuration/identifier-standardization/).\n"},{"disabled":false,"type":"any","value":"645","key":"tagID","description":"(Required) ID of the tag"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","auth":null},"response":[{"id":"620a684d-560a-4465-9c2e-1f687f1176a0","name":"Tag assigned","originalRequest":{"url":{"path":["v4","clients",":clientId","tags",":tagID"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"434428563","key":"clientId","description":"(Required) The ID of the profile\n\n**Upcoming breaking change (effective July 6, 2026):** Synerise is introducing changes to how user identifiers and UUIDs are handled. These changes may affect profiles with accented or diacritical characters in identifiers, profiles with leading or trailing whitespace in identifiers, and profiles with duplicate UUIDs. For details and recommended actions, see [Upcoming changes to identifier and UUID handling](https://hub.synerise.com/docs/settings/configuration/identifier-standardization/).\n"},{"disabled":false,"type":"any","value":"645","key":"tagID","description":"(Required) ID of the tag"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"clientId\": 433230297,\n \"id\": 73,\n \"tagId\": 645\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"c33610c1-de4c-4173-9db8-b2407063a47e","name":"Profile not found or data malformed","originalRequest":{"url":{"path":["v4","clients",":clientId","tags",":tagID"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"434428563","key":"clientId","description":"(Required) The ID of the profile\n\n**Upcoming breaking change (effective July 6, 2026):** Synerise is introducing changes to how user identifiers and UUIDs are handled. These changes may affect profiles with accented or diacritical characters in identifiers, profiles with leading or trailing whitespace in identifiers, and profiles with duplicate UUIDs. For details and recommended actions, see [Upcoming changes to identifier and UUID handling](https://hub.synerise.com/docs/settings/configuration/identifier-standardization/).\n"},{"disabled":false,"type":"any","value":"645","key":"tagID","description":"(Required) ID of the tag"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\",\n \"status\": 2802,\n \"timestamp\": \"string\",\n \"path\": \"string\",\n \"message\": \"string\",\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"528053fd-9c6d-443d-94fc-f7127180df67","name":"Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc.","originalRequest":{"url":{"path":["v4","clients",":clientId","tags",":tagID"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"434428563","key":"clientId","description":"(Required) The ID of the profile\n\n**Upcoming breaking change (effective July 6, 2026):** Synerise is introducing changes to how user identifiers and UUIDs are handled. These changes may affect profiles with accented or diacritical characters in identifiers, profiles with leading or trailing whitespace in identifiers, and profiles with duplicate UUIDs. For details and recommended actions, see [Upcoming changes to identifier and UUID handling](https://hub.synerise.com/docs/settings/configuration/identifier-standardization/).\n"},{"disabled":false,"type":"any","value":"645","key":"tagID","description":"(Required) ID of the tag"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"Bad Request\",\n \"status\": 400,\n \"timestamp\": \"2020-10-29T13:08:16.235Z\",\n \"path\": \"/exampleEndpoint\",\n \"message\": \"Some fields did not pass validation\",\n \"errors\": [\n {\n \"code\": 120,\n \"field\": \"exampleField\",\n \"message\": \"120\",\n \"rejectedValue\": \"exampleValue\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"87a3f7b7-5bcd-4967-a98f-f704e970400c","name":"Forbidden; insufficient permissions (when PII protection is enabled, PII permissions are required in addition to the permissions listed in the method description)","originalRequest":{"url":{"path":["v4","clients",":clientId","tags",":tagID"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"434428563","key":"clientId","description":"(Required) The ID of the profile\n\n**Upcoming breaking change (effective July 6, 2026):** Synerise is introducing changes to how user identifiers and UUIDs are handled. These changes may affect profiles with accented or diacritical characters in identifiers, profiles with leading or trailing whitespace in identifiers, and profiles with duplicate UUIDs. For details and recommended actions, see [Upcoming changes to identifier and UUID handling](https://hub.synerise.com/docs/settings/configuration/identifier-standardization/).\n"},{"disabled":false,"type":"any","value":"645","key":"tagID","description":"(Required) ID of the tag"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"2018-06-07T07:29:27.489+00:00\",\n \"status\": 403,\n \"error\": \"Forbidden\",\n \"message\": \"Forbidden\",\n \"path\": \"/path_of_the_endpoint\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"7c204af3-f35e-4e3b-bce0-a33a814fe356","name":"Tag not found","originalRequest":{"url":{"path":["v4","clients",":clientId","tags",":tagID"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"434428563","key":"clientId","description":"(Required) The ID of the profile\n\n**Upcoming breaking change (effective July 6, 2026):** Synerise is introducing changes to how user identifiers and UUIDs are handled. These changes may affect profiles with accented or diacritical characters in identifiers, profiles with leading or trailing whitespace in identifiers, and profiles with duplicate UUIDs. For details and recommended actions, see [Upcoming changes to identifier and UUID handling](https://hub.synerise.com/docs/settings/configuration/identifier-standardization/).\n"},{"disabled":false,"type":"any","value":"645","key":"tagID","description":"(Required) ID of the tag"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\",\n \"status\": 2802,\n \"timestamp\": \"string\",\n \"path\": \"string\",\n \"message\": \"string\",\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"3cdaaa9e-11ed-47b0-ada5-b139da69e3af","name":"Unsupported Media Type","originalRequest":{"url":{"path":["v4","clients",":clientId","tags",":tagID"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"434428563","key":"clientId","description":"(Required) The ID of the profile\n\n**Upcoming breaking change (effective July 6, 2026):** Synerise is introducing changes to how user identifiers and UUIDs are handled. These changes may affect profiles with accented or diacritical characters in identifiers, profiles with leading or trailing whitespace in identifiers, and profiles with duplicate UUIDs. For details and recommended actions, see [Upcoming changes to identifier and UUID handling](https://hub.synerise.com/docs/settings/configuration/identifier-standardization/).\n"},{"disabled":false,"type":"any","value":"645","key":"tagID","description":"(Required) ID of the tag"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"Unsupported Media Type","code":415,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"2018-06-07T07:27:23.136+00:00\",\n \"status\": 415,\n \"error\": \"Unsupported Media Type\",\n \"message\": \"Content type 'application/xml' not supported\",\n \"path\": \"/path_of_the_endpoint\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"59db46ec-96e0-4715-a705-57c526082f3f","name":"Remove tag from profile","request":{"name":"Remove tag from profile","description":{"content":"\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User\n\n**API key permission required:** `API_ASSIGN_TAGS_EXECUTE`\n\n**User role permission required:** `client_tags: execute`\n","type":"text/plain"},"url":{"path":["v4","clients",":clientId","tags",":tagID"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"434428563","key":"clientId","description":"(Required) The ID of the profile\n\n**Upcoming breaking change (effective July 6, 2026):** Synerise is introducing changes to how user identifiers and UUIDs are handled. These changes may affect profiles with accented or diacritical characters in identifiers, profiles with leading or trailing whitespace in identifiers, and profiles with duplicate UUIDs. For details and recommended actions, see [Upcoming changes to identifier and UUID handling](https://hub.synerise.com/docs/settings/configuration/identifier-standardization/).\n"},{"disabled":false,"type":"any","value":"645","key":"tagID","description":"(Required) ID of the tag"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE","auth":null},"response":[{"id":"52395514-633f-4e7d-8ac0-8a5797b68e9d","name":"Tag removed","originalRequest":{"url":{"path":["v4","clients",":clientId","tags",":tagID"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"434428563","key":"clientId","description":"(Required) The ID of the profile\n\n**Upcoming breaking change (effective July 6, 2026):** Synerise is introducing changes to how user identifiers and UUIDs are handled. These changes may affect profiles with accented or diacritical characters in identifiers, profiles with leading or trailing whitespace in identifiers, and profiles with duplicate UUIDs. For details and recommended actions, see [Upcoming changes to identifier and UUID handling](https://hub.synerise.com/docs/settings/configuration/identifier-standardization/).\n"},{"disabled":false,"type":"any","value":"645","key":"tagID","description":"(Required) ID of the tag"}]},"method":"DELETE","body":{}},"status":"Accepted","code":202,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"d3948d20-4970-4b58-aca8-0bc87ab59c64","name":"Profile not found or data malformed","originalRequest":{"url":{"path":["v4","clients",":clientId","tags",":tagID"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"434428563","key":"clientId","description":"(Required) The ID of the profile\n\n**Upcoming breaking change (effective July 6, 2026):** Synerise is introducing changes to how user identifiers and UUIDs are handled. These changes may affect profiles with accented or diacritical characters in identifiers, profiles with leading or trailing whitespace in identifiers, and profiles with duplicate UUIDs. For details and recommended actions, see [Upcoming changes to identifier and UUID handling](https://hub.synerise.com/docs/settings/configuration/identifier-standardization/).\n"},{"disabled":false,"type":"any","value":"645","key":"tagID","description":"(Required) ID of the tag"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\",\n \"status\": 2802,\n \"timestamp\": \"string\",\n \"path\": \"string\",\n \"message\": \"string\",\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"d60fd867-904c-4a77-b336-24a8df9a1f0a","name":"Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc.","originalRequest":{"url":{"path":["v4","clients",":clientId","tags",":tagID"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"434428563","key":"clientId","description":"(Required) The ID of the profile\n\n**Upcoming breaking change (effective July 6, 2026):** Synerise is introducing changes to how user identifiers and UUIDs are handled. These changes may affect profiles with accented or diacritical characters in identifiers, profiles with leading or trailing whitespace in identifiers, and profiles with duplicate UUIDs. For details and recommended actions, see [Upcoming changes to identifier and UUID handling](https://hub.synerise.com/docs/settings/configuration/identifier-standardization/).\n"},{"disabled":false,"type":"any","value":"645","key":"tagID","description":"(Required) ID of the tag"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"Bad Request\",\n \"status\": 400,\n \"timestamp\": \"2020-10-29T13:08:16.235Z\",\n \"path\": \"/exampleEndpoint\",\n \"message\": \"Some fields did not pass validation\",\n \"errors\": [\n {\n \"code\": 120,\n \"field\": \"exampleField\",\n \"message\": \"120\",\n \"rejectedValue\": \"exampleValue\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"96d0079e-dffa-4584-a3a4-33bd790af1e1","name":"Forbidden; insufficient permissions (when PII protection is enabled, PII permissions are required in addition to the permissions listed in the method description)","originalRequest":{"url":{"path":["v4","clients",":clientId","tags",":tagID"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"434428563","key":"clientId","description":"(Required) The ID of the profile\n\n**Upcoming breaking change (effective July 6, 2026):** Synerise is introducing changes to how user identifiers and UUIDs are handled. These changes may affect profiles with accented or diacritical characters in identifiers, profiles with leading or trailing whitespace in identifiers, and profiles with duplicate UUIDs. For details and recommended actions, see [Upcoming changes to identifier and UUID handling](https://hub.synerise.com/docs/settings/configuration/identifier-standardization/).\n"},{"disabled":false,"type":"any","value":"645","key":"tagID","description":"(Required) ID of the tag"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"2018-06-07T07:29:27.489+00:00\",\n \"status\": 403,\n \"error\": \"Forbidden\",\n \"message\": \"Forbidden\",\n \"path\": \"/path_of_the_endpoint\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"0b9563ac-416f-4b66-b1f3-bac8fe6919ac","name":"Tag not found","originalRequest":{"url":{"path":["v4","clients",":clientId","tags",":tagID"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"434428563","key":"clientId","description":"(Required) The ID of the profile\n\n**Upcoming breaking change (effective July 6, 2026):** Synerise is introducing changes to how user identifiers and UUIDs are handled. These changes may affect profiles with accented or diacritical characters in identifiers, profiles with leading or trailing whitespace in identifiers, and profiles with duplicate UUIDs. For details and recommended actions, see [Upcoming changes to identifier and UUID handling](https://hub.synerise.com/docs/settings/configuration/identifier-standardization/).\n"},{"disabled":false,"type":"any","value":"645","key":"tagID","description":"(Required) ID of the tag"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\",\n \"status\": 2802,\n \"timestamp\": \"string\",\n \"path\": \"string\",\n \"message\": \"string\",\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}],"event":[]},{"id":"4c7863fe-8252-4f98-8ea6-647023dda5d4","name":"Profile management","description":{"content":"","type":"text/plain"},"item":[{"id":"8d039f71-f2cf-408b-9c50-87516a3ba46a","name":"Create or update a Profile","request":{"name":"Create or update a Profile","description":{"content":"Create a new profile in the Synerise application database or update an existing one. If you don't have some information about the profile, don't insert a null-value parameter - omit the parameter entirely.\n\nThis is an asynchronous operation. After the request body is validated, the request is added to the queue (HTTP 202) as an [Ongoing import](https://hub.synerise.com/docs/assets/imports/importing-clients/#import-modes).\n\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `API_CLIENT_CREATE`\n\n**User role permission required:** `client_management: create`\n","type":"text/plain"},"url":{"path":["v4","clients"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"email\": {\n \"value\": \"\"\n },\n \"phone\": {\n \"value\": \"\"\n },\n \"customId\": {\n \"value\": \"\"\n },\n \"firstName\": {\n \"value\": \"\"\n },\n \"lastName\": {\n \"value\": \"\"\n },\n \"displayName\": {\n \"value\": \"\"\n },\n \"uuid\": {\n \"value\": \"\"\n },\n \"avatarUrl\": {\n \"value\": \"\"\n },\n \"birthDate\": {\n \"value\": \"\"\n },\n \"company\": {\n \"value\": \"\"\n },\n \"city\": {\n \"value\": \"\"\n },\n \"address\": {\n \"value\": \"\"\n },\n \"zipCode\": {\n \"value\": \"\"\n },\n \"province\": {\n \"value\": \"\"\n },\n \"countryCode\": {\n \"value\": \"\"\n },\n \"sex\": {\n \"value\": \"\"\n },\n \"whatsAppId\": {\n \"value\": \"\"\n },\n \"agreements\": {\n \"value\": \"\"\n },\n \"attributes\": {\n \"value\": \"\"\n },\n \"tags\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"c8746fe6-86ac-40b0-b09a-bac7f5465c56","name":"Accepted, queued for processing","originalRequest":{"url":{"path":["v4","clients"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"email\": {\n \"value\": \"\"\n },\n \"phone\": {\n \"value\": \"\"\n },\n \"customId\": {\n \"value\": \"\"\n },\n \"firstName\": {\n \"value\": \"\"\n },\n \"lastName\": {\n \"value\": \"\"\n },\n \"displayName\": {\n \"value\": \"\"\n },\n \"uuid\": {\n \"value\": \"\"\n },\n \"avatarUrl\": {\n \"value\": \"\"\n },\n \"birthDate\": {\n \"value\": \"\"\n },\n \"company\": {\n \"value\": \"\"\n },\n \"city\": {\n \"value\": \"\"\n },\n \"address\": {\n \"value\": \"\"\n },\n \"zipCode\": {\n \"value\": \"\"\n },\n \"province\": {\n \"value\": \"\"\n },\n \"countryCode\": {\n \"value\": \"\"\n },\n \"sex\": {\n \"value\": \"\"\n },\n \"whatsAppId\": {\n \"value\": \"\"\n },\n \"agreements\": {\n \"value\": \"\"\n },\n \"attributes\": {\n \"value\": \"\"\n },\n \"tags\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Accepted","code":202,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"493416cd-dfc0-4d74-bd4a-cd7d9e823f77","name":"Bad Request","originalRequest":{"url":{"path":["v4","clients"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"email\": {\n \"value\": \"\"\n },\n \"phone\": {\n \"value\": \"\"\n },\n \"customId\": {\n \"value\": \"\"\n },\n \"firstName\": {\n \"value\": \"\"\n },\n \"lastName\": {\n \"value\": \"\"\n },\n \"displayName\": {\n \"value\": \"\"\n },\n \"uuid\": {\n \"value\": \"\"\n },\n \"avatarUrl\": {\n \"value\": \"\"\n },\n \"birthDate\": {\n \"value\": \"\"\n },\n \"company\": {\n \"value\": \"\"\n },\n \"city\": {\n \"value\": \"\"\n },\n \"address\": {\n \"value\": \"\"\n },\n \"zipCode\": {\n \"value\": \"\"\n },\n \"province\": {\n \"value\": \"\"\n },\n \"countryCode\": {\n \"value\": \"\"\n },\n \"sex\": {\n \"value\": \"\"\n },\n \"whatsAppId\": {\n \"value\": \"\"\n },\n \"agreements\": {\n \"value\": \"\"\n },\n \"attributes\": {\n \"value\": \"\"\n },\n \"tags\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"Bad Request\",\n \"status\": 400,\n \"timestamp\": \"2019-03-18T13:15:39.84Z\",\n \"path\": \"/clients\",\n \"message\": \"Some fields did not pass validation\",\n \"errors\": [\n {\n \"code\": 12082,\n \"field\": \"countryCode\",\n \"message\": \"Country Code must have 0 or 3 characters as per ISO format.\",\n \"rejectedValue\": \"string\"\n },\n {\n \"code\": 120,\n \"field\": \"avatarUrl\",\n \"message\": \"120\",\n \"rejectedValue\": \"string\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"87acac6a-ec0b-409c-abb9-7f9f12588513","name":"Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc.","originalRequest":{"url":{"path":["v4","clients"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"email\": {\n \"value\": \"\"\n },\n \"phone\": {\n \"value\": \"\"\n },\n \"customId\": {\n \"value\": \"\"\n },\n \"firstName\": {\n \"value\": \"\"\n },\n \"lastName\": {\n \"value\": \"\"\n },\n \"displayName\": {\n \"value\": \"\"\n },\n \"uuid\": {\n \"value\": \"\"\n },\n \"avatarUrl\": {\n \"value\": \"\"\n },\n \"birthDate\": {\n \"value\": \"\"\n },\n \"company\": {\n \"value\": \"\"\n },\n \"city\": {\n \"value\": \"\"\n },\n \"address\": {\n \"value\": \"\"\n },\n \"zipCode\": {\n \"value\": \"\"\n },\n \"province\": {\n \"value\": \"\"\n },\n \"countryCode\": {\n \"value\": \"\"\n },\n \"sex\": {\n \"value\": \"\"\n },\n \"whatsAppId\": {\n \"value\": \"\"\n },\n \"agreements\": {\n \"value\": \"\"\n },\n \"attributes\": {\n \"value\": \"\"\n },\n \"tags\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"Bad Request\",\n \"status\": 400,\n \"timestamp\": \"2020-10-29T13:08:16.235Z\",\n \"path\": \"/exampleEndpoint\",\n \"message\": \"Some fields did not pass validation\",\n \"errors\": [\n {\n \"code\": 120,\n \"field\": \"exampleField\",\n \"message\": \"120\",\n \"rejectedValue\": \"exampleValue\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"39ab9466-213d-405e-b860-5def200959fd","name":"Forbidden; insufficient permissions (when PII protection is enabled, PII permissions are required in addition to the permissions listed in the method description)","originalRequest":{"url":{"path":["v4","clients"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"email\": {\n \"value\": \"\"\n },\n \"phone\": {\n \"value\": \"\"\n },\n \"customId\": {\n \"value\": \"\"\n },\n \"firstName\": {\n \"value\": \"\"\n },\n \"lastName\": {\n \"value\": \"\"\n },\n \"displayName\": {\n \"value\": \"\"\n },\n \"uuid\": {\n \"value\": \"\"\n },\n \"avatarUrl\": {\n \"value\": \"\"\n },\n \"birthDate\": {\n \"value\": \"\"\n },\n \"company\": {\n \"value\": \"\"\n },\n \"city\": {\n \"value\": \"\"\n },\n \"address\": {\n \"value\": \"\"\n },\n \"zipCode\": {\n \"value\": \"\"\n },\n \"province\": {\n \"value\": \"\"\n },\n \"countryCode\": {\n \"value\": \"\"\n },\n \"sex\": {\n \"value\": \"\"\n },\n \"whatsAppId\": {\n \"value\": \"\"\n },\n \"agreements\": {\n \"value\": \"\"\n },\n \"attributes\": {\n \"value\": \"\"\n },\n \"tags\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"2018-06-07T07:29:27.489+00:00\",\n \"status\": 403,\n \"error\": \"Forbidden\",\n \"message\": \"Forbidden\",\n \"path\": \"/path_of_the_endpoint\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"cf71c8e6-9b25-44b2-8a0d-53582c062f13","name":"Unsupported Media Type","originalRequest":{"url":{"path":["v4","clients"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"email\": {\n \"value\": \"\"\n },\n \"phone\": {\n \"value\": \"\"\n },\n \"customId\": {\n \"value\": \"\"\n },\n \"firstName\": {\n \"value\": \"\"\n },\n \"lastName\": {\n \"value\": \"\"\n },\n \"displayName\": {\n \"value\": \"\"\n },\n \"uuid\": {\n \"value\": \"\"\n },\n \"avatarUrl\": {\n \"value\": \"\"\n },\n \"birthDate\": {\n \"value\": \"\"\n },\n \"company\": {\n \"value\": \"\"\n },\n \"city\": {\n \"value\": \"\"\n },\n \"address\": {\n \"value\": \"\"\n },\n \"zipCode\": {\n \"value\": \"\"\n },\n \"province\": {\n \"value\": \"\"\n },\n \"countryCode\": {\n \"value\": \"\"\n },\n \"sex\": {\n \"value\": \"\"\n },\n \"whatsAppId\": {\n \"value\": \"\"\n },\n \"agreements\": {\n \"value\": \"\"\n },\n \"attributes\": {\n \"value\": \"\"\n },\n \"tags\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Unsupported Media Type","code":415,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"2018-06-07T07:27:23.136+00:00\",\n \"status\": 415,\n \"error\": \"Unsupported Media Type\",\n \"message\": \"Content type 'application/xml' not supported\",\n \"path\": \"/path_of_the_endpoint\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"d1d3af28-e768-4ff3-a8d4-69b7c429a625","name":"Merge profiles by customId","request":{"name":"Merge profiles by customId","description":{"content":"Moves profile UUIDs to a single profile (which must already exist) and removes the profiles that were merged. \n\nThe event history of the source profiles is moved to the target profile.\n\nThe attributes (data from the `attributes` object) that don't exist in the target profile are copied to the target profile. If an attribute already exists in the target profile, the value from the source profile is lost.\n\nThe properties and tags of the source profiles are lost, even if they don't have a value in the target profile.\n\n

WARNING: This operation is irreversible. Use it carefully.

\n

WARNING: You should not try to merge more than 10-20 profiles at once.

\n\n For more details, see the [Developer Guide](https://hub.synerise.com/developers/api/clients/profiles/merging-profiles/).\n\n\n---\n\n**API consumer:** Workspace (Business Profile)\n\n**API key permission required:** `API_MERGEBYCUSTOMID_CLIENT_UPDATE`\n","type":"text/plain"},"url":{"path":["v4","clients","merge","from","custom-ids",":sourceCustomIDs","to","custom-id",":targetCustomID"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"customIdExample,customIdExample2,customIdExample3,customIdExample4,customIdExample5","key":"sourceCustomIDs","description":"(Required) Comma-delimited string with custom IDs of the profiles to merge"},{"disabled":false,"type":"any","value":"customIdExample","key":"targetCustomID","description":"(Required) The custom ID of the profile to merge the `sourceCustomIDs` into"}]},"header":[{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"61c96c12-ef43-4899-bfea-b1fa0c1395cb","name":"Request completed","originalRequest":{"url":{"path":["v4","clients","merge","from","custom-ids",":sourceCustomIDs","to","custom-id",":targetCustomID"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"customIdExample,customIdExample2,customIdExample3,customIdExample4,customIdExample5","key":"sourceCustomIDs","description":"(Required) Comma-delimited string with custom IDs of the profiles to merge"},{"disabled":false,"type":"any","value":"customIdExample","key":"targetCustomID","description":"(Required) The custom ID of the profile to merge the `sourceCustomIDs` into"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Accept","value":"application/json"},{"disabled":false,"description":"(Required) ","key":"Content-Type","value":"application/json"},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"clientId\": 433230297,\n \"email\": \"string\",\n \"phone\": \"+48111222333\",\n \"customId\": \"string\",\n \"uuid\": \"07243772-008a-42e1-ba37-c3807cebde8f\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"displayName\": \"string\",\n \"company\": \"string\",\n \"address\": \"string\",\n \"city\": \"string\",\n \"province\": \"string\",\n \"zipCode\": \"string\",\n \"countryCode\": \"PL\",\n \"birthDate\": \"1987-10-24\",\n \"sex\": \"OTHER\",\n \"avatarUrl\": \"string\",\n \"whatsAppId\": \"TestWhatsappId\",\n \"anonymous\": false,\n \"agreements\": {\n \"email\": {\n \"value\": \"\"\n },\n \"sms\": {\n \"value\": \"\"\n },\n \"push\": {\n \"value\": \"\"\n },\n \"webPush\": {\n \"value\": \"\"\n },\n \"whatsApp\": {\n \"value\": \"\"\n },\n \"bluetooth\": {\n \"value\": \"\"\n },\n \"rfid\": {\n \"value\": \"\"\n },\n \"wifi\": {\n \"value\": \"\"\n }\n },\n \"attributes\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n },\n \"key_2\": {\n \"value\": \"\"\n },\n \"key_3\": {\n \"value\": \"\"\n },\n \"key_4\": {\n \"value\": \"\"\n }\n },\n \"tags\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"previousClients\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"lastActivityDate\": \"2019-03-19T14:05:39Z\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"c2135732-93c6-4415-a775-a69a62e24f6c","name":"Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc.","originalRequest":{"url":{"path":["v4","clients","merge","from","custom-ids",":sourceCustomIDs","to","custom-id",":targetCustomID"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"customIdExample,customIdExample2,customIdExample3,customIdExample4,customIdExample5","key":"sourceCustomIDs","description":"(Required) Comma-delimited string with custom IDs of the profiles to merge"},{"disabled":false,"type":"any","value":"customIdExample","key":"targetCustomID","description":"(Required) The custom ID of the profile to merge the `sourceCustomIDs` into"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Accept","value":"application/json"},{"disabled":false,"description":"(Required) ","key":"Content-Type","value":"application/json"},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"Bad Request\",\n \"status\": 400,\n \"timestamp\": \"2020-10-29T13:08:16.235Z\",\n \"path\": \"/exampleEndpoint\",\n \"message\": \"Some fields did not pass validation\",\n \"errors\": [\n {\n \"code\": 120,\n \"field\": \"exampleField\",\n \"message\": \"120\",\n \"rejectedValue\": \"exampleValue\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"67440722-90cd-4dee-810b-3dac7af91d17","name":"Forbidden; insufficient permissions (when PII protection is enabled, PII permissions are required in addition to the permissions listed in the method description)","originalRequest":{"url":{"path":["v4","clients","merge","from","custom-ids",":sourceCustomIDs","to","custom-id",":targetCustomID"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"customIdExample,customIdExample2,customIdExample3,customIdExample4,customIdExample5","key":"sourceCustomIDs","description":"(Required) Comma-delimited string with custom IDs of the profiles to merge"},{"disabled":false,"type":"any","value":"customIdExample","key":"targetCustomID","description":"(Required) The custom ID of the profile to merge the `sourceCustomIDs` into"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Accept","value":"application/json"},{"disabled":false,"description":"(Required) ","key":"Content-Type","value":"application/json"},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"2018-06-07T07:29:27.489+00:00\",\n \"status\": 403,\n \"error\": \"Forbidden\",\n \"message\": \"Forbidden\",\n \"path\": \"/path_of_the_endpoint\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"d261b0c8-76a4-448a-985e-9d71b75e2a6f","name":"Source and/or target profile(s) not found.","originalRequest":{"url":{"path":["v4","clients","merge","from","custom-ids",":sourceCustomIDs","to","custom-id",":targetCustomID"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"customIdExample,customIdExample2,customIdExample3,customIdExample4,customIdExample5","key":"sourceCustomIDs","description":"(Required) Comma-delimited string with custom IDs of the profiles to merge"},{"disabled":false,"type":"any","value":"customIdExample","key":"targetCustomID","description":"(Required) The custom ID of the profile to merge the `sourceCustomIDs` into"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Accept","value":"application/json"},{"disabled":false,"description":"(Required) ","key":"Content-Type","value":"application/json"},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\",\n \"status\": 6953,\n \"timestamp\": \"string\",\n \"path\": \"string\",\n \"message\": \"string\",\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"41289f79-175d-4c18-b016-daf8c5d6d435","name":"Merge profiles by clientId","request":{"name":"Merge profiles by clientId","description":{"content":"Moves profile UUIDs to a single profile (which must already exist) and removes the profiles that were merged. \n\nThe event history of the source profiles is moved to the target profile.\n\nThe attributes (data from the `attributes` object) that don't exist in the target profile are copied to the target profile. If an attribute already exists in the target profile, the value from the source profile is lost.\n\nThe properties and tags of the source profiles are lost, even if they don't have a value in the target profile.\n\n

WARNING: This operation is irreversible. Use it carefully.

\n

WARNING: You should not try to merge more than 10-20 profiles at once.

\n\n For more details, see the [Developer Guide](https://hub.synerise.com/developers/api/clients/profiles/merging-profiles/).\n\n\n---\n\n**API consumer:** Workspace (Business Profile)\n\n**API key permission required:** `API_MERGE_BY_ID_CLIENT_UPDATE`\n","type":"text/plain"},"url":{"path":["v4","clients","merge","from","ids",":fromClientIds","to","id",":toClientId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"434428563,33322211,232212342","key":"fromClientIds","description":"(Required) Comma-delimited string with client IDs of the profiles to merge"},{"disabled":false,"type":"any","value":"434428563","key":"toClientId","description":"(Required) The ID of the profile to merge the `fromClientIds` into"}]},"header":[{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"4afa8ed7-1691-4c80-ab78-456930ded924","name":"Request completed","originalRequest":{"url":{"path":["v4","clients","merge","from","ids",":fromClientIds","to","id",":toClientId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"434428563,33322211,232212342","key":"fromClientIds","description":"(Required) Comma-delimited string with client IDs of the profiles to merge"},{"disabled":false,"type":"any","value":"434428563","key":"toClientId","description":"(Required) The ID of the profile to merge the `fromClientIds` into"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Accept","value":"application/json"},{"disabled":false,"description":"(Required) ","key":"Content-Type","value":"application/json"},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"clientId\": 433230297,\n \"email\": \"string\",\n \"phone\": \"+48111222333\",\n \"customId\": \"string\",\n \"uuid\": \"07243772-008a-42e1-ba37-c3807cebde8f\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"displayName\": \"string\",\n \"company\": \"string\",\n \"address\": \"string\",\n \"city\": \"string\",\n \"province\": \"string\",\n \"zipCode\": \"string\",\n \"countryCode\": \"PL\",\n \"birthDate\": \"1987-10-24\",\n \"sex\": \"OTHER\",\n \"avatarUrl\": \"string\",\n \"whatsAppId\": \"TestWhatsappId\",\n \"anonymous\": false,\n \"agreements\": {\n \"email\": {\n \"value\": \"\"\n },\n \"sms\": {\n \"value\": \"\"\n },\n \"push\": {\n \"value\": \"\"\n },\n \"webPush\": {\n \"value\": \"\"\n },\n \"whatsApp\": {\n \"value\": \"\"\n },\n \"bluetooth\": {\n \"value\": \"\"\n },\n \"rfid\": {\n \"value\": \"\"\n },\n \"wifi\": {\n \"value\": \"\"\n }\n },\n \"attributes\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n },\n \"key_2\": {\n \"value\": \"\"\n },\n \"key_3\": {\n \"value\": \"\"\n },\n \"key_4\": {\n \"value\": \"\"\n }\n },\n \"tags\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"previousClients\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"lastActivityDate\": \"2019-03-19T14:05:39Z\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"6a8805f4-ea07-46fc-867f-6ec6d32aae41","name":"Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc.","originalRequest":{"url":{"path":["v4","clients","merge","from","ids",":fromClientIds","to","id",":toClientId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"434428563,33322211,232212342","key":"fromClientIds","description":"(Required) Comma-delimited string with client IDs of the profiles to merge"},{"disabled":false,"type":"any","value":"434428563","key":"toClientId","description":"(Required) The ID of the profile to merge the `fromClientIds` into"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Accept","value":"application/json"},{"disabled":false,"description":"(Required) ","key":"Content-Type","value":"application/json"},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"Bad Request\",\n \"status\": 400,\n \"timestamp\": \"2020-10-29T13:08:16.235Z\",\n \"path\": \"/exampleEndpoint\",\n \"message\": \"Some fields did not pass validation\",\n \"errors\": [\n {\n \"code\": 120,\n \"field\": \"exampleField\",\n \"message\": \"120\",\n \"rejectedValue\": \"exampleValue\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"5727d411-21e3-4620-a0f2-3c1affd7029b","name":"Forbidden; insufficient permissions (when PII protection is enabled, PII permissions are required in addition to the permissions listed in the method description)","originalRequest":{"url":{"path":["v4","clients","merge","from","ids",":fromClientIds","to","id",":toClientId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"434428563,33322211,232212342","key":"fromClientIds","description":"(Required) Comma-delimited string with client IDs of the profiles to merge"},{"disabled":false,"type":"any","value":"434428563","key":"toClientId","description":"(Required) The ID of the profile to merge the `fromClientIds` into"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Accept","value":"application/json"},{"disabled":false,"description":"(Required) ","key":"Content-Type","value":"application/json"},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"2018-06-07T07:29:27.489+00:00\",\n \"status\": 403,\n \"error\": \"Forbidden\",\n \"message\": \"Forbidden\",\n \"path\": \"/path_of_the_endpoint\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"3c59aad7-200d-4c72-9a11-d61648583275","name":"Source and/or target profile(s) not found.","originalRequest":{"url":{"path":["v4","clients","merge","from","ids",":fromClientIds","to","id",":toClientId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"434428563,33322211,232212342","key":"fromClientIds","description":"(Required) Comma-delimited string with client IDs of the profiles to merge"},{"disabled":false,"type":"any","value":"434428563","key":"toClientId","description":"(Required) The ID of the profile to merge the `fromClientIds` into"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Accept","value":"application/json"},{"disabled":false,"description":"(Required) ","key":"Content-Type","value":"application/json"},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\",\n \"status\": 2802,\n \"timestamp\": \"string\",\n \"path\": \"string\",\n \"message\": \"string\",\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"ea165975-c743-45da-8551-76dcdd7c0da6","name":"Batch add or update profiles","request":{"name":"Batch add or update profiles","description":{"content":" Enqueue a number of add/update operations in the Synerise application database.

If you don't have some information about a profile, don't insert a null-value parameter - omit the parameter entirely. Sending a null value deletes an attribute (if it's a custom attribute) or sets it to null/default value (if the attribute is Synerise-native).\n\n\nThe body contains an array of objects to update. The objects are the same as in the *Create a Profile* and *Update a Profile* endpoints.\n\nIMPORTANT: The request body cannot contain more than 1000 items or exceed 1 MB in size.\n\nThis is an asynchronous operation. After the request body is validated, the request is added to the queue (HTTP 202) as an [Ongoing import](https://hub.synerise.com/docs/assets/imports/importing-clients/#import-modes).\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `API_BATCH_CLIENT_CREATE`\n\n**User role permission required:** `client_management: create`\n","type":"text/plain"},"url":{"path":["v4","clients","batch"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"[\n {\n \"clientId\": {\n \"value\": \"\"\n }\n }\n]","options":{"raw":{"language":"json"}}}},"response":[{"id":"6d1a8816-87a7-4d2d-8105-2a4c34d8cb17","name":"Request accepted. IMPORTANT: this does not mean that all profiles were created/updated successfully. The data is sent for further processing in other elements of the infrastructure.","originalRequest":{"url":{"path":["v4","clients","batch"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Accept","value":"application/json"},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"}],"method":"POST","body":{"mode":"raw","raw":"[\n {\n \"clientId\": {\n \"value\": \"\"\n }\n }\n]","options":{"raw":{"language":"json"}}}},"status":"Accepted","code":202,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"77fbd930-2e81-4db8-89d5-17a1485d076b","name":"Invalid data in some entries. Correct entries are sent for further processing, the invalid ones are rejected.","originalRequest":{"url":{"path":["v4","clients","batch"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Accept","value":"application/json"},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"[\n {\n \"clientId\": {\n \"value\": \"\"\n }\n }\n]","options":{"raw":{"language":"json"}}}},"status":"Multi-Status (WebDAV) (RFC 4918)","code":207,"header":[{"key":"Content-Type","value":"application/json"}],"body":"[\n {\n \"rejectedValue\": \"de73b3490c4-bb8c0d8\",\n \"field\": \"list[0].uuid\",\n \"status\": 400,\n \"message\": \"UUID must be well-formed value as per RFC 4122\"\n }\n]","cookie":[],"_postman_previewlanguage":"json"},{"id":"ae4aa73d-d498-468d-b7d6-3608b4b58e44","name":"Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc.","originalRequest":{"url":{"path":["v4","clients","batch"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Accept","value":"application/json"},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"[\n {\n \"clientId\": {\n \"value\": \"\"\n }\n }\n]","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"Bad Request\",\n \"status\": 400,\n \"timestamp\": \"2020-10-29T13:08:16.235Z\",\n \"path\": \"/exampleEndpoint\",\n \"message\": \"Some fields did not pass validation\",\n \"errors\": [\n {\n \"code\": 120,\n \"field\": \"exampleField\",\n \"message\": \"120\",\n \"rejectedValue\": \"exampleValue\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"d59f03aa-a8ff-48d0-9724-a4e70f3d64a6","name":"Forbidden; insufficient permissions (when PII protection is enabled, PII permissions are required in addition to the permissions listed in the method description)","originalRequest":{"url":{"path":["v4","clients","batch"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Accept","value":"application/json"},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"[\n {\n \"clientId\": {\n \"value\": \"\"\n }\n }\n]","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"2018-06-07T07:29:27.489+00:00\",\n \"status\": 403,\n \"error\": \"Forbidden\",\n \"message\": \"Forbidden\",\n \"path\": \"/path_of_the_endpoint\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"98d91d60-4e16-4bc7-ab3b-e484c5c86de3","name":"Unsupported Media Type","originalRequest":{"url":{"path":["v4","clients","batch"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Accept","value":"application/json"},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"[\n {\n \"clientId\": {\n \"value\": \"\"\n }\n }\n]","options":{"raw":{"language":"json"}}}},"status":"Unsupported Media Type","code":415,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"2018-06-07T07:27:23.136+00:00\",\n \"status\": 415,\n \"error\": \"Unsupported Media Type\",\n \"message\": \"Content type 'application/xml' not supported\",\n \"path\": \"/path_of_the_endpoint\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"51da4801-6a48-4b64-a3df-91796bc08941","name":"Get profile data","request":{"name":"Get profile data","description":{"content":"Retrieve profile data by profile ID. If PII protection is enabled and your API key/user doesn't have the required permissions, this endpoint can only return test profiles; other profiles return error 404.\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `API_BY_ID_CLIENT_READ`\n\n**User role permission required:** `client_info: read`\n","type":"text/plain"},"url":{"path":["v4","clients",":clientId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"434428563","key":"clientId","description":"(Required) The ID of the profile\n\n**Upcoming breaking change (effective July 6, 2026):** Synerise is introducing changes to how user identifiers and UUIDs are handled. These changes may affect profiles with accented or diacritical characters in identifiers, profiles with leading or trailing whitespace in identifiers, and profiles with duplicate UUIDs. For details and recommended actions, see [Upcoming changes to identifier and UUID handling](https://hub.synerise.com/docs/settings/configuration/identifier-standardization/).\n"}]},"header":[{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"4d1730d0-1141-49bb-bc70-f01f53b523b0","name":"Details of a single profile","originalRequest":{"url":{"path":["v4","clients",":clientId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"434428563","key":"clientId","description":"(Required) The ID of the profile\n\n**Upcoming breaking change (effective July 6, 2026):** Synerise is introducing changes to how user identifiers and UUIDs are handled. These changes may affect profiles with accented or diacritical characters in identifiers, profiles with leading or trailing whitespace in identifiers, and profiles with duplicate UUIDs. For details and recommended actions, see [Upcoming changes to identifier and UUID handling](https://hub.synerise.com/docs/settings/configuration/identifier-standardization/).\n"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Content-Type","value":"application/json"},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"clientId\": 433230297,\n \"email\": \"string\",\n \"phone\": \"+48111222333\",\n \"customId\": \"string\",\n \"uuid\": \"07243772-008a-42e1-ba37-c3807cebde8f\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"displayName\": \"string\",\n \"company\": \"string\",\n \"address\": \"string\",\n \"city\": \"string\",\n \"province\": \"string\",\n \"zipCode\": \"string\",\n \"countryCode\": \"PL\",\n \"birthDate\": \"1987-10-24\",\n \"sex\": \"OTHER\",\n \"avatarUrl\": \"string\",\n \"whatsAppId\": \"TestWhatsappId\",\n \"anonymous\": false,\n \"agreements\": {\n \"email\": {\n \"value\": \"\"\n },\n \"sms\": {\n \"value\": \"\"\n },\n \"push\": {\n \"value\": \"\"\n },\n \"webPush\": {\n \"value\": \"\"\n },\n \"whatsApp\": {\n \"value\": \"\"\n },\n \"bluetooth\": {\n \"value\": \"\"\n },\n \"rfid\": {\n \"value\": \"\"\n },\n \"wifi\": {\n \"value\": \"\"\n }\n },\n \"attributes\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n },\n \"key_2\": {\n \"value\": \"\"\n },\n \"key_3\": {\n \"value\": \"\"\n },\n \"key_4\": {\n \"value\": \"\"\n }\n },\n \"tags\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"previousClients\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"lastActivityDate\": \"2019-03-19T14:05:39Z\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"b0ea08d0-3722-4a2b-a645-b010c9b180d5","name":"The profile ID is not valid, for example 0.","originalRequest":{"url":{"path":["v4","clients",":clientId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"434428563","key":"clientId","description":"(Required) The ID of the profile\n\n**Upcoming breaking change (effective July 6, 2026):** Synerise is introducing changes to how user identifiers and UUIDs are handled. These changes may affect profiles with accented or diacritical characters in identifiers, profiles with leading or trailing whitespace in identifiers, and profiles with duplicate UUIDs. For details and recommended actions, see [Upcoming changes to identifier and UUID handling](https://hub.synerise.com/docs/settings/configuration/identifier-standardization/).\n"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Content-Type","value":"application/json"},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"2018-06-07T09:48:56.522+00:00\",\n \"status\": 400,\n \"error\": \"Bad Request\",\n \"message\": \"Invalid client id\",\n \"path\": \"/clients/0\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"c279b1a7-cd88-45cc-bfef-a8d4b3431990","name":"Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc.","originalRequest":{"url":{"path":["v4","clients",":clientId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"434428563","key":"clientId","description":"(Required) The ID of the profile\n\n**Upcoming breaking change (effective July 6, 2026):** Synerise is introducing changes to how user identifiers and UUIDs are handled. These changes may affect profiles with accented or diacritical characters in identifiers, profiles with leading or trailing whitespace in identifiers, and profiles with duplicate UUIDs. For details and recommended actions, see [Upcoming changes to identifier and UUID handling](https://hub.synerise.com/docs/settings/configuration/identifier-standardization/).\n"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Content-Type","value":"application/json"},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"Bad Request\",\n \"status\": 400,\n \"timestamp\": \"2020-10-29T13:08:16.235Z\",\n \"path\": \"/exampleEndpoint\",\n \"message\": \"Some fields did not pass validation\",\n \"errors\": [\n {\n \"code\": 120,\n \"field\": \"exampleField\",\n \"message\": \"120\",\n \"rejectedValue\": \"exampleValue\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"67965719-0baf-4b05-834d-62699fc5b1ef","name":"Forbidden; insufficient permissions (when PII protection is enabled, PII permissions are required in addition to the permissions listed in the method description)","originalRequest":{"url":{"path":["v4","clients",":clientId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"434428563","key":"clientId","description":"(Required) The ID of the profile\n\n**Upcoming breaking change (effective July 6, 2026):** Synerise is introducing changes to how user identifiers and UUIDs are handled. These changes may affect profiles with accented or diacritical characters in identifiers, profiles with leading or trailing whitespace in identifiers, and profiles with duplicate UUIDs. For details and recommended actions, see [Upcoming changes to identifier and UUID handling](https://hub.synerise.com/docs/settings/configuration/identifier-standardization/).\n"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Content-Type","value":"application/json"},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"2018-06-07T07:29:27.489+00:00\",\n \"status\": 403,\n \"error\": \"Forbidden\",\n \"message\": \"Forbidden\",\n \"path\": \"/path_of_the_endpoint\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"48642b58-c022-449a-95ec-7fe75206e74c","name":"Profile not found or access blocked by PII protection settings","originalRequest":{"url":{"path":["v4","clients",":clientId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"434428563","key":"clientId","description":"(Required) The ID of the profile\n\n**Upcoming breaking change (effective July 6, 2026):** Synerise is introducing changes to how user identifiers and UUIDs are handled. These changes may affect profiles with accented or diacritical characters in identifiers, profiles with leading or trailing whitespace in identifiers, and profiles with duplicate UUIDs. For details and recommended actions, see [Upcoming changes to identifier and UUID handling](https://hub.synerise.com/docs/settings/configuration/identifier-standardization/).\n"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Content-Type","value":"application/json"},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"\"Client 5005535044 not found\"","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"2b341b70-1469-4502-8927-2a38ed6a2ee2","name":"Update a profile (identify by ID)","request":{"name":"Update a profile (identify by ID)","description":{"content":"Change the details of a profile in the Synerise application database.

Sending a null value deletes an attribute (if it's a custom attribute) or sets it to null/default value (if the attribute is Synerise-native).\n\nThe `attributes` object can be used to add custom attributes of your choice. For example, `\"hasDog\":true`.\n\nThe `tags` array contains custom tags of your choice.\n\nThis is an asynchronous operation. After the request body is validated, the request is added to the queue (HTTP 202) as an [Ongoing import](https://hub.synerise.com/docs/assets/imports/importing-clients/#import-modes).\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `API_BY_ID_CLIENT_UPDATE`\n\n**User role permission required:** `client_info: update`\n","type":"text/plain"},"url":{"path":["v4","clients",":clientId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"434428563","key":"clientId","description":"(Required) The ID of the profile\n\n**Upcoming breaking change (effective July 6, 2026):** Synerise is introducing changes to how user identifiers and UUIDs are handled. These changes may affect profiles with accented or diacritical characters in identifiers, profiles with leading or trailing whitespace in identifiers, and profiles with duplicate UUIDs. For details and recommended actions, see [Upcoming changes to identifier and UUID handling](https://hub.synerise.com/docs/settings/configuration/identifier-standardization/).\n"}]},"header":[{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"email\": \"string\",\n \"phone\": \"+48111222333\",\n \"customId\": \"string\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"displayName\": \"string\",\n \"uuid\": \"07243772-008a-42e1-ba37-c3807cebde8f\",\n \"avatarUrl\": \"string\",\n \"birthDate\": \"1987-10-24\",\n \"company\": \"string\",\n \"city\": \"string\",\n \"address\": \"string\",\n \"zipCode\": \"string\",\n \"province\": \"string\",\n \"countryCode\": \"PL\",\n \"sex\": \"MALE\",\n \"whatsAppId\": \"TestWhatsappId\",\n \"agreements\": {\n \"email\": {\n \"value\": \"\"\n },\n \"sms\": {\n \"value\": \"\"\n },\n \"push\": {\n \"value\": \"\"\n },\n \"webPush\": {\n \"value\": \"\"\n },\n \"whatsApp\": {\n \"value\": \"\"\n },\n \"bluetooth\": {\n \"value\": \"\"\n },\n \"rfid\": {\n \"value\": \"\"\n },\n \"wifi\": {\n \"value\": \"\"\n }\n },\n \"attributes\": {\n \"key_0\": {\n \"value\": \"\"\n }\n },\n \"tags\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"3a189928-e13d-4473-abbf-4e9ee8af203c","name":"Accepted, queued for processing","originalRequest":{"url":{"path":["v4","clients",":clientId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"434428563","key":"clientId","description":"(Required) The ID of the profile\n\n**Upcoming breaking change (effective July 6, 2026):** Synerise is introducing changes to how user identifiers and UUIDs are handled. These changes may affect profiles with accented or diacritical characters in identifiers, profiles with leading or trailing whitespace in identifiers, and profiles with duplicate UUIDs. For details and recommended actions, see [Upcoming changes to identifier and UUID handling](https://hub.synerise.com/docs/settings/configuration/identifier-standardization/).\n"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"email\": \"string\",\n \"phone\": \"+48111222333\",\n \"customId\": \"string\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"displayName\": \"string\",\n \"uuid\": \"07243772-008a-42e1-ba37-c3807cebde8f\",\n \"avatarUrl\": \"string\",\n \"birthDate\": \"1987-10-24\",\n \"company\": \"string\",\n \"city\": \"string\",\n \"address\": \"string\",\n \"zipCode\": \"string\",\n \"province\": \"string\",\n \"countryCode\": \"PL\",\n \"sex\": \"MALE\",\n \"whatsAppId\": \"TestWhatsappId\",\n \"agreements\": {\n \"email\": {\n \"value\": \"\"\n },\n \"sms\": {\n \"value\": \"\"\n },\n \"push\": {\n \"value\": \"\"\n },\n \"webPush\": {\n \"value\": \"\"\n },\n \"whatsApp\": {\n \"value\": \"\"\n },\n \"bluetooth\": {\n \"value\": \"\"\n },\n \"rfid\": {\n \"value\": \"\"\n },\n \"wifi\": {\n \"value\": \"\"\n }\n },\n \"attributes\": {\n \"key_0\": {\n \"value\": \"\"\n }\n },\n \"tags\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"Accepted","code":202,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"b301f3f0-ec4e-4f5e-8ae2-7fc8a568694f","name":"Bad Request","originalRequest":{"url":{"path":["v4","clients",":clientId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"434428563","key":"clientId","description":"(Required) The ID of the profile\n\n**Upcoming breaking change (effective July 6, 2026):** Synerise is introducing changes to how user identifiers and UUIDs are handled. These changes may affect profiles with accented or diacritical characters in identifiers, profiles with leading or trailing whitespace in identifiers, and profiles with duplicate UUIDs. For details and recommended actions, see [Upcoming changes to identifier and UUID handling](https://hub.synerise.com/docs/settings/configuration/identifier-standardization/).\n"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"email\": \"string\",\n \"phone\": \"+48111222333\",\n \"customId\": \"string\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"displayName\": \"string\",\n \"uuid\": \"07243772-008a-42e1-ba37-c3807cebde8f\",\n \"avatarUrl\": \"string\",\n \"birthDate\": \"1987-10-24\",\n \"company\": \"string\",\n \"city\": \"string\",\n \"address\": \"string\",\n \"zipCode\": \"string\",\n \"province\": \"string\",\n \"countryCode\": \"PL\",\n \"sex\": \"MALE\",\n \"whatsAppId\": \"TestWhatsappId\",\n \"agreements\": {\n \"email\": {\n \"value\": \"\"\n },\n \"sms\": {\n \"value\": \"\"\n },\n \"push\": {\n \"value\": \"\"\n },\n \"webPush\": {\n \"value\": \"\"\n },\n \"whatsApp\": {\n \"value\": \"\"\n },\n \"bluetooth\": {\n \"value\": \"\"\n },\n \"rfid\": {\n \"value\": \"\"\n },\n \"wifi\": {\n \"value\": \"\"\n }\n },\n \"attributes\": {\n \"key_0\": {\n \"value\": \"\"\n }\n },\n \"tags\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"Bad Request\",\n \"status\": 400,\n \"timestamp\": \"2019-03-21T08:37:34.526Z\",\n \"path\": \"/clients/1234\",\n \"message\": \"Some fields did not pass validation\",\n \"errors\": [\n {\n \"code\": 12053,\n \"field\": \"uuid\",\n \"message\": \"UUID must be well-formed value as per RFC 4122\",\n \"rejectedValue\": \"4321\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"a90c14dc-60f3-4de7-83ca-3856743e3a80","name":"Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc.","originalRequest":{"url":{"path":["v4","clients",":clientId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"434428563","key":"clientId","description":"(Required) The ID of the profile\n\n**Upcoming breaking change (effective July 6, 2026):** Synerise is introducing changes to how user identifiers and UUIDs are handled. These changes may affect profiles with accented or diacritical characters in identifiers, profiles with leading or trailing whitespace in identifiers, and profiles with duplicate UUIDs. For details and recommended actions, see [Upcoming changes to identifier and UUID handling](https://hub.synerise.com/docs/settings/configuration/identifier-standardization/).\n"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"email\": \"string\",\n \"phone\": \"+48111222333\",\n \"customId\": \"string\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"displayName\": \"string\",\n \"uuid\": \"07243772-008a-42e1-ba37-c3807cebde8f\",\n \"avatarUrl\": \"string\",\n \"birthDate\": \"1987-10-24\",\n \"company\": \"string\",\n \"city\": \"string\",\n \"address\": \"string\",\n \"zipCode\": \"string\",\n \"province\": \"string\",\n \"countryCode\": \"PL\",\n \"sex\": \"MALE\",\n \"whatsAppId\": \"TestWhatsappId\",\n \"agreements\": {\n \"email\": {\n \"value\": \"\"\n },\n \"sms\": {\n \"value\": \"\"\n },\n \"push\": {\n \"value\": \"\"\n },\n \"webPush\": {\n \"value\": \"\"\n },\n \"whatsApp\": {\n \"value\": \"\"\n },\n \"bluetooth\": {\n \"value\": \"\"\n },\n \"rfid\": {\n \"value\": \"\"\n },\n \"wifi\": {\n \"value\": \"\"\n }\n },\n \"attributes\": {\n \"key_0\": {\n \"value\": \"\"\n }\n },\n \"tags\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"Bad Request\",\n \"status\": 400,\n \"timestamp\": \"2020-10-29T13:08:16.235Z\",\n \"path\": \"/exampleEndpoint\",\n \"message\": \"Some fields did not pass validation\",\n \"errors\": [\n {\n \"code\": 120,\n \"field\": \"exampleField\",\n \"message\": \"120\",\n \"rejectedValue\": \"exampleValue\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"fcf2bb59-d25c-42eb-9703-29a5c4fc5cba","name":"Forbidden; insufficient permissions (when PII protection is enabled, PII permissions are required in addition to the permissions listed in the method description)","originalRequest":{"url":{"path":["v4","clients",":clientId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"434428563","key":"clientId","description":"(Required) The ID of the profile\n\n**Upcoming breaking change (effective July 6, 2026):** Synerise is introducing changes to how user identifiers and UUIDs are handled. These changes may affect profiles with accented or diacritical characters in identifiers, profiles with leading or trailing whitespace in identifiers, and profiles with duplicate UUIDs. For details and recommended actions, see [Upcoming changes to identifier and UUID handling](https://hub.synerise.com/docs/settings/configuration/identifier-standardization/).\n"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"email\": \"string\",\n \"phone\": \"+48111222333\",\n \"customId\": \"string\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"displayName\": \"string\",\n \"uuid\": \"07243772-008a-42e1-ba37-c3807cebde8f\",\n \"avatarUrl\": \"string\",\n \"birthDate\": \"1987-10-24\",\n \"company\": \"string\",\n \"city\": \"string\",\n \"address\": \"string\",\n \"zipCode\": \"string\",\n \"province\": \"string\",\n \"countryCode\": \"PL\",\n \"sex\": \"MALE\",\n \"whatsAppId\": \"TestWhatsappId\",\n \"agreements\": {\n \"email\": {\n \"value\": \"\"\n },\n \"sms\": {\n \"value\": \"\"\n },\n \"push\": {\n \"value\": \"\"\n },\n \"webPush\": {\n \"value\": \"\"\n },\n \"whatsApp\": {\n \"value\": \"\"\n },\n \"bluetooth\": {\n \"value\": \"\"\n },\n \"rfid\": {\n \"value\": \"\"\n },\n \"wifi\": {\n \"value\": \"\"\n }\n },\n \"attributes\": {\n \"key_0\": {\n \"value\": \"\"\n }\n },\n \"tags\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"2018-06-07T07:29:27.489+00:00\",\n \"status\": 403,\n \"error\": \"Forbidden\",\n \"message\": \"Forbidden\",\n \"path\": \"/path_of_the_endpoint\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"583390e4-e806-4a5d-a085-4af38e756175","name":"Profile not found","originalRequest":{"url":{"path":["v4","clients",":clientId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"434428563","key":"clientId","description":"(Required) The ID of the profile\n\n**Upcoming breaking change (effective July 6, 2026):** Synerise is introducing changes to how user identifiers and UUIDs are handled. These changes may affect profiles with accented or diacritical characters in identifiers, profiles with leading or trailing whitespace in identifiers, and profiles with duplicate UUIDs. For details and recommended actions, see [Upcoming changes to identifier and UUID handling](https://hub.synerise.com/docs/settings/configuration/identifier-standardization/).\n"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"email\": \"string\",\n \"phone\": \"+48111222333\",\n \"customId\": \"string\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"displayName\": \"string\",\n \"uuid\": \"07243772-008a-42e1-ba37-c3807cebde8f\",\n \"avatarUrl\": \"string\",\n \"birthDate\": \"1987-10-24\",\n \"company\": \"string\",\n \"city\": \"string\",\n \"address\": \"string\",\n \"zipCode\": \"string\",\n \"province\": \"string\",\n \"countryCode\": \"PL\",\n \"sex\": \"MALE\",\n \"whatsAppId\": \"TestWhatsappId\",\n \"agreements\": {\n \"email\": {\n \"value\": \"\"\n },\n \"sms\": {\n \"value\": \"\"\n },\n \"push\": {\n \"value\": \"\"\n },\n \"webPush\": {\n \"value\": \"\"\n },\n \"whatsApp\": {\n \"value\": \"\"\n },\n \"bluetooth\": {\n \"value\": \"\"\n },\n \"rfid\": {\n \"value\": \"\"\n },\n \"wifi\": {\n \"value\": \"\"\n }\n },\n \"attributes\": {\n \"key_0\": {\n \"value\": \"\"\n }\n },\n \"tags\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"2018-06-07T09:48:56.522+00:00\",\n \"status\": 404,\n \"error\": \"Not Found\",\n \"message\": \"Client 525446575 not found\",\n \"path\": \"/clients/525446575\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"e2bb7ace-20de-4c73-8625-48b4ea082d31","name":"Unsupported Media Type","originalRequest":{"url":{"path":["v4","clients",":clientId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"434428563","key":"clientId","description":"(Required) The ID of the profile\n\n**Upcoming breaking change (effective July 6, 2026):** Synerise is introducing changes to how user identifiers and UUIDs are handled. These changes may affect profiles with accented or diacritical characters in identifiers, profiles with leading or trailing whitespace in identifiers, and profiles with duplicate UUIDs. For details and recommended actions, see [Upcoming changes to identifier and UUID handling](https://hub.synerise.com/docs/settings/configuration/identifier-standardization/).\n"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"email\": \"string\",\n \"phone\": \"+48111222333\",\n \"customId\": \"string\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"displayName\": \"string\",\n \"uuid\": \"07243772-008a-42e1-ba37-c3807cebde8f\",\n \"avatarUrl\": \"string\",\n \"birthDate\": \"1987-10-24\",\n \"company\": \"string\",\n \"city\": \"string\",\n \"address\": \"string\",\n \"zipCode\": \"string\",\n \"province\": \"string\",\n \"countryCode\": \"PL\",\n \"sex\": \"MALE\",\n \"whatsAppId\": \"TestWhatsappId\",\n \"agreements\": {\n \"email\": {\n \"value\": \"\"\n },\n \"sms\": {\n \"value\": \"\"\n },\n \"push\": {\n \"value\": \"\"\n },\n \"webPush\": {\n \"value\": \"\"\n },\n \"whatsApp\": {\n \"value\": \"\"\n },\n \"bluetooth\": {\n \"value\": \"\"\n },\n \"rfid\": {\n \"value\": \"\"\n },\n \"wifi\": {\n \"value\": \"\"\n }\n },\n \"attributes\": {\n \"key_0\": {\n \"value\": \"\"\n }\n },\n \"tags\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"Unsupported Media Type","code":415,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"2018-06-07T07:27:23.136+00:00\",\n \"status\": 415,\n \"error\": \"Unsupported Media Type\",\n \"message\": \"Content type 'application/xml' not supported\",\n \"path\": \"/path_of_the_endpoint\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"f1f02275-db29-4fa7-af28-2c0137e17c73","name":"Delete a profile","request":{"name":"Delete a profile","description":{"content":"Delete a profile from the database.\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `API_BY_ID_CLIENT_DELETE`\n\n**User role permission required:** `client_info: delete`\n","type":"text/plain"},"url":{"path":["v4","clients",":clientId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"434428563","key":"clientId","description":"(Required) The ID of the profile\n\n**Upcoming breaking change (effective July 6, 2026):** Synerise is introducing changes to how user identifiers and UUIDs are handled. These changes may affect profiles with accented or diacritical characters in identifiers, profiles with leading or trailing whitespace in identifiers, and profiles with duplicate UUIDs. For details and recommended actions, see [Upcoming changes to identifier and UUID handling](https://hub.synerise.com/docs/settings/configuration/identifier-standardization/).\n"}]},"header":[{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"DELETE","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"dd6ded20-5143-485b-a628-b0a2a086779d","name":"Accepted","originalRequest":{"url":{"path":["v4","clients",":clientId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"434428563","key":"clientId","description":"(Required) The ID of the profile\n\n**Upcoming breaking change (effective July 6, 2026):** Synerise is introducing changes to how user identifiers and UUIDs are handled. These changes may affect profiles with accented or diacritical characters in identifiers, profiles with leading or trailing whitespace in identifiers, and profiles with duplicate UUIDs. For details and recommended actions, see [Upcoming changes to identifier and UUID handling](https://hub.synerise.com/docs/settings/configuration/identifier-standardization/).\n"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Accept","value":"application/json"},{"disabled":false,"description":"(Required) ","key":"Content-Type","value":"application/json"},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"}],"method":"DELETE","body":{}},"status":"Accepted","code":202,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"3af5cafd-eea6-4aeb-8e3f-d04081715691","name":"The profile ID is not valid, for example 0.","originalRequest":{"url":{"path":["v4","clients",":clientId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"434428563","key":"clientId","description":"(Required) The ID of the profile\n\n**Upcoming breaking change (effective July 6, 2026):** Synerise is introducing changes to how user identifiers and UUIDs are handled. These changes may affect profiles with accented or diacritical characters in identifiers, profiles with leading or trailing whitespace in identifiers, and profiles with duplicate UUIDs. For details and recommended actions, see [Upcoming changes to identifier and UUID handling](https://hub.synerise.com/docs/settings/configuration/identifier-standardization/).\n"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Accept","value":"application/json"},{"disabled":false,"description":"(Required) ","key":"Content-Type","value":"application/json"},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"2018-06-07T09:48:56.522+00:00\",\n \"status\": 400,\n \"error\": \"Bad Request\",\n \"message\": \"Invalid client id\",\n \"path\": \"/clients/0\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"35556e57-0100-4d7a-896f-6e120c7f44a4","name":"Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc.","originalRequest":{"url":{"path":["v4","clients",":clientId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"434428563","key":"clientId","description":"(Required) The ID of the profile\n\n**Upcoming breaking change (effective July 6, 2026):** Synerise is introducing changes to how user identifiers and UUIDs are handled. These changes may affect profiles with accented or diacritical characters in identifiers, profiles with leading or trailing whitespace in identifiers, and profiles with duplicate UUIDs. For details and recommended actions, see [Upcoming changes to identifier and UUID handling](https://hub.synerise.com/docs/settings/configuration/identifier-standardization/).\n"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Accept","value":"application/json"},{"disabled":false,"description":"(Required) ","key":"Content-Type","value":"application/json"},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"Bad Request\",\n \"status\": 400,\n \"timestamp\": \"2020-10-29T13:08:16.235Z\",\n \"path\": \"/exampleEndpoint\",\n \"message\": \"Some fields did not pass validation\",\n \"errors\": [\n {\n \"code\": 120,\n \"field\": \"exampleField\",\n \"message\": \"120\",\n \"rejectedValue\": \"exampleValue\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"13d357ea-a846-4e7c-93db-60944b8f8a64","name":"Forbidden; insufficient permissions (when PII protection is enabled, PII permissions are required in addition to the permissions listed in the method description)","originalRequest":{"url":{"path":["v4","clients",":clientId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"434428563","key":"clientId","description":"(Required) The ID of the profile\n\n**Upcoming breaking change (effective July 6, 2026):** Synerise is introducing changes to how user identifiers and UUIDs are handled. These changes may affect profiles with accented or diacritical characters in identifiers, profiles with leading or trailing whitespace in identifiers, and profiles with duplicate UUIDs. For details and recommended actions, see [Upcoming changes to identifier and UUID handling](https://hub.synerise.com/docs/settings/configuration/identifier-standardization/).\n"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Accept","value":"application/json"},{"disabled":false,"description":"(Required) ","key":"Content-Type","value":"application/json"},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"2018-06-07T07:29:27.489+00:00\",\n \"status\": 403,\n \"error\": \"Forbidden\",\n \"message\": \"Forbidden\",\n \"path\": \"/path_of_the_endpoint\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"d63e16ef-3e0a-441d-af68-2f553feeed97","name":"Profile not found, or already deleted. The body is the message as plain text, although the response carries `Content-Type: application/json`.","originalRequest":{"url":{"path":["v4","clients",":clientId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"434428563","key":"clientId","description":"(Required) The ID of the profile\n\n**Upcoming breaking change (effective July 6, 2026):** Synerise is introducing changes to how user identifiers and UUIDs are handled. These changes may affect profiles with accented or diacritical characters in identifiers, profiles with leading or trailing whitespace in identifiers, and profiles with duplicate UUIDs. For details and recommended actions, see [Upcoming changes to identifier and UUID handling](https://hub.synerise.com/docs/settings/configuration/identifier-standardization/).\n"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Accept","value":"application/json"},{"disabled":false,"description":"(Required) ","key":"Content-Type","value":"application/json"},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"\"Client 525446575 not found\"","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"332647cc-e0bc-4887-96a2-acb227b47480","name":"Update a profile (identify by email)","request":{"name":"Update a profile (identify by email)","description":{"content":"Change the details of a profile in the Synerise application database.

Sending a null value deletes an attribute (if it's a custom attribute) or sets it to null/default value (if the attribute is Synerise-native).\n\nThe `attributes` object can be used to add custom attributes of your choice. For example, `\"hasDog\":true`.\n\nThe `tags` array contains custom tags of your choice.\n\nThis is an asynchronous operation. After the request body is validated, the request is added to the queue (HTTP 202) as an [Ongoing import](https://hub.synerise.com/docs/assets/imports/importing-clients/#import-modes).\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `API_BY_EMAIL_CLIENT_UPDATE`\n\n**User role permission required:** `client_info: update`\n","type":"text/plain"},"url":{"path":["v4","clients","by-email",":clientEmail"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"clientemail@synerise.com","key":"clientEmail","description":"(Required) The profile's email address\n\n- Must match the pattern (ECMA flavor): `/^(([^<>()[\\]\\\\.,;:\\s@\\\\\"]+(\\.[^<>()[\\]\\\\.,;:\\s@\\\\\"]+)*)|(\\\\\".+\\\\\"))@((\\[[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}\\])|(([a-zA-Z\\-0-9]+\\.)+[a-zA-Z]{2,}))$/`\n- The value can't include any characters that match the patternn (ECMA flavor): `/([\\uD800-\\uDBFF][\\uDC00-\\uDFFF])|([\\r\\n\\u2028\\u2029\\u00AD]|[\\uFE00-\\uFE0F]|[\\u0000])/`\n\n**Upcoming breaking change (effective July 6, 2026):** Synerise is introducing changes to how user identifiers and UUIDs are handled. These changes may affect profiles with accented or diacritical characters in identifiers, profiles with leading or trailing whitespace in identifiers, and profiles with duplicate UUIDs. For details and recommended actions, see [Upcoming changes to identifier and UUID handling](https://hub.synerise.com/docs/settings/configuration/identifier-standardization/).\n"}]},"header":[{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"email\": \"string\",\n \"phone\": \"+48111222333\",\n \"customId\": \"string\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"displayName\": \"string\",\n \"uuid\": \"07243772-008a-42e1-ba37-c3807cebde8f\",\n \"avatarUrl\": \"string\",\n \"birthDate\": \"1987-10-24\",\n \"company\": \"string\",\n \"city\": \"string\",\n \"address\": \"string\",\n \"zipCode\": \"string\",\n \"province\": \"string\",\n \"countryCode\": \"PL\",\n \"sex\": \"MALE\",\n \"whatsAppId\": \"TestWhatsappId\",\n \"agreements\": {\n \"email\": {\n \"value\": \"\"\n },\n \"sms\": {\n \"value\": \"\"\n },\n \"push\": {\n \"value\": \"\"\n },\n \"webPush\": {\n \"value\": \"\"\n },\n \"whatsApp\": {\n \"value\": \"\"\n },\n \"bluetooth\": {\n \"value\": \"\"\n },\n \"rfid\": {\n \"value\": \"\"\n },\n \"wifi\": {\n \"value\": \"\"\n }\n },\n \"attributes\": {\n \"key_0\": {\n \"value\": \"\"\n }\n },\n \"tags\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"496cf860-00ce-4459-ad01-2f9c5714ba58","name":"Accepted, queued for processing","originalRequest":{"url":{"path":["v4","clients","by-email",":clientEmail"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"clientemail@synerise.com","key":"clientEmail","description":"(Required) The profile's email address\n\n- Must match the pattern (ECMA flavor): `/^(([^<>()[\\]\\\\.,;:\\s@\\\\\"]+(\\.[^<>()[\\]\\\\.,;:\\s@\\\\\"]+)*)|(\\\\\".+\\\\\"))@((\\[[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}\\])|(([a-zA-Z\\-0-9]+\\.)+[a-zA-Z]{2,}))$/`\n- The value can't include any characters that match the patternn (ECMA flavor): `/([\\uD800-\\uDBFF][\\uDC00-\\uDFFF])|([\\r\\n\\u2028\\u2029\\u00AD]|[\\uFE00-\\uFE0F]|[\\u0000])/`\n\n**Upcoming breaking change (effective July 6, 2026):** Synerise is introducing changes to how user identifiers and UUIDs are handled. These changes may affect profiles with accented or diacritical characters in identifiers, profiles with leading or trailing whitespace in identifiers, and profiles with duplicate UUIDs. For details and recommended actions, see [Upcoming changes to identifier and UUID handling](https://hub.synerise.com/docs/settings/configuration/identifier-standardization/).\n"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"email\": \"string\",\n \"phone\": \"+48111222333\",\n \"customId\": \"string\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"displayName\": \"string\",\n \"uuid\": \"07243772-008a-42e1-ba37-c3807cebde8f\",\n \"avatarUrl\": \"string\",\n \"birthDate\": \"1987-10-24\",\n \"company\": \"string\",\n \"city\": \"string\",\n \"address\": \"string\",\n \"zipCode\": \"string\",\n \"province\": \"string\",\n \"countryCode\": \"PL\",\n \"sex\": \"MALE\",\n \"whatsAppId\": \"TestWhatsappId\",\n \"agreements\": {\n \"email\": {\n \"value\": \"\"\n },\n \"sms\": {\n \"value\": \"\"\n },\n \"push\": {\n \"value\": \"\"\n },\n \"webPush\": {\n \"value\": \"\"\n },\n \"whatsApp\": {\n \"value\": \"\"\n },\n \"bluetooth\": {\n \"value\": \"\"\n },\n \"rfid\": {\n \"value\": \"\"\n },\n \"wifi\": {\n \"value\": \"\"\n }\n },\n \"attributes\": {\n \"key_0\": {\n \"value\": \"\"\n }\n },\n \"tags\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"Accepted","code":202,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"22a6d6c6-4420-431a-8c11-e86d4c518bd0","name":"Bad Request","originalRequest":{"url":{"path":["v4","clients","by-email",":clientEmail"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"clientemail@synerise.com","key":"clientEmail","description":"(Required) The profile's email address\n\n- Must match the pattern (ECMA flavor): `/^(([^<>()[\\]\\\\.,;:\\s@\\\\\"]+(\\.[^<>()[\\]\\\\.,;:\\s@\\\\\"]+)*)|(\\\\\".+\\\\\"))@((\\[[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}\\])|(([a-zA-Z\\-0-9]+\\.)+[a-zA-Z]{2,}))$/`\n- The value can't include any characters that match the patternn (ECMA flavor): `/([\\uD800-\\uDBFF][\\uDC00-\\uDFFF])|([\\r\\n\\u2028\\u2029\\u00AD]|[\\uFE00-\\uFE0F]|[\\u0000])/`\n\n**Upcoming breaking change (effective July 6, 2026):** Synerise is introducing changes to how user identifiers and UUIDs are handled. These changes may affect profiles with accented or diacritical characters in identifiers, profiles with leading or trailing whitespace in identifiers, and profiles with duplicate UUIDs. For details and recommended actions, see [Upcoming changes to identifier and UUID handling](https://hub.synerise.com/docs/settings/configuration/identifier-standardization/).\n"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"email\": \"string\",\n \"phone\": \"+48111222333\",\n \"customId\": \"string\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"displayName\": \"string\",\n \"uuid\": \"07243772-008a-42e1-ba37-c3807cebde8f\",\n \"avatarUrl\": \"string\",\n \"birthDate\": \"1987-10-24\",\n \"company\": \"string\",\n \"city\": \"string\",\n \"address\": \"string\",\n \"zipCode\": \"string\",\n \"province\": \"string\",\n \"countryCode\": \"PL\",\n \"sex\": \"MALE\",\n \"whatsAppId\": \"TestWhatsappId\",\n \"agreements\": {\n \"email\": {\n \"value\": \"\"\n },\n \"sms\": {\n \"value\": \"\"\n },\n \"push\": {\n \"value\": \"\"\n },\n \"webPush\": {\n \"value\": \"\"\n },\n \"whatsApp\": {\n \"value\": \"\"\n },\n \"bluetooth\": {\n \"value\": \"\"\n },\n \"rfid\": {\n \"value\": \"\"\n },\n \"wifi\": {\n \"value\": \"\"\n }\n },\n \"attributes\": {\n \"key_0\": {\n \"value\": \"\"\n }\n },\n \"tags\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"Bad Request\",\n \"status\": 400,\n \"timestamp\": \"2019-03-21T08:37:34.526Z\",\n \"path\": \"/clients/by-email/client@synerise.com\",\n \"message\": \"Some fields did not pass validation\",\n \"errors\": [\n {\n \"code\": 12053,\n \"field\": \"uuid\",\n \"message\": \"UUID must be well-formed value as per RFC 4122\",\n \"rejectedValue\": \"4321\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"e5b993ea-08da-43fd-86ea-d6be2b8feb09","name":"Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc.","originalRequest":{"url":{"path":["v4","clients","by-email",":clientEmail"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"clientemail@synerise.com","key":"clientEmail","description":"(Required) The profile's email address\n\n- Must match the pattern (ECMA flavor): `/^(([^<>()[\\]\\\\.,;:\\s@\\\\\"]+(\\.[^<>()[\\]\\\\.,;:\\s@\\\\\"]+)*)|(\\\\\".+\\\\\"))@((\\[[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}\\])|(([a-zA-Z\\-0-9]+\\.)+[a-zA-Z]{2,}))$/`\n- The value can't include any characters that match the patternn (ECMA flavor): `/([\\uD800-\\uDBFF][\\uDC00-\\uDFFF])|([\\r\\n\\u2028\\u2029\\u00AD]|[\\uFE00-\\uFE0F]|[\\u0000])/`\n\n**Upcoming breaking change (effective July 6, 2026):** Synerise is introducing changes to how user identifiers and UUIDs are handled. These changes may affect profiles with accented or diacritical characters in identifiers, profiles with leading or trailing whitespace in identifiers, and profiles with duplicate UUIDs. For details and recommended actions, see [Upcoming changes to identifier and UUID handling](https://hub.synerise.com/docs/settings/configuration/identifier-standardization/).\n"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"email\": \"string\",\n \"phone\": \"+48111222333\",\n \"customId\": \"string\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"displayName\": \"string\",\n \"uuid\": \"07243772-008a-42e1-ba37-c3807cebde8f\",\n \"avatarUrl\": \"string\",\n \"birthDate\": \"1987-10-24\",\n \"company\": \"string\",\n \"city\": \"string\",\n \"address\": \"string\",\n \"zipCode\": \"string\",\n \"province\": \"string\",\n \"countryCode\": \"PL\",\n \"sex\": \"MALE\",\n \"whatsAppId\": \"TestWhatsappId\",\n \"agreements\": {\n \"email\": {\n \"value\": \"\"\n },\n \"sms\": {\n \"value\": \"\"\n },\n \"push\": {\n \"value\": \"\"\n },\n \"webPush\": {\n \"value\": \"\"\n },\n \"whatsApp\": {\n \"value\": \"\"\n },\n \"bluetooth\": {\n \"value\": \"\"\n },\n \"rfid\": {\n \"value\": \"\"\n },\n \"wifi\": {\n \"value\": \"\"\n }\n },\n \"attributes\": {\n \"key_0\": {\n \"value\": \"\"\n }\n },\n \"tags\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"Bad Request\",\n \"status\": 400,\n \"timestamp\": \"2020-10-29T13:08:16.235Z\",\n \"path\": \"/exampleEndpoint\",\n \"message\": \"Some fields did not pass validation\",\n \"errors\": [\n {\n \"code\": 120,\n \"field\": \"exampleField\",\n \"message\": \"120\",\n \"rejectedValue\": \"exampleValue\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"2b6a9c35-ef4e-4ede-ad2f-278e3df90452","name":"Forbidden; insufficient permissions (when PII protection is enabled, PII permissions are required in addition to the permissions listed in the method description)","originalRequest":{"url":{"path":["v4","clients","by-email",":clientEmail"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"clientemail@synerise.com","key":"clientEmail","description":"(Required) The profile's email address\n\n- Must match the pattern (ECMA flavor): `/^(([^<>()[\\]\\\\.,;:\\s@\\\\\"]+(\\.[^<>()[\\]\\\\.,;:\\s@\\\\\"]+)*)|(\\\\\".+\\\\\"))@((\\[[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}\\])|(([a-zA-Z\\-0-9]+\\.)+[a-zA-Z]{2,}))$/`\n- The value can't include any characters that match the patternn (ECMA flavor): `/([\\uD800-\\uDBFF][\\uDC00-\\uDFFF])|([\\r\\n\\u2028\\u2029\\u00AD]|[\\uFE00-\\uFE0F]|[\\u0000])/`\n\n**Upcoming breaking change (effective July 6, 2026):** Synerise is introducing changes to how user identifiers and UUIDs are handled. These changes may affect profiles with accented or diacritical characters in identifiers, profiles with leading or trailing whitespace in identifiers, and profiles with duplicate UUIDs. For details and recommended actions, see [Upcoming changes to identifier and UUID handling](https://hub.synerise.com/docs/settings/configuration/identifier-standardization/).\n"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"email\": \"string\",\n \"phone\": \"+48111222333\",\n \"customId\": \"string\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"displayName\": \"string\",\n \"uuid\": \"07243772-008a-42e1-ba37-c3807cebde8f\",\n \"avatarUrl\": \"string\",\n \"birthDate\": \"1987-10-24\",\n \"company\": \"string\",\n \"city\": \"string\",\n \"address\": \"string\",\n \"zipCode\": \"string\",\n \"province\": \"string\",\n \"countryCode\": \"PL\",\n \"sex\": \"MALE\",\n \"whatsAppId\": \"TestWhatsappId\",\n \"agreements\": {\n \"email\": {\n \"value\": \"\"\n },\n \"sms\": {\n \"value\": \"\"\n },\n \"push\": {\n \"value\": \"\"\n },\n \"webPush\": {\n \"value\": \"\"\n },\n \"whatsApp\": {\n \"value\": \"\"\n },\n \"bluetooth\": {\n \"value\": \"\"\n },\n \"rfid\": {\n \"value\": \"\"\n },\n \"wifi\": {\n \"value\": \"\"\n }\n },\n \"attributes\": {\n \"key_0\": {\n \"value\": \"\"\n }\n },\n \"tags\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"2018-06-07T07:29:27.489+00:00\",\n \"status\": 403,\n \"error\": \"Forbidden\",\n \"message\": \"Forbidden\",\n \"path\": \"/path_of_the_endpoint\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"5b414fa9-1abe-43c5-b126-348a3e72e402","name":"Profile not found","originalRequest":{"url":{"path":["v4","clients","by-email",":clientEmail"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"clientemail@synerise.com","key":"clientEmail","description":"(Required) The profile's email address\n\n- Must match the pattern (ECMA flavor): `/^(([^<>()[\\]\\\\.,;:\\s@\\\\\"]+(\\.[^<>()[\\]\\\\.,;:\\s@\\\\\"]+)*)|(\\\\\".+\\\\\"))@((\\[[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}\\])|(([a-zA-Z\\-0-9]+\\.)+[a-zA-Z]{2,}))$/`\n- The value can't include any characters that match the patternn (ECMA flavor): `/([\\uD800-\\uDBFF][\\uDC00-\\uDFFF])|([\\r\\n\\u2028\\u2029\\u00AD]|[\\uFE00-\\uFE0F]|[\\u0000])/`\n\n**Upcoming breaking change (effective July 6, 2026):** Synerise is introducing changes to how user identifiers and UUIDs are handled. These changes may affect profiles with accented or diacritical characters in identifiers, profiles with leading or trailing whitespace in identifiers, and profiles with duplicate UUIDs. For details and recommended actions, see [Upcoming changes to identifier and UUID handling](https://hub.synerise.com/docs/settings/configuration/identifier-standardization/).\n"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"email\": \"string\",\n \"phone\": \"+48111222333\",\n \"customId\": \"string\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"displayName\": \"string\",\n \"uuid\": \"07243772-008a-42e1-ba37-c3807cebde8f\",\n \"avatarUrl\": \"string\",\n \"birthDate\": \"1987-10-24\",\n \"company\": \"string\",\n \"city\": \"string\",\n \"address\": \"string\",\n \"zipCode\": \"string\",\n \"province\": \"string\",\n \"countryCode\": \"PL\",\n \"sex\": \"MALE\",\n \"whatsAppId\": \"TestWhatsappId\",\n \"agreements\": {\n \"email\": {\n \"value\": \"\"\n },\n \"sms\": {\n \"value\": \"\"\n },\n \"push\": {\n \"value\": \"\"\n },\n \"webPush\": {\n \"value\": \"\"\n },\n \"whatsApp\": {\n \"value\": \"\"\n },\n \"bluetooth\": {\n \"value\": \"\"\n },\n \"rfid\": {\n \"value\": \"\"\n },\n \"wifi\": {\n \"value\": \"\"\n }\n },\n \"attributes\": {\n \"key_0\": {\n \"value\": \"\"\n }\n },\n \"tags\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"2018-06-07T09:48:56.522+00:00\",\n \"status\": 404,\n \"error\": \"Not Found\",\n \"message\": \"No client record found for email: client@synerise.com\",\n \"path\": \"/clients/by-email/client@synerise.com\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"15b79645-0a5e-4c64-ac33-8c31dd64196e","name":"Unsupported Media Type","originalRequest":{"url":{"path":["v4","clients","by-email",":clientEmail"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"clientemail@synerise.com","key":"clientEmail","description":"(Required) The profile's email address\n\n- Must match the pattern (ECMA flavor): `/^(([^<>()[\\]\\\\.,;:\\s@\\\\\"]+(\\.[^<>()[\\]\\\\.,;:\\s@\\\\\"]+)*)|(\\\\\".+\\\\\"))@((\\[[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}\\])|(([a-zA-Z\\-0-9]+\\.)+[a-zA-Z]{2,}))$/`\n- The value can't include any characters that match the patternn (ECMA flavor): `/([\\uD800-\\uDBFF][\\uDC00-\\uDFFF])|([\\r\\n\\u2028\\u2029\\u00AD]|[\\uFE00-\\uFE0F]|[\\u0000])/`\n\n**Upcoming breaking change (effective July 6, 2026):** Synerise is introducing changes to how user identifiers and UUIDs are handled. These changes may affect profiles with accented or diacritical characters in identifiers, profiles with leading or trailing whitespace in identifiers, and profiles with duplicate UUIDs. For details and recommended actions, see [Upcoming changes to identifier and UUID handling](https://hub.synerise.com/docs/settings/configuration/identifier-standardization/).\n"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"email\": \"string\",\n \"phone\": \"+48111222333\",\n \"customId\": \"string\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"displayName\": \"string\",\n \"uuid\": \"07243772-008a-42e1-ba37-c3807cebde8f\",\n \"avatarUrl\": \"string\",\n \"birthDate\": \"1987-10-24\",\n \"company\": \"string\",\n \"city\": \"string\",\n \"address\": \"string\",\n \"zipCode\": \"string\",\n \"province\": \"string\",\n \"countryCode\": \"PL\",\n \"sex\": \"MALE\",\n \"whatsAppId\": \"TestWhatsappId\",\n \"agreements\": {\n \"email\": {\n \"value\": \"\"\n },\n \"sms\": {\n \"value\": \"\"\n },\n \"push\": {\n \"value\": \"\"\n },\n \"webPush\": {\n \"value\": \"\"\n },\n \"whatsApp\": {\n \"value\": \"\"\n },\n \"bluetooth\": {\n \"value\": \"\"\n },\n \"rfid\": {\n \"value\": \"\"\n },\n \"wifi\": {\n \"value\": \"\"\n }\n },\n \"attributes\": {\n \"key_0\": {\n \"value\": \"\"\n }\n },\n \"tags\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"Unsupported Media Type","code":415,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"2018-06-07T07:27:23.136+00:00\",\n \"status\": 415,\n \"error\": \"Unsupported Media Type\",\n \"message\": \"Content type 'application/xml' not supported\",\n \"path\": \"/path_of_the_endpoint\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"8adcd35c-5e45-49b8-9859-1e7288cc17f6","name":"Update a profile (identify by customId)","request":{"name":"Update a profile (identify by customId)","description":{"content":"Change the details of a profile in the Synerise application database.

Sending a null value deletes an attribute (if it's a custom attribute) or sets it to null/default value (if the attribute is Synerise-native).\n \nThe `attributes` object can be used to add custom attributes of your choice. For example, `\"hasDog\":true`.\n\nThe `tags` array contains custom tags of your choice.\n\nThis is an asynchronous operation. After the request body is validated, the request is added to the queue (HTTP 202) as an [Ongoing import](https://hub.synerise.com/docs/assets/imports/importing-clients/#import-modes).\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `API_BY_CUSTOM_ID_CLIENT_UPDATE`\n\n**User role permission required:** `client_info: update`\n","type":"text/plain"},"url":{"path":["v4","clients","by-customid",":customId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"customIdExample","key":"customId","description":"(Required) The custom ID of the profile\n\n**Upcoming breaking change (effective July 6, 2026):** Synerise is introducing changes to how user identifiers and UUIDs are handled. These changes may affect profiles with accented or diacritical characters in identifiers, profiles with leading or trailing whitespace in identifiers, and profiles with duplicate UUIDs. For details and recommended actions, see [Upcoming changes to identifier and UUID handling](https://hub.synerise.com/docs/settings/configuration/identifier-standardization/).\n"}]},"header":[{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"email\": \"string\",\n \"phone\": \"+48111222333\",\n \"customId\": \"string\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"displayName\": \"string\",\n \"uuid\": \"07243772-008a-42e1-ba37-c3807cebde8f\",\n \"avatarUrl\": \"string\",\n \"birthDate\": \"1987-10-24\",\n \"company\": \"string\",\n \"city\": \"string\",\n \"address\": \"string\",\n \"zipCode\": \"string\",\n \"province\": \"string\",\n \"countryCode\": \"PL\",\n \"sex\": \"MALE\",\n \"whatsAppId\": \"TestWhatsappId\",\n \"agreements\": {\n \"email\": {\n \"value\": \"\"\n },\n \"sms\": {\n \"value\": \"\"\n },\n \"push\": {\n \"value\": \"\"\n },\n \"webPush\": {\n \"value\": \"\"\n },\n \"whatsApp\": {\n \"value\": \"\"\n },\n \"bluetooth\": {\n \"value\": \"\"\n },\n \"rfid\": {\n \"value\": \"\"\n },\n \"wifi\": {\n \"value\": \"\"\n }\n },\n \"attributes\": {\n \"key_0\": {\n \"value\": \"\"\n }\n },\n \"tags\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"0a57bc6b-3220-4214-a2a6-0d798a3b97f1","name":"Accepted, queued for processing","originalRequest":{"url":{"path":["v4","clients","by-customid",":customId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"customIdExample","key":"customId","description":"(Required) The custom ID of the profile\n\n**Upcoming breaking change (effective July 6, 2026):** Synerise is introducing changes to how user identifiers and UUIDs are handled. These changes may affect profiles with accented or diacritical characters in identifiers, profiles with leading or trailing whitespace in identifiers, and profiles with duplicate UUIDs. For details and recommended actions, see [Upcoming changes to identifier and UUID handling](https://hub.synerise.com/docs/settings/configuration/identifier-standardization/).\n"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"email\": \"string\",\n \"phone\": \"+48111222333\",\n \"customId\": \"string\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"displayName\": \"string\",\n \"uuid\": \"07243772-008a-42e1-ba37-c3807cebde8f\",\n \"avatarUrl\": \"string\",\n \"birthDate\": \"1987-10-24\",\n \"company\": \"string\",\n \"city\": \"string\",\n \"address\": \"string\",\n \"zipCode\": \"string\",\n \"province\": \"string\",\n \"countryCode\": \"PL\",\n \"sex\": \"MALE\",\n \"whatsAppId\": \"TestWhatsappId\",\n \"agreements\": {\n \"email\": {\n \"value\": \"\"\n },\n \"sms\": {\n \"value\": \"\"\n },\n \"push\": {\n \"value\": \"\"\n },\n \"webPush\": {\n \"value\": \"\"\n },\n \"whatsApp\": {\n \"value\": \"\"\n },\n \"bluetooth\": {\n \"value\": \"\"\n },\n \"rfid\": {\n \"value\": \"\"\n },\n \"wifi\": {\n \"value\": \"\"\n }\n },\n \"attributes\": {\n \"key_0\": {\n \"value\": \"\"\n }\n },\n \"tags\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"Accepted","code":202,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"a625a49f-86a6-4c65-ab82-3dbf26548860","name":"Bad Request","originalRequest":{"url":{"path":["v4","clients","by-customid",":customId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"customIdExample","key":"customId","description":"(Required) The custom ID of the profile\n\n**Upcoming breaking change (effective July 6, 2026):** Synerise is introducing changes to how user identifiers and UUIDs are handled. These changes may affect profiles with accented or diacritical characters in identifiers, profiles with leading or trailing whitespace in identifiers, and profiles with duplicate UUIDs. For details and recommended actions, see [Upcoming changes to identifier and UUID handling](https://hub.synerise.com/docs/settings/configuration/identifier-standardization/).\n"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"email\": \"string\",\n \"phone\": \"+48111222333\",\n \"customId\": \"string\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"displayName\": \"string\",\n \"uuid\": \"07243772-008a-42e1-ba37-c3807cebde8f\",\n \"avatarUrl\": \"string\",\n \"birthDate\": \"1987-10-24\",\n \"company\": \"string\",\n \"city\": \"string\",\n \"address\": \"string\",\n \"zipCode\": \"string\",\n \"province\": \"string\",\n \"countryCode\": \"PL\",\n \"sex\": \"MALE\",\n \"whatsAppId\": \"TestWhatsappId\",\n \"agreements\": {\n \"email\": {\n \"value\": \"\"\n },\n \"sms\": {\n \"value\": \"\"\n },\n \"push\": {\n \"value\": \"\"\n },\n \"webPush\": {\n \"value\": \"\"\n },\n \"whatsApp\": {\n \"value\": \"\"\n },\n \"bluetooth\": {\n \"value\": \"\"\n },\n \"rfid\": {\n \"value\": \"\"\n },\n \"wifi\": {\n \"value\": \"\"\n }\n },\n \"attributes\": {\n \"key_0\": {\n \"value\": \"\"\n }\n },\n \"tags\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"Bad Request\",\n \"status\": 400,\n \"timestamp\": \"2019-03-21T08:37:34.526Z\",\n \"path\": \"/clients/by-customid/customId1234\",\n \"message\": \"Some fields did not pass validation\",\n \"errors\": [\n {\n \"code\": 12053,\n \"field\": \"uuid\",\n \"message\": \"UUID must be well-formed value as per RFC 4122\",\n \"rejectedValue\": \"4321\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"1ec4a06b-1244-4f6f-a822-a271ea9ea476","name":"Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc.","originalRequest":{"url":{"path":["v4","clients","by-customid",":customId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"customIdExample","key":"customId","description":"(Required) The custom ID of the profile\n\n**Upcoming breaking change (effective July 6, 2026):** Synerise is introducing changes to how user identifiers and UUIDs are handled. These changes may affect profiles with accented or diacritical characters in identifiers, profiles with leading or trailing whitespace in identifiers, and profiles with duplicate UUIDs. For details and recommended actions, see [Upcoming changes to identifier and UUID handling](https://hub.synerise.com/docs/settings/configuration/identifier-standardization/).\n"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"email\": \"string\",\n \"phone\": \"+48111222333\",\n \"customId\": \"string\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"displayName\": \"string\",\n \"uuid\": \"07243772-008a-42e1-ba37-c3807cebde8f\",\n \"avatarUrl\": \"string\",\n \"birthDate\": \"1987-10-24\",\n \"company\": \"string\",\n \"city\": \"string\",\n \"address\": \"string\",\n \"zipCode\": \"string\",\n \"province\": \"string\",\n \"countryCode\": \"PL\",\n \"sex\": \"MALE\",\n \"whatsAppId\": \"TestWhatsappId\",\n \"agreements\": {\n \"email\": {\n \"value\": \"\"\n },\n \"sms\": {\n \"value\": \"\"\n },\n \"push\": {\n \"value\": \"\"\n },\n \"webPush\": {\n \"value\": \"\"\n },\n \"whatsApp\": {\n \"value\": \"\"\n },\n \"bluetooth\": {\n \"value\": \"\"\n },\n \"rfid\": {\n \"value\": \"\"\n },\n \"wifi\": {\n \"value\": \"\"\n }\n },\n \"attributes\": {\n \"key_0\": {\n \"value\": \"\"\n }\n },\n \"tags\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"Bad Request\",\n \"status\": 400,\n \"timestamp\": \"2020-10-29T13:08:16.235Z\",\n \"path\": \"/exampleEndpoint\",\n \"message\": \"Some fields did not pass validation\",\n \"errors\": [\n {\n \"code\": 120,\n \"field\": \"exampleField\",\n \"message\": \"120\",\n \"rejectedValue\": \"exampleValue\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"4a86101c-9b2a-48c3-a15e-49e7c4133516","name":"Forbidden; insufficient permissions (when PII protection is enabled, PII permissions are required in addition to the permissions listed in the method description)","originalRequest":{"url":{"path":["v4","clients","by-customid",":customId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"customIdExample","key":"customId","description":"(Required) The custom ID of the profile\n\n**Upcoming breaking change (effective July 6, 2026):** Synerise is introducing changes to how user identifiers and UUIDs are handled. These changes may affect profiles with accented or diacritical characters in identifiers, profiles with leading or trailing whitespace in identifiers, and profiles with duplicate UUIDs. For details and recommended actions, see [Upcoming changes to identifier and UUID handling](https://hub.synerise.com/docs/settings/configuration/identifier-standardization/).\n"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"email\": \"string\",\n \"phone\": \"+48111222333\",\n \"customId\": \"string\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"displayName\": \"string\",\n \"uuid\": \"07243772-008a-42e1-ba37-c3807cebde8f\",\n \"avatarUrl\": \"string\",\n \"birthDate\": \"1987-10-24\",\n \"company\": \"string\",\n \"city\": \"string\",\n \"address\": \"string\",\n \"zipCode\": \"string\",\n \"province\": \"string\",\n \"countryCode\": \"PL\",\n \"sex\": \"MALE\",\n \"whatsAppId\": \"TestWhatsappId\",\n \"agreements\": {\n \"email\": {\n \"value\": \"\"\n },\n \"sms\": {\n \"value\": \"\"\n },\n \"push\": {\n \"value\": \"\"\n },\n \"webPush\": {\n \"value\": \"\"\n },\n \"whatsApp\": {\n \"value\": \"\"\n },\n \"bluetooth\": {\n \"value\": \"\"\n },\n \"rfid\": {\n \"value\": \"\"\n },\n \"wifi\": {\n \"value\": \"\"\n }\n },\n \"attributes\": {\n \"key_0\": {\n \"value\": \"\"\n }\n },\n \"tags\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"2018-06-07T07:29:27.489+00:00\",\n \"status\": 403,\n \"error\": \"Forbidden\",\n \"message\": \"Forbidden\",\n \"path\": \"/path_of_the_endpoint\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"89118db6-de65-4b18-891d-f80e3480573e","name":"Profile not found","originalRequest":{"url":{"path":["v4","clients","by-customid",":customId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"customIdExample","key":"customId","description":"(Required) The custom ID of the profile\n\n**Upcoming breaking change (effective July 6, 2026):** Synerise is introducing changes to how user identifiers and UUIDs are handled. These changes may affect profiles with accented or diacritical characters in identifiers, profiles with leading or trailing whitespace in identifiers, and profiles with duplicate UUIDs. For details and recommended actions, see [Upcoming changes to identifier and UUID handling](https://hub.synerise.com/docs/settings/configuration/identifier-standardization/).\n"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"email\": \"string\",\n \"phone\": \"+48111222333\",\n \"customId\": \"string\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"displayName\": \"string\",\n \"uuid\": \"07243772-008a-42e1-ba37-c3807cebde8f\",\n \"avatarUrl\": \"string\",\n \"birthDate\": \"1987-10-24\",\n \"company\": \"string\",\n \"city\": \"string\",\n \"address\": \"string\",\n \"zipCode\": \"string\",\n \"province\": \"string\",\n \"countryCode\": \"PL\",\n \"sex\": \"MALE\",\n \"whatsAppId\": \"TestWhatsappId\",\n \"agreements\": {\n \"email\": {\n \"value\": \"\"\n },\n \"sms\": {\n \"value\": \"\"\n },\n \"push\": {\n \"value\": \"\"\n },\n \"webPush\": {\n \"value\": \"\"\n },\n \"whatsApp\": {\n \"value\": \"\"\n },\n \"bluetooth\": {\n \"value\": \"\"\n },\n \"rfid\": {\n \"value\": \"\"\n },\n \"wifi\": {\n \"value\": \"\"\n }\n },\n \"attributes\": {\n \"key_0\": {\n \"value\": \"\"\n }\n },\n \"tags\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"2018-06-07T09:48:56.522+00:00\",\n \"status\": 404,\n \"error\": \"Not Found\",\n \"message\": \"No client record found for customId: customId1234\",\n \"path\": \"/clients/by-customid/customId1234\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"4b92b451-812a-4cb3-839f-fdf7008de65a","name":"Unsupported Media Type","originalRequest":{"url":{"path":["v4","clients","by-customid",":customId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"customIdExample","key":"customId","description":"(Required) The custom ID of the profile\n\n**Upcoming breaking change (effective July 6, 2026):** Synerise is introducing changes to how user identifiers and UUIDs are handled. These changes may affect profiles with accented or diacritical characters in identifiers, profiles with leading or trailing whitespace in identifiers, and profiles with duplicate UUIDs. For details and recommended actions, see [Upcoming changes to identifier and UUID handling](https://hub.synerise.com/docs/settings/configuration/identifier-standardization/).\n"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"email\": \"string\",\n \"phone\": \"+48111222333\",\n \"customId\": \"string\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"displayName\": \"string\",\n \"uuid\": \"07243772-008a-42e1-ba37-c3807cebde8f\",\n \"avatarUrl\": \"string\",\n \"birthDate\": \"1987-10-24\",\n \"company\": \"string\",\n \"city\": \"string\",\n \"address\": \"string\",\n \"zipCode\": \"string\",\n \"province\": \"string\",\n \"countryCode\": \"PL\",\n \"sex\": \"MALE\",\n \"whatsAppId\": \"TestWhatsappId\",\n \"agreements\": {\n \"email\": {\n \"value\": \"\"\n },\n \"sms\": {\n \"value\": \"\"\n },\n \"push\": {\n \"value\": \"\"\n },\n \"webPush\": {\n \"value\": \"\"\n },\n \"whatsApp\": {\n \"value\": \"\"\n },\n \"bluetooth\": {\n \"value\": \"\"\n },\n \"rfid\": {\n \"value\": \"\"\n },\n \"wifi\": {\n \"value\": \"\"\n }\n },\n \"attributes\": {\n \"key_0\": {\n \"value\": \"\"\n }\n },\n \"tags\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"Unsupported Media Type","code":415,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"2018-06-07T07:27:23.136+00:00\",\n \"status\": 415,\n \"error\": \"Unsupported Media Type\",\n \"message\": \"Content type 'application/xml' not supported\",\n \"path\": \"/path_of_the_endpoint\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"4d306e7a-188c-442b-8a3c-04e4380fa38a","name":"Delete a profile (identify by customId)","request":{"name":"Delete a profile (identify by customId)","description":{"content":"Delete a profile from the database.\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `API_BY_ID_CLIENT_DELETE`\n\n**User role permission required:** `client_info: delete`\n","type":"text/plain"},"url":{"path":["v4","clients","by-custom-id",":customId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"customIdExample","key":"customId","description":"(Required) The custom ID of the profile\n\n**Upcoming breaking change (effective July 6, 2026):** Synerise is introducing changes to how user identifiers and UUIDs are handled. These changes may affect profiles with accented or diacritical characters in identifiers, profiles with leading or trailing whitespace in identifiers, and profiles with duplicate UUIDs. For details and recommended actions, see [Upcoming changes to identifier and UUID handling](https://hub.synerise.com/docs/settings/configuration/identifier-standardization/).\n"}]},"header":[{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"DELETE","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"29e5cc64-8634-4c39-adc1-a4faf459ee4f","name":"Accepted","originalRequest":{"url":{"path":["v4","clients","by-custom-id",":customId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"customIdExample","key":"customId","description":"(Required) The custom ID of the profile\n\n**Upcoming breaking change (effective July 6, 2026):** Synerise is introducing changes to how user identifiers and UUIDs are handled. These changes may affect profiles with accented or diacritical characters in identifiers, profiles with leading or trailing whitespace in identifiers, and profiles with duplicate UUIDs. For details and recommended actions, see [Upcoming changes to identifier and UUID handling](https://hub.synerise.com/docs/settings/configuration/identifier-standardization/).\n"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Content-Type","value":"application/json"},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"}],"method":"DELETE","body":{}},"status":"Accepted","code":202,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"4e07a67a-40ed-45c7-9219-0f277e4cf45c","name":"The custom id is not accepted, for example it is longer than 255 characters.","originalRequest":{"url":{"path":["v4","clients","by-custom-id",":customId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"customIdExample","key":"customId","description":"(Required) The custom ID of the profile\n\n**Upcoming breaking change (effective July 6, 2026):** Synerise is introducing changes to how user identifiers and UUIDs are handled. These changes may affect profiles with accented or diacritical characters in identifiers, profiles with leading or trailing whitespace in identifiers, and profiles with duplicate UUIDs. For details and recommended actions, see [Upcoming changes to identifier and UUID handling](https://hub.synerise.com/docs/settings/configuration/identifier-standardization/).\n"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Content-Type","value":"application/json"},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"2018-06-07T09:48:56.522+00:00\",\n \"status\": 400,\n \"error\": \"Bad Request\",\n \"message\": \"Invalid custom id\",\n \"path\": \"/clients/by-custom-id/customId1234\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"52746b3c-4efe-4de4-a6cc-abb9211d927d","name":"Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc.","originalRequest":{"url":{"path":["v4","clients","by-custom-id",":customId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"customIdExample","key":"customId","description":"(Required) The custom ID of the profile\n\n**Upcoming breaking change (effective July 6, 2026):** Synerise is introducing changes to how user identifiers and UUIDs are handled. These changes may affect profiles with accented or diacritical characters in identifiers, profiles with leading or trailing whitespace in identifiers, and profiles with duplicate UUIDs. For details and recommended actions, see [Upcoming changes to identifier and UUID handling](https://hub.synerise.com/docs/settings/configuration/identifier-standardization/).\n"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Content-Type","value":"application/json"},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"Bad Request\",\n \"status\": 400,\n \"timestamp\": \"2020-10-29T13:08:16.235Z\",\n \"path\": \"/exampleEndpoint\",\n \"message\": \"Some fields did not pass validation\",\n \"errors\": [\n {\n \"code\": 120,\n \"field\": \"exampleField\",\n \"message\": \"120\",\n \"rejectedValue\": \"exampleValue\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"c7169136-f0b2-4be4-b6f0-f94be4647c67","name":"Forbidden; insufficient permissions (when PII protection is enabled, PII permissions are required in addition to the permissions listed in the method description)","originalRequest":{"url":{"path":["v4","clients","by-custom-id",":customId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"customIdExample","key":"customId","description":"(Required) The custom ID of the profile\n\n**Upcoming breaking change (effective July 6, 2026):** Synerise is introducing changes to how user identifiers and UUIDs are handled. These changes may affect profiles with accented or diacritical characters in identifiers, profiles with leading or trailing whitespace in identifiers, and profiles with duplicate UUIDs. For details and recommended actions, see [Upcoming changes to identifier and UUID handling](https://hub.synerise.com/docs/settings/configuration/identifier-standardization/).\n"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Content-Type","value":"application/json"},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"2018-06-07T07:29:27.489+00:00\",\n \"status\": 403,\n \"error\": \"Forbidden\",\n \"message\": \"Forbidden\",\n \"path\": \"/path_of_the_endpoint\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"7e7adbfc-e30f-4607-9289-7987e6f25871","name":"Profile not found, or already deleted. The body is the message as plain text, although the response carries `Content-Type: application/json`.","originalRequest":{"url":{"path":["v4","clients","by-custom-id",":customId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"customIdExample","key":"customId","description":"(Required) The custom ID of the profile\n\n**Upcoming breaking change (effective July 6, 2026):** Synerise is introducing changes to how user identifiers and UUIDs are handled. These changes may affect profiles with accented or diacritical characters in identifiers, profiles with leading or trailing whitespace in identifiers, and profiles with duplicate UUIDs. For details and recommended actions, see [Upcoming changes to identifier and UUID handling](https://hub.synerise.com/docs/settings/configuration/identifier-standardization/).\n"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Content-Type","value":"application/json"},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"\"Client with customId: customId1234 not found\"","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"eb8535a3-dc73-46ac-97bc-a697112a6f25","name":"Fetch profile data","request":{"name":"Fetch profile data","description":{"content":" Get the details of a single profile. If PII protection is enabled and your API key/user doesn't have the required permissions, this endpoint can only return test profiles; other profiles return error 404.\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `API_BY_IDENTIFIER_CLIENT_READ`\n\n**User role permission required:** `client_info: read`\n","type":"text/plain"},"url":{"path":["v4","clients",":identifierType",":identifierValue"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"by-email","key":"identifierType","description":"(Required) The type of profile identifier to use for the request"},{"disabled":false,"type":"any","value":"address@domain.com","key":"identifierValue","description":"(Required) The value of the selected identifier. The value must be URL-encoded."}]},"header":[{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"e896402f-7737-4fc8-805f-0bb6cbaeaf27","name":"Details of a single profile","originalRequest":{"url":{"path":["v4","clients",":identifierType",":identifierValue"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"by-email","key":"identifierType","description":"(Required) The type of profile identifier to use for the request"},{"disabled":false,"type":"any","value":"address@domain.com","key":"identifierValue","description":"(Required) The value of the selected identifier. The value must be URL-encoded."}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Content-Type","value":"application/json"},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"clientId\": 433230297,\n \"email\": \"string\",\n \"phone\": \"+48111222333\",\n \"customId\": \"string\",\n \"uuid\": \"07243772-008a-42e1-ba37-c3807cebde8f\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"displayName\": \"string\",\n \"company\": \"string\",\n \"address\": \"string\",\n \"city\": \"string\",\n \"province\": \"string\",\n \"zipCode\": \"string\",\n \"countryCode\": \"PL\",\n \"birthDate\": \"1987-10-24\",\n \"sex\": \"OTHER\",\n \"avatarUrl\": \"string\",\n \"whatsAppId\": \"TestWhatsappId\",\n \"anonymous\": false,\n \"agreements\": {\n \"email\": {\n \"value\": \"\"\n },\n \"sms\": {\n \"value\": \"\"\n },\n \"push\": {\n \"value\": \"\"\n },\n \"webPush\": {\n \"value\": \"\"\n },\n \"whatsApp\": {\n \"value\": \"\"\n },\n \"bluetooth\": {\n \"value\": \"\"\n },\n \"rfid\": {\n \"value\": \"\"\n },\n \"wifi\": {\n \"value\": \"\"\n }\n },\n \"attributes\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n },\n \"key_2\": {\n \"value\": \"\"\n },\n \"key_3\": {\n \"value\": \"\"\n },\n \"key_4\": {\n \"value\": \"\"\n }\n },\n \"tags\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"previousClients\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"lastActivityDate\": \"2019-03-19T14:05:39Z\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"eb1da39c-2c77-4bb1-81cd-9b9e1e679aa4","name":"Bad Request","originalRequest":{"url":{"path":["v4","clients",":identifierType",":identifierValue"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"by-email","key":"identifierType","description":"(Required) The type of profile identifier to use for the request"},{"disabled":false,"type":"any","value":"address@domain.com","key":"identifierValue","description":"(Required) The value of the selected identifier. The value must be URL-encoded."}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Content-Type","value":"application/json"},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"path\": \"/clients/by-custom-id/444555\",\n \"message\": \"Api-Version header is required\",\n \"error\": \"Bad Request\",\n \"timestamp\": \"2018-06-07T09:33:59.183Z\",\n \"status\": 400\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"d81aa329-0750-40d3-9dd3-187f1d72f19b","name":"Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc.","originalRequest":{"url":{"path":["v4","clients",":identifierType",":identifierValue"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"by-email","key":"identifierType","description":"(Required) The type of profile identifier to use for the request"},{"disabled":false,"type":"any","value":"address@domain.com","key":"identifierValue","description":"(Required) The value of the selected identifier. The value must be URL-encoded."}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Content-Type","value":"application/json"},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"Bad Request\",\n \"status\": 400,\n \"timestamp\": \"2020-10-29T13:08:16.235Z\",\n \"path\": \"/exampleEndpoint\",\n \"message\": \"Some fields did not pass validation\",\n \"errors\": [\n {\n \"code\": 120,\n \"field\": \"exampleField\",\n \"message\": \"120\",\n \"rejectedValue\": \"exampleValue\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"6214a08f-843f-459f-bf1a-8add47612f7e","name":"Forbidden; insufficient permissions (when PII protection is enabled, PII permissions are required in addition to the permissions listed in the method description)","originalRequest":{"url":{"path":["v4","clients",":identifierType",":identifierValue"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"by-email","key":"identifierType","description":"(Required) The type of profile identifier to use for the request"},{"disabled":false,"type":"any","value":"address@domain.com","key":"identifierValue","description":"(Required) The value of the selected identifier. The value must be URL-encoded."}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Content-Type","value":"application/json"},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"2018-06-07T07:29:27.489+00:00\",\n \"status\": 403,\n \"error\": \"Forbidden\",\n \"message\": \"Forbidden\",\n \"path\": \"/path_of_the_endpoint\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"c41ad84a-a450-46a2-946b-3defdea3325b","name":"Profile not found or access blocked by PII protection settings","originalRequest":{"url":{"path":["v4","clients",":identifierType",":identifierValue"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"by-email","key":"identifierType","description":"(Required) The type of profile identifier to use for the request"},{"disabled":false,"type":"any","value":"address@domain.com","key":"identifierValue","description":"(Required) The value of the selected identifier. The value must be URL-encoded."}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Content-Type","value":"application/json"},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"\"Client 5005535044 not found\"","cookie":[],"_postman_previewlanguage":"json"},{"id":"ba1a265c-5800-4d41-bd8f-cb4dc4d2a9c1","name":"Unsupported Media Type","originalRequest":{"url":{"path":["v4","clients",":identifierType",":identifierValue"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"by-email","key":"identifierType","description":"(Required) The type of profile identifier to use for the request"},{"disabled":false,"type":"any","value":"address@domain.com","key":"identifierValue","description":"(Required) The value of the selected identifier. The value must be URL-encoded."}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Content-Type","value":"application/json"},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Unsupported Media Type","code":415,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"2018-06-07T07:27:23.136+00:00\",\n \"status\": 415,\n \"error\": \"Unsupported Media Type\",\n \"message\": \"Content type 'application/xml' not supported\",\n \"path\": \"/path_of_the_endpoint\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"b4776e3e-c860-4ef7-9ec9-851ddcd2b986","name":"Batch fetch profiles by phone number","request":{"name":"Batch fetch profiles by phone number","description":{"content":" Returns a detailed list of profiles associated with the provided phone number. The number saved in the profile must exactly match the number from the request. If no profiles match the criteria, an empty list is returned.\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `API_BY_IDENTIFIER_CLIENT_READ`\n\n**User role permission required:** `client_info: read`\n","type":"text/plain"},"url":{"path":["v4","clients","batch","by-phone",":phoneNumber"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"phoneNumber","description":"(Required) The phone number to search for in profiles. Must be an exact match. The value must be URL-encoded.\n\n**Upcoming breaking change (effective July 6, 2026):** Synerise is introducing changes to how user identifiers and UUIDs are handled. These changes may affect profiles with accented or diacritical characters in identifiers, profiles with leading or trailing whitespace in identifiers, and profiles with duplicate UUIDs. For details and recommended actions, see [Upcoming changes to identifier and UUID handling](https://hub.synerise.com/docs/settings/configuration/identifier-standardization/).\n"}]},"header":[{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"9a8941f8-ce5f-4332-b2da-ea04e19ae997","name":"Returns an array of profile details.","originalRequest":{"url":{"path":["v4","clients","batch","by-phone",":phoneNumber"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"phoneNumber","description":"(Required) The phone number to search for in profiles. Must be an exact match. The value must be URL-encoded.\n\n**Upcoming breaking change (effective July 6, 2026):** Synerise is introducing changes to how user identifiers and UUIDs are handled. These changes may affect profiles with accented or diacritical characters in identifiers, profiles with leading or trailing whitespace in identifiers, and profiles with duplicate UUIDs. For details and recommended actions, see [Upcoming changes to identifier and UUID handling](https://hub.synerise.com/docs/settings/configuration/identifier-standardization/).\n"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Content-Type","value":"application/json"},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"[\n {\n \"clientId\": {\n \"value\": \"\"\n },\n \"email\": {\n \"value\": \"\"\n },\n \"phone\": {\n \"value\": \"\"\n },\n \"customId\": {\n \"value\": \"\"\n },\n \"uuid\": {\n \"value\": \"\"\n },\n \"firstName\": {\n \"value\": \"\"\n },\n \"lastName\": {\n \"value\": \"\"\n },\n \"displayName\": {\n \"value\": \"\"\n },\n \"company\": {\n \"value\": \"\"\n },\n \"address\": {\n \"value\": \"\"\n },\n \"city\": {\n \"value\": \"\"\n },\n \"province\": {\n \"value\": \"\"\n },\n \"zipCode\": {\n \"value\": \"\"\n },\n \"countryCode\": {\n \"value\": \"\"\n },\n \"birthDate\": {\n \"value\": \"\"\n },\n \"sex\": {\n \"value\": \"\"\n },\n \"avatarUrl\": {\n \"value\": \"\"\n },\n \"whatsAppId\": {\n \"value\": \"\"\n },\n \"anonymous\": {\n \"value\": \"\"\n },\n \"agreements\": {\n \"value\": \"\"\n },\n \"attributes\": {\n \"value\": \"\"\n },\n \"tags\": {\n \"value\": \"\"\n },\n \"previousClients\": {\n \"value\": \"\"\n },\n \"lastActivityDate\": {\n \"value\": \"\"\n }\n },\n {\n \"clientId\": {\n \"value\": \"\"\n },\n \"email\": {\n \"value\": \"\"\n },\n \"phone\": {\n \"value\": \"\"\n },\n \"customId\": {\n \"value\": \"\"\n },\n \"uuid\": {\n \"value\": \"\"\n },\n \"firstName\": {\n \"value\": \"\"\n },\n \"lastName\": {\n \"value\": \"\"\n },\n \"displayName\": {\n \"value\": \"\"\n },\n \"company\": {\n \"value\": \"\"\n },\n \"address\": {\n \"value\": \"\"\n },\n \"city\": {\n \"value\": \"\"\n },\n \"province\": {\n \"value\": \"\"\n },\n \"zipCode\": {\n \"value\": \"\"\n },\n \"countryCode\": {\n \"value\": \"\"\n },\n \"birthDate\": {\n \"value\": \"\"\n },\n \"sex\": {\n \"value\": \"\"\n },\n \"avatarUrl\": {\n \"value\": \"\"\n },\n \"whatsAppId\": {\n \"value\": \"\"\n },\n \"anonymous\": {\n \"value\": \"\"\n },\n \"agreements\": {\n \"value\": \"\"\n },\n \"attributes\": {\n \"value\": \"\"\n },\n \"tags\": {\n \"value\": \"\"\n },\n \"previousClients\": {\n \"value\": \"\"\n },\n \"lastActivityDate\": {\n \"value\": \"\"\n }\n }\n]","cookie":[],"_postman_previewlanguage":"json"},{"id":"2b1cd14e-777c-4252-976e-7bc960dda7e0","name":"Bad Request","originalRequest":{"url":{"path":["v4","clients","batch","by-phone",":phoneNumber"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"phoneNumber","description":"(Required) The phone number to search for in profiles. Must be an exact match. The value must be URL-encoded.\n\n**Upcoming breaking change (effective July 6, 2026):** Synerise is introducing changes to how user identifiers and UUIDs are handled. These changes may affect profiles with accented or diacritical characters in identifiers, profiles with leading or trailing whitespace in identifiers, and profiles with duplicate UUIDs. For details and recommended actions, see [Upcoming changes to identifier and UUID handling](https://hub.synerise.com/docs/settings/configuration/identifier-standardization/).\n"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Content-Type","value":"application/json"},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"path\": \"/clients/by-phone/+12065550100/batch\",\n \"message\": \"Api-Version header is required\",\n \"error\": \"Bad Request\",\n \"timestamp\": \"2018-06-07T09:33:59.183Z\",\n \"status\": 400\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"f0792e11-0980-41d9-995a-8571ea8cbf9d","name":"Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc.","originalRequest":{"url":{"path":["v4","clients","batch","by-phone",":phoneNumber"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"phoneNumber","description":"(Required) The phone number to search for in profiles. Must be an exact match. The value must be URL-encoded.\n\n**Upcoming breaking change (effective July 6, 2026):** Synerise is introducing changes to how user identifiers and UUIDs are handled. These changes may affect profiles with accented or diacritical characters in identifiers, profiles with leading or trailing whitespace in identifiers, and profiles with duplicate UUIDs. For details and recommended actions, see [Upcoming changes to identifier and UUID handling](https://hub.synerise.com/docs/settings/configuration/identifier-standardization/).\n"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Content-Type","value":"application/json"},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"Bad Request\",\n \"status\": 400,\n \"timestamp\": \"2020-10-29T13:08:16.235Z\",\n \"path\": \"/exampleEndpoint\",\n \"message\": \"Some fields did not pass validation\",\n \"errors\": [\n {\n \"code\": 120,\n \"field\": \"exampleField\",\n \"message\": \"120\",\n \"rejectedValue\": \"exampleValue\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"1a652687-15d9-44b1-b7e8-4d3864850724","name":"Forbidden; insufficient permissions (when PII protection is enabled, PII permissions are required in addition to the permissions listed in the method description)","originalRequest":{"url":{"path":["v4","clients","batch","by-phone",":phoneNumber"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"phoneNumber","description":"(Required) The phone number to search for in profiles. Must be an exact match. The value must be URL-encoded.\n\n**Upcoming breaking change (effective July 6, 2026):** Synerise is introducing changes to how user identifiers and UUIDs are handled. These changes may affect profiles with accented or diacritical characters in identifiers, profiles with leading or trailing whitespace in identifiers, and profiles with duplicate UUIDs. For details and recommended actions, see [Upcoming changes to identifier and UUID handling](https://hub.synerise.com/docs/settings/configuration/identifier-standardization/).\n"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Content-Type","value":"application/json"},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"2018-06-07T07:29:27.489+00:00\",\n \"status\": 403,\n \"error\": \"Forbidden\",\n \"message\": \"Forbidden\",\n \"path\": \"/path_of_the_endpoint\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"b23afefd-bb02-428e-9222-60bd26b1c368","name":"Profile not found or access blocked by PII protection settings","originalRequest":{"url":{"path":["v4","clients","batch","by-phone",":phoneNumber"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"phoneNumber","description":"(Required) The phone number to search for in profiles. Must be an exact match. The value must be URL-encoded.\n\n**Upcoming breaking change (effective July 6, 2026):** Synerise is introducing changes to how user identifiers and UUIDs are handled. These changes may affect profiles with accented or diacritical characters in identifiers, profiles with leading or trailing whitespace in identifiers, and profiles with duplicate UUIDs. For details and recommended actions, see [Upcoming changes to identifier and UUID handling](https://hub.synerise.com/docs/settings/configuration/identifier-standardization/).\n"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Content-Type","value":"application/json"},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"\"Client 5005535044 not found\"","cookie":[],"_postman_previewlanguage":"json"},{"id":"5c7ecf4d-d5fd-4e6b-82cd-65bc7b9532b0","name":"Unsupported Media Type","originalRequest":{"url":{"path":["v4","clients","batch","by-phone",":phoneNumber"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"phoneNumber","description":"(Required) The phone number to search for in profiles. Must be an exact match. The value must be URL-encoded.\n\n**Upcoming breaking change (effective July 6, 2026):** Synerise is introducing changes to how user identifiers and UUIDs are handled. These changes may affect profiles with accented or diacritical characters in identifiers, profiles with leading or trailing whitespace in identifiers, and profiles with duplicate UUIDs. For details and recommended actions, see [Upcoming changes to identifier and UUID handling](https://hub.synerise.com/docs/settings/configuration/identifier-standardization/).\n"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Content-Type","value":"application/json"},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Unsupported Media Type","code":415,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"2018-06-07T07:27:23.136+00:00\",\n \"status\": 415,\n \"error\": \"Unsupported Media Type\",\n \"message\": \"Content type 'application/xml' not supported\",\n \"path\": \"/path_of_the_endpoint\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"30ab4ad0-13f9-4c3b-a9e4-ee75004d372e","name":"Create and run profile export","request":{"name":"Create and run profile export","description":{"content":"Request an export of profiles. The group of profiles to export is selected by pointing to a segmentation. After the export is completed, you can access the data with [GET /exports/clients/{taskId}/data](#operation/getExportedProfileData) or from [https://app.synerise.com/assets/exports](https://app.synerise.com/assets/exports).\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `CLIENT_EXPORTER_REPORT_CREATE`\n\n**User role permission required:** `settings_export: create`\n","type":"text/plain"},"url":{"path":["morph","exports","clients","segmentation"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"name\": \"string\",\n \"fields\": [\n \"id\",\n \"attr1\",\n \"attr2\"\n ],\n \"agreementFilter\": \"EMAIL\",\n \"segmentationHash\": \"496e09ce-f08f-7111-2ea8-f06769ebdba2\",\n \"excludedIds\": [\n 4863.3232068011275,\n 271.73630808530527\n ],\n \"tags\": [\n \"string\",\n \"string\"\n ],\n \"expressions\": [\n \"a122d275-685a-4c3a-2f96-c4af253722a9\",\n \"63d88f31-8833-0d6f-c15f-8d50417a6b93\"\n ],\n \"aggregates\": [\n \"c4c4918e-cc17-61f1-c185-cc9c753aea97\",\n \"7397adaf-05d6-1388-6fbc-2afa25990a08\"\n ],\n \"segmentations\": [\n \"8fc6d8b4-522e-4c1c-da67-a3d364274ff9\",\n \"a27380ab-7dea-ed9f-87f5-1b89134b47c3\"\n ]\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"1f3a5772-07c5-4556-82be-1700be8c17b3","name":"Export task created and queued","originalRequest":{"url":{"path":["morph","exports","clients","segmentation"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"name\": \"string\",\n \"fields\": [\n \"id\",\n \"attr1\",\n \"attr2\"\n ],\n \"agreementFilter\": \"ANONYMOUS\",\n \"segmentationHash\": \"9cfd2d40-3b86-54a3-8955-7d7bd16e2254\",\n \"excludedIds\": [\n 5380.226958823082,\n 9492.78127400772\n ],\n \"tags\": [\n \"string\",\n \"string\"\n ],\n \"expressions\": [\n \"53fd387f-92c9-613e-32ae-95ea0bca8a7c\",\n \"f147ca27-d44e-7859-fcbd-6c1415394838\"\n ],\n \"aggregates\": [\n \"fdcb11b0-ddc5-602f-fd98-f378cb96f9dc\",\n \"1d16c35a-a59c-c6c6-fd97-52a2df224844\"\n ],\n \"segmentations\": [\n \"6f474d59-ba86-ef7f-ba47-2e53f81bfaaf\",\n \"fd945ff1-4ea2-fd79-ee27-55ae6d42b578\"\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"taskId\": \"c4c145e0-dcf3-a56a-5e36-b0b891f3c5d3\",\n \"columnOrder\": [\n \"string\",\n \"string\"\n ],\n \"estimatedCount\": 6605.012962852455\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"761e4659-74a9-498f-960c-6f0381853f74","name":"Invalid request","originalRequest":{"url":{"path":["morph","exports","clients","segmentation"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"name\": \"string\",\n \"fields\": [\n \"id\",\n \"attr1\",\n \"attr2\"\n ],\n \"agreementFilter\": \"ANONYMOUS\",\n \"segmentationHash\": \"9cfd2d40-3b86-54a3-8955-7d7bd16e2254\",\n \"excludedIds\": [\n 5380.226958823082,\n 9492.78127400772\n ],\n \"tags\": [\n \"string\",\n \"string\"\n ],\n \"expressions\": [\n \"53fd387f-92c9-613e-32ae-95ea0bca8a7c\",\n \"f147ca27-d44e-7859-fcbd-6c1415394838\"\n ],\n \"aggregates\": [\n \"fdcb11b0-ddc5-602f-fd98-f378cb96f9dc\",\n \"1d16c35a-a59c-c6c6-fd97-52a2df224844\"\n ],\n \"segmentations\": [\n \"6f474d59-ba86-ef7f-ba47-2e53f81bfaaf\",\n \"fd945ff1-4ea2-fd79-ee27-55ae6d42b578\"\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"Bad Request\",\n \"status\": 400,\n \"timestamp\": \"2021-01-04T16:15:51.703Z\",\n \"message\": \"Message describing issue with provided request\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"dad7fb37-707d-4f06-a936-c1c56ac95a6b","name":"Check profile export status","request":{"name":"Check profile export status","description":{"content":"After creating an export with [POST /exports/clients/segmentation](#operation/runProfileExport), you can check its status. When the export is ready, you can access the data with [GET /exports/clients/{taskId}/data](#operation/getExportedProfileData).\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `CLIENT_EXPORTER_REPORT_CREATE`\n\n**User role permission required:** `settings_export: create`\n","type":"text/plain"},"url":{"path":["morph","exports","clients",":taskId","status"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"taskId","description":"(Required) Unique ID of the export task"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"9045a8df-63ea-44ff-ab57-c8479fadad1c","name":"Status of the export task","originalRequest":{"url":{"path":["morph","exports","clients",":taskId","status"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"taskId","description":"(Required) Unique ID of the export task"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"\"Pending\"","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"59a7f162-539d-4731-8aef-f22f35ff2f4c","name":"Get exported profiles","request":{"name":"Get exported profiles","description":{"content":"Get exported profiles as a list. To create the export, use [POST /exports/clients/segmentation](#operation/runProfileExport).\n\n**Tip**: If you want to download a CSV, JSON, or JSONL, find your export in [https://app.synerise.com/assets/exports](https://app.synerise.com/assets/exports).\n\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `CLIENT_EXPORTER_REPORT_CREATE`\n\n**User role permission required:** `settings_export: create`\n","type":"text/plain"},"url":{"path":["morph","exports","clients",":taskId","data"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"offset","value":"900.8027320744604","description":"(Required) The index of the first record to retrieve. Use this to paginate the exported data."},{"disabled":false,"key":"limit","value":"1042","description":"(Required) The number of records to retrieve. Use this to paginate the exported data."}],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"taskId","description":"(Required) Unique ID of the export task"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"30cda6b8-27f2-414a-bc63-c8f0d2f84c06","name":"Exported profile data","originalRequest":{"url":{"path":["morph","exports","clients",":taskId","data"],"host":["{{baseUrl}}"],"query":[{"key":"offset","value":"900.8027320744604"},{"key":"limit","value":"1042"}],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"taskId","description":"(Required) Unique ID of the export task"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"[\n {\n \"exampleAttribute\": \"foo\",\n \"exampleTag\": \"true\",\n \"exampleExpression\": \"23\",\n \"exampleAggregate\": \"74\",\n \"exampleSegmentation\": \"false\"\n },\n {\n \"exampleAttribute\": \"foo\",\n \"exampleTag\": \"true\",\n \"exampleExpression\": \"23\",\n \"exampleAggregate\": \"74\",\n \"exampleSegmentation\": \"false\"\n }\n]","cookie":[],"_postman_previewlanguage":"json"},{"id":"2913979d-ea8b-4b54-bea0-dbd81e3c5c7c","name":"Invalid request","originalRequest":{"url":{"path":["morph","exports","clients",":taskId","data"],"host":["{{baseUrl}}"],"query":[{"key":"offset","value":"900.8027320744604"},{"key":"limit","value":"1042"}],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"taskId","description":"(Required) Unique ID of the export task"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"Bad Request\",\n \"status\": 400,\n \"timestamp\": \"2021-01-04T16:15:51.703Z\",\n \"message\": \"Message describing issue with provided request\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"36878d50-2ee9-4969-be9b-40de07efcfa6","name":"Get all Profile notes","request":{"name":"Get all Profile notes","description":{"content":"Retrieve all notes associated with a single profile.\n\n---\n\n**API consumer:** Synerise User\n\n**User role permission required:** `client_notes: read`\n","type":"text/plain"},"url":{"path":["notes-service","by-id",":clientId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"4489","key":"clientId","description":"(Required) Profile ID"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"9a9d5c20-67ec-400c-8b9c-657c205521ff","name":"An array of notes","originalRequest":{"url":{"path":["notes-service","by-id",":clientId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"4489","key":"clientId","description":"(Required) Profile ID"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"[\n {\n \"body\": {\n \"value\": \"\"\n },\n \"created\": {\n \"value\": \"\"\n },\n \"createdBy\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n },\n \"subject\": {\n \"value\": \"\"\n },\n \"updated\": {\n \"value\": \"\"\n },\n \"updatedBy\": {\n \"value\": \"\"\n },\n \"userId\": {\n \"value\": \"\"\n }\n },\n {\n \"body\": {\n \"value\": \"\"\n },\n \"created\": {\n \"value\": \"\"\n },\n \"createdBy\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n },\n \"subject\": {\n \"value\": \"\"\n },\n \"updated\": {\n \"value\": \"\"\n },\n \"updatedBy\": {\n \"value\": \"\"\n },\n \"userId\": {\n \"value\": \"\"\n }\n }\n]","cookie":[],"_postman_previewlanguage":"json"},{"id":"b6494909-54cd-499d-aa2d-4c9a34ef68e6","name":"Unauthorized","originalRequest":{"url":{"path":["notes-service","by-id",":clientId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"4489","key":"clientId","description":"(Required) Profile ID"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"GET","body":{}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"38dd9408-415e-4dbc-93ba-7f5e37f502ca","name":"Forbidden","originalRequest":{"url":{"path":["notes-service","by-id",":clientId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"4489","key":"clientId","description":"(Required) Profile ID"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"GET","body":{}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"26cfc391-5db8-4059-ab28-551eb565e595","name":"Not Found","originalRequest":{"url":{"path":["notes-service","by-id",":clientId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"4489","key":"clientId","description":"(Required) Profile ID"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"GET","body":{}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"72d60ed2-1ad6-40e2-93d0-002c3c91737c","name":"Create a note","request":{"name":"Create a note","description":{"content":"Create a new note in the profile\n\n---\n\n**API consumer:** Synerise User\n\n**User role permission required:** `client_notes: create`\n","type":"text/plain"},"url":{"path":["notes-service","by-id",":clientId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"4489","key":"clientId","description":"(Required) Profile ID"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"subject\": \"Note 1\",\n \"body\": \"

NOTE 1

\\\\n

Some text

\\\\n
    \\\\n
  • 1
    • \\\\n
  • 2
    • \\\\n
  • 3
    • \\\\n
\\\\n
Lorem ipsum in quote
\\\\n

Lorem ipsum in bold

\\\\n\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"b8bb4c07-6d97-450a-ae69-20f0f3047d0d","name":"OK","originalRequest":{"url":{"path":["notes-service","by-id",":clientId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"4489","key":"clientId","description":"(Required) Profile ID"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"subject\": \"Note 1\",\n \"body\": \"

NOTE 1

\\\\n

Some text

\\\\n
    \\\\n
  • 1
    • \\\\n
  • 2
    • \\\\n
  • 3
    • \\\\n
\\\\n
Lorem ipsum in quote
\\\\n

Lorem ipsum in bold

\\\\n\"\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"body\": \"

NOTE 1

\\\\n

Some text

\\\\n
    \\\\n
  • 1
    • \\\\n
  • 2
    • \\\\n
  • 3
    • \\\\n
\\\\n
Lorem ipsum in quote
\\\\n

Lorem ipsum in bold

\\\\n\",\n \"created\": \"2019-08-01T08:03:31.556Z\",\n \"createdBy\": \"example@example.com\",\n \"id\": \"69b0e925-086a-4964-b8dc-4c9e58213cf5\",\n \"subject\": \"Note 1\",\n \"updated\": \"2019-08-01T08:03:38.556Z\",\n \"updatedBy\": \"example@example.com\",\n \"userId\": 11405\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"0721cf1d-9433-4507-b6e3-ef44a0a16894","name":"Created","originalRequest":{"url":{"path":["notes-service","by-id",":clientId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"4489","key":"clientId","description":"(Required) Profile ID"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"POST","body":{"mode":"raw","raw":"{\n \"subject\": \"Note 1\",\n \"body\": \"

NOTE 1

\\\\n

Some text

\\\\n
    \\\\n
  • 1
    • \\\\n
  • 2
    • \\\\n
  • 3
    • \\\\n
\\\\n
Lorem ipsum in quote
\\\\n

Lorem ipsum in bold

\\\\n\"\n}","options":{"raw":{"language":"json"}}}},"status":"Created","code":201,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"9be3dc78-c928-4275-9264-582c7aa9d250","name":"Unauthorized","originalRequest":{"url":{"path":["notes-service","by-id",":clientId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"4489","key":"clientId","description":"(Required) Profile ID"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"POST","body":{"mode":"raw","raw":"{\n \"subject\": \"Note 1\",\n \"body\": \"

NOTE 1

\\\\n

Some text

\\\\n
    \\\\n
  • 1
    • \\\\n
  • 2
    • \\\\n
  • 3
    • \\\\n
\\\\n
Lorem ipsum in quote
\\\\n

Lorem ipsum in bold

\\\\n\"\n}","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"9fbc83d6-d075-407a-a2e2-4976614ad4eb","name":"Forbidden","originalRequest":{"url":{"path":["notes-service","by-id",":clientId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"4489","key":"clientId","description":"(Required) Profile ID"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"POST","body":{"mode":"raw","raw":"{\n \"subject\": \"Note 1\",\n \"body\": \"

NOTE 1

\\\\n

Some text

\\\\n
    \\\\n
  • 1
    • \\\\n
  • 2
    • \\\\n
  • 3
    • \\\\n
\\\\n
Lorem ipsum in quote
\\\\n

Lorem ipsum in bold

\\\\n\"\n}","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"d00c5d84-295c-49eb-b284-b97b14ab7b0a","name":"Not Found","originalRequest":{"url":{"path":["notes-service","by-id",":clientId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"4489","key":"clientId","description":"(Required) Profile ID"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"POST","body":{"mode":"raw","raw":"{\n \"subject\": \"Note 1\",\n \"body\": \"

NOTE 1

\\\\n

Some text

\\\\n
    \\\\n
  • 1
    • \\\\n
  • 2
    • \\\\n
  • 3
    • \\\\n
\\\\n
Lorem ipsum in quote
\\\\n

Lorem ipsum in bold

\\\\n\"\n}","options":{"raw":{"language":"json"}}}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"97e22924-a840-4814-96be-c57529bb5737","name":"Get note","request":{"name":"Get note","description":{"content":"Retrieve a single note\n\n---\n\n**API consumer:** Synerise User\n\n**User role permission required:** `client_notes: read`\n","type":"text/plain"},"url":{"path":["notes-service","by-id",":clientId",":noteId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"4489","key":"clientId","description":"(Required) Profile ID"},{"disabled":false,"type":"any","value":"string","key":"noteId","description":"(Required) Note UUID"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"e9284c1d-c21b-4482-83ea-6844db5e3290","name":"OK","originalRequest":{"url":{"path":["notes-service","by-id",":clientId",":noteId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"4489","key":"clientId","description":"(Required) Profile ID"},{"disabled":false,"type":"any","value":"string","key":"noteId","description":"(Required) Note UUID"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"body\": \"

NOTE 1

\\\\n

Some text

\\\\n
    \\\\n
  • 1
    • \\\\n
  • 2
    • \\\\n
  • 3
    • \\\\n
\\\\n
Lorem ipsum in quote
\\\\n

Lorem ipsum in bold

\\\\n\",\n \"created\": \"2019-08-01T08:03:31.556Z\",\n \"createdBy\": \"example@example.com\",\n \"id\": \"69b0e925-086a-4964-b8dc-4c9e58213cf5\",\n \"subject\": \"Note 1\",\n \"updated\": \"2019-08-01T08:03:38.556Z\",\n \"updatedBy\": \"example@example.com\",\n \"userId\": 11405\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"d424b2ce-ea05-4417-9067-3d97a790ef83","name":"Unauthorized","originalRequest":{"url":{"path":["notes-service","by-id",":clientId",":noteId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"4489","key":"clientId","description":"(Required) Profile ID"},{"disabled":false,"type":"any","value":"string","key":"noteId","description":"(Required) Note UUID"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"GET","body":{}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"4b5359f1-a574-457f-b5d9-d74f7b105120","name":"Forbidden","originalRequest":{"url":{"path":["notes-service","by-id",":clientId",":noteId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"4489","key":"clientId","description":"(Required) Profile ID"},{"disabled":false,"type":"any","value":"string","key":"noteId","description":"(Required) Note UUID"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"GET","body":{}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"a1476d83-66db-4b8e-af78-c5d51265b5a7","name":"Not Found","originalRequest":{"url":{"path":["notes-service","by-id",":clientId",":noteId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"4489","key":"clientId","description":"(Required) Profile ID"},{"disabled":false,"type":"any","value":"string","key":"noteId","description":"(Required) Note UUID"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"GET","body":{}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"101a341f-0dd2-40a6-a056-bd676f0004ac","name":"Update note","request":{"name":"Update note","description":{"content":"You can update an existing note.\n\n---\n\n**API consumer:** Synerise User\n\n**User role permission required:** `client_notes: update`\n","type":"text/plain"},"url":{"path":["notes-service","by-id",":clientId",":noteId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"4489","key":"clientId","description":"(Required) Profile ID"},{"disabled":false,"type":"any","value":"string","key":"noteId","description":"(Required) Note UUID"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PUT","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"subject\": \"Note 1\",\n \"body\": \"

NOTE 1

\\\\n

Some text

\\\\n
    \\\\n
  • 1
    • \\\\n
  • 2
    • \\\\n
  • 3
    • \\\\n
\\\\n
Lorem ipsum in quote
\\\\n

Lorem ipsum in bold

\\\\n\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"d0c8d0c6-3400-4875-a529-fa038203d203","name":"OK","originalRequest":{"url":{"path":["notes-service","by-id",":clientId",":noteId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"4489","key":"clientId","description":"(Required) Profile ID"},{"disabled":false,"type":"any","value":"string","key":"noteId","description":"(Required) Note UUID"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"{\n \"subject\": \"Note 1\",\n \"body\": \"

NOTE 1

\\\\n

Some text

\\\\n
    \\\\n
  • 1
    • \\\\n
  • 2
    • \\\\n
  • 3
    • \\\\n
\\\\n
Lorem ipsum in quote
\\\\n

Lorem ipsum in bold

\\\\n\"\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"body\": \"

NOTE 1

\\\\n

Some text

\\\\n
    \\\\n
  • 1
    • \\\\n
  • 2
    • \\\\n
  • 3
    • \\\\n
\\\\n
Lorem ipsum in quote
\\\\n

Lorem ipsum in bold

\\\\n\",\n \"created\": \"2019-08-01T08:03:31.556Z\",\n \"createdBy\": \"example@example.com\",\n \"id\": \"69b0e925-086a-4964-b8dc-4c9e58213cf5\",\n \"subject\": \"Note 1\",\n \"updated\": \"2019-08-01T08:03:38.556Z\",\n \"updatedBy\": \"example@example.com\",\n \"userId\": 11405\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"0d09f1aa-d960-4e9e-ac18-a689a4129faa","name":"Created","originalRequest":{"url":{"path":["notes-service","by-id",":clientId",":noteId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"4489","key":"clientId","description":"(Required) Profile ID"},{"disabled":false,"type":"any","value":"string","key":"noteId","description":"(Required) Note UUID"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"PUT","body":{"mode":"raw","raw":"{\n \"subject\": \"Note 1\",\n \"body\": \"

NOTE 1

\\\\n

Some text

\\\\n
    \\\\n
  • 1
    • \\\\n
  • 2
    • \\\\n
  • 3
    • \\\\n
\\\\n
Lorem ipsum in quote
\\\\n

Lorem ipsum in bold

\\\\n\"\n}","options":{"raw":{"language":"json"}}}},"status":"Created","code":201,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"1f8fd7c8-b9c5-4389-8a89-de56dd8f0d10","name":"Unauthorized","originalRequest":{"url":{"path":["notes-service","by-id",":clientId",":noteId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"4489","key":"clientId","description":"(Required) Profile ID"},{"disabled":false,"type":"any","value":"string","key":"noteId","description":"(Required) Note UUID"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"PUT","body":{"mode":"raw","raw":"{\n \"subject\": \"Note 1\",\n \"body\": \"

NOTE 1

\\\\n

Some text

\\\\n
    \\\\n
  • 1
    • \\\\n
  • 2
    • \\\\n
  • 3
    • \\\\n
\\\\n
Lorem ipsum in quote
\\\\n

Lorem ipsum in bold

\\\\n\"\n}","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"1b22e775-a08c-4687-8144-c44627f73429","name":"Forbidden","originalRequest":{"url":{"path":["notes-service","by-id",":clientId",":noteId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"4489","key":"clientId","description":"(Required) Profile ID"},{"disabled":false,"type":"any","value":"string","key":"noteId","description":"(Required) Note UUID"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"PUT","body":{"mode":"raw","raw":"{\n \"subject\": \"Note 1\",\n \"body\": \"

NOTE 1

\\\\n

Some text

\\\\n
    \\\\n
  • 1
    • \\\\n
  • 2
    • \\\\n
  • 3
    • \\\\n
\\\\n
Lorem ipsum in quote
\\\\n

Lorem ipsum in bold

\\\\n\"\n}","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"927fd615-ac89-42d0-9b9b-c149bb113d55","name":"Not Found","originalRequest":{"url":{"path":["notes-service","by-id",":clientId",":noteId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"4489","key":"clientId","description":"(Required) Profile ID"},{"disabled":false,"type":"any","value":"string","key":"noteId","description":"(Required) Note UUID"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"PUT","body":{"mode":"raw","raw":"{\n \"subject\": \"Note 1\",\n \"body\": \"

NOTE 1

\\\\n

Some text

\\\\n
    \\\\n
  • 1
    • \\\\n
  • 2
    • \\\\n
  • 3
    • \\\\n
\\\\n
Lorem ipsum in quote
\\\\n

Lorem ipsum in bold

\\\\n\"\n}","options":{"raw":{"language":"json"}}}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"fd107ebb-46aa-49e0-bbdd-76541f317830","name":"Delete note","request":{"name":"Delete note","description":{"content":"You can delete a note. This operation is irreversible.\n\n---\n\n**API consumer:** Synerise User\n\n**User role permission required:** `client_notes: delete`\n","type":"text/plain"},"url":{"path":["notes-service","by-id",":clientId",":noteId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"4489","key":"clientId","description":"(Required) Profile ID"},{"disabled":false,"type":"any","value":"string","key":"noteId","description":"(Required) Note UUID"}]},"method":"DELETE","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"825dc4d5-5159-4395-ac1c-4ecd28e4e68a","name":"OK","originalRequest":{"url":{"path":["notes-service","by-id",":clientId",":noteId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"4489","key":"clientId","description":"(Required) Profile ID"},{"disabled":false,"type":"any","value":"string","key":"noteId","description":"(Required) Note UUID"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"DELETE","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"45689d0b-a210-4f08-bcdb-94b99d234305","name":"No Content","originalRequest":{"url":{"path":["notes-service","by-id",":clientId",":noteId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"4489","key":"clientId","description":"(Required) Profile ID"},{"disabled":false,"type":"any","value":"string","key":"noteId","description":"(Required) Note UUID"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"DELETE","body":{}},"status":"No Content","code":204,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"da0666fb-27f3-4f1f-b529-a28a69ada2ce","name":"Unauthorized","originalRequest":{"url":{"path":["notes-service","by-id",":clientId",":noteId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"4489","key":"clientId","description":"(Required) Profile ID"},{"disabled":false,"type":"any","value":"string","key":"noteId","description":"(Required) Note UUID"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"DELETE","body":{}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"19e04445-6575-4989-95fb-524d59bfd5bd","name":"Forbidden","originalRequest":{"url":{"path":["notes-service","by-id",":clientId",":noteId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"4489","key":"clientId","description":"(Required) Profile ID"},{"disabled":false,"type":"any","value":"string","key":"noteId","description":"(Required) Note UUID"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"DELETE","body":{}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"bc80feab-15b1-4835-a36c-957f40b4d65d","name":"Log out a Profile","request":{"name":"Log out a Profile","description":{"content":"Log out a Profile when authenticated as a Synerise User or a Workspace.\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `SAUTH_LOGOUT_CLIENT_CREATE`\n\n**User role permission required:** `settings_customers_iam: create`\n","type":"text/plain"},"url":{"path":["sauth","management","client",":clientID","logout"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"434428563","key":"clientID","description":"(Required) The ID of the Profile"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":null,"body":{"mode":"raw","raw":"{\n \"action\": \"LOGOUT\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"1cc59256-07ce-435a-ada3-68f8f81e29c6","name":"OK","originalRequest":{"url":{"path":["sauth","management","client",":clientID","logout"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"434428563","key":"clientID","description":"(Required) The ID of the Profile"}]},"method":"POST","body":{"mode":"raw","raw":"{\n \"action\": \"LOGOUT\"\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"61781d16-beed-40b6-bc1f-682c8854f371","name":"JWT missing, expired, or invalid","originalRequest":{"url":{"path":["sauth","management","client",":clientID","logout"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"434428563","key":"clientID","description":"(Required) The ID of the Profile"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"action\": \"LOGOUT\"\n}","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\",\n \"message\": \"string\",\n \"errors\": [\n {\n \"code\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"rejectedValue\": {\n \"value\": \"\"\n }\n },\n {\n \"code\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"rejectedValue\": {\n \"value\": \"\"\n }\n }\n ],\n \"status\": 8944,\n \"timestamp\": \"string\",\n \"path\": \"string\",\n \"traceId\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"e820177d-83d8-4f72-abdc-cc883c9aa3f0","name":"Insufficient permissions or wrong JWT scope (for example, profile token where a workspace token was required)","originalRequest":{"url":{"path":["sauth","management","client",":clientID","logout"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"434428563","key":"clientID","description":"(Required) The ID of the Profile"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"action\": \"LOGOUT\"\n}","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\",\n \"message\": \"string\",\n \"errors\": [\n {\n \"code\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"rejectedValue\": {\n \"value\": \"\"\n }\n },\n {\n \"code\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"rejectedValue\": {\n \"value\": \"\"\n }\n }\n ],\n \"status\": 8944,\n \"timestamp\": \"string\",\n \"path\": \"string\",\n \"traceId\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"aa6271d4-6ab8-44c0-8ced-a09a14a0b9e1","name":"Profile not found","originalRequest":{"url":{"path":["sauth","management","client",":clientID","logout"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"434428563","key":"clientID","description":"(Required) The ID of the Profile"}]},"method":"POST","body":{"mode":"raw","raw":"{\n \"action\": \"LOGOUT\"\n}","options":{"raw":{"language":"json"}}}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}],"event":[]},{"id":"b61caa05-555f-4430-9029-02a321066b2d","name":"Analytics: Expressions","description":{"content":"","type":"text/plain"},"item":[{"id":"894386ab-5a5a-47e7-8883-8ced614e52b0","name":"Get expressions for profile card","request":{"name":"Get expressions for profile card","description":{"content":"Retrieve expressions to display on a profile's card in the Profiles module (`\"isVisibleForClientProfile\": true` in the [expression config](https://developers.synerise.com/AnalyticsSuite/AnalyticsSuite.html#operation/addExpressionPOST)).\n\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `ANALYTICS_BACKEND_EXPRESSION_FOR_CLIENT_READ`\n\n**User role permission required (at least one):** `analytics: read`, `client_analytics_preview: read`\n","type":"text/plain"},"url":{"path":["analytics",":Namespace","expressions","visible-for-client","by",":IdentifierType"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"uuid","key":"IdentifierType","description":"(Required) Profile identifier type"},{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"identifierValue\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"87d7987b-7290-43d1-8fab-486e76d414c9","name":"List of calculated expressions configured as visible on the profile card","originalRequest":{"url":{"path":["analytics",":Namespace","expressions","visible-for-client","by",":IdentifierType"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"uuid","key":"IdentifierType","description":"(Required) Profile identifier type"},{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"identifierValue\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"[\n {\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"result\": {\n \"value\": \"\"\n }\n },\n {\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"result\": {\n \"value\": \"\"\n }\n }\n]","cookie":[],"_postman_previewlanguage":"json"},{"id":"e97b0447-fa7c-47a7-9da8-0f1dcfb5e3d6","name":"See error message for details","originalRequest":{"url":{"path":["analytics",":Namespace","expressions","visible-for-client","by",":IdentifierType"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"uuid","key":"IdentifierType","description":"(Required) Profile identifier type"},{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"identifierValue\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"source\": {\n \"pointer\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"timestamp\": {\n \"value\": \"\"\n },\n \"errorCode\": {\n \"value\": \"\"\n },\n \"httpStatus\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"traceId\": {\n \"value\": \"\"\n },\n \"help\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"9df07b98-f9c1-4a00-94d5-9dca7fb5fed9","name":"See error message for details","originalRequest":{"url":{"path":["analytics",":Namespace","expressions","visible-for-client","by",":IdentifierType"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"uuid","key":"IdentifierType","description":"(Required) Profile identifier type"},{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"identifierValue\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"source\": {\n \"pointer\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"timestamp\": {\n \"value\": \"\"\n },\n \"errorCode\": {\n \"value\": \"\"\n },\n \"httpStatus\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"traceId\": {\n \"value\": \"\"\n },\n \"help\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"c14f9af4-a375-4ba8-a29b-838d295f2ecd","name":"Calculate expression for profile","request":{"name":"Calculate expression for profile","description":{"content":"Calculate the result of an expression in context of a single profile.\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `ANALYTICS_BACKEND_EXPRESSION_FOR_CLIENT_READ`\n\n**User role permission required:** `analytics: read`\n","type":"text/plain"},"url":{"path":["analytics",":Namespace","expressions",":AnalysisId","calculate","by",":IdentifierType"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."},{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"AnalysisId","description":"(Required) UUID of the analysis"},{"disabled":false,"type":"any","value":"uuid","key":"IdentifierType","description":"(Required) Profile identifier type"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"identifierValue\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"9d7fccd5-598b-48c5-a4ca-e230937c3bcb","name":"Expression result","originalRequest":{"url":{"path":["analytics",":Namespace","expressions",":AnalysisId","calculate","by",":IdentifierType"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."},{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"AnalysisId","description":"(Required) UUID of the analysis"},{"disabled":false,"type":"any","value":"uuid","key":"IdentifierType","description":"(Required) Profile identifier type"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"identifierValue\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"clientId\": 7068,\n \"expressionId\": \"72165e3c-b064-dc64-bd64-ffd47ed20d49\",\n \"name\": \"string\",\n \"result\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"a0b400b8-0e46-4d72-9f09-10bc2a90447f","name":"See error message for details","originalRequest":{"url":{"path":["analytics",":Namespace","expressions",":AnalysisId","calculate","by",":IdentifierType"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."},{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"AnalysisId","description":"(Required) UUID of the analysis"},{"disabled":false,"type":"any","value":"uuid","key":"IdentifierType","description":"(Required) Profile identifier type"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"identifierValue\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"source\": {\n \"pointer\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"timestamp\": {\n \"value\": \"\"\n },\n \"errorCode\": {\n \"value\": \"\"\n },\n \"httpStatus\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"traceId\": {\n \"value\": \"\"\n },\n \"help\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"d62bbad3-9861-4f02-826f-60d064b549b9","name":"See error message for details","originalRequest":{"url":{"path":["analytics",":Namespace","expressions",":AnalysisId","calculate","by",":IdentifierType"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."},{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"AnalysisId","description":"(Required) UUID of the analysis"},{"disabled":false,"type":"any","value":"uuid","key":"IdentifierType","description":"(Required) Profile identifier type"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"identifierValue\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"source\": {\n \"pointer\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"timestamp\": {\n \"value\": \"\"\n },\n \"errorCode\": {\n \"value\": \"\"\n },\n \"httpStatus\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"traceId\": {\n \"value\": \"\"\n },\n \"help\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"12e2ac5f-9420-4657-855c-15c832ea8a19","name":"List expressions","request":{"name":"List expressions","description":{"content":"Returns a paginated list of expressions.\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `ANALYTICS_BACKEND_EXPRESSIONS_LIST_READ`\n\n**User role permission required:** `analytics: read`\n","type":"text/plain"},"url":{"path":["analytics",":Namespace","expressions"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"page","value":"1","description":"The number of the page to retrieve"},{"disabled":false,"key":"limit","value":"50","description":"Limit of items per page"},{"disabled":false,"key":"search","value":"string","description":"A string to search for in analyses' titles"},{"disabled":false,"key":"sortBy","value":"name:asc","description":"You can sort the results. The sorting direction is selected by adding `asc` or `desc`, for example `sortBy=name:desc`.\n"},{"disabled":false,"key":"directoryId","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","description":"Unique ID of the directory to retrieve analyses from"},{"disabled":false,"key":"ids","value":"string","description":"Comma-separated list of IDs (in UUID format) to filter results through"},{"disabled":false,"key":"type","value":"CLIENT","description":"Filter by expression type. When omitted, expressions of all types are returned."},{"disabled":false,"key":"actionName","value":"string","description":"Filter event expressions by their action's event name. When omitted, expressions for all actions are returned."}],"variable":[{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"35e1bc7c-1c3d-4d4d-820f-49fdea375537","name":"List of expressions","originalRequest":{"url":{"path":["analytics",":Namespace","expressions"],"host":["{{baseUrl}}"],"query":[{"key":"page","value":"1"},{"key":"limit","value":"50"},{"key":"search","value":"string"},{"key":"sortBy","value":"name:asc"},{"key":"directoryId","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750"},{"key":"ids","value":"string"},{"key":"type","value":"CLIENT"},{"key":"actionName","value":"string"}],"variable":[{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"data\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"meta\": {\n \"links\": {\n \"value\": \"\"\n },\n \"limit\": {\n \"value\": \"\"\n },\n \"count\": {\n \"value\": \"\"\n }\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"e8bb6dc3-afac-4b44-a118-792d1a0a9edc","name":"See error message for details","originalRequest":{"url":{"path":["analytics",":Namespace","expressions"],"host":["{{baseUrl}}"],"query":[{"key":"page","value":"1"},{"key":"limit","value":"50"},{"key":"search","value":"string"},{"key":"sortBy","value":"name:asc"},{"key":"directoryId","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750"},{"key":"ids","value":"string"},{"key":"type","value":"CLIENT"},{"key":"actionName","value":"string"}],"variable":[{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"source\": {\n \"pointer\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"timestamp\": {\n \"value\": \"\"\n },\n \"errorCode\": {\n \"value\": \"\"\n },\n \"httpStatus\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"traceId\": {\n \"value\": \"\"\n },\n \"help\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"55287cac-1209-48f2-ad66-2022bf9bb351","name":"See error message for details","originalRequest":{"url":{"path":["analytics",":Namespace","expressions"],"host":["{{baseUrl}}"],"query":[{"key":"page","value":"1"},{"key":"limit","value":"50"},{"key":"search","value":"string"},{"key":"sortBy","value":"name:asc"},{"key":"directoryId","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750"},{"key":"ids","value":"string"},{"key":"type","value":"CLIENT"},{"key":"actionName","value":"string"}],"variable":[{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"source\": {\n \"pointer\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"timestamp\": {\n \"value\": \"\"\n },\n \"errorCode\": {\n \"value\": \"\"\n },\n \"httpStatus\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"traceId\": {\n \"value\": \"\"\n },\n \"help\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"8760bd62-90f7-4da3-bdf9-94acec6220ee","name":"Create expression","request":{"name":"Create expression","description":{"content":"Create an expression that is saved in the database and can be used in other analyses.\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permissions required (at least one):** `ANALYTICS_BACKEND_EXPRESSIONS_CREATE`, `ANALYTICS_BACKEND_EXPRESSION_CREATE`\n\n**User role permission required:** `analytics: create`\n","type":"text/plain"},"url":{"path":["analytics",":Namespace","expressions"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"isVisibleForClientProfile\": false,\n \"analysis\": {\n \"value\": \"\"\n },\n \"inlineAnalytics\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"7e115733-86d2-4ddc-b78d-8e6c17d09371","name":"Create expression","originalRequest":{"url":{"path":["analytics",":Namespace","expressions"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"isVisibleForClientProfile\": false,\n \"analysis\": {\n \"value\": \"\"\n },\n \"inlineAnalytics\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"Created","code":201,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"id\": \"a8062d9e-a809-8389-88e6-f8d7b095b1db\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"de2d0eb8-e691-4ea4-81ff-977b06ce2d70","name":"See error message for details","originalRequest":{"url":{"path":["analytics",":Namespace","expressions"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"isVisibleForClientProfile\": false,\n \"analysis\": {\n \"value\": \"\"\n },\n \"inlineAnalytics\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"source\": {\n \"pointer\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"timestamp\": {\n \"value\": \"\"\n },\n \"errorCode\": {\n \"value\": \"\"\n },\n \"httpStatus\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"traceId\": {\n \"value\": \"\"\n },\n \"help\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"3ee238fe-fcc4-4c89-a084-755280e815b7","name":"See error message for details","originalRequest":{"url":{"path":["analytics",":Namespace","expressions"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"isVisibleForClientProfile\": false,\n \"analysis\": {\n \"value\": \"\"\n },\n \"inlineAnalytics\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"source\": {\n \"pointer\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"timestamp\": {\n \"value\": \"\"\n },\n \"errorCode\": {\n \"value\": \"\"\n },\n \"httpStatus\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"traceId\": {\n \"value\": \"\"\n },\n \"help\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"400a8bc7-1412-40af-9c75-91614f54ef08","name":"Get expression details","request":{"name":"Get expression details","description":{"content":"Retrieve information about an expression analysis\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permissions required (at least one):** `ANALYTICS_BACKEND_EXPRESSIONS_READ`, `ANALYTICS_BACKEND_EXPRESSION_READ`\n\n**User role permission required:** `analytics: read`\n","type":"text/plain"},"url":{"path":["analytics",":Namespace","expressions",":AnalysisId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."},{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"AnalysisId","description":"(Required) UUID of the analysis"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"4b9c266a-67ae-4a4a-9ce0-00aed3fdee9d","name":"Get expression details","originalRequest":{"url":{"path":["analytics",":Namespace","expressions",":AnalysisId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."},{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"AnalysisId","description":"(Required) UUID of the analysis"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"analysis\": {\n \"value\": \"\"\n },\n \"analyticVersion\": \"a8404f68-7b3c-e9e0-afb5-bebc744a5eef\",\n \"author\": 234,\n \"businessProfileId\": 48,\n \"createdAt\": \"1950-03-28T22:56:35.090Z\",\n \"description\": \"string\",\n \"directoryId\": \"5ef43e42-9ef9-147f-c481-2aa8a4d8a685\",\n \"id\": \"8c62e996-a8c1-c4d8-c5c3-4418068186bb\",\n \"isDeleted\": true,\n \"isDynamicAnalytic\": true,\n \"isPredefinedAnalytic\": false,\n \"isVisibleForClientProfile\": false,\n \"modifier\": 6022,\n \"name\": \"string\",\n \"namespace\": \"string\",\n \"updatedAt\": \"1994-11-19T16:52:58.486Z\",\n \"usedAt\": \"1969-12-31T06:09:14.166Z\",\n \"inlineAnalytics\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"48cb9f54-5c97-43d2-ba60-0ddb7285c036","name":"See error message for details","originalRequest":{"url":{"path":["analytics",":Namespace","expressions",":AnalysisId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."},{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"AnalysisId","description":"(Required) UUID of the analysis"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"source\": {\n \"pointer\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"timestamp\": {\n \"value\": \"\"\n },\n \"errorCode\": {\n \"value\": \"\"\n },\n \"httpStatus\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"traceId\": {\n \"value\": \"\"\n },\n \"help\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"ac3a44e6-57c0-4b44-b99b-3ac3a2b34e1a","name":"See error message for details","originalRequest":{"url":{"path":["analytics",":Namespace","expressions",":AnalysisId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."},{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"AnalysisId","description":"(Required) UUID of the analysis"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"source\": {\n \"pointer\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"timestamp\": {\n \"value\": \"\"\n },\n \"errorCode\": {\n \"value\": \"\"\n },\n \"httpStatus\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"traceId\": {\n \"value\": \"\"\n },\n \"help\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"6083ec56-8021-4887-aae3-7307bebd2afd","name":"Update expression","request":{"name":"Update expression","description":{"content":"Update an existing expression\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permissions required (at least one):** `ANALYTICS_BACKEND_EXPRESSIONS_UPDATE`, `ANALYTICS_BACKEND_EXPRESSION_UPDATE`\n\n**User role permission required:** `analytics: update`\n","type":"text/plain"},"url":{"path":["analytics",":Namespace","expressions",":AnalysisId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."},{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"AnalysisId","description":"(Required) UUID of the analysis"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PUT","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"isVisibleForClientProfile\": false,\n \"analysis\": {\n \"value\": \"\"\n },\n \"inlineAnalytics\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"59f7edeb-4d7b-4d7b-888d-790056a34f18","name":"Update expression","originalRequest":{"url":{"path":["analytics",":Namespace","expressions",":AnalysisId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."},{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"AnalysisId","description":"(Required) UUID of the analysis"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"PUT","body":{"mode":"raw","raw":"{\n \"isVisibleForClientProfile\": false,\n \"analysis\": {\n \"value\": \"\"\n },\n \"inlineAnalytics\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"1ff0e914-5104-47dc-928a-cdc5172a80b7","name":"See error message for details","originalRequest":{"url":{"path":["analytics",":Namespace","expressions",":AnalysisId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."},{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"AnalysisId","description":"(Required) UUID of the analysis"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"{\n \"isVisibleForClientProfile\": false,\n \"analysis\": {\n \"value\": \"\"\n },\n \"inlineAnalytics\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"source\": {\n \"pointer\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"timestamp\": {\n \"value\": \"\"\n },\n \"errorCode\": {\n \"value\": \"\"\n },\n \"httpStatus\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"traceId\": {\n \"value\": \"\"\n },\n \"help\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"4dd89736-79d7-46bf-9a7c-7dd28cf68fb4","name":"See error message for details","originalRequest":{"url":{"path":["analytics",":Namespace","expressions",":AnalysisId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."},{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"AnalysisId","description":"(Required) UUID of the analysis"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"{\n \"isVisibleForClientProfile\": false,\n \"analysis\": {\n \"value\": \"\"\n },\n \"inlineAnalytics\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"source\": {\n \"pointer\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"timestamp\": {\n \"value\": \"\"\n },\n \"errorCode\": {\n \"value\": \"\"\n },\n \"httpStatus\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"traceId\": {\n \"value\": \"\"\n },\n \"help\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"1e3d9527-e863-4a02-bf32-78691e1313f5","name":"Delete expression","request":{"name":"Delete expression","description":{"content":"\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permissions required (at least one):** `ANALYTICS_BACKEND_EXPRESSIONS_DELETE`, `ANALYTICS_BACKEND_EXPRESSION_DELETE`\n\n**User role permission required:** `analytics: delete`\n","type":"text/plain"},"url":{"path":["analytics",":Namespace","expressions",":AnalysisId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."},{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"AnalysisId","description":"(Required) UUID of the analysis"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"91668bcd-a669-44b8-8f00-def3cf3c70eb","name":"Delete expression","originalRequest":{"url":{"path":["analytics",":Namespace","expressions",":AnalysisId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."},{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"AnalysisId","description":"(Required) UUID of the analysis"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"DELETE","body":{}},"status":"No Content","code":204,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"b3d787fa-dafa-4e17-9456-8cdf6bfa5107","name":"See error message for details","originalRequest":{"url":{"path":["analytics",":Namespace","expressions",":AnalysisId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."},{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"AnalysisId","description":"(Required) UUID of the analysis"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"source\": {\n \"pointer\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"timestamp\": {\n \"value\": \"\"\n },\n \"errorCode\": {\n \"value\": \"\"\n },\n \"httpStatus\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"traceId\": {\n \"value\": \"\"\n },\n \"help\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"cc65746a-1cdb-420c-ad74-52d37cb87e66","name":"See error message for details","originalRequest":{"url":{"path":["analytics",":Namespace","expressions",":AnalysisId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."},{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"AnalysisId","description":"(Required) UUID of the analysis"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"source\": {\n \"pointer\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"timestamp\": {\n \"value\": \"\"\n },\n \"errorCode\": {\n \"value\": \"\"\n },\n \"httpStatus\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"traceId\": {\n \"value\": \"\"\n },\n \"help\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"e6dad357-1d9a-4a41-b73d-8822b405eaec","name":"Get expression preview","request":{"name":"Get expression preview","description":{"content":"Retrieve expression preview value. Previews are only available for CLIENT-type expressions. This request doesn't save the expression.\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `ANALYTICS_BACKEND_EXPRESSION_FOR_CLIENT_READ`\n\n**User role permission required (at least one):** `analytics: read`, `client_analytics_preview: read`\n","type":"text/plain"},"url":{"path":["analytics",":Namespace","expressions","preview","by",":IdentifierType"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."},{"disabled":false,"type":"any","value":"uuid","key":"IdentifierType","description":"(Required) Profile identifier type"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"expression\": {\n \"type\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"expression\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n }\n },\n \"identifierValue\": \"string\",\n \"inlineAnalytics\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"66ed2bbb-6b48-40a9-a504-ba49b30df470","name":"Expression preview result","originalRequest":{"url":{"path":["analytics",":Namespace","expressions","preview","by",":IdentifierType"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."},{"disabled":false,"type":"any","value":"uuid","key":"IdentifierType","description":"(Required) Profile identifier type"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"expression\": {\n \"type\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"expression\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n }\n },\n \"identifierValue\": \"string\",\n \"inlineAnalytics\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"clientId\": 6175,\n \"expressionId\": \"05019412-e818-ac67-edd1-e8e3657bccd1\",\n \"result\": \"string\",\n \"title\": \"string\",\n \"variables\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"eec0020f-e378-46c8-bd6f-6282d70f7d23","name":"See error message for details","originalRequest":{"url":{"path":["analytics",":Namespace","expressions","preview","by",":IdentifierType"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."},{"disabled":false,"type":"any","value":"uuid","key":"IdentifierType","description":"(Required) Profile identifier type"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"expression\": {\n \"type\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"expression\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n }\n },\n \"identifierValue\": \"string\",\n \"inlineAnalytics\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"source\": {\n \"pointer\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"timestamp\": {\n \"value\": \"\"\n },\n \"errorCode\": {\n \"value\": \"\"\n },\n \"httpStatus\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"traceId\": {\n \"value\": \"\"\n },\n \"help\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"31cfba4c-1479-432a-950b-73a36bdd2fab","name":"See error message for details","originalRequest":{"url":{"path":["analytics",":Namespace","expressions","preview","by",":IdentifierType"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."},{"disabled":false,"type":"any","value":"uuid","key":"IdentifierType","description":"(Required) Profile identifier type"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"expression\": {\n \"type\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"expression\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n }\n },\n \"identifierValue\": \"string\",\n \"inlineAnalytics\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"source\": {\n \"pointer\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"timestamp\": {\n \"value\": \"\"\n },\n \"errorCode\": {\n \"value\": \"\"\n },\n \"httpStatus\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"traceId\": {\n \"value\": \"\"\n },\n \"help\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}],"event":[]},{"id":"15d6cf2e-b2ad-4ebd-96b0-0d74b79ab496","name":"Analytics: Aggregates","description":{"content":"","type":"text/plain"},"item":[{"id":"1907e501-586d-4dff-9d4e-8380a05220f8","name":"Calculate aggregate for profile with period conditions","request":{"name":"Calculate aggregate for profile with period conditions","description":{"content":"Calculate the results of an aggregate in context of a single profile. The results can be date-filtered and aggregated in time periods.\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `ANALYTICS_BACKEND_AGGREGATE_HISTOGRAM_FOR_CLIENT_READ`\n\n**User role permission required:** `analytics: read`\n","type":"text/plain"},"url":{"path":["analytics","analytics","definitions-manager","aggregates",":AggregateIdentifier","client",":ProfileId","calculate","histogram"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"AggregateIdentifier","description":"(Required) Aggregate identifier (UUID or numeric ID)"},{"disabled":false,"type":"any","value":"4489","key":"ProfileId","description":"(Required) Unique identifier of a profile"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"aggregateDataBy\": {\n \"type\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"dateFilter\": {\n \"value\": \"\"\n },\n \"variables\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"5d32f687-37da-4f27-b435-0871d0f50486","name":"Aggregate calculation result","originalRequest":{"url":{"path":["analytics","analytics","definitions-manager","aggregates",":AggregateIdentifier","client",":ProfileId","calculate","histogram"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"AggregateIdentifier","description":"(Required) Aggregate identifier (UUID or numeric ID)"},{"disabled":false,"type":"any","value":"4489","key":"ProfileId","description":"(Required) Unique identifier of a profile"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"aggregateDataBy\": {\n \"type\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"dateFilter\": {\n \"value\": \"\"\n },\n \"variables\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"items\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"metadata\": {\n \"dateFilter\": {\n \"value\": \"\"\n },\n \"period\": {\n \"value\": \"\"\n }\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"eb2ad5b4-ff73-4db0-a6bc-e91f87bd02e6","name":"See error message for details","originalRequest":{"url":{"path":["analytics","analytics","definitions-manager","aggregates",":AggregateIdentifier","client",":ProfileId","calculate","histogram"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"AggregateIdentifier","description":"(Required) Aggregate identifier (UUID or numeric ID)"},{"disabled":false,"type":"any","value":"4489","key":"ProfileId","description":"(Required) Unique identifier of a profile"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"aggregateDataBy\": {\n \"type\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"dateFilter\": {\n \"value\": \"\"\n },\n \"variables\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"source\": {\n \"pointer\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"timestamp\": {\n \"value\": \"\"\n },\n \"errorCode\": {\n \"value\": \"\"\n },\n \"httpStatus\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"traceId\": {\n \"value\": \"\"\n },\n \"help\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"4bb99f69-a810-44c3-8578-b1651c684c61","name":"See error message for details","originalRequest":{"url":{"path":["analytics","analytics","definitions-manager","aggregates",":AggregateIdentifier","client",":ProfileId","calculate","histogram"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"AggregateIdentifier","description":"(Required) Aggregate identifier (UUID or numeric ID)"},{"disabled":false,"type":"any","value":"4489","key":"ProfileId","description":"(Required) Unique identifier of a profile"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"aggregateDataBy\": {\n \"type\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"dateFilter\": {\n \"value\": \"\"\n },\n \"variables\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"source\": {\n \"pointer\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"timestamp\": {\n \"value\": \"\"\n },\n \"errorCode\": {\n \"value\": \"\"\n },\n \"httpStatus\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"traceId\": {\n \"value\": \"\"\n },\n \"help\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"4ab53d91-494c-494e-ab6c-a71297ef49a1","name":"Get aggregate preview","request":{"name":"Get aggregate preview","description":{"content":"Retrieve aggregate preview value. Previews are only available for the AGGREGATE type (profile aggregate). This request doesn't save an aggregate to the database.\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permissions required (at least one):** `ANALYTICS_BACKEND_AGGREGATES_READ`, `ANALYTICS_BACKEND_AGGREGATE_READ`\n\n**User role permission required:** `analytics_aggregates: read`\n","type":"text/plain"},"url":{"path":["analytics",":Namespace","aggregates","preview","by",":IdentifierType"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."},{"disabled":false,"type":"any","value":"uuid","key":"IdentifierType","description":"(Required) Profile identifier type"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"aggregate\": {\n \"aggregateType\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n },\n \"uuid\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"level\": {\n \"value\": \"\"\n },\n \"size\": {\n \"value\": \"\"\n },\n \"unique\": {\n \"value\": \"\"\n },\n \"dateFilter\": {\n \"value\": \"\"\n },\n \"expressions\": {\n \"value\": \"\"\n },\n \"attribute\": {\n \"value\": \"\"\n },\n \"action\": {\n \"value\": \"\"\n }\n },\n \"identifierValue\": \"string\",\n \"inlineAnalytics\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"ec5c602b-0802-4fb9-b975-f874098a469c","name":"Aggregate preview","originalRequest":{"url":{"path":["analytics",":Namespace","aggregates","preview","by",":IdentifierType"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."},{"disabled":false,"type":"any","value":"uuid","key":"IdentifierType","description":"(Required) Profile identifier type"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"aggregate\": {\n \"aggregateType\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n },\n \"uuid\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"level\": {\n \"value\": \"\"\n },\n \"size\": {\n \"value\": \"\"\n },\n \"unique\": {\n \"value\": \"\"\n },\n \"dateFilter\": {\n \"value\": \"\"\n },\n \"expressions\": {\n \"value\": \"\"\n },\n \"attribute\": {\n \"value\": \"\"\n },\n \"action\": {\n \"value\": \"\"\n }\n },\n \"identifierValue\": \"string\",\n \"inlineAnalytics\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"aggregateId\": \"5370bf3c-2dfa-4e89-98ff-07100cffee6c\",\n \"aggregateUuid\": \"5370bf3c-2dfa-4e89-98ff-07100cffee6c\",\n \"clientId\": 1214.6457031166158,\n \"title\": \"Nice people who read the documentation\",\n \"result\": \"string\",\n \"variables\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"dateFilter\": {\n \"value\": \"\"\n },\n \"analyticVersion\": \"e3e1509b-f5ae-94f5-1d39-469bad788cdb\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"da906e0e-670c-4eed-aa18-11facd2326db","name":"See error message for details","originalRequest":{"url":{"path":["analytics",":Namespace","aggregates","preview","by",":IdentifierType"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."},{"disabled":false,"type":"any","value":"uuid","key":"IdentifierType","description":"(Required) Profile identifier type"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"aggregate\": {\n \"aggregateType\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n },\n \"uuid\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"level\": {\n \"value\": \"\"\n },\n \"size\": {\n \"value\": \"\"\n },\n \"unique\": {\n \"value\": \"\"\n },\n \"dateFilter\": {\n \"value\": \"\"\n },\n \"expressions\": {\n \"value\": \"\"\n },\n \"attribute\": {\n \"value\": \"\"\n },\n \"action\": {\n \"value\": \"\"\n }\n },\n \"identifierValue\": \"string\",\n \"inlineAnalytics\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"source\": {\n \"pointer\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"timestamp\": {\n \"value\": \"\"\n },\n \"errorCode\": {\n \"value\": \"\"\n },\n \"httpStatus\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"traceId\": {\n \"value\": \"\"\n },\n \"help\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"e9869cdf-7af2-4170-a71f-758a5e1d93b9","name":"See error message for details","originalRequest":{"url":{"path":["analytics",":Namespace","aggregates","preview","by",":IdentifierType"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."},{"disabled":false,"type":"any","value":"uuid","key":"IdentifierType","description":"(Required) Profile identifier type"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"aggregate\": {\n \"aggregateType\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n },\n \"uuid\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"level\": {\n \"value\": \"\"\n },\n \"size\": {\n \"value\": \"\"\n },\n \"unique\": {\n \"value\": \"\"\n },\n \"dateFilter\": {\n \"value\": \"\"\n },\n \"expressions\": {\n \"value\": \"\"\n },\n \"attribute\": {\n \"value\": \"\"\n },\n \"action\": {\n \"value\": \"\"\n }\n },\n \"identifierValue\": \"string\",\n \"inlineAnalytics\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"source\": {\n \"pointer\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"timestamp\": {\n \"value\": \"\"\n },\n \"errorCode\": {\n \"value\": \"\"\n },\n \"httpStatus\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"traceId\": {\n \"value\": \"\"\n },\n \"help\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"1ae11fb4-d595-4c59-a024-8706c2df2b62","name":"Get aggregates for profile card","request":{"name":"Get aggregates for profile card","description":{"content":"Retrieve aggregates to display on a profile's card in the Profiles module (`\"isVisibleForClientProfile\": true`) in the [expression config](https://developers.synerise.com/AnalyticsSuite/AnalyticsSuite.html#operation/addAggregatePOST)).\n\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `ANALYTICS_BACKEND_AGGREGATE_FOR_CLIENT_READ`\n\n**User role permission required (at least one):** `analytics: read`, `client_analytics_preview: read`\n","type":"text/plain"},"url":{"path":["analytics",":Namespace","aggregates","visible-for-client","by",":IdentifierType"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"uuid","key":"IdentifierType","description":"(Required) Profile identifier type"},{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"identifierValue\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"36253b4c-d80e-4d53-a6be-accee42824e7","name":"List of calculated aggregates configured as visible on the profile card","originalRequest":{"url":{"path":["analytics",":Namespace","aggregates","visible-for-client","by",":IdentifierType"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"uuid","key":"IdentifierType","description":"(Required) Profile identifier type"},{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"identifierValue\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"[\n {\n \"analyticId\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"result\": {\n \"value\": \"\"\n }\n },\n {\n \"analyticId\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"result\": {\n \"value\": \"\"\n }\n }\n]","cookie":[],"_postman_previewlanguage":"json"},{"id":"25e8337e-cd56-409f-824e-7f9d2bd26e9a","name":"See error message for details","originalRequest":{"url":{"path":["analytics",":Namespace","aggregates","visible-for-client","by",":IdentifierType"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"uuid","key":"IdentifierType","description":"(Required) Profile identifier type"},{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"identifierValue\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"source\": {\n \"pointer\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"timestamp\": {\n \"value\": \"\"\n },\n \"errorCode\": {\n \"value\": \"\"\n },\n \"httpStatus\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"traceId\": {\n \"value\": \"\"\n },\n \"help\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"59bfde2f-27b4-4c4b-80b7-a40a7a4eb58c","name":"See error message for details","originalRequest":{"url":{"path":["analytics",":Namespace","aggregates","visible-for-client","by",":IdentifierType"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"uuid","key":"IdentifierType","description":"(Required) Profile identifier type"},{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"identifierValue\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"source\": {\n \"pointer\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"timestamp\": {\n \"value\": \"\"\n },\n \"errorCode\": {\n \"value\": \"\"\n },\n \"httpStatus\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"traceId\": {\n \"value\": \"\"\n },\n \"help\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"cc415257-38b9-42de-bb3e-f9e751c42cc7","name":"Calculate aggregate for profile","request":{"name":"Calculate aggregate for profile","description":{"content":"Calculate the result of an existing aggregate in context of a single profile.\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `ANALYTICS_BACKEND_AGGREGATE_FOR_CLIENT_READ`\n\n**User role permission required:** `analytics: read`\n","type":"text/plain"},"url":{"path":["analytics",":Namespace","aggregates",":AggregateIdentifier","calculate","by",":IdentifierType"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."},{"disabled":false,"type":"any","value":"string","key":"AggregateIdentifier","description":"(Required) Aggregate identifier (UUID or numeric ID)"},{"disabled":false,"type":"any","value":"uuid","key":"IdentifierType","description":"(Required) Profile identifier type"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"identifierValue\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"f3090ee4-594b-42ad-8db0-6a600b228604","name":"Aggregate result","originalRequest":{"url":{"path":["analytics",":Namespace","aggregates",":AggregateIdentifier","calculate","by",":IdentifierType"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."},{"disabled":false,"type":"any","value":"string","key":"AggregateIdentifier","description":"(Required) Aggregate identifier (UUID or numeric ID)"},{"disabled":false,"type":"any","value":"uuid","key":"IdentifierType","description":"(Required) Profile identifier type"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"identifierValue\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"aggregateId\": \"2ca84188-d581-8b90-b224-a02a566a8311\",\n \"clientId\": 2444,\n \"name\": \"string\",\n \"result\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"8db2b120-81ce-47f4-b41b-66d0d9721f1b","name":"See error message for details","originalRequest":{"url":{"path":["analytics",":Namespace","aggregates",":AggregateIdentifier","calculate","by",":IdentifierType"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."},{"disabled":false,"type":"any","value":"string","key":"AggregateIdentifier","description":"(Required) Aggregate identifier (UUID or numeric ID)"},{"disabled":false,"type":"any","value":"uuid","key":"IdentifierType","description":"(Required) Profile identifier type"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"identifierValue\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"source\": {\n \"pointer\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"timestamp\": {\n \"value\": \"\"\n },\n \"errorCode\": {\n \"value\": \"\"\n },\n \"httpStatus\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"traceId\": {\n \"value\": \"\"\n },\n \"help\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"dbed04e0-5c35-4f2c-89a5-55b970016a3f","name":"See error message for details","originalRequest":{"url":{"path":["analytics",":Namespace","aggregates",":AggregateIdentifier","calculate","by",":IdentifierType"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."},{"disabled":false,"type":"any","value":"string","key":"AggregateIdentifier","description":"(Required) Aggregate identifier (UUID or numeric ID)"},{"disabled":false,"type":"any","value":"uuid","key":"IdentifierType","description":"(Required) Profile identifier type"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"identifierValue\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"source\": {\n \"pointer\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"timestamp\": {\n \"value\": \"\"\n },\n \"errorCode\": {\n \"value\": \"\"\n },\n \"httpStatus\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"traceId\": {\n \"value\": \"\"\n },\n \"help\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"002f0cb6-3d5a-4451-b9be-ee84b2e2d116","name":"List aggregates","request":{"name":"List aggregates","description":{"content":"Returns a paginated list of aggregates.\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `ANALYTICS_BACKEND_AGGREGATES_LIST_READ`\n\n**User role permission required:** `analytics: read`\n","type":"text/plain"},"url":{"path":["analytics",":Namespace","aggregates"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"page","value":"1","description":"The number of the page to retrieve"},{"disabled":false,"key":"limit","value":"50","description":"Limit of items per page"},{"disabled":false,"key":"search","value":"string","description":"A string to search for in analyses' titles"},{"disabled":false,"key":"sortBy","value":"name:asc","description":"You can sort the results. The sorting direction is selected by adding `asc` or `desc`, for example `sortBy=name:desc`.\n"},{"disabled":false,"key":"directoryId","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","description":"Unique ID of the directory to retrieve analyses from"},{"disabled":false,"key":"ids","value":"string","description":"Comma-separated list of IDs (in UUID format) to filter results through"},{"disabled":false,"key":"aggregateType","value":"RUNNING_AGGREGATE","description":"Filter by aggregate type"}],"variable":[{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"cc17d45c-c4b3-471b-9a64-de2523a47add","name":"List of aggregates","originalRequest":{"url":{"path":["analytics",":Namespace","aggregates"],"host":["{{baseUrl}}"],"query":[{"key":"page","value":"1"},{"key":"limit","value":"50"},{"key":"search","value":"string"},{"key":"sortBy","value":"name:asc"},{"key":"directoryId","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750"},{"key":"ids","value":"string"},{"key":"aggregateType","value":"RUNNING_AGGREGATE"}],"variable":[{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"data\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"meta\": {\n \"links\": {\n \"value\": \"\"\n },\n \"limit\": {\n \"value\": \"\"\n },\n \"count\": {\n \"value\": \"\"\n }\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"f1867a4b-b393-49b3-a99e-aa271f18c265","name":"See error message for details","originalRequest":{"url":{"path":["analytics",":Namespace","aggregates"],"host":["{{baseUrl}}"],"query":[{"key":"page","value":"1"},{"key":"limit","value":"50"},{"key":"search","value":"string"},{"key":"sortBy","value":"name:asc"},{"key":"directoryId","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750"},{"key":"ids","value":"string"},{"key":"aggregateType","value":"RUNNING_AGGREGATE"}],"variable":[{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"source\": {\n \"pointer\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"timestamp\": {\n \"value\": \"\"\n },\n \"errorCode\": {\n \"value\": \"\"\n },\n \"httpStatus\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"traceId\": {\n \"value\": \"\"\n },\n \"help\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"04d628a0-a440-4ef7-a229-ddb63d228c70","name":"See error message for details","originalRequest":{"url":{"path":["analytics",":Namespace","aggregates"],"host":["{{baseUrl}}"],"query":[{"key":"page","value":"1"},{"key":"limit","value":"50"},{"key":"search","value":"string"},{"key":"sortBy","value":"name:asc"},{"key":"directoryId","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750"},{"key":"ids","value":"string"},{"key":"aggregateType","value":"RUNNING_AGGREGATE"}],"variable":[{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"source\": {\n \"pointer\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"timestamp\": {\n \"value\": \"\"\n },\n \"errorCode\": {\n \"value\": \"\"\n },\n \"httpStatus\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"traceId\": {\n \"value\": \"\"\n },\n \"help\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"90b0ad35-6f22-4cec-abb1-42fec0730c87","name":"Create aggregate","request":{"name":"Create aggregate","description":{"content":"Create an aggregate analysis and save it to the database.\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permissions required (at least one):** `ANALYTICS_BACKEND_AGGREGATES_CREATE`, `ANALYTICS_BACKEND_AGGREGATE_CREATE`\n\n**User role permission required:** `analytics_aggregates: create`\n","type":"text/plain"},"url":{"path":["analytics",":Namespace","aggregates"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"analysis\": {\n \"value\": \"\"\n },\n \"isVisibleForClientProfile\": true,\n \"aggregateType\": \"AGGREGATE\",\n \"previewDefaultObjectId\": 6627.19361436753,\n \"inlineAnalytics\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"e1e98978-2f84-4117-8abd-e6150680488c","name":"Aggregate has been created","originalRequest":{"url":{"path":["analytics",":Namespace","aggregates"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"analysis\": {\n \"value\": \"\"\n },\n \"isVisibleForClientProfile\": true,\n \"aggregateType\": \"AGGREGATE\",\n \"previewDefaultObjectId\": 6627.19361436753,\n \"inlineAnalytics\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"Created","code":201,"header":[{"key":"Content-Type","value":"application/json"}],"body":"\"2434773e-26f7-510c-a544-9c720a822d1c\"","cookie":[],"_postman_previewlanguage":"json"},{"id":"12965034-b1d7-42b2-91eb-72435fdc5a30","name":"See error message for details","originalRequest":{"url":{"path":["analytics",":Namespace","aggregates"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"analysis\": {\n \"value\": \"\"\n },\n \"isVisibleForClientProfile\": true,\n \"aggregateType\": \"AGGREGATE\",\n \"previewDefaultObjectId\": 6627.19361436753,\n \"inlineAnalytics\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"source\": {\n \"pointer\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"timestamp\": {\n \"value\": \"\"\n },\n \"errorCode\": {\n \"value\": \"\"\n },\n \"httpStatus\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"traceId\": {\n \"value\": \"\"\n },\n \"help\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"3b74e83d-84bf-4bd6-9b86-97345a1a3910","name":"See error message for details","originalRequest":{"url":{"path":["analytics",":Namespace","aggregates"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"analysis\": {\n \"value\": \"\"\n },\n \"isVisibleForClientProfile\": true,\n \"aggregateType\": \"AGGREGATE\",\n \"previewDefaultObjectId\": 6627.19361436753,\n \"inlineAnalytics\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"source\": {\n \"pointer\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"timestamp\": {\n \"value\": \"\"\n },\n \"errorCode\": {\n \"value\": \"\"\n },\n \"httpStatus\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"traceId\": {\n \"value\": \"\"\n },\n \"help\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"b650390c-12ea-437a-af35-ffa4613e8c59","name":"Get aggregate details","request":{"name":"Get aggregate details","description":{"content":"Retrieve all data about an aggregate definition.\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permissions required (at least one):** `ANALYTICS_BACKEND_AGGREGATES_READ`, `ANALYTICS_BACKEND_AGGREGATE_READ`\n\n**User role permission required:** `analytics_aggregates: read`\n","type":"text/plain"},"url":{"path":["analytics",":Namespace","aggregates",":AggregateIdentifier"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."},{"disabled":false,"type":"any","value":"string","key":"AggregateIdentifier","description":"(Required) Aggregate identifier (UUID or numeric ID)"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"57e3f2eb-ee6d-45e0-8114-5791a3f387fe","name":"Details of the aggregate","originalRequest":{"url":{"path":["analytics",":Namespace","aggregates",":AggregateIdentifier"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."},{"disabled":false,"type":"any","value":"string","key":"AggregateIdentifier","description":"(Required) Aggregate identifier (UUID or numeric ID)"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"id\": \"5370bf3c-2dfa-4e89-98ff-07100cffee6c\",\n \"oldId\": 8586,\n \"businessProfileId\": 48,\n \"name\": \"string\",\n \"description\": \"string\",\n \"author\": 7348,\n \"modifier\": 3049,\n \"updatedAt\": \"1982-01-16T02:36:19.129Z\",\n \"createdAt\": \"1977-10-16T04:23:49.127Z\",\n \"usedAt\": \"1980-06-28T12:15:35.515Z\",\n \"analysis\": {\n \"value\": \"\"\n },\n \"isPredefinedAnalytic\": false,\n \"isVisibleForClientProfile\": false,\n \"isDynamicAnalytic\": true,\n \"isDeleted\": false,\n \"analyticVersion\": \"a3edfdb5-e319-8486-98e4-e3c90204a94b\",\n \"namespace\": \"string\",\n \"directoryId\": \"3bc56590-57b6-0c1a-8115-0b8b4009153d\",\n \"aggregateType\": \"AGGREGATE\",\n \"previewDefaultObjectId\": 7582.449773470617,\n \"inlineAnalytics\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"07a86d28-b4a8-427f-9347-2b5719058a20","name":"See error message for details","originalRequest":{"url":{"path":["analytics",":Namespace","aggregates",":AggregateIdentifier"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."},{"disabled":false,"type":"any","value":"string","key":"AggregateIdentifier","description":"(Required) Aggregate identifier (UUID or numeric ID)"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"source\": {\n \"pointer\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"timestamp\": {\n \"value\": \"\"\n },\n \"errorCode\": {\n \"value\": \"\"\n },\n \"httpStatus\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"traceId\": {\n \"value\": \"\"\n },\n \"help\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"cd865997-a993-4a2f-943c-328520699468","name":"See error message for details","originalRequest":{"url":{"path":["analytics",":Namespace","aggregates",":AggregateIdentifier"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."},{"disabled":false,"type":"any","value":"string","key":"AggregateIdentifier","description":"(Required) Aggregate identifier (UUID or numeric ID)"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"source\": {\n \"pointer\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"timestamp\": {\n \"value\": \"\"\n },\n \"errorCode\": {\n \"value\": \"\"\n },\n \"httpStatus\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"traceId\": {\n \"value\": \"\"\n },\n \"help\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"c46240f7-2934-4bc7-baf9-4e2772c4adb6","name":"Update aggregate","request":{"name":"Update aggregate","description":{"content":"Update an aggregate.\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permissions required (at least one):** `ANALYTICS_BACKEND_AGGREGATES_UPDATE`, `ANALYTICS_BACKEND_AGGREGATE_UPDATE`\n\n**User role permission required:** `analytics_aggregates: update`\n","type":"text/plain"},"url":{"path":["analytics",":Namespace","aggregates",":AggregateIdentifier"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."},{"disabled":false,"type":"any","value":"string","key":"AggregateIdentifier","description":"(Required) Aggregate identifier (UUID or numeric ID)"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PUT","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"analysis\": {\n \"value\": \"\"\n },\n \"isVisibleForClientProfile\": true,\n \"aggregateType\": \"AGGREGATE\",\n \"previewDefaultObjectId\": 6627.19361436753,\n \"inlineAnalytics\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"dd47dca7-73f3-44c5-a0ef-bfcc885d1e08","name":"Aggregate updated","originalRequest":{"url":{"path":["analytics",":Namespace","aggregates",":AggregateIdentifier"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."},{"disabled":false,"type":"any","value":"string","key":"AggregateIdentifier","description":"(Required) Aggregate identifier (UUID or numeric ID)"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"PUT","body":{"mode":"raw","raw":"{\n \"analysis\": {\n \"value\": \"\"\n },\n \"isVisibleForClientProfile\": true,\n \"aggregateType\": \"AGGREGATE\",\n \"previewDefaultObjectId\": 6627.19361436753,\n \"inlineAnalytics\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"5634da87-416f-42f7-836a-d932e80d04fd","name":"See error message for details","originalRequest":{"url":{"path":["analytics",":Namespace","aggregates",":AggregateIdentifier"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."},{"disabled":false,"type":"any","value":"string","key":"AggregateIdentifier","description":"(Required) Aggregate identifier (UUID or numeric ID)"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"{\n \"analysis\": {\n \"value\": \"\"\n },\n \"isVisibleForClientProfile\": true,\n \"aggregateType\": \"AGGREGATE\",\n \"previewDefaultObjectId\": 6627.19361436753,\n \"inlineAnalytics\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"source\": {\n \"pointer\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"timestamp\": {\n \"value\": \"\"\n },\n \"errorCode\": {\n \"value\": \"\"\n },\n \"httpStatus\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"traceId\": {\n \"value\": \"\"\n },\n \"help\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"ae32b910-db92-4aee-8674-b1e611ab20cb","name":"See error message for details","originalRequest":{"url":{"path":["analytics",":Namespace","aggregates",":AggregateIdentifier"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."},{"disabled":false,"type":"any","value":"string","key":"AggregateIdentifier","description":"(Required) Aggregate identifier (UUID or numeric ID)"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"{\n \"analysis\": {\n \"value\": \"\"\n },\n \"isVisibleForClientProfile\": true,\n \"aggregateType\": \"AGGREGATE\",\n \"previewDefaultObjectId\": 6627.19361436753,\n \"inlineAnalytics\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"source\": {\n \"pointer\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"timestamp\": {\n \"value\": \"\"\n },\n \"errorCode\": {\n \"value\": \"\"\n },\n \"httpStatus\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"traceId\": {\n \"value\": \"\"\n },\n \"help\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"42bdab2f-0b26-4fc4-8282-66aaf5d42e38","name":"Delete aggregate","request":{"name":"Delete aggregate","description":{"content":"\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permissions required (at least one):** `ANALYTICS_BACKEND_AGGREGATES_DELETE`, `ANALYTICS_BACKEND_AGGREGATE_DELETE`\n\n**User role permission required:** `analytics_aggregates: delete`\n","type":"text/plain"},"url":{"path":["analytics",":Namespace","aggregates",":AggregateIdentifier"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."},{"disabled":false,"type":"any","value":"string","key":"AggregateIdentifier","description":"(Required) Aggregate identifier (UUID or numeric ID)"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"aa023ccb-df24-4c12-b9d0-64ca33e4ae1b","name":"Aggregate deleted","originalRequest":{"url":{"path":["analytics",":Namespace","aggregates",":AggregateIdentifier"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."},{"disabled":false,"type":"any","value":"string","key":"AggregateIdentifier","description":"(Required) Aggregate identifier (UUID or numeric ID)"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"DELETE","body":{}},"status":"No Content","code":204,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"f0122f33-eea7-476a-964e-1d2d64ba915f","name":"See error message for details","originalRequest":{"url":{"path":["analytics",":Namespace","aggregates",":AggregateIdentifier"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."},{"disabled":false,"type":"any","value":"string","key":"AggregateIdentifier","description":"(Required) Aggregate identifier (UUID or numeric ID)"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"source\": {\n \"pointer\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"timestamp\": {\n \"value\": \"\"\n },\n \"errorCode\": {\n \"value\": \"\"\n },\n \"httpStatus\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"traceId\": {\n \"value\": \"\"\n },\n \"help\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"3c01b050-2d17-4565-a22f-d9f2647e7cab","name":"See error message for details","originalRequest":{"url":{"path":["analytics",":Namespace","aggregates",":AggregateIdentifier"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."},{"disabled":false,"type":"any","value":"string","key":"AggregateIdentifier","description":"(Required) Aggregate identifier (UUID or numeric ID)"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"source\": {\n \"pointer\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"timestamp\": {\n \"value\": \"\"\n },\n \"errorCode\": {\n \"value\": \"\"\n },\n \"httpStatus\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"traceId\": {\n \"value\": \"\"\n },\n \"help\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}],"event":[]},{"id":"e2bbf10a-3307-49b0-998c-a03cfeba87e9","name":"Profile registration","description":{"content":"","type":"text/plain"},"item":[{"id":"ad260554-8680-4837-965d-42f1a0bbaf49","name":"Register a Profile","request":{"name":"Register a Profile","description":{"content":"Create a new account for a Profile. This account is owned by the Profile and can be accessed and edited by it. If you don't have some information about the profile, don't insert a null-value parameter - omit the parameter entirely.\n\n---\n\n**API consumers:** Anonymous Profile, Workspace (Business Profile)\n\n**API key permission required:** `SAUTH_REGISTER_CLIENT_CREATE`\n","type":"text/plain"},"url":{"path":["sauth","clients","registered"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"email\": \"string\",\n \"password\": \"string\",\n \"phone\": \"+48111222333\",\n \"customId\": \"string\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"displayName\": \"string\",\n \"uuid\": \"07243772-008a-42e1-ba37-c3807cebde8f\",\n \"avatarUrl\": \"string\",\n \"whatsAppId\": \"string\",\n \"birthDate\": \"string\",\n \"company\": \"string\",\n \"city\": \"string\",\n \"address\": \"string\",\n \"zipCode\": \"string\",\n \"province\": \"string\",\n \"countryCode\": \"PL\",\n \"sex\": \"NOT_SPECIFIED\",\n \"agreements\": {\n \"email\": true,\n \"sms\": true,\n \"push\": true,\n \"bluetooth\": false,\n \"rfid\": false,\n \"wifi\": false\n },\n \"attributes\": {\n \"key_0\": {\n \"value\": \"\"\n }\n },\n \"tags\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"1e18ce03-90c3-40df-ab14-d75786d62382","name":"Request accepted","originalRequest":{"url":{"path":["sauth","clients","registered"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"POST","body":{"mode":"raw","raw":"{\n \"email\": \"string\",\n \"password\": \"string\",\n \"phone\": \"+48111222333\",\n \"customId\": \"string\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"displayName\": \"string\",\n \"uuid\": \"07243772-008a-42e1-ba37-c3807cebde8f\",\n \"avatarUrl\": \"string\",\n \"whatsAppId\": \"string\",\n \"birthDate\": \"string\",\n \"company\": \"string\",\n \"city\": \"string\",\n \"address\": \"string\",\n \"zipCode\": \"string\",\n \"province\": \"string\",\n \"countryCode\": \"PL\",\n \"sex\": \"NOT_SPECIFIED\",\n \"agreements\": {\n \"email\": true,\n \"sms\": true,\n \"push\": true,\n \"bluetooth\": false,\n \"rfid\": false,\n \"wifi\": false\n },\n \"attributes\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n }\n },\n \"tags\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"Accepted","code":202,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"caa01b64-156d-4810-9630-dd5772513fee","name":"Profile already exists or request body malformed","originalRequest":{"url":{"path":["sauth","clients","registered"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"email\": \"string\",\n \"password\": \"string\",\n \"phone\": \"+48111222333\",\n \"customId\": \"string\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"displayName\": \"string\",\n \"uuid\": \"07243772-008a-42e1-ba37-c3807cebde8f\",\n \"avatarUrl\": \"string\",\n \"whatsAppId\": \"string\",\n \"birthDate\": \"string\",\n \"company\": \"string\",\n \"city\": \"string\",\n \"address\": \"string\",\n \"zipCode\": \"string\",\n \"province\": \"string\",\n \"countryCode\": \"PL\",\n \"sex\": \"NOT_SPECIFIED\",\n \"agreements\": {\n \"email\": true,\n \"sms\": true,\n \"push\": true,\n \"bluetooth\": false,\n \"rfid\": false,\n \"wifi\": false\n },\n \"attributes\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n }\n },\n \"tags\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"errors\": {\n \"value\": \"\"\n },\n \"status\": {\n \"value\": \"\"\n },\n \"timestamp\": {\n \"value\": \"\"\n },\n \"path\": {\n \"value\": \"\"\n },\n \"traceId\": {\n \"value\": \"\"\n },\n \"errorCode\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"b2f4ff19-5eed-4722-bf48-7ecd049c79a8","name":"JWT missing, expired, or invalid","originalRequest":{"url":{"path":["sauth","clients","registered"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"email\": \"string\",\n \"password\": \"string\",\n \"phone\": \"+48111222333\",\n \"customId\": \"string\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"displayName\": \"string\",\n \"uuid\": \"07243772-008a-42e1-ba37-c3807cebde8f\",\n \"avatarUrl\": \"string\",\n \"whatsAppId\": \"string\",\n \"birthDate\": \"string\",\n \"company\": \"string\",\n \"city\": \"string\",\n \"address\": \"string\",\n \"zipCode\": \"string\",\n \"province\": \"string\",\n \"countryCode\": \"PL\",\n \"sex\": \"NOT_SPECIFIED\",\n \"agreements\": {\n \"email\": true,\n \"sms\": true,\n \"push\": true,\n \"bluetooth\": false,\n \"rfid\": false,\n \"wifi\": false\n },\n \"attributes\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n }\n },\n \"tags\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\",\n \"message\": \"string\",\n \"errors\": [\n {\n \"code\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"rejectedValue\": {\n \"value\": \"\"\n }\n },\n {\n \"code\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"rejectedValue\": {\n \"value\": \"\"\n }\n }\n ],\n \"status\": 8944,\n \"timestamp\": \"string\",\n \"path\": \"string\",\n \"traceId\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"ffc59dad-c0ea-4536-b9f3-fedc9afb633f","name":"Insufficient permissions or wrong JWT scope (for example, profile token where a workspace token was required)","originalRequest":{"url":{"path":["sauth","clients","registered"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"email\": \"string\",\n \"password\": \"string\",\n \"phone\": \"+48111222333\",\n \"customId\": \"string\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"displayName\": \"string\",\n \"uuid\": \"07243772-008a-42e1-ba37-c3807cebde8f\",\n \"avatarUrl\": \"string\",\n \"whatsAppId\": \"string\",\n \"birthDate\": \"string\",\n \"company\": \"string\",\n \"city\": \"string\",\n \"address\": \"string\",\n \"zipCode\": \"string\",\n \"province\": \"string\",\n \"countryCode\": \"PL\",\n \"sex\": \"NOT_SPECIFIED\",\n \"agreements\": {\n \"email\": true,\n \"sms\": true,\n \"push\": true,\n \"bluetooth\": false,\n \"rfid\": false,\n \"wifi\": false\n },\n \"attributes\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n }\n },\n \"tags\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\",\n \"message\": \"string\",\n \"errors\": [\n {\n \"code\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"rejectedValue\": {\n \"value\": \"\"\n }\n },\n {\n \"code\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"rejectedValue\": {\n \"value\": \"\"\n }\n }\n ],\n \"status\": 8944,\n \"timestamp\": \"string\",\n \"path\": \"string\",\n \"traceId\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"396fbd7f-e1c5-4c7b-8ebe-48edc36a311a","name":"Only if customId was obtained from loyalty card code pool: provided customId does not exist in loyalty card code pool","originalRequest":{"url":{"path":["sauth","clients","registered"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"email\": \"string\",\n \"password\": \"string\",\n \"phone\": \"+48111222333\",\n \"customId\": \"string\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"displayName\": \"string\",\n \"uuid\": \"07243772-008a-42e1-ba37-c3807cebde8f\",\n \"avatarUrl\": \"string\",\n \"whatsAppId\": \"string\",\n \"birthDate\": \"string\",\n \"company\": \"string\",\n \"city\": \"string\",\n \"address\": \"string\",\n \"zipCode\": \"string\",\n \"province\": \"string\",\n \"countryCode\": \"PL\",\n \"sex\": \"NOT_SPECIFIED\",\n \"agreements\": {\n \"email\": true,\n \"sms\": true,\n \"push\": true,\n \"bluetooth\": false,\n \"rfid\": false,\n \"wifi\": false\n },\n \"attributes\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n }\n },\n \"tags\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"Failed Dependency (WebDAV) (RFC 4918)","code":424,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\",\n \"message\": \"string\",\n \"errors\": [\n {\n \"code\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"rejectedValue\": {\n \"value\": \"\"\n }\n },\n {\n \"code\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"rejectedValue\": {\n \"value\": \"\"\n }\n }\n ],\n \"status\": 8944,\n \"timestamp\": \"string\",\n \"path\": \"string\",\n \"traceId\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"7c9d8fde-6ca9-4095-a06e-903864d1b478","name":"Confirm registration with PIN code","request":{"name":"Confirm registration with PIN code","description":{"content":"Confirm account registration with PIN code received by email (code is sent automatically at registration).\n\n---\n\n**API consumer:** Anonymous Profile\n","type":"text/plain"},"url":{"path":["sauth","clients","activation","by-pin-code","confirmation"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"deviceId\": \"string\",\n \"email\": \"string\",\n \"pinCode\": \"string\",\n \"uuid\": \"07243772-008a-42e1-ba37-c3807cebde8f\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"14de7700-0998-4cb9-a2b4-266858a3fe32","name":"OK, account confirmed","originalRequest":{"url":{"path":["sauth","clients","activation","by-pin-code","confirmation"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"POST","body":{"mode":"raw","raw":"{\n \"deviceId\": \"string\",\n \"email\": \"string\",\n \"pinCode\": \"string\",\n \"uuid\": \"07243772-008a-42e1-ba37-c3807cebde8f\"\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"2af86056-f935-4709-b618-0b331da21b66","name":"Request failed, see error message for details","originalRequest":{"url":{"path":["sauth","clients","activation","by-pin-code","confirmation"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"deviceId\": \"string\",\n \"email\": \"string\",\n \"pinCode\": \"string\",\n \"uuid\": \"07243772-008a-42e1-ba37-c3807cebde8f\"\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"errors\": {\n \"value\": \"\"\n },\n \"status\": {\n \"value\": \"\"\n },\n \"timestamp\": {\n \"value\": \"\"\n },\n \"path\": {\n \"value\": \"\"\n },\n \"traceId\": {\n \"value\": \"\"\n },\n \"errorCode\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"bc6902a9-c2d3-4ae0-ad88-d7613dccb8b7","name":"JWT missing, expired, or invalid","originalRequest":{"url":{"path":["sauth","clients","activation","by-pin-code","confirmation"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"deviceId\": \"string\",\n \"email\": \"string\",\n \"pinCode\": \"string\",\n \"uuid\": \"07243772-008a-42e1-ba37-c3807cebde8f\"\n}","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\",\n \"message\": \"string\",\n \"errors\": [\n {\n \"code\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"rejectedValue\": {\n \"value\": \"\"\n }\n },\n {\n \"code\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"rejectedValue\": {\n \"value\": \"\"\n }\n }\n ],\n \"status\": 8944,\n \"timestamp\": \"string\",\n \"path\": \"string\",\n \"traceId\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"081e65e6-8b87-4d03-8819-1d4490353b83","name":"Request failed, see error message for details","originalRequest":{"url":{"path":["sauth","clients","activation","by-pin-code","confirmation"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"deviceId\": \"string\",\n \"email\": \"string\",\n \"pinCode\": \"string\",\n \"uuid\": \"07243772-008a-42e1-ba37-c3807cebde8f\"\n}","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"errors\": {\n \"value\": \"\"\n },\n \"status\": {\n \"value\": \"\"\n },\n \"timestamp\": {\n \"value\": \"\"\n },\n \"path\": {\n \"value\": \"\"\n },\n \"traceId\": {\n \"value\": \"\"\n },\n \"errorCode\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"7482ec4c-763c-42fa-8c82-c9226b184420","name":"Not Found","originalRequest":{"url":{"path":["sauth","clients","activation","by-pin-code","confirmation"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"POST","body":{"mode":"raw","raw":"{\n \"deviceId\": \"string\",\n \"email\": \"string\",\n \"pinCode\": \"string\",\n \"uuid\": \"07243772-008a-42e1-ba37-c3807cebde8f\"\n}","options":{"raw":{"language":"json"}}}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"1eed3df8-a94b-4aa7-bc9a-7373beb8a91e","name":"Re-send PIN code","request":{"name":"Re-send PIN code","description":{"content":"Re-send a PIN code to the Profile's email.\n\n---\n\n**API consumer:** Anonymous Profile\n","type":"text/plain"},"url":{"path":["sauth","clients","activation","by-pin-code","request"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"email\": \"string\",\n \"deviceId\": \"string\",\n \"uuid\": \"07243772-008a-42e1-ba37-c3807cebde8f\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"3f2c76d6-69b0-4767-9cbf-158b80bd3c90","name":"OK","originalRequest":{"url":{"path":["sauth","clients","activation","by-pin-code","request"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"POST","body":{"mode":"raw","raw":"{\n \"email\": \"string\",\n \"deviceId\": \"string\",\n \"uuid\": \"07243772-008a-42e1-ba37-c3807cebde8f\"\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"633d4da6-f602-4424-b13f-967966ef20ef","name":"Request failed, see error message for details","originalRequest":{"url":{"path":["sauth","clients","activation","by-pin-code","request"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"email\": \"string\",\n \"deviceId\": \"string\",\n \"uuid\": \"07243772-008a-42e1-ba37-c3807cebde8f\"\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"errors\": {\n \"value\": \"\"\n },\n \"status\": {\n \"value\": \"\"\n },\n \"timestamp\": {\n \"value\": \"\"\n },\n \"path\": {\n \"value\": \"\"\n },\n \"traceId\": {\n \"value\": \"\"\n },\n \"errorCode\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"7316f5fd-0078-4c8d-8629-3753e397bf87","name":"JWT missing, expired, or invalid","originalRequest":{"url":{"path":["sauth","clients","activation","by-pin-code","request"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"email\": \"string\",\n \"deviceId\": \"string\",\n \"uuid\": \"07243772-008a-42e1-ba37-c3807cebde8f\"\n}","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\",\n \"message\": \"string\",\n \"errors\": [\n {\n \"code\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"rejectedValue\": {\n \"value\": \"\"\n }\n },\n {\n \"code\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"rejectedValue\": {\n \"value\": \"\"\n }\n }\n ],\n \"status\": 8944,\n \"timestamp\": \"string\",\n \"path\": \"string\",\n \"traceId\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"a54361dd-206f-4c1f-b137-0e9cd9bbc502","name":"Request failed, see error message for details","originalRequest":{"url":{"path":["sauth","clients","activation","by-pin-code","request"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"email\": \"string\",\n \"deviceId\": \"string\",\n \"uuid\": \"07243772-008a-42e1-ba37-c3807cebde8f\"\n}","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"errors\": {\n \"value\": \"\"\n },\n \"status\": {\n \"value\": \"\"\n },\n \"timestamp\": {\n \"value\": \"\"\n },\n \"path\": {\n \"value\": \"\"\n },\n \"traceId\": {\n \"value\": \"\"\n },\n \"errorCode\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"37e094f6-1f05-48e6-a322-297264b8741f","name":"Not Found","originalRequest":{"url":{"path":["sauth","clients","activation","by-pin-code","request"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"POST","body":{"mode":"raw","raw":"{\n \"email\": \"string\",\n \"deviceId\": \"string\",\n \"uuid\": \"07243772-008a-42e1-ba37-c3807cebde8f\"\n}","options":{"raw":{"language":"json"}}}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"e00789eb-803c-4f5e-bc8e-d24b3aa03d7b","name":"Activate a Profile's account","request":{"name":"Activate a Profile's account","description":{"content":"Activate the Profile's account. This is used when registration is configured to keep the account inactive until the email is confirmed.\n\n---\n\n**API consumers:** Profile (Client), Anonymous Profile, Workspace (Business Profile)\n\n**API key permission required:** `SAUTH_CONFIRMATION_CLIENT_CREATE`\n","type":"text/plain"},"url":{"path":["sauth","clients","activation","confirmation"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"token\": \"8a0be35a-f6be-437b-ab18-339cc6194df5\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"2dd9dfde-c1d9-4448-84ac-06545ce65b97","name":"Request accepted","originalRequest":{"url":{"path":["sauth","clients","activation","confirmation"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"POST","body":{"mode":"raw","raw":"{\n \"token\": \"8a0be35a-f6be-437b-ab18-339cc6194df5\"\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"ea421d55-2abf-4422-b01b-0e64439ef22d","name":"Request failed, see error message for details","originalRequest":{"url":{"path":["sauth","clients","activation","confirmation"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"token\": \"8a0be35a-f6be-437b-ab18-339cc6194df5\"\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"errors\": {\n \"value\": \"\"\n },\n \"status\": {\n \"value\": \"\"\n },\n \"timestamp\": {\n \"value\": \"\"\n },\n \"path\": {\n \"value\": \"\"\n },\n \"traceId\": {\n \"value\": \"\"\n },\n \"errorCode\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"63c6ac7a-a47d-4a50-856f-d42558c6ad2c","name":"JWT missing, expired, or invalid","originalRequest":{"url":{"path":["sauth","clients","activation","confirmation"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"token\": \"8a0be35a-f6be-437b-ab18-339cc6194df5\"\n}","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\",\n \"message\": \"string\",\n \"errors\": [\n {\n \"code\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"rejectedValue\": {\n \"value\": \"\"\n }\n },\n {\n \"code\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"rejectedValue\": {\n \"value\": \"\"\n }\n }\n ],\n \"status\": 8944,\n \"timestamp\": \"string\",\n \"path\": \"string\",\n \"traceId\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"a66c6fbe-9fd3-433a-bcc2-286a9d20d330","name":"Request failed, see error message for details","originalRequest":{"url":{"path":["sauth","clients","activation","confirmation"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"token\": \"8a0be35a-f6be-437b-ab18-339cc6194df5\"\n}","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\",\n \"message\": \"string\",\n \"errors\": [\n {\n \"code\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"rejectedValue\": {\n \"value\": \"\"\n }\n },\n {\n \"code\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"rejectedValue\": {\n \"value\": \"\"\n }\n }\n ],\n \"status\": 8944,\n \"timestamp\": \"string\",\n \"path\": \"string\",\n \"traceId\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"cf597aa2-f327-4a88-bead-429c491458a6","name":"Conflict","originalRequest":{"url":{"path":["sauth","clients","activation","confirmation"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"token\": \"8a0be35a-f6be-437b-ab18-339cc6194df5\"\n}","options":{"raw":{"language":"json"}}}},"status":"Conflict","code":409,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"2018-08-09T07:53:32.406+00:00\",\n \"status\": 409,\n \"error\": \"Conflict\",\n \"message\": \"Account already activated\",\n \"path\": \"/clients/activation/request\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"2a8eea18-2a82-40f7-a469-a8178772d92a","name":"Internal Server Error","originalRequest":{"url":{"path":["sauth","clients","activation","confirmation"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"token\": \"8a0be35a-f6be-437b-ab18-339cc6194df5\"\n}","options":{"raw":{"language":"json"}}}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\",\n \"message\": \"string\",\n \"errors\": [\n {\n \"code\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"rejectedValue\": {\n \"value\": \"\"\n }\n },\n {\n \"code\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"rejectedValue\": {\n \"value\": \"\"\n }\n }\n ],\n \"status\": 8944,\n \"timestamp\": \"string\",\n \"path\": \"string\",\n \"traceId\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"b20628de-9ef9-475d-bae7-97cfdf8726a8","name":"Re-send email confirmation","request":{"name":"Re-send email confirmation","description":{"content":"Request a re-sending of the confirmation email.\n\n---\n\n**API consumers:** Profile (Client), Anonymous Profile, Workspace (Business Profile)\n\n**API key permission required:** `SAUTH_CONFIRMATION_CLIENT_CREATE`\n","type":"text/plain"},"url":{"path":["sauth","clients","activation","request"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"email\": \"string\",\n \"deviceId\": \"string\",\n \"uuid\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"bc1a8286-ac26-4861-a876-3b8f87872197","name":"OK","originalRequest":{"url":{"path":["sauth","clients","activation","request"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"POST","body":{"mode":"raw","raw":"{\n \"email\": \"string\",\n \"deviceId\": \"string\",\n \"uuid\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"9ff28273-94b4-4544-b542-7b695d7d1b25","name":"JWT missing, expired, or invalid","originalRequest":{"url":{"path":["sauth","clients","activation","request"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"email\": \"string\",\n \"deviceId\": \"string\",\n \"uuid\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\",\n \"message\": \"string\",\n \"errors\": [\n {\n \"code\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"rejectedValue\": {\n \"value\": \"\"\n }\n },\n {\n \"code\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"rejectedValue\": {\n \"value\": \"\"\n }\n }\n ],\n \"status\": 8944,\n \"timestamp\": \"string\",\n \"path\": \"string\",\n \"traceId\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"d21c8e7a-5787-4d5e-ab58-7ef6cbd99725","name":"Insufficient permissions or wrong JWT scope (for example, profile token where a workspace token was required)","originalRequest":{"url":{"path":["sauth","clients","activation","request"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"email\": \"string\",\n \"deviceId\": \"string\",\n \"uuid\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\",\n \"message\": \"string\",\n \"errors\": [\n {\n \"code\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"rejectedValue\": {\n \"value\": \"\"\n }\n },\n {\n \"code\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"rejectedValue\": {\n \"value\": \"\"\n }\n }\n ],\n \"status\": 8944,\n \"timestamp\": \"string\",\n \"path\": \"string\",\n \"traceId\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"9f513833-6835-4fb3-bf2b-95f2aae4858e","name":"Not Found","originalRequest":{"url":{"path":["sauth","clients","activation","request"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"POST","body":{"mode":"raw","raw":"{\n \"email\": \"string\",\n \"deviceId\": \"string\",\n \"uuid\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}],"event":[]},{"id":"921fe8e0-db3c-4d3a-9f35-00376e3391dd","name":"Profile account management","description":{"content":"","type":"text/plain"},"item":[{"id":"b4a06ef8-c30d-444a-b142-7d57e0a8fe24","name":"Get Profile's own data","request":{"name":"Get Profile's own data","description":{"content":"A Profile can retrieve its details from the database.\n\n---\n\n**API consumers:** Profile (Client), ANONYMOUS_CLIENT_CONDITIONAL\n","type":"text/plain"},"url":{"path":["v4","my-account","personal-information"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"bd5367d9-b1f8-4a4c-a110-5da6fb85f252","name":"Profile information","originalRequest":{"url":{"path":["v4","my-account","personal-information"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"disabled":false,"description":"(Required) ","key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"clientId\": 433230297,\n \"email\": \"string\",\n \"phone\": \"+48111222333\",\n \"customId\": \"string\",\n \"uuid\": \"07243772-008a-42e1-ba37-c3807cebde8f\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"displayName\": \"string\",\n \"company\": \"string\",\n \"address\": \"string\",\n \"city\": \"string\",\n \"province\": \"string\",\n \"zipCode\": \"string\",\n \"countryCode\": \"PL\",\n \"birthDate\": \"1987-10-24\",\n \"sex\": \"OTHER\",\n \"avatarUrl\": \"string\",\n \"whatsAppId\": \"TestWhatsappId\",\n \"anonymous\": false,\n \"agreements\": {\n \"email\": {\n \"value\": \"\"\n },\n \"sms\": {\n \"value\": \"\"\n },\n \"push\": {\n \"value\": \"\"\n },\n \"webPush\": {\n \"value\": \"\"\n },\n \"whatsApp\": {\n \"value\": \"\"\n },\n \"bluetooth\": {\n \"value\": \"\"\n },\n \"rfid\": {\n \"value\": \"\"\n },\n \"wifi\": {\n \"value\": \"\"\n }\n },\n \"attributes\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n },\n \"key_2\": {\n \"value\": \"\"\n },\n \"key_3\": {\n \"value\": \"\"\n }\n },\n \"tags\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"previousClients\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"lastActivityDate\": \"2019-03-19T14:05:39Z\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"22184212-c456-4768-a129-eb91a2462b75","name":"Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc.","originalRequest":{"url":{"path":["v4","my-account","personal-information"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"disabled":false,"description":"(Required) ","key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"Bad Request\",\n \"status\": 400,\n \"timestamp\": \"2020-10-29T13:08:16.235Z\",\n \"path\": \"/exampleEndpoint\",\n \"message\": \"Some fields did not pass validation\",\n \"errors\": [\n {\n \"code\": 120,\n \"field\": \"exampleField\",\n \"message\": \"120\",\n \"rejectedValue\": \"exampleValue\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"69ad75f9-1026-469b-9c6d-5c33a9d9fd24","name":"Forbidden; insufficient permissions (when PII protection is enabled, PII permissions are required in addition to the permissions listed in the method description)","originalRequest":{"url":{"path":["v4","my-account","personal-information"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"disabled":false,"description":"(Required) ","key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"2018-06-07T07:29:27.489+00:00\",\n \"status\": 403,\n \"error\": \"Forbidden\",\n \"message\": \"Forbidden\",\n \"path\": \"/path_of_the_endpoint\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"db0fbac2-b953-408e-ae10-ddfcf2621076","name":"Unsupported Media Type","originalRequest":{"url":{"path":["v4","my-account","personal-information"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"disabled":false,"description":"(Required) ","key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Unsupported Media Type","code":415,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"2018-06-07T07:27:23.136+00:00\",\n \"status\": 415,\n \"error\": \"Unsupported Media Type\",\n \"message\": \"Content type 'application/xml' not supported\",\n \"path\": \"/path_of_the_endpoint\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"8d902c50-28c5-4864-86dd-9cb909e054af","name":"Update Profile's own data","request":{"name":"Update Profile's own data","description":{"content":"A Profile can update its own details.\n\n---\n\n**API consumer:** Profile (Client)\n","type":"text/plain"},"url":{"path":["v4","my-account","personal-information"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"address\": \"string\",\n \"agreements\": {\n \"email\": {\n \"value\": \"\"\n },\n \"sms\": {\n \"value\": \"\"\n },\n \"push\": {\n \"value\": \"\"\n },\n \"webPush\": {\n \"value\": \"\"\n },\n \"whatsApp\": {\n \"value\": \"\"\n },\n \"bluetooth\": {\n \"value\": \"\"\n },\n \"rfid\": {\n \"value\": \"\"\n },\n \"wifi\": {\n \"value\": \"\"\n }\n },\n \"attributes\": {\n \"key_0\": {\n \"value\": \"\"\n }\n },\n \"avatarUrl\": \"string\",\n \"birthDate\": \"1987-10-24\",\n \"city\": \"string\",\n \"company\": \"string\",\n \"countryCode\": \"PL\",\n \"customId\": \"string\",\n \"displayName\": \"string\",\n \"email\": \"string\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"phone\": \"+48111222333\",\n \"province\": \"string\",\n \"sex\": \"NOT_SPECIFIED\",\n \"whatsAppId\": \"TestWhatsappId\",\n \"zipCode\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"e791f0a5-593a-4434-a505-02adbdb30e96","name":"Accepted","originalRequest":{"url":{"path":["v4","my-account","personal-information"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"address\": \"string\",\n \"agreements\": {\n \"email\": {\n \"value\": \"\"\n },\n \"sms\": {\n \"value\": \"\"\n },\n \"push\": {\n \"value\": \"\"\n },\n \"webPush\": {\n \"value\": \"\"\n },\n \"whatsApp\": {\n \"value\": \"\"\n },\n \"bluetooth\": {\n \"value\": \"\"\n },\n \"rfid\": {\n \"value\": \"\"\n },\n \"wifi\": {\n \"value\": \"\"\n }\n },\n \"attributes\": {\n \"key_0\": {\n \"value\": \"\"\n }\n },\n \"avatarUrl\": \"string\",\n \"birthDate\": \"1987-10-24\",\n \"city\": \"string\",\n \"company\": \"string\",\n \"countryCode\": \"PL\",\n \"customId\": \"string\",\n \"displayName\": \"string\",\n \"email\": \"string\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"phone\": \"+48111222333\",\n \"province\": \"string\",\n \"sex\": \"NOT_SPECIFIED\",\n \"whatsAppId\": \"TestWhatsappId\",\n \"zipCode\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Accepted","code":202,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"aafa9632-b307-4d7a-89bf-c4efa315fa6e","name":"Bad Request","originalRequest":{"url":{"path":["v4","my-account","personal-information"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"address\": \"string\",\n \"agreements\": {\n \"email\": {\n \"value\": \"\"\n },\n \"sms\": {\n \"value\": \"\"\n },\n \"push\": {\n \"value\": \"\"\n },\n \"webPush\": {\n \"value\": \"\"\n },\n \"whatsApp\": {\n \"value\": \"\"\n },\n \"bluetooth\": {\n \"value\": \"\"\n },\n \"rfid\": {\n \"value\": \"\"\n },\n \"wifi\": {\n \"value\": \"\"\n }\n },\n \"attributes\": {\n \"key_0\": {\n \"value\": \"\"\n }\n },\n \"avatarUrl\": \"string\",\n \"birthDate\": \"1987-10-24\",\n \"city\": \"string\",\n \"company\": \"string\",\n \"countryCode\": \"PL\",\n \"customId\": \"string\",\n \"displayName\": \"string\",\n \"email\": \"string\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"phone\": \"+48111222333\",\n \"province\": \"string\",\n \"sex\": \"NOT_SPECIFIED\",\n \"whatsAppId\": \"TestWhatsappId\",\n \"zipCode\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"Bad Request\",\n \"status\": 400,\n \"timestamp\": \"2020-10-29T13:08:16.235Z\",\n \"path\": \"/my-account/personal-information\",\n \"message\": \"Some fields did not pass validation\",\n \"errors\": [\n {\n \"code\": 120,\n \"field\": \"avatarUrl\",\n \"message\": \"120\",\n \"rejectedValue\": \"548869\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"c1586006-f811-4e05-89ac-ea49c8338420","name":"Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc.","originalRequest":{"url":{"path":["v4","my-account","personal-information"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"address\": \"string\",\n \"agreements\": {\n \"email\": {\n \"value\": \"\"\n },\n \"sms\": {\n \"value\": \"\"\n },\n \"push\": {\n \"value\": \"\"\n },\n \"webPush\": {\n \"value\": \"\"\n },\n \"whatsApp\": {\n \"value\": \"\"\n },\n \"bluetooth\": {\n \"value\": \"\"\n },\n \"rfid\": {\n \"value\": \"\"\n },\n \"wifi\": {\n \"value\": \"\"\n }\n },\n \"attributes\": {\n \"key_0\": {\n \"value\": \"\"\n }\n },\n \"avatarUrl\": \"string\",\n \"birthDate\": \"1987-10-24\",\n \"city\": \"string\",\n \"company\": \"string\",\n \"countryCode\": \"PL\",\n \"customId\": \"string\",\n \"displayName\": \"string\",\n \"email\": \"string\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"phone\": \"+48111222333\",\n \"province\": \"string\",\n \"sex\": \"NOT_SPECIFIED\",\n \"whatsAppId\": \"TestWhatsappId\",\n \"zipCode\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"Bad Request\",\n \"status\": 400,\n \"timestamp\": \"2020-10-29T13:08:16.235Z\",\n \"path\": \"/exampleEndpoint\",\n \"message\": \"Some fields did not pass validation\",\n \"errors\": [\n {\n \"code\": 120,\n \"field\": \"exampleField\",\n \"message\": \"120\",\n \"rejectedValue\": \"exampleValue\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"d3c032ef-4184-43ee-afef-0d0814bdc414","name":"Forbidden; insufficient permissions (when PII protection is enabled, PII permissions are required in addition to the permissions listed in the method description)","originalRequest":{"url":{"path":["v4","my-account","personal-information"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"address\": \"string\",\n \"agreements\": {\n \"email\": {\n \"value\": \"\"\n },\n \"sms\": {\n \"value\": \"\"\n },\n \"push\": {\n \"value\": \"\"\n },\n \"webPush\": {\n \"value\": \"\"\n },\n \"whatsApp\": {\n \"value\": \"\"\n },\n \"bluetooth\": {\n \"value\": \"\"\n },\n \"rfid\": {\n \"value\": \"\"\n },\n \"wifi\": {\n \"value\": \"\"\n }\n },\n \"attributes\": {\n \"key_0\": {\n \"value\": \"\"\n }\n },\n \"avatarUrl\": \"string\",\n \"birthDate\": \"1987-10-24\",\n \"city\": \"string\",\n \"company\": \"string\",\n \"countryCode\": \"PL\",\n \"customId\": \"string\",\n \"displayName\": \"string\",\n \"email\": \"string\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"phone\": \"+48111222333\",\n \"province\": \"string\",\n \"sex\": \"NOT_SPECIFIED\",\n \"whatsAppId\": \"TestWhatsappId\",\n \"zipCode\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"2018-06-07T07:29:27.489+00:00\",\n \"status\": 403,\n \"error\": \"Forbidden\",\n \"message\": \"Forbidden\",\n \"path\": \"/path_of_the_endpoint\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"fb9ffbdd-e398-4011-89a2-1ce5e7bcef8c","name":"Unsupported Media Type","originalRequest":{"url":{"path":["v4","my-account","personal-information"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"address\": \"string\",\n \"agreements\": {\n \"email\": {\n \"value\": \"\"\n },\n \"sms\": {\n \"value\": \"\"\n },\n \"push\": {\n \"value\": \"\"\n },\n \"webPush\": {\n \"value\": \"\"\n },\n \"whatsApp\": {\n \"value\": \"\"\n },\n \"bluetooth\": {\n \"value\": \"\"\n },\n \"rfid\": {\n \"value\": \"\"\n },\n \"wifi\": {\n \"value\": \"\"\n }\n },\n \"attributes\": {\n \"key_0\": {\n \"value\": \"\"\n }\n },\n \"avatarUrl\": \"string\",\n \"birthDate\": \"1987-10-24\",\n \"city\": \"string\",\n \"company\": \"string\",\n \"countryCode\": \"PL\",\n \"customId\": \"string\",\n \"displayName\": \"string\",\n \"email\": \"string\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"phone\": \"+48111222333\",\n \"province\": \"string\",\n \"sex\": \"NOT_SPECIFIED\",\n \"whatsAppId\": \"TestWhatsappId\",\n \"zipCode\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Unsupported Media Type","code":415,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"2018-06-07T07:27:23.136+00:00\",\n \"status\": 415,\n \"error\": \"Unsupported Media Type\",\n \"message\": \"Content type 'application/xml' not supported\",\n \"path\": \"/path_of_the_endpoint\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"53175e18-91b1-4ca7-9676-34542d50dbba","name":"Request profile phone number change","request":{"name":"Request profile phone number change","description":{"content":"A Profile can request a phone number update. The confirmation code is sent in a text message.\n\n---\n\n**API consumer:** Profile (Client)\n","type":"text/plain"},"url":{"path":["v4","my-account","phone-update","request"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"phone\": \"+48111222333\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"56061896-a2c4-4c9a-837e-371e61deae4d","name":"Request accepted'","originalRequest":{"url":{"path":["v4","my-account","phone-update","request"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Accept","value":"application/json"},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"phone\": \"+48111222333\"\n}","options":{"raw":{"language":"json"}}}},"status":"Accepted","code":202,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"0871553d-daac-4d74-8cf0-a54de3a68cfc","name":"Bad request: input data missing or malformed","originalRequest":{"url":{"path":["v4","my-account","phone-update","request"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Accept","value":"application/json"},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"phone\": \"+48111222333\"\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"2018-06-07T07:28:26.078+00:00\",\n \"status\": 400,\n \"error\": \"Bad Request\",\n \"message\": \"Version header content is invalid\",\n \"path\": \"/path_of_the_endpoint\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"5c4fc176-14b0-494d-a7a5-c979688398ff","name":"Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc.","originalRequest":{"url":{"path":["v4","my-account","phone-update","request"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Accept","value":"application/json"},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"phone\": \"+48111222333\"\n}","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"Bad Request\",\n \"status\": 400,\n \"timestamp\": \"2020-10-29T13:08:16.235Z\",\n \"path\": \"/exampleEndpoint\",\n \"message\": \"Some fields did not pass validation\",\n \"errors\": [\n {\n \"code\": 120,\n \"field\": \"exampleField\",\n \"message\": \"120\",\n \"rejectedValue\": \"exampleValue\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"b03beac4-0afa-47a1-9695-249d757e9744","name":"Forbidden; insufficient permissions (when PII protection is enabled, PII permissions are required in addition to the permissions listed in the method description)","originalRequest":{"url":{"path":["v4","my-account","phone-update","request"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Accept","value":"application/json"},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"phone\": \"+48111222333\"\n}","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"2018-06-07T07:29:27.489+00:00\",\n \"status\": 403,\n \"error\": \"Forbidden\",\n \"message\": \"Forbidden\",\n \"path\": \"/path_of_the_endpoint\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"6768cbad-8403-4c57-8454-cb27b4f3f577","name":"Unsupported Media Type","originalRequest":{"url":{"path":["v4","my-account","phone-update","request"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Accept","value":"application/json"},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"phone\": \"+48111222333\"\n}","options":{"raw":{"language":"json"}}}},"status":"Unsupported Media Type","code":415,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"2018-06-07T07:27:23.136+00:00\",\n \"status\": 415,\n \"error\": \"Unsupported Media Type\",\n \"message\": \"Content type 'application/xml' not supported\",\n \"path\": \"/path_of_the_endpoint\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"244c394b-464c-478a-ad52-c96b41cd5843","name":"Confirm profile phone number change","request":{"name":"Confirm profile phone number change","description":{"content":"Use a code to confirm the phone number change and provide the new number.\n\n---\n\n**API consumer:** Profile (Client)\n","type":"text/plain"},"url":{"path":["v4","my-account","phone-update","confirmation"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"phone\": \"+48111222333\",\n \"confirmationCode\": \"73AC1\",\n \"deviceId\": \"string\",\n \"smsAgreement\": false\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"0f4b447d-9fee-4254-b059-d9b54d54944c","name":"Request accepted","originalRequest":{"url":{"path":["v4","my-account","phone-update","confirmation"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"phone\": \"+48111222333\",\n \"confirmationCode\": \"73AC1\",\n \"deviceId\": \"string\",\n \"smsAgreement\": false\n}","options":{"raw":{"language":"json"}}}},"status":"Accepted","code":202,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"1fec80f7-d9b6-491d-a2b8-d29e31f8b6d8","name":"Bad request: input data missing or malformed","originalRequest":{"url":{"path":["v4","my-account","phone-update","confirmation"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"phone\": \"+48111222333\",\n \"confirmationCode\": \"73AC1\",\n \"deviceId\": \"string\",\n \"smsAgreement\": false\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"2018-06-07T07:28:26.078+00:00\",\n \"status\": 400,\n \"error\": \"Bad Request\",\n \"message\": \"Version header content is invalid\",\n \"path\": \"/path_of_the_endpoint\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"81723a23-893e-4d95-b8f3-cb73357e2979","name":"Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc.","originalRequest":{"url":{"path":["v4","my-account","phone-update","confirmation"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"phone\": \"+48111222333\",\n \"confirmationCode\": \"73AC1\",\n \"deviceId\": \"string\",\n \"smsAgreement\": false\n}","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"Bad Request\",\n \"status\": 400,\n \"timestamp\": \"2020-10-29T13:08:16.235Z\",\n \"path\": \"/exampleEndpoint\",\n \"message\": \"Some fields did not pass validation\",\n \"errors\": [\n {\n \"code\": 120,\n \"field\": \"exampleField\",\n \"message\": \"120\",\n \"rejectedValue\": \"exampleValue\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"8f9640fa-596c-4fda-a992-20ab8df7b772","name":"Forbidden; insufficient permissions (when PII protection is enabled, PII permissions are required in addition to the permissions listed in the method description)","originalRequest":{"url":{"path":["v4","my-account","phone-update","confirmation"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"phone\": \"+48111222333\",\n \"confirmationCode\": \"73AC1\",\n \"deviceId\": \"string\",\n \"smsAgreement\": false\n}","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"2018-06-07T07:29:27.489+00:00\",\n \"status\": 403,\n \"error\": \"Forbidden\",\n \"message\": \"Forbidden\",\n \"path\": \"/path_of_the_endpoint\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"2d09c8a8-2bb3-4153-97e7-4b0af4da30b3","name":"Unsupported Media Type","originalRequest":{"url":{"path":["v4","my-account","phone-update","confirmation"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"phone\": \"+48111222333\",\n \"confirmationCode\": \"73AC1\",\n \"deviceId\": \"string\",\n \"smsAgreement\": false\n}","options":{"raw":{"language":"json"}}}},"status":"Unsupported Media Type","code":415,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"2018-06-07T07:27:23.136+00:00\",\n \"status\": 415,\n \"error\": \"Unsupported Media Type\",\n \"message\": \"Content type 'application/xml' not supported\",\n \"path\": \"/path_of_the_endpoint\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"a9811321-0ac2-4675-94ab-e75f852a70b2","name":"Request Profile password reset","request":{"name":"Request Profile password reset","description":{"content":"Allows a Profile to send a password reset request. A reset link is sent to the specified email address.\nTo confirm the request, use the [Confirm a Profile's password reset](#operation/ConfirmClientPasswordReset) endpoint.\n\n---\n\n**API consumers:** Anonymous Profile, Workspace (Business Profile)\n\n**API key permission required:** `SAUTH_PASSWORD_RESET_CLIENT_CREATE`\n","type":"text/plain"},"url":{"path":["sauth","clients","password-reset","request"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"email\": \"testDoc@example.com\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"0a8d115c-8400-422b-8429-039417ee38d3","name":"Request accepted","originalRequest":{"url":{"path":["sauth","clients","password-reset","request"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"POST","body":{"mode":"raw","raw":"{\n \"email\": \"testDoc@example.com\"\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"1069e1b8-e2d2-4d55-8664-8868a3fb0899","name":"Created","originalRequest":{"url":{"path":["sauth","clients","password-reset","request"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"POST","body":{"mode":"raw","raw":"{\n \"email\": \"testDoc@example.com\"\n}","options":{"raw":{"language":"json"}}}},"status":"Created","code":201,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"557339a7-0c49-41aa-8786-73644cb10c18","name":"JWT missing, expired, or invalid","originalRequest":{"url":{"path":["sauth","clients","password-reset","request"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"email\": \"testDoc@example.com\"\n}","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\",\n \"message\": \"string\",\n \"errors\": [\n {\n \"code\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"rejectedValue\": {\n \"value\": \"\"\n }\n },\n {\n \"code\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"rejectedValue\": {\n \"value\": \"\"\n }\n }\n ],\n \"status\": 8944,\n \"timestamp\": \"string\",\n \"path\": \"string\",\n \"traceId\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"b4ce2bfe-8bde-49b0-bad5-1b06da42f376","name":"Forbidden","originalRequest":{"url":{"path":["sauth","clients","password-reset","request"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"email\": \"testDoc@example.com\"\n}","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"errors\": {\n \"value\": \"\"\n },\n \"status\": {\n \"value\": \"\"\n },\n \"timestamp\": {\n \"value\": \"\"\n },\n \"path\": {\n \"value\": \"\"\n },\n \"traceId\": {\n \"value\": \"\"\n },\n \"errorCode\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"6e3cbccf-6581-42dd-b145-731fdc0b1e0f","name":"Not Found","originalRequest":{"url":{"path":["sauth","clients","password-reset","request"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"POST","body":{"mode":"raw","raw":"{\n \"email\": \"testDoc@example.com\"\n}","options":{"raw":{"language":"json"}}}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"202b6e41-1113-498b-8196-ae7a792936ed","name":"Confirm Profile password reset","request":{"name":"Confirm Profile password reset","description":{"content":"Confirm a password reset using the token obtained from the [Request Profile password reset](#operation/RequestClientPasswordReset) endpoint.\n\n---\n\n**API consumers:** Anonymous Profile, Workspace (Business Profile)\n\n**API key permission required:** `SAUTH_PASSWORD_RESET_CLIENT_CREATE`\n","type":"text/plain"},"url":{"path":["sauth","clients","password-reset","confirmation"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"password\": \"testPass1!\",\n \"token\": \"token_from_pass_reset_req\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"db097e9e-667f-4976-b79f-775d10434198","name":"Request accepted","originalRequest":{"url":{"path":["sauth","clients","password-reset","confirmation"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"POST","body":{"mode":"raw","raw":"{\n \"password\": \"testPass1!\",\n \"token\": \"token_from_pass_reset_req\"\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"d6610840-1499-4517-9bc3-dfdc11a183f3","name":"Change Profile password","request":{"name":"Change Profile password","description":{"content":"A Profile can update the password to its account.\n\n---\n\n**API consumer:** Profile (Client)\n","type":"text/plain"},"url":{"path":["sauth","my-account","change-password"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\"oldPassword\":\"test1.1234\",\"password\":\"Test.1234\",\"deviceId\":\"optional\"}","options":{"raw":{"language":"json"}}}},"response":[{"id":"aff8c399-4aa8-467f-b260-53d67aec1579","name":"Request accepted","originalRequest":{"url":{"path":["sauth","my-account","change-password"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"text/plain"}],"method":"POST","body":{"mode":"raw","raw":"{\"oldPassword\":\"test1.1234\",\"password\":\"Test.1234\",\"deviceId\":\"optional\"}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"831cff76-b7a7-4b80-a4ef-763f1be93615","name":"Bad Request","originalRequest":{"url":{"path":["sauth","my-account","change-password"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\"oldPassword\":\"test1.1234\",\"password\":\"Test.1234\",\"deviceId\":\"optional\"}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"Bad Request\",\n \"status\": 400,\n \"timestamp\": \"2018-08-01T19:46:52.178Z\",\n \"message\": \"Password must have at least 6 characters and must contain at least one digit, one letter and one special character\",\n \"path\": \"/my-account/change-password\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"daab3830-244e-45d9-90a9-f5d3c35b1fc5","name":"Delete account","request":{"name":"Delete account","description":{"content":"A Profile can delete its own account. Its history shows an `client.deleteAccount` event. All marketing agreements are cancelled. The profile is signed out on all devices and cannot sign in again.\n\n\n---\n\n**API consumer:** Profile (Client)\n","type":"text/plain"},"url":{"path":["sauth","v2","my-account","delete"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"password\": \"string\",\n \"identityProvider\": \"OAUTH\",\n \"uuid\": \"07243772-008a-42e1-ba37-c3807cebde8f\",\n \"externalToken\": \"string\",\n \"customId\": \"string\",\n \"deviceId\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"2c4e82fe-25c3-4e4e-9863-0b116c1cf7ed","name":"Account deleted","originalRequest":{"url":{"path":["sauth","v2","my-account","delete"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"POST","body":{"mode":"raw","raw":"{\n \"password\": \"string\",\n \"identityProvider\": \"OAUTH\",\n \"uuid\": \"07243772-008a-42e1-ba37-c3807cebde8f\",\n \"externalToken\": \"string\",\n \"customId\": \"string\",\n \"deviceId\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"138c88c5-bd8b-45db-a6b8-8e4d65d4454e","name":"Request body malformed/invalid","originalRequest":{"url":{"path":["sauth","v2","my-account","delete"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"password\": \"string\",\n \"identityProvider\": \"OAUTH\",\n \"uuid\": \"07243772-008a-42e1-ba37-c3807cebde8f\",\n \"externalToken\": \"string\",\n \"customId\": \"string\",\n \"deviceId\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\",\n \"message\": \"string\",\n \"errors\": [\n {\n \"code\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"rejectedValue\": {\n \"value\": \"\"\n }\n },\n {\n \"code\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"rejectedValue\": {\n \"value\": \"\"\n }\n }\n ],\n \"status\": 8944,\n \"timestamp\": \"string\",\n \"path\": \"string\",\n \"traceId\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"2a9d18d8-78df-4be9-9a23-c73d47ca3b52","name":"JWT missing, expired, or invalid","originalRequest":{"url":{"path":["sauth","v2","my-account","delete"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"password\": \"string\",\n \"identityProvider\": \"OAUTH\",\n \"uuid\": \"07243772-008a-42e1-ba37-c3807cebde8f\",\n \"externalToken\": \"string\",\n \"customId\": \"string\",\n \"deviceId\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\",\n \"message\": \"string\",\n \"errors\": [\n {\n \"code\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"rejectedValue\": {\n \"value\": \"\"\n }\n },\n {\n \"code\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"rejectedValue\": {\n \"value\": \"\"\n }\n }\n ],\n \"status\": 8944,\n \"timestamp\": \"string\",\n \"path\": \"string\",\n \"traceId\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"d253df53-1edf-4fcd-b0e8-ab5ffd9e81fb","name":"Invalid credentials in request body","originalRequest":{"url":{"path":["sauth","v2","my-account","delete"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"password\": \"string\",\n \"identityProvider\": \"OAUTH\",\n \"uuid\": \"07243772-008a-42e1-ba37-c3807cebde8f\",\n \"externalToken\": \"string\",\n \"customId\": \"string\",\n \"deviceId\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\",\n \"message\": \"string\",\n \"errors\": [\n {\n \"code\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"rejectedValue\": {\n \"value\": \"\"\n }\n },\n {\n \"code\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"rejectedValue\": {\n \"value\": \"\"\n }\n }\n ],\n \"status\": 8944,\n \"timestamp\": \"string\",\n \"path\": \"string\",\n \"traceId\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"8022149e-dc7f-4819-9180-0439c66cdbba","name":"Not Found","originalRequest":{"url":{"path":["sauth","v2","my-account","delete"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"POST","body":{"mode":"raw","raw":"{\n \"password\": \"string\",\n \"identityProvider\": \"OAUTH\",\n \"uuid\": \"07243772-008a-42e1-ba37-c3807cebde8f\",\n \"externalToken\": \"string\",\n \"customId\": \"string\",\n \"deviceId\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"81a6b9e7-7673-49f3-803d-f3f2c89bb619","name":"Request Profile email change","request":{"name":"Request Profile email change","description":{"content":"A Profile can request an email change for its own account. A confirmation token is sent to the new email by and must be applied by clicking the link in the message or using the [Confirm Profile email change](#operation/confirmClientEmailChange) endpoint.\n\n---\n\n**API consumer:** Profile (Client)\n","type":"text/plain"},"url":{"path":["sauth","v2","my-account","email-change","request"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":null,"body":{"mode":"raw","raw":"{\n \"email\": \"string\",\n \"uuid\": \"07243772-008a-42e1-ba37-c3807cebde8f\",\n \"externalToken\": \"string\",\n \"password\": \"string\",\n \"deviceId\": \"string\",\n \"customId\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"d2498ecb-03b5-4ce9-a232-9db10c33b93e","name":"Email change requested, confirmation token sent to new email","originalRequest":{"url":{"path":["sauth","v2","my-account","email-change","request"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"method":"POST","body":{"mode":"raw","raw":"{\n \"email\": \"string\",\n \"uuid\": \"07243772-008a-42e1-ba37-c3807cebde8f\",\n \"externalToken\": \"string\",\n \"password\": \"string\",\n \"deviceId\": \"string\",\n \"customId\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"ae9e5674-7282-459a-9dad-1288d2b3f1e8","name":"Request body malformed/invalid","originalRequest":{"url":{"path":["sauth","v2","my-account","email-change","request"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"email\": \"string\",\n \"uuid\": \"07243772-008a-42e1-ba37-c3807cebde8f\",\n \"externalToken\": \"string\",\n \"password\": \"string\",\n \"deviceId\": \"string\",\n \"customId\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\",\n \"message\": \"string\",\n \"errors\": [\n {\n \"code\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"rejectedValue\": {\n \"value\": \"\"\n }\n },\n {\n \"code\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"rejectedValue\": {\n \"value\": \"\"\n }\n }\n ],\n \"status\": 8944,\n \"timestamp\": \"string\",\n \"path\": \"string\",\n \"traceId\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"195ae855-755a-4ccb-859d-1c7b828c2f59","name":"JWT missing, expired, or invalid","originalRequest":{"url":{"path":["sauth","v2","my-account","email-change","request"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"email\": \"string\",\n \"uuid\": \"07243772-008a-42e1-ba37-c3807cebde8f\",\n \"externalToken\": \"string\",\n \"password\": \"string\",\n \"deviceId\": \"string\",\n \"customId\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\",\n \"message\": \"string\",\n \"errors\": [\n {\n \"code\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"rejectedValue\": {\n \"value\": \"\"\n }\n },\n {\n \"code\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"rejectedValue\": {\n \"value\": \"\"\n }\n }\n ],\n \"status\": 8944,\n \"timestamp\": \"string\",\n \"path\": \"string\",\n \"traceId\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"8579ca2b-9a19-4690-8e7d-ebcc326bf9ed","name":"Invalid credentials in request body","originalRequest":{"url":{"path":["sauth","v2","my-account","email-change","request"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"email\": \"string\",\n \"uuid\": \"07243772-008a-42e1-ba37-c3807cebde8f\",\n \"externalToken\": \"string\",\n \"password\": \"string\",\n \"deviceId\": \"string\",\n \"customId\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\",\n \"message\": \"string\",\n \"errors\": [\n {\n \"code\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"rejectedValue\": {\n \"value\": \"\"\n }\n },\n {\n \"code\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"rejectedValue\": {\n \"value\": \"\"\n }\n }\n ],\n \"status\": 8944,\n \"timestamp\": \"string\",\n \"path\": \"string\",\n \"traceId\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"9709915f-a58c-4d04-8902-b3a930c75266","name":"Not Found","originalRequest":{"url":{"path":["sauth","v2","my-account","email-change","request"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"method":"POST","body":{"mode":"raw","raw":"{\n \"email\": \"string\",\n \"uuid\": \"07243772-008a-42e1-ba37-c3807cebde8f\",\n \"externalToken\": \"string\",\n \"password\": \"string\",\n \"deviceId\": \"string\",\n \"customId\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"99882603-610e-41a8-8447-94b96f7f9c38","name":"Log out a Profile","request":{"name":"Log out a Profile","description":{"content":"Log out a Profile when authenticated as that Profile.\n\n---\n\n**API consumers:** Profile (Client), ANONYMOUS_CLIENT_CONDITIONAL\n","type":"text/plain"},"url":{"path":["sauth","v3","my-account","logout"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":null,"body":{"mode":"raw","raw":"{\n \"action\": \"LOGOUT\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"0e8ed166-ff17-439f-afaf-2372d151cdca","name":"OK","originalRequest":{"url":{"path":["sauth","v3","my-account","logout"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"method":"POST","body":{"mode":"raw","raw":"{\n \"action\": \"LOGOUT\"\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"8652ee0c-fafa-4c72-829f-31d9cb1f2803","name":"JWT missing, expired, or invalid","originalRequest":{"url":{"path":["sauth","v3","my-account","logout"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"action\": \"LOGOUT\"\n}","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\",\n \"message\": \"string\",\n \"errors\": [\n {\n \"code\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"rejectedValue\": {\n \"value\": \"\"\n }\n },\n {\n \"code\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"rejectedValue\": {\n \"value\": \"\"\n }\n }\n ],\n \"status\": 8944,\n \"timestamp\": \"string\",\n \"path\": \"string\",\n \"traceId\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"ff381e17-1ced-478e-ba11-925336cbff73","name":"Insufficient permissions or wrong JWT scope (for example, profile token where a workspace token was required)","originalRequest":{"url":{"path":["sauth","v3","my-account","logout"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"action\": \"LOGOUT\"\n}","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\",\n \"message\": \"string\",\n \"errors\": [\n {\n \"code\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"rejectedValue\": {\n \"value\": \"\"\n }\n },\n {\n \"code\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"rejectedValue\": {\n \"value\": \"\"\n }\n }\n ],\n \"status\": 8944,\n \"timestamp\": \"string\",\n \"path\": \"string\",\n \"traceId\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"5183e890-f54e-403f-b98f-1544571ec12b","name":"Profile not found","originalRequest":{"url":{"path":["sauth","v3","my-account","logout"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"method":"POST","body":{"mode":"raw","raw":"{\n \"action\": \"LOGOUT\"\n}","options":{"raw":{"language":"json"}}}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"9f14bae0-3720-4723-b324-2b2cd0e77073","name":"Confirm Profile email change","request":{"name":"Confirm Profile email change","description":{"content":"The Profile can confirm the email change by providing the token that they received by email as a result of the [Request a Profile email change](#operation/changeEmailRequestUsingPOST) call.\n\n---\n\n**API consumer:** Profile (Client)\n","type":"text/plain"},"url":{"path":["sauth","my-account","email-change","confirmation"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\"token\":\"token_from_email_change_mail\",\"newsletterAgreement\":true}","options":{"raw":{"language":"json"}}}},"response":[{"id":"7c569fec-b562-4579-81e1-7b5fdfbae3f2","name":"Request accepted","originalRequest":{"url":{"path":["sauth","my-account","email-change","confirmation"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"POST","body":{"mode":"raw","raw":"{\"token\":\"token_from_email_change_mail\",\"newsletterAgreement\":true}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"95c807b4-4f08-46c6-8bbd-1b0d313fbab4","name":"Request body malformed/invalid","originalRequest":{"url":{"path":["sauth","my-account","email-change","confirmation"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\"token\":\"token_from_email_change_mail\",\"newsletterAgreement\":true}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\",\n \"message\": \"string\",\n \"errors\": [\n {\n \"code\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"rejectedValue\": {\n \"value\": \"\"\n }\n },\n {\n \"code\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"rejectedValue\": {\n \"value\": \"\"\n }\n }\n ],\n \"status\": 8944,\n \"timestamp\": \"string\",\n \"path\": \"string\",\n \"traceId\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"c939579d-8311-4ae9-95d5-1fda36a69af5","name":"JWT missing, expired, or invalid","originalRequest":{"url":{"path":["sauth","my-account","email-change","confirmation"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\"token\":\"token_from_email_change_mail\",\"newsletterAgreement\":true}","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\",\n \"message\": \"string\",\n \"errors\": [\n {\n \"code\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"rejectedValue\": {\n \"value\": \"\"\n }\n },\n {\n \"code\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"rejectedValue\": {\n \"value\": \"\"\n }\n }\n ],\n \"status\": 8944,\n \"timestamp\": \"string\",\n \"path\": \"string\",\n \"traceId\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"64c267d3-4a94-42e6-ad5c-3205d9c0c1e8","name":"Invalid confirmation token","originalRequest":{"url":{"path":["sauth","my-account","email-change","confirmation"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\"token\":\"token_from_email_change_mail\",\"newsletterAgreement\":true}","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\",\n \"message\": \"string\",\n \"errors\": [\n {\n \"code\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"rejectedValue\": {\n \"value\": \"\"\n }\n },\n {\n \"code\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"rejectedValue\": {\n \"value\": \"\"\n }\n }\n ],\n \"status\": 8944,\n \"timestamp\": \"string\",\n \"path\": \"string\",\n \"traceId\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"4504867d-7cee-4a08-9b94-d27c4c915f83","name":"Change Facebook Profile email","request":{"name":"Change Facebook Profile email","description":{"content":"Change the email address of a Profile registered by Facebook\n\n---\n\n**API consumer:** Profile (Client)\n","type":"text/plain"},"url":{"path":["sauth","clients","facebook","email-change","request"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"email\": \"string\",\n \"uuid\": \"07243772-008a-42e1-ba37-c3807cebde8f\",\n \"deviceId\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"6be6d64f-6118-4d66-b443-d162a30157c0","name":"OK","originalRequest":{"url":{"path":["sauth","clients","facebook","email-change","request"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"POST","body":{"mode":"raw","raw":"{\n \"email\": \"string\",\n \"uuid\": \"07243772-008a-42e1-ba37-c3807cebde8f\",\n \"deviceId\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"3e3928ae-dc33-4e50-8be8-019287b387e1","name":"JWT missing, expired, or invalid","originalRequest":{"url":{"path":["sauth","clients","facebook","email-change","request"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"email\": \"string\",\n \"uuid\": \"07243772-008a-42e1-ba37-c3807cebde8f\",\n \"deviceId\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\",\n \"message\": \"string\",\n \"errors\": [\n {\n \"code\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"rejectedValue\": {\n \"value\": \"\"\n }\n },\n {\n \"code\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"rejectedValue\": {\n \"value\": \"\"\n }\n }\n ],\n \"status\": 8944,\n \"timestamp\": \"string\",\n \"path\": \"string\",\n \"traceId\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"20a916a3-4432-454d-bf73-abc33a2c5854","name":"Insufficient permissions or wrong JWT scope (for example, profile token where a workspace token was required)","originalRequest":{"url":{"path":["sauth","clients","facebook","email-change","request"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"email\": \"string\",\n \"uuid\": \"07243772-008a-42e1-ba37-c3807cebde8f\",\n \"deviceId\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\",\n \"message\": \"string\",\n \"errors\": [\n {\n \"code\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"rejectedValue\": {\n \"value\": \"\"\n }\n },\n {\n \"code\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"rejectedValue\": {\n \"value\": \"\"\n }\n }\n ],\n \"status\": 8944,\n \"timestamp\": \"string\",\n \"path\": \"string\",\n \"traceId\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"80d4d66f-5823-4774-83eb-aef7f972e80e","name":"Not Found","originalRequest":{"url":{"path":["sauth","clients","facebook","email-change","request"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"POST","body":{"mode":"raw","raw":"{\n \"email\": \"string\",\n \"uuid\": \"07243772-008a-42e1-ba37-c3807cebde8f\",\n \"deviceId\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"ce00fc50-2835-43fc-8c0a-2600926d12c6","name":"Delete Client Account (OAuth)","request":{"name":"Delete Client Account (OAuth)","description":{"content":"\nThis endpoint is deprecated. Use [this one](#operation/deleteAccountUsingPOST).\n\nA Client can delete their own account.\n\n\n---\n\n**API consumer:** Profile (Client)\n","type":"text/plain"},"url":{"path":["sauth","clients","oauth","deleted"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"accessToken\": \"string\",\n \"uuid\": \"07243772-008a-42e1-ba37-c3807cebde8f\",\n \"deviceId\": \"string\",\n \"customId\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"62468a54-80ec-48b7-b82d-ff51a0b688b1","name":"OK","originalRequest":{"url":{"path":["sauth","clients","oauth","deleted"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"POST","body":{"mode":"raw","raw":"{\n \"accessToken\": \"string\",\n \"uuid\": \"07243772-008a-42e1-ba37-c3807cebde8f\",\n \"deviceId\": \"string\",\n \"customId\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"8336cf4b-cc1d-46eb-ab8b-524f6a35547c","name":"Request body malformed/invalid","originalRequest":{"url":{"path":["sauth","clients","oauth","deleted"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"accessToken\": \"string\",\n \"uuid\": \"07243772-008a-42e1-ba37-c3807cebde8f\",\n \"deviceId\": \"string\",\n \"customId\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\",\n \"message\": \"string\",\n \"errors\": [\n {\n \"code\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"rejectedValue\": {\n \"value\": \"\"\n }\n },\n {\n \"code\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"rejectedValue\": {\n \"value\": \"\"\n }\n }\n ],\n \"status\": 8944,\n \"timestamp\": \"string\",\n \"path\": \"string\",\n \"traceId\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"35785ed6-19d5-4ddd-a2ff-bcf945fc442a","name":"JWT missing, expired, or invalid","originalRequest":{"url":{"path":["sauth","clients","oauth","deleted"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"accessToken\": \"string\",\n \"uuid\": \"07243772-008a-42e1-ba37-c3807cebde8f\",\n \"deviceId\": \"string\",\n \"customId\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\",\n \"message\": \"string\",\n \"errors\": [\n {\n \"code\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"rejectedValue\": {\n \"value\": \"\"\n }\n },\n {\n \"code\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"rejectedValue\": {\n \"value\": \"\"\n }\n }\n ],\n \"status\": 8944,\n \"timestamp\": \"string\",\n \"path\": \"string\",\n \"traceId\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"976f9094-836e-48bb-825e-726bb749fab8","name":"Invalid credentials in request body","originalRequest":{"url":{"path":["sauth","clients","oauth","deleted"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"accessToken\": \"string\",\n \"uuid\": \"07243772-008a-42e1-ba37-c3807cebde8f\",\n \"deviceId\": \"string\",\n \"customId\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\",\n \"message\": \"string\",\n \"errors\": [\n {\n \"code\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"rejectedValue\": {\n \"value\": \"\"\n }\n },\n {\n \"code\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"rejectedValue\": {\n \"value\": \"\"\n }\n }\n ],\n \"status\": 8944,\n \"timestamp\": \"string\",\n \"path\": \"string\",\n \"traceId\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"9ebc921c-984e-4a48-a48e-bbd969713091","name":"Not Found","originalRequest":{"url":{"path":["sauth","clients","oauth","deleted"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"POST","body":{"mode":"raw","raw":"{\n \"accessToken\": \"string\",\n \"uuid\": \"07243772-008a-42e1-ba37-c3807cebde8f\",\n \"deviceId\": \"string\",\n \"customId\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"a4c6e3cf-719b-4a35-9e8e-f282f6c844b1","name":"Delete Profile account (Sign in with Apple)","request":{"name":"Delete Profile account (Sign in with Apple)","description":{"content":"\nThis endpoint is deprecated. Use [this one](#operation/deleteAccountUsingPOST).\n\nA Profile can delete its own account.\n\n\n---\n\n**API consumer:** Profile (Client)\n","type":"text/plain"},"url":{"path":["sauth","clients","apple","deleted"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"accessToken\": \"string\",\n \"uuid\": \"07243772-008a-42e1-ba37-c3807cebde8f\",\n \"deviceId\": \"string\",\n \"customId\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"9932481a-af17-4360-a118-351fb2ca63a8","name":"OK","originalRequest":{"url":{"path":["sauth","clients","apple","deleted"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"POST","body":{"mode":"raw","raw":"{\n \"accessToken\": \"string\",\n \"uuid\": \"07243772-008a-42e1-ba37-c3807cebde8f\",\n \"deviceId\": \"string\",\n \"customId\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"09edce8b-862c-4d3e-a604-02f9312ce540","name":"JWT missing, expired, or invalid","originalRequest":{"url":{"path":["sauth","clients","apple","deleted"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"accessToken\": \"string\",\n \"uuid\": \"07243772-008a-42e1-ba37-c3807cebde8f\",\n \"deviceId\": \"string\",\n \"customId\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\",\n \"message\": \"string\",\n \"errors\": [\n {\n \"code\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"rejectedValue\": {\n \"value\": \"\"\n }\n },\n {\n \"code\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"rejectedValue\": {\n \"value\": \"\"\n }\n }\n ],\n \"status\": 8944,\n \"timestamp\": \"string\",\n \"path\": \"string\",\n \"traceId\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"f90d61f0-db31-445a-8bf3-bcefe8acacfc","name":"Insufficient permissions or wrong JWT scope (for example, profile token where a workspace token was required)","originalRequest":{"url":{"path":["sauth","clients","apple","deleted"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"accessToken\": \"string\",\n \"uuid\": \"07243772-008a-42e1-ba37-c3807cebde8f\",\n \"deviceId\": \"string\",\n \"customId\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\",\n \"message\": \"string\",\n \"errors\": [\n {\n \"code\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"rejectedValue\": {\n \"value\": \"\"\n }\n },\n {\n \"code\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"rejectedValue\": {\n \"value\": \"\"\n }\n }\n ],\n \"status\": 8944,\n \"timestamp\": \"string\",\n \"path\": \"string\",\n \"traceId\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"2531a094-01fb-4d9e-b91e-77ddf2c2a0cd","name":"Not Found","originalRequest":{"url":{"path":["sauth","clients","apple","deleted"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"POST","body":{"mode":"raw","raw":"{\n \"accessToken\": \"string\",\n \"uuid\": \"07243772-008a-42e1-ba37-c3807cebde8f\",\n \"deviceId\": \"string\",\n \"customId\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"4eb0d819-0bc9-46ee-87ab-be7e3cebf09f","name":"Delete Facebook Profile Account","request":{"name":"Delete Facebook Profile Account","description":{"content":"\nThis endpoint is deprecated. Use [this one](#operation/deleteAccountUsingPOST).\n\nA Profile can delete its own account.\n\n\n---\n\n**API consumer:** Profile (Client)\n","type":"text/plain"},"url":{"path":["sauth","clients","facebook","deleted"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"facebookToken\": \"string\",\n \"uuid\": \"07243772-008a-42e1-ba37-c3807cebde8f\",\n \"deviceId\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"ef557cac-7173-4253-8faf-5d9a979a4e2a","name":"Request accepted","originalRequest":{"url":{"path":["sauth","clients","facebook","deleted"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"POST","body":{"mode":"raw","raw":"{\n \"facebookToken\": \"string\",\n \"uuid\": \"07243772-008a-42e1-ba37-c3807cebde8f\",\n \"deviceId\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"bc418843-0c85-4d3a-a6bd-d08092f70d29","name":"Request body malformed/invalid","originalRequest":{"url":{"path":["sauth","clients","facebook","deleted"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"facebookToken\": \"string\",\n \"uuid\": \"07243772-008a-42e1-ba37-c3807cebde8f\",\n \"deviceId\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\",\n \"message\": \"string\",\n \"errors\": [\n {\n \"code\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"rejectedValue\": {\n \"value\": \"\"\n }\n },\n {\n \"code\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"rejectedValue\": {\n \"value\": \"\"\n }\n }\n ],\n \"status\": 8944,\n \"timestamp\": \"string\",\n \"path\": \"string\",\n \"traceId\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"44ed50d6-4cac-443a-bd7a-fd36604b3a75","name":"JWT missing, expired, or invalid","originalRequest":{"url":{"path":["sauth","clients","facebook","deleted"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"facebookToken\": \"string\",\n \"uuid\": \"07243772-008a-42e1-ba37-c3807cebde8f\",\n \"deviceId\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\",\n \"message\": \"string\",\n \"errors\": [\n {\n \"code\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"rejectedValue\": {\n \"value\": \"\"\n }\n },\n {\n \"code\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"rejectedValue\": {\n \"value\": \"\"\n }\n }\n ],\n \"status\": 8944,\n \"timestamp\": \"string\",\n \"path\": \"string\",\n \"traceId\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"c3b05023-8602-4798-bb81-eb3e848b4252","name":"Invalid credentials in request body","originalRequest":{"url":{"path":["sauth","clients","facebook","deleted"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"facebookToken\": \"string\",\n \"uuid\": \"07243772-008a-42e1-ba37-c3807cebde8f\",\n \"deviceId\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\",\n \"message\": \"string\",\n \"errors\": [\n {\n \"code\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"rejectedValue\": {\n \"value\": \"\"\n }\n },\n {\n \"code\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"rejectedValue\": {\n \"value\": \"\"\n }\n }\n ],\n \"status\": 8944,\n \"timestamp\": \"string\",\n \"path\": \"string\",\n \"traceId\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"1204d5b6-64f7-4002-86ff-074ba7563ce2","name":"Not Found","originalRequest":{"url":{"path":["sauth","clients","facebook","deleted"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"POST","body":{"mode":"raw","raw":"{\n \"facebookToken\": \"string\",\n \"uuid\": \"07243772-008a-42e1-ba37-c3807cebde8f\",\n \"deviceId\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"0e885497-e83b-45f4-b953-4330cc3afed1","name":"Delete account","request":{"name":"Delete account","description":{"content":"\nThis endpoint is deprecated. Use [this one](#operation/deleteAccountUsingPOST).\n\nA Profile can delete its own account.\n\n\n---\n\n**API consumer:** Profile (Client)\n","type":"text/plain"},"url":{"path":["sauth","my-account","delete"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"password\": \"string\",\n \"uuid\": \"string\",\n \"deviceId\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"33a91f11-365d-47a0-b446-7a66f4fc73ec","name":"OK","originalRequest":{"url":{"path":["sauth","my-account","delete"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"POST","body":{"mode":"raw","raw":"{\n \"password\": \"string\",\n \"uuid\": \"string\",\n \"deviceId\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"893453ea-edd4-4f6f-91ba-2f7a3fd1247a","name":"Request body malformed/invalid","originalRequest":{"url":{"path":["sauth","my-account","delete"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"password\": \"string\",\n \"uuid\": \"string\",\n \"deviceId\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\",\n \"message\": \"string\",\n \"errors\": [\n {\n \"code\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"rejectedValue\": {\n \"value\": \"\"\n }\n },\n {\n \"code\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"rejectedValue\": {\n \"value\": \"\"\n }\n }\n ],\n \"status\": 8944,\n \"timestamp\": \"string\",\n \"path\": \"string\",\n \"traceId\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"c9e71524-7db1-4808-9efe-3858e6f99b16","name":"JWT missing, expired, or invalid","originalRequest":{"url":{"path":["sauth","my-account","delete"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"password\": \"string\",\n \"uuid\": \"string\",\n \"deviceId\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\",\n \"message\": \"string\",\n \"errors\": [\n {\n \"code\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"rejectedValue\": {\n \"value\": \"\"\n }\n },\n {\n \"code\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"rejectedValue\": {\n \"value\": \"\"\n }\n }\n ],\n \"status\": 8944,\n \"timestamp\": \"string\",\n \"path\": \"string\",\n \"traceId\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"1338a57d-fb29-4dc9-ae34-165f5523bb8b","name":"Invalid credentials in request body","originalRequest":{"url":{"path":["sauth","my-account","delete"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"password\": \"string\",\n \"uuid\": \"string\",\n \"deviceId\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\",\n \"message\": \"string\",\n \"errors\": [\n {\n \"code\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"rejectedValue\": {\n \"value\": \"\"\n }\n },\n {\n \"code\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"rejectedValue\": {\n \"value\": \"\"\n }\n }\n ],\n \"status\": 8944,\n \"timestamp\": \"string\",\n \"path\": \"string\",\n \"traceId\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"c662597e-f923-4671-b387-a46f3e3dfd27","name":"Request Profile email change","request":{"name":"Request Profile email change","description":{"content":"\nThis endpoint is deprecated. Use [this one](#operation/changeEmailRequestUsingPOST).\n\nA Profile can request an email change for its account. A confirmation token is sent by and must be applied using the [Confirm Profile email change](#operation/confirmClientEmailChange) endpoint.\n\n\n---\n\n**API consumer:** Profile (Client)\n","type":"text/plain"},"url":{"path":["sauth","my-account","email-change","request"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\"email\":\"newEmail\",\"password\":\"my_password\",\"uuid\":\"my_uuid\",\"deviceId\":\"optional\"}","options":{"raw":{"language":"json"}}}},"response":[{"id":"edc368ec-c5e7-45ab-8ff9-bcb686efeed4","name":"Request accepted","originalRequest":{"url":{"path":["sauth","my-account","email-change","request"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"POST","body":{"mode":"raw","raw":"{\"email\":\"newEmail\",\"password\":\"my_password\",\"uuid\":\"my_uuid\",\"deviceId\":\"optional\"}","options":{"raw":{"language":"json"}}}},"status":"Accepted","code":202,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"82493c16-d552-4aa3-bd91-21707f68730d","name":"Clients not recognizable by email","originalRequest":{"url":{"path":["sauth","my-account","email-change","request"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"POST","body":{"mode":"raw","raw":"{\"email\":\"newEmail\",\"password\":\"my_password\",\"uuid\":\"my_uuid\",\"deviceId\":\"optional\"}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}],"event":[]},{"id":"d542e09a-e1ae-466d-b1fa-c0bbae1cd5af","name":"Profile devices","description":{"content":"","type":"text/plain"},"item":[{"id":"b4923924-bfe8-4ad6-a5ed-70f645f8fdfd","name":"Link a device by profile ID","request":{"name":"Link a device by profile ID","description":{"content":" Assign a device to a profile ID. A profile may have many devices assigned.\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `API_DEVICE_CLIENT_UPDATE`\n\n**User role permission required:** `client_info: update`\n","type":"text/plain"},"url":{"path":["v4","clients",":clientId","linked-devices"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"434428563","key":"clientId","description":"(Required) The ID of the profile\n\n**Upcoming breaking change (effective July 6, 2026):** Synerise is introducing changes to how user identifiers and UUIDs are handled. These changes may affect profiles with accented or diacritical characters in identifiers, profiles with leading or trailing whitespace in identifiers, and profiles with duplicate UUIDs. For details and recommended actions, see [Upcoming changes to identifier and UUID handling](https://hub.synerise.com/docs/settings/configuration/identifier-standardization/).\n"}]},"header":[{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"deviceId\": \"string\",\n \"type\": \"android\",\n \"registrationId\": \"string\",\n \"bluetoothAddress\": \"string\",\n \"macAddress\": \"string\",\n \"manufacturer\": \"string\",\n \"model\": \"string\",\n \"osVersion\": \"string\",\n \"product\": \"a51ul_htc_europe\",\n \"screenHeight\": 6880,\n \"screenWidth\": 1643,\n \"publicKey\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"8153816f-8562-4b6a-b021-05b16e23f00d","name":"Request accepted","originalRequest":{"url":{"path":["v4","clients",":clientId","linked-devices"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"434428563","key":"clientId","description":"(Required) The ID of the profile\n\n**Upcoming breaking change (effective July 6, 2026):** Synerise is introducing changes to how user identifiers and UUIDs are handled. These changes may affect profiles with accented or diacritical characters in identifiers, profiles with leading or trailing whitespace in identifiers, and profiles with duplicate UUIDs. For details and recommended actions, see [Upcoming changes to identifier and UUID handling](https://hub.synerise.com/docs/settings/configuration/identifier-standardization/).\n"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"deviceId\": \"string\",\n \"type\": \"android\",\n \"registrationId\": \"string\",\n \"bluetoothAddress\": \"string\",\n \"macAddress\": \"string\",\n \"manufacturer\": \"string\",\n \"model\": \"string\",\n \"osVersion\": \"string\",\n \"product\": \"a51ul_htc_europe\",\n \"screenHeight\": 6880,\n \"screenWidth\": 1643,\n \"publicKey\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"6d268b81-1726-4986-ac88-d59b133c9dc8","name":"Bad request","originalRequest":{"url":{"path":["v4","clients",":clientId","linked-devices"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"434428563","key":"clientId","description":"(Required) The ID of the profile\n\n**Upcoming breaking change (effective July 6, 2026):** Synerise is introducing changes to how user identifiers and UUIDs are handled. These changes may affect profiles with accented or diacritical characters in identifiers, profiles with leading or trailing whitespace in identifiers, and profiles with duplicate UUIDs. For details and recommended actions, see [Upcoming changes to identifier and UUID handling](https://hub.synerise.com/docs/settings/configuration/identifier-standardization/).\n"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"deviceId\": \"string\",\n \"type\": \"android\",\n \"registrationId\": \"string\",\n \"bluetoothAddress\": \"string\",\n \"macAddress\": \"string\",\n \"manufacturer\": \"string\",\n \"model\": \"string\",\n \"osVersion\": \"string\",\n \"product\": \"a51ul_htc_europe\",\n \"screenHeight\": 6880,\n \"screenWidth\": 1643,\n \"publicKey\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"Bad Request\",\n \"status\": 400,\n \"timestamp\": \"2020-10-29T12:34:02.222Z\",\n \"path\": \"/clients/1245757/linked-devices\",\n \"message\": \"Some fields did not pass validation\",\n \"errors\": [\n {\n \"code\": 12301,\n \"field\": \"deviceId\",\n \"message\": \"12301\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"90412b65-5c76-4321-a7d3-a760a748ed55","name":"Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc.","originalRequest":{"url":{"path":["v4","clients",":clientId","linked-devices"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"434428563","key":"clientId","description":"(Required) The ID of the profile\n\n**Upcoming breaking change (effective July 6, 2026):** Synerise is introducing changes to how user identifiers and UUIDs are handled. These changes may affect profiles with accented or diacritical characters in identifiers, profiles with leading or trailing whitespace in identifiers, and profiles with duplicate UUIDs. For details and recommended actions, see [Upcoming changes to identifier and UUID handling](https://hub.synerise.com/docs/settings/configuration/identifier-standardization/).\n"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"deviceId\": \"string\",\n \"type\": \"android\",\n \"registrationId\": \"string\",\n \"bluetoothAddress\": \"string\",\n \"macAddress\": \"string\",\n \"manufacturer\": \"string\",\n \"model\": \"string\",\n \"osVersion\": \"string\",\n \"product\": \"a51ul_htc_europe\",\n \"screenHeight\": 6880,\n \"screenWidth\": 1643,\n \"publicKey\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"Bad Request\",\n \"status\": 400,\n \"timestamp\": \"2020-10-29T13:08:16.235Z\",\n \"path\": \"/exampleEndpoint\",\n \"message\": \"Some fields did not pass validation\",\n \"errors\": [\n {\n \"code\": 120,\n \"field\": \"exampleField\",\n \"message\": \"120\",\n \"rejectedValue\": \"exampleValue\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"a6b7e2b8-f578-4dfc-a537-cda582345857","name":"Forbidden; insufficient permissions (when PII protection is enabled, PII permissions are required in addition to the permissions listed in the method description)","originalRequest":{"url":{"path":["v4","clients",":clientId","linked-devices"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"434428563","key":"clientId","description":"(Required) The ID of the profile\n\n**Upcoming breaking change (effective July 6, 2026):** Synerise is introducing changes to how user identifiers and UUIDs are handled. These changes may affect profiles with accented or diacritical characters in identifiers, profiles with leading or trailing whitespace in identifiers, and profiles with duplicate UUIDs. For details and recommended actions, see [Upcoming changes to identifier and UUID handling](https://hub.synerise.com/docs/settings/configuration/identifier-standardization/).\n"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"deviceId\": \"string\",\n \"type\": \"android\",\n \"registrationId\": \"string\",\n \"bluetoothAddress\": \"string\",\n \"macAddress\": \"string\",\n \"manufacturer\": \"string\",\n \"model\": \"string\",\n \"osVersion\": \"string\",\n \"product\": \"a51ul_htc_europe\",\n \"screenHeight\": 6880,\n \"screenWidth\": 1643,\n \"publicKey\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"2018-06-07T07:29:27.489+00:00\",\n \"status\": 403,\n \"error\": \"Forbidden\",\n \"message\": \"Forbidden\",\n \"path\": \"/path_of_the_endpoint\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"a5d9dc49-60cf-4deb-887b-6a4cc151398f","name":"Profile not found","originalRequest":{"url":{"path":["v4","clients",":clientId","linked-devices"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"434428563","key":"clientId","description":"(Required) The ID of the profile\n\n**Upcoming breaking change (effective July 6, 2026):** Synerise is introducing changes to how user identifiers and UUIDs are handled. These changes may affect profiles with accented or diacritical characters in identifiers, profiles with leading or trailing whitespace in identifiers, and profiles with duplicate UUIDs. For details and recommended actions, see [Upcoming changes to identifier and UUID handling](https://hub.synerise.com/docs/settings/configuration/identifier-standardization/).\n"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"deviceId\": \"string\",\n \"type\": \"android\",\n \"registrationId\": \"string\",\n \"bluetoothAddress\": \"string\",\n \"macAddress\": \"string\",\n \"manufacturer\": \"string\",\n \"model\": \"string\",\n \"osVersion\": \"string\",\n \"product\": \"a51ul_htc_europe\",\n \"screenHeight\": 6880,\n \"screenWidth\": 1643,\n \"publicKey\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"0ef7c9c1-e2ae-47b7-97a3-4304bda84c7a","name":"Unsupported Media Type","originalRequest":{"url":{"path":["v4","clients",":clientId","linked-devices"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"434428563","key":"clientId","description":"(Required) The ID of the profile\n\n**Upcoming breaking change (effective July 6, 2026):** Synerise is introducing changes to how user identifiers and UUIDs are handled. These changes may affect profiles with accented or diacritical characters in identifiers, profiles with leading or trailing whitespace in identifiers, and profiles with duplicate UUIDs. For details and recommended actions, see [Upcoming changes to identifier and UUID handling](https://hub.synerise.com/docs/settings/configuration/identifier-standardization/).\n"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"deviceId\": \"string\",\n \"type\": \"android\",\n \"registrationId\": \"string\",\n \"bluetoothAddress\": \"string\",\n \"macAddress\": \"string\",\n \"manufacturer\": \"string\",\n \"model\": \"string\",\n \"osVersion\": \"string\",\n \"product\": \"a51ul_htc_europe\",\n \"screenHeight\": 6880,\n \"screenWidth\": 1643,\n \"publicKey\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Unsupported Media Type","code":415,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"2018-06-07T07:27:23.136+00:00\",\n \"status\": 415,\n \"error\": \"Unsupported Media Type\",\n \"message\": \"Content type 'application/xml' not supported\",\n \"path\": \"/path_of_the_endpoint\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"186febce-7f4e-4c0b-abc4-78af369897f1","name":"Link a device by other parameters","request":{"name":"Link a device by other parameters","description":{"content":" Assign a device to a profile UUID. A profile may have many devices assigned.\n\n---\n\n**API consumers:** Workspace (Business Profile), Profile (Client), Anonymous Profile\n\n**API key permission required:** `API_BY_IDENTIFY_DEVICE_CLIENT_UPDATE`\n\n**User role permission required:** `client_info: update`\n","type":"text/plain"},"url":{"path":["v4","clients",":identifierType",":identifierValue","linked-devices"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"by-uuid","key":"identifierType","description":"(Required) The profile identifier to use for the request"},{"disabled":false,"type":"any","value":"string","key":"identifierValue","description":"(Required) The value of the selected identifier. It must be URL-encoded.\n\n**Upcoming breaking change (effective July 6, 2026):** Synerise is introducing changes to how user identifiers and UUIDs are handled. These changes may affect profiles with accented or diacritical characters in identifiers, profiles with leading or trailing whitespace in identifiers, and profiles with duplicate UUIDs. For details and recommended actions, see [Upcoming changes to identifier and UUID handling](https://hub.synerise.com/docs/settings/configuration/identifier-standardization/).\n"}]},"header":[{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"deviceId\": \"string\",\n \"type\": \"android\",\n \"registrationId\": \"string\",\n \"bluetoothAddress\": \"string\",\n \"macAddress\": \"string\",\n \"manufacturer\": \"string\",\n \"model\": \"string\",\n \"osVersion\": \"string\",\n \"product\": \"a51ul_htc_europe\",\n \"screenHeight\": 6880,\n \"screenWidth\": 1643,\n \"publicKey\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"376414d1-06e0-4fdc-bed1-db6363506af4","name":"Request accepted","originalRequest":{"url":{"path":["v4","clients",":identifierType",":identifierValue","linked-devices"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"by-uuid","key":"identifierType","description":"(Required) The profile identifier to use for the request"},{"disabled":false,"type":"any","value":"string","key":"identifierValue","description":"(Required) The value of the selected identifier. It must be URL-encoded.\n\n**Upcoming breaking change (effective July 6, 2026):** Synerise is introducing changes to how user identifiers and UUIDs are handled. These changes may affect profiles with accented or diacritical characters in identifiers, profiles with leading or trailing whitespace in identifiers, and profiles with duplicate UUIDs. For details and recommended actions, see [Upcoming changes to identifier and UUID handling](https://hub.synerise.com/docs/settings/configuration/identifier-standardization/).\n"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Accept","value":"application/json"},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"deviceId\": \"string\",\n \"type\": \"android\",\n \"registrationId\": \"string\",\n \"bluetoothAddress\": \"string\",\n \"macAddress\": \"string\",\n \"manufacturer\": \"string\",\n \"model\": \"string\",\n \"osVersion\": \"string\",\n \"product\": \"a51ul_htc_europe\",\n \"screenHeight\": 6880,\n \"screenWidth\": 1643,\n \"publicKey\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"7af85304-b7ff-4694-ba60-b6257f52d797","name":"Bad request","originalRequest":{"url":{"path":["v4","clients",":identifierType",":identifierValue","linked-devices"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"by-uuid","key":"identifierType","description":"(Required) The profile identifier to use for the request"},{"disabled":false,"type":"any","value":"string","key":"identifierValue","description":"(Required) The value of the selected identifier. It must be URL-encoded.\n\n**Upcoming breaking change (effective July 6, 2026):** Synerise is introducing changes to how user identifiers and UUIDs are handled. These changes may affect profiles with accented or diacritical characters in identifiers, profiles with leading or trailing whitespace in identifiers, and profiles with duplicate UUIDs. For details and recommended actions, see [Upcoming changes to identifier and UUID handling](https://hub.synerise.com/docs/settings/configuration/identifier-standardization/).\n"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Accept","value":"application/json"},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"deviceId\": \"string\",\n \"type\": \"android\",\n \"registrationId\": \"string\",\n \"bluetoothAddress\": \"string\",\n \"macAddress\": \"string\",\n \"manufacturer\": \"string\",\n \"model\": \"string\",\n \"osVersion\": \"string\",\n \"product\": \"a51ul_htc_europe\",\n \"screenHeight\": 6880,\n \"screenWidth\": 1643,\n \"publicKey\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"Bad Request\",\n \"status\": 400,\n \"timestamp\": \"2020-10-29T12:34:02.222Z\",\n \"path\": \"/clients/by-uuid/779465fc-a0c5-41e5-9be2-51c00b2588b4/linked-devices\",\n \"message\": \"Some fields did not pass validation\",\n \"errors\": [\n {\n \"code\": 12301,\n \"field\": \"deviceId\",\n \"message\": \"12301\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"d8a1edb2-03df-4f43-b918-19f667cd98e0","name":"Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc.","originalRequest":{"url":{"path":["v4","clients",":identifierType",":identifierValue","linked-devices"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"by-uuid","key":"identifierType","description":"(Required) The profile identifier to use for the request"},{"disabled":false,"type":"any","value":"string","key":"identifierValue","description":"(Required) The value of the selected identifier. It must be URL-encoded.\n\n**Upcoming breaking change (effective July 6, 2026):** Synerise is introducing changes to how user identifiers and UUIDs are handled. These changes may affect profiles with accented or diacritical characters in identifiers, profiles with leading or trailing whitespace in identifiers, and profiles with duplicate UUIDs. For details and recommended actions, see [Upcoming changes to identifier and UUID handling](https://hub.synerise.com/docs/settings/configuration/identifier-standardization/).\n"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Accept","value":"application/json"},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"deviceId\": \"string\",\n \"type\": \"android\",\n \"registrationId\": \"string\",\n \"bluetoothAddress\": \"string\",\n \"macAddress\": \"string\",\n \"manufacturer\": \"string\",\n \"model\": \"string\",\n \"osVersion\": \"string\",\n \"product\": \"a51ul_htc_europe\",\n \"screenHeight\": 6880,\n \"screenWidth\": 1643,\n \"publicKey\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"Bad Request\",\n \"status\": 400,\n \"timestamp\": \"2020-10-29T13:08:16.235Z\",\n \"path\": \"/exampleEndpoint\",\n \"message\": \"Some fields did not pass validation\",\n \"errors\": [\n {\n \"code\": 120,\n \"field\": \"exampleField\",\n \"message\": \"120\",\n \"rejectedValue\": \"exampleValue\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"fec32408-25ba-48c0-b793-524546acf3f3","name":"Forbidden; insufficient permissions (when PII protection is enabled, PII permissions are required in addition to the permissions listed in the method description)","originalRequest":{"url":{"path":["v4","clients",":identifierType",":identifierValue","linked-devices"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"by-uuid","key":"identifierType","description":"(Required) The profile identifier to use for the request"},{"disabled":false,"type":"any","value":"string","key":"identifierValue","description":"(Required) The value of the selected identifier. It must be URL-encoded.\n\n**Upcoming breaking change (effective July 6, 2026):** Synerise is introducing changes to how user identifiers and UUIDs are handled. These changes may affect profiles with accented or diacritical characters in identifiers, profiles with leading or trailing whitespace in identifiers, and profiles with duplicate UUIDs. For details and recommended actions, see [Upcoming changes to identifier and UUID handling](https://hub.synerise.com/docs/settings/configuration/identifier-standardization/).\n"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Accept","value":"application/json"},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"deviceId\": \"string\",\n \"type\": \"android\",\n \"registrationId\": \"string\",\n \"bluetoothAddress\": \"string\",\n \"macAddress\": \"string\",\n \"manufacturer\": \"string\",\n \"model\": \"string\",\n \"osVersion\": \"string\",\n \"product\": \"a51ul_htc_europe\",\n \"screenHeight\": 6880,\n \"screenWidth\": 1643,\n \"publicKey\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"2018-06-07T07:29:27.489+00:00\",\n \"status\": 403,\n \"error\": \"Forbidden\",\n \"message\": \"Forbidden\",\n \"path\": \"/path_of_the_endpoint\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"b70f2699-7b5b-42b7-b7e4-54917a94acfa","name":"Profile not found","originalRequest":{"url":{"path":["v4","clients",":identifierType",":identifierValue","linked-devices"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"by-uuid","key":"identifierType","description":"(Required) The profile identifier to use for the request"},{"disabled":false,"type":"any","value":"string","key":"identifierValue","description":"(Required) The value of the selected identifier. It must be URL-encoded.\n\n**Upcoming breaking change (effective July 6, 2026):** Synerise is introducing changes to how user identifiers and UUIDs are handled. These changes may affect profiles with accented or diacritical characters in identifiers, profiles with leading or trailing whitespace in identifiers, and profiles with duplicate UUIDs. For details and recommended actions, see [Upcoming changes to identifier and UUID handling](https://hub.synerise.com/docs/settings/configuration/identifier-standardization/).\n"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Accept","value":"application/json"},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"deviceId\": \"string\",\n \"type\": \"android\",\n \"registrationId\": \"string\",\n \"bluetoothAddress\": \"string\",\n \"macAddress\": \"string\",\n \"manufacturer\": \"string\",\n \"model\": \"string\",\n \"osVersion\": \"string\",\n \"product\": \"a51ul_htc_europe\",\n \"screenHeight\": 6880,\n \"screenWidth\": 1643,\n \"publicKey\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"ea4d07c3-2a95-4b22-b51e-94da7861a953","name":"Unsupported Media Type","originalRequest":{"url":{"path":["v4","clients",":identifierType",":identifierValue","linked-devices"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"by-uuid","key":"identifierType","description":"(Required) The profile identifier to use for the request"},{"disabled":false,"type":"any","value":"string","key":"identifierValue","description":"(Required) The value of the selected identifier. It must be URL-encoded.\n\n**Upcoming breaking change (effective July 6, 2026):** Synerise is introducing changes to how user identifiers and UUIDs are handled. These changes may affect profiles with accented or diacritical characters in identifiers, profiles with leading or trailing whitespace in identifiers, and profiles with duplicate UUIDs. For details and recommended actions, see [Upcoming changes to identifier and UUID handling](https://hub.synerise.com/docs/settings/configuration/identifier-standardization/).\n"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Accept","value":"application/json"},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"deviceId\": \"string\",\n \"type\": \"android\",\n \"registrationId\": \"string\",\n \"bluetoothAddress\": \"string\",\n \"macAddress\": \"string\",\n \"manufacturer\": \"string\",\n \"model\": \"string\",\n \"osVersion\": \"string\",\n \"product\": \"a51ul_htc_europe\",\n \"screenHeight\": 6880,\n \"screenWidth\": 1643,\n \"publicKey\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Unsupported Media Type","code":415,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"2018-06-07T07:27:23.136+00:00\",\n \"status\": 415,\n \"error\": \"Unsupported Media Type\",\n \"message\": \"Content type 'application/xml' not supported\",\n \"path\": \"/path_of_the_endpoint\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"0a44dd0a-526c-4f93-8732-7f783ee7ad4d","name":"Link a device to currently logged in profile","request":{"name":"Link a device to currently logged in profile","description":{"content":" Assign a device to the profile that is currently logged in. A Profile may have many devices assigned.\n\n---\n\n**API consumer:** Profile (Client)\n","type":"text/plain"},"url":{"path":["v4","my-account","linked-devices"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"deviceId\": \"string\",\n \"type\": \"android\",\n \"registrationId\": \"string\",\n \"bluetoothAddress\": \"string\",\n \"macAddress\": \"string\",\n \"manufacturer\": \"string\",\n \"model\": \"string\",\n \"osVersion\": \"string\",\n \"product\": \"a51ul_htc_europe\",\n \"screenHeight\": 6880,\n \"screenWidth\": 1643,\n \"publicKey\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"0fcb30ce-d7e3-42bb-9fe3-2b027859d579","name":"Request accepted","originalRequest":{"url":{"path":["v4","my-account","linked-devices"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Accept","value":"application/json"},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"deviceId\": \"string\",\n \"type\": \"android\",\n \"registrationId\": \"string\",\n \"bluetoothAddress\": \"string\",\n \"macAddress\": \"string\",\n \"manufacturer\": \"string\",\n \"model\": \"string\",\n \"osVersion\": \"string\",\n \"product\": \"a51ul_htc_europe\",\n \"screenHeight\": 6880,\n \"screenWidth\": 1643,\n \"publicKey\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"61f1b843-8b36-46b0-ab69-825e79b7ed2d","name":"Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc.","originalRequest":{"url":{"path":["v4","my-account","linked-devices"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Accept","value":"application/json"},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"deviceId\": \"string\",\n \"type\": \"android\",\n \"registrationId\": \"string\",\n \"bluetoothAddress\": \"string\",\n \"macAddress\": \"string\",\n \"manufacturer\": \"string\",\n \"model\": \"string\",\n \"osVersion\": \"string\",\n \"product\": \"a51ul_htc_europe\",\n \"screenHeight\": 6880,\n \"screenWidth\": 1643,\n \"publicKey\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"Bad Request\",\n \"status\": 400,\n \"timestamp\": \"2020-10-29T13:08:16.235Z\",\n \"path\": \"/exampleEndpoint\",\n \"message\": \"Some fields did not pass validation\",\n \"errors\": [\n {\n \"code\": 120,\n \"field\": \"exampleField\",\n \"message\": \"120\",\n \"rejectedValue\": \"exampleValue\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"3c5665e1-596f-410c-a91e-a94b9fd18cd4","name":"Forbidden; insufficient permissions (when PII protection is enabled, PII permissions are required in addition to the permissions listed in the method description)","originalRequest":{"url":{"path":["v4","my-account","linked-devices"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Accept","value":"application/json"},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"deviceId\": \"string\",\n \"type\": \"android\",\n \"registrationId\": \"string\",\n \"bluetoothAddress\": \"string\",\n \"macAddress\": \"string\",\n \"manufacturer\": \"string\",\n \"model\": \"string\",\n \"osVersion\": \"string\",\n \"product\": \"a51ul_htc_europe\",\n \"screenHeight\": 6880,\n \"screenWidth\": 1643,\n \"publicKey\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"2018-06-07T07:29:27.489+00:00\",\n \"status\": 403,\n \"error\": \"Forbidden\",\n \"message\": \"Forbidden\",\n \"path\": \"/path_of_the_endpoint\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"ba1b8dc7-7ada-4277-b38c-ef8f357b3241","name":"Unsupported Media Type","originalRequest":{"url":{"path":["v4","my-account","linked-devices"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Accept","value":"application/json"},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.4"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"deviceId\": \"string\",\n \"type\": \"android\",\n \"registrationId\": \"string\",\n \"bluetoothAddress\": \"string\",\n \"macAddress\": \"string\",\n \"manufacturer\": \"string\",\n \"model\": \"string\",\n \"osVersion\": \"string\",\n \"product\": \"a51ul_htc_europe\",\n \"screenHeight\": 6880,\n \"screenWidth\": 1643,\n \"publicKey\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Unsupported Media Type","code":415,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"2018-06-07T07:27:23.136+00:00\",\n \"status\": 415,\n \"error\": \"Unsupported Media Type\",\n \"message\": \"Content type 'application/xml' not supported\",\n \"path\": \"/path_of_the_endpoint\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"dca9f97f-f382-42b8-8dc1-43263f852ba6","name":"Clean up web push tokens\n","request":{"name":"Clean up web push tokens\n","description":{"content":"Remove mobile push Firebase tokens from profile. You can use this endpoint to clean up tokens updated before a selected date or by service worker version. \n\nUsing this endpoint generates a `webpush.tokenDelete` event for each deleted token.\n\nIf no tokens are left after the clean-up, the `has_webpush_devices` attribute in the profile is set to false.\n\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `PUSH_DEVICES_SERVICE_WEB_PUSH_DEVICES_DELETE`\n\n**User role permission required:** `client_detail: delete`\n","type":"text/plain"},"url":{"path":["push-devices","web-push","clean-up",":clientId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"4489","key":"clientId","description":"(Required) Unique identifier of a profile"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"type\": \"BY_UPDATED_BEFORE\",\n \"updated\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"f2e5cef6-46e3-46da-843c-14b306bf0848","name":"Tokens deleted","originalRequest":{"url":{"path":["push-devices","web-push","clean-up",":clientId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"4489","key":"clientId","description":"(Required) Unique identifier of a profile"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"POST","body":{"mode":"raw","raw":"{\n \"type\": \"BY_UPDATED_BEFORE\",\n \"updated\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"500f6045-d17b-45c8-a7b5-f71a82e7fd89","name":"See error message for details","originalRequest":{"url":{"path":["push-devices","web-push","clean-up",":clientId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"4489","key":"clientId","description":"(Required) Unique identifier of a profile"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"type\": \"BY_UPDATED_BEFORE\",\n \"updated\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"httpStatus\": 8816,\n \"errorCode\": \"string\",\n \"timestamp\": \"string\",\n \"message\": \"string\",\n \"traceId\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"03ed78e7-41d4-456d-aa13-0421baf6cda3","name":"Clean up mobile push tokens","request":{"name":"Clean up mobile push tokens","description":{"content":"Remove mobile push Firebase tokens from profile. You can use this endpoint to clean up tokens updated before a selected date. \n\nUsing this endpoint generates a `push.tokenDelete` event for each deleted token. \n\nIf no tokens are left after the clean-up, the `has_mobile_push_devices` attribute in the profile is set to false.\n\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `PUSH_DEVICES_SERVICE_MOBILE_PUSH_DEVICES_DELETE`\n\n**User role permission required:** `client_detail: delete`\n","type":"text/plain"},"url":{"path":["push-devices","mobile-push-subscriber","clean-up",":clientId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"4489","key":"clientId","description":"(Required) Unique identifier of a profile"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"type\": \"BY_UPDATED_BEFORE\",\n \"updated\": \"1957-01-28T23:51:43.138Z\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"03f2b949-16a3-4e4d-9e88-f4c16a1839f6","name":"Tokens deleted","originalRequest":{"url":{"path":["push-devices","mobile-push-subscriber","clean-up",":clientId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"4489","key":"clientId","description":"(Required) Unique identifier of a profile"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"POST","body":{"mode":"raw","raw":"{\n \"type\": \"BY_UPDATED_BEFORE\",\n \"updated\": \"1957-01-28T23:51:43.138Z\"\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"3994d709-cfb9-4f69-b950-0c8c0299d96f","name":"See error message for details","originalRequest":{"url":{"path":["push-devices","mobile-push-subscriber","clean-up",":clientId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"4489","key":"clientId","description":"(Required) Unique identifier of a profile"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"type\": \"BY_UPDATED_BEFORE\",\n \"updated\": \"1957-01-28T23:51:43.138Z\"\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"httpStatus\": 8816,\n \"errorCode\": \"string\",\n \"timestamp\": \"string\",\n \"message\": \"string\",\n \"traceId\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"20f47ee9-e416-4e3d-9aa2-b73784e17aa4","name":"Link a device by other parameters","request":{"name":"Link a device by other parameters","description":{"content":" Assign a device to a profile UUID. A profile may have many devices assigned. If request is made by PROFILE or ANONYMOUS_PROFILE uuid is taken from jwt token.\n\n---\n\n**API consumers:** Workspace (Business Profile), Profile (Client), Anonymous Profile\n\n**API key permission required:** `API_BY_IDENTIFY_DEVICE_CLIENT_UPDATE`\n\n**User role permission required:** `client_info: update`\n","type":"text/plain"},"url":{"path":["push-devices","clients","by-uuid",":identifierValue","linked-devices"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"by-uuid","key":"identifierType","description":"(Required) The profile identifier to use for the request"},{"disabled":false,"type":"any","value":"string","key":"identifierValue","description":"(Required) The value of the selected identifier"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"deviceId\": \"string\",\n \"type\": \"android\",\n \"registrationId\": \"string\",\n \"bluetoothAddress\": \"string\",\n \"macAddress\": \"string\",\n \"manufacturer\": \"string\",\n \"model\": \"string\",\n \"osVersion\": \"string\",\n \"product\": \"a51ul_htc_europe\",\n \"screenHeight\": 6880,\n \"screenWidth\": 1643,\n \"publicKey\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"fc1e6936-7026-45b4-9c5d-03da9be25d58","name":"Request accepted","originalRequest":{"url":{"path":["push-devices","clients","by-uuid",":identifierValue","linked-devices"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"by-uuid","key":"identifierType","description":"(Required) The profile identifier to use for the request"},{"disabled":false,"type":"any","value":"string","key":"identifierValue","description":"(Required) The value of the selected identifier"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"deviceId\": \"string\",\n \"type\": \"android\",\n \"registrationId\": \"string\",\n \"bluetoothAddress\": \"string\",\n \"macAddress\": \"string\",\n \"manufacturer\": \"string\",\n \"model\": \"string\",\n \"osVersion\": \"string\",\n \"product\": \"a51ul_htc_europe\",\n \"screenHeight\": 6880,\n \"screenWidth\": 1643,\n \"publicKey\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Accepted","code":202,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"f4e6ea83-e48a-4392-8ab6-c9ca8f1eba5d","name":"Bad request","originalRequest":{"url":{"path":["push-devices","clients","by-uuid",":identifierValue","linked-devices"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"by-uuid","key":"identifierType","description":"(Required) The profile identifier to use for the request"},{"disabled":false,"type":"any","value":"string","key":"identifierValue","description":"(Required) The value of the selected identifier"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Accept","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"deviceId\": \"string\",\n \"type\": \"android\",\n \"registrationId\": \"string\",\n \"bluetoothAddress\": \"string\",\n \"macAddress\": \"string\",\n \"manufacturer\": \"string\",\n \"model\": \"string\",\n \"osVersion\": \"string\",\n \"product\": \"a51ul_htc_europe\",\n \"screenHeight\": 6880,\n \"screenWidth\": 1643,\n \"publicKey\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"Bad Request\",\n \"status\": 400,\n \"timestamp\": \"2020-10-29T12:34:02.222Z\",\n \"path\": \"/clients/by-uuid/779465fc-a0c5-41e5-9be2-51c00b2588b4/linked-devices\",\n \"message\": \"Some fields did not pass validation\",\n \"errors\": [\n {\n \"code\": 12301,\n \"field\": \"deviceId\",\n \"message\": \"12301\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"d724c91f-2a07-4c9d-8fcb-32d52a5ed899","name":"Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc.","originalRequest":{"url":{"path":["push-devices","clients","by-uuid",":identifierValue","linked-devices"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"by-uuid","key":"identifierType","description":"(Required) The profile identifier to use for the request"},{"disabled":false,"type":"any","value":"string","key":"identifierValue","description":"(Required) The value of the selected identifier"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Accept","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"deviceId\": \"string\",\n \"type\": \"android\",\n \"registrationId\": \"string\",\n \"bluetoothAddress\": \"string\",\n \"macAddress\": \"string\",\n \"manufacturer\": \"string\",\n \"model\": \"string\",\n \"osVersion\": \"string\",\n \"product\": \"a51ul_htc_europe\",\n \"screenHeight\": 6880,\n \"screenWidth\": 1643,\n \"publicKey\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"Bad Request\",\n \"status\": 400,\n \"timestamp\": \"2020-10-29T13:08:16.235Z\",\n \"path\": \"/exampleEndpoint\",\n \"message\": \"Some fields did not pass validation\",\n \"errors\": [\n {\n \"code\": 120,\n \"field\": \"exampleField\",\n \"message\": \"120\",\n \"rejectedValue\": \"exampleValue\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"a8f5051a-52f7-4660-8e5a-c0bd13a80798","name":"Forbidden; insufficient permissions","originalRequest":{"url":{"path":["push-devices","clients","by-uuid",":identifierValue","linked-devices"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"by-uuid","key":"identifierType","description":"(Required) The profile identifier to use for the request"},{"disabled":false,"type":"any","value":"string","key":"identifierValue","description":"(Required) The value of the selected identifier"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Accept","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"deviceId\": \"string\",\n \"type\": \"android\",\n \"registrationId\": \"string\",\n \"bluetoothAddress\": \"string\",\n \"macAddress\": \"string\",\n \"manufacturer\": \"string\",\n \"model\": \"string\",\n \"osVersion\": \"string\",\n \"product\": \"a51ul_htc_europe\",\n \"screenHeight\": 6880,\n \"screenWidth\": 1643,\n \"publicKey\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"2018-06-07T07:29:27.489+00:00\",\n \"status\": 403,\n \"error\": \"Forbidden\",\n \"message\": \"Forbidden\",\n \"path\": \"/path_of_the_endpoint\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"01372fc7-88c1-4dbf-bc5d-ee1fa3db5a92","name":"Profile not found","originalRequest":{"url":{"path":["push-devices","clients","by-uuid",":identifierValue","linked-devices"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"by-uuid","key":"identifierType","description":"(Required) The profile identifier to use for the request"},{"disabled":false,"type":"any","value":"string","key":"identifierValue","description":"(Required) The value of the selected identifier"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"deviceId\": \"string\",\n \"type\": \"android\",\n \"registrationId\": \"string\",\n \"bluetoothAddress\": \"string\",\n \"macAddress\": \"string\",\n \"manufacturer\": \"string\",\n \"model\": \"string\",\n \"osVersion\": \"string\",\n \"product\": \"a51ul_htc_europe\",\n \"screenHeight\": 6880,\n \"screenWidth\": 1643,\n \"publicKey\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"5662be06-feb1-4a25-a993-fb78cdb5ada8","name":"Unsupported Media Type","originalRequest":{"url":{"path":["push-devices","clients","by-uuid",":identifierValue","linked-devices"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"by-uuid","key":"identifierType","description":"(Required) The profile identifier to use for the request"},{"disabled":false,"type":"any","value":"string","key":"identifierValue","description":"(Required) The value of the selected identifier"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Accept","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"deviceId\": \"string\",\n \"type\": \"android\",\n \"registrationId\": \"string\",\n \"bluetoothAddress\": \"string\",\n \"macAddress\": \"string\",\n \"manufacturer\": \"string\",\n \"model\": \"string\",\n \"osVersion\": \"string\",\n \"product\": \"a51ul_htc_europe\",\n \"screenHeight\": 6880,\n \"screenWidth\": 1643,\n \"publicKey\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Unsupported Media Type","code":415,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"2018-06-07T07:27:23.136+00:00\",\n \"status\": 415,\n \"error\": \"Unsupported Media Type\",\n \"message\": \"Content type 'application/xml' not supported\",\n \"path\": \"/path_of_the_endpoint\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"eddada1e-8c2b-470a-97d6-6ce38ad3adc7","name":"Link a device by other parameters","request":{"name":"Link a device by other parameters","description":{"content":" Assign a device to a profile UUID from JWT token. A profile may have many devices assigned.\n\n---\n\n**API consumers:** Profile (Client), Anonymous Profile\n\n**User role permission required:** `client_info: update`\n","type":"text/plain"},"url":{"path":["push-devices","clients","linked-devices"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"by-uuid","key":"identifierType","description":"(Required) The profile identifier to use for the request"},{"disabled":false,"type":"any","value":"string","key":"identifierValue","description":"(Required) The value of the selected identifier"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"deviceId\": \"string\",\n \"type\": \"android\",\n \"registrationId\": \"string\",\n \"bluetoothAddress\": \"string\",\n \"macAddress\": \"string\",\n \"manufacturer\": \"string\",\n \"model\": \"string\",\n \"osVersion\": \"string\",\n \"product\": \"a51ul_htc_europe\",\n \"screenHeight\": 6880,\n \"screenWidth\": 1643,\n \"publicKey\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"5468495f-5515-4af3-b646-7fcb9e6e6626","name":"Request accepted","originalRequest":{"url":{"path":["push-devices","clients","linked-devices"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"by-uuid","key":"identifierType","description":"(Required) The profile identifier to use for the request"},{"disabled":false,"type":"any","value":"string","key":"identifierValue","description":"(Required) The value of the selected identifier"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"deviceId\": \"string\",\n \"type\": \"android\",\n \"registrationId\": \"string\",\n \"bluetoothAddress\": \"string\",\n \"macAddress\": \"string\",\n \"manufacturer\": \"string\",\n \"model\": \"string\",\n \"osVersion\": \"string\",\n \"product\": \"a51ul_htc_europe\",\n \"screenHeight\": 6880,\n \"screenWidth\": 1643,\n \"publicKey\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Accepted","code":202,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"3e25ad65-430d-4622-8374-25de692e0b1c","name":"Bad request","originalRequest":{"url":{"path":["push-devices","clients","linked-devices"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"by-uuid","key":"identifierType","description":"(Required) The profile identifier to use for the request"},{"disabled":false,"type":"any","value":"string","key":"identifierValue","description":"(Required) The value of the selected identifier"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Accept","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"deviceId\": \"string\",\n \"type\": \"android\",\n \"registrationId\": \"string\",\n \"bluetoothAddress\": \"string\",\n \"macAddress\": \"string\",\n \"manufacturer\": \"string\",\n \"model\": \"string\",\n \"osVersion\": \"string\",\n \"product\": \"a51ul_htc_europe\",\n \"screenHeight\": 6880,\n \"screenWidth\": 1643,\n \"publicKey\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"Bad Request\",\n \"status\": 400,\n \"timestamp\": \"2020-10-29T12:34:02.222Z\",\n \"path\": \"/clients/linked-devices\",\n \"message\": \"Some fields did not pass validation\",\n \"errors\": [\n {\n \"code\": 12301,\n \"field\": \"deviceId\",\n \"message\": \"12301\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"f6fed734-1d04-47c6-aadb-bc61a67fdd5d","name":"Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc.","originalRequest":{"url":{"path":["push-devices","clients","linked-devices"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"by-uuid","key":"identifierType","description":"(Required) The profile identifier to use for the request"},{"disabled":false,"type":"any","value":"string","key":"identifierValue","description":"(Required) The value of the selected identifier"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Accept","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"deviceId\": \"string\",\n \"type\": \"android\",\n \"registrationId\": \"string\",\n \"bluetoothAddress\": \"string\",\n \"macAddress\": \"string\",\n \"manufacturer\": \"string\",\n \"model\": \"string\",\n \"osVersion\": \"string\",\n \"product\": \"a51ul_htc_europe\",\n \"screenHeight\": 6880,\n \"screenWidth\": 1643,\n \"publicKey\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"Bad Request\",\n \"status\": 400,\n \"timestamp\": \"2020-10-29T13:08:16.235Z\",\n \"path\": \"/exampleEndpoint\",\n \"message\": \"Some fields did not pass validation\",\n \"errors\": [\n {\n \"code\": 120,\n \"field\": \"exampleField\",\n \"message\": \"120\",\n \"rejectedValue\": \"exampleValue\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"baf2ef08-0911-401e-b16f-46646d5ad06d","name":"Forbidden; insufficient permissions","originalRequest":{"url":{"path":["push-devices","clients","linked-devices"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"by-uuid","key":"identifierType","description":"(Required) The profile identifier to use for the request"},{"disabled":false,"type":"any","value":"string","key":"identifierValue","description":"(Required) The value of the selected identifier"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Accept","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"deviceId\": \"string\",\n \"type\": \"android\",\n \"registrationId\": \"string\",\n \"bluetoothAddress\": \"string\",\n \"macAddress\": \"string\",\n \"manufacturer\": \"string\",\n \"model\": \"string\",\n \"osVersion\": \"string\",\n \"product\": \"a51ul_htc_europe\",\n \"screenHeight\": 6880,\n \"screenWidth\": 1643,\n \"publicKey\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"2018-06-07T07:29:27.489+00:00\",\n \"status\": 403,\n \"error\": \"Forbidden\",\n \"message\": \"Forbidden\",\n \"path\": \"/path_of_the_endpoint\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"5fd05baa-60ed-4b73-a019-d8438a70b11a","name":"Profile not found","originalRequest":{"url":{"path":["push-devices","clients","linked-devices"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"by-uuid","key":"identifierType","description":"(Required) The profile identifier to use for the request"},{"disabled":false,"type":"any","value":"string","key":"identifierValue","description":"(Required) The value of the selected identifier"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"deviceId\": \"string\",\n \"type\": \"android\",\n \"registrationId\": \"string\",\n \"bluetoothAddress\": \"string\",\n \"macAddress\": \"string\",\n \"manufacturer\": \"string\",\n \"model\": \"string\",\n \"osVersion\": \"string\",\n \"product\": \"a51ul_htc_europe\",\n \"screenHeight\": 6880,\n \"screenWidth\": 1643,\n \"publicKey\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"e0b28629-6913-4868-a186-48ecaea88427","name":"Unsupported Media Type","originalRequest":{"url":{"path":["push-devices","clients","linked-devices"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"by-uuid","key":"identifierType","description":"(Required) The profile identifier to use for the request"},{"disabled":false,"type":"any","value":"string","key":"identifierValue","description":"(Required) The value of the selected identifier"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Accept","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"deviceId\": \"string\",\n \"type\": \"android\",\n \"registrationId\": \"string\",\n \"bluetoothAddress\": \"string\",\n \"macAddress\": \"string\",\n \"manufacturer\": \"string\",\n \"model\": \"string\",\n \"osVersion\": \"string\",\n \"product\": \"a51ul_htc_europe\",\n \"screenHeight\": 6880,\n \"screenWidth\": 1643,\n \"publicKey\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Unsupported Media Type","code":415,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"2018-06-07T07:27:23.136+00:00\",\n \"status\": 415,\n \"error\": \"Unsupported Media Type\",\n \"message\": \"Content type 'application/xml' not supported\",\n \"path\": \"/path_of_the_endpoint\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}],"event":[]},{"id":"c584d022-dab4-43f3-9a7c-bba0981770d5","name":"Settings","description":{"content":"","type":"text/plain"},"item":[{"id":"d6bba635-6449-4ff6-b5ad-6468e2fab7c9","name":"Get universal list of organization workspaces","request":{"name":"Get universal list of organization workspaces","description":{"content":"Retrieve a list of worspaces in the organization in context of the current user.\n\n---\n\n**API consumer:** Synerise User\n","type":"text/plain"},"url":{"path":["business-profile-service","organizations","business-profiles"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"page","value":"1","description":"Page to retrieve"},{"disabled":false,"key":"limit","value":"20","description":"Limit of items per page"},{"disabled":false,"key":"businessProfileGroupId","value":"string","description":"Workspace group to filter by."},{"disabled":false,"key":"sortBy","value":"NAME:ASC"},{"disabled":false,"key":"search","value":"string"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":null},"response":[{"id":"a293cb07-22d1-4f22-95cc-3e00934a80ec","name":"OK","originalRequest":{"url":{"path":["business-profile-service","organizations","business-profiles"],"host":["{{baseUrl}}"],"query":[{"key":"page","value":"1"},{"key":"limit","value":"20"},{"key":"businessProfileGroupId","value":"string"},{"key":"sortBy","value":"NAME:ASC"},{"key":"search","value":"string"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"data\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"meta\": {\n \"count\": {\n \"value\": \"\"\n },\n \"limit\": {\n \"value\": \"\"\n },\n \"links\": {\n \"value\": \"\"\n }\n }\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"f3f19028-ca35-4b2c-9ffc-debaf13ad98e","name":"Get ban settings","request":{"name":"Get ban settings","description":{"content":"Retrieve the configuration of applying bans after a number of failed logins.\n\n---\n\n**API consumer:** Synerise User\n\n**User role permission required:** `settings_customers_iam_locking_policy: read`\n","type":"text/plain"},"url":{"path":["sauth","settings","ban"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"dbeb1c28-4cfc-4db6-944e-35f8beb247e9","name":"Current settings","originalRequest":{"url":{"path":["sauth","settings","ban"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"blockingForClientEnabled\": false,\n \"firstBanCollectingTime\": 6683,\n \"firstBanDuration\": 4732,\n \"firstBanThreshold\": 4809,\n \"secondBanCollectingTime\": 6151,\n \"secondBanDuration\": 5044,\n \"secondBanThreshold\": 6660,\n \"permanentBanCollectingTime\": 9199,\n \"permanentBanDuration\": 4534,\n \"permanentBanThreshold\": 1023\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"131c9de3-ebb3-4c47-8a05-a1aca1261f25","name":"JWT missing, expired, or invalid","originalRequest":{"url":{"path":["sauth","settings","ban"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\",\n \"message\": \"string\",\n \"errors\": [\n {\n \"code\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"rejectedValue\": {\n \"value\": \"\"\n }\n },\n {\n \"code\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"rejectedValue\": {\n \"value\": \"\"\n }\n }\n ],\n \"status\": 3232,\n \"timestamp\": \"string\",\n \"path\": \"string\",\n \"traceId\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"06428014-14dc-44a4-90b1-2e1932766196","name":"Insufficient permissions or wrong JWT scope (for example, profile token where a workspace token was required)","originalRequest":{"url":{"path":["sauth","settings","ban"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\",\n \"message\": \"string\",\n \"errors\": [\n {\n \"code\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"rejectedValue\": {\n \"value\": \"\"\n }\n },\n {\n \"code\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"rejectedValue\": {\n \"value\": \"\"\n }\n }\n ],\n \"status\": 8944,\n \"timestamp\": \"string\",\n \"path\": \"string\",\n \"traceId\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"b1cbc51d-0413-437e-829e-917c73b9c577","name":"Not Found","originalRequest":{"url":{"path":["sauth","settings","ban"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"GET","body":{}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"79bee14e-4794-4339-ab32-e5505b72365b","name":"Update ban settings","request":{"name":"Update ban settings","description":{"content":"Update the configuration of applying bans after a number of failed logins.\n\n---\n\n**API consumer:** Synerise User\n\n**User role permission required:** `settings_customers_iam_locking_policy: update`\n","type":"text/plain"},"url":{"path":["sauth","settings","ban"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"blockingForClientEnabled\": false,\n \"firstBanCollectingTime\": 6683,\n \"firstBanDuration\": 4732,\n \"firstBanThreshold\": 4809,\n \"secondBanCollectingTime\": 6151,\n \"secondBanDuration\": 5044,\n \"secondBanThreshold\": 6660,\n \"permanentBanCollectingTime\": 9199,\n \"permanentBanDuration\": 4534,\n \"permanentBanThreshold\": 1023\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"82d42d93-8eb6-4a19-b5f9-5f2343824b6d","name":"Current settings","originalRequest":{"url":{"path":["sauth","settings","ban"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"blockingForClientEnabled\": false,\n \"firstBanCollectingTime\": 6683,\n \"firstBanDuration\": 4732,\n \"firstBanThreshold\": 4809,\n \"secondBanCollectingTime\": 6151,\n \"secondBanDuration\": 5044,\n \"secondBanThreshold\": 6660,\n \"permanentBanCollectingTime\": 9199,\n \"permanentBanDuration\": 4534,\n \"permanentBanThreshold\": 1023\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"blockingForClientEnabled\": false,\n \"firstBanCollectingTime\": 6683,\n \"firstBanDuration\": 4732,\n \"firstBanThreshold\": 4809,\n \"secondBanCollectingTime\": 6151,\n \"secondBanDuration\": 5044,\n \"secondBanThreshold\": 6660,\n \"permanentBanCollectingTime\": 9199,\n \"permanentBanDuration\": 4534,\n \"permanentBanThreshold\": 1023\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"4a936d92-45f8-4b58-9cf1-02b41533f98b","name":"JWT missing, expired, or invalid","originalRequest":{"url":{"path":["sauth","settings","ban"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"blockingForClientEnabled\": false,\n \"firstBanCollectingTime\": 6683,\n \"firstBanDuration\": 4732,\n \"firstBanThreshold\": 4809,\n \"secondBanCollectingTime\": 6151,\n \"secondBanDuration\": 5044,\n \"secondBanThreshold\": 6660,\n \"permanentBanCollectingTime\": 9199,\n \"permanentBanDuration\": 4534,\n \"permanentBanThreshold\": 1023\n}","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\",\n \"message\": \"string\",\n \"errors\": [\n {\n \"code\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"rejectedValue\": {\n \"value\": \"\"\n }\n },\n {\n \"code\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"rejectedValue\": {\n \"value\": \"\"\n }\n }\n ],\n \"status\": 8944,\n \"timestamp\": \"string\",\n \"path\": \"string\",\n \"traceId\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"576b0df6-a279-44a2-968b-0e340a387c26","name":"Insufficient permissions or wrong JWT scope (for example, profile token where a workspace token was required)","originalRequest":{"url":{"path":["sauth","settings","ban"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"blockingForClientEnabled\": false,\n \"firstBanCollectingTime\": 6683,\n \"firstBanDuration\": 4732,\n \"firstBanThreshold\": 4809,\n \"secondBanCollectingTime\": 6151,\n \"secondBanDuration\": 5044,\n \"secondBanThreshold\": 6660,\n \"permanentBanCollectingTime\": 9199,\n \"permanentBanDuration\": 4534,\n \"permanentBanThreshold\": 1023\n}","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\",\n \"message\": \"string\",\n \"errors\": [\n {\n \"code\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"rejectedValue\": {\n \"value\": \"\"\n }\n },\n {\n \"code\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"rejectedValue\": {\n \"value\": \"\"\n }\n }\n ],\n \"status\": 8944,\n \"timestamp\": \"string\",\n \"path\": \"string\",\n \"traceId\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"cba70691-8048-4114-ac73-a34b76868e87","name":"Not Found","originalRequest":{"url":{"path":["sauth","settings","ban"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"POST","body":{"mode":"raw","raw":"{\n \"blockingForClientEnabled\": false,\n \"firstBanCollectingTime\": 6683,\n \"firstBanDuration\": 4732,\n \"firstBanThreshold\": 4809,\n \"secondBanCollectingTime\": 6151,\n \"secondBanDuration\": 5044,\n \"secondBanThreshold\": 6660,\n \"permanentBanCollectingTime\": 9199,\n \"permanentBanDuration\": 4534,\n \"permanentBanThreshold\": 1023\n}","options":{"raw":{"language":"json"}}}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"1e06cfc2-ef25-402d-8bb3-fd5b374d2f90","name":"Get email template settings","request":{"name":"Get email template settings","description":{"content":"Get settings for email templates.\n\n---\n\n**API consumer:** Synerise User\n\n**User role permission required:** `settings_customers_iam_account_confirmation: read`\n","type":"text/plain"},"url":{"path":["sauth","settings","templates"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"bfd12327-2d4e-4a92-b142-a2f22a575eff","name":"Current settings","originalRequest":{"url":{"path":["sauth","settings","templates"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"clientEmailChangeRequestMailSubject\": \"string\",\n \"clientEmailChangeRequestMailBody\": \"string\",\n \"clientEmailChangeRequestMailTemplateId\": \"string\",\n \"clientEmailChangeNotificationMailSubject\": \"string\",\n \"clientEmailChangeNotificationMailBody\": \"string\",\n \"clientEmailChangeNotificationMailTemplateId\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"c9c1b927-4fb5-47c4-aa7a-fa4ea9724f4e","name":"Unauthorized","originalRequest":{"url":{"path":["sauth","settings","templates"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"GET","body":{}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"bce17a55-ca8d-4edd-a4fd-bdeeaeda04a4","name":"Forbidden","originalRequest":{"url":{"path":["sauth","settings","templates"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"GET","body":{}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"c6bee097-c136-446a-bcb0-c6a648196e50","name":"Not Found","originalRequest":{"url":{"path":["sauth","settings","templates"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"GET","body":{}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"28ddb39c-7bc0-49d8-b1e7-1e69489f7a35","name":"Update email template settings","request":{"name":"Update email template settings","description":{"content":"Update email template settings. **Omitted settings are reset to null!**\n\n---\n\n**API consumer:** Synerise User\n\n**User role permission required:** `settings_customers_iam_account_confirmation: update`\n","type":"text/plain"},"url":{"path":["sauth","settings","templates"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"clientEmailChangeRequestMailSubject\": \"string\",\n \"clientEmailChangeRequestMailBody\": \"string\",\n \"clientEmailChangeRequestMailTemplateId\": \"string\",\n \"clientEmailChangeNotificationMailSubject\": \"string\",\n \"clientEmailChangeNotificationMailBody\": \"string\",\n \"clientEmailChangeNotificationMailTemplateId\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"6407448f-8357-4ce1-ae0f-2686b5933010","name":"Current settings","originalRequest":{"url":{"path":["sauth","settings","templates"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"clientEmailChangeRequestMailSubject\": \"string\",\n \"clientEmailChangeRequestMailBody\": \"string\",\n \"clientEmailChangeRequestMailTemplateId\": \"string\",\n \"clientEmailChangeNotificationMailSubject\": \"string\",\n \"clientEmailChangeNotificationMailBody\": \"string\",\n \"clientEmailChangeNotificationMailTemplateId\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"clientEmailChangeRequestMailSubject\": \"string\",\n \"clientEmailChangeRequestMailBody\": \"string\",\n \"clientEmailChangeRequestMailTemplateId\": \"string\",\n \"clientEmailChangeNotificationMailSubject\": \"string\",\n \"clientEmailChangeNotificationMailBody\": \"string\",\n \"clientEmailChangeNotificationMailTemplateId\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"347e30ee-3d25-4bbb-b571-bd7071c189f5","name":"Unauthorized","originalRequest":{"url":{"path":["sauth","settings","templates"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"POST","body":{"mode":"raw","raw":"{\n \"clientEmailChangeRequestMailSubject\": \"string\",\n \"clientEmailChangeRequestMailBody\": \"string\",\n \"clientEmailChangeRequestMailTemplateId\": \"string\",\n \"clientEmailChangeNotificationMailSubject\": \"string\",\n \"clientEmailChangeNotificationMailBody\": \"string\",\n \"clientEmailChangeNotificationMailTemplateId\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"983ca9b1-6100-49b0-b37d-0460866b2f48","name":"Forbidden","originalRequest":{"url":{"path":["sauth","settings","templates"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"POST","body":{"mode":"raw","raw":"{\n \"clientEmailChangeRequestMailSubject\": \"string\",\n \"clientEmailChangeRequestMailBody\": \"string\",\n \"clientEmailChangeRequestMailTemplateId\": \"string\",\n \"clientEmailChangeNotificationMailSubject\": \"string\",\n \"clientEmailChangeNotificationMailBody\": \"string\",\n \"clientEmailChangeNotificationMailTemplateId\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"1f04be00-369c-4ec3-8d02-da3dcc5d40ed","name":"Not Found","originalRequest":{"url":{"path":["sauth","settings","templates"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"POST","body":{"mode":"raw","raw":"{\n \"clientEmailChangeRequestMailSubject\": \"string\",\n \"clientEmailChangeRequestMailBody\": \"string\",\n \"clientEmailChangeRequestMailTemplateId\": \"string\",\n \"clientEmailChangeNotificationMailSubject\": \"string\",\n \"clientEmailChangeNotificationMailBody\": \"string\",\n \"clientEmailChangeNotificationMailTemplateId\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"3df58444-9a88-4e37-8f17-79f5ab15a718","name":"Get device authorization settings","request":{"name":"Get device authorization settings","description":{"content":"Retrieve the settings related to authorization of logins from unknown devices.\n\n---\n\n**API consumer:** Synerise User\n\n**User role permission required:** `settings_customers_iam_locking_policy: read`\n","type":"text/plain"},"url":{"path":["sauth","settings","device-control"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"709c7540-2546-432c-8730-4212059a2f4d","name":"Current settings","originalRequest":{"url":{"path":["sauth","settings","device-control"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"deviceControlMode\": \"OFF\",\n \"hardMailBody\": \"string\",\n \"hardMailTitle\": \"string\",\n \"hardTemplateId\": \"string\",\n \"softMailBody\": \"string\",\n \"softMailTitle\": \"string\",\n \"softTemplateId\": \"string\",\n \"deviceUnlockSuccessRedirectUrl\": \"string\",\n \"deviceUnlockAlreadyConfirmedRedirectUrl\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"b5f6e1e9-bf8e-4bff-a5d2-3e172e1ceb9e","name":"JWT missing, expired, or invalid","originalRequest":{"url":{"path":["sauth","settings","device-control"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\",\n \"message\": \"string\",\n \"errors\": [\n {\n \"code\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"rejectedValue\": {\n \"value\": \"\"\n }\n },\n {\n \"code\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"rejectedValue\": {\n \"value\": \"\"\n }\n }\n ],\n \"status\": 8944,\n \"timestamp\": \"string\",\n \"path\": \"string\",\n \"traceId\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"60b3bf1a-02df-435e-b86d-9d4a787596c4","name":"Insufficient permissions or wrong JWT scope (for example, profile token where a workspace token was required)","originalRequest":{"url":{"path":["sauth","settings","device-control"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\",\n \"message\": \"string\",\n \"errors\": [\n {\n \"code\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"rejectedValue\": {\n \"value\": \"\"\n }\n },\n {\n \"code\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"rejectedValue\": {\n \"value\": \"\"\n }\n }\n ],\n \"status\": 8944,\n \"timestamp\": \"string\",\n \"path\": \"string\",\n \"traceId\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"9798a627-6475-4a4b-8b03-dce076394cda","name":"Not Found","originalRequest":{"url":{"path":["sauth","settings","device-control"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"GET","body":{}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"6d923f99-4021-4074-8bba-e562a0ff33f1","name":"Update device authorization settings","request":{"name":"Update device authorization settings","description":{"content":"Update the settings related to authorization of logins from unknown devices.\n\n---\n\n**API consumer:** Synerise User\n\n**User role permission required:** `settings_customers_iam_locking_policy: update`\n","type":"text/plain"},"url":{"path":["sauth","settings","device-control"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"deviceControlMode\": \"OFF\",\n \"hardMailBody\": \"string\",\n \"hardMailTitle\": \"string\",\n \"hardTemplateId\": \"string\",\n \"softMailBody\": \"string\",\n \"softMailTitle\": \"string\",\n \"softTemplateId\": \"string\",\n \"deviceUnlockSuccessRedirectUrl\": \"string\",\n \"deviceUnlockAlreadyConfirmedRedirectUrl\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"e2e8fc16-1cef-42bf-8cc8-edbc32daf7c4","name":"Current settings","originalRequest":{"url":{"path":["sauth","settings","device-control"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"deviceControlMode\": \"OFF\",\n \"hardMailBody\": \"string\",\n \"hardMailTitle\": \"string\",\n \"hardTemplateId\": \"string\",\n \"softMailBody\": \"string\",\n \"softMailTitle\": \"string\",\n \"softTemplateId\": \"string\",\n \"deviceUnlockSuccessRedirectUrl\": \"string\",\n \"deviceUnlockAlreadyConfirmedRedirectUrl\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"deviceControlMode\": \"OFF\",\n \"hardMailBody\": \"string\",\n \"hardMailTitle\": \"string\",\n \"hardTemplateId\": \"string\",\n \"softMailBody\": \"string\",\n \"softMailTitle\": \"string\",\n \"softTemplateId\": \"string\",\n \"deviceUnlockSuccessRedirectUrl\": \"string\",\n \"deviceUnlockAlreadyConfirmedRedirectUrl\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"22a38a9d-1f4c-48ab-99bb-3857cd0394d8","name":"JWT missing, expired, or invalid","originalRequest":{"url":{"path":["sauth","settings","device-control"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"deviceControlMode\": \"OFF\",\n \"hardMailBody\": \"string\",\n \"hardMailTitle\": \"string\",\n \"hardTemplateId\": \"string\",\n \"softMailBody\": \"string\",\n \"softMailTitle\": \"string\",\n \"softTemplateId\": \"string\",\n \"deviceUnlockSuccessRedirectUrl\": \"string\",\n \"deviceUnlockAlreadyConfirmedRedirectUrl\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\",\n \"message\": \"string\",\n \"errors\": [\n {\n \"code\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"rejectedValue\": {\n \"value\": \"\"\n }\n },\n {\n \"code\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"rejectedValue\": {\n \"value\": \"\"\n }\n }\n ],\n \"status\": 8944,\n \"timestamp\": \"string\",\n \"path\": \"string\",\n \"traceId\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"88e425ce-dd87-43b8-ad42-929eff6c29a5","name":"Insufficient permissions or wrong JWT scope (for example, profile token where a workspace token was required)","originalRequest":{"url":{"path":["sauth","settings","device-control"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"deviceControlMode\": \"OFF\",\n \"hardMailBody\": \"string\",\n \"hardMailTitle\": \"string\",\n \"hardTemplateId\": \"string\",\n \"softMailBody\": \"string\",\n \"softMailTitle\": \"string\",\n \"softTemplateId\": \"string\",\n \"deviceUnlockSuccessRedirectUrl\": \"string\",\n \"deviceUnlockAlreadyConfirmedRedirectUrl\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\",\n \"message\": \"string\",\n \"errors\": [\n {\n \"code\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"rejectedValue\": {\n \"value\": \"\"\n }\n },\n {\n \"code\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"rejectedValue\": {\n \"value\": \"\"\n }\n }\n ],\n \"status\": 8944,\n \"timestamp\": \"string\",\n \"path\": \"string\",\n \"traceId\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"e60be2cb-64bf-4c7f-897b-0269260b2122","name":"Not Found","originalRequest":{"url":{"path":["sauth","settings","device-control"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"POST","body":{"mode":"raw","raw":"{\n \"deviceControlMode\": \"OFF\",\n \"hardMailBody\": \"string\",\n \"hardMailTitle\": \"string\",\n \"hardTemplateId\": \"string\",\n \"softMailBody\": \"string\",\n \"softMailTitle\": \"string\",\n \"softTemplateId\": \"string\",\n \"deviceUnlockSuccessRedirectUrl\": \"string\",\n \"deviceUnlockAlreadyConfirmedRedirectUrl\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"9997f957-24b8-4464-b821-6f232be21d4b","name":"Get general settings","request":{"name":"Get general settings","description":{"content":"Retrieve the general settings of the workspace.\n\n---\n\n**API consumer:** Synerise User\n\n**User role permission required:** `settings_customers_iam_account_confirmation: read`\n","type":"text/plain"},"url":{"path":["sauth","settings","general"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"cef44cd0-237d-48fb-91f3-330c9b8b688f","name":"Current settings","originalRequest":{"url":{"path":["sauth","settings","general"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"tokenLifetimeInSeconds\": 0,\n \"voucherPoolUuid\": null,\n \"allowOverwriteCustomIdentify\": false,\n \"allowOverwriteExternalId\": false,\n \"allowEmailChangeFromWebForm\": false,\n \"allowToPassCustomIdentifyWithVoucherPool\": false\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"f7262366-3229-4b6d-85e1-cffc095e60e5","name":"Unauthorized","originalRequest":{"url":{"path":["sauth","settings","general"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"GET","body":{}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"5d41186b-7278-4f1a-b409-56f2d70c0144","name":"Forbidden","originalRequest":{"url":{"path":["sauth","settings","general"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"GET","body":{}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"c25aff88-a962-45f7-ba59-54705a4d45be","name":"Not Found","originalRequest":{"url":{"path":["sauth","settings","general"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"GET","body":{}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"d5cf76c4-a632-4348-aea3-23722e49a668","name":"Update general settings","request":{"name":"Update general settings","description":{"content":"Update general settings. **Settings omitted in the request are reset to default!**.\n\n---\n\n**API consumer:** Synerise User\n\n**User role permission required:** `settings_customers_iam_account_confirmation: update`\n","type":"text/plain"},"url":{"path":["sauth","settings","general"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"tokenLifetimeInSeconds\": 0,\n \"voucherPoolUuid\": null,\n \"allowOverwriteCustomIdentify\": false,\n \"allowOverwriteExternalId\": false,\n \"allowEmailChangeFromWebForm\": false,\n \"allowToPassCustomIdentifyWithVoucherPool\": false\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"9be5c286-a894-4e76-b466-624dabfa7ab6","name":"New settings","originalRequest":{"url":{"path":["sauth","settings","general"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"tokenLifetimeInSeconds\": 0,\n \"voucherPoolUuid\": null,\n \"allowOverwriteCustomIdentify\": false,\n \"allowOverwriteExternalId\": false,\n \"allowEmailChangeFromWebForm\": false,\n \"allowToPassCustomIdentifyWithVoucherPool\": false\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"tokenLifetimeInSeconds\": 0,\n \"voucherPoolUuid\": null,\n \"allowOverwriteCustomIdentify\": false,\n \"allowOverwriteExternalId\": false,\n \"allowEmailChangeFromWebForm\": false,\n \"allowToPassCustomIdentifyWithVoucherPool\": false\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"eb700aac-09d4-4447-acd4-4eb3caf449bc","name":"Unauthorized","originalRequest":{"url":{"path":["sauth","settings","general"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"POST","body":{"mode":"raw","raw":"{\n \"tokenLifetimeInSeconds\": 0,\n \"voucherPoolUuid\": null,\n \"allowOverwriteCustomIdentify\": false,\n \"allowOverwriteExternalId\": false,\n \"allowEmailChangeFromWebForm\": false,\n \"allowToPassCustomIdentifyWithVoucherPool\": false\n}","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"28461a2b-7974-4478-8694-a619e1565688","name":"Forbidden","originalRequest":{"url":{"path":["sauth","settings","general"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"POST","body":{"mode":"raw","raw":"{\n \"tokenLifetimeInSeconds\": 0,\n \"voucherPoolUuid\": null,\n \"allowOverwriteCustomIdentify\": false,\n \"allowOverwriteExternalId\": false,\n \"allowEmailChangeFromWebForm\": false,\n \"allowToPassCustomIdentifyWithVoucherPool\": false\n}","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"550eda81-d3ef-4d63-b196-54ad6e20ce9d","name":"Not Found","originalRequest":{"url":{"path":["sauth","settings","general"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"POST","body":{"mode":"raw","raw":"{\n \"tokenLifetimeInSeconds\": 0,\n \"voucherPoolUuid\": null,\n \"allowOverwriteCustomIdentify\": false,\n \"allowOverwriteExternalId\": false,\n \"allowEmailChangeFromWebForm\": false,\n \"allowToPassCustomIdentifyWithVoucherPool\": false\n}","options":{"raw":{"language":"json"}}}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"1b16e1b4-0653-42a8-b222-0a2a969e15bf","name":"Get OAuth settings","request":{"name":"Get OAuth settings","description":{"content":"Retrieve OAuth authentication settings\n\n---\n\n**API consumer:** Synerise User\n\n**User role permission required:** `settings_customers_iam_oauth: read`\n","type":"text/plain"},"url":{"path":["sauth","settings","oauth"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"67fee5d6-7000-4052-9894-7cd742e735bf","name":"Current settings","originalRequest":{"url":{"path":["sauth","settings","oauth"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"enabled\": false,\n \"mode\": \"JWT_TOKEN\",\n \"endpoint\": \"string\",\n \"jwkEndpoint\": \"string\",\n \"headers\": {\n \"Content-Type\": \"application/json\",\n \"Authorization\": \"Bearer {{_snrs_access_token}}\",\n \"Cache-control\": \"no-cache\"\n },\n \"mapping\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n }\n },\n \"name\": \"string\",\n \"mappedExternal\": true,\n \"syncDataOnLogin\": false,\n \"validation\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n },\n \"key_2\": {\n \"value\": \"\"\n }\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"621c2403-ea23-4419-93b8-c518a9f2e074","name":"JWT missing, expired, or invalid","originalRequest":{"url":{"path":["sauth","settings","oauth"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\",\n \"message\": \"string\",\n \"errors\": [\n {\n \"code\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"rejectedValue\": {\n \"value\": \"\"\n }\n },\n {\n \"code\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"rejectedValue\": {\n \"value\": \"\"\n }\n }\n ],\n \"status\": 8944,\n \"timestamp\": \"string\",\n \"path\": \"string\",\n \"traceId\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"8968cad5-b08d-47ad-abcc-a0ed32e2802c","name":"Insufficient permissions or wrong JWT scope (for example, profile token where a workspace token was required)","originalRequest":{"url":{"path":["sauth","settings","oauth"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\",\n \"message\": \"string\",\n \"errors\": [\n {\n \"code\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"rejectedValue\": {\n \"value\": \"\"\n }\n },\n {\n \"code\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"rejectedValue\": {\n \"value\": \"\"\n }\n }\n ],\n \"status\": 8944,\n \"timestamp\": \"string\",\n \"path\": \"string\",\n \"traceId\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"499b00cb-23b1-4f58-8666-a8c6215206a5","name":"Not Found","originalRequest":{"url":{"path":["sauth","settings","oauth"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"GET","body":{}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"34178ed9-368b-43bf-80b9-b908a87d569e","name":"Update OAuth settings","request":{"name":"Update OAuth settings","description":{"content":"Update OAuth authentication settings\n\n---\n\n**API consumer:** Synerise User\n\n**User role permission required:** `settings_customers_iam_oauth: update`\n","type":"text/plain"},"url":{"path":["sauth","settings","oauth"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"enabled\": true,\n \"mode\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"endpoint\": {\n \"value\": \"\"\n },\n \"headers\": {\n \"value\": \"\"\n },\n \"mapping\": {\n \"value\": \"\"\n },\n \"mappedExternal\": {\n \"value\": \"\"\n },\n \"syncDataOnLogin\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"2a008335-7128-42e7-bb0c-3abb13a8a3ee","name":"Current settings","originalRequest":{"url":{"path":["sauth","settings","oauth"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"enabled\": true,\n \"mode\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"endpoint\": {\n \"value\": \"\"\n },\n \"headers\": {\n \"value\": \"\"\n },\n \"mapping\": {\n \"value\": \"\"\n },\n \"mappedExternal\": {\n \"value\": \"\"\n },\n \"syncDataOnLogin\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"enabled\": false,\n \"mode\": \"JWT_TOKEN\",\n \"endpoint\": \"string\",\n \"jwkEndpoint\": \"string\",\n \"headers\": {\n \"Content-Type\": \"application/json\",\n \"Authorization\": \"Bearer {{_snrs_access_token}}\",\n \"Cache-control\": \"no-cache\"\n },\n \"mapping\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n }\n },\n \"name\": \"string\",\n \"mappedExternal\": true,\n \"syncDataOnLogin\": false,\n \"validation\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n },\n \"key_2\": {\n \"value\": \"\"\n }\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"c7e738c7-1693-4172-a66d-2858d794e793","name":"JWT missing, expired, or invalid","originalRequest":{"url":{"path":["sauth","settings","oauth"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"enabled\": true,\n \"mode\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"endpoint\": {\n \"value\": \"\"\n },\n \"headers\": {\n \"value\": \"\"\n },\n \"mapping\": {\n \"value\": \"\"\n },\n \"mappedExternal\": {\n \"value\": \"\"\n },\n \"syncDataOnLogin\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\",\n \"message\": \"string\",\n \"errors\": [\n {\n \"code\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"rejectedValue\": {\n \"value\": \"\"\n }\n },\n {\n \"code\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"rejectedValue\": {\n \"value\": \"\"\n }\n }\n ],\n \"status\": 8944,\n \"timestamp\": \"string\",\n \"path\": \"string\",\n \"traceId\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"4dd2b46a-e04f-46ab-95ad-bd1b62f97458","name":"Insufficient permissions or wrong JWT scope (for example, profile token where a workspace token was required)","originalRequest":{"url":{"path":["sauth","settings","oauth"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"enabled\": true,\n \"mode\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"endpoint\": {\n \"value\": \"\"\n },\n \"headers\": {\n \"value\": \"\"\n },\n \"mapping\": {\n \"value\": \"\"\n },\n \"mappedExternal\": {\n \"value\": \"\"\n },\n \"syncDataOnLogin\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\",\n \"message\": \"string\",\n \"errors\": [\n {\n \"code\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"rejectedValue\": {\n \"value\": \"\"\n }\n },\n {\n \"code\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"rejectedValue\": {\n \"value\": \"\"\n }\n }\n ],\n \"status\": 8944,\n \"timestamp\": \"string\",\n \"path\": \"string\",\n \"traceId\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"fb95162f-e57a-47ff-a028-34c880367ffb","name":"Not Found","originalRequest":{"url":{"path":["sauth","settings","oauth"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"POST","body":{"mode":"raw","raw":"{\n \"enabled\": true,\n \"mode\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"endpoint\": {\n \"value\": \"\"\n },\n \"headers\": {\n \"value\": \"\"\n },\n \"mapping\": {\n \"value\": \"\"\n },\n \"mappedExternal\": {\n \"value\": \"\"\n },\n \"syncDataOnLogin\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"588b1ba7-62ec-4c8a-8fab-1d57c7cedfc2","name":"get Synerise Auth Config","request":{"name":"get Synerise Auth Config","description":{"content":"\n\n---\n\n**API consumer:** Synerise User\n\n**User role permission required:** `settings_customers_iam: read`\n","type":"text/plain"},"url":{"path":["sauth","settings","synerise-auth"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":null},"response":[{"id":"17cdfbd3-6093-4fa8-bfca-ed186946e7f6","name":"OK","originalRequest":{"url":{"path":["sauth","settings","synerise-auth"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"enabled\": true,\n \"registrationType\": \"AUTOMATIC\",\n \"pinConfirmationType\": \"ON_CONFLICT_WITH_EXTERNAL_ACCOUNT\",\n \"pinConfirmationLength\": 6,\n \"pinConfirmationValidInSeconds\": 300,\n \"allowPinResendFromDifferentDeviceId\": false,\n \"confirmationRedirectLink\": null,\n \"confirmationMailSubject\": \"string\",\n \"confirmationMailBody\": \"string\",\n \"confirmationMailTemplateId\": \"string\",\n \"passwordResetMailTemplateId\": \"string\",\n \"passwordResetMailSubject\": \"string\",\n \"passwordResetMailBody\": \"string\",\n \"pinConfirmationMailSubject\": \"string\",\n \"pinConfirmationMailBody\": \"string\",\n \"pinConfirmationMailTemplateId\": \"string\",\n \"maxLength\": 29,\n \"minLength\": 8667,\n \"requireAtLeastOneLowercaseLetter\": false,\n \"requireAtLeastOneNonAlphaNumericCharacter\": false,\n \"requireAtLeastOneNumber\": false,\n \"requireAtLeastOneUppercaseLetter\": false\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"f118f5d9-4397-4202-b382-380530778952","name":"update Synerise Auth Settings","request":{"name":"update Synerise Auth Settings","description":{"content":"\n\n---\n\n**API consumer:** Synerise User\n\n**User role permission required:** `settings_customers_iam: update`\n","type":"text/plain"},"url":{"path":["sauth","settings","synerise-auth"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":null,"body":{"mode":"raw","raw":"{\n \"enabled\": true,\n \"registrationType\": \"AUTOMATIC\",\n \"pinConfirmationType\": \"ON_CONFLICT_WITH_EXTERNAL_ACCOUNT\",\n \"pinConfirmationLength\": 6,\n \"pinConfirmationValidInSeconds\": 300,\n \"allowPinResendFromDifferentDeviceId\": false,\n \"confirmationRedirectLink\": null,\n \"confirmationMailSubject\": \"string\",\n \"confirmationMailBody\": \"string\",\n \"confirmationMailTemplateId\": \"string\",\n \"passwordResetMailTemplateId\": \"string\",\n \"passwordResetMailSubject\": \"string\",\n \"passwordResetMailBody\": \"string\",\n \"pinConfirmationMailSubject\": \"string\",\n \"pinConfirmationMailBody\": \"string\",\n \"pinConfirmationMailTemplateId\": \"string\",\n \"maxLength\": 29,\n \"minLength\": 8667,\n \"requireAtLeastOneLowercaseLetter\": false,\n \"requireAtLeastOneNonAlphaNumericCharacter\": false,\n \"requireAtLeastOneNumber\": false,\n \"requireAtLeastOneUppercaseLetter\": false\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"ed53ed9a-a779-4f8d-bab2-c08af7008eca","name":"OK","originalRequest":{"url":{"path":["sauth","settings","synerise-auth"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"enabled\": true,\n \"registrationType\": \"AUTOMATIC\",\n \"pinConfirmationType\": \"ON_CONFLICT_WITH_EXTERNAL_ACCOUNT\",\n \"pinConfirmationLength\": 6,\n \"pinConfirmationValidInSeconds\": 300,\n \"allowPinResendFromDifferentDeviceId\": false,\n \"confirmationRedirectLink\": null,\n \"confirmationMailSubject\": \"string\",\n \"confirmationMailBody\": \"string\",\n \"confirmationMailTemplateId\": \"string\",\n \"passwordResetMailTemplateId\": \"string\",\n \"passwordResetMailSubject\": \"string\",\n \"passwordResetMailBody\": \"string\",\n \"pinConfirmationMailSubject\": \"string\",\n \"pinConfirmationMailBody\": \"string\",\n \"pinConfirmationMailTemplateId\": \"string\",\n \"maxLength\": 29,\n \"minLength\": 8667,\n \"requireAtLeastOneLowercaseLetter\": false,\n \"requireAtLeastOneNonAlphaNumericCharacter\": false,\n \"requireAtLeastOneNumber\": false,\n \"requireAtLeastOneUppercaseLetter\": false\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"enabled\": true,\n \"registrationType\": \"AUTOMATIC\",\n \"pinConfirmationType\": \"ON_CONFLICT_WITH_EXTERNAL_ACCOUNT\",\n \"pinConfirmationLength\": 6,\n \"pinConfirmationValidInSeconds\": 300,\n \"allowPinResendFromDifferentDeviceId\": false,\n \"confirmationRedirectLink\": null,\n \"confirmationMailSubject\": \"string\",\n \"confirmationMailBody\": \"string\",\n \"confirmationMailTemplateId\": \"string\",\n \"passwordResetMailTemplateId\": \"string\",\n \"passwordResetMailSubject\": \"string\",\n \"passwordResetMailBody\": \"string\",\n \"pinConfirmationMailSubject\": \"string\",\n \"pinConfirmationMailBody\": \"string\",\n \"pinConfirmationMailTemplateId\": \"string\",\n \"maxLength\": 29,\n \"minLength\": 8667,\n \"requireAtLeastOneLowercaseLetter\": false,\n \"requireAtLeastOneNonAlphaNumericCharacter\": false,\n \"requireAtLeastOneNumber\": false,\n \"requireAtLeastOneUppercaseLetter\": false\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"76dd17a5-2180-4693-a377-c5bd06389c81","name":"get Facebook Oauth Settings","request":{"name":"get Facebook Oauth Settings","description":{"content":"\n\n---\n\n**API consumer:** Synerise User\n\n**User role permission required:** `settings_customers_iam_oauth: read`\n","type":"text/plain"},"url":{"path":["sauth","settings","oauth","facebook"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":null},"response":[{"id":"77d8ea0e-4857-4383-bf86-7417a7d09cbc","name":"OK","originalRequest":{"url":{"path":["sauth","settings","oauth","facebook"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"enabled\": true\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"1901e0ec-c9dd-444f-b2ff-e78c904ff9c4","name":"update Facebook Oauth Settings","request":{"name":"update Facebook Oauth Settings","description":{"content":"\n\n---\n\n**API consumer:** Synerise User\n\n**User role permission required:** `settings_customers_iam_oauth: update`\n","type":"text/plain"},"url":{"path":["sauth","settings","oauth","facebook"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"*/*"}],"method":"POST","auth":null,"body":{"mode":"raw","raw":"{\n \"enabled\": true\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"ffc91df8-22cb-40b8-8c6a-0ad571eeaa32","name":"OK","originalRequest":{"url":{"path":["sauth","settings","oauth","facebook"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"*/*"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"enabled\": true\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"*/*"}],"body":"{\n \"enabled\": true\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"f6b769c0-9b6b-4601-93d9-b0a8b41dc578","name":"get Google Oauth Settings","request":{"name":"get Google Oauth Settings","description":{"content":"\n\n---\n\n**API consumer:** Synerise User\n\n**User role permission required:** `settings_customers_iam_oauth: read`\n","type":"text/plain"},"url":{"path":["sauth","settings","oauth","google"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":null},"response":[{"id":"80748948-0625-46a9-beb5-1f79b8a7161d","name":"OK","originalRequest":{"url":{"path":["sauth","settings","oauth","google"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"enabled\": true\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"eed7bb78-6e52-46be-81db-7a4647733a74","name":"update Google Oauth Settings","request":{"name":"update Google Oauth Settings","description":{"content":"\n\n---\n\n**API consumer:** Synerise User\n\n**User role permission required:** `settings_customers_iam_oauth: update`\n","type":"text/plain"},"url":{"path":["sauth","settings","oauth","google"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"*/*"}],"method":"POST","auth":null,"body":{"mode":"raw","raw":"{\n \"enabled\": true\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"f7c3150f-1166-491d-9c4a-de5acc60ce7e","name":"OK","originalRequest":{"url":{"path":["sauth","settings","oauth","google"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"*/*"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"enabled\": true\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"*/*"}],"body":"{\n \"enabled\": true\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"cbb9ac15-00cf-4ef1-a34f-9f1e29b3862c","name":"Get Sign in with Apple settings","request":{"name":"Get Sign in with Apple settings","description":{"content":"Retrieve Sign in with Apple settings.\n\n---\n\n**API consumer:** Synerise User\n\n**User role permission required:** `settings_customers_iam_oauth: read`\n","type":"text/plain"},"url":{"path":["sauth","settings","oauth","apple"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"bc448dd6-47f3-4f71-b5e3-0f4129abea33","name":"Current settings","originalRequest":{"url":{"path":["sauth","settings","oauth","apple"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"enabled\": false,\n \"bundle\": \"com.synerise.sdk.sample-swift\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"5fc683bb-ecc4-4d7c-8175-0a4ad4c1bf2e","name":"JWT missing, expired, or invalid","originalRequest":{"url":{"path":["sauth","settings","oauth","apple"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\",\n \"message\": \"string\",\n \"errors\": [\n {\n \"code\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"rejectedValue\": {\n \"value\": \"\"\n }\n },\n {\n \"code\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"rejectedValue\": {\n \"value\": \"\"\n }\n }\n ],\n \"status\": 8944,\n \"timestamp\": \"string\",\n \"path\": \"string\",\n \"traceId\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"8d92331c-42a4-4601-b445-763ac6bdd5b4","name":"Insufficient permissions or wrong JWT scope (for example, profile token where a workspace token was required)","originalRequest":{"url":{"path":["sauth","settings","oauth","apple"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\",\n \"message\": \"string\",\n \"errors\": [\n {\n \"code\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"rejectedValue\": {\n \"value\": \"\"\n }\n },\n {\n \"code\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"rejectedValue\": {\n \"value\": \"\"\n }\n }\n ],\n \"status\": 8944,\n \"timestamp\": \"string\",\n \"path\": \"string\",\n \"traceId\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"16cf6054-f7b1-47b7-b30e-1075e5688650","name":"Not Found","originalRequest":{"url":{"path":["sauth","settings","oauth","apple"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"GET","body":{}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"59be6bc0-331a-4897-8397-24f5711ee4a4","name":"Update Sign in with Apple settings","request":{"name":"Update Sign in with Apple settings","description":{"content":"Update Sign in with Apple settings.\n\n---\n\n**API consumer:** Synerise User\n\n**User role permission required:** `settings_customers_iam_oauth: update`\n","type":"text/plain"},"url":{"path":["sauth","settings","oauth","apple"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"enabled\": false,\n \"bundle\": \"com.synerise.sdk.sample-swift\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"80ba68b8-7026-4577-b1b9-1bf4ab8794d4","name":"Current settings","originalRequest":{"url":{"path":["sauth","settings","oauth","apple"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"enabled\": false,\n \"bundle\": \"com.synerise.sdk.sample-swift\"\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"enabled\": false,\n \"bundle\": \"com.synerise.sdk.sample-swift\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"b79ab855-793e-452c-b6d6-9d0365140235","name":"JWT missing, expired, or invalid","originalRequest":{"url":{"path":["sauth","settings","oauth","apple"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"enabled\": false,\n \"bundle\": \"com.synerise.sdk.sample-swift\"\n}","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\",\n \"message\": \"string\",\n \"errors\": [\n {\n \"code\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"rejectedValue\": {\n \"value\": \"\"\n }\n },\n {\n \"code\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"rejectedValue\": {\n \"value\": \"\"\n }\n }\n ],\n \"status\": 8944,\n \"timestamp\": \"string\",\n \"path\": \"string\",\n \"traceId\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"71b92f81-4c6f-40a8-860a-7149911ad1b0","name":"Insufficient permissions or wrong JWT scope (for example, profile token where a workspace token was required)","originalRequest":{"url":{"path":["sauth","settings","oauth","apple"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"enabled\": false,\n \"bundle\": \"com.synerise.sdk.sample-swift\"\n}","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\",\n \"message\": \"string\",\n \"errors\": [\n {\n \"code\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"rejectedValue\": {\n \"value\": \"\"\n }\n },\n {\n \"code\": {\n \"value\": \"\"\n },\n \"field\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"rejectedValue\": {\n \"value\": \"\"\n }\n }\n ],\n \"status\": 8944,\n \"timestamp\": \"string\",\n \"path\": \"string\",\n \"traceId\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"c5b7aad6-67e2-4c57-944c-bb650a988c49","name":"Not Found","originalRequest":{"url":{"path":["sauth","settings","oauth","apple"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"POST","body":{"mode":"raw","raw":"{\n \"enabled\": false,\n \"bundle\": \"com.synerise.sdk.sample-swift\"\n}","options":{"raw":{"language":"json"}}}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"c2fb9f71-babd-48db-b9de-9f33bf5d6264","name":"Add or remove business profile to favorites","request":{"name":"Add or remove business profile to favorites","description":{"content":"Business profile can be added or removed from favorites using this endpoint\n\n---\n\n**API consumer:** Synerise User\n","type":"text/plain"},"url":{"path":["uauth","business-profile","mark-favorite"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"businessProfileGuid\": \"string\",\n \"favorite\": true\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"f4466955-2020-4d8c-af46-312c176b83cd","name":"OK","originalRequest":{"url":{"path":["uauth","business-profile","mark-favorite"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"POST","body":{"mode":"raw","raw":"{\n \"businessProfileGuid\": \"string\",\n \"favorite\": true\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"b5df5886-974c-41f2-81f7-54d30997fd70","name":"Bad Request","originalRequest":{"url":{"path":["uauth","business-profile","mark-favorite"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"POST","body":{"mode":"raw","raw":"{\n \"businessProfileGuid\": \"string\",\n \"favorite\": true\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"14184578-b591-486f-83ed-0091fb36ae66","name":"Unauthorized","originalRequest":{"url":{"path":["uauth","business-profile","mark-favorite"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"POST","body":{"mode":"raw","raw":"{\n \"businessProfileGuid\": \"string\",\n \"favorite\": true\n}","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"0c278057-a0cb-4dab-82e4-5b198f7d5deb","name":"Forbidden","originalRequest":{"url":{"path":["uauth","business-profile","mark-favorite"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"POST","body":{"mode":"raw","raw":"{\n \"businessProfileGuid\": \"string\",\n \"favorite\": true\n}","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"d4617878-d6ce-4587-b387-25937448829a","name":"Not Found","originalRequest":{"url":{"path":["uauth","business-profile","mark-favorite"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"POST","body":{"mode":"raw","raw":"{\n \"businessProfileGuid\": \"string\",\n \"favorite\": true\n}","options":{"raw":{"language":"json"}}}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}],"event":[]},{"id":"72311320-8eea-4219-bb94-b9574bcf4e0e","name":"Access control","description":{"content":"","type":"text/plain"},"item":[{"id":"36b86254-9621-409d-a31f-be7be4a98d0b","name":"Enable MFA requirement for workspace","request":{"name":"Enable MFA requirement for workspace","description":{"content":"This request enables multi-factor authentication requirement for the currently selected workspace. After enabling this setting, only users with MFA can access the workspace.\n\n---\n\n**API consumer:** Synerise User\n","type":"text/plain"},"url":{"path":["uauth","business-profile","mfa","requirements"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"39e94520-1c6f-48a2-8815-8c52d2cd6fa1","name":"OK","originalRequest":{"url":{"path":["uauth","business-profile","mfa","requirements"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"POST","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"e1865118-3349-413a-87b7-43020f68be2d","name":"Unauthorized","originalRequest":{"url":{"path":["uauth","business-profile","mfa","requirements"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"POST","body":{}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"b1b2b89d-b0ea-46f9-a010-17ea3aac8ed2","name":"Forbidden","originalRequest":{"url":{"path":["uauth","business-profile","mfa","requirements"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"POST","body":{}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"3c341ff2-b4d5-46e5-b660-2944bfe87d55","name":"Not Found","originalRequest":{"url":{"path":["uauth","business-profile","mfa","requirements"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"POST","body":{}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"f2c76d89-39a0-4f49-891d-5d1820ccacf0","name":"Disable MFA requirement for workspace","request":{"name":"Disable MFA requirement for workspace","description":{"content":"This request disables multi-factor authentication requirement for the currently selected workspace. After disabling this setting, users without MFA can access the workspace.\n\n---\n\n**API consumer:** Synerise User\n","type":"text/plain"},"url":{"path":["uauth","business-profile","mfa","requirements"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"method":"DELETE","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"2cfe3f2f-4110-4819-867c-2e675d1f6ac6","name":"OK","originalRequest":{"url":{"path":["uauth","business-profile","mfa","requirements"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"DELETE","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"f2040e97-b3f8-4b15-8169-9e90a27226ca","name":"Unauthorized","originalRequest":{"url":{"path":["uauth","business-profile","mfa","requirements"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"DELETE","body":{}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"fe5a29bd-0d75-4042-a6cb-a026a8f7a0ea","name":"Forbidden","originalRequest":{"url":{"path":["uauth","business-profile","mfa","requirements"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"DELETE","body":{}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"92fcc2f5-62a7-4db4-b4af-e8c78dd637b5","name":"Not Found","originalRequest":{"url":{"path":["uauth","business-profile","mfa","requirements"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"DELETE","body":{}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"e24077a2-440c-4302-ba40-60d3ef4c4fe7","name":"Get own strongest password policy","request":{"name":"Get own strongest password policy","description":{"content":"If a user has access to more than one workspace, you can use this endpoint to find the strictest password policy of all the policies in these workspaces. The user's password must meet the requirements of that strictest policy.\n\n---\n\n**API consumer:** Synerise User\n","type":"text/plain"},"url":{"path":["uauth","users","my-account","strongest-password-settings"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"*/*"}],"method":"GET","auth":null},"response":[{"id":"33f01f9a-ebfe-4b17-a782-957729ac4346","name":"OK","originalRequest":{"url":{"path":["uauth","users","my-account","strongest-password-settings"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"*/*"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"*/*"}],"body":"{\n \"attempts\": 8553,\n \"block\": 2044,\n \"businessProfileId\": 4961,\n \"different\": 4207,\n \"digits\": 2806,\n \"expiration\": 7030,\n \"lowerLetters\": 4950,\n \"maxIdleTime\": 4307,\n \"maxLength\": 7802,\n \"minLength\": 3717,\n \"nextChange\": 7027,\n \"specialChars\": 4076,\n \"upperLetters\": 9784\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"5b2cd8cb-fa22-40e7-8080-42cad00e845d","name":"Get IP allowlist policy","request":{"name":"Get IP allowlist policy","description":{"content":"Retrieve the details of IP allowlisting policy of the workspace.\n\n---\n\n**API consumer:** Synerise User\n\n**User role permission required:** `settings_users_am_ip_access_restriction: read`\n","type":"text/plain"},"url":{"path":["uauth","settings","user-bp-ip-policy"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"1f9d74a5-92ac-4e49-9924-ee5ed701c1e4","name":"IP policy details","originalRequest":{"url":{"path":["uauth","settings","user-bp-ip-policy"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"enabled\": true,\n \"enableSupportSubnets\": true,\n \"ipPolicy\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"c45b1245-d99e-4e2e-a951-ea089b0872dc","name":"Unauthorized","originalRequest":{"url":{"path":["uauth","settings","user-bp-ip-policy"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"GET","body":{}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"36b86c14-0624-4730-b3ec-3548d7f1390c","name":"Forbidden","originalRequest":{"url":{"path":["uauth","settings","user-bp-ip-policy"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"GET","body":{}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"0f16285f-b7ed-4276-ab53-3e09cb5da7d6","name":"Not Found","originalRequest":{"url":{"path":["uauth","settings","user-bp-ip-policy"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"GET","body":{}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"ebc6fbfd-f0f4-4ed5-a800-88b944b26ca7","name":"Update IP allowlist policy","request":{"name":"Update IP allowlist policy","description":{"content":"Update the details of IP allowlisting policy of the workspace.\n\n---\n\n**API consumer:** Synerise User\n\n**User role permission required:** `settings_users_am_ip_access_restriction: update`\n","type":"text/plain"},"url":{"path":["uauth","settings","user-bp-ip-policy"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"enabled\": false,\n \"enableSupportSubnets\": true,\n \"ipPolicy\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"556742b2-2eee-420b-b3b4-5a330a59bf96","name":"Updated IP policy","originalRequest":{"url":{"path":["uauth","settings","user-bp-ip-policy"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"enabled\": false,\n \"enableSupportSubnets\": true,\n \"ipPolicy\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"enabled\": false,\n \"enableSupportSubnets\": true,\n \"ipPolicy\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"f93c3401-1c80-4c0e-9d68-2c70c327290f","name":"Unauthorized","originalRequest":{"url":{"path":["uauth","settings","user-bp-ip-policy"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"POST","body":{"mode":"raw","raw":"{\n \"enabled\": false,\n \"enableSupportSubnets\": true,\n \"ipPolicy\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"635a98b9-4868-4075-9a0c-4cf687b2cd33","name":"Forbidden","originalRequest":{"url":{"path":["uauth","settings","user-bp-ip-policy"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"POST","body":{"mode":"raw","raw":"{\n \"enabled\": false,\n \"enableSupportSubnets\": true,\n \"ipPolicy\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"2583ec0d-408d-4b93-a111-b6c8f9792425","name":"Not Found","originalRequest":{"url":{"path":["uauth","settings","user-bp-ip-policy"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"POST","body":{"mode":"raw","raw":"{\n \"enabled\": false,\n \"enableSupportSubnets\": true,\n \"ipPolicy\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"c173ee40-94e8-417e-aa38-7548c1b18bee","name":"Get strongest password policy of a User","request":{"name":"Get strongest password policy of a User","description":{"content":"If a user has access to more than one workspace, you can use this endpoint to find the strictest password policy of all the policies in these workspaces. The user's password must meet the requirements of that strictest policy.\n\n---\n\n**Authentication:** Not required\n","type":"text/plain"},"url":{"path":["uauth","strongest-password-settings-by-email",":email"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"email","description":"(Required) User's email address"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"75fa7f06-725e-49dd-8c58-4b8aeb4feaf9","name":"OK","originalRequest":{"url":{"path":["uauth","strongest-password-settings-by-email",":email"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"email","description":"(Required) User's email address"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"attempts\": 8553,\n \"block\": 2044,\n \"businessProfileId\": 4961,\n \"different\": 4207,\n \"digits\": 2806,\n \"expiration\": 7030,\n \"lowerLetters\": 4950,\n \"maxIdleTime\": 4307,\n \"maxLength\": 7802,\n \"minLength\": 3717,\n \"nextChange\": 7027,\n \"specialChars\": 4076,\n \"upperLetters\": 9784\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"3551abf3-ab39-4e92-b1c6-977454b396df","name":"Unauthorized","originalRequest":{"url":{"path":["uauth","strongest-password-settings-by-email",":email"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"email","description":"(Required) User's email address"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"GET","body":{}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"98948e5f-f45b-4941-b9c4-798e68f18542","name":"Forbidden","originalRequest":{"url":{"path":["uauth","strongest-password-settings-by-email",":email"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"email","description":"(Required) User's email address"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"GET","body":{}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"6fe85838-e098-4166-b5cb-ee65096a5c1a","name":"Not Found","originalRequest":{"url":{"path":["uauth","strongest-password-settings-by-email",":email"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"email","description":"(Required) User's email address"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"GET","body":{}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"e90d63b6-6fe2-42fb-9c12-574f3ddcd9dc","name":"Initiate multi-factor authentication for user","request":{"name":"Initiate multi-factor authentication for user","description":{"content":"Begins the process of enabling multi-factor authentication for a user by initiating it.\n\n---\n\n**API consumer:** Synerise User\n","type":"text/plain"},"url":{"path":["uauth","users","mfa","initialization"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"mfaType","value":"TOTP_AUTHENTICATOR","description":"(Required) Type of multi-factor authentication"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"eb29da4b-a5ee-4333-9601-c04f32f7d871","name":"Secret and QR code URL","originalRequest":{"url":{"path":["uauth","users","mfa","initialization"],"host":["{{baseUrl}}"],"query":[{"key":"mfaType","value":"TOTP_AUTHENTICATOR"}],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"url\": \"string\",\n \"secret\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"0fcb12c0-a2e8-48e7-9287-fea5218bec22","name":"Unauthorized","originalRequest":{"url":{"path":["uauth","users","mfa","initialization"],"host":["{{baseUrl}}"],"query":[{"key":"mfaType","value":"TOTP_AUTHENTICATOR"}],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"POST","body":{}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"5898742c-b509-4275-9e0e-3463aa063451","name":"Forbidden","originalRequest":{"url":{"path":["uauth","users","mfa","initialization"],"host":["{{baseUrl}}"],"query":[{"key":"mfaType","value":"TOTP_AUTHENTICATOR"}],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"POST","body":{}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"354e1c76-a661-4f7e-ba71-c55bd4b20875","name":"Not Found","originalRequest":{"url":{"path":["uauth","users","mfa","initialization"],"host":["{{baseUrl}}"],"query":[{"key":"mfaType","value":"TOTP_AUTHENTICATOR"}],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"POST","body":{}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"00c8c828-f586-42ff-a298-5358743d28da","name":"Confirm multi-factor authentication for user","request":{"name":"Confirm multi-factor authentication for user","description":{"content":"Continues the process of enabling multi-factor authentication for a user by confirming it.\n\n---\n\n**API consumer:** Synerise User\n","type":"text/plain"},"url":{"path":["uauth","users","mfa","confirmation"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"mfaType","value":"TOTP_AUTHENTICATOR","description":"(Required) Type of multi-factor authentication"}],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"verificationCode\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"b0f560e3-d7d8-4717-b013-0fae5c5c2888","name":"User's backup code","originalRequest":{"url":{"path":["uauth","users","mfa","confirmation"],"host":["{{baseUrl}}"],"query":[{"key":"mfaType","value":"TOTP_AUTHENTICATOR"}],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"verificationCode\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"backupCode\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"2053ca5d-3943-4b83-b50a-3d61333cbd72","name":"Unauthorized","originalRequest":{"url":{"path":["uauth","users","mfa","confirmation"],"host":["{{baseUrl}}"],"query":[{"key":"mfaType","value":"TOTP_AUTHENTICATOR"}],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"POST","body":{"mode":"raw","raw":"{\n \"verificationCode\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"9a44dc9e-f94e-47b8-8fbd-6fd62bcde249","name":"Forbidden","originalRequest":{"url":{"path":["uauth","users","mfa","confirmation"],"host":["{{baseUrl}}"],"query":[{"key":"mfaType","value":"TOTP_AUTHENTICATOR"}],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"POST","body":{"mode":"raw","raw":"{\n \"verificationCode\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"a8947d7c-3a48-4689-9fbb-d7c431abd20f","name":"Not Found","originalRequest":{"url":{"path":["uauth","users","mfa","confirmation"],"host":["{{baseUrl}}"],"query":[{"key":"mfaType","value":"TOTP_AUTHENTICATOR"}],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"POST","body":{"mode":"raw","raw":"{\n \"verificationCode\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"70c5e414-9ea2-43b4-a8d9-31c1b263851e","name":"Remove multi-factor authentication for user","request":{"name":"Remove multi-factor authentication for user","description":{"content":"Removes user multi-factor authentication.\n\n---\n\n**API consumer:** Synerise User\n","type":"text/plain"},"url":{"path":["uauth","users","mfa"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"mfaType","value":"TOTP_AUTHENTICATOR","description":"(Required) Type of multi-factor authentication"},{"disabled":false,"key":"backupCode","value":"string","description":"(Required) User's backup code"}],"variable":[]},"method":"DELETE","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"01fd1250-fd16-49a2-9281-3ccf74fc2938","name":"No Content","originalRequest":{"url":{"path":["uauth","users","mfa"],"host":["{{baseUrl}}"],"query":[{"key":"mfaType","value":"TOTP_AUTHENTICATOR"},{"key":"backupCode","value":"string"}],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"DELETE","body":{}},"status":"No Content","code":204,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"fb1be5ef-eee7-4fd5-b9b9-3db3df447895","name":"Unauthorized","originalRequest":{"url":{"path":["uauth","users","mfa"],"host":["{{baseUrl}}"],"query":[{"key":"mfaType","value":"TOTP_AUTHENTICATOR"},{"key":"backupCode","value":"string"}],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"DELETE","body":{}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"c08f5ea5-64a8-45ac-ab00-32bf6b97730c","name":"Forbidden","originalRequest":{"url":{"path":["uauth","users","mfa"],"host":["{{baseUrl}}"],"query":[{"key":"mfaType","value":"TOTP_AUTHENTICATOR"},{"key":"backupCode","value":"string"}],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"DELETE","body":{}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"99aeb74d-4eb2-42b7-91ae-0a8258731d06","name":"Not Found","originalRequest":{"url":{"path":["uauth","users","mfa"],"host":["{{baseUrl}}"],"query":[{"key":"mfaType","value":"TOTP_AUTHENTICATOR"},{"key":"backupCode","value":"string"}],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"DELETE","body":{}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"f85eb35f-b601-4717-b524-ea0237e3d33e","name":"Get user password policy","request":{"name":"Get user password policy","description":{"content":"Retrieve the user password policy of the workspace.\n\n---\n\n**API consumer:** Synerise User\n\n**User role permission required:** `settings_users_am_password_policy: read`\n","type":"text/plain"},"url":{"path":["uauth","settings","password-policy"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"b50ed2e8-4de4-4611-9dd2-f52b9575dad8","name":"OK","originalRequest":{"url":{"path":["uauth","settings","password-policy"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"attempts\": 4506,\n \"block\": 9390,\n \"different\": 9438,\n \"digits\": 5826,\n \"expiration\": 1874,\n \"lowerLetters\": 5446,\n \"maxIdleTime\": 6109,\n \"maxLength\": 8424,\n \"minLength\": 705,\n \"nextChange\": 8706,\n \"specialChars\": 9838,\n \"upperLetters\": 7503\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"46bf67b6-aea2-4c35-8623-07134276e76f","name":"Unauthorized","originalRequest":{"url":{"path":["uauth","settings","password-policy"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"GET","body":{}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"9aaec969-5ec2-4acd-9cc2-a28153799cbc","name":"Forbidden","originalRequest":{"url":{"path":["uauth","settings","password-policy"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"GET","body":{}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"4fcd571c-5baf-4636-b26f-435735b72091","name":"Not Found","originalRequest":{"url":{"path":["uauth","settings","password-policy"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"GET","body":{}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"2e83009a-d63f-4a5b-85f6-3c7f9391ce02","name":"Update user password policy","request":{"name":"Update user password policy","description":{"content":"Update the user password policy. Entering `0` as the value disables a requirement.\n\n---\n\n**API consumer:** Synerise User\n\n**User role permission required:** `settings_users_am_password_policy: update`\n","type":"text/plain"},"url":{"path":["uauth","settings","password-policy"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"attempts\": 4506,\n \"block\": 9390,\n \"different\": 9438,\n \"digits\": 5826,\n \"expiration\": 1874,\n \"lowerLetters\": 5446,\n \"maxIdleTime\": 6109,\n \"maxLength\": 8424,\n \"minLength\": 705,\n \"nextChange\": 8706,\n \"specialChars\": 9838,\n \"upperLetters\": 7503\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"989123ba-5a88-4b62-bea3-cc66658f0ce6","name":"New password policy","originalRequest":{"url":{"path":["uauth","settings","password-policy"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"attempts\": 4506,\n \"block\": 9390,\n \"different\": 9438,\n \"digits\": 5826,\n \"expiration\": 1874,\n \"lowerLetters\": 5446,\n \"maxIdleTime\": 6109,\n \"maxLength\": 8424,\n \"minLength\": 705,\n \"nextChange\": 8706,\n \"specialChars\": 9838,\n \"upperLetters\": 7503\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"attempts\": 4506,\n \"block\": 9390,\n \"different\": 9438,\n \"digits\": 5826,\n \"expiration\": 1874,\n \"lowerLetters\": 5446,\n \"maxIdleTime\": 6109,\n \"maxLength\": 8424,\n \"minLength\": 705,\n \"nextChange\": 8706,\n \"specialChars\": 9838,\n \"upperLetters\": 7503\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"4cf75adf-8bca-46ea-9986-4fe80d961cf1","name":"Unauthorized","originalRequest":{"url":{"path":["uauth","settings","password-policy"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"POST","body":{"mode":"raw","raw":"{\n \"attempts\": 4506,\n \"block\": 9390,\n \"different\": 9438,\n \"digits\": 5826,\n \"expiration\": 1874,\n \"lowerLetters\": 5446,\n \"maxIdleTime\": 6109,\n \"maxLength\": 8424,\n \"minLength\": 705,\n \"nextChange\": 8706,\n \"specialChars\": 9838,\n \"upperLetters\": 7503\n}","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"cb573f1a-aa1c-401e-8e2c-bfb07c65a967","name":"Forbidden","originalRequest":{"url":{"path":["uauth","settings","password-policy"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"POST","body":{"mode":"raw","raw":"{\n \"attempts\": 4506,\n \"block\": 9390,\n \"different\": 9438,\n \"digits\": 5826,\n \"expiration\": 1874,\n \"lowerLetters\": 5446,\n \"maxIdleTime\": 6109,\n \"maxLength\": 8424,\n \"minLength\": 705,\n \"nextChange\": 8706,\n \"specialChars\": 9838,\n \"upperLetters\": 7503\n}","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"86b21b2a-4dd2-445c-9d0a-724038c7b3fb","name":"Not Found","originalRequest":{"url":{"path":["uauth","settings","password-policy"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"POST","body":{"mode":"raw","raw":"{\n \"attempts\": 4506,\n \"block\": 9390,\n \"different\": 9438,\n \"digits\": 5826,\n \"expiration\": 1874,\n \"lowerLetters\": 5446,\n \"maxIdleTime\": 6109,\n \"maxLength\": 8424,\n \"minLength\": 705,\n \"nextChange\": 8706,\n \"specialChars\": 9838,\n \"upperLetters\": 7503\n}","options":{"raw":{"language":"json"}}}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}],"event":[]},{"id":"9987f764-1fa3-49be-8981-e5c6851fa921","name":"User management","description":{"content":"","type":"text/plain"},"item":[{"id":"ef97af1f-865e-4c9c-a098-e735d3ad72a5","name":"Find user by invitation token","request":{"name":"Find user by invitation token","description":{"content":"You can retrieve the details of an account by providing the invitation token generated for that account.\n\n---\n\n**Authentication:** Not required\n","type":"text/plain"},"url":{"path":["uauth","user","register","invitation",":invitationToken"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"invitationToken","description":"(Required) Invitation token"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":null},"response":[{"id":"2bf7a647-ae7a-4dff-90ce-9a3f5c3f6a76","name":"OK","originalRequest":{"url":{"path":["uauth","user","register","invitation",":invitationToken"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"invitationToken","description":"(Required) Invitation token"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"email\": \"string\",\n \"firstName\": \"string\",\n \"lastName\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"afa43a82-f57e-4641-aa1f-0fbd2a558048","name":"Created","originalRequest":{"url":{"path":["uauth","user","register","invitation",":invitationToken"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"invitationToken","description":"(Required) Invitation token"}]},"method":"GET","body":{}},"status":"Created","code":201,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"15d724ae-cc3c-44eb-ad61-3d9ab599a2da","name":"Unauthorized","originalRequest":{"url":{"path":["uauth","user","register","invitation",":invitationToken"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"invitationToken","description":"(Required) Invitation token"}]},"method":"GET","body":{}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"f3945dce-b652-4d4e-a43f-59bb3203ab77","name":"Forbidden","originalRequest":{"url":{"path":["uauth","user","register","invitation",":invitationToken"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"invitationToken","description":"(Required) Invitation token"}]},"method":"GET","body":{}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"a81ff844-a539-4a29-b897-d14f15671a32","name":"Not Found","originalRequest":{"url":{"path":["uauth","user","register","invitation",":invitationToken"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"invitationToken","description":"(Required) Invitation token"}]},"method":"GET","body":{}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"bea577f9-3685-40a9-a969-dd5c3a22225f","name":"Invite user","request":{"name":"Invite user","description":{"content":"Invite a user to join a workspace. The user receives an email with an invitation token.\n\n---\n\n**API consumer:** Synerise User\n\n**User role permission required:** `settings_users: create`\n","type":"text/plain"},"url":{"path":["uauth","users","invitations","invite"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"email\": \"string\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"roles\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"expirationDate\": \"2003-01-27T04:11:55.710Z\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"acd58f4b-54c8-488c-a5bf-85104f976331","name":"OK","originalRequest":{"url":{"path":["uauth","users","invitations","invite"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"email\": \"string\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"roles\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"expirationDate\": \"2004-06-08T04:58:47.366Z\"\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"success\": [\n \"string\",\n \"string\"\n ],\n \"fail\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"e1e791fc-14c7-44e8-b3dc-7c9b9d0e02cf","name":"Unauthorized","originalRequest":{"url":{"path":["uauth","users","invitations","invite"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"POST","body":{"mode":"raw","raw":"{\n \"email\": \"string\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"roles\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"expirationDate\": \"2004-06-08T04:58:47.366Z\"\n}","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"3ebd54aa-eeb4-4299-9f7b-dca8d9dba32b","name":"Forbidden","originalRequest":{"url":{"path":["uauth","users","invitations","invite"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"POST","body":{"mode":"raw","raw":"{\n \"email\": \"string\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"roles\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"expirationDate\": \"2004-06-08T04:58:47.366Z\"\n}","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"2a443450-7fba-4b07-b50b-8ccc68a04e7d","name":"Not Found","originalRequest":{"url":{"path":["uauth","users","invitations","invite"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"POST","body":{"mode":"raw","raw":"{\n \"email\": \"string\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"roles\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"expirationDate\": \"2004-06-08T04:58:47.366Z\"\n}","options":{"raw":{"language":"json"}}}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"d83b972f-e36a-4bff-956d-860ce3ac4e18","name":"Invite many users","request":{"name":"Invite many users","description":{"content":"Invite a number of users to the workspace at once. The users receive emails with invitation tokens.\n\n---\n\n**API consumer:** Synerise User\n\n**User role permission required:** `settings_users: create`\n","type":"text/plain"},"url":{"path":["uauth","users","invitations","invite-bulk"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"invitations\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"2102e625-555b-4d3b-8e69-e45a63e07212","name":"OK","originalRequest":{"url":{"path":["uauth","users","invitations","invite-bulk"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"invitations\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"success\": [\n \"string\",\n \"string\"\n ],\n \"fail\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"99935239-cd0d-4d7b-a4dd-c2daf7387b82","name":"Unauthorized","originalRequest":{"url":{"path":["uauth","users","invitations","invite-bulk"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"POST","body":{"mode":"raw","raw":"{\n \"invitations\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"48e21d27-5156-4f9f-8a27-53c4a0049d50","name":"Forbidden","originalRequest":{"url":{"path":["uauth","users","invitations","invite-bulk"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"POST","body":{"mode":"raw","raw":"{\n \"invitations\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"2b5c174f-f8a1-46e4-9fb0-b4721acc1f43","name":"Not Found","originalRequest":{"url":{"path":["uauth","users","invitations","invite-bulk"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"POST","body":{"mode":"raw","raw":"{\n \"invitations\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"75ad2a3e-aa31-4b36-9604-fc56a3c02ed3","name":"Delete invitations","request":{"name":"Delete invitations","description":{"content":"Delete invitations that were not yet accepted.\n\n---\n\n**API consumer:** Synerise User\n\n**User role permission required:** `settings_users: delete`\n","type":"text/plain"},"url":{"path":["uauth","users","invitations",":invitationIds"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"invitationIds","description":"(Required) Comma-separated list of invitation IDs. To obtain the invitation ID, check the [list of users with PENDING status](#/operation/UsersListingUsingGET). The invitation ID for a user is the same as the ID of that user."}]},"method":"DELETE","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"148b8040-b68c-4808-ba8e-e3ef7e5ee1cb","name":"OK","originalRequest":{"url":{"path":["uauth","users","invitations",":invitationIds"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"invitationIds","description":"(Required) Comma-separated list of invitation IDs. To obtain the invitation ID, check the [list of users with PENDING status](#/operation/UsersListingUsingGET). The invitation ID for a user is the same as the ID of that user."}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"DELETE","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"9a446e12-d441-4244-bff4-b3646edc05cf","name":"Unauthorized","originalRequest":{"url":{"path":["uauth","users","invitations",":invitationIds"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"invitationIds","description":"(Required) Comma-separated list of invitation IDs. To obtain the invitation ID, check the [list of users with PENDING status](#/operation/UsersListingUsingGET). The invitation ID for a user is the same as the ID of that user."}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"DELETE","body":{}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"1f0f6b4d-d9b3-49fa-9d1d-58df4519ced6","name":"Forbidden","originalRequest":{"url":{"path":["uauth","users","invitations",":invitationIds"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"invitationIds","description":"(Required) Comma-separated list of invitation IDs. To obtain the invitation ID, check the [list of users with PENDING status](#/operation/UsersListingUsingGET). The invitation ID for a user is the same as the ID of that user."}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"DELETE","body":{}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"5ddc2275-15c3-446b-93b0-5ac848648869","name":"Update invitation","request":{"name":"Update invitation","description":{"content":"Update the details of an invitation.\n\n---\n\n**API consumer:** Synerise User\n\n**User role permission required:** `settings_users: update`\n","type":"text/plain"},"url":{"path":["uauth","users","invitations",":invitationId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"4489","key":"invitationId","description":"(Required) To obtain the invitation ID, check the [list of users with PENDING status](#/operation/UsersListingUsingGET). The invitation ID for a user is the same as the ID of that user."}]},"header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"roles\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"ba7bbcc7-71f8-4495-9f5f-2cf5038921a0","name":"OK","originalRequest":{"url":{"path":["uauth","users","invitations",":invitationId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"4489","key":"invitationId","description":"(Required) To obtain the invitation ID, check the [list of users with PENDING status](#/operation/UsersListingUsingGET). The invitation ID for a user is the same as the ID of that user."}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"POST","body":{"mode":"raw","raw":"{\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"roles\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"190ed742-e60e-4867-afd6-0082847ecf00","name":"Unauthorized","originalRequest":{"url":{"path":["uauth","users","invitations",":invitationId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"4489","key":"invitationId","description":"(Required) To obtain the invitation ID, check the [list of users with PENDING status](#/operation/UsersListingUsingGET). The invitation ID for a user is the same as the ID of that user."}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"POST","body":{"mode":"raw","raw":"{\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"roles\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"25c9c5be-2608-4678-9520-42b60b8f9100","name":"Forbidden","originalRequest":{"url":{"path":["uauth","users","invitations",":invitationId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"4489","key":"invitationId","description":"(Required) To obtain the invitation ID, check the [list of users with PENDING status](#/operation/UsersListingUsingGET). The invitation ID for a user is the same as the ID of that user."}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"POST","body":{"mode":"raw","raw":"{\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"roles\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"9dbfd160-726d-436a-85f2-0b9cd6de34a3","name":"Not Found","originalRequest":{"url":{"path":["uauth","users","invitations",":invitationId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"4489","key":"invitationId","description":"(Required) To obtain the invitation ID, check the [list of users with PENDING status](#/operation/UsersListingUsingGET). The invitation ID for a user is the same as the ID of that user."}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"POST","body":{"mode":"raw","raw":"{\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"roles\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"2619e2ea-822f-43ae-af37-89ee53773485","name":"List users","request":{"name":"List users","description":{"content":"List users from the current workspace\n\n---\n\n**API consumer:** Synerise User\n\n**User role permission required:** `settings_users: read`\n","type":"text/plain"},"url":{"path":["uauth","users","listing"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"page","value":"5612","description":"(Required) The page of results to retrieve. The first page has the index `0`."},{"disabled":false,"key":"size","value":"5612","description":"(Required) The number of entries on a page"},{"disabled":false,"key":"status","value":"ALL","description":"(Required) Filters the results by status of the users"},{"disabled":false,"key":"search","value":"string","description":"(Required) String to search for in the first names, surnames, and email addresses"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"58019559-99fd-4cb8-8448-de3cb98e7f42","name":"OK","originalRequest":{"url":{"path":["uauth","users","listing"],"host":["{{baseUrl}}"],"query":[{"key":"page","value":"5612"},{"key":"size","value":"5612"},{"key":"status","value":"ALL"},{"key":"search","value":"string"}],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"data\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"meta\": {\n \"pagination\": {\n \"value\": \"\"\n }\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"4b31bd97-822c-47dd-9264-6ca90f0132c1","name":"Unauthorized","originalRequest":{"url":{"path":["uauth","users","listing"],"host":["{{baseUrl}}"],"query":[{"key":"page","value":"5612"},{"key":"size","value":"5612"},{"key":"status","value":"ALL"},{"key":"search","value":"string"}],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"GET","body":{}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"2cf59daa-2d6e-4355-a7b6-597ed5b6d325","name":"Forbidden","originalRequest":{"url":{"path":["uauth","users","listing"],"host":["{{baseUrl}}"],"query":[{"key":"page","value":"5612"},{"key":"size","value":"5612"},{"key":"status","value":"ALL"},{"key":"search","value":"string"}],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"GET","body":{}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"0d00a6ce-2a96-4d40-af2e-7f8775a8ecd0","name":"Not Found","originalRequest":{"url":{"path":["uauth","users","listing"],"host":["{{baseUrl}}"],"query":[{"key":"page","value":"5612"},{"key":"size","value":"5612"},{"key":"status","value":"ALL"},{"key":"search","value":"string"}],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"GET","body":{}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"c312336d-943f-46b9-83a9-49deeeb03a69","name":"Autocomplete user search result","request":{"name":"Autocomplete user search result","description":{"content":"You can use this endpoint to obtain data for search autocomplete.\n\n---\n\n**API consumer:** Synerise User\n\n**User role permission required (at least one):** `settings_users: read`, `analytics: read`\n","type":"text/plain"},"url":{"path":["uauth","users","listing","autocomplete"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"email","value":"string","description":"(Required) User's email address"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"2be76521-31ed-4a4e-acc1-5e6193cd9fe7","name":"OK","originalRequest":{"url":{"path":["uauth","users","listing","autocomplete"],"host":["{{baseUrl}}"],"query":[{"key":"email","value":"string"}],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"[\n {\n \"avatarUrl\": {\n \"value\": \"\"\n },\n \"displayName\": {\n \"value\": \"\"\n },\n \"email\": {\n \"value\": \"\"\n },\n \"userId\": {\n \"value\": \"\"\n }\n },\n {\n \"avatarUrl\": {\n \"value\": \"\"\n },\n \"displayName\": {\n \"value\": \"\"\n },\n \"email\": {\n \"value\": \"\"\n },\n \"userId\": {\n \"value\": \"\"\n }\n }\n]","cookie":[],"_postman_previewlanguage":"json"},{"id":"c75b1c80-a61f-40c3-8822-7be9327ed449","name":"Unauthorized","originalRequest":{"url":{"path":["uauth","users","listing","autocomplete"],"host":["{{baseUrl}}"],"query":[{"key":"email","value":"string"}],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"GET","body":{}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"81e3b90d-6e5a-4a59-9b60-3672e4e1df29","name":"Forbidden","originalRequest":{"url":{"path":["uauth","users","listing","autocomplete"],"host":["{{baseUrl}}"],"query":[{"key":"email","value":"string"}],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"GET","body":{}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"bdbcc45c-e34c-4d6c-ad78-f9bcb0a8ca93","name":"Not Found","originalRequest":{"url":{"path":["uauth","users","listing","autocomplete"],"host":["{{baseUrl}}"],"query":[{"key":"email","value":"string"}],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"GET","body":{}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"3ff925a0-71ff-4d38-a464-7461494a0167","name":"Remove users from workspace","request":{"name":"Remove users from workspace","description":{"content":"Delete user associations from a workspace. This does not delete the user accounts.\n\n---\n\n**API consumer:** Synerise User\n\n**User role permission required:** `settings_users: delete`\n","type":"text/plain"},"url":{"path":["uauth","users","profile-association",":ids"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"11405,11406,11407","key":"ids","description":"(Required) Comma-separated user IDs"}]},"method":"DELETE","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"18b33054-cb22-4ce9-84cb-ed2dcf04b788","name":"OK","originalRequest":{"url":{"path":["uauth","users","profile-association",":ids"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"11405,11406,11407","key":"ids","description":"(Required) Comma-separated user IDs"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"DELETE","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"d4f6920a-2f24-4b9d-8b3b-9b060820a2d2","name":"Unauthorized","originalRequest":{"url":{"path":["uauth","users","profile-association",":ids"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"11405,11406,11407","key":"ids","description":"(Required) Comma-separated user IDs"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"DELETE","body":{}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"527a04ea-3421-41ab-8dc6-d1870e130aab","name":"Forbidden","originalRequest":{"url":{"path":["uauth","users","profile-association",":ids"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"11405,11406,11407","key":"ids","description":"(Required) Comma-separated user IDs"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"DELETE","body":{}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"bdf51529-ac5b-453a-9397-52ab32261120","name":"Get user data","request":{"name":"Get user data","description":{"content":"\n\n---\n\n**API consumer:** Synerise User\n","type":"text/plain"},"url":{"path":["uauth","users",":userId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"5612","key":"userId","description":"(Required) User ID"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"4287fe12-6665-4e09-9cca-ece1a775e70a","name":"OK","originalRequest":{"url":{"path":["uauth","users",":userId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"5612","key":"userId","description":"(Required) User ID"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"avatar\": \"string\",\n \"confirmed\": true,\n \"created\": \"2002-08-09T19:24:36.193Z\",\n \"description\": \"string\",\n \"displayName\": \"string\",\n \"email\": \"string\",\n \"firstName\": \"string\",\n \"id\": 4335,\n \"introduction\": \"string\",\n \"isTheSameUserAsLoggedIn\": false,\n \"language\": \"es\",\n \"lastLogin\": \"1989-07-15T14:47:48.243Z\",\n \"lastName\": \"string\",\n \"mailAccountId\": 6811,\n \"organizationRole\": \"string\",\n \"phone\": \"string\",\n \"roles\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"status\": \"PENDING\",\n \"superAdmin\": false,\n \"updated\": \"1958-07-22T02:19:55.567Z\",\n \"isMfaEnabled\": true,\n \"passwordLastModificationDate\": \"2018-06-14T09:31:13.452Z\",\n \"dateFormatNotation\": \"EU\",\n \"timeFormatNotation\": \"EU\",\n \"numberFormatNotation\": \"US\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"4c5ae419-5b69-4717-ad0e-243d8386967c","name":"Unauthorized","originalRequest":{"url":{"path":["uauth","users",":userId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"5612","key":"userId","description":"(Required) User ID"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"GET","body":{}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"70285c4c-0efd-4b6c-990f-dd6238166102","name":"Forbidden","originalRequest":{"url":{"path":["uauth","users",":userId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"5612","key":"userId","description":"(Required) User ID"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"GET","body":{}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"ad9fc1ad-f9c5-49ed-9bae-4a4946b1d1ac","name":"Not Found","originalRequest":{"url":{"path":["uauth","users",":userId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"5612","key":"userId","description":"(Required) User ID"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"GET","body":{}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"568a3702-4bcb-48d2-9411-db7065943fe0","name":"Update user data","request":{"name":"Update user data","description":{"content":"\n\n---\n\n**API consumer:** Synerise User\n","type":"text/plain"},"url":{"path":["uauth","users",":userId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"5612","key":"userId","description":"(Required) User ID"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"roles\": {\n \"value\": \"\"\n },\n \"firstName\": {\n \"value\": \"\"\n },\n \"lastName\": {\n \"value\": \"\"\n },\n \"avatar\": {\n \"value\": \"\"\n },\n \"phone\": {\n \"value\": \"\"\n },\n \"language\": {\n \"value\": \"\"\n },\n \"organizationRole\": {\n \"value\": \"\"\n },\n \"introduction\": {\n \"value\": \"\"\n },\n \"confirmed\": {\n \"value\": \"\"\n },\n \"mailAccountId\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n },\n \"dateFormatNotation\": {\n \"value\": \"\"\n },\n \"timeFormatNotation\": {\n \"value\": \"\"\n },\n \"numberFormatNotation\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"a095d183-918b-418e-80f2-2332217159bd","name":"OK","originalRequest":{"url":{"path":["uauth","users",":userId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"5612","key":"userId","description":"(Required) User ID"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"roles\": {\n \"value\": \"\"\n },\n \"firstName\": {\n \"value\": \"\"\n },\n \"lastName\": {\n \"value\": \"\"\n },\n \"avatar\": {\n \"value\": \"\"\n },\n \"phone\": {\n \"value\": \"\"\n },\n \"language\": {\n \"value\": \"\"\n },\n \"organizationRole\": {\n \"value\": \"\"\n },\n \"introduction\": {\n \"value\": \"\"\n },\n \"confirmed\": {\n \"value\": \"\"\n },\n \"mailAccountId\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n },\n \"dateFormatNotation\": {\n \"value\": \"\"\n },\n \"timeFormatNotation\": {\n \"value\": \"\"\n },\n \"numberFormatNotation\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"avatar\": \"string\",\n \"confirmed\": true,\n \"created\": \"2002-08-09T19:24:36.193Z\",\n \"description\": \"string\",\n \"displayName\": \"string\",\n \"email\": \"string\",\n \"firstName\": \"string\",\n \"id\": 4335,\n \"introduction\": \"string\",\n \"isTheSameUserAsLoggedIn\": false,\n \"language\": \"es\",\n \"lastLogin\": \"1989-07-15T14:47:48.243Z\",\n \"lastName\": \"string\",\n \"mailAccountId\": 6811,\n \"organizationRole\": \"string\",\n \"phone\": \"string\",\n \"roles\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"status\": \"PENDING\",\n \"superAdmin\": false,\n \"updated\": \"1958-07-22T02:19:55.567Z\",\n \"isMfaEnabled\": true,\n \"passwordLastModificationDate\": \"2018-06-14T09:31:13.452Z\",\n \"dateFormatNotation\": \"EU\",\n \"timeFormatNotation\": \"EU\",\n \"numberFormatNotation\": \"US\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"47c7232d-0921-4d49-b36d-05f077bf3e65","name":"Created","originalRequest":{"url":{"path":["uauth","users",":userId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"5612","key":"userId","description":"(Required) User ID"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"POST","body":{"mode":"raw","raw":"{\n \"roles\": {\n \"value\": \"\"\n },\n \"firstName\": {\n \"value\": \"\"\n },\n \"lastName\": {\n \"value\": \"\"\n },\n \"avatar\": {\n \"value\": \"\"\n },\n \"phone\": {\n \"value\": \"\"\n },\n \"language\": {\n \"value\": \"\"\n },\n \"organizationRole\": {\n \"value\": \"\"\n },\n \"introduction\": {\n \"value\": \"\"\n },\n \"confirmed\": {\n \"value\": \"\"\n },\n \"mailAccountId\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n },\n \"dateFormatNotation\": {\n \"value\": \"\"\n },\n \"timeFormatNotation\": {\n \"value\": \"\"\n },\n \"numberFormatNotation\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Created","code":201,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"440064d8-afe1-4653-8f87-05d3b481ea93","name":"Unauthorized","originalRequest":{"url":{"path":["uauth","users",":userId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"5612","key":"userId","description":"(Required) User ID"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"POST","body":{"mode":"raw","raw":"{\n \"roles\": {\n \"value\": \"\"\n },\n \"firstName\": {\n \"value\": \"\"\n },\n \"lastName\": {\n \"value\": \"\"\n },\n \"avatar\": {\n \"value\": \"\"\n },\n \"phone\": {\n \"value\": \"\"\n },\n \"language\": {\n \"value\": \"\"\n },\n \"organizationRole\": {\n \"value\": \"\"\n },\n \"introduction\": {\n \"value\": \"\"\n },\n \"confirmed\": {\n \"value\": \"\"\n },\n \"mailAccountId\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n },\n \"dateFormatNotation\": {\n \"value\": \"\"\n },\n \"timeFormatNotation\": {\n \"value\": \"\"\n },\n \"numberFormatNotation\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"6ace2e30-c3f5-4526-a2b7-8281947a2903","name":"Forbidden","originalRequest":{"url":{"path":["uauth","users",":userId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"5612","key":"userId","description":"(Required) User ID"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"POST","body":{"mode":"raw","raw":"{\n \"roles\": {\n \"value\": \"\"\n },\n \"firstName\": {\n \"value\": \"\"\n },\n \"lastName\": {\n \"value\": \"\"\n },\n \"avatar\": {\n \"value\": \"\"\n },\n \"phone\": {\n \"value\": \"\"\n },\n \"language\": {\n \"value\": \"\"\n },\n \"organizationRole\": {\n \"value\": \"\"\n },\n \"introduction\": {\n \"value\": \"\"\n },\n \"confirmed\": {\n \"value\": \"\"\n },\n \"mailAccountId\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n },\n \"dateFormatNotation\": {\n \"value\": \"\"\n },\n \"timeFormatNotation\": {\n \"value\": \"\"\n },\n \"numberFormatNotation\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"9dea30e6-fc2d-4d6e-8a7c-711d3c666ce9","name":"Not Found","originalRequest":{"url":{"path":["uauth","users",":userId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"5612","key":"userId","description":"(Required) User ID"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"POST","body":{"mode":"raw","raw":"{\n \"roles\": {\n \"value\": \"\"\n },\n \"firstName\": {\n \"value\": \"\"\n },\n \"lastName\": {\n \"value\": \"\"\n },\n \"avatar\": {\n \"value\": \"\"\n },\n \"phone\": {\n \"value\": \"\"\n },\n \"language\": {\n \"value\": \"\"\n },\n \"organizationRole\": {\n \"value\": \"\"\n },\n \"introduction\": {\n \"value\": \"\"\n },\n \"confirmed\": {\n \"value\": \"\"\n },\n \"mailAccountId\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n },\n \"dateFormatNotation\": {\n \"value\": \"\"\n },\n \"timeFormatNotation\": {\n \"value\": \"\"\n },\n \"numberFormatNotation\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"116fc31c-e688-4fba-9a00-09b5564f0986","name":"Activate users","request":{"name":"Activate users","description":{"content":"Activate access to the workspace for a number of users\n\n---\n\n**API consumer:** Synerise User\n\n**User role permission required:** `settings_users: delete`\n","type":"text/plain"},"url":{"path":["uauth","users","activate"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"ids\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"97c4d5af-83f6-499c-8d1c-90c84a9c4746","name":"OK","originalRequest":{"url":{"path":["uauth","users","activate"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"POST","body":{"mode":"raw","raw":"{\n \"ids\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"6c19b3f4-5591-42c5-803c-00e3f730fe10","name":"De-activate users","request":{"name":"De-activate users","description":{"content":"De-activate access to the workspace for a number of users\n\n---\n\n**API consumer:** Synerise User\n\n**User role permission required:** `settings_users: update`\n","type":"text/plain"},"url":{"path":["uauth","users","deactivate"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"ids\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"2e65f9fd-73e2-46b3-8c8b-93c3f5975898","name":"OK","originalRequest":{"url":{"path":["uauth","users","deactivate"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"POST","body":{"mode":"raw","raw":"{\n \"ids\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"ec43af16-7fcc-4c0f-be31-67b70c51fc80","name":"Change access expiration time","request":{"name":"Change access expiration time","description":{"content":"Change the date when a user's access to the workspace is cancelled.\n\n---\n\n**API consumer:** Synerise User\n\n**User role permission required:** `settings_users: update`\n","type":"text/plain"},"url":{"path":["uauth","users",":userId","access-time"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"5612","key":"userId","description":"(Required) User ID"}]},"header":[{"key":"Content-Type","value":"application/json"}],"method":"PUT","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"expirationDate\": \"1979-10-28T21:53:21.882Z\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"a578e469-bda7-495a-a607-4d830c66aa81","name":"OK","originalRequest":{"url":{"path":["uauth","users",":userId","access-time"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"5612","key":"userId","description":"(Required) User ID"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"PUT","body":{"mode":"raw","raw":"{\n \"expirationDate\": \"1979-10-28T21:53:21.882Z\"\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"d3e491d0-4eea-4fd7-ac84-9b2c04c44ee0","name":"Unauthorized","originalRequest":{"url":{"path":["uauth","users",":userId","access-time"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"5612","key":"userId","description":"(Required) User ID"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"PUT","body":{"mode":"raw","raw":"{\n \"expirationDate\": \"1979-10-28T21:53:21.882Z\"\n}","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"6d3ee394-65ca-4c12-9227-6a74301601ee","name":"Forbidden","originalRequest":{"url":{"path":["uauth","users",":userId","access-time"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"5612","key":"userId","description":"(Required) User ID"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"PUT","body":{"mode":"raw","raw":"{\n \"expirationDate\": \"1979-10-28T21:53:21.882Z\"\n}","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"391793a6-afe4-4770-8d2e-af64b7610515","name":"Not Found","originalRequest":{"url":{"path":["uauth","users",":userId","access-time"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"5612","key":"userId","description":"(Required) User ID"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"PUT","body":{"mode":"raw","raw":"{\n \"expirationDate\": \"1979-10-28T21:53:21.882Z\"\n}","options":{"raw":{"language":"json"}}}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"93b38cce-944a-4341-9335-715d62d77659","name":"Reset another user's password","request":{"name":"Reset another user's password","description":{"content":"Request a password reset for another user. That user receives an email with a password reset token. Their account is locked until the new password is set.\n\n---\n\n**API consumer:** Synerise User\n\n**User role permission required:** `settings_users: update`\n","type":"text/plain"},"url":{"path":["uauth","users",":userId","password-reset"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"5612","key":"userId","description":"(Required) User ID"}]},"method":"POST","auth":null},"response":[{"id":"542bd881-3e45-4e16-8906-a81334454fad","name":"OK","originalRequest":{"url":{"path":["uauth","users",":userId","password-reset"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"5612","key":"userId","description":"(Required) User ID"}]},"method":"POST","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"52d4b213-3b9f-4557-bde4-ce8c075711d2","name":"Reset another user's multi-factor authentication","request":{"name":"Reset another user's multi-factor authentication","description":{"content":"You can reset the settings of another user's multi-factor authentication. This can be used, for example, if the user has lost both their device with the MFA application and the recovery code.\nThe user will need to re-enable MFA in the same way as when setting it up for the first time.\n\n\n---\n\n**API consumer:** Synerise User\n\n**User role permission required:** `settings_users: update`\n","type":"text/plain"},"url":{"path":["uauth","users",":userId","mfa-reset"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"5612","key":"userId","description":"(Required) User ID"}]},"method":"PUT","auth":null},"response":[{"id":"1f5d2d66-b119-4492-8c9b-9a7da4bc18f1","name":"OK","originalRequest":{"url":{"path":["uauth","users",":userId","mfa-reset"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"5612","key":"userId","description":"(Required) User ID"}]},"method":"PUT","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"95262b02-bdf1-4e46-84d0-e60aae9abbac","name":"Delete user account","request":{"name":"Delete user account","description":{"content":"Permanently deletes a user account.\n\n---\n\n**API consumer:** Synerise User\n\n**User role permission required:** `settings_users: delete`\n","type":"text/plain"},"url":{"path":["uauth","users",":ids"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"11405,11406,11407","key":"ids","description":"(Required) Comma-separated user IDs"}]},"method":"DELETE","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"89649f5d-8ecc-4126-8ca4-4a33523411e7","name":"OK","originalRequest":{"url":{"path":["uauth","users",":ids"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"11405,11406,11407","key":"ids","description":"(Required) Comma-separated user IDs"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"DELETE","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}],"event":[]},{"id":"37f70878-6e84-4078-9fc6-ebb2fac85330","name":"Access groups","description":{"content":"","type":"text/plain"},"item":[{"id":"5594bd68-4959-412e-9cc3-e75c4ae60d7a","name":"List grouped permissions","request":{"name":"List grouped permissions","description":{"content":"List all permissions for a role, including information about permission grouping.\n\n---\n\n**API consumer:** Synerise User\n\n**User role permission required:** `settings_users: read`\n","type":"text/plain"},"url":{"path":["uauth","permissions","group","role",":roleId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"4489","key":"roleId","description":"(Required) Role ID"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":null},"response":[{"id":"fee31075-acca-4fc2-ba2b-9797165d1047","name":"This schema is **recursive**: the `children` array can include more groups, which include more groups, etc.","originalRequest":{"url":{"path":["uauth","permissions","group","role",":roleId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"4489","key":"roleId","description":"(Required) Role ID"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"[\n {\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"slug\": {\n \"value\": \"\"\n },\n \"path\": {\n \"value\": \"\"\n },\n \"left\": {\n \"value\": \"\"\n },\n \"right\": {\n \"value\": \"\"\n },\n \"deep\": {\n \"value\": \"\"\n },\n \"canCreate\": {\n \"value\": \"\"\n },\n \"canRead\": {\n \"value\": \"\"\n },\n \"canUpdate\": {\n \"value\": \"\"\n },\n \"canDelete\": {\n \"value\": \"\"\n },\n \"canExecute\": {\n \"value\": \"\"\n },\n \"create\": {\n \"value\": \"\"\n },\n \"read\": {\n \"value\": \"\"\n },\n \"update\": {\n \"value\": \"\"\n },\n \"delete\": {\n \"value\": \"\"\n },\n \"execute\": {\n \"value\": \"\"\n },\n \"createDisabled\": {\n \"value\": \"\"\n },\n \"readDisabled\": {\n \"value\": \"\"\n },\n \"updateDisabled\": {\n \"value\": \"\"\n },\n \"deleteDisabled\": {\n \"value\": \"\"\n },\n \"executeDisabled\": {\n \"value\": \"\"\n },\n \"children\": {\n \"value\": \"\"\n }\n },\n {\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"slug\": {\n \"value\": \"\"\n },\n \"path\": {\n \"value\": \"\"\n },\n \"left\": {\n \"value\": \"\"\n },\n \"right\": {\n \"value\": \"\"\n },\n \"deep\": {\n \"value\": \"\"\n },\n \"canCreate\": {\n \"value\": \"\"\n },\n \"canRead\": {\n \"value\": \"\"\n },\n \"canUpdate\": {\n \"value\": \"\"\n },\n \"canDelete\": {\n \"value\": \"\"\n },\n \"canExecute\": {\n \"value\": \"\"\n },\n \"create\": {\n \"value\": \"\"\n },\n \"read\": {\n \"value\": \"\"\n },\n \"update\": {\n \"value\": \"\"\n },\n \"delete\": {\n \"value\": \"\"\n },\n \"execute\": {\n \"value\": \"\"\n },\n \"createDisabled\": {\n \"value\": \"\"\n },\n \"readDisabled\": {\n \"value\": \"\"\n },\n \"updateDisabled\": {\n \"value\": \"\"\n },\n \"deleteDisabled\": {\n \"value\": \"\"\n },\n \"executeDisabled\": {\n \"value\": \"\"\n },\n \"children\": {\n \"value\": \"\"\n }\n }\n]","cookie":[],"_postman_previewlanguage":"json"},{"id":"0ccf7a77-f799-4b97-bb95-ee3ff75defff","name":"Unauthorized","originalRequest":{"url":{"path":["uauth","permissions","group","role",":roleId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"4489","key":"roleId","description":"(Required) Role ID"}]},"method":"GET","body":{}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"d66a814e-efc5-4563-a8c6-b5dd2f094d2e","name":"Forbidden","originalRequest":{"url":{"path":["uauth","permissions","group","role",":roleId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"4489","key":"roleId","description":"(Required) Role ID"}]},"method":"GET","body":{}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"c9f62c46-2c19-4625-82ed-102bb8349af6","name":"Not Found","originalRequest":{"url":{"path":["uauth","permissions","group","role",":roleId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"4489","key":"roleId","description":"(Required) Role ID"}]},"method":"GET","body":{}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"464919c8-7f4e-4385-ac53-2ad790604041","name":"Get role groups","request":{"name":"Get role groups","description":{"content":"Retrieve a list of user role groups.\n\n---\n\n**API consumer:** Synerise User\n\n**User role permission required:** `settings_users: read`\n","type":"text/plain"},"url":{"path":["uauth","roles","listing"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"363b8109-37d8-423d-b4cf-0b9844459e04","name":"OK","originalRequest":{"url":{"path":["uauth","roles","listing"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"[\n {\n \"data\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n },\n \"editable\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n },\n {\n \"data\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n },\n \"editable\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n }\n]","cookie":[],"_postman_previewlanguage":"json"},{"id":"1a490d6a-1097-4a87-8dbf-989f2a3bdd44","name":"Unauthorized","originalRequest":{"url":{"path":["uauth","roles","listing"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"GET","body":{}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"a12808e9-46d6-43e6-ad3c-76f74c184c52","name":"Forbidden","originalRequest":{"url":{"path":["uauth","roles","listing"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"GET","body":{}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"44db6c49-837a-40a0-9cf4-ce15d076b690","name":"Not Found","originalRequest":{"url":{"path":["uauth","roles","listing"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"GET","body":{}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"9f403edd-f385-4af0-8989-37093cfbdce4","name":"Create role group","request":{"name":"Create role group","description":{"content":"Create a new role group. A new group does not include any roles. To add a role to a group, [update the role](#operation/updateRoleUsingPOST).\n\n---\n\n**API consumer:** Synerise User\n\n**User role permission required:** `settings_users: create`\n","type":"text/plain"},"url":{"path":["uauth","roles","role-group"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"name\": \"string\",\n \"description\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"45cb4999-1ca3-4115-a407-a0cfc98cf97f","name":"New group created; response includes all existing groups","originalRequest":{"url":{"path":["uauth","roles","role-group"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"name\": \"string\",\n \"description\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"[\n {\n \"data\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n },\n \"editable\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n },\n {\n \"data\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n },\n \"editable\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n }\n]","cookie":[],"_postman_previewlanguage":"json"},{"id":"fc2a9adf-10cb-4214-b2ba-ae702ad7d3c2","name":"Unauthorized","originalRequest":{"url":{"path":["uauth","roles","role-group"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"POST","body":{"mode":"raw","raw":"{\n \"name\": \"string\",\n \"description\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"334ecf4d-0f60-437e-9623-a0ea6960cf11","name":"Forbidden","originalRequest":{"url":{"path":["uauth","roles","role-group"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"POST","body":{"mode":"raw","raw":"{\n \"name\": \"string\",\n \"description\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"43af10d1-943d-40ad-99a0-01f15c61fb02","name":"Not Found","originalRequest":{"url":{"path":["uauth","roles","role-group"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"POST","body":{"mode":"raw","raw":"{\n \"name\": \"string\",\n \"description\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"c6b1e640-17e9-46f8-a5d9-5b1fcdb7dcae","name":"Update role group","request":{"name":"Update role group","description":{"content":"Update a group. To add a role to a group, [update the role](#operation/updateRoleUsingPOST).\n\n---\n\n**API consumer:** Synerise User\n\n**User role permission required:** `settings_users: update`\n","type":"text/plain"},"url":{"path":["uauth","roles","role-group",":groupId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"4489","key":"groupId","description":"(Required) Role group ID"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"name\": \"string\",\n \"description\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"0b544363-0b69-4a9c-9937-ebc67025a823","name":"Group updated; response includes all existing groups","originalRequest":{"url":{"path":["uauth","roles","role-group",":groupId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"4489","key":"groupId","description":"(Required) Role group ID"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"name\": \"string\",\n \"description\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"[\n {\n \"data\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n },\n \"editable\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n },\n {\n \"data\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n },\n \"editable\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n }\n]","cookie":[],"_postman_previewlanguage":"json"},{"id":"1d8c2834-1c93-4bc4-b006-95b3a5ddce85","name":"Unauthorized","originalRequest":{"url":{"path":["uauth","roles","role-group",":groupId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"4489","key":"groupId","description":"(Required) Role group ID"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"POST","body":{"mode":"raw","raw":"{\n \"name\": \"string\",\n \"description\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"5196c515-1777-4c11-9694-501ea0efca48","name":"Forbidden","originalRequest":{"url":{"path":["uauth","roles","role-group",":groupId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"4489","key":"groupId","description":"(Required) Role group ID"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"POST","body":{"mode":"raw","raw":"{\n \"name\": \"string\",\n \"description\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"3e6749f7-9291-424f-9216-505af3508385","name":"Not Found","originalRequest":{"url":{"path":["uauth","roles","role-group",":groupId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"4489","key":"groupId","description":"(Required) Role group ID"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"POST","body":{"mode":"raw","raw":"{\n \"name\": \"string\",\n \"description\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"7a69ca81-3baf-4293-ad7e-0d58084dc5ec","name":"Delete role group","request":{"name":"Delete role group","description":{"content":"Delete a role group permanently.\n\n---\n\n**API consumer:** Synerise User\n\n**User role permission required:** `settings_users: delete`\n","type":"text/plain"},"url":{"path":["uauth","roles","role-group",":groupId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"4489","key":"groupId","description":"(Required) Role group ID"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"f7fe3275-460d-42d8-9549-983684f1350d","name":"Group deleted; response includes all existing groups","originalRequest":{"url":{"path":["uauth","roles","role-group",":groupId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"4489","key":"groupId","description":"(Required) Role group ID"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"[\n {\n \"data\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n },\n \"editable\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n },\n {\n \"data\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n },\n \"editable\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n }\n]","cookie":[],"_postman_previewlanguage":"json"},{"id":"8de99093-9994-4f1c-8a7a-9c3978bf1d98","name":"Unauthorized","originalRequest":{"url":{"path":["uauth","roles","role-group",":groupId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"4489","key":"groupId","description":"(Required) Role group ID"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"DELETE","body":{}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"846ec895-b676-4fbf-ac41-4d0354b77402","name":"Forbidden","originalRequest":{"url":{"path":["uauth","roles","role-group",":groupId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"4489","key":"groupId","description":"(Required) Role group ID"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"DELETE","body":{}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"1e0c4cf2-ce78-471a-84de-8861214cb2e3","name":"Create role","request":{"name":"Create role","description":{"content":"Create a new user role.\n\n---\n\n**API consumer:** Synerise User\n\n**User role permission required:** `settings_users: update`\n","type":"text/plain"},"url":{"path":["uauth","roles","role"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"name\": \"string\",\n \"group\": 3562,\n \"description\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"84b8e225-24e9-47f6-8f65-2c514808d757","name":"Role created","originalRequest":{"url":{"path":["uauth","roles","role"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"name\": \"string\",\n \"group\": 3562,\n \"description\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"id\": 9156,\n \"name\": \"string\",\n \"businessProfileId\": 2225,\n \"shownAsResource\": false,\n \"manageable\": false,\n \"pii\": true,\n \"group\": 6000,\n \"author\": {\n \"avatar\": {\n \"value\": \"\"\n },\n \"displayName\": {\n \"value\": \"\"\n },\n \"firstName\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n },\n \"lastName\": {\n \"value\": \"\"\n }\n },\n \"editable\": false,\n \"description\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"896dcff5-2343-49f5-92b1-d826e3212c00","name":"Unauthorized","originalRequest":{"url":{"path":["uauth","roles","role"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"POST","body":{"mode":"raw","raw":"{\n \"name\": \"string\",\n \"group\": 3562,\n \"description\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"57f55228-3ddc-491a-9e45-8e8d09a27819","name":"Forbidden","originalRequest":{"url":{"path":["uauth","roles","role"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"POST","body":{"mode":"raw","raw":"{\n \"name\": \"string\",\n \"group\": 3562,\n \"description\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"bb978e0a-626a-4103-a60b-e2d6fa34553e","name":"Not Found","originalRequest":{"url":{"path":["uauth","roles","role"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"POST","body":{"mode":"raw","raw":"{\n \"name\": \"string\",\n \"group\": 3562,\n \"description\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"69159758-72a0-45cf-806c-2cf6de86facc","name":"Get role","request":{"name":"Get role","description":{"content":"Retrieve the details of a user role\n\n---\n\n**API consumer:** Synerise User\n\n**User role permission required:** `settings_users: read`\n","type":"text/plain"},"url":{"path":["uauth","roles",":roleId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"4489","key":"roleId","description":"(Required) Role ID"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"35067955-edf8-4be2-ac98-3d0eaaafe43e","name":"OK","originalRequest":{"url":{"path":["uauth","roles",":roleId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"4489","key":"roleId","description":"(Required) Role ID"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"id\": 9156,\n \"name\": \"string\",\n \"businessProfileId\": 2225,\n \"shownAsResource\": false,\n \"manageable\": false,\n \"pii\": true,\n \"group\": 6000,\n \"author\": {\n \"avatar\": {\n \"value\": \"\"\n },\n \"displayName\": {\n \"value\": \"\"\n },\n \"firstName\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n },\n \"lastName\": {\n \"value\": \"\"\n }\n },\n \"editable\": false,\n \"description\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"012a68ee-af4f-420f-8ec4-0ebbf2a23f95","name":"Unauthorized","originalRequest":{"url":{"path":["uauth","roles",":roleId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"4489","key":"roleId","description":"(Required) Role ID"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"GET","body":{}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"78905f51-4bfe-4f54-8036-fbdf2e44f39b","name":"Forbidden","originalRequest":{"url":{"path":["uauth","roles",":roleId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"4489","key":"roleId","description":"(Required) Role ID"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"GET","body":{}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"1f316979-47bb-4caf-be27-04d6097487dd","name":"Not Found","originalRequest":{"url":{"path":["uauth","roles",":roleId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"4489","key":"roleId","description":"(Required) Role ID"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"GET","body":{}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"12d2a6ee-33d0-45c4-b6c0-5e4392a5fdc9","name":"Update role","request":{"name":"Update role","description":{"content":"Update a user role.\n\n---\n\n**API consumer:** Synerise User\n\n**User role permission required:** `settings_users: update`\n","type":"text/plain"},"url":{"path":["uauth","roles","role",":roleId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"4489","key":"roleId","description":"(Required) Role ID"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"name\": \"string\",\n \"group\": 3562,\n \"description\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"bc440f7e-505e-4aab-86bb-fef3107ed438","name":"Role updated","originalRequest":{"url":{"path":["uauth","roles","role",":roleId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"4489","key":"roleId","description":"(Required) Role ID"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"name\": \"string\",\n \"group\": 3562,\n \"description\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"id\": 9156,\n \"name\": \"string\",\n \"businessProfileId\": 2225,\n \"shownAsResource\": false,\n \"manageable\": false,\n \"pii\": true,\n \"group\": 6000,\n \"author\": {\n \"avatar\": {\n \"value\": \"\"\n },\n \"displayName\": {\n \"value\": \"\"\n },\n \"firstName\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n },\n \"lastName\": {\n \"value\": \"\"\n }\n },\n \"editable\": false,\n \"description\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"f908dfea-5d69-4ac7-861d-578750d2513d","name":"Unauthorized","originalRequest":{"url":{"path":["uauth","roles","role",":roleId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"4489","key":"roleId","description":"(Required) Role ID"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"POST","body":{"mode":"raw","raw":"{\n \"name\": \"string\",\n \"group\": 3562,\n \"description\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"15ecf39f-fd67-42e3-a2b5-4628008e9128","name":"Forbidden","originalRequest":{"url":{"path":["uauth","roles","role",":roleId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"4489","key":"roleId","description":"(Required) Role ID"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"POST","body":{"mode":"raw","raw":"{\n \"name\": \"string\",\n \"group\": 3562,\n \"description\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"6bc67d08-d236-4295-b35b-041258726eed","name":"Not Found","originalRequest":{"url":{"path":["uauth","roles","role",":roleId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"4489","key":"roleId","description":"(Required) Role ID"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"POST","body":{"mode":"raw","raw":"{\n \"name\": \"string\",\n \"group\": 3562,\n \"description\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"d1026bb7-885c-4503-bd63-11c195608c7b","name":"Delete role","request":{"name":"Delete role","description":{"content":"Delete a user role permanently.\n\n---\n\n**API consumer:** Synerise User\n\n**User role permission required:** `settings_users: delete`\n","type":"text/plain"},"url":{"path":["uauth","roles","role",":roleId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"4489","key":"roleId","description":"(Required) Role ID"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"ebc6f976-960b-44c2-9b46-a1b3057b65e2","name":"Role deleted, response includes all existing groups","originalRequest":{"url":{"path":["uauth","roles","role",":roleId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"4489","key":"roleId","description":"(Required) Role ID"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"[\n {\n \"data\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n },\n \"editable\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n },\n {\n \"data\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n },\n \"editable\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n }\n]","cookie":[],"_postman_previewlanguage":"json"},{"id":"8308c186-f802-4bbd-b734-4b1b3d4848d5","name":"Unauthorized","originalRequest":{"url":{"path":["uauth","roles","role",":roleId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"4489","key":"roleId","description":"(Required) Role ID"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"DELETE","body":{}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"31ddcd9e-eace-4c7a-93f8-ade052c119f9","name":"Forbidden","originalRequest":{"url":{"path":["uauth","roles","role",":roleId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"4489","key":"roleId","description":"(Required) Role ID"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"DELETE","body":{}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"ba79af7d-2784-440c-a8ce-278abdeb2627","name":"Get available roles","request":{"name":"Get available roles","description":{"content":"Retrieve a list of user roles available in the business profile.\n\n---\n\n**API consumer:** Synerise User\n\n**Authentication:** Not required\n","type":"text/plain"},"url":{"path":["uauth","users","available-roles"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":null},"response":[{"id":"02fbbfdb-fe6c-4324-9d38-b7ac8e9d3698","name":"OK","originalRequest":{"url":{"path":["uauth","users","available-roles"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"[\n {\n \"businessProfileId\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n },\n \"manageable\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"shownAsResource\": {\n \"value\": \"\"\n },\n \"pii\": {\n \"value\": \"\"\n }\n },\n {\n \"businessProfileId\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n },\n \"manageable\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"shownAsResource\": {\n \"value\": \"\"\n },\n \"pii\": {\n \"value\": \"\"\n }\n }\n]","cookie":[],"_postman_previewlanguage":"json"},{"id":"969b3834-4f8d-4cc9-a781-dd3053283aaa","name":"Unauthorized","originalRequest":{"url":{"path":["uauth","users","available-roles"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"method":"GET","body":{}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"ecca4bc5-4187-4a3b-a92d-681f3919ddef","name":"Forbidden","originalRequest":{"url":{"path":["uauth","users","available-roles"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"method":"GET","body":{}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"1aa62745-b074-4d50-9611-6c94a90a2dbf","name":"Not Found","originalRequest":{"url":{"path":["uauth","users","available-roles"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"method":"GET","body":{}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}],"event":[]},{"id":"1c351272-8b0e-4614-80bf-aee98711befc","name":"User account management","description":{"content":"","type":"text/plain"},"item":[{"id":"e5b62f3b-3bdf-4189-8958-2f9d6f9cb494","name":"Change user password","request":{"name":"Change user password","description":{"content":"Change a user's password.\n\n---\n\n**API consumer:** Synerise User\n","type":"text/plain"},"url":{"path":["uauth","change-password"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"currentPassword\": \"string\",\n \"newPassword\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"7f0511d1-4842-4e55-8bc6-3fac42b340fc","name":"OK","originalRequest":{"url":{"path":["uauth","change-password"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"currentPassword\": \"string\",\n \"newPassword\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"status\": \"OK\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"0bf7daa0-65e3-44b4-bf1f-c97e0ae4be7d","name":"Created","originalRequest":{"url":{"path":["uauth","change-password"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"POST","body":{"mode":"raw","raw":"{\n \"currentPassword\": \"string\",\n \"newPassword\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Created","code":201,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"1b5170b2-8d2d-4bcf-b4df-49a1276d7776","name":"Unauthorized","originalRequest":{"url":{"path":["uauth","change-password"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"POST","body":{"mode":"raw","raw":"{\n \"currentPassword\": \"string\",\n \"newPassword\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"1d2f09d9-9d39-439b-89d7-1ac5912d487f","name":"Forbidden","originalRequest":{"url":{"path":["uauth","change-password"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"POST","body":{"mode":"raw","raw":"{\n \"currentPassword\": \"string\",\n \"newPassword\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"7792ccd6-afbc-40fe-a890-e7f23f66ffeb","name":"Not Found","originalRequest":{"url":{"path":["uauth","change-password"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"POST","body":{"mode":"raw","raw":"{\n \"currentPassword\": \"string\",\n \"newPassword\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"2fee9fac-5b29-48e9-8d25-666b6140a7f0","name":"Request user password reset","request":{"name":"Request user password reset","description":{"content":"The user can request a password reset token sent by email.\n\n---\n\n**Authentication:** Not required\n","type":"text/plain"},"url":{"path":["uauth","password-reset","request"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","auth":null,"body":{"mode":"raw","raw":"{\n \"email\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"264ed06d-2e0a-4056-a943-4cbebcc201f4","name":"OK","originalRequest":{"url":{"path":["uauth","password-reset","request"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"method":"POST","body":{"mode":"raw","raw":"{\n \"email\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"9a8afafb-02ab-4911-8927-2eea63ea31a4","name":"Unauthorized","originalRequest":{"url":{"path":["uauth","password-reset","request"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"method":"POST","body":{"mode":"raw","raw":"{\n \"email\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"14d9fa10-5bfd-482d-b8dc-974750ebe8b2","name":"Forbidden","originalRequest":{"url":{"path":["uauth","password-reset","request"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"method":"POST","body":{"mode":"raw","raw":"{\n \"email\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"5aa7d334-b40d-438e-a1e9-9d74d1209cec","name":"Not Found","originalRequest":{"url":{"path":["uauth","password-reset","request"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"method":"POST","body":{"mode":"raw","raw":"{\n \"email\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"5442fdca-aae5-4151-9a1a-abdcd3567671","name":"Confirm user password reset","request":{"name":"Confirm user password reset","description":{"content":"Confirm user password reset using the token received by email.\n\n---\n\n**Authentication:** Not required\n","type":"text/plain"},"url":{"path":["uauth","password-reset","confirmation"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","auth":null,"body":{"mode":"raw","raw":"{\n \"token\": \"string\",\n \"password\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"bb452e94-6d4b-46aa-a507-4de8d0637043","name":"OK","originalRequest":{"url":{"path":["uauth","password-reset","confirmation"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"method":"POST","body":{"mode":"raw","raw":"{\n \"token\": \"string\",\n \"password\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"7375cbb7-6503-45b4-8f90-d7a94f5645ce","name":"Unauthorized","originalRequest":{"url":{"path":["uauth","password-reset","confirmation"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"method":"POST","body":{"mode":"raw","raw":"{\n \"token\": \"string\",\n \"password\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"b822a918-c42f-45d0-be87-0a2fcafd21e3","name":"Forbidden","originalRequest":{"url":{"path":["uauth","password-reset","confirmation"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"method":"POST","body":{"mode":"raw","raw":"{\n \"token\": \"string\",\n \"password\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"bb996b65-4279-450e-8691-3fc5b4c609c3","name":"Not Found","originalRequest":{"url":{"path":["uauth","password-reset","confirmation"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"method":"POST","body":{"mode":"raw","raw":"{\n \"token\": \"string\",\n \"password\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"7dd9ba31-7103-466f-9051-84494faffea1","name":"Confirm user registration","request":{"name":"Confirm user registration","description":{"content":"Confirm user registration. The token is sent by email.\n\n---\n\n**Authentication:** Not required\n","type":"text/plain"},"url":{"path":["uauth","user","confirmation",":confirmationToken"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"confirmationToken","description":"(Required) Confirmation token"}]},"method":"GET","auth":null},"response":[{"id":"6ab676a7-4f76-446f-8857-1d449899adbb","name":"OK","originalRequest":{"url":{"path":["uauth","user","confirmation",":confirmationToken"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"confirmationToken","description":"(Required) Confirmation token"}]},"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"96e7df15-23f9-4698-8fc5-347e96d4aa9c","name":"Unauthorized","originalRequest":{"url":{"path":["uauth","user","confirmation",":confirmationToken"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"confirmationToken","description":"(Required) Confirmation token"}]},"method":"GET","body":{}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"38808b04-f170-4628-8c32-3a285cc4486d","name":"Forbidden","originalRequest":{"url":{"path":["uauth","user","confirmation",":confirmationToken"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"confirmationToken","description":"(Required) Confirmation token"}]},"method":"GET","body":{}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"9fd8ca0a-f258-4239-8af7-55725e786c3d","name":"Not Found","originalRequest":{"url":{"path":["uauth","user","confirmation",":confirmationToken"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"confirmationToken","description":"(Required) Confirmation token"}]},"method":"GET","body":{}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"ebaee2ed-cdd2-4233-b540-1c8829cdb594","name":"Register user","request":{"name":"Register user","description":{"content":"Register a new user. Before the new account can be used, it must be [confirmed](#operation/confirmUserUsingGET).\n\n---\n\n**Authentication:** Not required\n","type":"text/plain"},"url":{"path":["uauth","user","register"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","auth":null,"body":{"mode":"raw","raw":"{\n \"email\": \"string\",\n \"password\": \"string\",\n \"invitationToken\": \"string\",\n \"externalProviderToken\": \"string\",\n \"externalProviderType\": \"GOOGLE\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"387aaa2e-682c-4146-a24d-f716166bbaf5","name":"OK","originalRequest":{"url":{"path":["uauth","user","register"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"method":"POST","body":{"mode":"raw","raw":"{\n \"email\": \"string\",\n \"password\": \"string\",\n \"invitationToken\": \"string\",\n \"externalProviderToken\": \"string\",\n \"externalProviderType\": \"GOOGLE\"\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"941ff60b-6ae5-442e-93a7-bd32559ff1d2","name":"Unauthorized","originalRequest":{"url":{"path":["uauth","user","register"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"method":"POST","body":{"mode":"raw","raw":"{\n \"email\": \"string\",\n \"password\": \"string\",\n \"invitationToken\": \"string\",\n \"externalProviderToken\": \"string\",\n \"externalProviderType\": \"GOOGLE\"\n}","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"75a1b5a0-ecab-4d74-a2fa-8f594a86922e","name":"Forbidden","originalRequest":{"url":{"path":["uauth","user","register"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"method":"POST","body":{"mode":"raw","raw":"{\n \"email\": \"string\",\n \"password\": \"string\",\n \"invitationToken\": \"string\",\n \"externalProviderToken\": \"string\",\n \"externalProviderType\": \"GOOGLE\"\n}","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"9cf068e1-09bc-44fb-8f78-71376b61db39","name":"Not Found","originalRequest":{"url":{"path":["uauth","user","register"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"method":"POST","body":{"mode":"raw","raw":"{\n \"email\": \"string\",\n \"password\": \"string\",\n \"invitationToken\": \"string\",\n \"externalProviderToken\": \"string\",\n \"externalProviderType\": \"GOOGLE\"\n}","options":{"raw":{"language":"json"}}}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"c7cd15cc-327d-4ebf-8e16-506714313e97","name":"User already registered","originalRequest":{"url":{"path":["uauth","user","register"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"method":"POST","body":{"mode":"raw","raw":"{\n \"email\": \"string\",\n \"password\": \"string\",\n \"invitationToken\": \"string\",\n \"externalProviderToken\": \"string\",\n \"externalProviderType\": \"GOOGLE\"\n}","options":{"raw":{"language":"json"}}}},"status":"Conflict","code":409,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"36534718-e1b2-4095-9805-af0f15444485","name":"Re-send user confirmation token","request":{"name":"Re-send user confirmation token","description":{"content":"If the confirmation token does not reach the user's inbox, you can send a new one.\n\n---\n\n**Authentication:** Not required\n","type":"text/plain"},"url":{"path":["uauth","user","register","resend-confirmation"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","auth":null,"body":{"mode":"raw","raw":"{\n \"email\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"8692acc9-925e-43ce-a6ae-f281348f66d9","name":"OK","originalRequest":{"url":{"path":["uauth","user","register","resend-confirmation"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"method":"POST","body":{"mode":"raw","raw":"{\n \"email\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"2c3fd671-7c80-420a-8bff-9e188114771e","name":"Created","originalRequest":{"url":{"path":["uauth","user","register","resend-confirmation"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"method":"POST","body":{"mode":"raw","raw":"{\n \"email\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Created","code":201,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"006daad0-468e-42b4-b5a9-028f391efd42","name":"Unauthorized","originalRequest":{"url":{"path":["uauth","user","register","resend-confirmation"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"method":"POST","body":{"mode":"raw","raw":"{\n \"email\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"68fd6338-ae13-41f0-9e6c-4589f270c5d1","name":"Forbidden","originalRequest":{"url":{"path":["uauth","user","register","resend-confirmation"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"method":"POST","body":{"mode":"raw","raw":"{\n \"email\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"ef6313c0-95a0-4b6a-8fcc-4670b8b3cb85","name":"Not Found","originalRequest":{"url":{"path":["uauth","user","register","resend-confirmation"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"method":"POST","body":{"mode":"raw","raw":"{\n \"email\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"a675f7ec-298c-40e0-ba02-d6b2a61ae206","name":"Get user's own data","request":{"name":"Get user's own data","description":{"content":"A user can retrieve their account data.\n\n---\n\n**API consumer:** Synerise User\n","type":"text/plain"},"url":{"path":["uauth","users","my-account"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"e5c48941-2fdd-4365-9b0c-6dd5494417bd","name":"OK","originalRequest":{"url":{"path":["uauth","users","my-account"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"id\": 3733,\n \"email\": \"string\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"displayName\": \"string\",\n \"avatar\": \"string\",\n \"phone\": \"string\",\n \"language\": \"en-US\",\n \"organizationRole\": \"string\",\n \"introduction\": \"string\",\n \"confirmed\": false,\n \"mailAccountId\": 7710,\n \"superAdmin\": true,\n \"created\": \"1969-07-23T16:16:03.668Z\",\n \"updated\": \"2018-03-10T19:31:04.664Z\",\n \"lastLogin\": \"1949-03-17T13:27:25.045Z\",\n \"status\": \"ACTIVE\",\n \"roles\": [\n 6452,\n 3406\n ],\n \"isTheSameUserAsLoggedIn\": true,\n \"description\": \"string\",\n \"isMfaEnabled\": true,\n \"passwordLastModificationDate\": \"1970-02-12T12:20:37.164Z\",\n \"canBeEdited\": true,\n \"dateFormatNotation\": \"US\",\n \"timeFormatNotation\": \"EU\",\n \"numberFormatNotation\": \"US\",\n \"mfaTokenExpirationHours\": 734,\n \"defaultMfaMethod\": \"TOTP_AUTHENTICATOR\",\n \"labels\": [\n \"string\",\n \"string\"\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"48a8e7b5-a88e-47fe-bd9a-7ced919bf5b9","name":"Unauthorized","originalRequest":{"url":{"path":["uauth","users","my-account"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"GET","body":{}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"5daa9f03-67fe-45c1-b14a-95affa71023f","name":"Forbidden","originalRequest":{"url":{"path":["uauth","users","my-account"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"GET","body":{}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"0fc0852e-bccc-4fea-ba9d-bad9154cd932","name":"Not Found","originalRequest":{"url":{"path":["uauth","users","my-account"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"GET","body":{}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"5d51f605-96a0-423d-84bd-86c661f873cf","name":"Update user's own data","request":{"name":"Update user's own data","description":{"content":"A user can update their own details.\n\n---\n\n**API consumer:** Synerise User\n","type":"text/plain"},"url":{"path":["uauth","users","my-account"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"avatar\": \"string\",\n \"phone\": \"string\",\n \"language\": \"pl\",\n \"organizationRole\": \"string\",\n \"introduction\": \"string\",\n \"confirmed\": true,\n \"mailAccountId\": 1507,\n \"description\": \"string\",\n \"dateFormatNotation\": \"EU\",\n \"timeFormatNotation\": \"US\",\n \"numberFormatNotation\": \"US\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"3388c52a-bfbb-498e-9049-454293d686cd","name":"OK","originalRequest":{"url":{"path":["uauth","users","my-account"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"avatar\": \"string\",\n \"phone\": \"string\",\n \"language\": \"pl\",\n \"organizationRole\": \"string\",\n \"introduction\": \"string\",\n \"confirmed\": true,\n \"mailAccountId\": 1507,\n \"description\": \"string\",\n \"dateFormatNotation\": \"EU\",\n \"timeFormatNotation\": \"US\",\n \"numberFormatNotation\": \"US\"\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"id\": 2742,\n \"email\": \"string\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"displayName\": \"string\",\n \"avatar\": \"string\",\n \"phone\": \"string\",\n \"language\": \"es\",\n \"organizationRole\": \"string\",\n \"introduction\": \"string\",\n \"confirmed\": true,\n \"mailAccountId\": 9822,\n \"superAdmin\": true,\n \"created\": \"1969-05-31T01:10:30.806Z\",\n \"updated\": \"1992-06-06T00:16:52.062Z\",\n \"lastLogin\": \"2016-03-30T13:16:33.394Z\",\n \"status\": \"INACTIVE\",\n \"roles\": [\n 2764,\n 9601\n ],\n \"isTheSameUserAsLoggedIn\": true,\n \"description\": \"string\",\n \"isMfaEnabled\": false,\n \"passwordLastModificationDate\": \"1965-03-19T09:39:07.591Z\",\n \"canBeEdited\": true,\n \"dateFormatNotation\": \"EU\",\n \"timeFormatNotation\": \"EU\",\n \"numberFormatNotation\": \"US\",\n \"mfaTokenExpirationHours\": 9093,\n \"defaultMfaMethod\": \"TOTP_AUTHENTICATOR\",\n \"labels\": [\n \"string\",\n \"string\"\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"8563179d-15fd-4b05-a8f3-387fe9d60976","name":"Created","originalRequest":{"url":{"path":["uauth","users","my-account"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"POST","body":{"mode":"raw","raw":"{\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"avatar\": \"string\",\n \"phone\": \"string\",\n \"language\": \"pl\",\n \"organizationRole\": \"string\",\n \"introduction\": \"string\",\n \"confirmed\": true,\n \"mailAccountId\": 1507,\n \"description\": \"string\",\n \"dateFormatNotation\": \"EU\",\n \"timeFormatNotation\": \"US\",\n \"numberFormatNotation\": \"US\"\n}","options":{"raw":{"language":"json"}}}},"status":"Created","code":201,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"ea699a8e-a2d9-484f-b025-5ad05edc4f2d","name":"Unauthorized","originalRequest":{"url":{"path":["uauth","users","my-account"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"POST","body":{"mode":"raw","raw":"{\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"avatar\": \"string\",\n \"phone\": \"string\",\n \"language\": \"pl\",\n \"organizationRole\": \"string\",\n \"introduction\": \"string\",\n \"confirmed\": true,\n \"mailAccountId\": 1507,\n \"description\": \"string\",\n \"dateFormatNotation\": \"EU\",\n \"timeFormatNotation\": \"US\",\n \"numberFormatNotation\": \"US\"\n}","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"b640fea3-1956-4c42-9b32-4d6be63576d5","name":"Forbidden","originalRequest":{"url":{"path":["uauth","users","my-account"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"POST","body":{"mode":"raw","raw":"{\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"avatar\": \"string\",\n \"phone\": \"string\",\n \"language\": \"pl\",\n \"organizationRole\": \"string\",\n \"introduction\": \"string\",\n \"confirmed\": true,\n \"mailAccountId\": 1507,\n \"description\": \"string\",\n \"dateFormatNotation\": \"EU\",\n \"timeFormatNotation\": \"US\",\n \"numberFormatNotation\": \"US\"\n}","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"846673dd-5246-4732-b345-8af06f35b288","name":"Not Found","originalRequest":{"url":{"path":["uauth","users","my-account"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"POST","body":{"mode":"raw","raw":"{\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"avatar\": \"string\",\n \"phone\": \"string\",\n \"language\": \"pl\",\n \"organizationRole\": \"string\",\n \"introduction\": \"string\",\n \"confirmed\": true,\n \"mailAccountId\": 1507,\n \"description\": \"string\",\n \"dateFormatNotation\": \"EU\",\n \"timeFormatNotation\": \"US\",\n \"numberFormatNotation\": \"US\"\n}","options":{"raw":{"language":"json"}}}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"6c159e0d-8401-4978-8606-d200f0c7032b","name":"Delete user's own account","request":{"name":"Delete user's own account","description":{"content":"A user can delete their own account.\n\n---\n\n**API consumer:** Synerise User\n","type":"text/plain"},"url":{"path":["uauth","users","my-account"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"method":"DELETE","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"ac33c450-d5c1-4895-a89c-d9c4733ab5e3","name":"OK","originalRequest":{"url":{"path":["uauth","users","my-account"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"DELETE","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"42a85aa4-8cfc-4dfa-9736-674dbbe4adbb","name":"Unauthorized","originalRequest":{"url":{"path":["uauth","users","my-account"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"DELETE","body":{}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"7a7ce00a-cd58-4820-97cb-61a704d4eaf7","name":"Forbidden","originalRequest":{"url":{"path":["uauth","users","my-account"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"DELETE","body":{}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}],"event":[]},{"id":"550d4c57-4815-4a8a-b1f2-98792d8a8882","name":"Directory","description":{"content":"","type":"text/plain"},"item":[{"id":"f3d8c916-845f-46f3-a087-c4b6abd8e38d","name":"List managed domains","request":{"name":"List managed domains","description":{"content":"Retrieve a list of all domains managed by the workspace.\n\n---\n\n**API consumer:** Synerise User\n\n**User role permission required:** `managed_domains: read`\n","type":"text/plain"},"url":{"path":["uauth","managed-domains"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"page","value":"1","description":"Page number (first page is 1)"},{"disabled":false,"key":"size","value":"20","description":"The number of entries on a page"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":null},"response":[{"id":"d5e7c77d-ade7-40d7-b5b5-dbffafecadef","name":"OK","originalRequest":{"url":{"path":["uauth","managed-domains"],"host":["{{baseUrl}}"],"query":[{"key":"page","value":"1"},{"key":"size","value":"20"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"meta\": {\n \"pagination\": {\n \"value\": \"\"\n }\n },\n \"data\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"ea78fc22-fd40-4e5c-987a-f559db9f788e","name":"Created","originalRequest":{"url":{"path":["uauth","managed-domains"],"host":["{{baseUrl}}"],"query":[{"key":"page","value":"1"},{"key":"size","value":"20"}],"variable":[]},"method":"GET","body":{}},"status":"Created","code":201,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"e728a0de-9a6f-4d7e-95c1-0b0e728ed485","name":"Unauthorized","originalRequest":{"url":{"path":["uauth","managed-domains"],"host":["{{baseUrl}}"],"query":[{"key":"page","value":"1"},{"key":"size","value":"20"}],"variable":[]},"method":"GET","body":{}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"fc8b848d-0fd6-4fe6-9282-5f57db782839","name":"Forbidden","originalRequest":{"url":{"path":["uauth","managed-domains"],"host":["{{baseUrl}}"],"query":[{"key":"page","value":"1"},{"key":"size","value":"20"}],"variable":[]},"method":"GET","body":{}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"5f15004b-1a42-4524-b28d-aa85491aaab6","name":"Not Found","originalRequest":{"url":{"path":["uauth","managed-domains"],"host":["{{baseUrl}}"],"query":[{"key":"page","value":"1"},{"key":"size","value":"20"}],"variable":[]},"method":"GET","body":{}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"06cf1cf5-7b53-4eee-800f-b89d014711e1","name":"Delete managed domain","request":{"name":"Delete managed domain","description":{"content":"Remove management settings for a domain.\n\n---\n\n**API consumer:** Synerise User\n\n**User role permission required:** `managed_domains: delete`\n","type":"text/plain"},"url":{"path":["uauth","managed-domains"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"}],"method":"DELETE","auth":null,"body":{"mode":"raw","raw":"{\n \"domain\": \"synerise.com\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"353a7d02-175b-42d7-8015-951d2b1c7806","name":"Created","originalRequest":{"url":{"path":["uauth","managed-domains"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"method":"DELETE","body":{"mode":"raw","raw":"{\n \"domain\": \"synerise.com\"\n}","options":{"raw":{"language":"json"}}}},"status":"Created","code":201,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"23dd70e9-4317-4f19-afd0-89e2522eb690","name":"No Content","originalRequest":{"url":{"path":["uauth","managed-domains"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"method":"DELETE","body":{"mode":"raw","raw":"{\n \"domain\": \"synerise.com\"\n}","options":{"raw":{"language":"json"}}}},"status":"No Content","code":204,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"9bc45397-001a-4c61-a77c-81e0d1bca710","name":"Unauthorized","originalRequest":{"url":{"path":["uauth","managed-domains"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"method":"DELETE","body":{"mode":"raw","raw":"{\n \"domain\": \"synerise.com\"\n}","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"45888076-9bf0-41d2-a787-53e442579124","name":"Forbidden","originalRequest":{"url":{"path":["uauth","managed-domains"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"method":"DELETE","body":{"mode":"raw","raw":"{\n \"domain\": \"synerise.com\"\n}","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"0f1970ab-031b-4803-a2b7-e00b1d1061d4","name":"Not Found","originalRequest":{"url":{"path":["uauth","managed-domains"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"method":"DELETE","body":{"mode":"raw","raw":"{\n \"domain\": \"synerise.com\"\n}","options":{"raw":{"language":"json"}}}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"0b9f86b8-d4ed-4ff7-8f9a-aa5dbdf870d4","name":"Initialize managed domain","request":{"name":"Initialize managed domain","description":{"content":"Generate a verification string for a domain. This string is then used in [this endpoint](#operation/verifyManagedDomainUsingPOST). The verification string for a particular workspace is always the same.\n\n---\n\n**API consumer:** Synerise User\n\n**User role permission required:** `managed_domains: create`\n","type":"text/plain"},"url":{"path":["uauth","managed-domains","initialize-code"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":null},"response":[{"id":"7ffc74c5-3311-431c-9d0d-7c673b5988c2","name":"OK","originalRequest":{"url":{"path":["uauth","managed-domains","initialize-code"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"verificationCode\": \"743e4de1-44fb-9049-84b9-746ec779cb10\",\n \"businessProfileId\": 1139\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"42e5d2e2-142b-4817-bb40-4c41fb11c82d","name":"Unauthorized","originalRequest":{"url":{"path":["uauth","managed-domains","initialize-code"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"method":"GET","body":{}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"f0c78116-23ab-4d64-85f0-62f0c9f28833","name":"Forbidden","originalRequest":{"url":{"path":["uauth","managed-domains","initialize-code"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"method":"GET","body":{}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"75fcc008-6569-4304-904c-f837d3f6c9d8","name":"Not Found","originalRequest":{"url":{"path":["uauth","managed-domains","initialize-code"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"method":"GET","body":{}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"070c475d-1163-4577-946d-674fcb89c9a1","name":"Verify managed domain","request":{"name":"Verify managed domain","description":{"content":"Verify a managed domain to assign it to a workspace. All users who belong to the domain are managed by that workspace.\n\n---\n\n**API consumer:** Synerise User\n\n**User role permission required:** `managed_domains: create`\n","type":"text/plain"},"url":{"path":["uauth","managed-domains","verification"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":null,"body":{"mode":"raw","raw":"{\n \"domain\": \"synerise.com\",\n \"verificationMethod\": \"FILE_CHECK\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"e2fad01c-53ce-435c-9291-00aaaced687e","name":"OK","originalRequest":{"url":{"path":["uauth","managed-domains","verification"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"domain\": \"synerise.com\",\n \"verificationMethod\": \"FILE_CHECK\"\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"id\": 4388.474483770816,\n \"domain\": \"synerise.com\",\n \"created\": \"1978-04-05T20:23:48.098Z\",\n \"verificationMethod\": \"INTERNAL\",\n \"verificationStatus\": \"NOT_VERIFIED\",\n \"updated\": \"2021-07-28T22:11:34.084Z\",\n \"managedByProfile\": 4857,\n \"usersCount\": 6794.173401445781\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"75ca46a6-37f2-4340-a26a-4efddb2d30cc","name":"Created","originalRequest":{"url":{"path":["uauth","managed-domains","verification"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"method":"POST","body":{"mode":"raw","raw":"{\n \"domain\": \"synerise.com\",\n \"verificationMethod\": \"FILE_CHECK\"\n}","options":{"raw":{"language":"json"}}}},"status":"Created","code":201,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"8b0d9047-ff14-4561-909f-5b51ce320b40","name":"Unauthorized","originalRequest":{"url":{"path":["uauth","managed-domains","verification"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"method":"POST","body":{"mode":"raw","raw":"{\n \"domain\": \"synerise.com\",\n \"verificationMethod\": \"FILE_CHECK\"\n}","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"0382ffc3-93e1-4e57-b975-2db151aedb6d","name":"Forbidden","originalRequest":{"url":{"path":["uauth","managed-domains","verification"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"method":"POST","body":{"mode":"raw","raw":"{\n \"domain\": \"synerise.com\",\n \"verificationMethod\": \"FILE_CHECK\"\n}","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"07f0a042-9a8e-44c6-a97d-e324c02254bc","name":"Not Found","originalRequest":{"url":{"path":["uauth","managed-domains","verification"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"method":"POST","body":{"mode":"raw","raw":"{\n \"domain\": \"synerise.com\",\n \"verificationMethod\": \"FILE_CHECK\"\n}","options":{"raw":{"language":"json"}}}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}],"event":[]},{"id":"578408a3-4961-4817-82f5-d65492c03e98","name":"Recommendation campaigns","description":{"content":"","type":"text/plain"},"item":[{"id":"caf561b8-f09d-4f5d-8751-060a6ff9e5c3","name":"Get all recommendation campaigns","request":{"name":"Get all recommendation campaigns","description":{"content":"Fetch all recommendation campaigns.\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User\n\n**API key permission required:** `RECOMMENDATIONS_V2_MANY_CAMPAIGN_READ`\n\n**User role permission required:** `campaigns_recommendations: read`\n","type":"text/plain"},"url":{"path":["recommendations","v2","campaigns"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"page","value":"1","description":"Page number"},{"disabled":false,"key":"limit","value":"50","description":"Maximum number of campaigns on a page"},{"disabled":false,"key":"sortBy","value":"createdAt:asc","description":"Name of the field by which data will be sorted. The sort direction may be embedded\nas `field:direction` (universal-lists form, e.g. `createdAt:asc`); when present it\ntakes precedence over the `ordering` parameter.\n"},{"disabled":false,"key":"ordering","value":"desc","description":"Sorting order, used when `sortBy` carries no embedded direction"},{"disabled":false,"key":"includeMeta","value":"false","description":"If true, a `meta` JSON block with pagination data is included in the response body.\nIf false, the pagination data is included in the response headers.\n"},{"disabled":false,"key":"type","value":"string","description":"Filters the results by campaign type."},{"disabled":false,"key":"state","value":"draft","description":"Shows only results with states matching this parameter. When this parameter is omitted, all campaigns are returned regardless of state."},{"disabled":false,"key":"state","value":"paused","description":"Shows only results with states matching this parameter. When this parameter is omitted, all campaigns are returned regardless of state."},{"disabled":false,"key":"search","value":"string","description":"Searches campaigns by the specified phrase in their `id` and `title`."}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"2fae8b18-6b4d-487e-93bb-f06946cdced1","name":"Returns paginated campaigns. If `showMeta` was set to `true`, the metadata is included in the JSON response. If it was set to `false`, the metadata is included in the headers.","originalRequest":{"url":{"path":["recommendations","v2","campaigns"],"host":["{{baseUrl}}"],"query":[{"key":"page","value":"1"},{"key":"limit","value":"50"},{"key":"sortBy","value":"createdAt:asc"},{"key":"ordering","value":"desc"},{"key":"includeMeta","value":"false"},{"key":"type","value":"string"},{"key":"state","value":"draft"},{"key":"state","value":"active"},{"key":"search","value":"string"}],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"disabled":false,"description":"Links to neighboring pages, first page, and last page in pagination","key":"Link","value":"string"},{"disabled":false,"description":"Total number of campaigns","key":"X-Pagination-Total-Count","value":"5612"},{"disabled":false,"description":"Total number of pages","key":"X-Pagination-Total-Pages","value":"5612"},{"disabled":false,"description":"The current page","key":"X-Pagination-Page","value":"5612"},{"disabled":false,"description":"Maximal number of items on a page","key":"X-Pagination-Limit","value":"5612"},{"disabled":false,"description":"The column (attribute) that the campaigns were sorted by","key":"X-Pagination-Sorted-By","value":"string"},{"disabled":false,"description":"Sorting order","key":"X-Pagination-Ordering","value":"string"},{"key":"Content-Type","value":"application/json"}],"body":"{\n \"meta\": {\n \"totalPages\": 3888.0088220366883,\n \"totalCount\": 8464.93052648341,\n \"page\": 5341.488099010937,\n \"limit\": 6314.058511493206,\n \"sortedBy\": \"string\",\n \"ordering\": \"string\",\n \"code\": 5068.136487482431,\n \"link\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n },\n \"data\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"extras\": {\n \"states\": {\n \"active\": {\n \"value\": \"\"\n },\n \"draft\": {\n \"value\": \"\"\n },\n \"paused\": {\n \"value\": \"\"\n }\n }\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"141292e6-cf5d-40b4-b7c7-b5217c57e29b","name":"Could not find campaigns","originalRequest":{"url":{"path":["recommendations","v2","campaigns"],"host":["{{baseUrl}}"],"query":[{"key":"page","value":"1"},{"key":"limit","value":"50"},{"key":"sortBy","value":"createdAt:asc"},{"key":"ordering","value":"desc"},{"key":"includeMeta","value":"false"},{"key":"type","value":"string"},{"key":"state","value":"draft"},{"key":"state","value":"active"},{"key":"search","value":"string"}],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1963-08-12T14:54:43.321Z\",\n \"status\": 2878,\n \"message\": \"string\",\n \"error\": \"string\",\n \"path\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"40ab2e7a-8117-4dc8-9a8e-11771887c32a","name":"An error occurred","originalRequest":{"url":{"path":["recommendations","v2","campaigns"],"host":["{{baseUrl}}"],"query":[{"key":"page","value":"1"},{"key":"limit","value":"50"},{"key":"sortBy","value":"createdAt:asc"},{"key":"ordering","value":"desc"},{"key":"includeMeta","value":"false"},{"key":"type","value":"string"},{"key":"state","value":"draft"},{"key":"state","value":"active"},{"key":"search","value":"string"}],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1963-08-12T14:54:43.321Z\",\n \"status\": 2878,\n \"message\": \"string\",\n \"error\": \"string\",\n \"path\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"af1345e3-31d1-4608-9c1b-6f3174d532b1","name":"Create a recommendation campaign","request":{"name":"Create a recommendation campaign","description":{"content":"Create a new recommendation campaign.\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User\n\n**API key permission required:** `RECOMMENDATIONS_V2_CAMPAIGN_CREATE`\n\n**User role permission required:** `campaigns_recommendations: create`\n","type":"text/plain"},"url":{"path":["recommendations","v2","campaigns"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"value\": \"\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"00aea529-341c-495d-9acf-c4c469312c8a","name":"OK campaign has been returned","originalRequest":{"url":{"path":["recommendations","v2","campaigns"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"value\": \"\"\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"value\": \"\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"0bf14456-5fcf-4c0a-98f7-3d895d519a88","name":"An error occurred","originalRequest":{"url":{"path":["recommendations","v2","campaigns"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"value\": \"\"\n}","options":{"raw":{"language":"json"}}}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1963-08-12T14:54:43.321Z\",\n \"status\": 2878,\n \"message\": \"string\",\n \"error\": \"string\",\n \"path\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"1fcf2d58-0d22-49d5-a774-e9a623d5098e","name":"Get recommendation campaign details","request":{"name":"Get recommendation campaign details","description":{"content":"Retrieve the details of a single campaign.\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User\n\n**API key permission required:** `RECOMMENDATIONS_V2_SINGLE_CAMPAIGN_READ`\n\n**User role permission required:** `campaigns_recommendations: read`\n","type":"text/plain"},"url":{"path":["recommendations","v2","campaigns",":campaignId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"campaignId","description":"(Required) ID of the campaign"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"fbd5ba90-c866-4417-bf59-81df23a03d9c","name":"Data of a single campaign","originalRequest":{"url":{"path":["recommendations","v2","campaigns",":campaignId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"campaignId","description":"(Required) ID of the campaign"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"value\": \"\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"1a6f2529-9386-451b-9c0b-6adb7c17e69f","name":"Could not find campaign","originalRequest":{"url":{"path":["recommendations","v2","campaigns",":campaignId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"campaignId","description":"(Required) ID of the campaign"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1963-08-12T14:54:43.321Z\",\n \"status\": 2878,\n \"message\": \"string\",\n \"error\": \"string\",\n \"path\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"31a3a8fd-a08c-48e2-b5f3-95bce8ac7e40","name":"An error occurred","originalRequest":{"url":{"path":["recommendations","v2","campaigns",":campaignId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"campaignId","description":"(Required) ID of the campaign"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1963-08-12T14:54:43.321Z\",\n \"status\": 2878,\n \"message\": \"string\",\n \"error\": \"string\",\n \"path\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"0fa95e1b-260a-4ef9-9399-b26f0cf8204c","name":"Update a recommendation campaign","request":{"name":"Update a recommendation campaign","description":{"content":"Update a recommendation campaign by changing the parameters or copying the definition from another campaign.\n\nWhen you copy from another campaign:\n- the following campaign data is NOT updated:\n - `title`\n - `state`\n - `start_date`\n - `end_date`\n - `campaignId`\n - `createdAt`\n- `modified_by_user_id` changes to the user who performed the update\n\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User\n\n**API key permission required:** `RECOMMENDATIONS_V2_CAMPAIGN_UPDATE`\n\n**User role permission required:** `campaigns_recommendations: update`\n","type":"text/plain"},"url":{"path":["recommendations","v2","campaigns",":campaignId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"campaignId","description":"(Required) ID of the campaign"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"value\": \"\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"3d40887a-015f-4abd-806c-71b8361c689d","name":"Campaign updated and returned","originalRequest":{"url":{"path":["recommendations","v2","campaigns",":campaignId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"campaignId","description":"(Required) ID of the campaign"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"value\": \"\"\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"value\": \"\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"c2d2e3ed-8a56-4d62-a7d8-a169bca49d3f","name":"Could not find campaign","originalRequest":{"url":{"path":["recommendations","v2","campaigns",":campaignId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"campaignId","description":"(Required) ID of the campaign"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"value\": \"\"\n}","options":{"raw":{"language":"json"}}}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1963-08-12T14:54:43.321Z\",\n \"status\": 2878,\n \"message\": \"string\",\n \"error\": \"string\",\n \"path\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"ada3dc0b-acd8-49ac-9cf9-0ff2ce137f02","name":"An error occurred","originalRequest":{"url":{"path":["recommendations","v2","campaigns",":campaignId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"campaignId","description":"(Required) ID of the campaign"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"value\": \"\"\n}","options":{"raw":{"language":"json"}}}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1963-08-12T14:54:43.321Z\",\n \"status\": 2878,\n \"message\": \"string\",\n \"error\": \"string\",\n \"path\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"0cce30cd-de0f-4c56-b6bc-c2d2f39c5d5b","name":"Delete a recommendation campaign","request":{"name":"Delete a recommendation campaign","description":{"content":"Delete a recommendation campaign. This operation is irreversible.\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User\n\n**API key permission required:** `RECOMMENDATIONS_V2_CAMPAIGN_DELETE`\n\n**User role permission required:** `campaigns_recommendations: delete`\n","type":"text/plain"},"url":{"path":["recommendations","v2","campaigns",":campaignId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"campaignId","description":"(Required) ID of the campaign"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"c30f7d16-4c27-4911-a407-15e2956b3a1a","name":"OK campaign has been deleted","originalRequest":{"url":{"path":["recommendations","v2","campaigns",":campaignId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"campaignId","description":"(Required) ID of the campaign"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"value\": \"\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"45560556-ea60-4ca3-91ba-68bbb23eb9bc","name":"Could not find campaign","originalRequest":{"url":{"path":["recommendations","v2","campaigns",":campaignId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"campaignId","description":"(Required) ID of the campaign"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1963-08-12T14:54:43.321Z\",\n \"status\": 2878,\n \"message\": \"string\",\n \"error\": \"string\",\n \"path\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"518437af-36df-443a-97a9-0c32290d04a1","name":"An error occurred","originalRequest":{"url":{"path":["recommendations","v2","campaigns",":campaignId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"campaignId","description":"(Required) ID of the campaign"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1963-08-12T14:54:43.321Z\",\n \"status\": 2878,\n \"message\": \"string\",\n \"error\": \"string\",\n \"path\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"9d1c5101-a381-4dde-a4f8-b6daf77e3d6d","name":"Change campaigns' states","request":{"name":"Change campaigns' states","description":{"content":"Change the status of one or more campaigns.\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User\n\n**API key permission required:** `RECOMMENDATIONS_V2_STATE_CAMPAIGN_UPDATE`\n\n**User role permission required:** `campaigns_recommendations: update`\n","type":"text/plain"},"url":{"path":["recommendations","v2","campaigns","state"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"state\": \"active\",\n \"ids\": [\n \"string\"\n ]\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"31e46481-b140-46f3-ad9e-22344f96c29d","name":"Campaigns status changed","originalRequest":{"url":{"path":["recommendations","v2","campaigns","state"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"state\": \"active\",\n \"ids\": [\n \"string\"\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"[\n \"string\",\n \"string\"\n]","cookie":[],"_postman_previewlanguage":"json"},{"id":"6604c830-74c0-4dd7-9d53-a4c7e2f9a4cd","name":"An error occurred","originalRequest":{"url":{"path":["recommendations","v2","campaigns","state"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"state\": \"active\",\n \"ids\": [\n \"string\"\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1963-08-12T14:54:43.321Z\",\n \"status\": 2878,\n \"message\": \"string\",\n \"error\": \"string\",\n \"path\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"a479eb1c-c97e-4b9f-ab92-3d82ec72b2a5","name":"Copy a recommendation campaign","request":{"name":"Copy a recommendation campaign","description":{"content":"Copy a campaign. The copied campaign's `state` will be `draft` and `slug` will be undefined.\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User\n\n**API key permission required:** `RECOMMENDATIONS_V2_COPY_CAMPAIGN_CREATE`\n\n**User role permission required:** `campaigns_recommendations: create`\n","type":"text/plain"},"url":{"path":["recommendations","v2","campaigns",":campaignId","copy"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"campaignId","description":"(Required) ID of the campaign"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"4b1764cc-dfe8-4d3d-89e2-21be5a1c93d2","name":"Copy created and returned","originalRequest":{"url":{"path":["recommendations","v2","campaigns",":campaignId","copy"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"campaignId","description":"(Required) ID of the campaign"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"value\": \"\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"c2e82984-0d10-42ff-9b33-2239ac4a1100","name":"Could not find campaign","originalRequest":{"url":{"path":["recommendations","v2","campaigns",":campaignId","copy"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"campaignId","description":"(Required) ID of the campaign"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1963-08-12T14:54:43.321Z\",\n \"status\": 2878,\n \"message\": \"string\",\n \"error\": \"string\",\n \"path\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"b9d367fa-92a9-4d68-9290-725f996b6e42","name":"An error occurred","originalRequest":{"url":{"path":["recommendations","v2","campaigns",":campaignId","copy"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"campaignId","description":"(Required) ID of the campaign"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1963-08-12T14:54:43.321Z\",\n \"status\": 2878,\n \"message\": \"string\",\n \"error\": \"string\",\n \"path\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"a8a16e86-2261-4943-81a6-163287e295af","name":"Get simplified recommendation campaigns","request":{"name":"Get simplified recommendation campaigns","description":{"content":"Fetch simplified recommendation campaign data.\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User\n\n**API key permission required:** `RECOMMENDATIONS_V2_MANY_SIMPLIFIED_CAMPAIGN_READ`\n\n**User role permission required:** `campaigns_recommendations: read`\n","type":"text/plain"},"url":{"path":["recommendations","v2","campaigns","simplified"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"type","value":"string","description":"Filter by campaign type."},{"disabled":false,"key":"type","value":"string","description":"Filter by campaign type."},{"disabled":false,"key":"state","value":"draft","description":"Filter by states."},{"disabled":false,"key":"state","value":"paused","description":"Filter by states."}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"3d06318c-352b-419e-bacf-fdbbea57c9e2","name":"Simplified campaigns returned","originalRequest":{"url":{"path":["recommendations","v2","campaigns","simplified"],"host":["{{baseUrl}}"],"query":[{"key":"type","value":"string"},{"key":"type","value":"string"},{"key":"state","value":"draft"},{"key":"state","value":"active"}],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"[\n {\n \"campaignId\": \"string\",\n \"title\": \"string\",\n \"type\": \"string\"\n },\n {\n \"campaignId\": \"string\",\n \"title\": \"string\",\n \"type\": \"string\"\n }\n]","cookie":[],"_postman_previewlanguage":"json"},{"id":"2133400b-5518-4d6a-97e4-3550847f6f8b","name":"Could not find campaign","originalRequest":{"url":{"path":["recommendations","v2","campaigns","simplified"],"host":["{{baseUrl}}"],"query":[{"key":"type","value":"string"},{"key":"type","value":"string"},{"key":"state","value":"draft"},{"key":"state","value":"active"}],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1963-08-12T14:54:43.321Z\",\n \"status\": 2878,\n \"message\": \"string\",\n \"error\": \"string\",\n \"path\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"9fe2f1d0-5066-4989-a501-fba73a76bdb7","name":"An error occurred","originalRequest":{"url":{"path":["recommendations","v2","campaigns","simplified"],"host":["{{baseUrl}}"],"query":[{"key":"type","value":"string"},{"key":"type","value":"string"},{"key":"state","value":"draft"},{"key":"state","value":"active"}],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1963-08-12T14:54:43.321Z\",\n \"status\": 2878,\n \"message\": \"string\",\n \"error\": \"string\",\n \"path\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}],"event":[]},{"id":"70eb68f9-4147-4e8c-97c7-5bdeb69ab18a","name":"Recommendation statistics","description":{"content":"","type":"text/plain"},"item":[{"id":"99939f72-df91-499d-a606-6a63d0c0bcf8","name":"Get recommendation campaign statistics","request":{"name":"Get recommendation campaign statistics","description":{"content":"Retrieves the statistics of campaigns defined in the request.\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User\n\n**API key permission required:** `AI_STATS_READ`\n\n**User role permission required:** `campaigns_recommendations: read`\n","type":"text/plain"},"url":{"path":["recommendations","v2","campaigns","stats"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"campaignIds\": [\n \"string\"\n ],\n \"from\": \"1970-08-05\",\n \"to\": \"2000-04-25\",\n \"timeZone\": \"Europe/Warsaw\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"945dbda4-ace0-4f98-bc4b-e0ed794392f0","name":"Statistics returned","originalRequest":{"url":{"path":["recommendations","v2","campaigns","stats"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"campaignIds\": [\n \"string\"\n ],\n \"from\": \"1970-08-05\",\n \"to\": \"2000-04-25\",\n \"timeZone\": \"Europe/Warsaw\"\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"data\": {\n \"summary\": {\n \"value\": \"\"\n },\n \"byCampaign\": {\n \"value\": \"\"\n }\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"000c516b-75b2-43af-a53a-39ba4df4c923","name":"Service error","originalRequest":{"url":{"path":["recommendations","v2","campaigns","stats"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"campaignIds\": [\n \"string\"\n ],\n \"from\": \"1970-08-05\",\n \"to\": \"2000-04-25\",\n \"timeZone\": \"Europe/Warsaw\"\n}","options":{"raw":{"language":"json"}}}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"httpStatus\": 500,\n \"errorCode\": 8992,\n \"timestamp\": \"1994-03-23T16:52:22.343Z\",\n \"message\": \"string\",\n \"traceId\": \"string\",\n \"help\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"63cdc378-227b-49bf-b63a-23ba82534f4f","name":"Incorrect request","originalRequest":{"url":{"path":["recommendations","v2","campaigns","stats"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"campaignIds\": [\n \"string\"\n ],\n \"from\": \"1970-08-05\",\n \"to\": \"2000-04-25\",\n \"timeZone\": \"Europe/Warsaw\"\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"httpStatus\": 500,\n \"errorCode\": 8992,\n \"timestamp\": \"1994-03-23T16:52:22.343Z\",\n \"message\": \"string\",\n \"traceId\": \"string\",\n \"help\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"dec308c6-e7f1-4585-ad03-e7722ec7a197","name":"Get global recommendation campaign statistics","request":{"name":"Get global recommendation campaign statistics","description":{"content":"Retrieves the statistics of all recommendation campaigns.\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User\n\n**API key permission required:** `AI_STATS_READ`\n\n**User role permission required:** `campaigns_recommendations: read`\n","type":"text/plain"},"url":{"path":["recommendations","v2","campaigns","stats","global"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"from","value":"1987-03-02","description":"Upper bound of the interval for which the statistics will be retrieved. \nMust be provided with `from`, otherwise the filter is treated as unspecified. \nIf not specified, the interval is last 7 days.\n"},{"disabled":false,"key":"to","value":"1987-03-02","description":"Lower bound of the interval for which the statistics will be retrieved.\nIf not specified, the interval is last 7 days.\n"},{"disabled":false,"key":"timeZone","value":"Europe/Warsaw","description":"Time zone identifier."}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"cae45554-365d-4512-b0e5-c970e8fd81e3","name":"Statistics returned","originalRequest":{"url":{"path":["recommendations","v2","campaigns","stats","global"],"host":["{{baseUrl}}"],"query":[{"key":"from","value":"1987-03-02"},{"key":"to","value":"1987-03-02"},{"key":"timeZone","value":"Europe/Warsaw"}],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"data\": {\n \"summary\": {\n \"value\": \"\"\n },\n \"byDate\": {\n \"value\": \"\"\n }\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"d4d192d1-944b-4c40-8890-f6c7d38f67be","name":"Service error","originalRequest":{"url":{"path":["recommendations","v2","campaigns","stats","global"],"host":["{{baseUrl}}"],"query":[{"key":"from","value":"1987-03-02"},{"key":"to","value":"1987-03-02"},{"key":"timeZone","value":"Europe/Warsaw"}],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"httpStatus\": 500,\n \"errorCode\": 8992,\n \"timestamp\": \"1994-03-23T16:52:22.343Z\",\n \"message\": \"string\",\n \"traceId\": \"string\",\n \"help\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"178a7c80-f424-48bb-8773-dab6b26102b2","name":"Incorrect request","originalRequest":{"url":{"path":["recommendations","v2","campaigns","stats","global"],"host":["{{baseUrl}}"],"query":[{"key":"from","value":"1987-03-02"},{"key":"to","value":"1987-03-02"},{"key":"timeZone","value":"Europe/Warsaw"}],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"httpStatus\": 500,\n \"errorCode\": 8992,\n \"timestamp\": \"1994-03-23T16:52:22.343Z\",\n \"message\": \"string\",\n \"traceId\": \"string\",\n \"help\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"e18b0d91-eef2-4955-bf74-072c97db384b","name":"Get recommendation campaign statistics","request":{"name":"Get recommendation campaign statistics","description":{"content":"Retrieves the statistics of a single recommendation campaign.\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User\n\n**API key permission required:** `AI_STATS_READ`\n\n**User role permission required:** `campaigns_recommendations: read`\n","type":"text/plain"},"url":{"path":["recommendations","v2","campaigns",":campaignId","stats"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"from","value":"1987-03-02","description":"Upper bound of the interval for which the statistics will be retrieved. \nMust be provided with `from`, otherwise the filter is treated as unspecified. \nIf not specified, the interval is last 7 days.\n"},{"disabled":false,"key":"to","value":"1987-03-02","description":"Lower bound of the interval for which the statistics will be retrieved.\nIf not specified, the interval is last 7 days.\n"},{"disabled":false,"key":"timeZone","value":"Europe/Warsaw","description":"Time zone identifier."}],"variable":[{"disabled":false,"type":"any","value":"50NCGoRK0VRb","key":"campaignId","description":"(Required) ID of the recommendation campaign"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"b1cecaf2-819c-4fc0-8d00-aa173d245766","name":"Statistics returned","originalRequest":{"url":{"path":["recommendations","v2","campaigns",":campaignId","stats"],"host":["{{baseUrl}}"],"query":[{"key":"from","value":"1987-03-02"},{"key":"to","value":"1987-03-02"},{"key":"timeZone","value":"Europe/Warsaw"}],"variable":[{"disabled":false,"type":"any","value":"50NCGoRK0VRb","key":"campaignId","description":"(Required) ID of the recommendation campaign"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"data\": {\n \"summary\": {\n \"value\": \"\"\n },\n \"byDate\": {\n \"value\": \"\"\n }\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"c541b851-8ea1-4e7e-a763-70557c9d4b4e","name":"Service error","originalRequest":{"url":{"path":["recommendations","v2","campaigns",":campaignId","stats"],"host":["{{baseUrl}}"],"query":[{"key":"from","value":"1987-03-02"},{"key":"to","value":"1987-03-02"},{"key":"timeZone","value":"Europe/Warsaw"}],"variable":[{"disabled":false,"type":"any","value":"50NCGoRK0VRb","key":"campaignId","description":"(Required) ID of the recommendation campaign"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"httpStatus\": 500,\n \"errorCode\": 8992,\n \"timestamp\": \"1994-03-23T16:52:22.343Z\",\n \"message\": \"string\",\n \"traceId\": \"string\",\n \"help\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"5bc013a8-3a6c-434f-8ba4-3606b01f1e40","name":"Incorrect request","originalRequest":{"url":{"path":["recommendations","v2","campaigns",":campaignId","stats"],"host":["{{baseUrl}}"],"query":[{"key":"from","value":"1987-03-02"},{"key":"to","value":"1987-03-02"},{"key":"timeZone","value":"Europe/Warsaw"}],"variable":[{"disabled":false,"type":"any","value":"50NCGoRK0VRb","key":"campaignId","description":"(Required) ID of the recommendation campaign"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"httpStatus\": 500,\n \"errorCode\": 8992,\n \"timestamp\": \"1994-03-23T16:52:22.343Z\",\n \"message\": \"string\",\n \"traceId\": \"string\",\n \"help\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"c5fd72f1-122d-41e5-9a3c-08af7ca50070","name":"Get statistics for top items in a campaign","request":{"name":"Get statistics for top items in a campaign","description":{"content":"Retrieves the statistics of top products for a single recommendation campaign.\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User\n\n**API key permission required:** `AI_STATS_READ`\n\n**User role permission required:** `campaigns_recommendations: read`\n","type":"text/plain"},"url":{"path":["recommendations","v2","campaigns",":campaignId","products","stats"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"from","value":"1987-03-02","description":"Upper bound of the interval for which the statistics will be retrieved. \nMust be provided with `from`, otherwise the filter is treated as unspecified. \nIf not specified, the interval is last 7 days.\n"},{"disabled":false,"key":"to","value":"1987-03-02","description":"Lower bound of the interval for which the statistics will be retrieved.\nIf not specified, the interval is last 7 days.\n"},{"disabled":false,"key":"timeZone","value":"Europe/Warsaw","description":"Time zone identifier."},{"disabled":false,"key":"metric","value":"views","description":"The response will include statistics for up to 10 top-performing items according to the selected metric, sorted from best to worst.\nIf not specified, the default metric is `views`.\n- views - the number of displayed recommendation frames.\n- generations - the number of generated recommendation frames.\n- clicks - the number of times an item in a recommendation frame was clicked.\n- charges - the number of transactions caused by the recommendation.\n- revenue - the revenue generated by the recommendation.\n"}],"variable":[{"disabled":false,"type":"any","value":"50NCGoRK0VRb","key":"campaignId","description":"(Required) ID of the recommendation campaign"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"33214a0d-2b62-4485-85b4-fb47663127dc","name":"Statistics returned","originalRequest":{"url":{"path":["recommendations","v2","campaigns",":campaignId","products","stats"],"host":["{{baseUrl}}"],"query":[{"key":"from","value":"1987-03-02"},{"key":"to","value":"1987-03-02"},{"key":"timeZone","value":"Europe/Warsaw"},{"key":"metric","value":"views"}],"variable":[{"disabled":false,"type":"any","value":"50NCGoRK0VRb","key":"campaignId","description":"(Required) ID of the recommendation campaign"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"data\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"d11e5e6f-e4d0-4f87-9f93-b4f55c8c6319","name":"Service error","originalRequest":{"url":{"path":["recommendations","v2","campaigns",":campaignId","products","stats"],"host":["{{baseUrl}}"],"query":[{"key":"from","value":"1987-03-02"},{"key":"to","value":"1987-03-02"},{"key":"timeZone","value":"Europe/Warsaw"},{"key":"metric","value":"views"}],"variable":[{"disabled":false,"type":"any","value":"50NCGoRK0VRb","key":"campaignId","description":"(Required) ID of the recommendation campaign"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"httpStatus\": 500,\n \"errorCode\": 8992,\n \"timestamp\": \"1994-03-23T16:52:22.343Z\",\n \"message\": \"string\",\n \"traceId\": \"string\",\n \"help\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"bc7df2bf-39f0-4afb-84d1-f55475c292c2","name":"Incorrect request","originalRequest":{"url":{"path":["recommendations","v2","campaigns",":campaignId","products","stats"],"host":["{{baseUrl}}"],"query":[{"key":"from","value":"1987-03-02"},{"key":"to","value":"1987-03-02"},{"key":"timeZone","value":"Europe/Warsaw"},{"key":"metric","value":"views"}],"variable":[{"disabled":false,"type":"any","value":"50NCGoRK0VRb","key":"campaignId","description":"(Required) ID of the recommendation campaign"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"httpStatus\": 500,\n \"errorCode\": 8992,\n \"timestamp\": \"1994-03-23T16:52:22.343Z\",\n \"message\": \"string\",\n \"traceId\": \"string\",\n \"help\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}],"event":[]},{"id":"a7ea7b23-6d54-454f-b171-71badb087bf9","name":"Recommendations","description":{"content":"","type":"text/plain"},"item":[{"id":"7f673012-b882-4107-b44b-db12e539b3dd","name":"Get recommendations by campaign","request":{"name":"Get recommendations by campaign","description":{"content":"This method allows you to retrieve recommendations based on a campaignID or a slug and a context. The context is built based on:\n\n - campaign identifier (required)\n - profile UUID\n - items (for example, items currently in the basket)\n - item exclusions\n\n\n This is the recommended and simplest way to fetch recommendations.\n\n Before you use this method, you must to create a recommendations campaign in Synerise. All the recommendation filters and parameters will be handled for you automatically according to a campaign's configuration.\n\n\n---\n\n**API consumers:** AI API key (legacy), Web SDK Tracker, Workspace (Business Profile)\n\n**API key permission required:** `API_MATERIALIZER_V2_RECOMMEND_CAMPAIGNS_RECOMMENDATIONS_READ`\n","type":"text/plain"},"url":{"path":["recommendations","v2","recommend","campaigns",":campaignIdentifier"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"clientUUID","value":"string","description":"Profile UUID. This parameter is required for these recommendation types:\n - Personalized\n - Last seen\n - Recent interactions\n - Section\n - Attribute\n\nThis parameter can be passed in all recommendations. In recommendations which don't require the customer context, it can still be used to create filters.\n"},{"disabled":false,"key":"itemId","value":"string","description":"Item ID or item IDs for the recommendation context. This parameter is:\n\n- required for similar/complementary items campaigns.\n\n- optional for personalized campaigns.\n\nThis parameter can be passed in all recommendations. In recommendations which don't use the context item as part of the recommendation model, the context item can only be used to create filters.\n\nYou can repeat this parameter in order to pass a number of context-creating items, for example, in a cart recommendation campaign.\n\nThis overrides the `itemsSource` settings of the campaign definition.\n\nAlternatively, you can pass the `itemsSourceType` and `itemsSourceId` parameters to use context items from source (aggregate or expression). These parameters can't be used at the same request with `itemId`.\n"},{"disabled":false,"key":"inventoryChannelId","value":"string","description":"Inventory context identifier used to evaluate inventory-related filters and boosting strategies. If not provided, no inventory context will be applied."},{"disabled":false,"key":"itemsSourceType","value":"aggregate","description":"Item ID or item IDs source type for the recommendation context.\n\nMust be used with `itemSourceId`. This overrides the `itemsSource` settings of the campaign definition.\n\nIn recommendations whose models doesn't use the item context, the attributes of those items can only be used in filters. \n\nIf the items' source type is 'aggregate', the aggregate result will be used as context items. If the items' source type is 'expression', the expression result will be used as context items.\n\nThe item ID source (aggregate or expression) should return a string or an array of strings. If it returns numerical values, the recommendations engine attempts to convert them into strings while processing the request.\n\nAlternatively, you can pass the `itemId` parameter to define context items directly. Only one of these options is allowed at the same time.\n"},{"disabled":false,"key":"itemsSourceId","value":"string","description":"Source of item IDs for the recommendation context. In recommendations whose models doesn't use the item context, the attributes of those items can only be used in filters.\n\nMust be used with `itemsSourceType`.\n\nIf the items' source type is 'aggregate', this is the aggregate's ID. If the items' source type is 'expression', this is the expression's ID.\n\nThe item ID source (aggregate or expression) should return a string or an array of strings. If it returns numerical values, the recommendations engine attempts to convert them into strings while processing the request.\n\nAlternatively, you can pass the `itemId` parameter to define context items directly. Only one of these options is allowed at the same time.\n"},{"disabled":false,"key":"externalItemId","value":"string","description":"Items provided by an external recommendation model to be returned as recommendation results.\n\nYou can repeat this parameter to pass multiple external items.\n\nThis parameter is used with campaigns of type \"external-items\".\n"},{"disabled":false,"key":"itemIdExcluded","value":"string","description":"IDs of items that will be excluded from the generated recommendations. For example, items already added to the basket."},{"disabled":false,"key":"additionalFilters","value":"effectivePrice>300 AND effectivePrice<400","description":"
\nIMPORTANT:\n\n- The `filtersJoiner` attribute is REQUIRED when `additionalFilters` is included. If `filtersJoiner` is missing, the additional filters do not work. \n- Do NOT send multiple instances of this parameter.\n\n
\n\nAdditional filters. These are merged with the campaign's own filters according to the logic in `filtersJoiner`.\n\nThis parameter must include all the additional filters as a single string, for example `additionalFilters=effectivePrice>300 AND effectivePrice<400` (the spaces are required).\n"},{"disabled":false,"key":"filtersJoiner","value":"AND","description":"Defines the logic of merging `additionalFilters` with the campaign's existing filters.\n- `REPLACE` replaces the campaign's filters with your filters.\n- `AND` matches if both your filters and the campaign filters are met.\n- `OR` matches if at least one of the filters is met.\n"},{"disabled":false,"key":"additionalElasticFilters","value":"effectivePrice>300 AND effectivePrice<400","description":"
\nIMPORTANT:\n\n- The `elasticFiltersJoiner` attribute is REQUIRED when `additionalElasticFilters` is included. If `elasticFiltersJoiner` is missing, the additional filters do not work. \n- Do NOT send multiple instances of this parameter.\n\n
\n\nAdditional elastic filters. These are merged with the campaign's own elastic filters according to the logic in `elasticFiltersJoiner`.\n\nThis parameter must include all the additional filters as a single string, for example `additionalElasticFilters=effectivePrice>300 AND effectivePrice<400` (the spaces are required).\n"},{"disabled":false,"key":"elasticFiltersJoiner","value":"AND","description":"Defines the logic of merging `additionalElasticFilters` with the campaign's existing elastic filters.\n- `REPLACE` replaces the campaign's filters with your filters.\n- `AND` matches if both your filters and the campaign filters are met.\n- `OR` matches if at least one of the filters is met.\n"},{"disabled":false,"key":"displayAttribute","value":"string","description":"Item attribute whose value will be returned in the recommendation response. The parameter value will be merged with the configuration of the recommendation. This parameter can be passed multiple times."},{"disabled":false,"key":"includeContextItems","value":"true","description":"When true, the recommendation response will include context items metadata."},{"disabled":false,"key":"params","value":"source:mobile","description":"List of extra params that will be added to the `recommendation.generated` event. They must be in the `name:value` format. The total size must not exceed 500 bytes when written as a JSON object.\n"}],"variable":[{"disabled":false,"type":"any","value":"string","key":"campaignIdentifier","description":"(Required) Recommendation campaign identifier - a campaignID or a slug"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"key":"key","value":"token"},{"key":"value","value":"{{apiKey}}"},{"key":"in","value":"query"}]}},"response":[{"id":"5982f771-1fd6-46b2-a0bf-5046e2964e25","name":"Recommendations for the provided context. The response schema depends on your Workspace configuration. The schema below only includes the static elements.","originalRequest":{"url":{"path":["recommendations","v2","recommend","campaigns",":campaignIdentifier"],"host":["{{baseUrl}}"],"query":[{"key":"clientUUID","value":"string"},{"key":"itemId","value":"string"},{"key":"inventoryChannelId","value":"string"},{"key":"itemsSourceType","value":"aggregate"},{"key":"itemsSourceId","value":"string"},{"key":"externalItemId","value":"string"},{"key":"itemIdExcluded","value":"string"},{"key":"additionalFilters","value":"effectivePrice>300 AND effectivePrice<400"},{"key":"filtersJoiner","value":"AND"},{"key":"additionalElasticFilters","value":"effectivePrice>300 AND effectivePrice<400"},{"key":"elasticFiltersJoiner","value":"AND"},{"key":"displayAttribute","value":"string"},{"key":"includeContextItems","value":"true"},{"key":"params","value":"source:mobile"},{"key":"token","value":""}],"variable":[{"disabled":false,"type":"any","value":"string","key":"campaignIdentifier","description":"(Required) Recommendation campaign identifier - a campaignID or a slug"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"data\": [\n {\n \"itemId\": {\n \"value\": \"\"\n }\n },\n {\n \"itemId\": {\n \"value\": \"\"\n }\n }\n ],\n \"extras\": {\n \"correlationId\": \"string\",\n \"slots\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"contextItems\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"bf6675b3-8ce2-4939-9480-d2cf02b6305d","name":"No recommendations could be generated for the specified campaign and context.","originalRequest":{"url":{"path":["recommendations","v2","recommend","campaigns",":campaignIdentifier"],"host":["{{baseUrl}}"],"query":[{"key":"clientUUID","value":"string"},{"key":"itemId","value":"string"},{"key":"inventoryChannelId","value":"string"},{"key":"itemsSourceType","value":"aggregate"},{"key":"itemsSourceId","value":"string"},{"key":"externalItemId","value":"string"},{"key":"itemIdExcluded","value":"string"},{"key":"additionalFilters","value":"effectivePrice>300 AND effectivePrice<400"},{"key":"filtersJoiner","value":"AND"},{"key":"additionalElasticFilters","value":"effectivePrice>300 AND effectivePrice<400"},{"key":"elasticFiltersJoiner","value":"AND"},{"key":"displayAttribute","value":"string"},{"key":"includeContextItems","value":"true"},{"key":"params","value":"source:mobile"},{"key":"token","value":""}],"variable":[{"disabled":false,"type":"any","value":"string","key":"campaignIdentifier","description":"(Required) Recommendation campaign identifier - a campaignID or a slug"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1963-08-12T14:54:43.321Z\",\n \"status\": 2878,\n \"message\": \"string\",\n \"error\": \"string\",\n \"path\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"0943c43a-4450-45bd-804d-ca05ea02a462","name":"An error occurred","originalRequest":{"url":{"path":["recommendations","v2","recommend","campaigns",":campaignIdentifier"],"host":["{{baseUrl}}"],"query":[{"key":"clientUUID","value":"string"},{"key":"itemId","value":"string"},{"key":"inventoryChannelId","value":"string"},{"key":"itemsSourceType","value":"aggregate"},{"key":"itemsSourceId","value":"string"},{"key":"externalItemId","value":"string"},{"key":"itemIdExcluded","value":"string"},{"key":"additionalFilters","value":"effectivePrice>300 AND effectivePrice<400"},{"key":"filtersJoiner","value":"AND"},{"key":"additionalElasticFilters","value":"effectivePrice>300 AND effectivePrice<400"},{"key":"elasticFiltersJoiner","value":"AND"},{"key":"displayAttribute","value":"string"},{"key":"includeContextItems","value":"true"},{"key":"params","value":"source:mobile"},{"key":"token","value":""}],"variable":[{"disabled":false,"type":"any","value":"string","key":"campaignIdentifier","description":"(Required) Recommendation campaign identifier - a campaignID or a slug"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1963-08-12T14:54:43.321Z\",\n \"status\": 2878,\n \"message\": \"string\",\n \"error\": \"string\",\n \"path\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"708317f7-e5ae-44d2-95f7-0684e833d2cd","name":"Get recommendations by campaign","request":{"name":"Get recommendations by campaign","description":{"content":"This method allows you to retrieve recommendations based on a campaignID or slug and a context. The context is built based on:\n\n- campaign ID or slug (one of those is required)\n- profile UUID\n- items (for example, items currently in the basket)\n- item exclusions\n\nThis is the recommended and simplest way to fetch recommendations.\n\nBefore you use this method, you must to create a recommendations campaign in Synerise. All the recommendation filters and parameters will be handled for you automatically according to a campaign's configuration.\n\n\n---\n\n**API consumers:** AI API key (legacy), Web SDK Tracker, Workspace (Business Profile)\n\n**API key permission required:** `API_MATERIALIZER_V2_RECOMMEND_CAMPAIGNS_RECOMMENDATIONS_READ`\n","type":"text/plain"},"url":{"path":["recommendations","v2","recommend","campaigns"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"apikey","apikey":[{"key":"key","value":"token"},{"key":"value","value":"{{apiKey}}"},{"key":"in","value":"query"}]},"body":{"mode":"raw","raw":"{\n \"clientUUID\": \"string\",\n \"campaignId\": \"string\",\n \"slug\": \"string\",\n \"items\": {\n \"value\": \"\"\n },\n \"itemsSource\": {\n \"value\": \"\"\n },\n \"itemsExcluded\": {\n \"value\": \"\"\n },\n \"additionalFilters\": {\n \"value\": \"\"\n },\n \"filtersJoiner\": {\n \"value\": \"\"\n },\n \"additionalElasticFilters\": {\n \"value\": \"\"\n },\n \"elasticFiltersJoiner\": {\n \"value\": \"\"\n },\n \"displayAttributes\": {\n \"value\": \"\"\n },\n \"includeContextItems\": {\n \"value\": \"\"\n },\n \"recommendedItemsFromExternalModel\": {\n \"value\": \"\"\n },\n \"inventoryContext\": {\n \"value\": \"\"\n },\n \"params\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"122b9a57-d67e-4792-997a-bc35e8434ea5","name":"Recommendations for the provided context. The response schema depends on your Workspace configuration. The schema below only includes the static elements.","originalRequest":{"url":{"path":["recommendations","v2","recommend","campaigns"],"host":["{{baseUrl}}"],"query":[{"key":"token","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"clientUUID\": \"string\",\n \"campaignId\": \"string\",\n \"slug\": \"string\",\n \"items\": {\n \"value\": \"\"\n },\n \"itemsSource\": {\n \"value\": \"\"\n },\n \"itemsExcluded\": {\n \"value\": \"\"\n },\n \"additionalFilters\": {\n \"value\": \"\"\n },\n \"filtersJoiner\": {\n \"value\": \"\"\n },\n \"additionalElasticFilters\": {\n \"value\": \"\"\n },\n \"elasticFiltersJoiner\": {\n \"value\": \"\"\n },\n \"displayAttributes\": {\n \"value\": \"\"\n },\n \"includeContextItems\": {\n \"value\": \"\"\n },\n \"recommendedItemsFromExternalModel\": {\n \"value\": \"\"\n },\n \"inventoryContext\": {\n \"value\": \"\"\n },\n \"params\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"data\": [\n {\n \"itemId\": {\n \"value\": \"\"\n }\n },\n {\n \"itemId\": {\n \"value\": \"\"\n }\n }\n ],\n \"extras\": {\n \"correlationId\": \"string\",\n \"slots\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"contextItems\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"b36e788c-4918-435f-a98e-1b99e748a49b","name":"No recommendations could be generated for the specified campaign and context.","originalRequest":{"url":{"path":["recommendations","v2","recommend","campaigns"],"host":["{{baseUrl}}"],"query":[{"key":"token","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"clientUUID\": \"string\",\n \"campaignId\": \"string\",\n \"slug\": \"string\",\n \"items\": {\n \"value\": \"\"\n },\n \"itemsSource\": {\n \"value\": \"\"\n },\n \"itemsExcluded\": {\n \"value\": \"\"\n },\n \"additionalFilters\": {\n \"value\": \"\"\n },\n \"filtersJoiner\": {\n \"value\": \"\"\n },\n \"additionalElasticFilters\": {\n \"value\": \"\"\n },\n \"elasticFiltersJoiner\": {\n \"value\": \"\"\n },\n \"displayAttributes\": {\n \"value\": \"\"\n },\n \"includeContextItems\": {\n \"value\": \"\"\n },\n \"recommendedItemsFromExternalModel\": {\n \"value\": \"\"\n },\n \"inventoryContext\": {\n \"value\": \"\"\n },\n \"params\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1963-08-12T14:54:43.321Z\",\n \"status\": 2878,\n \"message\": \"string\",\n \"error\": \"string\",\n \"path\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"4dfd12e7-ad65-46bd-bd77-10de2ee86537","name":"An error occurred","originalRequest":{"url":{"path":["recommendations","v2","recommend","campaigns"],"host":["{{baseUrl}}"],"query":[{"key":"token","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"clientUUID\": \"string\",\n \"campaignId\": \"string\",\n \"slug\": \"string\",\n \"items\": {\n \"value\": \"\"\n },\n \"itemsSource\": {\n \"value\": \"\"\n },\n \"itemsExcluded\": {\n \"value\": \"\"\n },\n \"additionalFilters\": {\n \"value\": \"\"\n },\n \"filtersJoiner\": {\n \"value\": \"\"\n },\n \"additionalElasticFilters\": {\n \"value\": \"\"\n },\n \"elasticFiltersJoiner\": {\n \"value\": \"\"\n },\n \"displayAttributes\": {\n \"value\": \"\"\n },\n \"includeContextItems\": {\n \"value\": \"\"\n },\n \"recommendedItemsFromExternalModel\": {\n \"value\": \"\"\n },\n \"inventoryContext\": {\n \"value\": \"\"\n },\n \"params\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1963-08-12T14:54:43.321Z\",\n \"status\": 2878,\n \"message\": \"string\",\n \"error\": \"string\",\n \"path\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"ace96113-644b-4ba4-b8c1-7b52556525b2","name":"Get recommendations by campaign and profile identifier","request":{"name":"Get recommendations by campaign and profile identifier","description":{"content":"\n**Before you use this method**: you must [create a recommendations campaign in Synerise](https://help.synerise.com/docs/campaign/recommendations-v2/). All the recommendation filters and parameters will be handled for you automatically according to a campaign's configuration.\n\nThe method allows you to retrieve recommendations based on a campaignID or a slug, profile's identifier name (the value of the identifier is provided in the request body), and a context. The context is built based on:\n\n- campaign identifier (required)\n- identifierName (required)\n- identifierValue (required)\n- items (for example, items currently in the basket)\n- item exclusions\n\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User\n\n**API key permission required:** `API_MATERIALIZER_V2_RECOMMEND_WITH_CUSTOM_ID_RECOMMENDATIONS_READ`\n\n**User role permission required:** `campaigns_recommendations: read`\n","type":"text/plain"},"url":{"path":["recommendations","v2","recommend","campaigns",":campaignIdentifier","by",":identifierName"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"campaignIdentifier","description":"(Required) Recommendation campaign identifier - a campaignID or a slug"},{"disabled":false,"type":"any","value":"uuid","key":"identifierName","description":"(Required) The name of the profile identifier to use for the request. By default, the allowed identifier types are `id`, `uuid`, `email`, and `custom_identify`. This may be changed in the workspace configuration."}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"identifierValue\": \"string\",\n \"items\": {\n \"value\": \"\"\n },\n \"itemsSource\": {\n \"value\": \"\"\n },\n \"itemsExcluded\": {\n \"value\": \"\"\n },\n \"additionalFilters\": {\n \"value\": \"\"\n },\n \"filtersJoiner\": {\n \"value\": \"\"\n },\n \"additionalElasticFilters\": {\n \"value\": \"\"\n },\n \"elasticFiltersJoiner\": {\n \"value\": \"\"\n },\n \"displayAttributes\": {\n \"value\": \"\"\n },\n \"includeContextItems\": {\n \"value\": \"\"\n },\n \"recommendedItemsFromExternalModel\": {\n \"value\": \"\"\n },\n \"inventoryContext\": {\n \"value\": \"\"\n },\n \"params\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"50126402-87c1-4c53-bd84-1fe41d50e0db","name":"Recommendations for the provided context. The response schema depends on your Workspace configuration. The schema below only includes the static elements.","originalRequest":{"url":{"path":["recommendations","v2","recommend","campaigns",":campaignIdentifier","by",":identifierName"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"campaignIdentifier","description":"(Required) Recommendation campaign identifier - a campaignID or a slug"},{"disabled":false,"type":"any","value":"uuid","key":"identifierName","description":"(Required) The name of the profile identifier to use for the request. By default, the allowed identifier types are `id`, `uuid`, `email`, and `custom_identify`. This may be changed in the workspace configuration."}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"identifierValue\": \"string\",\n \"items\": {\n \"value\": \"\"\n },\n \"itemsSource\": {\n \"value\": \"\"\n },\n \"itemsExcluded\": {\n \"value\": \"\"\n },\n \"additionalFilters\": {\n \"value\": \"\"\n },\n \"filtersJoiner\": {\n \"value\": \"\"\n },\n \"additionalElasticFilters\": {\n \"value\": \"\"\n },\n \"elasticFiltersJoiner\": {\n \"value\": \"\"\n },\n \"displayAttributes\": {\n \"value\": \"\"\n },\n \"includeContextItems\": {\n \"value\": \"\"\n },\n \"recommendedItemsFromExternalModel\": {\n \"value\": \"\"\n },\n \"inventoryContext\": {\n \"value\": \"\"\n },\n \"params\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"data\": [\n {\n \"itemId\": {\n \"value\": \"\"\n }\n },\n {\n \"itemId\": {\n \"value\": \"\"\n }\n }\n ],\n \"extras\": {\n \"correlationId\": \"string\",\n \"slots\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"contextItems\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"41484a32-8cfe-4e5a-8a60-ea1e613dcfd9","name":"No recommendations could be generated for the specified campaign and context.","originalRequest":{"url":{"path":["recommendations","v2","recommend","campaigns",":campaignIdentifier","by",":identifierName"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"campaignIdentifier","description":"(Required) Recommendation campaign identifier - a campaignID or a slug"},{"disabled":false,"type":"any","value":"uuid","key":"identifierName","description":"(Required) The name of the profile identifier to use for the request. By default, the allowed identifier types are `id`, `uuid`, `email`, and `custom_identify`. This may be changed in the workspace configuration."}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"identifierValue\": \"string\",\n \"items\": {\n \"value\": \"\"\n },\n \"itemsSource\": {\n \"value\": \"\"\n },\n \"itemsExcluded\": {\n \"value\": \"\"\n },\n \"additionalFilters\": {\n \"value\": \"\"\n },\n \"filtersJoiner\": {\n \"value\": \"\"\n },\n \"additionalElasticFilters\": {\n \"value\": \"\"\n },\n \"elasticFiltersJoiner\": {\n \"value\": \"\"\n },\n \"displayAttributes\": {\n \"value\": \"\"\n },\n \"includeContextItems\": {\n \"value\": \"\"\n },\n \"recommendedItemsFromExternalModel\": {\n \"value\": \"\"\n },\n \"inventoryContext\": {\n \"value\": \"\"\n },\n \"params\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1963-08-12T14:54:43.321Z\",\n \"status\": 2878,\n \"message\": \"string\",\n \"error\": \"string\",\n \"path\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"7ad54b98-f8c7-4d59-80ea-3ceba79b9463","name":"An error occurred","originalRequest":{"url":{"path":["recommendations","v2","recommend","campaigns",":campaignIdentifier","by",":identifierName"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"campaignIdentifier","description":"(Required) Recommendation campaign identifier - a campaignID or a slug"},{"disabled":false,"type":"any","value":"uuid","key":"identifierName","description":"(Required) The name of the profile identifier to use for the request. By default, the allowed identifier types are `id`, `uuid`, `email`, and `custom_identify`. This may be changed in the workspace configuration."}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"identifierValue\": \"string\",\n \"items\": {\n \"value\": \"\"\n },\n \"itemsSource\": {\n \"value\": \"\"\n },\n \"itemsExcluded\": {\n \"value\": \"\"\n },\n \"additionalFilters\": {\n \"value\": \"\"\n },\n \"filtersJoiner\": {\n \"value\": \"\"\n },\n \"additionalElasticFilters\": {\n \"value\": \"\"\n },\n \"elasticFiltersJoiner\": {\n \"value\": \"\"\n },\n \"displayAttributes\": {\n \"value\": \"\"\n },\n \"includeContextItems\": {\n \"value\": \"\"\n },\n \"recommendedItemsFromExternalModel\": {\n \"value\": \"\"\n },\n \"inventoryContext\": {\n \"value\": \"\"\n },\n \"params\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1963-08-12T14:54:43.321Z\",\n \"status\": 2878,\n \"message\": \"string\",\n \"error\": \"string\",\n \"path\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"80ff1761-a247-4bf1-802b-99b8708d1a7d","name":"Preview campaign recommendations","request":{"name":"Preview campaign recommendations","description":{"content":"This method allows you to preview recommendations for a campaign with a given configuration before creating it.\n\n**Note**: This method is not an alternative to creating recommendations for an existing campaign. It is intended for testing purposes only.\n\nThe recommendation context is built based on:\n- profile UUID\n- items\n- item exclusions\n\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User\n\n**API key permission required:** `API_MATERIALIZER_V2_RECOMMEND_CAMPAIGNS_RECOMMENDATIONS_PREVIEW_READ`\n\n**User role permission required:** `campaigns_recommendations: read`\n","type":"text/plain"},"url":{"path":["recommendations","v2","recommend","campaigns","preview"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"apikey","apikey":[{"key":"key","value":"token"},{"key":"value","value":"{{apiKey}}"},{"key":"in","value":"query"}]},"body":{"mode":"raw","raw":"{\n \"clientUUID\": {\n \"value\": \"\"\n },\n \"items\": {\n \"value\": \"\"\n },\n \"includeContextItems\": {\n \"value\": \"\"\n },\n \"params\": {\n \"value\": \"\"\n },\n \"inventoryContext\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"7c4911fa-262a-4af7-83b6-e07bd7823c9a","name":"Recommendations for the provided context. The response schema depends on your Workspace configuration. The schema below only includes the static elements.","originalRequest":{"url":{"path":["recommendations","v2","recommend","campaigns","preview"],"host":["{{baseUrl}}"],"query":[{"key":"token","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"clientUUID\": {\n \"value\": \"\"\n },\n \"items\": {\n \"value\": \"\"\n },\n \"includeContextItems\": {\n \"value\": \"\"\n },\n \"params\": {\n \"value\": \"\"\n },\n \"inventoryContext\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"data\": [\n {\n \"itemId\": {\n \"value\": \"\"\n }\n },\n {\n \"itemId\": {\n \"value\": \"\"\n }\n }\n ],\n \"extras\": {\n \"correlationId\": \"string\",\n \"slots\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"contextItems\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"7d0e92b4-645c-44e1-be4c-961a28525cd8","name":"No recommendations could be generated for the specified campaign and context.","originalRequest":{"url":{"path":["recommendations","v2","recommend","campaigns","preview"],"host":["{{baseUrl}}"],"query":[{"key":"token","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"clientUUID\": {\n \"value\": \"\"\n },\n \"items\": {\n \"value\": \"\"\n },\n \"includeContextItems\": {\n \"value\": \"\"\n },\n \"params\": {\n \"value\": \"\"\n },\n \"inventoryContext\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1963-08-12T14:54:43.321Z\",\n \"status\": 2878,\n \"message\": \"string\",\n \"error\": \"string\",\n \"path\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"a225d2bf-e731-454d-ac73-687350bc55a9","name":"The user has sent too many requests in a given amount of time (\"rate limiting\").","originalRequest":{"url":{"path":["recommendations","v2","recommend","campaigns","preview"],"host":["{{baseUrl}}"],"query":[{"key":"token","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"clientUUID\": {\n \"value\": \"\"\n },\n \"items\": {\n \"value\": \"\"\n },\n \"includeContextItems\": {\n \"value\": \"\"\n },\n \"params\": {\n \"value\": \"\"\n },\n \"inventoryContext\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Too Many Requests","code":429,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1963-08-12T14:54:43.321Z\",\n \"status\": 2878,\n \"message\": \"string\",\n \"error\": \"string\",\n \"path\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"c8ecfd06-ea2b-408f-ba1f-e0d2ddaad931","name":"An error occurred","originalRequest":{"url":{"path":["recommendations","v2","recommend","campaigns","preview"],"host":["{{baseUrl}}"],"query":[{"key":"token","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"clientUUID\": {\n \"value\": \"\"\n },\n \"items\": {\n \"value\": \"\"\n },\n \"includeContextItems\": {\n \"value\": \"\"\n },\n \"params\": {\n \"value\": \"\"\n },\n \"inventoryContext\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1963-08-12T14:54:43.321Z\",\n \"status\": 2878,\n \"message\": \"string\",\n \"error\": \"string\",\n \"path\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"15a13ac9-e3b9-43a8-bedf-26fe5192c9ff","name":"Personalized recommendations","request":{"name":"Personalized recommendations","description":{"content":"Retrieve item recommendations for a profile.\n\n**Note:** The definition of an *item* encompasses products, but also articles, images, videos, and any other entities in the item feed.\n\n---\n\n**API consumers:** AI API key (legacy), Workspace (Business Profile), Web SDK Tracker\n\n**API key permission required:** `RECOMMENDATIONS_V2_PERSONALIZED_RECOMMENDATIONS_READ`\n","type":"text/plain"},"url":{"path":["recommendations","v2","recommend","items","users",":clientUuid"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"minNumItems","value":"1","description":"The minimal number of returned item recommendations. If the service is not able to return at least this many recommendations, it will return an error."},{"disabled":false,"key":"maxNumItems","value":"5","description":"The maximal number of returned item recommendations."},{"disabled":false,"key":"campaignId","value":"defaultCampaign","description":"The campaignId which will be passed as *utm_campaign* in a link to the recommended item."},{"disabled":false,"key":"campaignName","value":"string","description":"The campaign name which will be included in the recommendation.generated event."},{"disabled":false,"key":"excludePurchasedItems","value":"false","description":"When true, the recommendation results will include only items that the profile hasn't purchased before. \n**IMPORTANT**: Only the last 250 purchased items are taken into account. Items further back in the purchase history may be included in the recommendation.\n"},{"disabled":false,"key":"excludePurchasedItemsSinceDays","value":"682","description":"Limits the application of the `excludePurchasedItems` filter to a specified number of days."},{"disabled":false,"key":"filters","value":"string","description":"This string defines the criteria that an item must meet in order to be considered for recommendation. \nFor information on building filters, see [\"Items Query Language (IQL)\" in the Developer Guide](https://hub.synerise.com/developers/iql/).\n"},{"disabled":false,"key":"elastic:filters","value":"string","description":"This string defines the criteria that an item must meet in order to be considered for recommendation. The Elastic filter may be dropped if not enough products meet the required criteria. \nFor information on building filters, see [\"Items Query Language (IQL)\" in the Developer Guide](https://hub.synerise.com/developers/iql/).\n"},{"disabled":false,"key":"itemId","value":"string","description":"Item identifier, equal to `itemId` from the *item feed*. It can be used to define the item context of the query."},{"disabled":false,"key":"itemCatalogId","value":"default","description":"ID (_not_ name) of the item feed to use in the request. The requested recommendation type (model) must be ready for this item feed."},{"disabled":false,"key":"elastic","value":"false"},{"disabled":false,"key":"filters","value":"[{\"field\":{\"value\":\"\"},\"maxNumItems\":{\"value\":\"\"},\"levelRangeModifier\":{\"value\":\"\"}}]"},{"disabled":false,"key":"includeContextItems","value":"true","description":"The recommendation results will include context items from the request."},{"disabled":false,"key":"params","value":"source:mobile","description":"List of extra params that will be added to the `recommendation.generated` event. They must be in the `name:value` format. The total size must not exceed 500 bytes when written as a JSON object.\n"},{"disabled":false,"key":"inventoryChannelId","value":"string","description":"Inventory context identifier used to evaluate inventory-related filters and boosting strategies. If not provided, no inventory context will be applied.\n"},{"disabled":false,"key":"crossWorkspaceMode","value":"true","description":"Specifies if recommendation should use cross-workspace mode and personalize recommendations with events from other members of workspace group if they are available.\n"}],"variable":[{"disabled":false,"type":"any","value":"string","key":"clientUuid","description":"(Required) Recommendations will be generated for the provided profile UUID."}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"key":"key","value":"token"},{"key":"value","value":"{{apiKey}}"},{"key":"in","value":"query"}]}},"response":[{"id":"734f3570-8ce0-4dcf-9c88-d25ae0918f98","name":"Personalized recommendations","originalRequest":{"url":{"path":["recommendations","v2","recommend","items","users",":clientUuid"],"host":["{{baseUrl}}"],"query":[{"key":"minNumItems","value":"1"},{"key":"maxNumItems","value":"5"},{"key":"campaignId","value":"defaultCampaign"},{"key":"campaignName","value":"string"},{"key":"excludePurchasedItems","value":"false"},{"key":"excludePurchasedItemsSinceDays","value":"682"},{"key":"filters","value":"string"},{"key":"elastic:filters","value":"string"},{"key":"itemId","value":"string"},{"key":"itemCatalogId","value":"default"},{"key":"elastic","value":"false"},{"key":"filters","value":"[object Object]"},{"key":"includeContextItems","value":"true"},{"key":"params","value":"source:mobile"},{"key":"inventoryChannelId","value":"string"},{"key":"crossWorkspaceMode","value":"true"},{"key":"token","value":""}],"variable":[{"disabled":false,"type":"any","value":"string","key":"clientUuid","description":"(Required) Recommendations will be generated for the provided profile UUID."}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"extras\": {\n \"correlationId\": \"string\",\n \"contextItems\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"campaignId\": \"string\"\n },\n \"data\": [\n {\n \"itemId\": {\n \"value\": \"\"\n }\n },\n {\n \"itemId\": {\n \"value\": \"\"\n }\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"b11f9d58-4809-442b-b5d2-94aa9199a493","name":"No recommendations could be generated for the specified profile and filters","originalRequest":{"url":{"path":["recommendations","v2","recommend","items","users",":clientUuid"],"host":["{{baseUrl}}"],"query":[{"key":"minNumItems","value":"1"},{"key":"maxNumItems","value":"5"},{"key":"campaignId","value":"defaultCampaign"},{"key":"campaignName","value":"string"},{"key":"excludePurchasedItems","value":"false"},{"key":"excludePurchasedItemsSinceDays","value":"682"},{"key":"filters","value":"string"},{"key":"elastic:filters","value":"string"},{"key":"itemId","value":"string"},{"key":"itemCatalogId","value":"default"},{"key":"elastic","value":"false"},{"key":"filters","value":"[object Object]"},{"key":"includeContextItems","value":"true"},{"key":"params","value":"source:mobile"},{"key":"inventoryChannelId","value":"string"},{"key":"crossWorkspaceMode","value":"true"},{"key":"token","value":""}],"variable":[{"disabled":false,"type":"any","value":"string","key":"clientUuid","description":"(Required) Recommendations will be generated for the provided profile UUID."}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1990-11-06T06:53:04.578Z\",\n \"status\": 5998,\n \"message\": \"string\",\n \"error\": \"string\",\n \"path\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"6622d317-025b-43df-be8f-d37bd5782a2d","name":"An error occurred","originalRequest":{"url":{"path":["recommendations","v2","recommend","items","users",":clientUuid"],"host":["{{baseUrl}}"],"query":[{"key":"minNumItems","value":"1"},{"key":"maxNumItems","value":"5"},{"key":"campaignId","value":"defaultCampaign"},{"key":"campaignName","value":"string"},{"key":"excludePurchasedItems","value":"false"},{"key":"excludePurchasedItemsSinceDays","value":"682"},{"key":"filters","value":"string"},{"key":"elastic:filters","value":"string"},{"key":"itemId","value":"string"},{"key":"itemCatalogId","value":"default"},{"key":"elastic","value":"false"},{"key":"filters","value":"[object Object]"},{"key":"includeContextItems","value":"true"},{"key":"params","value":"source:mobile"},{"key":"inventoryChannelId","value":"string"},{"key":"crossWorkspaceMode","value":"true"},{"key":"token","value":""}],"variable":[{"disabled":false,"type":"any","value":"string","key":"clientUuid","description":"(Required) Recommendations will be generated for the provided profile UUID."}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1990-11-06T06:53:04.578Z\",\n \"status\": 5998,\n \"message\": \"string\",\n \"error\": \"string\",\n \"path\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"44dffe9e-5a8b-47dc-907b-bde153aaf6db","name":"Personalized recommendations","request":{"name":"Personalized recommendations","description":{"content":"Retrieve item recommendations for a profile.\n\n**Note:** The definition of an *item* encompasses products, but also articles, images, videos, and any other entities in the item feed.\n\n---\n\n**API consumers:** AI API key (legacy), Workspace (Business Profile), Web SDK Tracker\n\n**API key permission required:** `RECOMMENDATIONS_V2_PERSONALIZED_RECOMMENDATIONS_READ`\n","type":"text/plain"},"url":{"path":["recommendations","v2","recommend","items","users",":clientUuid"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"clientUuid","description":"(Required) Recommendations will be generated for the provided profile UUID."}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"apikey","apikey":[{"key":"key","value":"token"},{"key":"value","value":"{{apiKey}}"},{"key":"in","value":"query"}]},"body":{"mode":"raw","raw":"{\n \"slots\": [\n {\n \"value\": \"\"\n }\n ],\n \"campaignId\": {\n \"value\": \"\"\n },\n \"campaignName\": {\n \"value\": \"\"\n },\n \"catalogId\": {\n \"value\": \"\"\n },\n \"clientUUID\": {\n \"value\": \"\"\n },\n \"contextItemIds\": {\n \"value\": \"\"\n },\n \"includeContextItems\": {\n \"value\": \"\"\n },\n \"filterRules\": {\n \"value\": \"\"\n },\n \"displayAttributes\": {\n \"value\": \"\"\n },\n \"abTestContext\": {\n \"value\": \"\"\n },\n \"params\": {\n \"value\": \"\"\n },\n \"inventoryContext\": {\n \"value\": \"\"\n },\n \"keepSlotsOrder\": true,\n \"personalizeSlotsOrder\": false,\n \"sortMetric\": \"string\",\n \"boostingParameters\": {\n \"value\": \"\"\n },\n \"boostingStrategies\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"crossWorkspaceMode\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"cc43f2a3-456a-4d6f-b168-c7f7a14e3377","name":"Personalized recommendations","originalRequest":{"url":{"path":["recommendations","v2","recommend","items","users",":clientUuid"],"host":["{{baseUrl}}"],"query":[{"key":"token","value":""}],"variable":[{"disabled":false,"type":"any","value":"string","key":"clientUuid","description":"(Required) Recommendations will be generated for the provided profile UUID."}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"slots\": [\n {\n \"value\": \"\"\n }\n ],\n \"campaignId\": {\n \"value\": \"\"\n },\n \"campaignName\": {\n \"value\": \"\"\n },\n \"catalogId\": {\n \"value\": \"\"\n },\n \"clientUUID\": {\n \"value\": \"\"\n },\n \"contextItemIds\": {\n \"value\": \"\"\n },\n \"includeContextItems\": {\n \"value\": \"\"\n },\n \"filterRules\": {\n \"value\": \"\"\n },\n \"displayAttributes\": {\n \"value\": \"\"\n },\n \"abTestContext\": {\n \"value\": \"\"\n },\n \"params\": {\n \"value\": \"\"\n },\n \"inventoryContext\": {\n \"value\": \"\"\n },\n \"keepSlotsOrder\": true,\n \"personalizeSlotsOrder\": false,\n \"sortMetric\": \"string\",\n \"boostingParameters\": {\n \"value\": \"\"\n },\n \"boostingStrategies\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"crossWorkspaceMode\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"extras\": {\n \"slots\": {\n \"value\": \"\"\n }\n },\n \"data\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"974b89c3-6821-46c1-8bc8-1c46ba3a5686","name":"No recommendations could be generated for the specified profile and filters","originalRequest":{"url":{"path":["recommendations","v2","recommend","items","users",":clientUuid"],"host":["{{baseUrl}}"],"query":[{"key":"token","value":""}],"variable":[{"disabled":false,"type":"any","value":"string","key":"clientUuid","description":"(Required) Recommendations will be generated for the provided profile UUID."}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"slots\": [\n {\n \"value\": \"\"\n }\n ],\n \"campaignId\": {\n \"value\": \"\"\n },\n \"campaignName\": {\n \"value\": \"\"\n },\n \"catalogId\": {\n \"value\": \"\"\n },\n \"clientUUID\": {\n \"value\": \"\"\n },\n \"contextItemIds\": {\n \"value\": \"\"\n },\n \"includeContextItems\": {\n \"value\": \"\"\n },\n \"filterRules\": {\n \"value\": \"\"\n },\n \"displayAttributes\": {\n \"value\": \"\"\n },\n \"abTestContext\": {\n \"value\": \"\"\n },\n \"params\": {\n \"value\": \"\"\n },\n \"inventoryContext\": {\n \"value\": \"\"\n },\n \"keepSlotsOrder\": true,\n \"personalizeSlotsOrder\": false,\n \"sortMetric\": \"string\",\n \"boostingParameters\": {\n \"value\": \"\"\n },\n \"boostingStrategies\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"crossWorkspaceMode\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1990-11-06T06:53:04.578Z\",\n \"status\": 5998,\n \"message\": \"string\",\n \"error\": \"string\",\n \"path\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"4f395f86-4013-46b0-92b9-4d6c81bd6b75","name":"An error occurred","originalRequest":{"url":{"path":["recommendations","v2","recommend","items","users",":clientUuid"],"host":["{{baseUrl}}"],"query":[{"key":"token","value":""}],"variable":[{"disabled":false,"type":"any","value":"string","key":"clientUuid","description":"(Required) Recommendations will be generated for the provided profile UUID."}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"slots\": [\n {\n \"value\": \"\"\n }\n ],\n \"campaignId\": {\n \"value\": \"\"\n },\n \"campaignName\": {\n \"value\": \"\"\n },\n \"catalogId\": {\n \"value\": \"\"\n },\n \"clientUUID\": {\n \"value\": \"\"\n },\n \"contextItemIds\": {\n \"value\": \"\"\n },\n \"includeContextItems\": {\n \"value\": \"\"\n },\n \"filterRules\": {\n \"value\": \"\"\n },\n \"displayAttributes\": {\n \"value\": \"\"\n },\n \"abTestContext\": {\n \"value\": \"\"\n },\n \"params\": {\n \"value\": \"\"\n },\n \"inventoryContext\": {\n \"value\": \"\"\n },\n \"keepSlotsOrder\": true,\n \"personalizeSlotsOrder\": false,\n \"sortMetric\": \"string\",\n \"boostingParameters\": {\n \"value\": \"\"\n },\n \"boostingStrategies\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"crossWorkspaceMode\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1990-11-06T06:53:04.578Z\",\n \"status\": 5998,\n \"message\": \"string\",\n \"error\": \"string\",\n \"path\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"73021ae7-f741-444f-9d92-2f24ab74b7c8","name":"Section recommendations","request":{"name":"Section recommendations","description":{"content":"Retrieve item recommendations grouped by attribute.\n\n**Note:** The definition of an *item* encompasses products, but also articles, images, videos, and any other entities in the item feed.\n\n---\n\n**API consumers:** AI API key (legacy), Workspace (Business Profile), Web SDK Tracker\n\n**API key permission required:** `RECOMMENDATIONS_V2_SECTION_RECOMMENDATIONS_READ`\n","type":"text/plain"},"url":{"path":["recommendations","v2","recommend","items","users",":clientUuid","sections"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"clientUuid","description":"(Required) Information will be shown for the provided profile UUID."}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"slots\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"campaignId\": {\n \"value\": \"\"\n },\n \"campaignName\": {\n \"value\": \"\"\n },\n \"catalogId\": {\n \"value\": \"\"\n },\n \"clientUUID\": {\n \"value\": \"\"\n },\n \"contextItemIds\": {\n \"value\": \"\"\n },\n \"includeContextItems\": {\n \"value\": \"\"\n },\n \"filterRules\": {\n \"value\": \"\"\n },\n \"displayAttributes\": {\n \"value\": \"\"\n },\n \"abTestContext\": {\n \"value\": \"\"\n },\n \"params\": {\n \"value\": \"\"\n },\n \"inventoryContext\": {\n \"value\": \"\"\n },\n \"metadataCatalogId\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"412c5f06-99b4-459d-9384-c92804304495","name":"Section recommendations","originalRequest":{"url":{"path":["recommendations","v2","recommend","items","users",":clientUuid","sections"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"clientUuid","description":"(Required) Information will be shown for the provided profile UUID."}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"slots\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"campaignId\": {\n \"value\": \"\"\n },\n \"campaignName\": {\n \"value\": \"\"\n },\n \"catalogId\": {\n \"value\": \"\"\n },\n \"clientUUID\": {\n \"value\": \"\"\n },\n \"contextItemIds\": {\n \"value\": \"\"\n },\n \"includeContextItems\": {\n \"value\": \"\"\n },\n \"filterRules\": {\n \"value\": \"\"\n },\n \"displayAttributes\": {\n \"value\": \"\"\n },\n \"abTestContext\": {\n \"value\": \"\"\n },\n \"params\": {\n \"value\": \"\"\n },\n \"inventoryContext\": {\n \"value\": \"\"\n },\n \"metadataCatalogId\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"extras\": {\n \"slots\": {\n \"value\": \"\"\n }\n },\n \"data\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"7af89b4d-0b46-4e2c-bfa4-78a7c137afae","name":"No recommendations could be generated for the specified profile and filters","originalRequest":{"url":{"path":["recommendations","v2","recommend","items","users",":clientUuid","sections"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"clientUuid","description":"(Required) Information will be shown for the provided profile UUID."}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"slots\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"campaignId\": {\n \"value\": \"\"\n },\n \"campaignName\": {\n \"value\": \"\"\n },\n \"catalogId\": {\n \"value\": \"\"\n },\n \"clientUUID\": {\n \"value\": \"\"\n },\n \"contextItemIds\": {\n \"value\": \"\"\n },\n \"includeContextItems\": {\n \"value\": \"\"\n },\n \"filterRules\": {\n \"value\": \"\"\n },\n \"displayAttributes\": {\n \"value\": \"\"\n },\n \"abTestContext\": {\n \"value\": \"\"\n },\n \"params\": {\n \"value\": \"\"\n },\n \"inventoryContext\": {\n \"value\": \"\"\n },\n \"metadataCatalogId\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1990-11-06T06:53:04.578Z\",\n \"status\": 5998,\n \"message\": \"string\",\n \"error\": \"string\",\n \"path\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"06cd08ef-1c1c-4533-9a43-c18308923487","name":"An error occurred","originalRequest":{"url":{"path":["recommendations","v2","recommend","items","users",":clientUuid","sections"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"clientUuid","description":"(Required) Information will be shown for the provided profile UUID."}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"slots\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"campaignId\": {\n \"value\": \"\"\n },\n \"campaignName\": {\n \"value\": \"\"\n },\n \"catalogId\": {\n \"value\": \"\"\n },\n \"clientUUID\": {\n \"value\": \"\"\n },\n \"contextItemIds\": {\n \"value\": \"\"\n },\n \"includeContextItems\": {\n \"value\": \"\"\n },\n \"filterRules\": {\n \"value\": \"\"\n },\n \"displayAttributes\": {\n \"value\": \"\"\n },\n \"abTestContext\": {\n \"value\": \"\"\n },\n \"params\": {\n \"value\": \"\"\n },\n \"inventoryContext\": {\n \"value\": \"\"\n },\n \"metadataCatalogId\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1990-11-06T06:53:04.578Z\",\n \"status\": 5998,\n \"message\": \"string\",\n \"error\": \"string\",\n \"path\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"41915427-8234-4000-a23f-a335b567d7d0","name":"Attribute recommendations","request":{"name":"Attribute recommendations","description":{"content":"Retrieve attribute recommendations.\n\n**Note:** The definition of an *item* encompasses products, but also articles, images, videos, and any other entities in the item feed.\n\n---\n\n**API consumers:** AI API key (legacy), Workspace (Business Profile), Web SDK Tracker\n\n**API key permission required:** `RECOMMENDATIONS_V2_ATTRIBUTE_RECOMMENDATIONS_READ`\n","type":"text/plain"},"url":{"path":["recommendations","v2","recommend","items","users",":clientUuid","attributes"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"clientUuid","description":"(Required) Information will be shown for the provided profile UUID."}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"slots\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"campaignId\": {\n \"value\": \"\"\n },\n \"campaignName\": {\n \"value\": \"\"\n },\n \"catalogId\": {\n \"value\": \"\"\n },\n \"clientUUID\": {\n \"value\": \"\"\n },\n \"contextItemIds\": {\n \"value\": \"\"\n },\n \"includeContextItems\": {\n \"value\": \"\"\n },\n \"filterRules\": {\n \"value\": \"\"\n },\n \"displayAttributes\": {\n \"value\": \"\"\n },\n \"abTestContext\": {\n \"value\": \"\"\n },\n \"params\": {\n \"value\": \"\"\n },\n \"inventoryContext\": {\n \"value\": \"\"\n },\n \"metadataCatalogId\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"2ff92075-1e63-4f20-bda4-0c89c1edffad","name":"Attribute recommendations","originalRequest":{"url":{"path":["recommendations","v2","recommend","items","users",":clientUuid","attributes"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"clientUuid","description":"(Required) Information will be shown for the provided profile UUID."}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"slots\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"campaignId\": {\n \"value\": \"\"\n },\n \"campaignName\": {\n \"value\": \"\"\n },\n \"catalogId\": {\n \"value\": \"\"\n },\n \"clientUUID\": {\n \"value\": \"\"\n },\n \"contextItemIds\": {\n \"value\": \"\"\n },\n \"includeContextItems\": {\n \"value\": \"\"\n },\n \"filterRules\": {\n \"value\": \"\"\n },\n \"displayAttributes\": {\n \"value\": \"\"\n },\n \"abTestContext\": {\n \"value\": \"\"\n },\n \"params\": {\n \"value\": \"\"\n },\n \"inventoryContext\": {\n \"value\": \"\"\n },\n \"metadataCatalogId\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"extras\": {\n \"slots\": {\n \"value\": \"\"\n }\n },\n \"data\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"a45604f6-8013-4fc6-8a15-188dd949db1f","name":"No recommendations could be generated for the specified profile and filters","originalRequest":{"url":{"path":["recommendations","v2","recommend","items","users",":clientUuid","attributes"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"clientUuid","description":"(Required) Information will be shown for the provided profile UUID."}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"slots\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"campaignId\": {\n \"value\": \"\"\n },\n \"campaignName\": {\n \"value\": \"\"\n },\n \"catalogId\": {\n \"value\": \"\"\n },\n \"clientUUID\": {\n \"value\": \"\"\n },\n \"contextItemIds\": {\n \"value\": \"\"\n },\n \"includeContextItems\": {\n \"value\": \"\"\n },\n \"filterRules\": {\n \"value\": \"\"\n },\n \"displayAttributes\": {\n \"value\": \"\"\n },\n \"abTestContext\": {\n \"value\": \"\"\n },\n \"params\": {\n \"value\": \"\"\n },\n \"inventoryContext\": {\n \"value\": \"\"\n },\n \"metadataCatalogId\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1990-11-06T06:53:04.578Z\",\n \"status\": 5998,\n \"message\": \"string\",\n \"error\": \"string\",\n \"path\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"8a414a8b-7e56-4260-9f6a-dda92ee7bcf5","name":"An error occurred","originalRequest":{"url":{"path":["recommendations","v2","recommend","items","users",":clientUuid","attributes"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"clientUuid","description":"(Required) Information will be shown for the provided profile UUID."}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"slots\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"campaignId\": {\n \"value\": \"\"\n },\n \"campaignName\": {\n \"value\": \"\"\n },\n \"catalogId\": {\n \"value\": \"\"\n },\n \"clientUUID\": {\n \"value\": \"\"\n },\n \"contextItemIds\": {\n \"value\": \"\"\n },\n \"includeContextItems\": {\n \"value\": \"\"\n },\n \"filterRules\": {\n \"value\": \"\"\n },\n \"displayAttributes\": {\n \"value\": \"\"\n },\n \"abTestContext\": {\n \"value\": \"\"\n },\n \"params\": {\n \"value\": \"\"\n },\n \"inventoryContext\": {\n \"value\": \"\"\n },\n \"metadataCatalogId\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1990-11-06T06:53:04.578Z\",\n \"status\": 5998,\n \"message\": \"string\",\n \"error\": \"string\",\n \"path\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"e6ba9e10-46c4-4072-a2f4-c9b738c02908","name":"Last viewed recommendations","request":{"name":"Last viewed recommendations","description":{"content":"Retrieve recent item recommendations seen by a profile.\n\n**Note:** The definition of an *item* encompasses products, but also articles, images, videos, and any other entities in the item feed.\n\n---\n\n**API consumers:** AI API key (legacy), Workspace (Business Profile), Web SDK Tracker\n\n**API key permission required:** `RECOMMENDATIONS_V2_LAST_VIEWED_RECOMMENDATIONS_READ`\n","type":"text/plain"},"url":{"path":["recommendations","v2","recommend","items","users",":clientUuid","last"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"campaignId","value":"defaultCampaign","description":"The campaignId which will be passed as *utm_campaign* in a link to the recommended item."},{"disabled":false,"key":"campaignName","value":"string","description":"The campaign name which will be included in the recommendation.generated event."},{"disabled":false,"key":"minNumItems","value":"1","description":"The minimal number of returned item recommendations. If the service is not able to return at least this many recommendations, it will return an error."},{"disabled":false,"key":"maxNumItems","value":"5","description":"The maximal number of returned item recommendations."},{"disabled":false,"key":"elastic","value":"false"},{"disabled":false,"key":"filters","value":"[{\"field\":{\"value\":\"\"},\"maxNumItems\":{\"value\":\"\"},\"levelRangeModifier\":{\"value\":\"\"}}]"},{"disabled":false,"key":"includeContextItems","value":"true","description":"The recommendation results will include context items from the request."},{"disabled":false,"key":"params","value":"source:mobile","description":"List of extra params that will be added to the `recommendation.generated` event. They must be in the `name:value` format. The total size must not exceed 500 bytes when written as a JSON object.\n"},{"disabled":false,"key":"inventoryChannelId","value":"string","description":"Inventory context identifier used to evaluate inventory-related filters and boosting strategies. If not provided, no inventory context will be applied.\n"},{"disabled":false,"key":"crossWorkspaceMode","value":"true","description":"Specifies if recommendation should use cross-workspace mode and personalize recommendations with events from other members of workspace group if they are available.\n"}],"variable":[{"disabled":false,"type":"any","value":"string","key":"clientUuid","description":"(Required) Information will be shown for the provided profile UUID."}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"key":"key","value":"token"},{"key":"value","value":"{{apiKey}}"},{"key":"in","value":"query"}]}},"response":[{"id":"5f41c0d1-927d-4e95-9868-e9490ad87265","name":"Last viewed recommendations","originalRequest":{"url":{"path":["recommendations","v2","recommend","items","users",":clientUuid","last"],"host":["{{baseUrl}}"],"query":[{"key":"campaignId","value":"defaultCampaign"},{"key":"campaignName","value":"string"},{"key":"minNumItems","value":"1"},{"key":"maxNumItems","value":"5"},{"key":"elastic","value":"false"},{"key":"filters","value":"[object Object]"},{"key":"includeContextItems","value":"true"},{"key":"params","value":"source:mobile"},{"key":"inventoryChannelId","value":"string"},{"key":"crossWorkspaceMode","value":"true"},{"key":"token","value":""}],"variable":[{"disabled":false,"type":"any","value":"string","key":"clientUuid","description":"(Required) Information will be shown for the provided profile UUID."}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"extras\": {\n \"correlationId\": \"string\",\n \"contextItems\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"campaignId\": \"string\"\n },\n \"data\": [\n {\n \"itemId\": {\n \"value\": \"\"\n }\n },\n {\n \"itemId\": {\n \"value\": \"\"\n }\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"ea7fcb70-ac34-4c99-88fa-f7b27b6e3a10","name":"No recommendations could be generated for the specified profile and filters","originalRequest":{"url":{"path":["recommendations","v2","recommend","items","users",":clientUuid","last"],"host":["{{baseUrl}}"],"query":[{"key":"campaignId","value":"defaultCampaign"},{"key":"campaignName","value":"string"},{"key":"minNumItems","value":"1"},{"key":"maxNumItems","value":"5"},{"key":"elastic","value":"false"},{"key":"filters","value":"[object Object]"},{"key":"includeContextItems","value":"true"},{"key":"params","value":"source:mobile"},{"key":"inventoryChannelId","value":"string"},{"key":"crossWorkspaceMode","value":"true"},{"key":"token","value":""}],"variable":[{"disabled":false,"type":"any","value":"string","key":"clientUuid","description":"(Required) Information will be shown for the provided profile UUID."}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1990-11-06T06:53:04.578Z\",\n \"status\": 5998,\n \"message\": \"string\",\n \"error\": \"string\",\n \"path\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"ad368d4f-43bc-400e-a935-3007a800a766","name":"An error occurred","originalRequest":{"url":{"path":["recommendations","v2","recommend","items","users",":clientUuid","last"],"host":["{{baseUrl}}"],"query":[{"key":"campaignId","value":"defaultCampaign"},{"key":"campaignName","value":"string"},{"key":"minNumItems","value":"1"},{"key":"maxNumItems","value":"5"},{"key":"elastic","value":"false"},{"key":"filters","value":"[object Object]"},{"key":"includeContextItems","value":"true"},{"key":"params","value":"source:mobile"},{"key":"inventoryChannelId","value":"string"},{"key":"crossWorkspaceMode","value":"true"},{"key":"token","value":""}],"variable":[{"disabled":false,"type":"any","value":"string","key":"clientUuid","description":"(Required) Information will be shown for the provided profile UUID."}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1990-11-06T06:53:04.578Z\",\n \"status\": 5998,\n \"message\": \"string\",\n \"error\": \"string\",\n \"path\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"e5ba2439-c971-4319-a101-c70488b12a89","name":"Last viewed recommendations","request":{"name":"Last viewed recommendations","description":{"content":"Retrieve recent item recommendations seen by a profile.\n\n**Note:** The definition of an *item* encompasses products, but also articles, images, videos, and any other entities in the item feed.\n\n---\n\n**API consumers:** AI API key (legacy), Workspace (Business Profile), Web SDK Tracker\n\n**API key permission required:** `RECOMMENDATIONS_V2_LAST_VIEWED_RECOMMENDATIONS_READ`\n","type":"text/plain"},"url":{"path":["recommendations","v2","recommend","items","users",":clientUuid","last"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"clientUuid","description":"(Required) Information will be shown for the provided profile UUID."}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"slots\": [\n {\n \"value\": \"\"\n }\n ],\n \"campaignId\": {\n \"value\": \"\"\n },\n \"campaignName\": {\n \"value\": \"\"\n },\n \"catalogId\": {\n \"value\": \"\"\n },\n \"clientUUID\": {\n \"value\": \"\"\n },\n \"contextItemIds\": {\n \"value\": \"\"\n },\n \"includeContextItems\": {\n \"value\": \"\"\n },\n \"filterRules\": {\n \"value\": \"\"\n },\n \"displayAttributes\": {\n \"value\": \"\"\n },\n \"abTestContext\": {\n \"value\": \"\"\n },\n \"params\": {\n \"value\": \"\"\n },\n \"inventoryContext\": {\n \"value\": \"\"\n },\n \"keepSlotsOrder\": true,\n \"personalizeSlotsOrder\": false,\n \"sortMetric\": \"string\",\n \"boostingParameters\": {\n \"value\": \"\"\n },\n \"boostingStrategies\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"crossWorkspaceMode\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"892bf695-fdb6-40f3-b7a5-8dbf04b06fb5","name":"Last viewed recommendations","originalRequest":{"url":{"path":["recommendations","v2","recommend","items","users",":clientUuid","last"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"clientUuid","description":"(Required) Information will be shown for the provided profile UUID."}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"slots\": [\n {\n \"value\": \"\"\n }\n ],\n \"campaignId\": {\n \"value\": \"\"\n },\n \"campaignName\": {\n \"value\": \"\"\n },\n \"catalogId\": {\n \"value\": \"\"\n },\n \"clientUUID\": {\n \"value\": \"\"\n },\n \"contextItemIds\": {\n \"value\": \"\"\n },\n \"includeContextItems\": {\n \"value\": \"\"\n },\n \"filterRules\": {\n \"value\": \"\"\n },\n \"displayAttributes\": {\n \"value\": \"\"\n },\n \"abTestContext\": {\n \"value\": \"\"\n },\n \"params\": {\n \"value\": \"\"\n },\n \"inventoryContext\": {\n \"value\": \"\"\n },\n \"keepSlotsOrder\": true,\n \"personalizeSlotsOrder\": false,\n \"sortMetric\": \"string\",\n \"boostingParameters\": {\n \"value\": \"\"\n },\n \"boostingStrategies\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"crossWorkspaceMode\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"extras\": {\n \"slots\": {\n \"value\": \"\"\n }\n },\n \"data\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"aca3fe41-f048-4908-a814-272eed7d158a","name":"No recommendations could be generated for the specified profile and filters","originalRequest":{"url":{"path":["recommendations","v2","recommend","items","users",":clientUuid","last"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"clientUuid","description":"(Required) Information will be shown for the provided profile UUID."}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"slots\": [\n {\n \"value\": \"\"\n }\n ],\n \"campaignId\": {\n \"value\": \"\"\n },\n \"campaignName\": {\n \"value\": \"\"\n },\n \"catalogId\": {\n \"value\": \"\"\n },\n \"clientUUID\": {\n \"value\": \"\"\n },\n \"contextItemIds\": {\n \"value\": \"\"\n },\n \"includeContextItems\": {\n \"value\": \"\"\n },\n \"filterRules\": {\n \"value\": \"\"\n },\n \"displayAttributes\": {\n \"value\": \"\"\n },\n \"abTestContext\": {\n \"value\": \"\"\n },\n \"params\": {\n \"value\": \"\"\n },\n \"inventoryContext\": {\n \"value\": \"\"\n },\n \"keepSlotsOrder\": true,\n \"personalizeSlotsOrder\": false,\n \"sortMetric\": \"string\",\n \"boostingParameters\": {\n \"value\": \"\"\n },\n \"boostingStrategies\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"crossWorkspaceMode\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1990-11-06T06:53:04.578Z\",\n \"status\": 5998,\n \"message\": \"string\",\n \"error\": \"string\",\n \"path\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"dad1a350-0400-4e89-81bd-6a8c68dc1364","name":"An error occurred","originalRequest":{"url":{"path":["recommendations","v2","recommend","items","users",":clientUuid","last"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"clientUuid","description":"(Required) Information will be shown for the provided profile UUID."}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"slots\": [\n {\n \"value\": \"\"\n }\n ],\n \"campaignId\": {\n \"value\": \"\"\n },\n \"campaignName\": {\n \"value\": \"\"\n },\n \"catalogId\": {\n \"value\": \"\"\n },\n \"clientUUID\": {\n \"value\": \"\"\n },\n \"contextItemIds\": {\n \"value\": \"\"\n },\n \"includeContextItems\": {\n \"value\": \"\"\n },\n \"filterRules\": {\n \"value\": \"\"\n },\n \"displayAttributes\": {\n \"value\": \"\"\n },\n \"abTestContext\": {\n \"value\": \"\"\n },\n \"params\": {\n \"value\": \"\"\n },\n \"inventoryContext\": {\n \"value\": \"\"\n },\n \"keepSlotsOrder\": true,\n \"personalizeSlotsOrder\": false,\n \"sortMetric\": \"string\",\n \"boostingParameters\": {\n \"value\": \"\"\n },\n \"boostingStrategies\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"crossWorkspaceMode\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1990-11-06T06:53:04.578Z\",\n \"status\": 5998,\n \"message\": \"string\",\n \"error\": \"string\",\n \"path\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"26ff4a44-fe32-4d7c-acd8-cbb9a1ca807b","name":"Recent interactions recommendations","request":{"name":"Recent interactions recommendations","description":{"content":"Retrieve recent interactions recommendations for a profile.\n\n**Note:** The definition of an *item* encompasses products, but also articles, images, videos, and any other entities in the item feed.\n\n---\n\n**API consumers:** AI API key (legacy), Workspace (Business Profile), Web SDK Tracker\n\n**API key permission required:** `RECOMMENDATIONS_V2_RECENT_INTERACTIONS_RECOMMENDATIONS_READ`\n","type":"text/plain"},"url":{"path":["recommendations","v2","recommend","items","users",":clientUuid","aggregates",":aggregateUUID"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"campaignId","value":"defaultCampaign","description":"The campaignId which will be passed as *utm_campaign* in a link to the recommended item."},{"disabled":false,"key":"campaignName","value":"string","description":"The campaign name which will be included in the recommendation.generated event."},{"disabled":false,"key":"minNumItems","value":"1","description":"The minimal number of returned item recommendations. If the service is not able to return at least this many recommendations, it will return an error."},{"disabled":false,"key":"maxNumItems","value":"5","description":"The maximal number of returned item recommendations."},{"disabled":false,"key":"elastic","value":"false"},{"disabled":false,"key":"filters","value":"[{\"field\":{\"value\":\"\"},\"maxNumItems\":{\"value\":\"\"},\"levelRangeModifier\":{\"value\":\"\"}}]"},{"disabled":false,"key":"includeContextItems","value":"true","description":"The recommendation results will include context items from the request."},{"disabled":false,"key":"params","value":"source:mobile","description":"List of extra params that will be added to the `recommendation.generated` event. They must be in the `name:value` format. The total size must not exceed 500 bytes when written as a JSON object.\n"},{"disabled":false,"key":"inventoryChannelId","value":"string","description":"Inventory context identifier used to evaluate inventory-related filters and boosting strategies. If not provided, no inventory context will be applied.\n"},{"disabled":false,"key":"crossWorkspaceMode","value":"true","description":"Specifies if recommendation should use cross-workspace mode and personalize recommendations with events from other members of workspace group if they are available.\n"}],"variable":[{"disabled":false,"type":"any","value":"string","key":"clientUuid","description":"(Required) Information will be shown for the provided profile UUID."},{"disabled":false,"type":"any","value":"string","key":"aggregateUUID","description":"(Required) Information will be shown for the provided aggregate UUID."}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"key":"key","value":"token"},{"key":"value","value":"{{apiKey}}"},{"key":"in","value":"query"}]}},"response":[{"id":"581f9716-1a33-41f5-86cd-7f556b9ee213","name":"Recent interactions recommendations","originalRequest":{"url":{"path":["recommendations","v2","recommend","items","users",":clientUuid","aggregates",":aggregateUUID"],"host":["{{baseUrl}}"],"query":[{"key":"campaignId","value":"defaultCampaign"},{"key":"campaignName","value":"string"},{"key":"minNumItems","value":"1"},{"key":"maxNumItems","value":"5"},{"key":"elastic","value":"false"},{"key":"filters","value":"[object Object]"},{"key":"includeContextItems","value":"true"},{"key":"params","value":"source:mobile"},{"key":"inventoryChannelId","value":"string"},{"key":"crossWorkspaceMode","value":"true"},{"key":"token","value":""}],"variable":[{"disabled":false,"type":"any","value":"string","key":"clientUuid","description":"(Required) Information will be shown for the provided profile UUID."},{"disabled":false,"type":"any","value":"string","key":"aggregateUUID","description":"(Required) Information will be shown for the provided aggregate UUID."}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"extras\": {\n \"correlationId\": \"string\",\n \"contextItems\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"campaignId\": \"string\"\n },\n \"data\": [\n {\n \"itemId\": {\n \"value\": \"\"\n }\n },\n {\n \"itemId\": {\n \"value\": \"\"\n }\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"52155154-121a-45f3-a016-dab646863ba2","name":"No recommendations could be generated for the specified profile and filters","originalRequest":{"url":{"path":["recommendations","v2","recommend","items","users",":clientUuid","aggregates",":aggregateUUID"],"host":["{{baseUrl}}"],"query":[{"key":"campaignId","value":"defaultCampaign"},{"key":"campaignName","value":"string"},{"key":"minNumItems","value":"1"},{"key":"maxNumItems","value":"5"},{"key":"elastic","value":"false"},{"key":"filters","value":"[object Object]"},{"key":"includeContextItems","value":"true"},{"key":"params","value":"source:mobile"},{"key":"inventoryChannelId","value":"string"},{"key":"crossWorkspaceMode","value":"true"},{"key":"token","value":""}],"variable":[{"disabled":false,"type":"any","value":"string","key":"clientUuid","description":"(Required) Information will be shown for the provided profile UUID."},{"disabled":false,"type":"any","value":"string","key":"aggregateUUID","description":"(Required) Information will be shown for the provided aggregate UUID."}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1990-11-06T06:53:04.578Z\",\n \"status\": 5998,\n \"message\": \"string\",\n \"error\": \"string\",\n \"path\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"21c77e75-1d32-4158-80bb-16fb202496f6","name":"An error occurred","originalRequest":{"url":{"path":["recommendations","v2","recommend","items","users",":clientUuid","aggregates",":aggregateUUID"],"host":["{{baseUrl}}"],"query":[{"key":"campaignId","value":"defaultCampaign"},{"key":"campaignName","value":"string"},{"key":"minNumItems","value":"1"},{"key":"maxNumItems","value":"5"},{"key":"elastic","value":"false"},{"key":"filters","value":"[object Object]"},{"key":"includeContextItems","value":"true"},{"key":"params","value":"source:mobile"},{"key":"inventoryChannelId","value":"string"},{"key":"crossWorkspaceMode","value":"true"},{"key":"token","value":""}],"variable":[{"disabled":false,"type":"any","value":"string","key":"clientUuid","description":"(Required) Information will be shown for the provided profile UUID."},{"disabled":false,"type":"any","value":"string","key":"aggregateUUID","description":"(Required) Information will be shown for the provided aggregate UUID."}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1990-11-06T06:53:04.578Z\",\n \"status\": 5998,\n \"message\": \"string\",\n \"error\": \"string\",\n \"path\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"5fb007ed-4117-41e2-b3d0-49d71653ae73","name":"Recent interactions recommendations","request":{"name":"Recent interactions recommendations","description":{"content":"Retrieve recent interactions recommendations for a profile.\n\n**Note:** The definition of an *item* encompasses products, but also articles, images, videos, and any other entities in the item feed.\n\n---\n\n**API consumers:** AI API key (legacy), Workspace (Business Profile), Web SDK Tracker\n\n**API key permission required:** `RECOMMENDATIONS_V2_RECENT_INTERACTIONS_RECOMMENDATIONS_READ`\n","type":"text/plain"},"url":{"path":["recommendations","v2","recommend","items","users",":clientUuid","aggregates",":aggregateUUID"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"clientUuid","description":"(Required) Information will be shown for the provided profile UUID."},{"disabled":false,"type":"any","value":"string","key":"aggregateUUID","description":"(Required) Information will be shown for the provided aggregate UUID."}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"slots\": [\n {\n \"value\": \"\"\n }\n ],\n \"campaignId\": {\n \"value\": \"\"\n },\n \"campaignName\": {\n \"value\": \"\"\n },\n \"catalogId\": {\n \"value\": \"\"\n },\n \"clientUUID\": {\n \"value\": \"\"\n },\n \"contextItemIds\": {\n \"value\": \"\"\n },\n \"includeContextItems\": {\n \"value\": \"\"\n },\n \"filterRules\": {\n \"value\": \"\"\n },\n \"displayAttributes\": {\n \"value\": \"\"\n },\n \"abTestContext\": {\n \"value\": \"\"\n },\n \"params\": {\n \"value\": \"\"\n },\n \"inventoryContext\": {\n \"value\": \"\"\n },\n \"keepSlotsOrder\": true,\n \"personalizeSlotsOrder\": false,\n \"sortMetric\": \"string\",\n \"boostingParameters\": {\n \"value\": \"\"\n },\n \"boostingStrategies\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"crossWorkspaceMode\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"f0593fca-ad7f-4238-975f-0944bd0e873f","name":"Recent interactions recommendations","originalRequest":{"url":{"path":["recommendations","v2","recommend","items","users",":clientUuid","aggregates",":aggregateUUID"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"clientUuid","description":"(Required) Information will be shown for the provided profile UUID."},{"disabled":false,"type":"any","value":"string","key":"aggregateUUID","description":"(Required) Information will be shown for the provided aggregate UUID."}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"slots\": [\n {\n \"value\": \"\"\n }\n ],\n \"campaignId\": {\n \"value\": \"\"\n },\n \"campaignName\": {\n \"value\": \"\"\n },\n \"catalogId\": {\n \"value\": \"\"\n },\n \"clientUUID\": {\n \"value\": \"\"\n },\n \"contextItemIds\": {\n \"value\": \"\"\n },\n \"includeContextItems\": {\n \"value\": \"\"\n },\n \"filterRules\": {\n \"value\": \"\"\n },\n \"displayAttributes\": {\n \"value\": \"\"\n },\n \"abTestContext\": {\n \"value\": \"\"\n },\n \"params\": {\n \"value\": \"\"\n },\n \"inventoryContext\": {\n \"value\": \"\"\n },\n \"keepSlotsOrder\": true,\n \"personalizeSlotsOrder\": false,\n \"sortMetric\": \"string\",\n \"boostingParameters\": {\n \"value\": \"\"\n },\n \"boostingStrategies\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"crossWorkspaceMode\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"extras\": {\n \"slots\": {\n \"value\": \"\"\n }\n },\n \"data\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"8480b345-b052-41e2-ae53-80fbcc574f93","name":"No recommendations could be generated for the specified profile and filters","originalRequest":{"url":{"path":["recommendations","v2","recommend","items","users",":clientUuid","aggregates",":aggregateUUID"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"clientUuid","description":"(Required) Information will be shown for the provided profile UUID."},{"disabled":false,"type":"any","value":"string","key":"aggregateUUID","description":"(Required) Information will be shown for the provided aggregate UUID."}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"slots\": [\n {\n \"value\": \"\"\n }\n ],\n \"campaignId\": {\n \"value\": \"\"\n },\n \"campaignName\": {\n \"value\": \"\"\n },\n \"catalogId\": {\n \"value\": \"\"\n },\n \"clientUUID\": {\n \"value\": \"\"\n },\n \"contextItemIds\": {\n \"value\": \"\"\n },\n \"includeContextItems\": {\n \"value\": \"\"\n },\n \"filterRules\": {\n \"value\": \"\"\n },\n \"displayAttributes\": {\n \"value\": \"\"\n },\n \"abTestContext\": {\n \"value\": \"\"\n },\n \"params\": {\n \"value\": \"\"\n },\n \"inventoryContext\": {\n \"value\": \"\"\n },\n \"keepSlotsOrder\": true,\n \"personalizeSlotsOrder\": false,\n \"sortMetric\": \"string\",\n \"boostingParameters\": {\n \"value\": \"\"\n },\n \"boostingStrategies\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"crossWorkspaceMode\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1990-11-06T06:53:04.578Z\",\n \"status\": 5998,\n \"message\": \"string\",\n \"error\": \"string\",\n \"path\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"803348f6-b8d1-4655-b131-2816bf7957d3","name":"An error occurred","originalRequest":{"url":{"path":["recommendations","v2","recommend","items","users",":clientUuid","aggregates",":aggregateUUID"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"clientUuid","description":"(Required) Information will be shown for the provided profile UUID."},{"disabled":false,"type":"any","value":"string","key":"aggregateUUID","description":"(Required) Information will be shown for the provided aggregate UUID."}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"slots\": [\n {\n \"value\": \"\"\n }\n ],\n \"campaignId\": {\n \"value\": \"\"\n },\n \"campaignName\": {\n \"value\": \"\"\n },\n \"catalogId\": {\n \"value\": \"\"\n },\n \"clientUUID\": {\n \"value\": \"\"\n },\n \"contextItemIds\": {\n \"value\": \"\"\n },\n \"includeContextItems\": {\n \"value\": \"\"\n },\n \"filterRules\": {\n \"value\": \"\"\n },\n \"displayAttributes\": {\n \"value\": \"\"\n },\n \"abTestContext\": {\n \"value\": \"\"\n },\n \"params\": {\n \"value\": \"\"\n },\n \"inventoryContext\": {\n \"value\": \"\"\n },\n \"keepSlotsOrder\": true,\n \"personalizeSlotsOrder\": false,\n \"sortMetric\": \"string\",\n \"boostingParameters\": {\n \"value\": \"\"\n },\n \"boostingStrategies\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"crossWorkspaceMode\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1990-11-06T06:53:04.578Z\",\n \"status\": 5998,\n \"message\": \"string\",\n \"error\": \"string\",\n \"path\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"b784dcd5-46f1-4fd9-a4dc-c710d4f697eb","name":"Scoring by metric","request":{"name":"Scoring by metric","description":{"content":"Returns items with the highest score of a chosen metric. A list of available metrics can be checked by using [this endpoint](https://developers.synerise.com/AnalyticsSuite/AnalyticsSuite.html#operation/ApiGetAvailableMetricsV2).\n\n**Note:** The definition of an *item* encompasses products, but also articles, images, videos, and any other entities in the item feed.\n\n---\n\n**API consumers:** AI API key (legacy), Workspace (Business Profile), Web SDK Tracker\n\n**API key permission required:** `RECOMMENDATIONS_V2_METRICS_RECOMMENDATIONS_READ`\n","type":"text/plain"},"url":{"path":["recommendations","v2","recommend","items","metric"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"sortMetric","value":"string","description":"ID of the metric to sort the results by. The list of available metrics can be checked by using [this endpoint](https://developers.synerise.com/AnalyticsSuite/AnalyticsSuite.html#operation/ApiGetAvailableMetricsV2)."},{"disabled":false,"key":"minNumItems","value":"1","description":"The minimal number of returned item recommendations. If the service is not able to return at least this many recommendations, it will return an error."},{"disabled":false,"key":"maxNumItems","value":"5","description":"The maximal number of returned item recommendations."},{"disabled":false,"key":"campaignId","value":"defaultCampaign","description":"The campaignId which will be passed as *utm_campaign* in a link to the recommended item."},{"disabled":false,"key":"campaignName","value":"string","description":"The campaign name which will be included in the recommendation.generated event."},{"disabled":false,"key":"clientUUID","value":"string","description":"Profile UUID. This parameter is required for these recommendation types:\n - Personalized\n - Last seen\n - Recent interactions\n - Section\n - Attribute\n\nThis parameter can be passed in all recommendations. In recommendations which don't require the customer context, it can still be used to create filters.\n"},{"disabled":false,"key":"itemId","value":"string","description":"Item identifier, equal to `itemId` from the *item feed*. It can be used to define the item context of the query."},{"disabled":false,"key":"excludePurchasedItems","value":"false","description":"When true, the recommendation results will include only items that the profile hasn't purchased before. \n**IMPORTANT**: Only the last 250 purchased items are taken into account. Items further back in the purchase history may be included in the recommendation.\n"},{"disabled":false,"key":"excludePurchasedItemsSinceDays","value":"682","description":"Limits the application of the `excludePurchasedItems` filter to a specified number of days."},{"disabled":false,"key":"filters","value":"string","description":"This string defines the criteria that an item must meet in order to be considered for recommendation. \nFor information on building filters, see [\"Items Query Language (IQL)\" in the Developer Guide](https://hub.synerise.com/developers/iql/).\n"},{"disabled":false,"key":"elastic:filters","value":"string","description":"This string defines the criteria that an item must meet in order to be considered for recommendation. The Elastic filter may be dropped if not enough products meet the required criteria. \nFor information on building filters, see [\"Items Query Language (IQL)\" in the Developer Guide](https://hub.synerise.com/developers/iql/).\n"},{"disabled":false,"key":"itemCatalogId","value":"default","description":"ID (_not_ name) of the item feed to use in the request. The requested recommendation type (model) must be ready for this item feed."},{"disabled":false,"key":"elastic","value":"false"},{"disabled":false,"key":"filters","value":"[{\"field\":{\"value\":\"\"},\"maxNumItems\":{\"value\":\"\"},\"levelRangeModifier\":{\"value\":\"\"}}]"},{"disabled":false,"key":"includeContextItems","value":"true","description":"The recommendation results will include context items from the request."},{"disabled":false,"key":"params","value":"source:mobile","description":"List of extra params that will be added to the `recommendation.generated` event. They must be in the `name:value` format. The total size must not exceed 500 bytes when written as a JSON object.\n"},{"disabled":false,"key":"inventoryChannelId","value":"string","description":"Inventory context identifier used to evaluate inventory-related filters and boosting strategies. If not provided, no inventory context will be applied.\n"},{"disabled":false,"key":"crossWorkspaceMode","value":"true","description":"Specifies if recommendation should use cross-workspace mode and personalize recommendations with events from other members of workspace group if they are available.\n"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"key":"key","value":"token"},{"key":"value","value":"{{apiKey}}"},{"key":"in","value":"query"}]}},"response":[{"id":"7da157f6-240a-4e0e-8fcc-2319487d8a9f","name":"Items with the highest metric scores","originalRequest":{"url":{"path":["recommendations","v2","recommend","items","metric"],"host":["{{baseUrl}}"],"query":[{"key":"sortMetric","value":"string"},{"key":"minNumItems","value":"1"},{"key":"maxNumItems","value":"5"},{"key":"campaignId","value":"defaultCampaign"},{"key":"campaignName","value":"string"},{"key":"clientUUID","value":"string"},{"key":"itemId","value":"string"},{"key":"excludePurchasedItems","value":"false"},{"key":"excludePurchasedItemsSinceDays","value":"682"},{"key":"filters","value":"string"},{"key":"elastic:filters","value":"string"},{"key":"itemCatalogId","value":"default"},{"key":"elastic","value":"false"},{"key":"filters","value":"[object Object]"},{"key":"includeContextItems","value":"true"},{"key":"params","value":"source:mobile"},{"key":"inventoryChannelId","value":"string"},{"key":"crossWorkspaceMode","value":"true"},{"key":"token","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"extras\": {\n \"correlationId\": \"string\",\n \"contextItems\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"campaignId\": \"string\"\n },\n \"data\": [\n {\n \"itemId\": {\n \"value\": \"\"\n }\n },\n {\n \"itemId\": {\n \"value\": \"\"\n }\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"ccaea678-bd50-4e82-a16a-0f192990d21b","name":"No recommendations could be generated for the specified profile and filters","originalRequest":{"url":{"path":["recommendations","v2","recommend","items","metric"],"host":["{{baseUrl}}"],"query":[{"key":"sortMetric","value":"string"},{"key":"minNumItems","value":"1"},{"key":"maxNumItems","value":"5"},{"key":"campaignId","value":"defaultCampaign"},{"key":"campaignName","value":"string"},{"key":"clientUUID","value":"string"},{"key":"itemId","value":"string"},{"key":"excludePurchasedItems","value":"false"},{"key":"excludePurchasedItemsSinceDays","value":"682"},{"key":"filters","value":"string"},{"key":"elastic:filters","value":"string"},{"key":"itemCatalogId","value":"default"},{"key":"elastic","value":"false"},{"key":"filters","value":"[object Object]"},{"key":"includeContextItems","value":"true"},{"key":"params","value":"source:mobile"},{"key":"inventoryChannelId","value":"string"},{"key":"crossWorkspaceMode","value":"true"},{"key":"token","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1990-11-06T06:53:04.578Z\",\n \"status\": 5998,\n \"message\": \"string\",\n \"error\": \"string\",\n \"path\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"0b17db29-f09c-4139-9008-9c44e0370680","name":"An error occurred","originalRequest":{"url":{"path":["recommendations","v2","recommend","items","metric"],"host":["{{baseUrl}}"],"query":[{"key":"sortMetric","value":"string"},{"key":"minNumItems","value":"1"},{"key":"maxNumItems","value":"5"},{"key":"campaignId","value":"defaultCampaign"},{"key":"campaignName","value":"string"},{"key":"clientUUID","value":"string"},{"key":"itemId","value":"string"},{"key":"excludePurchasedItems","value":"false"},{"key":"excludePurchasedItemsSinceDays","value":"682"},{"key":"filters","value":"string"},{"key":"elastic:filters","value":"string"},{"key":"itemCatalogId","value":"default"},{"key":"elastic","value":"false"},{"key":"filters","value":"[object Object]"},{"key":"includeContextItems","value":"true"},{"key":"params","value":"source:mobile"},{"key":"inventoryChannelId","value":"string"},{"key":"crossWorkspaceMode","value":"true"},{"key":"token","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1990-11-06T06:53:04.578Z\",\n \"status\": 5998,\n \"message\": \"string\",\n \"error\": \"string\",\n \"path\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"af8c752d-bf26-44aa-870a-db1fe4a733fb","name":"Scoring by metric","request":{"name":"Scoring by metric","description":{"content":"Returns items with the highest score of a chosen metric. A list of available metrics can be checked by using [this endpoint](https://developers.synerise.com/AnalyticsSuite/AnalyticsSuite.html#operation/ApiGetAvailableMetricsV2).\n\n**Note:** The definition of an *item* encompasses products, but also articles, images, videos, and any other entities in the item feed.\n\n---\n\n**API consumers:** AI API key (legacy), Workspace (Business Profile), Web SDK Tracker\n\n**API key permission required:** `RECOMMENDATIONS_V2_METRICS_RECOMMENDATIONS_READ`\n","type":"text/plain"},"url":{"path":["recommendations","v2","recommend","items","metric"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"apikey","apikey":[{"key":"key","value":"token"},{"key":"value","value":"{{apiKey}}"},{"key":"in","value":"query"}]},"body":{"mode":"raw","raw":"{\n \"sortMetric\": 2890,\n \"clientUUID\": 8851.767765339664\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"2f497a4d-e026-452a-8e77-d45dea2bb191","name":"Items with the highest metric scores","originalRequest":{"url":{"path":["recommendations","v2","recommend","items","metric"],"host":["{{baseUrl}}"],"query":[{"key":"token","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"sortMetric\": 2890,\n \"clientUUID\": 8851.767765339664\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"extras\": {\n \"slots\": {\n \"value\": \"\"\n }\n },\n \"data\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"79780375-7c0f-4e8d-808b-8907eeed3629","name":"No recommendations could be generated for the specified profile and filters","originalRequest":{"url":{"path":["recommendations","v2","recommend","items","metric"],"host":["{{baseUrl}}"],"query":[{"key":"token","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"sortMetric\": 2890,\n \"clientUUID\": 8851.767765339664\n}","options":{"raw":{"language":"json"}}}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1990-11-06T06:53:04.578Z\",\n \"status\": 5998,\n \"message\": \"string\",\n \"error\": \"string\",\n \"path\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"991b105f-a1df-443d-ac0c-b0b4554adee2","name":"An error occurred","originalRequest":{"url":{"path":["recommendations","v2","recommend","items","metric"],"host":["{{baseUrl}}"],"query":[{"key":"token","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"sortMetric\": 2890,\n \"clientUUID\": 8851.767765339664\n}","options":{"raw":{"language":"json"}}}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1990-11-06T06:53:04.578Z\",\n \"status\": 5998,\n \"message\": \"string\",\n \"error\": \"string\",\n \"path\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"28e3b5f1-1b8e-4b03-a3b8-154f4c43fb49","name":"Complementary items for a cart","request":{"name":"Complementary items for a cart","description":{"content":"Show recommendations based on the contents of a cart.\n\n**Note:** The definition of an *item* encompasses products, but also articles, images, videos, and any other entities in the item feed.\n\n---\n\n**API consumers:** AI API key (legacy), Workspace (Business Profile), Web SDK Tracker\n\n**API key permission required:** `RECOMMENDATIONS_V2_COMPLEMENTARY_RECOMMENDATIONS_READ`\n","type":"text/plain"},"url":{"path":["recommendations","v2","recommend","items","complementary"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"clientUUID","value":"string","description":"Profile UUID. This parameter is required for these recommendation types:\n - Personalized\n - Last seen\n - Recent interactions\n - Section\n - Attribute\n\nThis parameter can be passed in all recommendations. In recommendations which don't require the customer context, it can still be used to create filters.\n"},{"disabled":false,"key":"minNumItems","value":"1","description":"The minimal number of returned item recommendations. If the service is not able to return at least this many recommendations, it will return an error."},{"disabled":false,"key":"maxNumItems","value":"5","description":"The maximal number of returned item recommendations."},{"disabled":false,"key":"campaignId","value":"defaultCampaign","description":"The campaignId which will be passed as *utm_campaign* in a link to the recommended item."},{"disabled":false,"key":"campaignName","value":"string","description":"The campaign name which will be included in the recommendation.generated event."},{"disabled":false,"key":"excludePurchasedItems","value":"false","description":"When true, the recommendation results will include only items that the profile hasn't purchased before. \n**IMPORTANT**: Only the last 250 purchased items are taken into account. Items further back in the purchase history may be included in the recommendation.\n"},{"disabled":false,"key":"excludePurchasedItemsSinceDays","value":"682","description":"Limits the application of the `excludePurchasedItems` filter to a specified number of days."},{"disabled":false,"key":"filters","value":"string","description":"This string defines the criteria that an item must meet in order to be considered for recommendation. \nFor information on building filters, see [\"Items Query Language (IQL)\" in the Developer Guide](https://hub.synerise.com/developers/iql/).\n"},{"disabled":false,"key":"elastic:filters","value":"string","description":"This string defines the criteria that an item must meet in order to be considered for recommendation. The Elastic filter may be dropped if not enough products meet the required criteria. \nFor information on building filters, see [\"Items Query Language (IQL)\" in the Developer Guide](https://hub.synerise.com/developers/iql/).\n"},{"disabled":false,"key":"itemId","value":"string","description":"Item identifiers, equal to `itemId` from the *item feed*. They can be used to define the item context of the query."},{"disabled":false,"key":"itemId","value":"string","description":"Item identifiers, equal to `itemId` from the *item feed*. They can be used to define the item context of the query."},{"disabled":false,"key":"itemCatalogId","value":"default","description":"ID (_not_ name) of the item feed to use in the request. The requested recommendation type (model) must be ready for this item feed."},{"disabled":false,"key":"boostMetric","value":"string","description":"ID of the metric to boost the results by. Metric scores will be combined with recommendation scores, favoring the best-performing results. The list of available metrics can be checked by using [this endpoint](https://developers.synerise.com/AnalyticsSuite/AnalyticsSuite.html#operation/ApiGetAvailableMetricsV2)."},{"disabled":false,"key":"sortMetric","value":"string","description":"ID of the metric to sort the results by. The list of available metrics can be checked by using [this endpoint](https://developers.synerise.com/AnalyticsSuite/AnalyticsSuite.html#operation/ApiGetAvailableMetricsV2)."},{"disabled":false,"key":"elastic","value":"false"},{"disabled":false,"key":"filters","value":"[{\"field\":{\"value\":\"\"},\"maxNumItems\":{\"value\":\"\"},\"levelRangeModifier\":{\"value\":\"\"}}]"},{"disabled":false,"key":"includeContextItems","value":"true","description":"The recommendation results will include context items from the request."},{"disabled":false,"key":"params","value":"source:mobile","description":"List of extra params that will be added to the `recommendation.generated` event. They must be in the `name:value` format. The total size must not exceed 500 bytes when written as a JSON object.\n"},{"disabled":false,"key":"inventoryChannelId","value":"string","description":"Inventory context identifier used to evaluate inventory-related filters and boosting strategies. If not provided, no inventory context will be applied.\n"},{"disabled":false,"key":"crossWorkspaceMode","value":"true","description":"Specifies if recommendation should use cross-workspace mode and personalize recommendations with events from other members of workspace group if they are available.\n"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"key":"key","value":"token"},{"key":"value","value":"{{apiKey}}"},{"key":"in","value":"query"}]}},"response":[{"id":"9339d635-cbb7-41d4-95f3-7858abd86755","name":"Cart complementary recommendations","originalRequest":{"url":{"path":["recommendations","v2","recommend","items","complementary"],"host":["{{baseUrl}}"],"query":[{"key":"clientUUID","value":"string"},{"key":"minNumItems","value":"1"},{"key":"maxNumItems","value":"5"},{"key":"campaignId","value":"defaultCampaign"},{"key":"campaignName","value":"string"},{"key":"excludePurchasedItems","value":"false"},{"key":"excludePurchasedItemsSinceDays","value":"682"},{"key":"filters","value":"string"},{"key":"elastic:filters","value":"string"},{"key":"itemId","value":"string"},{"key":"itemId","value":"string"},{"key":"itemCatalogId","value":"default"},{"key":"boostMetric","value":"string"},{"key":"sortMetric","value":"string"},{"key":"elastic","value":"false"},{"key":"filters","value":"[object Object]"},{"key":"includeContextItems","value":"true"},{"key":"params","value":"source:mobile"},{"key":"inventoryChannelId","value":"string"},{"key":"crossWorkspaceMode","value":"true"},{"key":"token","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"extras\": {\n \"correlationId\": \"string\",\n \"contextItems\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"campaignId\": \"string\"\n },\n \"data\": [\n {\n \"itemId\": {\n \"value\": \"\"\n }\n },\n {\n \"itemId\": {\n \"value\": \"\"\n }\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"26e0f461-38d0-4328-870b-3b6958d86f01","name":"No recommendations could be generated for the specified profile and filters","originalRequest":{"url":{"path":["recommendations","v2","recommend","items","complementary"],"host":["{{baseUrl}}"],"query":[{"key":"clientUUID","value":"string"},{"key":"minNumItems","value":"1"},{"key":"maxNumItems","value":"5"},{"key":"campaignId","value":"defaultCampaign"},{"key":"campaignName","value":"string"},{"key":"excludePurchasedItems","value":"false"},{"key":"excludePurchasedItemsSinceDays","value":"682"},{"key":"filters","value":"string"},{"key":"elastic:filters","value":"string"},{"key":"itemId","value":"string"},{"key":"itemId","value":"string"},{"key":"itemCatalogId","value":"default"},{"key":"boostMetric","value":"string"},{"key":"sortMetric","value":"string"},{"key":"elastic","value":"false"},{"key":"filters","value":"[object Object]"},{"key":"includeContextItems","value":"true"},{"key":"params","value":"source:mobile"},{"key":"inventoryChannelId","value":"string"},{"key":"crossWorkspaceMode","value":"true"},{"key":"token","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1990-11-06T06:53:04.578Z\",\n \"status\": 5998,\n \"message\": \"string\",\n \"error\": \"string\",\n \"path\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"e7f004b8-f868-4848-b17d-73b4f12eb9ab","name":"An error occurred","originalRequest":{"url":{"path":["recommendations","v2","recommend","items","complementary"],"host":["{{baseUrl}}"],"query":[{"key":"clientUUID","value":"string"},{"key":"minNumItems","value":"1"},{"key":"maxNumItems","value":"5"},{"key":"campaignId","value":"defaultCampaign"},{"key":"campaignName","value":"string"},{"key":"excludePurchasedItems","value":"false"},{"key":"excludePurchasedItemsSinceDays","value":"682"},{"key":"filters","value":"string"},{"key":"elastic:filters","value":"string"},{"key":"itemId","value":"string"},{"key":"itemId","value":"string"},{"key":"itemCatalogId","value":"default"},{"key":"boostMetric","value":"string"},{"key":"sortMetric","value":"string"},{"key":"elastic","value":"false"},{"key":"filters","value":"[object Object]"},{"key":"includeContextItems","value":"true"},{"key":"params","value":"source:mobile"},{"key":"inventoryChannelId","value":"string"},{"key":"crossWorkspaceMode","value":"true"},{"key":"token","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1990-11-06T06:53:04.578Z\",\n \"status\": 5998,\n \"message\": \"string\",\n \"error\": \"string\",\n \"path\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"8136996d-d381-4a21-be6e-46a0c41c25af","name":"Complementary items for a cart","request":{"name":"Complementary items for a cart","description":{"content":"Show recommendations based on the contents of a cart.\n\n**Note:** The definition of an *item* encompasses products, but also articles, images, videos, and any other entities in the item feed.\n\n---\n\n**API consumers:** AI API key (legacy), Workspace (Business Profile), Web SDK Tracker\n\n**API key permission required:** `RECOMMENDATIONS_V2_COMPLEMENTARY_RECOMMENDATIONS_READ`\n","type":"text/plain"},"url":{"path":["recommendations","v2","recommend","items","complementary"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"slots\": [\n {\n \"value\": \"\"\n }\n ],\n \"campaignId\": {\n \"value\": \"\"\n },\n \"campaignName\": {\n \"value\": \"\"\n },\n \"catalogId\": {\n \"value\": \"\"\n },\n \"clientUUID\": {\n \"value\": \"\"\n },\n \"contextItemIds\": {\n \"value\": \"\"\n },\n \"includeContextItems\": {\n \"value\": \"\"\n },\n \"filterRules\": {\n \"value\": \"\"\n },\n \"displayAttributes\": {\n \"value\": \"\"\n },\n \"abTestContext\": {\n \"value\": \"\"\n },\n \"params\": {\n \"value\": \"\"\n },\n \"inventoryContext\": {\n \"value\": \"\"\n },\n \"keepSlotsOrder\": true,\n \"personalizeSlotsOrder\": false,\n \"sortMetric\": \"string\",\n \"boostingParameters\": {\n \"value\": \"\"\n },\n \"boostingStrategies\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"crossWorkspaceMode\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"33571585-cc3c-442e-9614-ec4ab5b9403b","name":"Cart complementary recommendations","originalRequest":{"url":{"path":["recommendations","v2","recommend","items","complementary"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"slots\": [\n {\n \"value\": \"\"\n }\n ],\n \"campaignId\": {\n \"value\": \"\"\n },\n \"campaignName\": {\n \"value\": \"\"\n },\n \"catalogId\": {\n \"value\": \"\"\n },\n \"clientUUID\": {\n \"value\": \"\"\n },\n \"contextItemIds\": {\n \"value\": \"\"\n },\n \"includeContextItems\": {\n \"value\": \"\"\n },\n \"filterRules\": {\n \"value\": \"\"\n },\n \"displayAttributes\": {\n \"value\": \"\"\n },\n \"abTestContext\": {\n \"value\": \"\"\n },\n \"params\": {\n \"value\": \"\"\n },\n \"inventoryContext\": {\n \"value\": \"\"\n },\n \"keepSlotsOrder\": true,\n \"personalizeSlotsOrder\": false,\n \"sortMetric\": \"string\",\n \"boostingParameters\": {\n \"value\": \"\"\n },\n \"boostingStrategies\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"crossWorkspaceMode\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"extras\": {\n \"slots\": {\n \"value\": \"\"\n }\n },\n \"data\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"8e53f8ef-d91b-43a9-b153-e636ae162abe","name":"No recommendations could be generated for the specified profile and filters","originalRequest":{"url":{"path":["recommendations","v2","recommend","items","complementary"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"slots\": [\n {\n \"value\": \"\"\n }\n ],\n \"campaignId\": {\n \"value\": \"\"\n },\n \"campaignName\": {\n \"value\": \"\"\n },\n \"catalogId\": {\n \"value\": \"\"\n },\n \"clientUUID\": {\n \"value\": \"\"\n },\n \"contextItemIds\": {\n \"value\": \"\"\n },\n \"includeContextItems\": {\n \"value\": \"\"\n },\n \"filterRules\": {\n \"value\": \"\"\n },\n \"displayAttributes\": {\n \"value\": \"\"\n },\n \"abTestContext\": {\n \"value\": \"\"\n },\n \"params\": {\n \"value\": \"\"\n },\n \"inventoryContext\": {\n \"value\": \"\"\n },\n \"keepSlotsOrder\": true,\n \"personalizeSlotsOrder\": false,\n \"sortMetric\": \"string\",\n \"boostingParameters\": {\n \"value\": \"\"\n },\n \"boostingStrategies\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"crossWorkspaceMode\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1990-11-06T06:53:04.578Z\",\n \"status\": 5998,\n \"message\": \"string\",\n \"error\": \"string\",\n \"path\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"d47db9b6-2cff-4194-9b51-a3b00a48de8f","name":"An error occurred","originalRequest":{"url":{"path":["recommendations","v2","recommend","items","complementary"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"slots\": [\n {\n \"value\": \"\"\n }\n ],\n \"campaignId\": {\n \"value\": \"\"\n },\n \"campaignName\": {\n \"value\": \"\"\n },\n \"catalogId\": {\n \"value\": \"\"\n },\n \"clientUUID\": {\n \"value\": \"\"\n },\n \"contextItemIds\": {\n \"value\": \"\"\n },\n \"includeContextItems\": {\n \"value\": \"\"\n },\n \"filterRules\": {\n \"value\": \"\"\n },\n \"displayAttributes\": {\n \"value\": \"\"\n },\n \"abTestContext\": {\n \"value\": \"\"\n },\n \"params\": {\n \"value\": \"\"\n },\n \"inventoryContext\": {\n \"value\": \"\"\n },\n \"keepSlotsOrder\": true,\n \"personalizeSlotsOrder\": false,\n \"sortMetric\": \"string\",\n \"boostingParameters\": {\n \"value\": \"\"\n },\n \"boostingStrategies\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"crossWorkspaceMode\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1990-11-06T06:53:04.578Z\",\n \"status\": 5998,\n \"message\": \"string\",\n \"error\": \"string\",\n \"path\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"df6910c0-6304-4e49-8dee-84f68a8f3b39","name":"Complementary items","request":{"name":"Complementary items","description":{"content":"Returns items complementary to the given items.\n\n**Note:** The definition of an *item* encompasses products, but also articles, images, videos, and any other entities in the item feed.\n\n---\n\n**API consumers:** AI API key (legacy), Workspace (Business Profile), Web SDK Tracker\n\n**API key permission required:** `RECOMMENDATIONS_V2_COMPLEMENTARY_PRODUCTS_RECOMMENDATIONS_READ`\n","type":"text/plain"},"url":{"path":["recommendations","v2","recommend","items",":itemId","complementary"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"minNumItems","value":"1","description":"The minimal number of returned item recommendations. If the service is not able to return at least this many recommendations, it will return an error."},{"disabled":false,"key":"maxNumItems","value":"5","description":"The maximal number of returned item recommendations."},{"disabled":false,"key":"campaignId","value":"defaultCampaign","description":"The campaignId which will be passed as *utm_campaign* in a link to the recommended item."},{"disabled":false,"key":"campaignName","value":"string","description":"The campaign name which will be included in the recommendation.generated event."},{"disabled":false,"key":"clientUUID","value":"string","description":"Profile UUID. This parameter is required for these recommendation types:\n - Personalized\n - Last seen\n - Recent interactions\n - Section\n - Attribute\n\nThis parameter can be passed in all recommendations. In recommendations which don't require the customer context, it can still be used to create filters.\n"},{"disabled":false,"key":"excludePurchasedItems","value":"false","description":"When true, the recommendation results will include only items that the profile hasn't purchased before. \n**IMPORTANT**: Only the last 250 purchased items are taken into account. Items further back in the purchase history may be included in the recommendation.\n"},{"disabled":false,"key":"excludePurchasedItemsSinceDays","value":"682","description":"Limits the application of the `excludePurchasedItems` filter to a specified number of days."},{"disabled":false,"key":"filters","value":"string","description":"This string defines the criteria that an item must meet in order to be considered for recommendation. \nFor information on building filters, see [\"Items Query Language (IQL)\" in the Developer Guide](https://hub.synerise.com/developers/iql/).\n"},{"disabled":false,"key":"elastic:filters","value":"string","description":"This string defines the criteria that an item must meet in order to be considered for recommendation. The Elastic filter may be dropped if not enough products meet the required criteria. \nFor information on building filters, see [\"Items Query Language (IQL)\" in the Developer Guide](https://hub.synerise.com/developers/iql/).\n"},{"disabled":false,"key":"itemCatalogId","value":"default","description":"ID (_not_ name) of the item feed to use in the request. The requested recommendation type (model) must be ready for this item feed."},{"disabled":false,"key":"elastic","value":"false"},{"disabled":false,"key":"filters","value":"[{\"field\":{\"value\":\"\"},\"maxNumItems\":{\"value\":\"\"},\"levelRangeModifier\":{\"value\":\"\"}}]"},{"disabled":false,"key":"includeContextItems","value":"true","description":"The recommendation results will include context items from the request."},{"disabled":false,"key":"params","value":"source:mobile","description":"List of extra params that will be added to the `recommendation.generated` event. They must be in the `name:value` format. The total size must not exceed 500 bytes when written as a JSON object.\n"},{"disabled":false,"key":"inventoryChannelId","value":"string","description":"Inventory context identifier used to evaluate inventory-related filters and boosting strategies. If not provided, no inventory context will be applied.\n"},{"disabled":false,"key":"crossWorkspaceMode","value":"true","description":"Specifies if recommendation should use cross-workspace mode and personalize recommendations with events from other members of workspace group if they are available.\n"}],"variable":[{"disabled":false,"type":"any","value":"string","key":"itemId","description":"(Required) Item identifier, equal to `itemId` from the *item feed*."}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"key":"key","value":"token"},{"key":"value","value":"{{apiKey}}"},{"key":"in","value":"query"}]}},"response":[{"id":"5fa55c6e-da21-4c01-bfac-64b9318e67cc","name":"Items complementary to the given item","originalRequest":{"url":{"path":["recommendations","v2","recommend","items",":itemId","complementary"],"host":["{{baseUrl}}"],"query":[{"key":"minNumItems","value":"1"},{"key":"maxNumItems","value":"5"},{"key":"campaignId","value":"defaultCampaign"},{"key":"campaignName","value":"string"},{"key":"clientUUID","value":"string"},{"key":"excludePurchasedItems","value":"false"},{"key":"excludePurchasedItemsSinceDays","value":"682"},{"key":"filters","value":"string"},{"key":"elastic:filters","value":"string"},{"key":"itemCatalogId","value":"default"},{"key":"elastic","value":"false"},{"key":"filters","value":"[object Object]"},{"key":"includeContextItems","value":"true"},{"key":"params","value":"source:mobile"},{"key":"inventoryChannelId","value":"string"},{"key":"crossWorkspaceMode","value":"true"},{"key":"token","value":""}],"variable":[{"disabled":false,"type":"any","value":"string","key":"itemId","description":"(Required) Item identifier, equal to `itemId` from the *item feed*."}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"extras\": {\n \"correlationId\": \"string\",\n \"contextItems\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"campaignId\": \"string\"\n },\n \"data\": [\n {\n \"itemId\": {\n \"value\": \"\"\n }\n },\n {\n \"itemId\": {\n \"value\": \"\"\n }\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"48c4a5ab-006d-4ee3-bebc-e63b75fecf70","name":"No recommendations could be generated for the specified profile and filters","originalRequest":{"url":{"path":["recommendations","v2","recommend","items",":itemId","complementary"],"host":["{{baseUrl}}"],"query":[{"key":"minNumItems","value":"1"},{"key":"maxNumItems","value":"5"},{"key":"campaignId","value":"defaultCampaign"},{"key":"campaignName","value":"string"},{"key":"clientUUID","value":"string"},{"key":"excludePurchasedItems","value":"false"},{"key":"excludePurchasedItemsSinceDays","value":"682"},{"key":"filters","value":"string"},{"key":"elastic:filters","value":"string"},{"key":"itemCatalogId","value":"default"},{"key":"elastic","value":"false"},{"key":"filters","value":"[object Object]"},{"key":"includeContextItems","value":"true"},{"key":"params","value":"source:mobile"},{"key":"inventoryChannelId","value":"string"},{"key":"crossWorkspaceMode","value":"true"},{"key":"token","value":""}],"variable":[{"disabled":false,"type":"any","value":"string","key":"itemId","description":"(Required) Item identifier, equal to `itemId` from the *item feed*."}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1990-11-06T06:53:04.578Z\",\n \"status\": 5998,\n \"message\": \"string\",\n \"error\": \"string\",\n \"path\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"14e790ca-f717-4a3e-9156-7e5d1c8af87c","name":"An error occurred","originalRequest":{"url":{"path":["recommendations","v2","recommend","items",":itemId","complementary"],"host":["{{baseUrl}}"],"query":[{"key":"minNumItems","value":"1"},{"key":"maxNumItems","value":"5"},{"key":"campaignId","value":"defaultCampaign"},{"key":"campaignName","value":"string"},{"key":"clientUUID","value":"string"},{"key":"excludePurchasedItems","value":"false"},{"key":"excludePurchasedItemsSinceDays","value":"682"},{"key":"filters","value":"string"},{"key":"elastic:filters","value":"string"},{"key":"itemCatalogId","value":"default"},{"key":"elastic","value":"false"},{"key":"filters","value":"[object Object]"},{"key":"includeContextItems","value":"true"},{"key":"params","value":"source:mobile"},{"key":"inventoryChannelId","value":"string"},{"key":"crossWorkspaceMode","value":"true"},{"key":"token","value":""}],"variable":[{"disabled":false,"type":"any","value":"string","key":"itemId","description":"(Required) Item identifier, equal to `itemId` from the *item feed*."}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1990-11-06T06:53:04.578Z\",\n \"status\": 5998,\n \"message\": \"string\",\n \"error\": \"string\",\n \"path\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"d6395e1e-d09f-4a69-9ead-8d6af12305b8","name":"Complementary items","request":{"name":"Complementary items","description":{"content":"Returns items complementary to the given items.\n\n**Note:** The definition of an *item* encompasses products, but also articles, images, videos, and any other entities in the item feed.\n\n---\n\n**API consumers:** AI API key (legacy), Workspace (Business Profile), Web SDK Tracker\n\n**API key permission required:** `RECOMMENDATIONS_V2_COMPLEMENTARY_PRODUCTS_RECOMMENDATIONS_READ`\n","type":"text/plain"},"url":{"path":["recommendations","v2","recommend","items",":itemId","complementary"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"itemId","description":"(Required) Item identifier, equal to `itemId` from the *item feed*."}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"apikey","apikey":[{"key":"key","value":"token"},{"key":"value","value":"{{apiKey}}"},{"key":"in","value":"query"}]},"body":{"mode":"raw","raw":"{\n \"slots\": [\n {\n \"value\": \"\"\n }\n ],\n \"campaignId\": {\n \"value\": \"\"\n },\n \"campaignName\": {\n \"value\": \"\"\n },\n \"catalogId\": {\n \"value\": \"\"\n },\n \"clientUUID\": {\n \"value\": \"\"\n },\n \"contextItemIds\": {\n \"value\": \"\"\n },\n \"includeContextItems\": {\n \"value\": \"\"\n },\n \"filterRules\": {\n \"value\": \"\"\n },\n \"displayAttributes\": {\n \"value\": \"\"\n },\n \"abTestContext\": {\n \"value\": \"\"\n },\n \"params\": {\n \"value\": \"\"\n },\n \"inventoryContext\": {\n \"value\": \"\"\n },\n \"keepSlotsOrder\": true,\n \"personalizeSlotsOrder\": false,\n \"sortMetric\": \"string\",\n \"boostingParameters\": {\n \"value\": \"\"\n },\n \"boostingStrategies\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"crossWorkspaceMode\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"5e1ec3d3-895d-4ae9-9b87-25184d0361a7","name":"Items complementary to the given item","originalRequest":{"url":{"path":["recommendations","v2","recommend","items",":itemId","complementary"],"host":["{{baseUrl}}"],"query":[{"key":"token","value":""}],"variable":[{"disabled":false,"type":"any","value":"string","key":"itemId","description":"(Required) Item identifier, equal to `itemId` from the *item feed*."}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"slots\": [\n {\n \"value\": \"\"\n }\n ],\n \"campaignId\": {\n \"value\": \"\"\n },\n \"campaignName\": {\n \"value\": \"\"\n },\n \"catalogId\": {\n \"value\": \"\"\n },\n \"clientUUID\": {\n \"value\": \"\"\n },\n \"contextItemIds\": {\n \"value\": \"\"\n },\n \"includeContextItems\": {\n \"value\": \"\"\n },\n \"filterRules\": {\n \"value\": \"\"\n },\n \"displayAttributes\": {\n \"value\": \"\"\n },\n \"abTestContext\": {\n \"value\": \"\"\n },\n \"params\": {\n \"value\": \"\"\n },\n \"inventoryContext\": {\n \"value\": \"\"\n },\n \"keepSlotsOrder\": true,\n \"personalizeSlotsOrder\": false,\n \"sortMetric\": \"string\",\n \"boostingParameters\": {\n \"value\": \"\"\n },\n \"boostingStrategies\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"crossWorkspaceMode\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"extras\": {\n \"slots\": {\n \"value\": \"\"\n }\n },\n \"data\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"72506c49-c8e4-440d-a62a-6a0c7e38f5e4","name":"No recommendations could be generated for the specified profile and filters","originalRequest":{"url":{"path":["recommendations","v2","recommend","items",":itemId","complementary"],"host":["{{baseUrl}}"],"query":[{"key":"token","value":""}],"variable":[{"disabled":false,"type":"any","value":"string","key":"itemId","description":"(Required) Item identifier, equal to `itemId` from the *item feed*."}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"slots\": [\n {\n \"value\": \"\"\n }\n ],\n \"campaignId\": {\n \"value\": \"\"\n },\n \"campaignName\": {\n \"value\": \"\"\n },\n \"catalogId\": {\n \"value\": \"\"\n },\n \"clientUUID\": {\n \"value\": \"\"\n },\n \"contextItemIds\": {\n \"value\": \"\"\n },\n \"includeContextItems\": {\n \"value\": \"\"\n },\n \"filterRules\": {\n \"value\": \"\"\n },\n \"displayAttributes\": {\n \"value\": \"\"\n },\n \"abTestContext\": {\n \"value\": \"\"\n },\n \"params\": {\n \"value\": \"\"\n },\n \"inventoryContext\": {\n \"value\": \"\"\n },\n \"keepSlotsOrder\": true,\n \"personalizeSlotsOrder\": false,\n \"sortMetric\": \"string\",\n \"boostingParameters\": {\n \"value\": \"\"\n },\n \"boostingStrategies\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"crossWorkspaceMode\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1990-11-06T06:53:04.578Z\",\n \"status\": 5998,\n \"message\": \"string\",\n \"error\": \"string\",\n \"path\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"d0f20c60-455a-4294-88ca-a541572a68ea","name":"An error occurred","originalRequest":{"url":{"path":["recommendations","v2","recommend","items",":itemId","complementary"],"host":["{{baseUrl}}"],"query":[{"key":"token","value":""}],"variable":[{"disabled":false,"type":"any","value":"string","key":"itemId","description":"(Required) Item identifier, equal to `itemId` from the *item feed*."}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"slots\": [\n {\n \"value\": \"\"\n }\n ],\n \"campaignId\": {\n \"value\": \"\"\n },\n \"campaignName\": {\n \"value\": \"\"\n },\n \"catalogId\": {\n \"value\": \"\"\n },\n \"clientUUID\": {\n \"value\": \"\"\n },\n \"contextItemIds\": {\n \"value\": \"\"\n },\n \"includeContextItems\": {\n \"value\": \"\"\n },\n \"filterRules\": {\n \"value\": \"\"\n },\n \"displayAttributes\": {\n \"value\": \"\"\n },\n \"abTestContext\": {\n \"value\": \"\"\n },\n \"params\": {\n \"value\": \"\"\n },\n \"inventoryContext\": {\n \"value\": \"\"\n },\n \"keepSlotsOrder\": true,\n \"personalizeSlotsOrder\": false,\n \"sortMetric\": \"string\",\n \"boostingParameters\": {\n \"value\": \"\"\n },\n \"boostingStrategies\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"crossWorkspaceMode\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1990-11-06T06:53:04.578Z\",\n \"status\": 5998,\n \"message\": \"string\",\n \"error\": \"string\",\n \"path\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"1a36822e-198e-4303-919b-73a2cccfacc3","name":"Similar items","request":{"name":"Similar items","description":{"content":"Returns items similar to a given item.\n\n**Note:** The definition of an *item* encompasses products, but also articles, images, videos, and any other entities in the item feed.\n\n---\n\n**API consumers:** AI API key (legacy), Workspace (Business Profile), Web SDK Tracker\n\n**API key permission required:** `RECOMMENDATIONS_V2_SIMILAR_RECOMMENDATIONS_READ`\n","type":"text/plain"},"url":{"path":["recommendations","v2","recommend","items",":itemId","similar"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"minNumItems","value":"1","description":"The minimal number of returned item recommendations. If the service is not able to return at least this many recommendations, it will return an error."},{"disabled":false,"key":"maxNumItems","value":"5","description":"The maximal number of returned item recommendations."},{"disabled":false,"key":"campaignId","value":"defaultCampaign","description":"The campaignId which will be passed as *utm_campaign* in a link to the recommended item."},{"disabled":false,"key":"campaignName","value":"string","description":"The campaign name which will be included in the recommendation.generated event."},{"disabled":false,"key":"clientUUID","value":"string","description":"Profile UUID. This parameter is required for these recommendation types:\n - Personalized\n - Last seen\n - Recent interactions\n - Section\n - Attribute\n\nThis parameter can be passed in all recommendations. In recommendations which don't require the customer context, it can still be used to create filters.\n"},{"disabled":false,"key":"excludePurchasedItems","value":"false","description":"When true, the recommendation results will include only items that the profile hasn't purchased before. \n**IMPORTANT**: Only the last 250 purchased items are taken into account. Items further back in the purchase history may be included in the recommendation.\n"},{"disabled":false,"key":"excludePurchasedItemsSinceDays","value":"682","description":"Limits the application of the `excludePurchasedItems` filter to a specified number of days."},{"disabled":false,"key":"filters","value":"string","description":"This string defines the criteria that an item must meet in order to be considered for recommendation. \nFor information on building filters, see [\"Items Query Language (IQL)\" in the Developer Guide](https://hub.synerise.com/developers/iql/).\n"},{"disabled":false,"key":"elastic:filters","value":"string","description":"This string defines the criteria that an item must meet in order to be considered for recommendation. The Elastic filter may be dropped if not enough products meet the required criteria. \nFor information on building filters, see [\"Items Query Language (IQL)\" in the Developer Guide](https://hub.synerise.com/developers/iql/).\n"},{"disabled":false,"key":"itemCatalogId","value":"default","description":"ID (_not_ name) of the item feed to use in the request. The requested recommendation type (model) must be ready for this item feed."},{"disabled":false,"key":"elastic","value":"false"},{"disabled":false,"key":"filters","value":"[{\"field\":{\"value\":\"\"},\"maxNumItems\":{\"value\":\"\"},\"levelRangeModifier\":{\"value\":\"\"}}]"},{"disabled":false,"key":"includeContextItems","value":"true","description":"The recommendation results will include context items from the request."},{"disabled":false,"key":"params","value":"source:mobile","description":"List of extra params that will be added to the `recommendation.generated` event. They must be in the `name:value` format. The total size must not exceed 500 bytes when written as a JSON object.\n"},{"disabled":false,"key":"inventoryChannelId","value":"string","description":"Inventory context identifier used to evaluate inventory-related filters and boosting strategies. If not provided, no inventory context will be applied.\n"},{"disabled":false,"key":"crossWorkspaceMode","value":"true","description":"Specifies if recommendation should use cross-workspace mode and personalize recommendations with events from other members of workspace group if they are available.\n"}],"variable":[{"disabled":false,"type":"any","value":"string","key":"itemId","description":"(Required) Item identifier, equal to `itemId` from the *item feed*."}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"key":"key","value":"token"},{"key":"value","value":"{{apiKey}}"},{"key":"in","value":"query"}]}},"response":[{"id":"6d2d5da9-7675-49cd-a3be-1f6e4dfeea3e","name":"Items similar to the given item","originalRequest":{"url":{"path":["recommendations","v2","recommend","items",":itemId","similar"],"host":["{{baseUrl}}"],"query":[{"key":"minNumItems","value":"1"},{"key":"maxNumItems","value":"5"},{"key":"campaignId","value":"defaultCampaign"},{"key":"campaignName","value":"string"},{"key":"clientUUID","value":"string"},{"key":"excludePurchasedItems","value":"false"},{"key":"excludePurchasedItemsSinceDays","value":"682"},{"key":"filters","value":"string"},{"key":"elastic:filters","value":"string"},{"key":"itemCatalogId","value":"default"},{"key":"elastic","value":"false"},{"key":"filters","value":"[object Object]"},{"key":"includeContextItems","value":"true"},{"key":"params","value":"source:mobile"},{"key":"inventoryChannelId","value":"string"},{"key":"crossWorkspaceMode","value":"true"},{"key":"token","value":""}],"variable":[{"disabled":false,"type":"any","value":"string","key":"itemId","description":"(Required) Item identifier, equal to `itemId` from the *item feed*."}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"extras\": {\n \"correlationId\": \"string\",\n \"contextItems\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"campaignId\": \"string\"\n },\n \"data\": [\n {\n \"itemId\": {\n \"value\": \"\"\n }\n },\n {\n \"itemId\": {\n \"value\": \"\"\n }\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"02419272-ae36-416a-9e41-ed2c37fcf481","name":"No recommendations could be generated for the specified profile and filters","originalRequest":{"url":{"path":["recommendations","v2","recommend","items",":itemId","similar"],"host":["{{baseUrl}}"],"query":[{"key":"minNumItems","value":"1"},{"key":"maxNumItems","value":"5"},{"key":"campaignId","value":"defaultCampaign"},{"key":"campaignName","value":"string"},{"key":"clientUUID","value":"string"},{"key":"excludePurchasedItems","value":"false"},{"key":"excludePurchasedItemsSinceDays","value":"682"},{"key":"filters","value":"string"},{"key":"elastic:filters","value":"string"},{"key":"itemCatalogId","value":"default"},{"key":"elastic","value":"false"},{"key":"filters","value":"[object Object]"},{"key":"includeContextItems","value":"true"},{"key":"params","value":"source:mobile"},{"key":"inventoryChannelId","value":"string"},{"key":"crossWorkspaceMode","value":"true"},{"key":"token","value":""}],"variable":[{"disabled":false,"type":"any","value":"string","key":"itemId","description":"(Required) Item identifier, equal to `itemId` from the *item feed*."}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1990-11-06T06:53:04.578Z\",\n \"status\": 5998,\n \"message\": \"string\",\n \"error\": \"string\",\n \"path\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"3e2d0d2b-8a7b-4035-831d-3c4a4dd6d83b","name":"An error occurred","originalRequest":{"url":{"path":["recommendations","v2","recommend","items",":itemId","similar"],"host":["{{baseUrl}}"],"query":[{"key":"minNumItems","value":"1"},{"key":"maxNumItems","value":"5"},{"key":"campaignId","value":"defaultCampaign"},{"key":"campaignName","value":"string"},{"key":"clientUUID","value":"string"},{"key":"excludePurchasedItems","value":"false"},{"key":"excludePurchasedItemsSinceDays","value":"682"},{"key":"filters","value":"string"},{"key":"elastic:filters","value":"string"},{"key":"itemCatalogId","value":"default"},{"key":"elastic","value":"false"},{"key":"filters","value":"[object Object]"},{"key":"includeContextItems","value":"true"},{"key":"params","value":"source:mobile"},{"key":"inventoryChannelId","value":"string"},{"key":"crossWorkspaceMode","value":"true"},{"key":"token","value":""}],"variable":[{"disabled":false,"type":"any","value":"string","key":"itemId","description":"(Required) Item identifier, equal to `itemId` from the *item feed*."}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1990-11-06T06:53:04.578Z\",\n \"status\": 5998,\n \"message\": \"string\",\n \"error\": \"string\",\n \"path\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"1d1aa2d2-30ba-43ea-833d-5d8a07ad2a98","name":"Similar items","request":{"name":"Similar items","description":{"content":"Returns items similar to a given item.\n\n**Note:** The definition of an *item* encompasses products, but also articles, images, videos, and any other entities in the item feed.\n\n---\n\n**API consumers:** AI API key (legacy), Workspace (Business Profile), Web SDK Tracker\n\n**API key permission required:** `RECOMMENDATIONS_V2_SIMILAR_RECOMMENDATIONS_READ`\n","type":"text/plain"},"url":{"path":["recommendations","v2","recommend","items",":itemId","similar"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"itemId","description":"(Required) Item identifier, equal to `itemId` from the *item feed*."}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"slots\": [\n {\n \"value\": \"\"\n }\n ],\n \"campaignId\": {\n \"value\": \"\"\n },\n \"campaignName\": {\n \"value\": \"\"\n },\n \"catalogId\": {\n \"value\": \"\"\n },\n \"clientUUID\": {\n \"value\": \"\"\n },\n \"contextItemIds\": {\n \"value\": \"\"\n },\n \"includeContextItems\": {\n \"value\": \"\"\n },\n \"filterRules\": {\n \"value\": \"\"\n },\n \"displayAttributes\": {\n \"value\": \"\"\n },\n \"abTestContext\": {\n \"value\": \"\"\n },\n \"params\": {\n \"value\": \"\"\n },\n \"inventoryContext\": {\n \"value\": \"\"\n },\n \"keepSlotsOrder\": true,\n \"personalizeSlotsOrder\": false,\n \"sortMetric\": \"string\",\n \"boostingParameters\": {\n \"value\": \"\"\n },\n \"boostingStrategies\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"crossWorkspaceMode\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"d98ed7f9-80b8-412e-a936-a0c770fd86f8","name":"Items similar to the given item","originalRequest":{"url":{"path":["recommendations","v2","recommend","items",":itemId","similar"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"itemId","description":"(Required) Item identifier, equal to `itemId` from the *item feed*."}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"slots\": [\n {\n \"value\": \"\"\n }\n ],\n \"campaignId\": {\n \"value\": \"\"\n },\n \"campaignName\": {\n \"value\": \"\"\n },\n \"catalogId\": {\n \"value\": \"\"\n },\n \"clientUUID\": {\n \"value\": \"\"\n },\n \"contextItemIds\": {\n \"value\": \"\"\n },\n \"includeContextItems\": {\n \"value\": \"\"\n },\n \"filterRules\": {\n \"value\": \"\"\n },\n \"displayAttributes\": {\n \"value\": \"\"\n },\n \"abTestContext\": {\n \"value\": \"\"\n },\n \"params\": {\n \"value\": \"\"\n },\n \"inventoryContext\": {\n \"value\": \"\"\n },\n \"keepSlotsOrder\": true,\n \"personalizeSlotsOrder\": false,\n \"sortMetric\": \"string\",\n \"boostingParameters\": {\n \"value\": \"\"\n },\n \"boostingStrategies\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"crossWorkspaceMode\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"extras\": {\n \"slots\": {\n \"value\": \"\"\n }\n },\n \"data\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"ddaaccf7-c7f5-4864-bb6f-3e0798848dd0","name":"No recommendations could be generated for the specified profile and filters","originalRequest":{"url":{"path":["recommendations","v2","recommend","items",":itemId","similar"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"itemId","description":"(Required) Item identifier, equal to `itemId` from the *item feed*."}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"slots\": [\n {\n \"value\": \"\"\n }\n ],\n \"campaignId\": {\n \"value\": \"\"\n },\n \"campaignName\": {\n \"value\": \"\"\n },\n \"catalogId\": {\n \"value\": \"\"\n },\n \"clientUUID\": {\n \"value\": \"\"\n },\n \"contextItemIds\": {\n \"value\": \"\"\n },\n \"includeContextItems\": {\n \"value\": \"\"\n },\n \"filterRules\": {\n \"value\": \"\"\n },\n \"displayAttributes\": {\n \"value\": \"\"\n },\n \"abTestContext\": {\n \"value\": \"\"\n },\n \"params\": {\n \"value\": \"\"\n },\n \"inventoryContext\": {\n \"value\": \"\"\n },\n \"keepSlotsOrder\": true,\n \"personalizeSlotsOrder\": false,\n \"sortMetric\": \"string\",\n \"boostingParameters\": {\n \"value\": \"\"\n },\n \"boostingStrategies\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"crossWorkspaceMode\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1990-11-06T06:53:04.578Z\",\n \"status\": 5998,\n \"message\": \"string\",\n \"error\": \"string\",\n \"path\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"23dd52d9-b7dd-4d7d-b600-e710c8b56e30","name":"An error occurred","originalRequest":{"url":{"path":["recommendations","v2","recommend","items",":itemId","similar"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"itemId","description":"(Required) Item identifier, equal to `itemId` from the *item feed*."}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"slots\": [\n {\n \"value\": \"\"\n }\n ],\n \"campaignId\": {\n \"value\": \"\"\n },\n \"campaignName\": {\n \"value\": \"\"\n },\n \"catalogId\": {\n \"value\": \"\"\n },\n \"clientUUID\": {\n \"value\": \"\"\n },\n \"contextItemIds\": {\n \"value\": \"\"\n },\n \"includeContextItems\": {\n \"value\": \"\"\n },\n \"filterRules\": {\n \"value\": \"\"\n },\n \"displayAttributes\": {\n \"value\": \"\"\n },\n \"abTestContext\": {\n \"value\": \"\"\n },\n \"params\": {\n \"value\": \"\"\n },\n \"inventoryContext\": {\n \"value\": \"\"\n },\n \"keepSlotsOrder\": true,\n \"personalizeSlotsOrder\": false,\n \"sortMetric\": \"string\",\n \"boostingParameters\": {\n \"value\": \"\"\n },\n \"boostingStrategies\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"crossWorkspaceMode\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1990-11-06T06:53:04.578Z\",\n \"status\": 5998,\n \"message\": \"string\",\n \"error\": \"string\",\n \"path\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"fc44a8db-34a1-45dc-a991-572c724bae95","name":"Visually similar","request":{"name":"Visually similar","description":{"content":"Returns items visually similar to the given items.\n\n**Note:** The definition of an *item* encompasses products, but also articles, images, videos, and any other entities in the item feed.\n\n---\n\n**API consumers:** AI API key (legacy), Workspace (Business Profile), Web SDK Tracker\n\n**API key permission required:** `RECOMMENDATIONS_V2_VISUAL_RECOMMENDATIONS_READ`\n","type":"text/plain"},"url":{"path":["recommendations","v2","recommend","items",":itemId","similar","visual"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"minNumItems","value":"1","description":"The minimal number of returned item recommendations. If the service is not able to return at least this many recommendations, it will return an error."},{"disabled":false,"key":"maxNumItems","value":"5","description":"The maximal number of returned item recommendations."},{"disabled":false,"key":"clientUUID","value":"string","description":"Profile UUID. This parameter is required for these recommendation types:\n - Personalized\n - Last seen\n - Recent interactions\n - Section\n - Attribute\n\nThis parameter can be passed in all recommendations. In recommendations which don't require the customer context, it can still be used to create filters.\n"},{"disabled":false,"key":"excludePurchasedItems","value":"false","description":"When true, the recommendation results will include only items that the profile hasn't purchased before. \n**IMPORTANT**: Only the last 250 purchased items are taken into account. Items further back in the purchase history may be included in the recommendation.\n"},{"disabled":false,"key":"excludePurchasedItemsSinceDays","value":"682","description":"Limits the application of the `excludePurchasedItems` filter to a specified number of days."},{"disabled":false,"key":"filters","value":"string","description":"This string defines the criteria that an item must meet in order to be considered for recommendation. \nFor information on building filters, see [\"Items Query Language (IQL)\" in the Developer Guide](https://hub.synerise.com/developers/iql/).\n"},{"disabled":false,"key":"elastic:filters","value":"string","description":"This string defines the criteria that an item must meet in order to be considered for recommendation. The Elastic filter may be dropped if not enough products meet the required criteria. \nFor information on building filters, see [\"Items Query Language (IQL)\" in the Developer Guide](https://hub.synerise.com/developers/iql/).\n"},{"disabled":false,"key":"itemCatalogId","value":"default","description":"ID (_not_ name) of the item feed to use in the request. The requested recommendation type (model) must be ready for this item feed."},{"disabled":false,"key":"campaignId","value":"defaultCampaign","description":"The campaignId which will be passed as *utm_campaign* in a link to the recommended item."},{"disabled":false,"key":"campaignName","value":"string","description":"The campaign name which will be included in the recommendation.generated event."},{"disabled":false,"key":"elastic","value":"false"},{"disabled":false,"key":"filters","value":"[{\"field\":{\"value\":\"\"},\"maxNumItems\":{\"value\":\"\"},\"levelRangeModifier\":{\"value\":\"\"}}]"},{"disabled":false,"key":"includeContextItems","value":"true","description":"The recommendation results will include context items from the request."},{"disabled":false,"key":"params","value":"source:mobile","description":"List of extra params that will be added to the `recommendation.generated` event. They must be in the `name:value` format. The total size must not exceed 500 bytes when written as a JSON object.\n"},{"disabled":false,"key":"inventoryChannelId","value":"string","description":"Inventory context identifier used to evaluate inventory-related filters and boosting strategies. If not provided, no inventory context will be applied.\n"},{"disabled":false,"key":"crossWorkspaceMode","value":"true","description":"Specifies if recommendation should use cross-workspace mode and personalize recommendations with events from other members of workspace group if they are available.\n"}],"variable":[{"disabled":false,"type":"any","value":"string","key":"itemId","description":"(Required) Item identifier, equal to `itemId` from the *item feed*."}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"key":"key","value":"token"},{"key":"value","value":"{{apiKey}}"},{"key":"in","value":"query"}]}},"response":[{"id":"39978459-0c61-4cbd-b368-ec279fcb9503","name":"Items visually similar to the given item","originalRequest":{"url":{"path":["recommendations","v2","recommend","items",":itemId","similar","visual"],"host":["{{baseUrl}}"],"query":[{"key":"minNumItems","value":"1"},{"key":"maxNumItems","value":"5"},{"key":"clientUUID","value":"string"},{"key":"excludePurchasedItems","value":"false"},{"key":"excludePurchasedItemsSinceDays","value":"682"},{"key":"filters","value":"string"},{"key":"elastic:filters","value":"string"},{"key":"itemCatalogId","value":"default"},{"key":"campaignId","value":"defaultCampaign"},{"key":"campaignName","value":"string"},{"key":"elastic","value":"false"},{"key":"filters","value":"[object Object]"},{"key":"includeContextItems","value":"true"},{"key":"params","value":"source:mobile"},{"key":"inventoryChannelId","value":"string"},{"key":"crossWorkspaceMode","value":"true"},{"key":"token","value":""}],"variable":[{"disabled":false,"type":"any","value":"string","key":"itemId","description":"(Required) Item identifier, equal to `itemId` from the *item feed*."}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"extras\": {\n \"correlationId\": \"string\",\n \"contextItems\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"campaignId\": \"string\"\n },\n \"data\": [\n {\n \"itemId\": {\n \"value\": \"\"\n }\n },\n {\n \"itemId\": {\n \"value\": \"\"\n }\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"90353014-4620-489f-9d33-42c5e5b1c319","name":"No recommendations could be generated for the specified profile and filters","originalRequest":{"url":{"path":["recommendations","v2","recommend","items",":itemId","similar","visual"],"host":["{{baseUrl}}"],"query":[{"key":"minNumItems","value":"1"},{"key":"maxNumItems","value":"5"},{"key":"clientUUID","value":"string"},{"key":"excludePurchasedItems","value":"false"},{"key":"excludePurchasedItemsSinceDays","value":"682"},{"key":"filters","value":"string"},{"key":"elastic:filters","value":"string"},{"key":"itemCatalogId","value":"default"},{"key":"campaignId","value":"defaultCampaign"},{"key":"campaignName","value":"string"},{"key":"elastic","value":"false"},{"key":"filters","value":"[object Object]"},{"key":"includeContextItems","value":"true"},{"key":"params","value":"source:mobile"},{"key":"inventoryChannelId","value":"string"},{"key":"crossWorkspaceMode","value":"true"},{"key":"token","value":""}],"variable":[{"disabled":false,"type":"any","value":"string","key":"itemId","description":"(Required) Item identifier, equal to `itemId` from the *item feed*."}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1990-11-06T06:53:04.578Z\",\n \"status\": 5998,\n \"message\": \"string\",\n \"error\": \"string\",\n \"path\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"1d29855e-2128-4c21-afd1-b2906bfba11b","name":"An error occurred","originalRequest":{"url":{"path":["recommendations","v2","recommend","items",":itemId","similar","visual"],"host":["{{baseUrl}}"],"query":[{"key":"minNumItems","value":"1"},{"key":"maxNumItems","value":"5"},{"key":"clientUUID","value":"string"},{"key":"excludePurchasedItems","value":"false"},{"key":"excludePurchasedItemsSinceDays","value":"682"},{"key":"filters","value":"string"},{"key":"elastic:filters","value":"string"},{"key":"itemCatalogId","value":"default"},{"key":"campaignId","value":"defaultCampaign"},{"key":"campaignName","value":"string"},{"key":"elastic","value":"false"},{"key":"filters","value":"[object Object]"},{"key":"includeContextItems","value":"true"},{"key":"params","value":"source:mobile"},{"key":"inventoryChannelId","value":"string"},{"key":"crossWorkspaceMode","value":"true"},{"key":"token","value":""}],"variable":[{"disabled":false,"type":"any","value":"string","key":"itemId","description":"(Required) Item identifier, equal to `itemId` from the *item feed*."}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1990-11-06T06:53:04.578Z\",\n \"status\": 5998,\n \"message\": \"string\",\n \"error\": \"string\",\n \"path\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"8edca5fa-e285-4915-b7ec-4457bc61d9ec","name":"Visually similar","request":{"name":"Visually similar","description":{"content":"Returns items visually similar to the given items.\n\n**Note:** The definition of an *item* encompasses products, but also articles, images, videos, and any other entities in the item feed.\n\n---\n\n**API consumers:** AI API key (legacy), Workspace (Business Profile), Web SDK Tracker\n\n**API key permission required:** `RECOMMENDATIONS_V2_VISUAL_RECOMMENDATIONS_READ`\n","type":"text/plain"},"url":{"path":["recommendations","v2","recommend","items",":itemId","similar","visual"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"itemId","description":"(Required) Item identifier, equal to `itemId` from the *item feed*."}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"apikey","apikey":[{"key":"key","value":"token"},{"key":"value","value":"{{apiKey}}"},{"key":"in","value":"query"}]},"body":{"mode":"raw","raw":"{\n \"slots\": [\n {\n \"value\": \"\"\n }\n ],\n \"campaignId\": {\n \"value\": \"\"\n },\n \"campaignName\": {\n \"value\": \"\"\n },\n \"catalogId\": {\n \"value\": \"\"\n },\n \"clientUUID\": {\n \"value\": \"\"\n },\n \"contextItemIds\": {\n \"value\": \"\"\n },\n \"includeContextItems\": {\n \"value\": \"\"\n },\n \"filterRules\": {\n \"value\": \"\"\n },\n \"displayAttributes\": {\n \"value\": \"\"\n },\n \"abTestContext\": {\n \"value\": \"\"\n },\n \"params\": {\n \"value\": \"\"\n },\n \"inventoryContext\": {\n \"value\": \"\"\n },\n \"keepSlotsOrder\": true,\n \"personalizeSlotsOrder\": false,\n \"sortMetric\": \"string\",\n \"boostingParameters\": {\n \"value\": \"\"\n },\n \"boostingStrategies\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"crossWorkspaceMode\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"cbfabcad-93c3-47dc-8b58-42fb5d28fd03","name":"Items visually similar to the given item","originalRequest":{"url":{"path":["recommendations","v2","recommend","items",":itemId","similar","visual"],"host":["{{baseUrl}}"],"query":[{"key":"token","value":""}],"variable":[{"disabled":false,"type":"any","value":"string","key":"itemId","description":"(Required) Item identifier, equal to `itemId` from the *item feed*."}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"slots\": [\n {\n \"value\": \"\"\n }\n ],\n \"campaignId\": {\n \"value\": \"\"\n },\n \"campaignName\": {\n \"value\": \"\"\n },\n \"catalogId\": {\n \"value\": \"\"\n },\n \"clientUUID\": {\n \"value\": \"\"\n },\n \"contextItemIds\": {\n \"value\": \"\"\n },\n \"includeContextItems\": {\n \"value\": \"\"\n },\n \"filterRules\": {\n \"value\": \"\"\n },\n \"displayAttributes\": {\n \"value\": \"\"\n },\n \"abTestContext\": {\n \"value\": \"\"\n },\n \"params\": {\n \"value\": \"\"\n },\n \"inventoryContext\": {\n \"value\": \"\"\n },\n \"keepSlotsOrder\": true,\n \"personalizeSlotsOrder\": false,\n \"sortMetric\": \"string\",\n \"boostingParameters\": {\n \"value\": \"\"\n },\n \"boostingStrategies\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"crossWorkspaceMode\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"extras\": {\n \"slots\": {\n \"value\": \"\"\n }\n },\n \"data\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"b17e0d6d-5061-4ed8-86e1-358b9744e124","name":"No recommendations could be generated for the specified profile and filters","originalRequest":{"url":{"path":["recommendations","v2","recommend","items",":itemId","similar","visual"],"host":["{{baseUrl}}"],"query":[{"key":"token","value":""}],"variable":[{"disabled":false,"type":"any","value":"string","key":"itemId","description":"(Required) Item identifier, equal to `itemId` from the *item feed*."}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"slots\": [\n {\n \"value\": \"\"\n }\n ],\n \"campaignId\": {\n \"value\": \"\"\n },\n \"campaignName\": {\n \"value\": \"\"\n },\n \"catalogId\": {\n \"value\": \"\"\n },\n \"clientUUID\": {\n \"value\": \"\"\n },\n \"contextItemIds\": {\n \"value\": \"\"\n },\n \"includeContextItems\": {\n \"value\": \"\"\n },\n \"filterRules\": {\n \"value\": \"\"\n },\n \"displayAttributes\": {\n \"value\": \"\"\n },\n \"abTestContext\": {\n \"value\": \"\"\n },\n \"params\": {\n \"value\": \"\"\n },\n \"inventoryContext\": {\n \"value\": \"\"\n },\n \"keepSlotsOrder\": true,\n \"personalizeSlotsOrder\": false,\n \"sortMetric\": \"string\",\n \"boostingParameters\": {\n \"value\": \"\"\n },\n \"boostingStrategies\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"crossWorkspaceMode\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1990-11-06T06:53:04.578Z\",\n \"status\": 5998,\n \"message\": \"string\",\n \"error\": \"string\",\n \"path\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"b6984e38-4978-4860-9be8-d61abb37f178","name":"An error occurred","originalRequest":{"url":{"path":["recommendations","v2","recommend","items",":itemId","similar","visual"],"host":["{{baseUrl}}"],"query":[{"key":"token","value":""}],"variable":[{"disabled":false,"type":"any","value":"string","key":"itemId","description":"(Required) Item identifier, equal to `itemId` from the *item feed*."}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"slots\": [\n {\n \"value\": \"\"\n }\n ],\n \"campaignId\": {\n \"value\": \"\"\n },\n \"campaignName\": {\n \"value\": \"\"\n },\n \"catalogId\": {\n \"value\": \"\"\n },\n \"clientUUID\": {\n \"value\": \"\"\n },\n \"contextItemIds\": {\n \"value\": \"\"\n },\n \"includeContextItems\": {\n \"value\": \"\"\n },\n \"filterRules\": {\n \"value\": \"\"\n },\n \"displayAttributes\": {\n \"value\": \"\"\n },\n \"abTestContext\": {\n \"value\": \"\"\n },\n \"params\": {\n \"value\": \"\"\n },\n \"inventoryContext\": {\n \"value\": \"\"\n },\n \"keepSlotsOrder\": true,\n \"personalizeSlotsOrder\": false,\n \"sortMetric\": \"string\",\n \"boostingParameters\": {\n \"value\": \"\"\n },\n \"boostingStrategies\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"crossWorkspaceMode\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1990-11-06T06:53:04.578Z\",\n \"status\": 5998,\n \"message\": \"string\",\n \"error\": \"string\",\n \"path\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"0fda9938-febf-4c8e-9826-b0d3de4249f1","name":"Next interaction","request":{"name":"Next interaction","description":{"content":"The \"next interaction\" model recommends items that are most likely to produce a `page.visit` or `product.buy` event.\n\n**Note:** The definition of an *item* encompasses products, but also articles, images, videos, and any other entities in the item feed.\n\n\n---\n\n**API consumers:** AI API key (legacy), Workspace (Business Profile), Web SDK Tracker\n\n**API key permission required:** `RECOMMENDATIONS_V2_NEXT_INTERACTION_RECOMMENDATIONS_READ`\n","type":"text/plain"},"url":{"path":["recommendations","v2","recommend","items","next-interaction"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"clientUUID","value":"string","description":"Profile UUID. This parameter is required for these recommendation types:\n - Personalized\n - Last seen\n - Recent interactions\n - Section\n - Attribute\n\nThis parameter can be passed in all recommendations. In recommendations which don't require the customer context, it can still be used to create filters.\n"},{"disabled":false,"key":"minNumItems","value":"1","description":"The minimal number of returned item recommendations. If the service is not able to return at least this many recommendations, it will return an error."},{"disabled":false,"key":"maxNumItems","value":"5","description":"The maximal number of returned item recommendations."},{"disabled":false,"key":"campaignId","value":"defaultCampaign","description":"The campaignId which will be passed as *utm_campaign* in a link to the recommended item."},{"disabled":false,"key":"campaignName","value":"string","description":"The campaign name which will be included in the recommendation.generated event."},{"disabled":false,"key":"excludePurchasedItems","value":"false","description":"When true, the recommendation results will include only items that the profile hasn't purchased before. \n**IMPORTANT**: Only the last 250 purchased items are taken into account. Items further back in the purchase history may be included in the recommendation.\n"},{"disabled":false,"key":"excludePurchasedItemsSinceDays","value":"682","description":"Limits the application of the `excludePurchasedItems` filter to a specified number of days."},{"disabled":false,"key":"filters","value":"string","description":"This string defines the criteria that an item must meet in order to be considered for recommendation. \nFor information on building filters, see [\"Items Query Language (IQL)\" in the Developer Guide](https://hub.synerise.com/developers/iql/).\n"},{"disabled":false,"key":"elastic:filters","value":"string","description":"This string defines the criteria that an item must meet in order to be considered for recommendation. The Elastic filter may be dropped if not enough products meet the required criteria. \nFor information on building filters, see [\"Items Query Language (IQL)\" in the Developer Guide](https://hub.synerise.com/developers/iql/).\n"},{"disabled":false,"key":"itemId","value":"string","description":"Item identifiers, equal to `itemId` from the *item feed*. They can be used to define the item context of the query."},{"disabled":false,"key":"itemId","value":"string","description":"Item identifiers, equal to `itemId` from the *item feed*. They can be used to define the item context of the query."},{"disabled":false,"key":"itemCatalogId","value":"default","description":"ID (_not_ name) of the item feed to use in the request. The requested recommendation type (model) must be ready for this item feed."},{"disabled":false,"key":"boostMetric","value":"string","description":"ID of the metric to boost the results by. Metric scores will be combined with recommendation scores, favoring the best-performing results. The list of available metrics can be checked by using [this endpoint](https://developers.synerise.com/AnalyticsSuite/AnalyticsSuite.html#operation/ApiGetAvailableMetricsV2)."},{"disabled":false,"key":"sortMetric","value":"string","description":"ID of the metric to sort the results by. The list of available metrics can be checked by using [this endpoint](https://developers.synerise.com/AnalyticsSuite/AnalyticsSuite.html#operation/ApiGetAvailableMetricsV2)."},{"disabled":false,"key":"elastic","value":"false"},{"disabled":false,"key":"filters","value":"[{\"field\":{\"value\":\"\"},\"maxNumItems\":{\"value\":\"\"},\"levelRangeModifier\":{\"value\":\"\"}}]"},{"disabled":false,"key":"includeContextItems","value":"true","description":"The recommendation results will include context items from the request."},{"disabled":false,"key":"params","value":"source:mobile","description":"List of extra params that will be added to the `recommendation.generated` event. They must be in the `name:value` format. The total size must not exceed 500 bytes when written as a JSON object.\n"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"key":"key","value":"token"},{"key":"value","value":"{{apiKey}}"},{"key":"in","value":"query"}]}},"response":[{"id":"3eb3a54f-b8c8-4aa7-aad0-16811258fed8","name":"Next interaction recommendation","originalRequest":{"url":{"path":["recommendations","v2","recommend","items","next-interaction"],"host":["{{baseUrl}}"],"query":[{"key":"clientUUID","value":"string"},{"key":"minNumItems","value":"1"},{"key":"maxNumItems","value":"5"},{"key":"campaignId","value":"defaultCampaign"},{"key":"campaignName","value":"string"},{"key":"excludePurchasedItems","value":"false"},{"key":"excludePurchasedItemsSinceDays","value":"682"},{"key":"filters","value":"string"},{"key":"elastic:filters","value":"string"},{"key":"itemId","value":"string"},{"key":"itemId","value":"string"},{"key":"itemCatalogId","value":"default"},{"key":"boostMetric","value":"string"},{"key":"sortMetric","value":"string"},{"key":"elastic","value":"false"},{"key":"filters","value":"[object Object]"},{"key":"includeContextItems","value":"true"},{"key":"params","value":"source:mobile"},{"key":"token","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"extras\": {\n \"correlationId\": \"string\",\n \"contextItems\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"campaignId\": \"string\"\n },\n \"data\": [\n {\n \"itemId\": {\n \"value\": \"\"\n }\n },\n {\n \"itemId\": {\n \"value\": \"\"\n }\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"6f6d8f81-1544-4ceb-a96f-7a3dad20fb2d","name":"No recommendations could be generated for the specified profile and filters","originalRequest":{"url":{"path":["recommendations","v2","recommend","items","next-interaction"],"host":["{{baseUrl}}"],"query":[{"key":"clientUUID","value":"string"},{"key":"minNumItems","value":"1"},{"key":"maxNumItems","value":"5"},{"key":"campaignId","value":"defaultCampaign"},{"key":"campaignName","value":"string"},{"key":"excludePurchasedItems","value":"false"},{"key":"excludePurchasedItemsSinceDays","value":"682"},{"key":"filters","value":"string"},{"key":"elastic:filters","value":"string"},{"key":"itemId","value":"string"},{"key":"itemId","value":"string"},{"key":"itemCatalogId","value":"default"},{"key":"boostMetric","value":"string"},{"key":"sortMetric","value":"string"},{"key":"elastic","value":"false"},{"key":"filters","value":"[object Object]"},{"key":"includeContextItems","value":"true"},{"key":"params","value":"source:mobile"},{"key":"token","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1990-11-06T06:53:04.578Z\",\n \"status\": 5998,\n \"message\": \"string\",\n \"error\": \"string\",\n \"path\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"bab06ea8-1f93-4829-95ab-021887c7328f","name":"An error occurred","originalRequest":{"url":{"path":["recommendations","v2","recommend","items","next-interaction"],"host":["{{baseUrl}}"],"query":[{"key":"clientUUID","value":"string"},{"key":"minNumItems","value":"1"},{"key":"maxNumItems","value":"5"},{"key":"campaignId","value":"defaultCampaign"},{"key":"campaignName","value":"string"},{"key":"excludePurchasedItems","value":"false"},{"key":"excludePurchasedItemsSinceDays","value":"682"},{"key":"filters","value":"string"},{"key":"elastic:filters","value":"string"},{"key":"itemId","value":"string"},{"key":"itemId","value":"string"},{"key":"itemCatalogId","value":"default"},{"key":"boostMetric","value":"string"},{"key":"sortMetric","value":"string"},{"key":"elastic","value":"false"},{"key":"filters","value":"[object Object]"},{"key":"includeContextItems","value":"true"},{"key":"params","value":"source:mobile"},{"key":"token","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1990-11-06T06:53:04.578Z\",\n \"status\": 5998,\n \"message\": \"string\",\n \"error\": \"string\",\n \"path\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"31f4288c-87b8-408c-b081-31c674aaf757","name":"Next interaction","request":{"name":"Next interaction","description":{"content":"The \"next interaction\" model recommends items that are most likely to produce a `page.visit` or `product.buy` event.\n\n**Note:** The definition of an *item* encompasses products, but also articles, images, videos, and any other entities in the item feed.\n\n\n---\n\n**API consumers:** AI API key (legacy), Workspace (Business Profile), Web SDK Tracker\n\n**API key permission required:** `RECOMMENDATIONS_V2_NEXT_INTERACTION_RECOMMENDATIONS_READ`\n","type":"text/plain"},"url":{"path":["recommendations","v2","recommend","items","next-interaction"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"slots\": [\n {\n \"value\": \"\"\n }\n ],\n \"campaignId\": {\n \"value\": \"\"\n },\n \"campaignName\": {\n \"value\": \"\"\n },\n \"catalogId\": {\n \"value\": \"\"\n },\n \"clientUUID\": {\n \"value\": \"\"\n },\n \"contextItemIds\": {\n \"value\": \"\"\n },\n \"includeContextItems\": {\n \"value\": \"\"\n },\n \"filterRules\": {\n \"value\": \"\"\n },\n \"displayAttributes\": {\n \"value\": \"\"\n },\n \"abTestContext\": {\n \"value\": \"\"\n },\n \"params\": {\n \"value\": \"\"\n },\n \"inventoryContext\": {\n \"value\": \"\"\n },\n \"keepSlotsOrder\": true,\n \"personalizeSlotsOrder\": false,\n \"sortMetric\": \"string\",\n \"boostingParameters\": {\n \"value\": \"\"\n },\n \"boostingStrategies\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"crossWorkspaceMode\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"f18394c6-a655-4da7-9367-0ce69289b858","name":"Next interaction recommendations","originalRequest":{"url":{"path":["recommendations","v2","recommend","items","next-interaction"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"slots\": [\n {\n \"value\": \"\"\n }\n ],\n \"campaignId\": {\n \"value\": \"\"\n },\n \"campaignName\": {\n \"value\": \"\"\n },\n \"catalogId\": {\n \"value\": \"\"\n },\n \"clientUUID\": {\n \"value\": \"\"\n },\n \"contextItemIds\": {\n \"value\": \"\"\n },\n \"includeContextItems\": {\n \"value\": \"\"\n },\n \"filterRules\": {\n \"value\": \"\"\n },\n \"displayAttributes\": {\n \"value\": \"\"\n },\n \"abTestContext\": {\n \"value\": \"\"\n },\n \"params\": {\n \"value\": \"\"\n },\n \"inventoryContext\": {\n \"value\": \"\"\n },\n \"keepSlotsOrder\": true,\n \"personalizeSlotsOrder\": false,\n \"sortMetric\": \"string\",\n \"boostingParameters\": {\n \"value\": \"\"\n },\n \"boostingStrategies\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"crossWorkspaceMode\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"extras\": {\n \"slots\": {\n \"value\": \"\"\n }\n },\n \"data\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"7a543561-63dc-4794-a904-34a17ee33e2d","name":"No recommendations could be generated for the specified profile and filters","originalRequest":{"url":{"path":["recommendations","v2","recommend","items","next-interaction"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"slots\": [\n {\n \"value\": \"\"\n }\n ],\n \"campaignId\": {\n \"value\": \"\"\n },\n \"campaignName\": {\n \"value\": \"\"\n },\n \"catalogId\": {\n \"value\": \"\"\n },\n \"clientUUID\": {\n \"value\": \"\"\n },\n \"contextItemIds\": {\n \"value\": \"\"\n },\n \"includeContextItems\": {\n \"value\": \"\"\n },\n \"filterRules\": {\n \"value\": \"\"\n },\n \"displayAttributes\": {\n \"value\": \"\"\n },\n \"abTestContext\": {\n \"value\": \"\"\n },\n \"params\": {\n \"value\": \"\"\n },\n \"inventoryContext\": {\n \"value\": \"\"\n },\n \"keepSlotsOrder\": true,\n \"personalizeSlotsOrder\": false,\n \"sortMetric\": \"string\",\n \"boostingParameters\": {\n \"value\": \"\"\n },\n \"boostingStrategies\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"crossWorkspaceMode\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1990-11-06T06:53:04.578Z\",\n \"status\": 5998,\n \"message\": \"string\",\n \"error\": \"string\",\n \"path\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"8ed930c3-755f-467e-974f-358e9667e6d1","name":"An error occurred","originalRequest":{"url":{"path":["recommendations","v2","recommend","items","next-interaction"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"slots\": [\n {\n \"value\": \"\"\n }\n ],\n \"campaignId\": {\n \"value\": \"\"\n },\n \"campaignName\": {\n \"value\": \"\"\n },\n \"catalogId\": {\n \"value\": \"\"\n },\n \"clientUUID\": {\n \"value\": \"\"\n },\n \"contextItemIds\": {\n \"value\": \"\"\n },\n \"includeContextItems\": {\n \"value\": \"\"\n },\n \"filterRules\": {\n \"value\": \"\"\n },\n \"displayAttributes\": {\n \"value\": \"\"\n },\n \"abTestContext\": {\n \"value\": \"\"\n },\n \"params\": {\n \"value\": \"\"\n },\n \"inventoryContext\": {\n \"value\": \"\"\n },\n \"keepSlotsOrder\": true,\n \"personalizeSlotsOrder\": false,\n \"sortMetric\": \"string\",\n \"boostingParameters\": {\n \"value\": \"\"\n },\n \"boostingStrategies\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"crossWorkspaceMode\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1990-11-06T06:53:04.578Z\",\n \"status\": 5998,\n \"message\": \"string\",\n \"error\": \"string\",\n \"path\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}],"event":[]},{"id":"c6b7b099-cd03-46df-861a-837e78e2570e","name":"Search","description":{"content":"","type":"text/plain"},"item":[{"id":"149e3272-3ee5-4a12-bb56-db66d65ee613","name":"Full-text items search","request":{"name":"Full-text items search","description":{"content":"Retrieves items that match a full-text query from a search index or a suggestion index. The results can be filtered and sorted.\n\n---\n\n**API consumers:** AI API key (legacy), Web SDK Tracker, Workspace (Business Profile)\n\n**API key permission required:** `ITEMS_SEARCH_SEARCH_READ`\n","type":"text/plain"},"url":{"path":["search","v2","indices",":indexId","query"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"query","value":"string","description":"(Required) Query text to use in the search"},{"disabled":false,"key":"clientUUID","value":"string","description":"UUID of the profile for which the search is performed"},{"disabled":false,"key":"personalize","value":"true","description":"If set to `false`, the search result is not personalized.\n"},{"disabled":false,"key":"correlationId","value":"string","description":"Correlation ID for pagination. If a search with the ID was performed recently (last 10 minutes), the cached results will be used.\n\nDo not send this if sortBy/filters/sorting order, etc. have changed - the cached results may have different order or may match different filters.\n"},{"disabled":false,"key":"searchId","value":"string","description":"**DEPRECATED - use correlationId instead**\n\nSearch ID for pagination. If a search with the ID was performed recently (last 10 minutes), the cached results will be used.\n\nDo not send this if sortBy/filters/sorting order, etc. have changed - the cached results may have different order or may match different filters.\n"},{"disabled":false,"key":"sortByMetric","value":"TransactionsPopularity","description":"IMPORTANT: Sorting disables boosting, elastic filters, and promoting search results.\n\nName of the metric by which the data will be sorted.\n"},{"disabled":false,"key":"sortByGeoPoint","value":"34.052235,-118.243685","description":"IMPORTANT: Sorting disables boosting, elastic filters, and promoting search results.\n\nGeo-point (`{latitude},{longitude}`) for data sorting. Results are sorted by distance from this point. `ordering: asc` means \"closest first\".'\n"},{"disabled":false,"key":"filterGeoPoints","value":"34.052235,-118.243685","description":"The definition of a geographical area to filter by.\n\nGiven one geo-point, the results will be limited to a radius around a point. To override the default radius (1000 meters), provide the `filterAroundRadius` parameter.\n**Example input:** `[\"34.052235,-118.243685\"]`\n\nGiven two geo-points, the results will be limited to a rectangular area.\n**Example input:** `[\"50,-100\", \"25,150\"]`\n\nGiven three or more geo-points, the results will be limited to a polygonal area.\n**Example input:** `[\"50,0\", \"40,20\", \"-20,10\"]`\n"},{"disabled":false,"key":"filterGeoPoints","value":"15.0,65.0","description":"The definition of a geographical area to filter by.\n\nGiven one geo-point, the results will be limited to a radius around a point. To override the default radius (1000 meters), provide the `filterAroundRadius` parameter.\n**Example input:** `[\"34.052235,-118.243685\"]`\n\nGiven two geo-points, the results will be limited to a rectangular area.\n**Example input:** `[\"50,-100\", \"25,150\"]`\n\nGiven three or more geo-points, the results will be limited to a polygonal area.\n**Example input:** `[\"50,0\", \"40,20\", \"-20,10\"]`\n"},{"disabled":false,"key":"filterAroundRadius","value":"5000","description":"Radius in meters to be used when filtering using geo-location. Can only be used when filtering by a single geo-point."},{"disabled":false,"key":"filters","value":"string","description":"IQL query string. For details, see the [Help Center](https://help.synerise.com/developers/iql/)."},{"disabled":false,"key":"facets","value":"string","description":"A list of attributes for which facets will be returned. A single `*` value matches all facetable attributes.\nA single `auto` value enables automatic facet selection based on the result set — the system picks the most relevant facets using the index's `dynamicFacets` configuration.\n\nTo determine which groups of facets should be returned, use the `includeFacets` parameter.\n"},{"disabled":false,"key":"facets","value":"string","description":"A list of attributes for which facets will be returned. A single `*` value matches all facetable attributes.\nA single `auto` value enables automatic facet selection based on the result set — the system picks the most relevant facets using the index's `dynamicFacets` configuration.\n\nTo determine which groups of facets should be returned, use the `includeFacets` parameter.\n"},{"disabled":false,"key":"facetsSize","value":"2000","description":"Determines how many items will be used for facets aggregation.\n"},{"disabled":false,"key":"maxValuesPerFacet","value":"50","description":"Determines how many values will be retrieved per facet.\n"},{"disabled":false,"key":"caseSensitiveFacetValues","value":"false","description":"Specifies whether facets aggregation should be case sensitive.\n"},{"disabled":false,"key":"displayAttributes","value":"title","description":"List of ad hoc attributes that will be returned for each found item"},{"disabled":false,"key":"displayAttributes","value":"price","description":"List of ad hoc attributes that will be returned for each found item"},{"disabled":false,"key":"context","value":"mobile","description":"List of context strings for a search query"},{"disabled":false,"key":"context","value":"listing","description":"List of context strings for a search query"},{"disabled":false,"key":"includeFacets","value":"filtered","description":"Determines which groups of facets will be returned: both filtered and unfiltered; just filtered; just unfiltered; or no group at at all.\n\nTo determine which attributes should be returned as facets in each group, use the `facets` parameter.\n"},{"disabled":false,"key":"facetsOrderBy","value":"name","description":"Controls the ordering of facets in the response. \nWhen `facets=auto`, the default ordering is by coverage (most relevant facets first). \nWhen facets are specified explicitly, the default ordering is by name. \nWhen two facets have equal coverage, ties are resolved by name.\n"},{"disabled":false,"key":"page","value":"4","description":"Page number to return for pagination. The first page has the index `1`."},{"disabled":false,"key":"limit","value":"10","description":"The number of items to return per page"},{"disabled":false,"key":"sortBy","value":"string","description":"IMPORTANT: Sorting disables boosting, elastic filters, and promoting search results.\n\nName of the attribute by which the data will be sorted. \n"},{"disabled":false,"key":"ordering","value":"asc","description":"Sorting order"},{"disabled":false,"key":"includeMeta","value":"false","description":"\nWhen `true`, pagination metadata is included in the response body.\n\nWhen `false`, the data is included in the response headers:\n\n- Link: links to neighbors, first, and last pages in pagination.\n\n- X-Pagination-Total-Count: total number of items on all pages\n\n- X-Pagination-Total-Pages: total number of pages\n\n- X-Pagination-Page: current page\n\n- X-Pagination-Limit: maximum number of items on a page\n\n- X-Pagination-Sorted-By: parameter that the items were sorted by\n\n- X-Pagination-Ordering: sorting direction\n"},{"disabled":false,"key":"distinctFilter","value":"{\"attribute\": \"color\", \"maxNumItems\": 3}","description":"DistinctFilter JSON as an URL-encoded string\n"},{"disabled":false,"key":"ignoreQueryRules","value":"false","description":"If set to `true`, query rules are not applied.\n"},{"disabled":false,"key":"excludeQueryRules","value":"2","description":"List of query rules that will not be applied.\n"},{"disabled":false,"key":"excludeQueryRules","value":"5","description":"List of query rules that will not be applied.\n"},{"disabled":false,"key":"disableQueryClassification","value":"false","description":"If set to `true`, query classification is not applied.\n"},{"disabled":false,"key":"disableDynamicReranker","value":"false","description":"If set to `true`, dynamic reranker is not applied.\n"},{"disabled":false,"key":"params","value":"source:mobile","description":"List of extra params that will be added to the `item.search` event. They must be in the `name:value` format. The total size must not exceed 500 bytes when written as a JSON object.\n"}],"variable":[{"disabled":false,"type":"any","value":"string","key":"indexId","description":"(Required) ID of the index to be used in the search operation"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"key":"key","value":"token"},{"key":"value","value":"{{apiKey}}"},{"key":"in","value":"query"}]}},"response":[{"id":"2695cc9c-4d28-4914-9191-d758a3df836b","name":"Search result","originalRequest":{"url":{"path":["search","v2","indices",":indexId","query"],"host":["{{baseUrl}}"],"query":[{"key":"query","value":"string"},{"key":"clientUUID","value":"string"},{"key":"personalize","value":"true"},{"key":"correlationId","value":"string"},{"key":"searchId","value":"string"},{"key":"sortByMetric","value":"TransactionsPopularity"},{"key":"sortByGeoPoint","value":"34.052235,-118.243685"},{"key":"filterGeoPoints","value":"34.052235,-118.243685"},{"key":"filterGeoPoints","value":"15.0,65.0"},{"key":"filterAroundRadius","value":"5000"},{"key":"filters","value":"string"},{"key":"facets","value":"string"},{"key":"facets","value":"string"},{"key":"facetsSize","value":"2000"},{"key":"maxValuesPerFacet","value":"50"},{"key":"caseSensitiveFacetValues","value":"false"},{"key":"displayAttributes","value":"title"},{"key":"displayAttributes","value":"price"},{"key":"context","value":"mobile"},{"key":"context","value":"listing"},{"key":"includeFacets","value":"filtered"},{"key":"facetsOrderBy","value":"name"},{"key":"page","value":"4"},{"key":"limit","value":"10"},{"key":"sortBy","value":"string"},{"key":"ordering","value":"asc"},{"key":"includeMeta","value":"false"},{"key":"distinctFilter","value":"{\"attribute\": \"color\", \"maxNumItems\": 3}"},{"key":"ignoreQueryRules","value":"false"},{"key":"excludeQueryRules","value":"2"},{"key":"excludeQueryRules","value":"5"},{"key":"disableQueryClassification","value":"false"},{"key":"disableDynamicReranker","value":"false"},{"key":"params","value":"source:mobile"},{"key":"token","value":""}],"variable":[{"disabled":false,"type":"any","value":"string","key":"indexId","description":"(Required) ID of the index to be used in the search operation"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"data\": {\n \"value\": \"\"\n },\n \"extras\": {\n \"value\": \"\"\n },\n \"meta\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"3f9f8674-2cb6-4174-b1b0-c87317e71bc1","name":"Service not available","originalRequest":{"url":{"path":["search","v2","indices",":indexId","query"],"host":["{{baseUrl}}"],"query":[{"key":"query","value":"string"},{"key":"clientUUID","value":"string"},{"key":"personalize","value":"true"},{"key":"correlationId","value":"string"},{"key":"searchId","value":"string"},{"key":"sortByMetric","value":"TransactionsPopularity"},{"key":"sortByGeoPoint","value":"34.052235,-118.243685"},{"key":"filterGeoPoints","value":"34.052235,-118.243685"},{"key":"filterGeoPoints","value":"15.0,65.0"},{"key":"filterAroundRadius","value":"5000"},{"key":"filters","value":"string"},{"key":"facets","value":"string"},{"key":"facets","value":"string"},{"key":"facetsSize","value":"2000"},{"key":"maxValuesPerFacet","value":"50"},{"key":"caseSensitiveFacetValues","value":"false"},{"key":"displayAttributes","value":"title"},{"key":"displayAttributes","value":"price"},{"key":"context","value":"mobile"},{"key":"context","value":"listing"},{"key":"includeFacets","value":"filtered"},{"key":"facetsOrderBy","value":"name"},{"key":"page","value":"4"},{"key":"limit","value":"10"},{"key":"sortBy","value":"string"},{"key":"ordering","value":"asc"},{"key":"includeMeta","value":"false"},{"key":"distinctFilter","value":"{\"attribute\": \"color\", \"maxNumItems\": 3}"},{"key":"ignoreQueryRules","value":"false"},{"key":"excludeQueryRules","value":"2"},{"key":"excludeQueryRules","value":"5"},{"key":"disableQueryClassification","value":"false"},{"key":"disableDynamicReranker","value":"false"},{"key":"params","value":"source:mobile"},{"key":"token","value":""}],"variable":[{"disabled":false,"type":"any","value":"string","key":"indexId","description":"(Required) ID of the index to be used in the search operation"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1963-08-12T14:54:43.321Z\",\n \"status\": 2878,\n \"message\": \"string\",\n \"error\": \"string\",\n \"path\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"8e1b2929-626f-469c-893d-b84dae0f37bf","name":"Full-text items search","request":{"name":"Full-text items search","description":{"content":"Retrieves items that match a full-text query from a search index or a suggestion index. The results can be filtered and sorted.\n\n---\n\n**API consumers:** AI API key (legacy), Web SDK Tracker, Workspace (Business Profile)\n\n**API key permission required:** `ITEMS_SEARCH_SEARCH_READ`\n","type":"text/plain"},"url":{"path":["search","v2","indices",":indexId","query"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"indexId","description":"(Required) ID of the index to be used in the search operation"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"apikey","apikey":[{"key":"key","value":"token"},{"key":"value","value":"{{apiKey}}"},{"key":"in","value":"query"}]},"body":{"mode":"raw","raw":"{\n \"query\": \"string\",\n \"page\": 6048,\n \"limit\": 10,\n \"sortBy\": \"string\",\n \"ordering\": \"asc\",\n \"includeMeta\": false,\n \"clientUUID\": \"string\",\n \"personalize\": true,\n \"correlationId\": \"string\",\n \"searchId\": \"string\",\n \"sortByMetric\": \"PageVisitsPopularity\",\n \"sortByGeoPoints\": \"34.052235,-118.243685\",\n \"filterGeoPoints\": [\n \"34.052235,-118.243685\",\n \"15.0,65.0\"\n ],\n \"filterAroundRadius\": 2000,\n \"filters\": \"string\",\n \"facets\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"customFilteredFacets\": {\n \"brand\": \"price > 100\",\n \"price\": \"brand == foo\"\n },\n \"facetsSize\": 2000,\n \"maxValuesPerFacet\": 50,\n \"caseSensitiveFacetValues\": false,\n \"includeFacets\": \"filtered\",\n \"facetsOrderBy\": \"coverage\",\n \"context\": [\n \"mobile\",\n \"listing\"\n ],\n \"displayAttributes\": [\n \"title\",\n \"price\"\n ],\n \"distinctFilter\": {\n \"attribute\": {\n \"value\": \"\"\n },\n \"maxNumItems\": {\n \"value\": \"\"\n },\n \"levelRangeModifier\": {\n \"value\": \"\"\n }\n },\n \"ignoreQueryRules\": false,\n \"excludeQueryRules\": [\n 2,\n 5\n ],\n \"params\": {\n \"source\": \"mobile\"\n },\n \"disableQueryClassification\": false,\n \"disableDynamicReranker\": false\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"bb6ba4f5-b08b-4694-912d-0f49fba97fac","name":"Search result","originalRequest":{"url":{"path":["search","v2","indices",":indexId","query"],"host":["{{baseUrl}}"],"query":[{"key":"token","value":""}],"variable":[{"disabled":false,"type":"any","value":"string","key":"indexId","description":"(Required) ID of the index to be used in the search operation"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"query\": \"string\",\n \"page\": 6048,\n \"limit\": 10,\n \"sortBy\": \"string\",\n \"ordering\": \"asc\",\n \"includeMeta\": false,\n \"clientUUID\": \"string\",\n \"personalize\": true,\n \"correlationId\": \"string\",\n \"searchId\": \"string\",\n \"sortByMetric\": \"PageVisitsPopularity\",\n \"sortByGeoPoints\": \"34.052235,-118.243685\",\n \"filterGeoPoints\": [\n \"34.052235,-118.243685\",\n \"15.0,65.0\"\n ],\n \"filterAroundRadius\": 2000,\n \"filters\": \"string\",\n \"facets\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"customFilteredFacets\": {\n \"brand\": \"price > 100\",\n \"price\": \"brand == foo\"\n },\n \"facetsSize\": 2000,\n \"maxValuesPerFacet\": 50,\n \"caseSensitiveFacetValues\": false,\n \"includeFacets\": \"filtered\",\n \"facetsOrderBy\": \"coverage\",\n \"context\": [\n \"mobile\",\n \"listing\"\n ],\n \"displayAttributes\": [\n \"title\",\n \"price\"\n ],\n \"distinctFilter\": {\n \"attribute\": {\n \"value\": \"\"\n },\n \"maxNumItems\": {\n \"value\": \"\"\n },\n \"levelRangeModifier\": {\n \"value\": \"\"\n }\n },\n \"ignoreQueryRules\": false,\n \"excludeQueryRules\": [\n 2,\n 5\n ],\n \"params\": {\n \"source\": \"mobile\"\n },\n \"disableQueryClassification\": false,\n \"disableDynamicReranker\": false\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"data\": {\n \"value\": \"\"\n },\n \"extras\": {\n \"value\": \"\"\n },\n \"meta\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"ad94b7f5-2fec-4054-bf37-2699e994de74","name":"Service not available","originalRequest":{"url":{"path":["search","v2","indices",":indexId","query"],"host":["{{baseUrl}}"],"query":[{"key":"token","value":""}],"variable":[{"disabled":false,"type":"any","value":"string","key":"indexId","description":"(Required) ID of the index to be used in the search operation"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"query\": \"string\",\n \"page\": 6048,\n \"limit\": 10,\n \"sortBy\": \"string\",\n \"ordering\": \"asc\",\n \"includeMeta\": false,\n \"clientUUID\": \"string\",\n \"personalize\": true,\n \"correlationId\": \"string\",\n \"searchId\": \"string\",\n \"sortByMetric\": \"PageVisitsPopularity\",\n \"sortByGeoPoints\": \"34.052235,-118.243685\",\n \"filterGeoPoints\": [\n \"34.052235,-118.243685\",\n \"15.0,65.0\"\n ],\n \"filterAroundRadius\": 2000,\n \"filters\": \"string\",\n \"facets\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"customFilteredFacets\": {\n \"brand\": \"price > 100\",\n \"price\": \"brand == foo\"\n },\n \"facetsSize\": 2000,\n \"maxValuesPerFacet\": 50,\n \"caseSensitiveFacetValues\": false,\n \"includeFacets\": \"filtered\",\n \"facetsOrderBy\": \"coverage\",\n \"context\": [\n \"mobile\",\n \"listing\"\n ],\n \"displayAttributes\": [\n \"title\",\n \"price\"\n ],\n \"distinctFilter\": {\n \"attribute\": {\n \"value\": \"\"\n },\n \"maxNumItems\": {\n \"value\": \"\"\n },\n \"levelRangeModifier\": {\n \"value\": \"\"\n }\n },\n \"ignoreQueryRules\": false,\n \"excludeQueryRules\": [\n 2,\n 5\n ],\n \"params\": {\n \"source\": \"mobile\"\n },\n \"disableQueryClassification\": false,\n \"disableDynamicReranker\": false\n}","options":{"raw":{"language":"json"}}}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1963-08-12T14:54:43.321Z\",\n \"status\": 2878,\n \"message\": \"string\",\n \"error\": \"string\",\n \"path\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"19bceddb-34ff-410b-a507-80d0224ae1fc","name":"Explained full-text items search","request":{"name":"Explained full-text items search","description":{"content":"Retrieves items that match a full-text query from a search index or a suggestion index. The results can be filtered and sorted. The response contains an explanation of the factors that influenced the result.\n\n---\n\n**API consumers:** AI API key (legacy), Web SDK Tracker, Workspace (Business Profile)\n\n**API key permission required:** `ITEMS_SEARCH_SEARCH_READ`\n","type":"text/plain"},"url":{"path":["search","v2","indices",":indexId","query","explain"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"query","value":"string","description":"(Required) Query text to use in the search"},{"disabled":false,"key":"clientUUID","value":"string","description":"UUID of the profile for which the search is performed"},{"disabled":false,"key":"personalize","value":"true","description":"If set to `false`, the search result is not personalized.\n"},{"disabled":false,"key":"correlationId","value":"string","description":"Correlation ID for pagination. If a search with the ID was performed recently (last 10 minutes), the cached results will be used.\n\nDo not send this if sortBy/filters/sorting order, etc. have changed - the cached results may have different order or may match different filters.\n"},{"disabled":false,"key":"searchId","value":"string","description":"**DEPRECATED - use correlationId instead**\n\nSearch ID for pagination. If a search with the ID was performed recently (last 10 minutes), the cached results will be used.\n\nDo not send this if sortBy/filters/sorting order, etc. have changed - the cached results may have different order or may match different filters.\n"},{"disabled":false,"key":"sortByMetric","value":"TransactionsPopularity","description":"IMPORTANT: Sorting disables boosting, elastic filters, and promoting search results.\n\nName of the metric by which the data will be sorted.\n"},{"disabled":false,"key":"sortByGeoPoint","value":"34.052235,-118.243685","description":"IMPORTANT: Sorting disables boosting, elastic filters, and promoting search results.\n\nGeo-point (`{latitude},{longitude}`) for data sorting. Results are sorted by distance from this point. `ordering: asc` means \"closest first\".'\n"},{"disabled":false,"key":"filterGeoPoints","value":"34.052235,-118.243685","description":"The definition of a geographical area to filter by.\n\nGiven one geo-point, the results will be limited to a radius around a point. To override the default radius (1000 meters), provide the `filterAroundRadius` parameter.\n**Example input:** `[\"34.052235,-118.243685\"]`\n\nGiven two geo-points, the results will be limited to a rectangular area.\n**Example input:** `[\"50,-100\", \"25,150\"]`\n\nGiven three or more geo-points, the results will be limited to a polygonal area.\n**Example input:** `[\"50,0\", \"40,20\", \"-20,10\"]`\n"},{"disabled":false,"key":"filterGeoPoints","value":"15.0,65.0","description":"The definition of a geographical area to filter by.\n\nGiven one geo-point, the results will be limited to a radius around a point. To override the default radius (1000 meters), provide the `filterAroundRadius` parameter.\n**Example input:** `[\"34.052235,-118.243685\"]`\n\nGiven two geo-points, the results will be limited to a rectangular area.\n**Example input:** `[\"50,-100\", \"25,150\"]`\n\nGiven three or more geo-points, the results will be limited to a polygonal area.\n**Example input:** `[\"50,0\", \"40,20\", \"-20,10\"]`\n"},{"disabled":false,"key":"filterAroundRadius","value":"5000","description":"Radius in meters to be used when filtering using geo-location. Can only be used when filtering by a single geo-point."},{"disabled":false,"key":"filters","value":"string","description":"IQL query string. For details, see the [Help Center](https://help.synerise.com/developers/iql/)."},{"disabled":false,"key":"facets","value":"string","description":"A list of attributes for which facets will be returned. A single `*` value matches all facetable attributes.\nA single `auto` value enables automatic facet selection based on the result set — the system picks the most relevant facets using the index's `dynamicFacets` configuration.\n\nTo determine which groups of facets should be returned, use the `includeFacets` parameter.\n"},{"disabled":false,"key":"facets","value":"string","description":"A list of attributes for which facets will be returned. A single `*` value matches all facetable attributes.\nA single `auto` value enables automatic facet selection based on the result set — the system picks the most relevant facets using the index's `dynamicFacets` configuration.\n\nTo determine which groups of facets should be returned, use the `includeFacets` parameter.\n"},{"disabled":false,"key":"facetsSize","value":"2000","description":"Determines how many items will be used for facets aggregation.\n"},{"disabled":false,"key":"maxValuesPerFacet","value":"50","description":"Determines how many values will be retrieved per facet.\n"},{"disabled":false,"key":"caseSensitiveFacetValues","value":"false","description":"Specifies whether facets aggregation should be case sensitive.\n"},{"disabled":false,"key":"displayAttributes","value":"title","description":"List of ad hoc attributes that will be returned for each found item"},{"disabled":false,"key":"displayAttributes","value":"price","description":"List of ad hoc attributes that will be returned for each found item"},{"disabled":false,"key":"context","value":"mobile","description":"List of context strings for a search query"},{"disabled":false,"key":"context","value":"listing","description":"List of context strings for a search query"},{"disabled":false,"key":"includeFacets","value":"filtered","description":"Determines which groups of facets will be returned: both filtered and unfiltered; just filtered; just unfiltered; or no group at at all.\n\nTo determine which attributes should be returned as facets in each group, use the `facets` parameter.\n"},{"disabled":false,"key":"facetsOrderBy","value":"name","description":"Controls the ordering of facets in the response. \nWhen `facets=auto`, the default ordering is by coverage (most relevant facets first). \nWhen facets are specified explicitly, the default ordering is by name. \nWhen two facets have equal coverage, ties are resolved by name.\n"},{"disabled":false,"key":"page","value":"4","description":"Page number to return for pagination. The first page has the index `1`."},{"disabled":false,"key":"limit","value":"10","description":"The number of items to return per page"},{"disabled":false,"key":"sortBy","value":"string","description":"IMPORTANT: Sorting disables boosting, elastic filters, and promoting search results.\n\nName of the attribute by which the data will be sorted. \n"},{"disabled":false,"key":"ordering","value":"asc","description":"Sorting order"},{"disabled":false,"key":"includeMeta","value":"false","description":"\nWhen `true`, pagination metadata is included in the response body.\n\nWhen `false`, the data is included in the response headers:\n\n- Link: links to neighbors, first, and last pages in pagination.\n\n- X-Pagination-Total-Count: total number of items on all pages\n\n- X-Pagination-Total-Pages: total number of pages\n\n- X-Pagination-Page: current page\n\n- X-Pagination-Limit: maximum number of items on a page\n\n- X-Pagination-Sorted-By: parameter that the items were sorted by\n\n- X-Pagination-Ordering: sorting direction\n"},{"disabled":false,"key":"distinctFilter","value":"{\"attribute\": \"color\", \"maxNumItems\": 3}","description":"DistinctFilter JSON as an URL-encoded string\n"},{"disabled":false,"key":"ignoreQueryRules","value":"false","description":"If set to `true`, query rules are not applied.\n"},{"disabled":false,"key":"disableQueryClassification","value":"false","description":"If set to `true`, query classification is not applied.\n"},{"disabled":false,"key":"disableDynamicReranker","value":"false","description":"If set to `true`, dynamic reranker is not applied.\n"},{"disabled":false,"key":"excludeQueryRules","value":"2","description":"List of query rules that will not be applied.\n"},{"disabled":false,"key":"excludeQueryRules","value":"5","description":"List of query rules that will not be applied.\n"},{"disabled":false,"key":"crossWorkspaceModeEnabled","value":"true","description":"If set, overrides the cross-workspace mode from the index configuration. When `true`, cross-workspace personalization is enabled. When `false`, it is disabled.\n"},{"disabled":false,"key":"params","value":"source:mobile","description":"List of extra params that will be added to the `item.search` event. They must be in the `name:value` format. The total size must not exceed 500 bytes when written as a JSON object.\n"}],"variable":[{"disabled":false,"type":"any","value":"string","key":"indexId","description":"(Required) ID of the index to be used in the search operation"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"key":"key","value":"token"},{"key":"value","value":"{{apiKey}}"},{"key":"in","value":"query"}]}},"response":[{"id":"980d93ba-0a69-4b6c-830b-22e113ea111a","name":"Search result","originalRequest":{"url":{"path":["search","v2","indices",":indexId","query","explain"],"host":["{{baseUrl}}"],"query":[{"key":"query","value":"string"},{"key":"clientUUID","value":"string"},{"key":"personalize","value":"true"},{"key":"correlationId","value":"string"},{"key":"searchId","value":"string"},{"key":"sortByMetric","value":"TransactionsPopularity"},{"key":"sortByGeoPoint","value":"34.052235,-118.243685"},{"key":"filterGeoPoints","value":"34.052235,-118.243685"},{"key":"filterGeoPoints","value":"15.0,65.0"},{"key":"filterAroundRadius","value":"5000"},{"key":"filters","value":"string"},{"key":"facets","value":"string"},{"key":"facets","value":"string"},{"key":"facetsSize","value":"2000"},{"key":"maxValuesPerFacet","value":"50"},{"key":"caseSensitiveFacetValues","value":"false"},{"key":"displayAttributes","value":"title"},{"key":"displayAttributes","value":"price"},{"key":"context","value":"mobile"},{"key":"context","value":"listing"},{"key":"includeFacets","value":"filtered"},{"key":"facetsOrderBy","value":"name"},{"key":"page","value":"4"},{"key":"limit","value":"10"},{"key":"sortBy","value":"string"},{"key":"ordering","value":"asc"},{"key":"includeMeta","value":"false"},{"key":"distinctFilter","value":"{\"attribute\": \"color\", \"maxNumItems\": 3}"},{"key":"ignoreQueryRules","value":"false"},{"key":"disableQueryClassification","value":"false"},{"key":"disableDynamicReranker","value":"false"},{"key":"excludeQueryRules","value":"2"},{"key":"excludeQueryRules","value":"5"},{"key":"crossWorkspaceModeEnabled","value":"true"},{"key":"params","value":"source:mobile"},{"key":"token","value":""}],"variable":[{"disabled":false,"type":"any","value":"string","key":"indexId","description":"(Required) ID of the index to be used in the search operation"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"data\": {\n \"value\": \"\"\n },\n \"extras\": {\n \"value\": \"\"\n },\n \"meta\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"51bb6c50-40a2-4335-94d1-f6c2a236b4ae","name":"Service not available","originalRequest":{"url":{"path":["search","v2","indices",":indexId","query","explain"],"host":["{{baseUrl}}"],"query":[{"key":"query","value":"string"},{"key":"clientUUID","value":"string"},{"key":"personalize","value":"true"},{"key":"correlationId","value":"string"},{"key":"searchId","value":"string"},{"key":"sortByMetric","value":"TransactionsPopularity"},{"key":"sortByGeoPoint","value":"34.052235,-118.243685"},{"key":"filterGeoPoints","value":"34.052235,-118.243685"},{"key":"filterGeoPoints","value":"15.0,65.0"},{"key":"filterAroundRadius","value":"5000"},{"key":"filters","value":"string"},{"key":"facets","value":"string"},{"key":"facets","value":"string"},{"key":"facetsSize","value":"2000"},{"key":"maxValuesPerFacet","value":"50"},{"key":"caseSensitiveFacetValues","value":"false"},{"key":"displayAttributes","value":"title"},{"key":"displayAttributes","value":"price"},{"key":"context","value":"mobile"},{"key":"context","value":"listing"},{"key":"includeFacets","value":"filtered"},{"key":"facetsOrderBy","value":"name"},{"key":"page","value":"4"},{"key":"limit","value":"10"},{"key":"sortBy","value":"string"},{"key":"ordering","value":"asc"},{"key":"includeMeta","value":"false"},{"key":"distinctFilter","value":"{\"attribute\": \"color\", \"maxNumItems\": 3}"},{"key":"ignoreQueryRules","value":"false"},{"key":"disableQueryClassification","value":"false"},{"key":"disableDynamicReranker","value":"false"},{"key":"excludeQueryRules","value":"2"},{"key":"excludeQueryRules","value":"5"},{"key":"crossWorkspaceModeEnabled","value":"true"},{"key":"params","value":"source:mobile"},{"key":"token","value":""}],"variable":[{"disabled":false,"type":"any","value":"string","key":"indexId","description":"(Required) ID of the index to be used in the search operation"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1963-08-12T14:54:43.321Z\",\n \"status\": 2878,\n \"message\": \"string\",\n \"error\": \"string\",\n \"path\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"fbc3d69f-752b-4641-b400-3f57c0abe42f","name":"Explained full-text items search","request":{"name":"Explained full-text items search","description":{"content":"Retrieves items that match a full-text query from a search index or a suggestion index. The results can be filtered and sorted. The response contains an explanation of the factors that influenced the result.\n\n---\n\n**API consumers:** AI API key (legacy), Web SDK Tracker, Workspace (Business Profile)\n\n**API key permission required:** `ITEMS_SEARCH_SEARCH_READ`\n","type":"text/plain"},"url":{"path":["search","v2","indices",":indexId","query","explain"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"indexId","description":"(Required) ID of the index to be used in the search operation"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"apikey","apikey":[{"key":"key","value":"token"},{"key":"value","value":"{{apiKey}}"},{"key":"in","value":"query"}]},"body":{"mode":"raw","raw":"{\n \"query\": {\n \"value\": \"\"\n },\n \"page\": {\n \"value\": \"\"\n },\n \"limit\": {\n \"value\": \"\"\n },\n \"sortBy\": {\n \"value\": \"\"\n },\n \"ordering\": {\n \"value\": \"\"\n },\n \"includeMeta\": {\n \"value\": \"\"\n },\n \"clientUUID\": {\n \"value\": \"\"\n },\n \"personalize\": {\n \"value\": \"\"\n },\n \"correlationId\": {\n \"value\": \"\"\n },\n \"searchId\": {\n \"value\": \"\"\n },\n \"sortByMetric\": {\n \"value\": \"\"\n },\n \"sortByGeoPoints\": {\n \"value\": \"\"\n },\n \"filterGeoPoints\": {\n \"value\": \"\"\n },\n \"filterAroundRadius\": {\n \"value\": \"\"\n },\n \"filters\": {\n \"value\": \"\"\n },\n \"facets\": {\n \"value\": \"\"\n },\n \"customFilteredFacets\": {\n \"value\": \"\"\n },\n \"facetsSize\": {\n \"value\": \"\"\n },\n \"maxValuesPerFacet\": {\n \"value\": \"\"\n },\n \"caseSensitiveFacetValues\": {\n \"value\": \"\"\n },\n \"includeFacets\": {\n \"value\": \"\"\n },\n \"facetsOrderBy\": {\n \"value\": \"\"\n },\n \"context\": {\n \"value\": \"\"\n },\n \"displayAttributes\": {\n \"value\": \"\"\n },\n \"distinctFilter\": {\n \"value\": \"\"\n },\n \"ignoreQueryRules\": {\n \"value\": \"\"\n },\n \"excludeQueryRules\": {\n \"value\": \"\"\n },\n \"params\": {\n \"value\": \"\"\n },\n \"disableQueryClassification\": {\n \"value\": \"\"\n },\n \"disableDynamicReranker\": {\n \"value\": \"\"\n },\n \"crossWorkspaceMode\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"fe1c5394-bc0d-4024-ba5a-c22805f706c2","name":"Search result","originalRequest":{"url":{"path":["search","v2","indices",":indexId","query","explain"],"host":["{{baseUrl}}"],"query":[{"key":"token","value":""}],"variable":[{"disabled":false,"type":"any","value":"string","key":"indexId","description":"(Required) ID of the index to be used in the search operation"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"query\": {\n \"value\": \"\"\n },\n \"page\": {\n \"value\": \"\"\n },\n \"limit\": {\n \"value\": \"\"\n },\n \"sortBy\": {\n \"value\": \"\"\n },\n \"ordering\": {\n \"value\": \"\"\n },\n \"includeMeta\": {\n \"value\": \"\"\n },\n \"clientUUID\": {\n \"value\": \"\"\n },\n \"personalize\": {\n \"value\": \"\"\n },\n \"correlationId\": {\n \"value\": \"\"\n },\n \"searchId\": {\n \"value\": \"\"\n },\n \"sortByMetric\": {\n \"value\": \"\"\n },\n \"sortByGeoPoints\": {\n \"value\": \"\"\n },\n \"filterGeoPoints\": {\n \"value\": \"\"\n },\n \"filterAroundRadius\": {\n \"value\": \"\"\n },\n \"filters\": {\n \"value\": \"\"\n },\n \"facets\": {\n \"value\": \"\"\n },\n \"customFilteredFacets\": {\n \"value\": \"\"\n },\n \"facetsSize\": {\n \"value\": \"\"\n },\n \"maxValuesPerFacet\": {\n \"value\": \"\"\n },\n \"caseSensitiveFacetValues\": {\n \"value\": \"\"\n },\n \"includeFacets\": {\n \"value\": \"\"\n },\n \"facetsOrderBy\": {\n \"value\": \"\"\n },\n \"context\": {\n \"value\": \"\"\n },\n \"displayAttributes\": {\n \"value\": \"\"\n },\n \"distinctFilter\": {\n \"value\": \"\"\n },\n \"ignoreQueryRules\": {\n \"value\": \"\"\n },\n \"excludeQueryRules\": {\n \"value\": \"\"\n },\n \"params\": {\n \"value\": \"\"\n },\n \"disableQueryClassification\": {\n \"value\": \"\"\n },\n \"disableDynamicReranker\": {\n \"value\": \"\"\n },\n \"crossWorkspaceMode\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"data\": {\n \"value\": \"\"\n },\n \"extras\": {\n \"value\": \"\"\n },\n \"meta\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"e355ffa0-0be5-41dc-ac54-0bd89aedeb50","name":"Service not available","originalRequest":{"url":{"path":["search","v2","indices",":indexId","query","explain"],"host":["{{baseUrl}}"],"query":[{"key":"token","value":""}],"variable":[{"disabled":false,"type":"any","value":"string","key":"indexId","description":"(Required) ID of the index to be used in the search operation"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"query\": {\n \"value\": \"\"\n },\n \"page\": {\n \"value\": \"\"\n },\n \"limit\": {\n \"value\": \"\"\n },\n \"sortBy\": {\n \"value\": \"\"\n },\n \"ordering\": {\n \"value\": \"\"\n },\n \"includeMeta\": {\n \"value\": \"\"\n },\n \"clientUUID\": {\n \"value\": \"\"\n },\n \"personalize\": {\n \"value\": \"\"\n },\n \"correlationId\": {\n \"value\": \"\"\n },\n \"searchId\": {\n \"value\": \"\"\n },\n \"sortByMetric\": {\n \"value\": \"\"\n },\n \"sortByGeoPoints\": {\n \"value\": \"\"\n },\n \"filterGeoPoints\": {\n \"value\": \"\"\n },\n \"filterAroundRadius\": {\n \"value\": \"\"\n },\n \"filters\": {\n \"value\": \"\"\n },\n \"facets\": {\n \"value\": \"\"\n },\n \"customFilteredFacets\": {\n \"value\": \"\"\n },\n \"facetsSize\": {\n \"value\": \"\"\n },\n \"maxValuesPerFacet\": {\n \"value\": \"\"\n },\n \"caseSensitiveFacetValues\": {\n \"value\": \"\"\n },\n \"includeFacets\": {\n \"value\": \"\"\n },\n \"facetsOrderBy\": {\n \"value\": \"\"\n },\n \"context\": {\n \"value\": \"\"\n },\n \"displayAttributes\": {\n \"value\": \"\"\n },\n \"distinctFilter\": {\n \"value\": \"\"\n },\n \"ignoreQueryRules\": {\n \"value\": \"\"\n },\n \"excludeQueryRules\": {\n \"value\": \"\"\n },\n \"params\": {\n \"value\": \"\"\n },\n \"disableQueryClassification\": {\n \"value\": \"\"\n },\n \"disableDynamicReranker\": {\n \"value\": \"\"\n },\n \"crossWorkspaceMode\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1963-08-12T14:54:43.321Z\",\n \"status\": 2878,\n \"message\": \"string\",\n \"error\": \"string\",\n \"path\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"8383163f-3d81-4860-903e-87397bc6b128","name":"Autocomplete items search","request":{"name":"Autocomplete items search","description":{"content":"Retrieves items that match a query from a search index or a suggestion index. The results can be filtered and sorted. The results of this search type are not cached.\n\n---\n\n**API consumers:** AI API key (legacy), Web SDK Tracker, Workspace (Business Profile)\n\n**API key permission required:** `ITEMS_SEARCH_SEARCH_READ`\n","type":"text/plain"},"url":{"path":["search","v2","indices",":indexId","autocomplete"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"query","value":"string","description":"(Required) Query text to use in the search"},{"disabled":false,"key":"clientUUID","value":"string","description":"UUID of the profile for which the search is performed"},{"disabled":false,"key":"personalize","value":"true","description":"If set to `false`, the search result is not personalized.\n"},{"disabled":false,"key":"sortByMetric","value":"TransactionsPopularity","description":"IMPORTANT: Sorting disables boosting, elastic filters, and promoting search results.\n\nName of the metric by which the data will be sorted.\n"},{"disabled":false,"key":"sortByGeoPoint","value":"34.052235,-118.243685","description":"IMPORTANT: Sorting disables boosting, elastic filters, and promoting search results.\n\nGeo-point (`{latitude},{longitude}`) for data sorting. Results are sorted by distance from this point. `ordering: asc` means \"closest first\".'\n"},{"disabled":false,"key":"filterGeoPoints","value":"34.052235,-118.243685","description":"The definition of a geographical area to filter by.\n\nGiven one geo-point, the results will be limited to a radius around a point. To override the default radius (1000 meters), provide the `filterAroundRadius` parameter.\n**Example input:** `[\"34.052235,-118.243685\"]`\n\nGiven two geo-points, the results will be limited to a rectangular area.\n**Example input:** `[\"50,-100\", \"25,150\"]`\n\nGiven three or more geo-points, the results will be limited to a polygonal area.\n**Example input:** `[\"50,0\", \"40,20\", \"-20,10\"]`\n"},{"disabled":false,"key":"filterGeoPoints","value":"15.0,65.0","description":"The definition of a geographical area to filter by.\n\nGiven one geo-point, the results will be limited to a radius around a point. To override the default radius (1000 meters), provide the `filterAroundRadius` parameter.\n**Example input:** `[\"34.052235,-118.243685\"]`\n\nGiven two geo-points, the results will be limited to a rectangular area.\n**Example input:** `[\"50,-100\", \"25,150\"]`\n\nGiven three or more geo-points, the results will be limited to a polygonal area.\n**Example input:** `[\"50,0\", \"40,20\", \"-20,10\"]`\n"},{"disabled":false,"key":"filterAroundRadius","value":"5000","description":"Radius in meters to be used when filtering using geo-location. Can only be used when filtering by a single geo-point."},{"disabled":false,"key":"filters","value":"string","description":"IQL query string. For details, see the [Help Center](https://help.synerise.com/developers/iql/)."},{"disabled":false,"key":"facets","value":"string","description":"A list of attributes for which facets will be returned. A single `*` value matches all facetable attributes.\nA single `auto` value enables automatic facet selection based on the result set — the system picks the most relevant facets using the index's `dynamicFacets` configuration.\n\nTo determine which groups of facets should be returned, use the `includeFacets` parameter.\n"},{"disabled":false,"key":"facets","value":"string","description":"A list of attributes for which facets will be returned. A single `*` value matches all facetable attributes.\nA single `auto` value enables automatic facet selection based on the result set — the system picks the most relevant facets using the index's `dynamicFacets` configuration.\n\nTo determine which groups of facets should be returned, use the `includeFacets` parameter.\n"},{"disabled":false,"key":"facetsSize","value":"2000","description":"Determines how many items will be used for facets aggregation.\n"},{"disabled":false,"key":"maxValuesPerFacet","value":"50","description":"Determines how many values will be retrieved per facet.\n"},{"disabled":false,"key":"caseSensitiveFacetValues","value":"false","description":"Specifies whether facets aggregation should be case sensitive.\n"},{"disabled":false,"key":"displayAttributes","value":"title","description":"List of ad hoc attributes that will be returned for each found item"},{"disabled":false,"key":"displayAttributes","value":"price","description":"List of ad hoc attributes that will be returned for each found item"},{"disabled":false,"key":"context","value":"mobile","description":"List of context strings for a search query"},{"disabled":false,"key":"context","value":"listing","description":"List of context strings for a search query"},{"disabled":false,"key":"includeFacets","value":"filtered","description":"Determines which groups of facets will be returned: both filtered and unfiltered; just filtered; just unfiltered; or no group at at all.\n\nTo determine which attributes should be returned as facets in each group, use the `facets` parameter.\n"},{"disabled":false,"key":"facetsOrderBy","value":"name","description":"Controls the ordering of facets in the response. \nWhen `facets=auto`, the default ordering is by coverage (most relevant facets first). \nWhen facets are specified explicitly, the default ordering is by name. \nWhen two facets have equal coverage, ties are resolved by name.\n"},{"disabled":false,"key":"page","value":"4","description":"Page number to return for pagination. The first page has the index `1`."},{"disabled":false,"key":"limit","value":"10","description":"The number of items to return per page"},{"disabled":false,"key":"sortBy","value":"string","description":"IMPORTANT: Sorting disables boosting, elastic filters, and promoting search results.\n\nName of the attribute by which the data will be sorted. \n"},{"disabled":false,"key":"ordering","value":"asc","description":"Sorting order"},{"disabled":false,"key":"includeMeta","value":"false","description":"\nWhen `true`, pagination metadata is included in the response body.\n\nWhen `false`, the data is included in the response headers:\n\n- Link: links to neighbors, first, and last pages in pagination.\n\n- X-Pagination-Total-Count: total number of items on all pages\n\n- X-Pagination-Total-Pages: total number of pages\n\n- X-Pagination-Page: current page\n\n- X-Pagination-Limit: maximum number of items on a page\n\n- X-Pagination-Sorted-By: parameter that the items were sorted by\n\n- X-Pagination-Ordering: sorting direction\n"},{"disabled":false,"key":"distinctFilter","value":"{\"attribute\": \"color\", \"maxNumItems\": 3}","description":"DistinctFilter JSON as an URL-encoded string\n"},{"disabled":false,"key":"ignoreQueryRules","value":"false","description":"If set to `true`, query rules are not applied.\n"},{"disabled":false,"key":"excludeQueryRules","value":"2","description":"List of query rules that will not be applied.\n"},{"disabled":false,"key":"excludeQueryRules","value":"5","description":"List of query rules that will not be applied.\n"},{"disabled":false,"key":"params","value":"source:mobile","description":"List of extra params that will be added to the `item.search` event. They must be in the `name:value` format. The total size must not exceed 500 bytes when written as a JSON object.\n"},{"disabled":false,"key":"disableQueryClassification","value":"false","description":"If set to `true`, query classification is not applied.\n"},{"disabled":false,"key":"disableDynamicReranker","value":"false","description":"If set to `true`, dynamic reranker is not applied.\n"}],"variable":[{"disabled":false,"type":"any","value":"string","key":"indexId","description":"(Required) ID of the index to be used in the search operation"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"key":"key","value":"token"},{"key":"value","value":"{{apiKey}}"},{"key":"in","value":"query"}]}},"response":[{"id":"dd15eb8a-fb44-4c38-816a-155c9232d488","name":"Search result","originalRequest":{"url":{"path":["search","v2","indices",":indexId","autocomplete"],"host":["{{baseUrl}}"],"query":[{"key":"query","value":"string"},{"key":"clientUUID","value":"string"},{"key":"personalize","value":"true"},{"key":"sortByMetric","value":"TransactionsPopularity"},{"key":"sortByGeoPoint","value":"34.052235,-118.243685"},{"key":"filterGeoPoints","value":"34.052235,-118.243685"},{"key":"filterGeoPoints","value":"15.0,65.0"},{"key":"filterAroundRadius","value":"5000"},{"key":"filters","value":"string"},{"key":"facets","value":"string"},{"key":"facets","value":"string"},{"key":"facetsSize","value":"2000"},{"key":"maxValuesPerFacet","value":"50"},{"key":"caseSensitiveFacetValues","value":"false"},{"key":"displayAttributes","value":"title"},{"key":"displayAttributes","value":"price"},{"key":"context","value":"mobile"},{"key":"context","value":"listing"},{"key":"includeFacets","value":"filtered"},{"key":"facetsOrderBy","value":"name"},{"key":"page","value":"4"},{"key":"limit","value":"10"},{"key":"sortBy","value":"string"},{"key":"ordering","value":"asc"},{"key":"includeMeta","value":"false"},{"key":"distinctFilter","value":"{\"attribute\": \"color\", \"maxNumItems\": 3}"},{"key":"ignoreQueryRules","value":"false"},{"key":"excludeQueryRules","value":"2"},{"key":"excludeQueryRules","value":"5"},{"key":"params","value":"source:mobile"},{"key":"disableQueryClassification","value":"false"},{"key":"disableDynamicReranker","value":"false"},{"key":"token","value":""}],"variable":[{"disabled":false,"type":"any","value":"string","key":"indexId","description":"(Required) ID of the index to be used in the search operation"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"data\": {\n \"value\": \"\"\n },\n \"extras\": {\n \"value\": \"\"\n },\n \"meta\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"7ace0553-1ecf-4a2d-aa99-f29f68959eea","name":"Service not available","originalRequest":{"url":{"path":["search","v2","indices",":indexId","autocomplete"],"host":["{{baseUrl}}"],"query":[{"key":"query","value":"string"},{"key":"clientUUID","value":"string"},{"key":"personalize","value":"true"},{"key":"sortByMetric","value":"TransactionsPopularity"},{"key":"sortByGeoPoint","value":"34.052235,-118.243685"},{"key":"filterGeoPoints","value":"34.052235,-118.243685"},{"key":"filterGeoPoints","value":"15.0,65.0"},{"key":"filterAroundRadius","value":"5000"},{"key":"filters","value":"string"},{"key":"facets","value":"string"},{"key":"facets","value":"string"},{"key":"facetsSize","value":"2000"},{"key":"maxValuesPerFacet","value":"50"},{"key":"caseSensitiveFacetValues","value":"false"},{"key":"displayAttributes","value":"title"},{"key":"displayAttributes","value":"price"},{"key":"context","value":"mobile"},{"key":"context","value":"listing"},{"key":"includeFacets","value":"filtered"},{"key":"facetsOrderBy","value":"name"},{"key":"page","value":"4"},{"key":"limit","value":"10"},{"key":"sortBy","value":"string"},{"key":"ordering","value":"asc"},{"key":"includeMeta","value":"false"},{"key":"distinctFilter","value":"{\"attribute\": \"color\", \"maxNumItems\": 3}"},{"key":"ignoreQueryRules","value":"false"},{"key":"excludeQueryRules","value":"2"},{"key":"excludeQueryRules","value":"5"},{"key":"params","value":"source:mobile"},{"key":"disableQueryClassification","value":"false"},{"key":"disableDynamicReranker","value":"false"},{"key":"token","value":""}],"variable":[{"disabled":false,"type":"any","value":"string","key":"indexId","description":"(Required) ID of the index to be used in the search operation"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1963-08-12T14:54:43.321Z\",\n \"status\": 2878,\n \"message\": \"string\",\n \"error\": \"string\",\n \"path\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"63614f13-d324-4833-800b-0b277e2b3605","name":"Autocomplete items search","request":{"name":"Autocomplete items search","description":{"content":"Retrieves items that match a query from a search index or a suggestion index. The results can be filtered and sorted. The results of this search type are not cached.\n\n---\n\n**API consumers:** AI API key (legacy), Web SDK Tracker, Workspace (Business Profile)\n\n**API key permission required:** `ITEMS_SEARCH_SEARCH_READ`\n","type":"text/plain"},"url":{"path":["search","v2","indices",":indexId","autocomplete"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"indexId","description":"(Required) ID of the index to be used in the search operation"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"apikey","apikey":[{"key":"key","value":"token"},{"key":"value","value":"{{apiKey}}"},{"key":"in","value":"query"}]},"body":{"mode":"raw","raw":"{\n \"query\": \"string\",\n \"page\": 4371,\n \"limit\": 10,\n \"sortBy\": \"string\",\n \"ordering\": \"asc\",\n \"includeMeta\": true,\n \"clientUUID\": \"string\",\n \"sortByMetric\": \"PageVisitsPopularity\",\n \"sortByGeoPoints\": \"34.052235,-118.243685\",\n \"filterGeoPoints\": [\n \"34.052235,-118.243685\",\n \"15.0,65.0\"\n ],\n \"filterAroundRadius\": 2000,\n \"filters\": \"string\",\n \"facets\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"customFilteredFacets\": {\n \"brand\": \"price > 100\",\n \"price\": \"brand == foo\"\n },\n \"facetsSize\": 2000,\n \"maxValuesPerFacet\": 50,\n \"caseSensitiveFacetValues\": false,\n \"includeFacets\": \"filtered\",\n \"facetsOrderBy\": \"coverage\",\n \"context\": [\n \"mobile\",\n \"listing\"\n ],\n \"displayAttributes\": [\n \"title\",\n \"price\"\n ],\n \"distinctFilter\": {\n \"attribute\": {\n \"value\": \"\"\n },\n \"maxNumItems\": {\n \"value\": \"\"\n },\n \"levelRangeModifier\": {\n \"value\": \"\"\n }\n },\n \"ignoreQueryRules\": false,\n \"excludeQueryRules\": [\n 2,\n 5\n ],\n \"params\": {\n \"source\": \"mobile\"\n },\n \"disableQueryClassification\": false,\n \"disableDynamicReranker\": false\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"a51ae9a4-1354-4182-a349-dc9971aa25f7","name":"Search result","originalRequest":{"url":{"path":["search","v2","indices",":indexId","autocomplete"],"host":["{{baseUrl}}"],"query":[{"key":"token","value":""}],"variable":[{"disabled":false,"type":"any","value":"string","key":"indexId","description":"(Required) ID of the index to be used in the search operation"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"query\": \"string\",\n \"page\": 4371,\n \"limit\": 10,\n \"sortBy\": \"string\",\n \"ordering\": \"asc\",\n \"includeMeta\": true,\n \"clientUUID\": \"string\",\n \"sortByMetric\": \"PageVisitsPopularity\",\n \"sortByGeoPoints\": \"34.052235,-118.243685\",\n \"filterGeoPoints\": [\n \"34.052235,-118.243685\",\n \"15.0,65.0\"\n ],\n \"filterAroundRadius\": 2000,\n \"filters\": \"string\",\n \"facets\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"customFilteredFacets\": {\n \"brand\": \"price > 100\",\n \"price\": \"brand == foo\"\n },\n \"facetsSize\": 2000,\n \"maxValuesPerFacet\": 50,\n \"caseSensitiveFacetValues\": false,\n \"includeFacets\": \"filtered\",\n \"facetsOrderBy\": \"coverage\",\n \"context\": [\n \"mobile\",\n \"listing\"\n ],\n \"displayAttributes\": [\n \"title\",\n \"price\"\n ],\n \"distinctFilter\": {\n \"attribute\": {\n \"value\": \"\"\n },\n \"maxNumItems\": {\n \"value\": \"\"\n },\n \"levelRangeModifier\": {\n \"value\": \"\"\n }\n },\n \"ignoreQueryRules\": false,\n \"excludeQueryRules\": [\n 2,\n 5\n ],\n \"params\": {\n \"source\": \"mobile\"\n },\n \"disableQueryClassification\": false,\n \"disableDynamicReranker\": false\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"data\": {\n \"value\": \"\"\n },\n \"extras\": {\n \"value\": \"\"\n },\n \"meta\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"3dfc2d43-ca0f-47bf-8add-c807b458cf34","name":"Service not available","originalRequest":{"url":{"path":["search","v2","indices",":indexId","autocomplete"],"host":["{{baseUrl}}"],"query":[{"key":"token","value":""}],"variable":[{"disabled":false,"type":"any","value":"string","key":"indexId","description":"(Required) ID of the index to be used in the search operation"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"query\": \"string\",\n \"page\": 4371,\n \"limit\": 10,\n \"sortBy\": \"string\",\n \"ordering\": \"asc\",\n \"includeMeta\": true,\n \"clientUUID\": \"string\",\n \"sortByMetric\": \"PageVisitsPopularity\",\n \"sortByGeoPoints\": \"34.052235,-118.243685\",\n \"filterGeoPoints\": [\n \"34.052235,-118.243685\",\n \"15.0,65.0\"\n ],\n \"filterAroundRadius\": 2000,\n \"filters\": \"string\",\n \"facets\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"customFilteredFacets\": {\n \"brand\": \"price > 100\",\n \"price\": \"brand == foo\"\n },\n \"facetsSize\": 2000,\n \"maxValuesPerFacet\": 50,\n \"caseSensitiveFacetValues\": false,\n \"includeFacets\": \"filtered\",\n \"facetsOrderBy\": \"coverage\",\n \"context\": [\n \"mobile\",\n \"listing\"\n ],\n \"displayAttributes\": [\n \"title\",\n \"price\"\n ],\n \"distinctFilter\": {\n \"attribute\": {\n \"value\": \"\"\n },\n \"maxNumItems\": {\n \"value\": \"\"\n },\n \"levelRangeModifier\": {\n \"value\": \"\"\n }\n },\n \"ignoreQueryRules\": false,\n \"excludeQueryRules\": [\n 2,\n 5\n ],\n \"params\": {\n \"source\": \"mobile\"\n },\n \"disableQueryClassification\": false,\n \"disableDynamicReranker\": false\n}","options":{"raw":{"language":"json"}}}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1963-08-12T14:54:43.321Z\",\n \"status\": 2878,\n \"message\": \"string\",\n \"error\": \"string\",\n \"path\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"bd57fff6-5e6e-4d9c-ad95-317483709e74","name":"Explained autocomplete items search","request":{"name":"Explained autocomplete items search","description":{"content":"Retrieves items that match a query from a search index or a suggestion index. The results can be filtered and sorted. The results of this search type are not cached. The response contains an explanation of the factors that influenced the result.\n\n---\n\n**API consumers:** AI API key (legacy), Web SDK Tracker, Workspace (Business Profile)\n\n**API key permission required:** `ITEMS_SEARCH_SEARCH_READ`\n","type":"text/plain"},"url":{"path":["search","v2","indices",":indexId","autocomplete","explain"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"query","value":"string","description":"(Required) Query text to use in the search"},{"disabled":false,"key":"clientUUID","value":"string","description":"UUID of the profile for which the search is performed"},{"disabled":false,"key":"personalize","value":"true","description":"If set to `false`, the search result is not personalized.\n"},{"disabled":false,"key":"sortByMetric","value":"TransactionsPopularity","description":"IMPORTANT: Sorting disables boosting, elastic filters, and promoting search results.\n\nName of the metric by which the data will be sorted.\n"},{"disabled":false,"key":"sortByGeoPoint","value":"34.052235,-118.243685","description":"IMPORTANT: Sorting disables boosting, elastic filters, and promoting search results.\n\nGeo-point (`{latitude},{longitude}`) for data sorting. Results are sorted by distance from this point. `ordering: asc` means \"closest first\".'\n"},{"disabled":false,"key":"filterGeoPoints","value":"34.052235,-118.243685","description":"The definition of a geographical area to filter by.\n\nGiven one geo-point, the results will be limited to a radius around a point. To override the default radius (1000 meters), provide the `filterAroundRadius` parameter.\n**Example input:** `[\"34.052235,-118.243685\"]`\n\nGiven two geo-points, the results will be limited to a rectangular area.\n**Example input:** `[\"50,-100\", \"25,150\"]`\n\nGiven three or more geo-points, the results will be limited to a polygonal area.\n**Example input:** `[\"50,0\", \"40,20\", \"-20,10\"]`\n"},{"disabled":false,"key":"filterGeoPoints","value":"15.0,65.0","description":"The definition of a geographical area to filter by.\n\nGiven one geo-point, the results will be limited to a radius around a point. To override the default radius (1000 meters), provide the `filterAroundRadius` parameter.\n**Example input:** `[\"34.052235,-118.243685\"]`\n\nGiven two geo-points, the results will be limited to a rectangular area.\n**Example input:** `[\"50,-100\", \"25,150\"]`\n\nGiven three or more geo-points, the results will be limited to a polygonal area.\n**Example input:** `[\"50,0\", \"40,20\", \"-20,10\"]`\n"},{"disabled":false,"key":"filterAroundRadius","value":"5000","description":"Radius in meters to be used when filtering using geo-location. Can only be used when filtering by a single geo-point."},{"disabled":false,"key":"filters","value":"string","description":"IQL query string. For details, see the [Help Center](https://help.synerise.com/developers/iql/)."},{"disabled":false,"key":"facets","value":"string","description":"A list of attributes for which facets will be returned. A single `*` value matches all facetable attributes.\nA single `auto` value enables automatic facet selection based on the result set — the system picks the most relevant facets using the index's `dynamicFacets` configuration.\n\nTo determine which groups of facets should be returned, use the `includeFacets` parameter.\n"},{"disabled":false,"key":"facets","value":"string","description":"A list of attributes for which facets will be returned. A single `*` value matches all facetable attributes.\nA single `auto` value enables automatic facet selection based on the result set — the system picks the most relevant facets using the index's `dynamicFacets` configuration.\n\nTo determine which groups of facets should be returned, use the `includeFacets` parameter.\n"},{"disabled":false,"key":"facetsSize","value":"2000","description":"Determines how many items will be used for facets aggregation.\n"},{"disabled":false,"key":"maxValuesPerFacet","value":"50","description":"Determines how many values will be retrieved per facet.\n"},{"disabled":false,"key":"caseSensitiveFacetValues","value":"false","description":"Specifies whether facets aggregation should be case sensitive.\n"},{"disabled":false,"key":"displayAttributes","value":"title","description":"List of ad hoc attributes that will be returned for each found item"},{"disabled":false,"key":"displayAttributes","value":"price","description":"List of ad hoc attributes that will be returned for each found item"},{"disabled":false,"key":"context","value":"mobile","description":"List of context strings for a search query"},{"disabled":false,"key":"context","value":"listing","description":"List of context strings for a search query"},{"disabled":false,"key":"includeFacets","value":"filtered","description":"Determines which groups of facets will be returned: both filtered and unfiltered; just filtered; just unfiltered; or no group at at all.\n\nTo determine which attributes should be returned as facets in each group, use the `facets` parameter.\n"},{"disabled":false,"key":"facetsOrderBy","value":"name","description":"Controls the ordering of facets in the response. \nWhen `facets=auto`, the default ordering is by coverage (most relevant facets first). \nWhen facets are specified explicitly, the default ordering is by name. \nWhen two facets have equal coverage, ties are resolved by name.\n"},{"disabled":false,"key":"page","value":"4","description":"Page number to return for pagination. The first page has the index `1`."},{"disabled":false,"key":"limit","value":"10","description":"The number of items to return per page"},{"disabled":false,"key":"sortBy","value":"string","description":"IMPORTANT: Sorting disables boosting, elastic filters, and promoting search results.\n\nName of the attribute by which the data will be sorted. \n"},{"disabled":false,"key":"ordering","value":"asc","description":"Sorting order"},{"disabled":false,"key":"includeMeta","value":"false","description":"\nWhen `true`, pagination metadata is included in the response body.\n\nWhen `false`, the data is included in the response headers:\n\n- Link: links to neighbors, first, and last pages in pagination.\n\n- X-Pagination-Total-Count: total number of items on all pages\n\n- X-Pagination-Total-Pages: total number of pages\n\n- X-Pagination-Page: current page\n\n- X-Pagination-Limit: maximum number of items on a page\n\n- X-Pagination-Sorted-By: parameter that the items were sorted by\n\n- X-Pagination-Ordering: sorting direction\n"},{"disabled":false,"key":"distinctFilter","value":"{\"attribute\": \"color\", \"maxNumItems\": 3}","description":"DistinctFilter JSON as an URL-encoded string\n"},{"disabled":false,"key":"ignoreQueryRules","value":"false","description":"If set to `true`, query rules are not applied.\n"},{"disabled":false,"key":"excludeQueryRules","value":"2","description":"List of query rules that will not be applied.\n"},{"disabled":false,"key":"excludeQueryRules","value":"5","description":"List of query rules that will not be applied.\n"},{"disabled":false,"key":"crossWorkspaceModeEnabled","value":"true","description":"If set, overrides the cross-workspace mode from the index configuration. When `true`, cross-workspace personalization is enabled. When `false`, it is disabled.\n"},{"disabled":false,"key":"params","value":"source:mobile","description":"List of extra params that will be added to the `item.search` event. They must be in the `name:value` format. The total size must not exceed 500 bytes when written as a JSON object.\n"},{"disabled":false,"key":"disableQueryClassification","value":"false","description":"If set to `true`, query classification is not applied.\n"},{"disabled":false,"key":"disableDynamicReranker","value":"false","description":"If set to `true`, dynamic reranker is not applied.\n"}],"variable":[{"disabled":false,"type":"any","value":"string","key":"indexId","description":"(Required) ID of the index to be used in the search operation"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"key":"key","value":"token"},{"key":"value","value":"{{apiKey}}"},{"key":"in","value":"query"}]}},"response":[{"id":"099584ab-bbae-484f-a923-fa149e7ba43d","name":"Search result","originalRequest":{"url":{"path":["search","v2","indices",":indexId","autocomplete","explain"],"host":["{{baseUrl}}"],"query":[{"key":"query","value":"string"},{"key":"clientUUID","value":"string"},{"key":"personalize","value":"true"},{"key":"sortByMetric","value":"TransactionsPopularity"},{"key":"sortByGeoPoint","value":"34.052235,-118.243685"},{"key":"filterGeoPoints","value":"34.052235,-118.243685"},{"key":"filterGeoPoints","value":"15.0,65.0"},{"key":"filterAroundRadius","value":"5000"},{"key":"filters","value":"string"},{"key":"facets","value":"string"},{"key":"facets","value":"string"},{"key":"facetsSize","value":"2000"},{"key":"maxValuesPerFacet","value":"50"},{"key":"caseSensitiveFacetValues","value":"false"},{"key":"displayAttributes","value":"title"},{"key":"displayAttributes","value":"price"},{"key":"context","value":"mobile"},{"key":"context","value":"listing"},{"key":"includeFacets","value":"filtered"},{"key":"facetsOrderBy","value":"name"},{"key":"page","value":"4"},{"key":"limit","value":"10"},{"key":"sortBy","value":"string"},{"key":"ordering","value":"asc"},{"key":"includeMeta","value":"false"},{"key":"distinctFilter","value":"{\"attribute\": \"color\", \"maxNumItems\": 3}"},{"key":"ignoreQueryRules","value":"false"},{"key":"excludeQueryRules","value":"2"},{"key":"excludeQueryRules","value":"5"},{"key":"crossWorkspaceModeEnabled","value":"true"},{"key":"params","value":"source:mobile"},{"key":"disableQueryClassification","value":"false"},{"key":"disableDynamicReranker","value":"false"},{"key":"token","value":""}],"variable":[{"disabled":false,"type":"any","value":"string","key":"indexId","description":"(Required) ID of the index to be used in the search operation"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"data\": {\n \"value\": \"\"\n },\n \"extras\": {\n \"value\": \"\"\n },\n \"meta\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"d2958222-e883-401d-9e91-7be9410413f8","name":"Service not available","originalRequest":{"url":{"path":["search","v2","indices",":indexId","autocomplete","explain"],"host":["{{baseUrl}}"],"query":[{"key":"query","value":"string"},{"key":"clientUUID","value":"string"},{"key":"personalize","value":"true"},{"key":"sortByMetric","value":"TransactionsPopularity"},{"key":"sortByGeoPoint","value":"34.052235,-118.243685"},{"key":"filterGeoPoints","value":"34.052235,-118.243685"},{"key":"filterGeoPoints","value":"15.0,65.0"},{"key":"filterAroundRadius","value":"5000"},{"key":"filters","value":"string"},{"key":"facets","value":"string"},{"key":"facets","value":"string"},{"key":"facetsSize","value":"2000"},{"key":"maxValuesPerFacet","value":"50"},{"key":"caseSensitiveFacetValues","value":"false"},{"key":"displayAttributes","value":"title"},{"key":"displayAttributes","value":"price"},{"key":"context","value":"mobile"},{"key":"context","value":"listing"},{"key":"includeFacets","value":"filtered"},{"key":"facetsOrderBy","value":"name"},{"key":"page","value":"4"},{"key":"limit","value":"10"},{"key":"sortBy","value":"string"},{"key":"ordering","value":"asc"},{"key":"includeMeta","value":"false"},{"key":"distinctFilter","value":"{\"attribute\": \"color\", \"maxNumItems\": 3}"},{"key":"ignoreQueryRules","value":"false"},{"key":"excludeQueryRules","value":"2"},{"key":"excludeQueryRules","value":"5"},{"key":"crossWorkspaceModeEnabled","value":"true"},{"key":"params","value":"source:mobile"},{"key":"disableQueryClassification","value":"false"},{"key":"disableDynamicReranker","value":"false"},{"key":"token","value":""}],"variable":[{"disabled":false,"type":"any","value":"string","key":"indexId","description":"(Required) ID of the index to be used in the search operation"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1963-08-12T14:54:43.321Z\",\n \"status\": 2878,\n \"message\": \"string\",\n \"error\": \"string\",\n \"path\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"3dbef24a-76af-41d6-8614-1a96ce34879e","name":"Explained autocomplete items search","request":{"name":"Explained autocomplete items search","description":{"content":"Retrieves items that match a query from a search index or a suggestion index. The results can be filtered and sorted. The results of this search type are not cached. The response contains an explanation of the factors that influenced the result.\n\n---\n\n**API consumers:** AI API key (legacy), Web SDK Tracker, Workspace (Business Profile)\n\n**API key permission required:** `ITEMS_SEARCH_SEARCH_READ`\n","type":"text/plain"},"url":{"path":["search","v2","indices",":indexId","autocomplete","explain"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"indexId","description":"(Required) ID of the index to be used in the search operation"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"apikey","apikey":[{"key":"key","value":"token"},{"key":"value","value":"{{apiKey}}"},{"key":"in","value":"query"}]},"body":{"mode":"raw","raw":"{\n \"query\": {\n \"value\": \"\"\n },\n \"page\": {\n \"value\": \"\"\n },\n \"limit\": {\n \"value\": \"\"\n },\n \"sortBy\": {\n \"value\": \"\"\n },\n \"ordering\": {\n \"value\": \"\"\n },\n \"includeMeta\": {\n \"value\": \"\"\n },\n \"clientUUID\": {\n \"value\": \"\"\n },\n \"sortByMetric\": {\n \"value\": \"\"\n },\n \"sortByGeoPoints\": {\n \"value\": \"\"\n },\n \"filterGeoPoints\": {\n \"value\": \"\"\n },\n \"filterAroundRadius\": {\n \"value\": \"\"\n },\n \"filters\": {\n \"value\": \"\"\n },\n \"facets\": {\n \"value\": \"\"\n },\n \"customFilteredFacets\": {\n \"value\": \"\"\n },\n \"facetsSize\": {\n \"value\": \"\"\n },\n \"maxValuesPerFacet\": {\n \"value\": \"\"\n },\n \"caseSensitiveFacetValues\": {\n \"value\": \"\"\n },\n \"includeFacets\": {\n \"value\": \"\"\n },\n \"facetsOrderBy\": {\n \"value\": \"\"\n },\n \"context\": {\n \"value\": \"\"\n },\n \"displayAttributes\": {\n \"value\": \"\"\n },\n \"distinctFilter\": {\n \"value\": \"\"\n },\n \"ignoreQueryRules\": {\n \"value\": \"\"\n },\n \"excludeQueryRules\": {\n \"value\": \"\"\n },\n \"params\": {\n \"value\": \"\"\n },\n \"disableQueryClassification\": {\n \"value\": \"\"\n },\n \"disableDynamicReranker\": {\n \"value\": \"\"\n },\n \"crossWorkspaceMode\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"e6ee9e75-1308-4b04-8dea-86b5a62e307d","name":"Search result","originalRequest":{"url":{"path":["search","v2","indices",":indexId","autocomplete","explain"],"host":["{{baseUrl}}"],"query":[{"key":"token","value":""}],"variable":[{"disabled":false,"type":"any","value":"string","key":"indexId","description":"(Required) ID of the index to be used in the search operation"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"query\": {\n \"value\": \"\"\n },\n \"page\": {\n \"value\": \"\"\n },\n \"limit\": {\n \"value\": \"\"\n },\n \"sortBy\": {\n \"value\": \"\"\n },\n \"ordering\": {\n \"value\": \"\"\n },\n \"includeMeta\": {\n \"value\": \"\"\n },\n \"clientUUID\": {\n \"value\": \"\"\n },\n \"sortByMetric\": {\n \"value\": \"\"\n },\n \"sortByGeoPoints\": {\n \"value\": \"\"\n },\n \"filterGeoPoints\": {\n \"value\": \"\"\n },\n \"filterAroundRadius\": {\n \"value\": \"\"\n },\n \"filters\": {\n \"value\": \"\"\n },\n \"facets\": {\n \"value\": \"\"\n },\n \"customFilteredFacets\": {\n \"value\": \"\"\n },\n \"facetsSize\": {\n \"value\": \"\"\n },\n \"maxValuesPerFacet\": {\n \"value\": \"\"\n },\n \"caseSensitiveFacetValues\": {\n \"value\": \"\"\n },\n \"includeFacets\": {\n \"value\": \"\"\n },\n \"facetsOrderBy\": {\n \"value\": \"\"\n },\n \"context\": {\n \"value\": \"\"\n },\n \"displayAttributes\": {\n \"value\": \"\"\n },\n \"distinctFilter\": {\n \"value\": \"\"\n },\n \"ignoreQueryRules\": {\n \"value\": \"\"\n },\n \"excludeQueryRules\": {\n \"value\": \"\"\n },\n \"params\": {\n \"value\": \"\"\n },\n \"disableQueryClassification\": {\n \"value\": \"\"\n },\n \"disableDynamicReranker\": {\n \"value\": \"\"\n },\n \"crossWorkspaceMode\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"data\": {\n \"value\": \"\"\n },\n \"extras\": {\n \"value\": \"\"\n },\n \"meta\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"fcb54a73-d41e-4ca9-92c5-7b7faab5f327","name":"Service not available","originalRequest":{"url":{"path":["search","v2","indices",":indexId","autocomplete","explain"],"host":["{{baseUrl}}"],"query":[{"key":"token","value":""}],"variable":[{"disabled":false,"type":"any","value":"string","key":"indexId","description":"(Required) ID of the index to be used in the search operation"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"query\": {\n \"value\": \"\"\n },\n \"page\": {\n \"value\": \"\"\n },\n \"limit\": {\n \"value\": \"\"\n },\n \"sortBy\": {\n \"value\": \"\"\n },\n \"ordering\": {\n \"value\": \"\"\n },\n \"includeMeta\": {\n \"value\": \"\"\n },\n \"clientUUID\": {\n \"value\": \"\"\n },\n \"sortByMetric\": {\n \"value\": \"\"\n },\n \"sortByGeoPoints\": {\n \"value\": \"\"\n },\n \"filterGeoPoints\": {\n \"value\": \"\"\n },\n \"filterAroundRadius\": {\n \"value\": \"\"\n },\n \"filters\": {\n \"value\": \"\"\n },\n \"facets\": {\n \"value\": \"\"\n },\n \"customFilteredFacets\": {\n \"value\": \"\"\n },\n \"facetsSize\": {\n \"value\": \"\"\n },\n \"maxValuesPerFacet\": {\n \"value\": \"\"\n },\n \"caseSensitiveFacetValues\": {\n \"value\": \"\"\n },\n \"includeFacets\": {\n \"value\": \"\"\n },\n \"facetsOrderBy\": {\n \"value\": \"\"\n },\n \"context\": {\n \"value\": \"\"\n },\n \"displayAttributes\": {\n \"value\": \"\"\n },\n \"distinctFilter\": {\n \"value\": \"\"\n },\n \"ignoreQueryRules\": {\n \"value\": \"\"\n },\n \"excludeQueryRules\": {\n \"value\": \"\"\n },\n \"params\": {\n \"value\": \"\"\n },\n \"disableQueryClassification\": {\n \"value\": \"\"\n },\n \"disableDynamicReranker\": {\n \"value\": \"\"\n },\n \"crossWorkspaceMode\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1963-08-12T14:54:43.321Z\",\n \"status\": 2878,\n \"message\": \"string\",\n \"error\": \"string\",\n \"path\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"bbf437f4-7802-441f-9fdb-25dd116ccaae","name":"Searchable attributes match","request":{"name":"Searchable attributes match","description":{"content":"Enter a query and an item ID to check if a token (a word or a synonym which replaced it) matches a value or part of a value from the item's searchable attributes.\n\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User\n\n**API key permission required:** `ITEMS_SEARCH_SEARCH_READ`\n\n**User role permission required:** `assets_search: read`\n","type":"text/plain"},"url":{"path":["search","v2","indices",":indexId","explain-match"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"query","value":"string","description":"(Required) Query text to use in the search"},{"disabled":false,"key":"itemId","value":"string","description":"(Required) Item ID"}],"variable":[{"disabled":false,"type":"any","value":"string","key":"indexId","description":"(Required) ID of the index to be used in the search operation"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"key":"key","value":"token"},{"key":"value","value":"{{apiKey}}"},{"key":"in","value":"query"}]}},"response":[{"id":"053a6983-a5c8-49ea-b6fe-7185ed530c76","name":"Searchable attributes match result","originalRequest":{"url":{"path":["search","v2","indices",":indexId","explain-match"],"host":["{{baseUrl}}"],"query":[{"key":"query","value":"string"},{"key":"itemId","value":"string"},{"key":"token","value":""}],"variable":[{"disabled":false,"type":"any","value":"string","key":"indexId","description":"(Required) ID of the index to be used in the search operation"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"query\": {\n \"value\": \"string\",\n \"tokens\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n },\n \"attributes\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"0691e57a-4aea-40fc-a932-f0a31ef2d320","name":"Service not available","originalRequest":{"url":{"path":["search","v2","indices",":indexId","explain-match"],"host":["{{baseUrl}}"],"query":[{"key":"query","value":"string"},{"key":"itemId","value":"string"},{"key":"token","value":""}],"variable":[{"disabled":false,"type":"any","value":"string","key":"indexId","description":"(Required) ID of the index to be used in the search operation"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1963-08-12T14:54:43.321Z\",\n \"status\": 2878,\n \"message\": \"string\",\n \"error\": \"string\",\n \"path\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"0b0e15e8-25f2-4a95-b0e5-94705baa69e9","name":"Get deleted searches","request":{"name":"Get deleted searches","description":{"content":"Retrieve the searches deleted from a profile's history.\n\n---\n\n**API consumers:** AI API key (legacy), Workspace (Business Profile), Web SDK Tracker\n\n**API key permission required:** `ITEMS_SEARCH_RECENT_SEARCH_READ`\n","type":"text/plain"},"url":{"path":["search","v2","indices",":indexId","deleted-searches"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"clientUUID","value":"e0097757-d1e2-44ac-ba3c-d97979a354c1","description":"(Required) UUID of the profile for which the query is performed"}],"variable":[{"disabled":false,"type":"any","value":"4add1a1fa877c1651906bb22c9dfd37a1618852272","key":"indexId","description":"(Required) ID of the index that the query relates to"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"b0b7a90d-f9c1-4104-8f5f-5a2d61f4af50","name":"Deleted searches returned","originalRequest":{"url":{"path":["search","v2","indices",":indexId","deleted-searches"],"host":["{{baseUrl}}"],"query":[{"key":"clientUUID","value":"e0097757-d1e2-44ac-ba3c-d97979a354c1"}],"variable":[{"disabled":false,"type":"any","value":"4add1a1fa877c1651906bb22c9dfd37a1618852272","key":"indexId","description":"(Required) ID of the index that the query relates to"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"[\n {\n \"query\": {\n \"value\": \"\"\n },\n \"match\": {\n \"value\": \"\"\n },\n \"timestamp\": {\n \"value\": \"\"\n }\n },\n {\n \"query\": {\n \"value\": \"\"\n },\n \"match\": {\n \"value\": \"\"\n },\n \"timestamp\": {\n \"value\": \"\"\n }\n }\n]","cookie":[],"_postman_previewlanguage":"json"},{"id":"1bc6a0ff-c6d6-45a6-a765-ad92d5b3ea99","name":"Check error message for more details","originalRequest":{"url":{"path":["search","v2","indices",":indexId","deleted-searches"],"host":["{{baseUrl}}"],"query":[{"key":"clientUUID","value":"e0097757-d1e2-44ac-ba3c-d97979a354c1"}],"variable":[{"disabled":false,"type":"any","value":"4add1a1fa877c1651906bb22c9dfd37a1618852272","key":"indexId","description":"(Required) ID of the index that the query relates to"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1963-08-12T14:54:43.321Z\",\n \"status\": 2878,\n \"message\": \"string\",\n \"error\": \"string\",\n \"path\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"0660e539-860a-4793-9ff0-aaf801a324f9","name":"Soft-delete a recent search","request":{"name":"Soft-delete a recent search","description":{"content":"Delete a recent search from the history accessible to a profile. The search remains in the database and you can retrieve it by using [this endpoint](#operation/GetDeletedSearches).\n\n---\n\n**API consumers:** AI API key (legacy), Workspace (Business Profile), Web SDK Tracker\n\n**API key permission required:** `ITEMS_SEARCH_RECENT_SEARCH_CREATE`\n","type":"text/plain"},"url":{"path":["search","v2","indices",":indexId","deleted-searches"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"clientUUID","value":"e0097757-d1e2-44ac-ba3c-d97979a354c1","description":"(Required) UUID of the profile for which the query is performed"}],"variable":[{"disabled":false,"type":"any","value":"4add1a1fa877c1651906bb22c9dfd37a1618852272","key":"indexId","description":"(Required) ID of the index that the query relates to"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"query\": \"string\",\n \"match\": \"query\",\n \"timestamp\": \"2002-08-28T07:35:38.149Z\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"7a1558b3-8529-473a-8a94-ad8fa8b08245","name":"Soft-delete successful","originalRequest":{"url":{"path":["search","v2","indices",":indexId","deleted-searches"],"host":["{{baseUrl}}"],"query":[{"key":"clientUUID","value":"e0097757-d1e2-44ac-ba3c-d97979a354c1"}],"variable":[{"disabled":false,"type":"any","value":"4add1a1fa877c1651906bb22c9dfd37a1618852272","key":"indexId","description":"(Required) ID of the index that the query relates to"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"POST","body":{"mode":"raw","raw":"{\n \"query\": \"string\",\n \"match\": \"query\",\n \"timestamp\": \"2002-08-28T07:35:38.149Z\"\n}","options":{"raw":{"language":"json"}}}},"status":"No Content","code":204,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"4251f25c-5dc1-4bf2-9697-75de9422a899","name":"Check error message for more details","originalRequest":{"url":{"path":["search","v2","indices",":indexId","deleted-searches"],"host":["{{baseUrl}}"],"query":[{"key":"clientUUID","value":"e0097757-d1e2-44ac-ba3c-d97979a354c1"}],"variable":[{"disabled":false,"type":"any","value":"4add1a1fa877c1651906bb22c9dfd37a1618852272","key":"indexId","description":"(Required) ID of the index that the query relates to"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"query\": \"string\",\n \"match\": \"query\",\n \"timestamp\": \"2002-08-28T07:35:38.149Z\"\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1963-08-12T14:54:43.321Z\",\n \"status\": 2878,\n \"message\": \"string\",\n \"error\": \"string\",\n \"path\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"a2163c18-3d0d-46f2-8969-b9c3eb3bc009","name":"Get recent searches","request":{"name":"Get recent searches","description":{"content":"Get a profile's recent searches from a particular index.\n\n---\n\n**API consumers:** AI API key (legacy), Workspace (Business Profile), Web SDK Tracker\n\n**API key permission required:** `ITEMS_SEARCH_RECENT_SEARCH_READ`\n","type":"text/plain"},"url":{"path":["search","v2","indices",":indexId","recent-searches"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"clientUUID","value":"e0097757-d1e2-44ac-ba3c-d97979a354c1","description":"(Required) UUID of the profile for which the query is performed"},{"disabled":false,"key":"windowSize","value":"15","description":"Maximum number of recent searches to be returned.
NOTE:
The provided query parameter has priority over the configuration provided in [this endpoint](#operation/postIndexConfigV2). If the parameter is not provided, the default value does **not** override the configuration."},{"disabled":false,"key":"timeUnit","value":"DAYS","description":"The time unit. Used in conjunction with `timeValue`.
NOTE:
The provided query parameter has priority over the configuration provided in [this endpoint](#operation/postIndexConfigV2). If the parameter is not provided, the default value does **not** override the configuration."},{"disabled":false,"key":"timeValue","value":"30","description":"The amount of time units. Used in conjunction with `timeUnit`.
NOTE:
The provided query parameter has priority over the configuration provided in [this endpoint](#operation/postIndexConfigV2). If the parameter is not provided, the default value does **not** override the configuration."}],"variable":[{"disabled":false,"type":"any","value":"4add1a1fa877c1651906bb22c9dfd37a1618852272","key":"indexId","description":"(Required) ID of the index that the query relates to"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"f7ffaeef-70fc-4a83-bec1-4219f9339106","name":"Recent searches returned","originalRequest":{"url":{"path":["search","v2","indices",":indexId","recent-searches"],"host":["{{baseUrl}}"],"query":[{"key":"clientUUID","value":"e0097757-d1e2-44ac-ba3c-d97979a354c1"},{"key":"windowSize","value":"15"},{"key":"timeUnit","value":"DAYS"},{"key":"timeValue","value":"30"}],"variable":[{"disabled":false,"type":"any","value":"4add1a1fa877c1651906bb22c9dfd37a1618852272","key":"indexId","description":"(Required) ID of the index that the query relates to"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"[\n \"string\",\n \"string\"\n]","cookie":[],"_postman_previewlanguage":"json"},{"id":"3c6c06a4-9bed-49a7-b8b0-2db79244e0cb","name":"Check error message for more details","originalRequest":{"url":{"path":["search","v2","indices",":indexId","recent-searches"],"host":["{{baseUrl}}"],"query":[{"key":"clientUUID","value":"e0097757-d1e2-44ac-ba3c-d97979a354c1"},{"key":"windowSize","value":"15"},{"key":"timeUnit","value":"DAYS"},{"key":"timeValue","value":"30"}],"variable":[{"disabled":false,"type":"any","value":"4add1a1fa877c1651906bb22c9dfd37a1618852272","key":"indexId","description":"(Required) ID of the index that the query relates to"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1963-08-12T14:54:43.321Z\",\n \"status\": 2878,\n \"message\": \"string\",\n \"error\": \"string\",\n \"path\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}],"event":[]},{"id":"8e183634-945b-43b2-82cf-a5880627f60c","name":"Visual Search","description":{"content":"","type":"text/plain"},"item":[{"id":"063dffa1-2c45-413a-9667-27fb9745cd2d","name":"Visual items search","request":{"name":"Visual items search","description":{"content":"Retrieves items that match an image. The results can be filtered and sorted.\n\n---\n\n**API consumers:** AI API key (legacy), Web SDK Tracker, Workspace (Business Profile)\n\n**API key permission required:** `ITEMS_SEARCH_SEARCH_READ`\n","type":"text/plain"},"url":{"path":["search","v2","indices",":indexId","visual"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"url","value":"string","description":"(Required) URL of the image to be used in the visual search"},{"disabled":false,"key":"clientUUID","value":"string","description":"UUID of the profile for which the search is performed"},{"disabled":false,"key":"personalize","value":"true","description":"If set to `false`, the search result is not personalized.\n"},{"disabled":false,"key":"correlationId","value":"string","description":"Correlation ID for pagination. If a search with the ID was performed recently (last 10 minutes), the cached results will be used.\n\nDo not send this if sortBy/filters/sorting order, etc. have changed - the cached results may have different order or may match different filters.\n"},{"disabled":false,"key":"searchId","value":"string","description":"**DEPRECATED - use correlationId instead**\n\nSearch ID for pagination. If a search with the ID was performed recently (last 10 minutes), the cached results will be used.\n\nDo not send this if sortBy/filters/sorting order, etc. have changed - the cached results may have different order or may match different filters.\n"},{"disabled":false,"key":"sortByMetric","value":"TransactionsPopularity","description":"IMPORTANT: Sorting disables boosting, elastic filters, and promoting search results.\n\nName of the metric by which the data will be sorted.\n"},{"disabled":false,"key":"sortByGeoPoint","value":"34.052235,-118.243685","description":"IMPORTANT: Sorting disables boosting, elastic filters, and promoting search results.\n\nGeo-point (`{latitude},{longitude}`) for data sorting. Results are sorted by distance from this point. `ordering: asc` means \"closest first\".'\n"},{"disabled":false,"key":"filterGeoPoints","value":"34.052235,-118.243685","description":"The definition of a geographical area to filter by.\n\nGiven one geo-point, the results will be limited to a radius around a point. To override the default radius (1000 meters), provide the `filterAroundRadius` parameter.\n**Example input:** `[\"34.052235,-118.243685\"]`\n\nGiven two geo-points, the results will be limited to a rectangular area.\n**Example input:** `[\"50,-100\", \"25,150\"]`\n\nGiven three or more geo-points, the results will be limited to a polygonal area.\n**Example input:** `[\"50,0\", \"40,20\", \"-20,10\"]`\n"},{"disabled":false,"key":"filterGeoPoints","value":"15.0,65.0","description":"The definition of a geographical area to filter by.\n\nGiven one geo-point, the results will be limited to a radius around a point. To override the default radius (1000 meters), provide the `filterAroundRadius` parameter.\n**Example input:** `[\"34.052235,-118.243685\"]`\n\nGiven two geo-points, the results will be limited to a rectangular area.\n**Example input:** `[\"50,-100\", \"25,150\"]`\n\nGiven three or more geo-points, the results will be limited to a polygonal area.\n**Example input:** `[\"50,0\", \"40,20\", \"-20,10\"]`\n"},{"disabled":false,"key":"filterAroundRadius","value":"5000","description":"Radius in meters to be used when filtering using geo-location. Can only be used when filtering by a single geo-point."},{"disabled":false,"key":"filterAnchor","value":"0.2,0.8","description":"Anchor (`{width},{height}`) by which the visual results data will be filtered.\n`{width},{height}` correspond to normalized image coordinates, i.e. they are in range [0,1].\nAnchor (0,0) corresponds to the top-left pixel of an image.\n"},{"disabled":false,"key":"filters","value":"string","description":"IQL query string. For details, see the [Help Center](https://help.synerise.com/developers/iql/)."},{"disabled":false,"key":"facets","value":"string","description":"A list of attributes for which facets will be returned. A single `*` value matches all facetable attributes.\nA single `auto` value enables automatic facet selection based on the result set — the system picks the most relevant facets using the index's `dynamicFacets` configuration.\n\nTo determine which groups of facets should be returned, use the `includeFacets` parameter.\n"},{"disabled":false,"key":"facets","value":"string","description":"A list of attributes for which facets will be returned. A single `*` value matches all facetable attributes.\nA single `auto` value enables automatic facet selection based on the result set — the system picks the most relevant facets using the index's `dynamicFacets` configuration.\n\nTo determine which groups of facets should be returned, use the `includeFacets` parameter.\n"},{"disabled":false,"key":"facetsSize","value":"2000","description":"Determines how many items will be used for facets aggregation.\n"},{"disabled":false,"key":"maxValuesPerFacet","value":"50","description":"Determines how many values will be retrieved per facet.\n"},{"disabled":false,"key":"caseSensitiveFacetValues","value":"false","description":"Specifies whether facets aggregation should be case sensitive.\n"},{"disabled":false,"key":"displayAttributes","value":"title","description":"List of ad hoc attributes that will be returned for each found item"},{"disabled":false,"key":"displayAttributes","value":"price","description":"List of ad hoc attributes that will be returned for each found item"},{"disabled":false,"key":"context","value":"mobile","description":"List of context strings for a search query"},{"disabled":false,"key":"context","value":"listing","description":"List of context strings for a search query"},{"disabled":false,"key":"includeFacets","value":"filtered","description":"Determines which groups of facets will be returned: both filtered and unfiltered; just filtered; just unfiltered; or no group at at all.\n\nTo determine which attributes should be returned as facets in each group, use the `facets` parameter.\n"},{"disabled":false,"key":"facetsOrderBy","value":"name","description":"Controls the ordering of facets in the response. \nWhen `facets=auto`, the default ordering is by coverage (most relevant facets first). \nWhen facets are specified explicitly, the default ordering is by name. \nWhen two facets have equal coverage, ties are resolved by name.\n"},{"disabled":false,"key":"page","value":"4","description":"Page number to return for pagination. The first page has the index `1`."},{"disabled":false,"key":"limit","value":"10","description":"The number of items to return per page"},{"disabled":false,"key":"sortBy","value":"string","description":"IMPORTANT: Sorting disables boosting, elastic filters, and promoting search results.\n\nName of the attribute by which the data will be sorted. \n"},{"disabled":false,"key":"ordering","value":"asc","description":"Sorting order"},{"disabled":false,"key":"includeMeta","value":"false","description":"\nWhen `true`, pagination metadata is included in the response body.\n\nWhen `false`, the data is included in the response headers:\n\n- Link: links to neighbors, first, and last pages in pagination.\n\n- X-Pagination-Total-Count: total number of items on all pages\n\n- X-Pagination-Total-Pages: total number of pages\n\n- X-Pagination-Page: current page\n\n- X-Pagination-Limit: maximum number of items on a page\n\n- X-Pagination-Sorted-By: parameter that the items were sorted by\n\n- X-Pagination-Ordering: sorting direction\n"},{"disabled":false,"key":"ignoreQueryRules","value":"false","description":"If set to `true`, query rules are not applied.\n"},{"disabled":false,"key":"excludeQueryRules","value":"2","description":"List of query rules that will not be applied.\n"},{"disabled":false,"key":"excludeQueryRules","value":"5","description":"List of query rules that will not be applied.\n"},{"disabled":false,"key":"params","value":"source:mobile","description":"List of extra params that will be added to the `item.search` event. They must be in the `name:value` format. The total size must not exceed 500 bytes when written as a JSON object.\n"}],"variable":[{"disabled":false,"type":"any","value":"string","key":"indexId","description":"(Required) ID of the index to be used in the search operation"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"key":"key","value":"token"},{"key":"value","value":"{{apiKey}}"},{"key":"in","value":"query"}]}},"response":[{"id":"29f892c9-04a0-4f69-b65a-decf82f73463","name":"Search response","originalRequest":{"url":{"path":["search","v2","indices",":indexId","visual"],"host":["{{baseUrl}}"],"query":[{"key":"url","value":"string"},{"key":"clientUUID","value":"string"},{"key":"personalize","value":"true"},{"key":"correlationId","value":"string"},{"key":"searchId","value":"string"},{"key":"sortByMetric","value":"TransactionsPopularity"},{"key":"sortByGeoPoint","value":"34.052235,-118.243685"},{"key":"filterGeoPoints","value":"34.052235,-118.243685"},{"key":"filterGeoPoints","value":"15.0,65.0"},{"key":"filterAroundRadius","value":"5000"},{"key":"filterAnchor","value":"0.2,0.8"},{"key":"filters","value":"string"},{"key":"facets","value":"string"},{"key":"facets","value":"string"},{"key":"facetsSize","value":"2000"},{"key":"maxValuesPerFacet","value":"50"},{"key":"caseSensitiveFacetValues","value":"false"},{"key":"displayAttributes","value":"title"},{"key":"displayAttributes","value":"price"},{"key":"context","value":"mobile"},{"key":"context","value":"listing"},{"key":"includeFacets","value":"filtered"},{"key":"facetsOrderBy","value":"name"},{"key":"page","value":"4"},{"key":"limit","value":"10"},{"key":"sortBy","value":"string"},{"key":"ordering","value":"asc"},{"key":"includeMeta","value":"false"},{"key":"ignoreQueryRules","value":"false"},{"key":"excludeQueryRules","value":"2"},{"key":"excludeQueryRules","value":"5"},{"key":"params","value":"source:mobile"},{"key":"token","value":""}],"variable":[{"disabled":false,"type":"any","value":"string","key":"indexId","description":"(Required) ID of the index to be used in the search operation"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"data\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"extras\": {\n \"filteredFacets\": {\n \"value\": \"\"\n },\n \"allFacets\": {\n \"value\": \"\"\n },\n \"customFilteredFacets\": {\n \"value\": \"\"\n },\n \"correlationId\": {\n \"value\": \"\"\n },\n \"searchId\": {\n \"value\": \"\"\n },\n \"facetsOrdering\": {\n \"value\": \"\"\n }\n },\n \"meta\": {\n \"totalPages\": {\n \"value\": \"\"\n },\n \"totalCount\": {\n \"value\": \"\"\n },\n \"page\": {\n \"value\": \"\"\n },\n \"limit\": {\n \"value\": \"\"\n },\n \"sortedBy\": {\n \"value\": \"\"\n },\n \"ordering\": {\n \"value\": \"\"\n },\n \"code\": {\n \"value\": \"\"\n },\n \"link\": {\n \"value\": \"\"\n }\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"4ff4446e-ee1e-48d0-92eb-a462d8831109","name":"Service not available","originalRequest":{"url":{"path":["search","v2","indices",":indexId","visual"],"host":["{{baseUrl}}"],"query":[{"key":"url","value":"string"},{"key":"clientUUID","value":"string"},{"key":"personalize","value":"true"},{"key":"correlationId","value":"string"},{"key":"searchId","value":"string"},{"key":"sortByMetric","value":"TransactionsPopularity"},{"key":"sortByGeoPoint","value":"34.052235,-118.243685"},{"key":"filterGeoPoints","value":"34.052235,-118.243685"},{"key":"filterGeoPoints","value":"15.0,65.0"},{"key":"filterAroundRadius","value":"5000"},{"key":"filterAnchor","value":"0.2,0.8"},{"key":"filters","value":"string"},{"key":"facets","value":"string"},{"key":"facets","value":"string"},{"key":"facetsSize","value":"2000"},{"key":"maxValuesPerFacet","value":"50"},{"key":"caseSensitiveFacetValues","value":"false"},{"key":"displayAttributes","value":"title"},{"key":"displayAttributes","value":"price"},{"key":"context","value":"mobile"},{"key":"context","value":"listing"},{"key":"includeFacets","value":"filtered"},{"key":"facetsOrderBy","value":"name"},{"key":"page","value":"4"},{"key":"limit","value":"10"},{"key":"sortBy","value":"string"},{"key":"ordering","value":"asc"},{"key":"includeMeta","value":"false"},{"key":"ignoreQueryRules","value":"false"},{"key":"excludeQueryRules","value":"2"},{"key":"excludeQueryRules","value":"5"},{"key":"params","value":"source:mobile"},{"key":"token","value":""}],"variable":[{"disabled":false,"type":"any","value":"string","key":"indexId","description":"(Required) ID of the index to be used in the search operation"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1963-08-12T14:54:43.321Z\",\n \"status\": 2878,\n \"message\": \"string\",\n \"error\": \"string\",\n \"path\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"57192c90-3481-4d8d-9d5b-4781351ed027","name":"Visual items search","request":{"name":"Visual items search","description":{"content":"Retrieves items that match an image. The results can be filtered and sorted.\n\n---\n\n**API consumers:** AI API key (legacy), Web SDK Tracker, Workspace (Business Profile)\n\n**API key permission required:** `ITEMS_SEARCH_SEARCH_READ`\n","type":"text/plain"},"url":{"path":["search","v2","indices",":indexId","visual"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"indexId","description":"(Required) ID of the index to be used in the search operation"}]},"header":[{"key":"Content-Type","value":"multipart/form-data"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"apikey","apikey":[{"key":"key","value":"token"},{"key":"value","value":"{{apiKey}}"},{"key":"in","value":"query"}]},"body":{"mode":"formdata","formdata":[{"key":"image","type":"file","description":"Uploaded image to be used in the visual search"},{"key":"params","value":"{\"page\":{\"value\":\"\"},\"limit\":{\"value\":\"\"},\"sortBy\":{\"value\":\"\"},\"ordering\":{\"value\":\"\"},\"includeMeta\":{\"value\":\"\"},\"clientUUID\":{\"value\":\"\"},\"correlationId\":{\"value\":\"\"},\"searchId\":{\"value\":\"\"},\"sortByMetric\":{\"value\":\"\"},\"sortByGeoPoints\":{\"value\":\"\"},\"filterGeoPoints\":{\"value\":\"\"},\"filterAroundRadius\":{\"value\":\"\"},\"filterAnchor\":{\"value\":\"\"},\"filters\":{\"value\":\"\"},\"facets\":{\"value\":\"\"},\"facetsSize\":{\"value\":\"\"},\"maxValuesPerFacet\":{\"value\":\"\"},\"caseSensitiveFacetValues\":{\"value\":\"\"},\"includeFacets\":{\"value\":\"\"},\"facetsOrderBy\":{\"value\":\"\"},\"context\":{\"value\":\"\"},\"displayAttributes\":{\"value\":\"\"},\"ignoreQueryRules\":{\"value\":\"\"},\"excludeQueryRules\":{\"value\":\"\"},\"params\":{\"value\":\"\"}}","type":"text","description":"Parameters of the search"}]}},"response":[{"id":"52c2da72-796b-429a-be1a-20e86cba537e","name":"Search response","originalRequest":{"url":{"path":["search","v2","indices",":indexId","visual"],"host":["{{baseUrl}}"],"query":[{"key":"token","value":""}],"variable":[{"disabled":false,"type":"any","value":"string","key":"indexId","description":"(Required) ID of the index to be used in the search operation"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"formdata","formdata":[{"description":{"content":"Uploaded image to be used in the visual search","type":"text/plain"},"key":"image","type":"file"},{"description":{"content":"Parameters of the search","type":"text/plain"},"key":"params","value":"{\"page\":{\"value\":\"\"},\"limit\":{\"value\":\"\"},\"sortBy\":{\"value\":\"\"},\"ordering\":{\"value\":\"\"},\"includeMeta\":{\"value\":\"\"},\"clientUUID\":{\"value\":\"\"},\"correlationId\":{\"value\":\"\"},\"searchId\":{\"value\":\"\"},\"sortByMetric\":{\"value\":\"\"},\"sortByGeoPoints\":{\"value\":\"\"},\"filterGeoPoints\":{\"value\":\"\"},\"filterAroundRadius\":{\"value\":\"\"},\"filterAnchor\":{\"value\":\"\"},\"filters\":{\"value\":\"\"},\"facets\":{\"value\":\"\"},\"facetsSize\":{\"value\":\"\"},\"maxValuesPerFacet\":{\"value\":\"\"},\"caseSensitiveFacetValues\":{\"value\":\"\"},\"includeFacets\":{\"value\":\"\"},\"facetsOrderBy\":{\"value\":\"\"},\"context\":{\"value\":\"\"},\"displayAttributes\":{\"value\":\"\"},\"ignoreQueryRules\":{\"value\":\"\"},\"excludeQueryRules\":{\"value\":\"\"},\"params\":{\"value\":\"\"}}","type":"text"}]}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"data\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"extras\": {\n \"filteredFacets\": {\n \"value\": \"\"\n },\n \"allFacets\": {\n \"value\": \"\"\n },\n \"customFilteredFacets\": {\n \"value\": \"\"\n },\n \"correlationId\": {\n \"value\": \"\"\n },\n \"searchId\": {\n \"value\": \"\"\n },\n \"facetsOrdering\": {\n \"value\": \"\"\n }\n },\n \"meta\": {\n \"totalPages\": {\n \"value\": \"\"\n },\n \"totalCount\": {\n \"value\": \"\"\n },\n \"page\": {\n \"value\": \"\"\n },\n \"limit\": {\n \"value\": \"\"\n },\n \"sortedBy\": {\n \"value\": \"\"\n },\n \"ordering\": {\n \"value\": \"\"\n },\n \"code\": {\n \"value\": \"\"\n },\n \"link\": {\n \"value\": \"\"\n }\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"a8dbd87c-4255-4486-b6c8-ef289cd9dc17","name":"Service not available","originalRequest":{"url":{"path":["search","v2","indices",":indexId","visual"],"host":["{{baseUrl}}"],"query":[{"key":"token","value":""}],"variable":[{"disabled":false,"type":"any","value":"string","key":"indexId","description":"(Required) ID of the index to be used in the search operation"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"formdata","formdata":[{"description":{"content":"Uploaded image to be used in the visual search","type":"text/plain"},"key":"image","type":"file"},{"description":{"content":"Parameters of the search","type":"text/plain"},"key":"params","value":"{\"page\":{\"value\":\"\"},\"limit\":{\"value\":\"\"},\"sortBy\":{\"value\":\"\"},\"ordering\":{\"value\":\"\"},\"includeMeta\":{\"value\":\"\"},\"clientUUID\":{\"value\":\"\"},\"correlationId\":{\"value\":\"\"},\"searchId\":{\"value\":\"\"},\"sortByMetric\":{\"value\":\"\"},\"sortByGeoPoints\":{\"value\":\"\"},\"filterGeoPoints\":{\"value\":\"\"},\"filterAroundRadius\":{\"value\":\"\"},\"filterAnchor\":{\"value\":\"\"},\"filters\":{\"value\":\"\"},\"facets\":{\"value\":\"\"},\"facetsSize\":{\"value\":\"\"},\"maxValuesPerFacet\":{\"value\":\"\"},\"caseSensitiveFacetValues\":{\"value\":\"\"},\"includeFacets\":{\"value\":\"\"},\"facetsOrderBy\":{\"value\":\"\"},\"context\":{\"value\":\"\"},\"displayAttributes\":{\"value\":\"\"},\"ignoreQueryRules\":{\"value\":\"\"},\"excludeQueryRules\":{\"value\":\"\"},\"params\":{\"value\":\"\"}}","type":"text"}]}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1963-08-12T14:54:43.321Z\",\n \"status\": 2878,\n \"message\": \"string\",\n \"error\": \"string\",\n \"path\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"3e36a652-3de2-4071-b7d3-96d5a70dd1c6","name":"Explained visual items search","request":{"name":"Explained visual items search","description":{"content":"Retrieves items that match an image. The results can be filtered and sorted. The response contains an explanation of the factors that influenced the result.\n\n---\n\n**API consumers:** AI API key (legacy), Web SDK Tracker, Workspace (Business Profile)\n\n**API key permission required:** `ITEMS_SEARCH_SEARCH_READ`\n","type":"text/plain"},"url":{"path":["search","v2","indices",":indexId","visual","explain"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"url","value":"string","description":"(Required) URL of the image to be used in the visual search"},{"disabled":false,"key":"clientUUID","value":"string","description":"UUID of the profile for which the search is performed"},{"disabled":false,"key":"personalize","value":"true","description":"If set to `false`, the search result is not personalized.\n"},{"disabled":false,"key":"correlationId","value":"string","description":"Correlation ID for pagination. If a search with the ID was performed recently (last 10 minutes), the cached results will be used.\n\nDo not send this if sortBy/filters/sorting order, etc. have changed - the cached results may have different order or may match different filters.\n"},{"disabled":false,"key":"searchId","value":"string","description":"**DEPRECATED - use correlationId instead**\n\nSearch ID for pagination. If a search with the ID was performed recently (last 10 minutes), the cached results will be used.\n\nDo not send this if sortBy/filters/sorting order, etc. have changed - the cached results may have different order or may match different filters.\n"},{"disabled":false,"key":"sortByMetric","value":"TransactionsPopularity","description":"IMPORTANT: Sorting disables boosting, elastic filters, and promoting search results.\n\nName of the metric by which the data will be sorted.\n"},{"disabled":false,"key":"sortByGeoPoint","value":"34.052235,-118.243685","description":"IMPORTANT: Sorting disables boosting, elastic filters, and promoting search results.\n\nGeo-point (`{latitude},{longitude}`) for data sorting. Results are sorted by distance from this point. `ordering: asc` means \"closest first\".'\n"},{"disabled":false,"key":"filterGeoPoints","value":"34.052235,-118.243685","description":"The definition of a geographical area to filter by.\n\nGiven one geo-point, the results will be limited to a radius around a point. To override the default radius (1000 meters), provide the `filterAroundRadius` parameter.\n**Example input:** `[\"34.052235,-118.243685\"]`\n\nGiven two geo-points, the results will be limited to a rectangular area.\n**Example input:** `[\"50,-100\", \"25,150\"]`\n\nGiven three or more geo-points, the results will be limited to a polygonal area.\n**Example input:** `[\"50,0\", \"40,20\", \"-20,10\"]`\n"},{"disabled":false,"key":"filterGeoPoints","value":"15.0,65.0","description":"The definition of a geographical area to filter by.\n\nGiven one geo-point, the results will be limited to a radius around a point. To override the default radius (1000 meters), provide the `filterAroundRadius` parameter.\n**Example input:** `[\"34.052235,-118.243685\"]`\n\nGiven two geo-points, the results will be limited to a rectangular area.\n**Example input:** `[\"50,-100\", \"25,150\"]`\n\nGiven three or more geo-points, the results will be limited to a polygonal area.\n**Example input:** `[\"50,0\", \"40,20\", \"-20,10\"]`\n"},{"disabled":false,"key":"filterAroundRadius","value":"5000","description":"Radius in meters to be used when filtering using geo-location. Can only be used when filtering by a single geo-point."},{"disabled":false,"key":"filterAnchor","value":"0.2,0.8","description":"Anchor (`{width},{height}`) by which the visual results data will be filtered.\n`{width},{height}` correspond to normalized image coordinates, i.e. they are in range [0,1].\nAnchor (0,0) corresponds to the top-left pixel of an image.\n"},{"disabled":false,"key":"filters","value":"string","description":"IQL query string. For details, see the [Help Center](https://help.synerise.com/developers/iql/)."},{"disabled":false,"key":"facets","value":"string","description":"A list of attributes for which facets will be returned. A single `*` value matches all facetable attributes.\nA single `auto` value enables automatic facet selection based on the result set — the system picks the most relevant facets using the index's `dynamicFacets` configuration.\n\nTo determine which groups of facets should be returned, use the `includeFacets` parameter.\n"},{"disabled":false,"key":"facets","value":"string","description":"A list of attributes for which facets will be returned. A single `*` value matches all facetable attributes.\nA single `auto` value enables automatic facet selection based on the result set — the system picks the most relevant facets using the index's `dynamicFacets` configuration.\n\nTo determine which groups of facets should be returned, use the `includeFacets` parameter.\n"},{"disabled":false,"key":"facetsSize","value":"2000","description":"Determines how many items will be used for facets aggregation.\n"},{"disabled":false,"key":"maxValuesPerFacet","value":"50","description":"Determines how many values will be retrieved per facet.\n"},{"disabled":false,"key":"caseSensitiveFacetValues","value":"false","description":"Specifies whether facets aggregation should be case sensitive.\n"},{"disabled":false,"key":"displayAttributes","value":"title","description":"List of ad hoc attributes that will be returned for each found item"},{"disabled":false,"key":"displayAttributes","value":"price","description":"List of ad hoc attributes that will be returned for each found item"},{"disabled":false,"key":"context","value":"mobile","description":"List of context strings for a search query"},{"disabled":false,"key":"context","value":"listing","description":"List of context strings for a search query"},{"disabled":false,"key":"includeFacets","value":"filtered","description":"Determines which groups of facets will be returned: both filtered and unfiltered; just filtered; just unfiltered; or no group at at all.\n\nTo determine which attributes should be returned as facets in each group, use the `facets` parameter.\n"},{"disabled":false,"key":"facetsOrderBy","value":"name","description":"Controls the ordering of facets in the response. \nWhen `facets=auto`, the default ordering is by coverage (most relevant facets first). \nWhen facets are specified explicitly, the default ordering is by name. \nWhen two facets have equal coverage, ties are resolved by name.\n"},{"disabled":false,"key":"page","value":"4","description":"Page number to return for pagination. The first page has the index `1`."},{"disabled":false,"key":"limit","value":"10","description":"The number of items to return per page"},{"disabled":false,"key":"sortBy","value":"string","description":"IMPORTANT: Sorting disables boosting, elastic filters, and promoting search results.\n\nName of the attribute by which the data will be sorted. \n"},{"disabled":false,"key":"ordering","value":"asc","description":"Sorting order"},{"disabled":false,"key":"includeMeta","value":"false","description":"\nWhen `true`, pagination metadata is included in the response body.\n\nWhen `false`, the data is included in the response headers:\n\n- Link: links to neighbors, first, and last pages in pagination.\n\n- X-Pagination-Total-Count: total number of items on all pages\n\n- X-Pagination-Total-Pages: total number of pages\n\n- X-Pagination-Page: current page\n\n- X-Pagination-Limit: maximum number of items on a page\n\n- X-Pagination-Sorted-By: parameter that the items were sorted by\n\n- X-Pagination-Ordering: sorting direction\n"},{"disabled":false,"key":"ignoreQueryRules","value":"false","description":"If set to `true`, query rules are not applied.\n"},{"disabled":false,"key":"excludeQueryRules","value":"2","description":"List of query rules that will not be applied.\n"},{"disabled":false,"key":"excludeQueryRules","value":"5","description":"List of query rules that will not be applied.\n"},{"disabled":false,"key":"crossWorkspaceModeEnabled","value":"true","description":"If set, overrides the cross-workspace mode from the index configuration. When `true`, cross-workspace personalization is enabled. When `false`, it is disabled.\n"},{"disabled":false,"key":"params","value":"source:mobile","description":"List of extra params that will be added to the `item.search` event. They must be in the `name:value` format. The total size must not exceed 500 bytes when written as a JSON object.\n"}],"variable":[{"disabled":false,"type":"any","value":"string","key":"indexId","description":"(Required) ID of the index to be used in the search operation"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"key":"key","value":"token"},{"key":"value","value":"{{apiKey}}"},{"key":"in","value":"query"}]}},"response":[{"id":"c9cddc86-bff1-4395-986a-5c57c958e8a1","name":"Search response","originalRequest":{"url":{"path":["search","v2","indices",":indexId","visual","explain"],"host":["{{baseUrl}}"],"query":[{"key":"url","value":"string"},{"key":"clientUUID","value":"string"},{"key":"personalize","value":"true"},{"key":"correlationId","value":"string"},{"key":"searchId","value":"string"},{"key":"sortByMetric","value":"TransactionsPopularity"},{"key":"sortByGeoPoint","value":"34.052235,-118.243685"},{"key":"filterGeoPoints","value":"34.052235,-118.243685"},{"key":"filterGeoPoints","value":"15.0,65.0"},{"key":"filterAroundRadius","value":"5000"},{"key":"filterAnchor","value":"0.2,0.8"},{"key":"filters","value":"string"},{"key":"facets","value":"string"},{"key":"facets","value":"string"},{"key":"facetsSize","value":"2000"},{"key":"maxValuesPerFacet","value":"50"},{"key":"caseSensitiveFacetValues","value":"false"},{"key":"displayAttributes","value":"title"},{"key":"displayAttributes","value":"price"},{"key":"context","value":"mobile"},{"key":"context","value":"listing"},{"key":"includeFacets","value":"filtered"},{"key":"facetsOrderBy","value":"name"},{"key":"page","value":"4"},{"key":"limit","value":"10"},{"key":"sortBy","value":"string"},{"key":"ordering","value":"asc"},{"key":"includeMeta","value":"false"},{"key":"ignoreQueryRules","value":"false"},{"key":"excludeQueryRules","value":"2"},{"key":"excludeQueryRules","value":"5"},{"key":"crossWorkspaceModeEnabled","value":"true"},{"key":"params","value":"source:mobile"},{"key":"token","value":""}],"variable":[{"disabled":false,"type":"any","value":"string","key":"indexId","description":"(Required) ID of the index to be used in the search operation"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"data\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"extras\": {\n \"filteredFacets\": {\n \"value\": \"\"\n },\n \"allFacets\": {\n \"value\": \"\"\n },\n \"customFilteredFacets\": {\n \"value\": \"\"\n },\n \"correlationId\": {\n \"value\": \"\"\n },\n \"searchId\": {\n \"value\": \"\"\n },\n \"facetsOrdering\": {\n \"value\": \"\"\n },\n \"explanation\": {\n \"value\": \"\"\n }\n },\n \"meta\": {\n \"totalPages\": {\n \"value\": \"\"\n },\n \"totalCount\": {\n \"value\": \"\"\n },\n \"page\": {\n \"value\": \"\"\n },\n \"limit\": {\n \"value\": \"\"\n },\n \"sortedBy\": {\n \"value\": \"\"\n },\n \"ordering\": {\n \"value\": \"\"\n },\n \"code\": {\n \"value\": \"\"\n },\n \"link\": {\n \"value\": \"\"\n }\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"8efba479-d4b3-4c78-91e7-bea716b3fbcb","name":"Service not available","originalRequest":{"url":{"path":["search","v2","indices",":indexId","visual","explain"],"host":["{{baseUrl}}"],"query":[{"key":"url","value":"string"},{"key":"clientUUID","value":"string"},{"key":"personalize","value":"true"},{"key":"correlationId","value":"string"},{"key":"searchId","value":"string"},{"key":"sortByMetric","value":"TransactionsPopularity"},{"key":"sortByGeoPoint","value":"34.052235,-118.243685"},{"key":"filterGeoPoints","value":"34.052235,-118.243685"},{"key":"filterGeoPoints","value":"15.0,65.0"},{"key":"filterAroundRadius","value":"5000"},{"key":"filterAnchor","value":"0.2,0.8"},{"key":"filters","value":"string"},{"key":"facets","value":"string"},{"key":"facets","value":"string"},{"key":"facetsSize","value":"2000"},{"key":"maxValuesPerFacet","value":"50"},{"key":"caseSensitiveFacetValues","value":"false"},{"key":"displayAttributes","value":"title"},{"key":"displayAttributes","value":"price"},{"key":"context","value":"mobile"},{"key":"context","value":"listing"},{"key":"includeFacets","value":"filtered"},{"key":"facetsOrderBy","value":"name"},{"key":"page","value":"4"},{"key":"limit","value":"10"},{"key":"sortBy","value":"string"},{"key":"ordering","value":"asc"},{"key":"includeMeta","value":"false"},{"key":"ignoreQueryRules","value":"false"},{"key":"excludeQueryRules","value":"2"},{"key":"excludeQueryRules","value":"5"},{"key":"crossWorkspaceModeEnabled","value":"true"},{"key":"params","value":"source:mobile"},{"key":"token","value":""}],"variable":[{"disabled":false,"type":"any","value":"string","key":"indexId","description":"(Required) ID of the index to be used in the search operation"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1963-08-12T14:54:43.321Z\",\n \"status\": 2878,\n \"message\": \"string\",\n \"error\": \"string\",\n \"path\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"2515070e-5ac9-415a-a042-2420d09f8bb6","name":"Explained visual items search","request":{"name":"Explained visual items search","description":{"content":"Retrieves items that match an image. The results can be filtered and sorted. The response contains an explanation of the factors that influenced the result.\n\n---\n\n**API consumers:** AI API key (legacy), Web SDK Tracker, Workspace (Business Profile)\n\n**API key permission required:** `ITEMS_SEARCH_SEARCH_READ`\n","type":"text/plain"},"url":{"path":["search","v2","indices",":indexId","visual","explain"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"indexId","description":"(Required) ID of the index to be used in the search operation"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"apikey","apikey":[{"key":"key","value":"token"},{"key":"value","value":"{{apiKey}}"},{"key":"in","value":"query"}]},"body":{"mode":"raw","raw":"{\n \"url\": {\n \"value\": \"\"\n },\n \"page\": {\n \"value\": \"\"\n },\n \"limit\": {\n \"value\": \"\"\n },\n \"sortBy\": {\n \"value\": \"\"\n },\n \"ordering\": {\n \"value\": \"\"\n },\n \"includeMeta\": {\n \"value\": \"\"\n },\n \"clientUUID\": {\n \"value\": \"\"\n },\n \"personalize\": {\n \"value\": \"\"\n },\n \"correlationId\": {\n \"value\": \"\"\n },\n \"searchId\": {\n \"value\": \"\"\n },\n \"sortByMetric\": {\n \"value\": \"\"\n },\n \"sortByGeoPoints\": {\n \"value\": \"\"\n },\n \"filterGeoPoints\": {\n \"value\": \"\"\n },\n \"filterAroundRadius\": {\n \"value\": \"\"\n },\n \"filterAnchor\": {\n \"value\": \"\"\n },\n \"filters\": {\n \"value\": \"\"\n },\n \"facets\": {\n \"value\": \"\"\n },\n \"customFilteredFacets\": {\n \"value\": \"\"\n },\n \"facetsSize\": {\n \"value\": \"\"\n },\n \"maxValuesPerFacet\": {\n \"value\": \"\"\n },\n \"caseSensitiveFacetValues\": {\n \"value\": \"\"\n },\n \"includeFacets\": {\n \"value\": \"\"\n },\n \"facetsOrderBy\": {\n \"value\": \"\"\n },\n \"context\": {\n \"value\": \"\"\n },\n \"displayAttributes\": {\n \"value\": \"\"\n },\n \"ignoreQueryRules\": {\n \"value\": \"\"\n },\n \"excludeQueryRules\": {\n \"value\": \"\"\n },\n \"params\": {\n \"value\": \"\"\n },\n \"crossWorkspaceMode\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"9c836d16-05ec-44cf-9574-8b3ea772fbac","name":"Search response","originalRequest":{"url":{"path":["search","v2","indices",":indexId","visual","explain"],"host":["{{baseUrl}}"],"query":[{"key":"token","value":""}],"variable":[{"disabled":false,"type":"any","value":"string","key":"indexId","description":"(Required) ID of the index to be used in the search operation"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"url\": {\n \"value\": \"\"\n },\n \"page\": {\n \"value\": \"\"\n },\n \"limit\": {\n \"value\": \"\"\n },\n \"sortBy\": {\n \"value\": \"\"\n },\n \"ordering\": {\n \"value\": \"\"\n },\n \"includeMeta\": {\n \"value\": \"\"\n },\n \"clientUUID\": {\n \"value\": \"\"\n },\n \"personalize\": {\n \"value\": \"\"\n },\n \"correlationId\": {\n \"value\": \"\"\n },\n \"searchId\": {\n \"value\": \"\"\n },\n \"sortByMetric\": {\n \"value\": \"\"\n },\n \"sortByGeoPoints\": {\n \"value\": \"\"\n },\n \"filterGeoPoints\": {\n \"value\": \"\"\n },\n \"filterAroundRadius\": {\n \"value\": \"\"\n },\n \"filterAnchor\": {\n \"value\": \"\"\n },\n \"filters\": {\n \"value\": \"\"\n },\n \"facets\": {\n \"value\": \"\"\n },\n \"customFilteredFacets\": {\n \"value\": \"\"\n },\n \"facetsSize\": {\n \"value\": \"\"\n },\n \"maxValuesPerFacet\": {\n \"value\": \"\"\n },\n \"caseSensitiveFacetValues\": {\n \"value\": \"\"\n },\n \"includeFacets\": {\n \"value\": \"\"\n },\n \"facetsOrderBy\": {\n \"value\": \"\"\n },\n \"context\": {\n \"value\": \"\"\n },\n \"displayAttributes\": {\n \"value\": \"\"\n },\n \"ignoreQueryRules\": {\n \"value\": \"\"\n },\n \"excludeQueryRules\": {\n \"value\": \"\"\n },\n \"params\": {\n \"value\": \"\"\n },\n \"crossWorkspaceMode\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"data\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"extras\": {\n \"filteredFacets\": {\n \"value\": \"\"\n },\n \"allFacets\": {\n \"value\": \"\"\n },\n \"customFilteredFacets\": {\n \"value\": \"\"\n },\n \"correlationId\": {\n \"value\": \"\"\n },\n \"searchId\": {\n \"value\": \"\"\n },\n \"facetsOrdering\": {\n \"value\": \"\"\n },\n \"explanation\": {\n \"value\": \"\"\n }\n },\n \"meta\": {\n \"totalPages\": {\n \"value\": \"\"\n },\n \"totalCount\": {\n \"value\": \"\"\n },\n \"page\": {\n \"value\": \"\"\n },\n \"limit\": {\n \"value\": \"\"\n },\n \"sortedBy\": {\n \"value\": \"\"\n },\n \"ordering\": {\n \"value\": \"\"\n },\n \"code\": {\n \"value\": \"\"\n },\n \"link\": {\n \"value\": \"\"\n }\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"2c0d3621-a707-47ad-b55f-32b501b36cba","name":"Service not available","originalRequest":{"url":{"path":["search","v2","indices",":indexId","visual","explain"],"host":["{{baseUrl}}"],"query":[{"key":"token","value":""}],"variable":[{"disabled":false,"type":"any","value":"string","key":"indexId","description":"(Required) ID of the index to be used in the search operation"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"url\": {\n \"value\": \"\"\n },\n \"page\": {\n \"value\": \"\"\n },\n \"limit\": {\n \"value\": \"\"\n },\n \"sortBy\": {\n \"value\": \"\"\n },\n \"ordering\": {\n \"value\": \"\"\n },\n \"includeMeta\": {\n \"value\": \"\"\n },\n \"clientUUID\": {\n \"value\": \"\"\n },\n \"personalize\": {\n \"value\": \"\"\n },\n \"correlationId\": {\n \"value\": \"\"\n },\n \"searchId\": {\n \"value\": \"\"\n },\n \"sortByMetric\": {\n \"value\": \"\"\n },\n \"sortByGeoPoints\": {\n \"value\": \"\"\n },\n \"filterGeoPoints\": {\n \"value\": \"\"\n },\n \"filterAroundRadius\": {\n \"value\": \"\"\n },\n \"filterAnchor\": {\n \"value\": \"\"\n },\n \"filters\": {\n \"value\": \"\"\n },\n \"facets\": {\n \"value\": \"\"\n },\n \"customFilteredFacets\": {\n \"value\": \"\"\n },\n \"facetsSize\": {\n \"value\": \"\"\n },\n \"maxValuesPerFacet\": {\n \"value\": \"\"\n },\n \"caseSensitiveFacetValues\": {\n \"value\": \"\"\n },\n \"includeFacets\": {\n \"value\": \"\"\n },\n \"facetsOrderBy\": {\n \"value\": \"\"\n },\n \"context\": {\n \"value\": \"\"\n },\n \"displayAttributes\": {\n \"value\": \"\"\n },\n \"ignoreQueryRules\": {\n \"value\": \"\"\n },\n \"excludeQueryRules\": {\n \"value\": \"\"\n },\n \"params\": {\n \"value\": \"\"\n },\n \"crossWorkspaceMode\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1963-08-12T14:54:43.321Z\",\n \"status\": 2878,\n \"message\": \"string\",\n \"error\": \"string\",\n \"path\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}],"event":[]},{"id":"377393f5-351c-4bde-a491-bcf69f850526","name":"Listing","description":{"content":"","type":"text/plain"},"item":[{"id":"02677164-6c4b-4123-8d85-4e7b484b9681","name":"Items listing","request":{"name":"Items listing","description":{"content":"Retrieves item listing, which is a search without a query. The results can be filtered and sorted.\n\n---\n\n**API consumers:** AI API key (legacy), Web SDK Tracker, Workspace (Business Profile)\n\n**API key permission required:** `ITEMS_SEARCH_SEARCH_READ`\n","type":"text/plain"},"url":{"path":["search","v2","indices",":indexId","list"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"clientUUID","value":"string","description":"UUID of the profile for which the search is performed"},{"disabled":false,"key":"personalize","value":"true","description":"If set to `false`, the search result is not personalized.\n"},{"disabled":false,"key":"correlationId","value":"string","description":"Correlation ID for pagination. If a search with the ID was performed recently (last 10 minutes), the cached results will be used.\n\nDo not send this if sortBy/filters/sorting order, etc. have changed - the cached results may have different order or may match different filters.\n"},{"disabled":false,"key":"searchId","value":"string","description":"**DEPRECATED - use correlationId instead**\n\nSearch ID for pagination. If a search with the ID was performed recently (last 10 minutes), the cached results will be used.\n\nDo not send this if sortBy/filters/sorting order, etc. have changed - the cached results may have different order or may match different filters.\n"},{"disabled":false,"key":"sortByMetric","value":"TransactionsPopularity","description":"IMPORTANT: Sorting disables boosting, elastic filters, and promoting search results.\n\nName of the metric by which the data will be sorted.\n"},{"disabled":false,"key":"sortByGeoPoint","value":"34.052235,-118.243685","description":"IMPORTANT: Sorting disables boosting, elastic filters, and promoting search results.\n\nGeo-point (`{latitude},{longitude}`) for data sorting. Results are sorted by distance from this point. `ordering: asc` means \"closest first\".'\n"},{"disabled":false,"key":"filterGeoPoints","value":"34.052235,-118.243685","description":"The definition of a geographical area to filter by.\n\nGiven one geo-point, the results will be limited to a radius around a point. To override the default radius (1000 meters), provide the `filterAroundRadius` parameter.\n**Example input:** `[\"34.052235,-118.243685\"]`\n\nGiven two geo-points, the results will be limited to a rectangular area.\n**Example input:** `[\"50,-100\", \"25,150\"]`\n\nGiven three or more geo-points, the results will be limited to a polygonal area.\n**Example input:** `[\"50,0\", \"40,20\", \"-20,10\"]`\n"},{"disabled":false,"key":"filterGeoPoints","value":"15.0,65.0","description":"The definition of a geographical area to filter by.\n\nGiven one geo-point, the results will be limited to a radius around a point. To override the default radius (1000 meters), provide the `filterAroundRadius` parameter.\n**Example input:** `[\"34.052235,-118.243685\"]`\n\nGiven two geo-points, the results will be limited to a rectangular area.\n**Example input:** `[\"50,-100\", \"25,150\"]`\n\nGiven three or more geo-points, the results will be limited to a polygonal area.\n**Example input:** `[\"50,0\", \"40,20\", \"-20,10\"]`\n"},{"disabled":false,"key":"filterAroundRadius","value":"5000","description":"Radius in meters to be used when filtering using geo-location. Can only be used when filtering by a single geo-point."},{"disabled":false,"key":"filters","value":"string","description":"IQL query string. For details, see the [Help Center](https://help.synerise.com/developers/iql/)."},{"disabled":false,"key":"facets","value":"string","description":"A list of attributes for which facets will be returned. A single `*` value matches all facetable attributes.\nA single `auto` value enables automatic facet selection based on the result set — the system picks the most relevant facets using the index's `dynamicFacets` configuration.\n\nTo determine which groups of facets should be returned, use the `includeFacets` parameter.\n"},{"disabled":false,"key":"facets","value":"string","description":"A list of attributes for which facets will be returned. A single `*` value matches all facetable attributes.\nA single `auto` value enables automatic facet selection based on the result set — the system picks the most relevant facets using the index's `dynamicFacets` configuration.\n\nTo determine which groups of facets should be returned, use the `includeFacets` parameter.\n"},{"disabled":false,"key":"facetsSize","value":"2000","description":"Determines how many items will be used for facets aggregation.\n"},{"disabled":false,"key":"maxValuesPerFacet","value":"50","description":"Determines how many values will be retrieved per facet.\n"},{"disabled":false,"key":"caseSensitiveFacetValues","value":"false","description":"Specifies whether facets aggregation should be case sensitive.\n"},{"disabled":false,"key":"displayAttributes","value":"title","description":"List of ad hoc attributes that will be returned for each found item"},{"disabled":false,"key":"displayAttributes","value":"price","description":"List of ad hoc attributes that will be returned for each found item"},{"disabled":false,"key":"context","value":"mobile","description":"List of context strings for a search query"},{"disabled":false,"key":"context","value":"listing","description":"List of context strings for a search query"},{"disabled":false,"key":"includeFacets","value":"filtered","description":"Determines which groups of facets will be returned: both filtered and unfiltered; just filtered; just unfiltered; or no group at at all.\n\nTo determine which attributes should be returned as facets in each group, use the `facets` parameter.\n"},{"disabled":false,"key":"facetsOrderBy","value":"name","description":"Controls the ordering of facets in the response. \nWhen `facets=auto`, the default ordering is by coverage (most relevant facets first). \nWhen facets are specified explicitly, the default ordering is by name. \nWhen two facets have equal coverage, ties are resolved by name.\n"},{"disabled":false,"key":"page","value":"4","description":"Page number to return for pagination. The first page has the index `1`."},{"disabled":false,"key":"limit","value":"10","description":"The number of items to return per page"},{"disabled":false,"key":"sortBy","value":"string","description":"IMPORTANT: Sorting disables boosting, elastic filters, and promoting search results.\n\nName of the attribute by which the data will be sorted. \n"},{"disabled":false,"key":"ordering","value":"asc","description":"Sorting order"},{"disabled":false,"key":"includeMeta","value":"false","description":"\nWhen `true`, pagination metadata is included in the response body.\n\nWhen `false`, the data is included in the response headers:\n\n- Link: links to neighbors, first, and last pages in pagination.\n\n- X-Pagination-Total-Count: total number of items on all pages\n\n- X-Pagination-Total-Pages: total number of pages\n\n- X-Pagination-Page: current page\n\n- X-Pagination-Limit: maximum number of items on a page\n\n- X-Pagination-Sorted-By: parameter that the items were sorted by\n\n- X-Pagination-Ordering: sorting direction\n"},{"disabled":false,"key":"distinctFilter","value":"{\"attribute\": \"color\", \"maxNumItems\": 3}","description":"DistinctFilter JSON as an URL-encoded string\n"},{"disabled":false,"key":"ignoreQueryRules","value":"false","description":"If set to `true`, query rules are not applied.\n"},{"disabled":false,"key":"excludeQueryRules","value":"2","description":"List of query rules that will not be applied.\n"},{"disabled":false,"key":"excludeQueryRules","value":"5","description":"List of query rules that will not be applied.\n"},{"disabled":false,"key":"params","value":"source:mobile","description":"List of extra params that will be added to the `item.search` event. They must be in the `name:value` format. The total size must not exceed 500 bytes when written as a JSON object.\n"}],"variable":[{"disabled":false,"type":"any","value":"string","key":"indexId","description":"(Required) ID of the index to be used in the search operation"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"key":"key","value":"token"},{"key":"value","value":"{{apiKey}}"},{"key":"in","value":"query"}]}},"response":[{"id":"4d367dd5-28fa-401a-bd1b-69cc6280c708","name":"Listing result","originalRequest":{"url":{"path":["search","v2","indices",":indexId","list"],"host":["{{baseUrl}}"],"query":[{"key":"clientUUID","value":"string"},{"key":"personalize","value":"true"},{"key":"correlationId","value":"string"},{"key":"searchId","value":"string"},{"key":"sortByMetric","value":"TransactionsPopularity"},{"key":"sortByGeoPoint","value":"34.052235,-118.243685"},{"key":"filterGeoPoints","value":"34.052235,-118.243685"},{"key":"filterGeoPoints","value":"15.0,65.0"},{"key":"filterAroundRadius","value":"5000"},{"key":"filters","value":"string"},{"key":"facets","value":"string"},{"key":"facets","value":"string"},{"key":"facetsSize","value":"2000"},{"key":"maxValuesPerFacet","value":"50"},{"key":"caseSensitiveFacetValues","value":"false"},{"key":"displayAttributes","value":"title"},{"key":"displayAttributes","value":"price"},{"key":"context","value":"mobile"},{"key":"context","value":"listing"},{"key":"includeFacets","value":"filtered"},{"key":"facetsOrderBy","value":"name"},{"key":"page","value":"4"},{"key":"limit","value":"10"},{"key":"sortBy","value":"string"},{"key":"ordering","value":"asc"},{"key":"includeMeta","value":"false"},{"key":"distinctFilter","value":"{\"attribute\": \"color\", \"maxNumItems\": 3}"},{"key":"ignoreQueryRules","value":"false"},{"key":"excludeQueryRules","value":"2"},{"key":"excludeQueryRules","value":"5"},{"key":"params","value":"source:mobile"},{"key":"token","value":""}],"variable":[{"disabled":false,"type":"any","value":"string","key":"indexId","description":"(Required) ID of the index to be used in the search operation"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"data\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"extras\": {\n \"filteredFacets\": {\n \"value\": \"\"\n },\n \"allFacets\": {\n \"value\": \"\"\n },\n \"customFilteredFacets\": {\n \"value\": \"\"\n },\n \"correlationId\": {\n \"value\": \"\"\n },\n \"searchId\": {\n \"value\": \"\"\n },\n \"facetsOrdering\": {\n \"value\": \"\"\n }\n },\n \"meta\": {\n \"totalPages\": {\n \"value\": \"\"\n },\n \"totalCount\": {\n \"value\": \"\"\n },\n \"page\": {\n \"value\": \"\"\n },\n \"limit\": {\n \"value\": \"\"\n },\n \"sortedBy\": {\n \"value\": \"\"\n },\n \"ordering\": {\n \"value\": \"\"\n },\n \"code\": {\n \"value\": \"\"\n },\n \"link\": {\n \"value\": \"\"\n }\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"e5917f86-624d-4a86-9839-dcc6e7032ed8","name":"Service not available","originalRequest":{"url":{"path":["search","v2","indices",":indexId","list"],"host":["{{baseUrl}}"],"query":[{"key":"clientUUID","value":"string"},{"key":"personalize","value":"true"},{"key":"correlationId","value":"string"},{"key":"searchId","value":"string"},{"key":"sortByMetric","value":"TransactionsPopularity"},{"key":"sortByGeoPoint","value":"34.052235,-118.243685"},{"key":"filterGeoPoints","value":"34.052235,-118.243685"},{"key":"filterGeoPoints","value":"15.0,65.0"},{"key":"filterAroundRadius","value":"5000"},{"key":"filters","value":"string"},{"key":"facets","value":"string"},{"key":"facets","value":"string"},{"key":"facetsSize","value":"2000"},{"key":"maxValuesPerFacet","value":"50"},{"key":"caseSensitiveFacetValues","value":"false"},{"key":"displayAttributes","value":"title"},{"key":"displayAttributes","value":"price"},{"key":"context","value":"mobile"},{"key":"context","value":"listing"},{"key":"includeFacets","value":"filtered"},{"key":"facetsOrderBy","value":"name"},{"key":"page","value":"4"},{"key":"limit","value":"10"},{"key":"sortBy","value":"string"},{"key":"ordering","value":"asc"},{"key":"includeMeta","value":"false"},{"key":"distinctFilter","value":"{\"attribute\": \"color\", \"maxNumItems\": 3}"},{"key":"ignoreQueryRules","value":"false"},{"key":"excludeQueryRules","value":"2"},{"key":"excludeQueryRules","value":"5"},{"key":"params","value":"source:mobile"},{"key":"token","value":""}],"variable":[{"disabled":false,"type":"any","value":"string","key":"indexId","description":"(Required) ID of the index to be used in the search operation"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1963-08-12T14:54:43.321Z\",\n \"status\": 2878,\n \"message\": \"string\",\n \"error\": \"string\",\n \"path\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"ff0e309e-f800-4780-9d14-0f28a2eae92c","name":"Items listing","request":{"name":"Items listing","description":{"content":"Retrieves item listing, which is a search without a query. The results can be filtered and sorted.\n\n---\n\n**API consumers:** AI API key (legacy), Web SDK Tracker, Workspace (Business Profile)\n\n**API key permission required:** `ITEMS_SEARCH_SEARCH_READ`\n","type":"text/plain"},"url":{"path":["search","v2","indices",":indexId","list"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"indexId","description":"(Required) ID of the index to be used in the search operation"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"apikey","apikey":[{"key":"key","value":"token"},{"key":"value","value":"{{apiKey}}"},{"key":"in","value":"query"}]},"body":{"mode":"raw","raw":"{\n \"page\": 1471,\n \"limit\": 10,\n \"sortBy\": \"string\",\n \"ordering\": \"asc\",\n \"includeMeta\": true,\n \"clientUUID\": \"string\",\n \"personalize\": true,\n \"correlationId\": \"string\",\n \"searchId\": \"string\",\n \"sortByMetric\": \"TransactionsPopularity\",\n \"sortByGeoPoints\": \"34.052235,-118.243685\",\n \"filterGeoPoints\": [\n \"34.052235,-118.243685\",\n \"15.0,65.0\"\n ],\n \"filterAroundRadius\": 2000,\n \"filters\": \"string\",\n \"facets\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"customFilteredFacets\": {\n \"brand\": \"price > 100\",\n \"price\": \"brand == foo\"\n },\n \"facetsSize\": 2000,\n \"maxValuesPerFacet\": 50,\n \"caseSensitiveFacetValues\": false,\n \"includeFacets\": \"filtered\",\n \"facetsOrderBy\": \"coverage\",\n \"context\": [\n \"mobile\",\n \"listing\"\n ],\n \"displayAttributes\": [\n \"title\",\n \"price\"\n ],\n \"distinctFilter\": {\n \"attribute\": {\n \"value\": \"\"\n },\n \"maxNumItems\": {\n \"value\": \"\"\n },\n \"levelRangeModifier\": {\n \"value\": \"\"\n }\n },\n \"ignoreQueryRules\": false,\n \"excludeQueryRules\": [\n 2,\n 5\n ],\n \"params\": {\n \"source\": \"mobile\"\n }\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"90306d77-f58d-4685-b420-4cb1600fb973","name":"Listing result","originalRequest":{"url":{"path":["search","v2","indices",":indexId","list"],"host":["{{baseUrl}}"],"query":[{"key":"token","value":""}],"variable":[{"disabled":false,"type":"any","value":"string","key":"indexId","description":"(Required) ID of the index to be used in the search operation"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"page\": 3524,\n \"limit\": 10,\n \"sortBy\": \"string\",\n \"ordering\": \"asc\",\n \"includeMeta\": true,\n \"clientUUID\": \"string\",\n \"personalize\": true,\n \"correlationId\": \"string\",\n \"searchId\": \"string\",\n \"sortByMetric\": \"PageVisitsPopularity\",\n \"sortByGeoPoints\": \"34.052235,-118.243685\",\n \"filterGeoPoints\": [\n \"34.052235,-118.243685\",\n \"15.0,65.0\"\n ],\n \"filterAroundRadius\": 2000,\n \"filters\": \"string\",\n \"facets\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"customFilteredFacets\": {\n \"brand\": \"price > 100\",\n \"price\": \"brand == foo\"\n },\n \"facetsSize\": 2000,\n \"maxValuesPerFacet\": 50,\n \"caseSensitiveFacetValues\": false,\n \"includeFacets\": \"filtered\",\n \"facetsOrderBy\": \"coverage\",\n \"context\": [\n \"mobile\",\n \"listing\"\n ],\n \"displayAttributes\": [\n \"title\",\n \"price\"\n ],\n \"distinctFilter\": {\n \"attribute\": {\n \"value\": \"\"\n },\n \"maxNumItems\": {\n \"value\": \"\"\n },\n \"levelRangeModifier\": {\n \"value\": \"\"\n }\n },\n \"ignoreQueryRules\": false,\n \"excludeQueryRules\": [\n 2,\n 5\n ],\n \"params\": {\n \"source\": \"mobile\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"data\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"extras\": {\n \"filteredFacets\": {\n \"value\": \"\"\n },\n \"allFacets\": {\n \"value\": \"\"\n },\n \"customFilteredFacets\": {\n \"value\": \"\"\n },\n \"correlationId\": {\n \"value\": \"\"\n },\n \"searchId\": {\n \"value\": \"\"\n },\n \"facetsOrdering\": {\n \"value\": \"\"\n }\n },\n \"meta\": {\n \"totalPages\": {\n \"value\": \"\"\n },\n \"totalCount\": {\n \"value\": \"\"\n },\n \"page\": {\n \"value\": \"\"\n },\n \"limit\": {\n \"value\": \"\"\n },\n \"sortedBy\": {\n \"value\": \"\"\n },\n \"ordering\": {\n \"value\": \"\"\n },\n \"code\": {\n \"value\": \"\"\n },\n \"link\": {\n \"value\": \"\"\n }\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"bd4fa99d-7716-4ca5-aa6c-1d73472fcb62","name":"Service not available","originalRequest":{"url":{"path":["search","v2","indices",":indexId","list"],"host":["{{baseUrl}}"],"query":[{"key":"token","value":""}],"variable":[{"disabled":false,"type":"any","value":"string","key":"indexId","description":"(Required) ID of the index to be used in the search operation"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"page\": 3524,\n \"limit\": 10,\n \"sortBy\": \"string\",\n \"ordering\": \"asc\",\n \"includeMeta\": true,\n \"clientUUID\": \"string\",\n \"personalize\": true,\n \"correlationId\": \"string\",\n \"searchId\": \"string\",\n \"sortByMetric\": \"PageVisitsPopularity\",\n \"sortByGeoPoints\": \"34.052235,-118.243685\",\n \"filterGeoPoints\": [\n \"34.052235,-118.243685\",\n \"15.0,65.0\"\n ],\n \"filterAroundRadius\": 2000,\n \"filters\": \"string\",\n \"facets\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"customFilteredFacets\": {\n \"brand\": \"price > 100\",\n \"price\": \"brand == foo\"\n },\n \"facetsSize\": 2000,\n \"maxValuesPerFacet\": 50,\n \"caseSensitiveFacetValues\": false,\n \"includeFacets\": \"filtered\",\n \"facetsOrderBy\": \"coverage\",\n \"context\": [\n \"mobile\",\n \"listing\"\n ],\n \"displayAttributes\": [\n \"title\",\n \"price\"\n ],\n \"distinctFilter\": {\n \"attribute\": {\n \"value\": \"\"\n },\n \"maxNumItems\": {\n \"value\": \"\"\n },\n \"levelRangeModifier\": {\n \"value\": \"\"\n }\n },\n \"ignoreQueryRules\": false,\n \"excludeQueryRules\": [\n 2,\n 5\n ],\n \"params\": {\n \"source\": \"mobile\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1963-08-12T14:54:43.321Z\",\n \"status\": 2878,\n \"message\": \"string\",\n \"error\": \"string\",\n \"path\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"9aedd939-fc35-4930-ac49-343aa7e37299","name":"Explained items listing","request":{"name":"Explained items listing","description":{"content":"Retrieves item listing, which is a search without a query. The results can be filtered and sorted. The response contains an explanation of the factors that influenced the result.\n\n---\n\n**API consumers:** AI API key (legacy), Web SDK Tracker, Workspace (Business Profile)\n\n**API key permission required:** `ITEMS_SEARCH_SEARCH_READ`\n","type":"text/plain"},"url":{"path":["search","v2","indices",":indexId","list","explain"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"clientUUID","value":"string","description":"UUID of the profile for which the search is performed"},{"disabled":false,"key":"personalize","value":"true","description":"If set to `false`, the search result is not personalized.\n"},{"disabled":false,"key":"correlationId","value":"string","description":"Correlation ID for pagination. If a search with the ID was performed recently (last 10 minutes), the cached results will be used.\n\nDo not send this if sortBy/filters/sorting order, etc. have changed - the cached results may have different order or may match different filters.\n"},{"disabled":false,"key":"searchId","value":"string","description":"**DEPRECATED - use correlationId instead**\n\nSearch ID for pagination. If a search with the ID was performed recently (last 10 minutes), the cached results will be used.\n\nDo not send this if sortBy/filters/sorting order, etc. have changed - the cached results may have different order or may match different filters.\n"},{"disabled":false,"key":"sortByMetric","value":"TransactionsPopularity","description":"IMPORTANT: Sorting disables boosting, elastic filters, and promoting search results.\n\nName of the metric by which the data will be sorted.\n"},{"disabled":false,"key":"sortByGeoPoint","value":"34.052235,-118.243685","description":"IMPORTANT: Sorting disables boosting, elastic filters, and promoting search results.\n\nGeo-point (`{latitude},{longitude}`) for data sorting. Results are sorted by distance from this point. `ordering: asc` means \"closest first\".'\n"},{"disabled":false,"key":"filterGeoPoints","value":"34.052235,-118.243685","description":"The definition of a geographical area to filter by.\n\nGiven one geo-point, the results will be limited to a radius around a point. To override the default radius (1000 meters), provide the `filterAroundRadius` parameter.\n**Example input:** `[\"34.052235,-118.243685\"]`\n\nGiven two geo-points, the results will be limited to a rectangular area.\n**Example input:** `[\"50,-100\", \"25,150\"]`\n\nGiven three or more geo-points, the results will be limited to a polygonal area.\n**Example input:** `[\"50,0\", \"40,20\", \"-20,10\"]`\n"},{"disabled":false,"key":"filterGeoPoints","value":"15.0,65.0","description":"The definition of a geographical area to filter by.\n\nGiven one geo-point, the results will be limited to a radius around a point. To override the default radius (1000 meters), provide the `filterAroundRadius` parameter.\n**Example input:** `[\"34.052235,-118.243685\"]`\n\nGiven two geo-points, the results will be limited to a rectangular area.\n**Example input:** `[\"50,-100\", \"25,150\"]`\n\nGiven three or more geo-points, the results will be limited to a polygonal area.\n**Example input:** `[\"50,0\", \"40,20\", \"-20,10\"]`\n"},{"disabled":false,"key":"filterAroundRadius","value":"5000","description":"Radius in meters to be used when filtering using geo-location. Can only be used when filtering by a single geo-point."},{"disabled":false,"key":"filters","value":"string","description":"IQL query string. For details, see the [Help Center](https://help.synerise.com/developers/iql/)."},{"disabled":false,"key":"facets","value":"string","description":"A list of attributes for which facets will be returned. A single `*` value matches all facetable attributes.\nA single `auto` value enables automatic facet selection based on the result set — the system picks the most relevant facets using the index's `dynamicFacets` configuration.\n\nTo determine which groups of facets should be returned, use the `includeFacets` parameter.\n"},{"disabled":false,"key":"facets","value":"string","description":"A list of attributes for which facets will be returned. A single `*` value matches all facetable attributes.\nA single `auto` value enables automatic facet selection based on the result set — the system picks the most relevant facets using the index's `dynamicFacets` configuration.\n\nTo determine which groups of facets should be returned, use the `includeFacets` parameter.\n"},{"disabled":false,"key":"facetsSize","value":"2000","description":"Determines how many items will be used for facets aggregation.\n"},{"disabled":false,"key":"maxValuesPerFacet","value":"50","description":"Determines how many values will be retrieved per facet.\n"},{"disabled":false,"key":"caseSensitiveFacetValues","value":"false","description":"Specifies whether facets aggregation should be case sensitive.\n"},{"disabled":false,"key":"displayAttributes","value":"title","description":"List of ad hoc attributes that will be returned for each found item"},{"disabled":false,"key":"displayAttributes","value":"price","description":"List of ad hoc attributes that will be returned for each found item"},{"disabled":false,"key":"context","value":"mobile","description":"List of context strings for a search query"},{"disabled":false,"key":"context","value":"listing","description":"List of context strings for a search query"},{"disabled":false,"key":"includeFacets","value":"filtered","description":"Determines which groups of facets will be returned: both filtered and unfiltered; just filtered; just unfiltered; or no group at at all.\n\nTo determine which attributes should be returned as facets in each group, use the `facets` parameter.\n"},{"disabled":false,"key":"facetsOrderBy","value":"name","description":"Controls the ordering of facets in the response. \nWhen `facets=auto`, the default ordering is by coverage (most relevant facets first). \nWhen facets are specified explicitly, the default ordering is by name. \nWhen two facets have equal coverage, ties are resolved by name.\n"},{"disabled":false,"key":"page","value":"4","description":"Page number to return for pagination. The first page has the index `1`."},{"disabled":false,"key":"limit","value":"10","description":"The number of items to return per page"},{"disabled":false,"key":"sortBy","value":"string","description":"IMPORTANT: Sorting disables boosting, elastic filters, and promoting search results.\n\nName of the attribute by which the data will be sorted. \n"},{"disabled":false,"key":"ordering","value":"asc","description":"Sorting order"},{"disabled":false,"key":"includeMeta","value":"false","description":"\nWhen `true`, pagination metadata is included in the response body.\n\nWhen `false`, the data is included in the response headers:\n\n- Link: links to neighbors, first, and last pages in pagination.\n\n- X-Pagination-Total-Count: total number of items on all pages\n\n- X-Pagination-Total-Pages: total number of pages\n\n- X-Pagination-Page: current page\n\n- X-Pagination-Limit: maximum number of items on a page\n\n- X-Pagination-Sorted-By: parameter that the items were sorted by\n\n- X-Pagination-Ordering: sorting direction\n"},{"disabled":false,"key":"distinctFilter","value":"{\"attribute\": \"color\", \"maxNumItems\": 3}","description":"DistinctFilter JSON as an URL-encoded string\n"},{"disabled":false,"key":"ignoreQueryRules","value":"false","description":"If set to `true`, query rules are not applied.\n"},{"disabled":false,"key":"excludeQueryRules","value":"2","description":"List of query rules that will not be applied.\n"},{"disabled":false,"key":"excludeQueryRules","value":"5","description":"List of query rules that will not be applied.\n"},{"disabled":false,"key":"crossWorkspaceModeEnabled","value":"true","description":"If set, overrides the cross-workspace mode from the index configuration. When `true`, cross-workspace personalization is enabled. When `false`, it is disabled.\n"},{"disabled":false,"key":"params","value":"source:mobile","description":"List of extra params that will be added to the `item.search` event. They must be in the `name:value` format. The total size must not exceed 500 bytes when written as a JSON object.\n"}],"variable":[{"disabled":false,"type":"any","value":"string","key":"indexId","description":"(Required) ID of the index to be used in the search operation"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"key":"key","value":"token"},{"key":"value","value":"{{apiKey}}"},{"key":"in","value":"query"}]}},"response":[{"id":"0480f3d5-7853-42ca-a6d5-cec66ebc8750","name":"Listing result","originalRequest":{"url":{"path":["search","v2","indices",":indexId","list","explain"],"host":["{{baseUrl}}"],"query":[{"key":"clientUUID","value":"string"},{"key":"personalize","value":"true"},{"key":"correlationId","value":"string"},{"key":"searchId","value":"string"},{"key":"sortByMetric","value":"TransactionsPopularity"},{"key":"sortByGeoPoint","value":"34.052235,-118.243685"},{"key":"filterGeoPoints","value":"34.052235,-118.243685"},{"key":"filterGeoPoints","value":"15.0,65.0"},{"key":"filterAroundRadius","value":"5000"},{"key":"filters","value":"string"},{"key":"facets","value":"string"},{"key":"facets","value":"string"},{"key":"facetsSize","value":"2000"},{"key":"maxValuesPerFacet","value":"50"},{"key":"caseSensitiveFacetValues","value":"false"},{"key":"displayAttributes","value":"title"},{"key":"displayAttributes","value":"price"},{"key":"context","value":"mobile"},{"key":"context","value":"listing"},{"key":"includeFacets","value":"filtered"},{"key":"facetsOrderBy","value":"name"},{"key":"page","value":"4"},{"key":"limit","value":"10"},{"key":"sortBy","value":"string"},{"key":"ordering","value":"asc"},{"key":"includeMeta","value":"false"},{"key":"distinctFilter","value":"{\"attribute\": \"color\", \"maxNumItems\": 3}"},{"key":"ignoreQueryRules","value":"false"},{"key":"excludeQueryRules","value":"2"},{"key":"excludeQueryRules","value":"5"},{"key":"crossWorkspaceModeEnabled","value":"true"},{"key":"params","value":"source:mobile"},{"key":"token","value":""}],"variable":[{"disabled":false,"type":"any","value":"string","key":"indexId","description":"(Required) ID of the index to be used in the search operation"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"data\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"extras\": {\n \"filteredFacets\": {\n \"value\": \"\"\n },\n \"allFacets\": {\n \"value\": \"\"\n },\n \"customFilteredFacets\": {\n \"value\": \"\"\n },\n \"correlationId\": {\n \"value\": \"\"\n },\n \"searchId\": {\n \"value\": \"\"\n },\n \"facetsOrdering\": {\n \"value\": \"\"\n },\n \"explanation\": {\n \"value\": \"\"\n }\n },\n \"meta\": {\n \"totalPages\": {\n \"value\": \"\"\n },\n \"totalCount\": {\n \"value\": \"\"\n },\n \"page\": {\n \"value\": \"\"\n },\n \"limit\": {\n \"value\": \"\"\n },\n \"sortedBy\": {\n \"value\": \"\"\n },\n \"ordering\": {\n \"value\": \"\"\n },\n \"code\": {\n \"value\": \"\"\n },\n \"link\": {\n \"value\": \"\"\n }\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"fc60f69c-dd30-4b09-8c76-d40a04420ceb","name":"Service not available","originalRequest":{"url":{"path":["search","v2","indices",":indexId","list","explain"],"host":["{{baseUrl}}"],"query":[{"key":"clientUUID","value":"string"},{"key":"personalize","value":"true"},{"key":"correlationId","value":"string"},{"key":"searchId","value":"string"},{"key":"sortByMetric","value":"TransactionsPopularity"},{"key":"sortByGeoPoint","value":"34.052235,-118.243685"},{"key":"filterGeoPoints","value":"34.052235,-118.243685"},{"key":"filterGeoPoints","value":"15.0,65.0"},{"key":"filterAroundRadius","value":"5000"},{"key":"filters","value":"string"},{"key":"facets","value":"string"},{"key":"facets","value":"string"},{"key":"facetsSize","value":"2000"},{"key":"maxValuesPerFacet","value":"50"},{"key":"caseSensitiveFacetValues","value":"false"},{"key":"displayAttributes","value":"title"},{"key":"displayAttributes","value":"price"},{"key":"context","value":"mobile"},{"key":"context","value":"listing"},{"key":"includeFacets","value":"filtered"},{"key":"facetsOrderBy","value":"name"},{"key":"page","value":"4"},{"key":"limit","value":"10"},{"key":"sortBy","value":"string"},{"key":"ordering","value":"asc"},{"key":"includeMeta","value":"false"},{"key":"distinctFilter","value":"{\"attribute\": \"color\", \"maxNumItems\": 3}"},{"key":"ignoreQueryRules","value":"false"},{"key":"excludeQueryRules","value":"2"},{"key":"excludeQueryRules","value":"5"},{"key":"crossWorkspaceModeEnabled","value":"true"},{"key":"params","value":"source:mobile"},{"key":"token","value":""}],"variable":[{"disabled":false,"type":"any","value":"string","key":"indexId","description":"(Required) ID of the index to be used in the search operation"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1963-08-12T14:54:43.321Z\",\n \"status\": 2878,\n \"message\": \"string\",\n \"error\": \"string\",\n \"path\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"451c6545-c4aa-42d7-8d53-9899bbba26de","name":"Explained items listing","request":{"name":"Explained items listing","description":{"content":"Retrieves item listing, which is a search without a query. The results can be filtered and sorted. The response contains an explanation of the factors that influenced the result.\n\n---\n\n**API consumers:** AI API key (legacy), Web SDK Tracker, Workspace (Business Profile)\n\n**API key permission required:** `ITEMS_SEARCH_SEARCH_READ`\n","type":"text/plain"},"url":{"path":["search","v2","indices",":indexId","list","explain"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"indexId","description":"(Required) ID of the index to be used in the search operation"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"apikey","apikey":[{"key":"key","value":"token"},{"key":"value","value":"{{apiKey}}"},{"key":"in","value":"query"}]},"body":{"mode":"raw","raw":"{\n \"page\": {\n \"value\": \"\"\n },\n \"limit\": {\n \"value\": \"\"\n },\n \"sortBy\": {\n \"value\": \"\"\n },\n \"ordering\": {\n \"value\": \"\"\n },\n \"includeMeta\": {\n \"value\": \"\"\n },\n \"clientUUID\": {\n \"value\": \"\"\n },\n \"personalize\": {\n \"value\": \"\"\n },\n \"correlationId\": {\n \"value\": \"\"\n },\n \"searchId\": {\n \"value\": \"\"\n },\n \"sortByMetric\": {\n \"value\": \"\"\n },\n \"sortByGeoPoints\": {\n \"value\": \"\"\n },\n \"filterGeoPoints\": {\n \"value\": \"\"\n },\n \"filterAroundRadius\": {\n \"value\": \"\"\n },\n \"filters\": {\n \"value\": \"\"\n },\n \"facets\": {\n \"value\": \"\"\n },\n \"customFilteredFacets\": {\n \"value\": \"\"\n },\n \"facetsSize\": {\n \"value\": \"\"\n },\n \"maxValuesPerFacet\": {\n \"value\": \"\"\n },\n \"caseSensitiveFacetValues\": {\n \"value\": \"\"\n },\n \"includeFacets\": {\n \"value\": \"\"\n },\n \"facetsOrderBy\": {\n \"value\": \"\"\n },\n \"context\": {\n \"value\": \"\"\n },\n \"displayAttributes\": {\n \"value\": \"\"\n },\n \"distinctFilter\": {\n \"value\": \"\"\n },\n \"ignoreQueryRules\": {\n \"value\": \"\"\n },\n \"excludeQueryRules\": {\n \"value\": \"\"\n },\n \"params\": {\n \"value\": \"\"\n },\n \"crossWorkspaceMode\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"2e0e26b6-918c-4d61-90fe-2ac13af6216e","name":"Listing result","originalRequest":{"url":{"path":["search","v2","indices",":indexId","list","explain"],"host":["{{baseUrl}}"],"query":[{"key":"token","value":""}],"variable":[{"disabled":false,"type":"any","value":"string","key":"indexId","description":"(Required) ID of the index to be used in the search operation"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"page\": {\n \"value\": \"\"\n },\n \"limit\": {\n \"value\": \"\"\n },\n \"sortBy\": {\n \"value\": \"\"\n },\n \"ordering\": {\n \"value\": \"\"\n },\n \"includeMeta\": {\n \"value\": \"\"\n },\n \"clientUUID\": {\n \"value\": \"\"\n },\n \"personalize\": {\n \"value\": \"\"\n },\n \"correlationId\": {\n \"value\": \"\"\n },\n \"searchId\": {\n \"value\": \"\"\n },\n \"sortByMetric\": {\n \"value\": \"\"\n },\n \"sortByGeoPoints\": {\n \"value\": \"\"\n },\n \"filterGeoPoints\": {\n \"value\": \"\"\n },\n \"filterAroundRadius\": {\n \"value\": \"\"\n },\n \"filters\": {\n \"value\": \"\"\n },\n \"facets\": {\n \"value\": \"\"\n },\n \"customFilteredFacets\": {\n \"value\": \"\"\n },\n \"facetsSize\": {\n \"value\": \"\"\n },\n \"maxValuesPerFacet\": {\n \"value\": \"\"\n },\n \"caseSensitiveFacetValues\": {\n \"value\": \"\"\n },\n \"includeFacets\": {\n \"value\": \"\"\n },\n \"facetsOrderBy\": {\n \"value\": \"\"\n },\n \"context\": {\n \"value\": \"\"\n },\n \"displayAttributes\": {\n \"value\": \"\"\n },\n \"distinctFilter\": {\n \"value\": \"\"\n },\n \"ignoreQueryRules\": {\n \"value\": \"\"\n },\n \"excludeQueryRules\": {\n \"value\": \"\"\n },\n \"params\": {\n \"value\": \"\"\n },\n \"crossWorkspaceMode\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"data\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"extras\": {\n \"filteredFacets\": {\n \"value\": \"\"\n },\n \"allFacets\": {\n \"value\": \"\"\n },\n \"customFilteredFacets\": {\n \"value\": \"\"\n },\n \"correlationId\": {\n \"value\": \"\"\n },\n \"searchId\": {\n \"value\": \"\"\n },\n \"facetsOrdering\": {\n \"value\": \"\"\n },\n \"explanation\": {\n \"value\": \"\"\n }\n },\n \"meta\": {\n \"totalPages\": {\n \"value\": \"\"\n },\n \"totalCount\": {\n \"value\": \"\"\n },\n \"page\": {\n \"value\": \"\"\n },\n \"limit\": {\n \"value\": \"\"\n },\n \"sortedBy\": {\n \"value\": \"\"\n },\n \"ordering\": {\n \"value\": \"\"\n },\n \"code\": {\n \"value\": \"\"\n },\n \"link\": {\n \"value\": \"\"\n }\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"cef648eb-c8c3-4fa5-a905-b7b9f520b77a","name":"Service not available","originalRequest":{"url":{"path":["search","v2","indices",":indexId","list","explain"],"host":["{{baseUrl}}"],"query":[{"key":"token","value":""}],"variable":[{"disabled":false,"type":"any","value":"string","key":"indexId","description":"(Required) ID of the index to be used in the search operation"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"page\": {\n \"value\": \"\"\n },\n \"limit\": {\n \"value\": \"\"\n },\n \"sortBy\": {\n \"value\": \"\"\n },\n \"ordering\": {\n \"value\": \"\"\n },\n \"includeMeta\": {\n \"value\": \"\"\n },\n \"clientUUID\": {\n \"value\": \"\"\n },\n \"personalize\": {\n \"value\": \"\"\n },\n \"correlationId\": {\n \"value\": \"\"\n },\n \"searchId\": {\n \"value\": \"\"\n },\n \"sortByMetric\": {\n \"value\": \"\"\n },\n \"sortByGeoPoints\": {\n \"value\": \"\"\n },\n \"filterGeoPoints\": {\n \"value\": \"\"\n },\n \"filterAroundRadius\": {\n \"value\": \"\"\n },\n \"filters\": {\n \"value\": \"\"\n },\n \"facets\": {\n \"value\": \"\"\n },\n \"customFilteredFacets\": {\n \"value\": \"\"\n },\n \"facetsSize\": {\n \"value\": \"\"\n },\n \"maxValuesPerFacet\": {\n \"value\": \"\"\n },\n \"caseSensitiveFacetValues\": {\n \"value\": \"\"\n },\n \"includeFacets\": {\n \"value\": \"\"\n },\n \"facetsOrderBy\": {\n \"value\": \"\"\n },\n \"context\": {\n \"value\": \"\"\n },\n \"displayAttributes\": {\n \"value\": \"\"\n },\n \"distinctFilter\": {\n \"value\": \"\"\n },\n \"ignoreQueryRules\": {\n \"value\": \"\"\n },\n \"excludeQueryRules\": {\n \"value\": \"\"\n },\n \"params\": {\n \"value\": \"\"\n },\n \"crossWorkspaceMode\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1963-08-12T14:54:43.321Z\",\n \"status\": 2878,\n \"message\": \"string\",\n \"error\": \"string\",\n \"path\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}],"event":[]},{"id":"b3bec308-3875-4924-9862-2f90acdc21bc","name":"Synonyms","description":{"content":"","type":"text/plain"},"item":[{"id":"f2ae9232-fa1a-4022-9339-42dae4b0e6c3","name":"Get synonyms","request":{"name":"Get synonyms","description":{"content":"Retrieve a list of synonyms.\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User\n\n**API key permission required:** `SYNONYMS_SEARCH_READ`\n\n**User role permission required:** `assets_search: read`\n","type":"text/plain"},"url":{"path":["search","v2","indices",":indexId","synonyms"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"page","value":"4","description":"Page number to return for pagination. The first page has the index `1`."},{"disabled":false,"key":"limit","value":"100","description":"The number of items to return per page"},{"disabled":false,"key":"sortBy","value":"string","description":"Name of the attribute by which the data will be sorted and ordered by. Supported values: `indexId`, `updatedAt`, `createdAt`, `confidence`, `type`. Defaults to `updatedAt`."},{"disabled":false,"key":"ordering","value":"desc","description":"Sorting order. Deprecated: append the direction to `sortBy` instead, e.g. `sortBy=createdAt:desc`."},{"disabled":false,"key":"includeMeta","value":"false","description":"\nWhen `true`, pagination metadata is included in the response body.\n\nWhen `false`, the data is included in the response headers:\n\n- Link: links to neighbors, first, and last pages in pagination.\n\n- X-Pagination-Total-Count: total number of items on all pages\n\n- X-Pagination-Total-Pages: total number of pages\n\n- X-Pagination-Page: current page\n\n- X-Pagination-Limit: maximum number of items on a page\n\n- X-Pagination-Sorted-By: parameter that the items were sorted by\n\n- X-Pagination-Ordering: sorting direction\n"},{"disabled":false,"key":"directoryId","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","description":"Return only synonyms attached to this directory. Pass the Default directory id (00000000-0000-0000-0000-000000000000) to get the synonyms attached to no directory."},{"disabled":false,"key":"source","value":"User","description":"Filter synonyms by source"},{"disabled":false,"key":"state","value":"Accepted","description":"Filter synonyms by state"},{"disabled":false,"key":"type","value":"oneway","description":"Filter synonyms by type"},{"disabled":false,"key":"search","value":"string","description":"Search synonyms by word or synonym phrase (case-insensitive partial match)"},{"disabled":false,"key":"confidence","value":"0.9987468404951614","description":"Filter synonyms with confidence greater than or equal to this value"}],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"indexId","description":"(Required) Index identifier"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"72272f0c-701c-4802-9746-51b6be49d0ac","name":"List of synonyms returned","originalRequest":{"url":{"path":["search","v2","indices",":indexId","synonyms"],"host":["{{baseUrl}}"],"query":[{"key":"page","value":"4"},{"key":"limit","value":"100"},{"key":"sortBy","value":"string"},{"key":"ordering","value":"desc"},{"key":"includeMeta","value":"false"},{"key":"directoryId","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750"},{"key":"source","value":"User"},{"key":"state","value":"Accepted"},{"key":"type","value":"oneway"},{"key":"search","value":"string"},{"key":"confidence","value":"0.9987468404951614"}],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"indexId","description":"(Required) Index identifier"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"data\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"meta\": {\n \"totalPages\": {\n \"value\": \"\"\n },\n \"totalCount\": {\n \"value\": \"\"\n },\n \"page\": {\n \"value\": \"\"\n },\n \"limit\": {\n \"value\": \"\"\n },\n \"sortedBy\": {\n \"value\": \"\"\n },\n \"ordering\": {\n \"value\": \"\"\n },\n \"code\": {\n \"value\": \"\"\n },\n \"link\": {\n \"value\": \"\"\n }\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"1509941f-d53d-44d8-b652-a2d3270bbc9f","name":"Some error occurred","originalRequest":{"url":{"path":["search","v2","indices",":indexId","synonyms"],"host":["{{baseUrl}}"],"query":[{"key":"page","value":"4"},{"key":"limit","value":"100"},{"key":"sortBy","value":"string"},{"key":"ordering","value":"desc"},{"key":"includeMeta","value":"false"},{"key":"directoryId","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750"},{"key":"source","value":"User"},{"key":"state","value":"Accepted"},{"key":"type","value":"oneway"},{"key":"search","value":"string"},{"key":"confidence","value":"0.9987468404951614"}],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"indexId","description":"(Required) Index identifier"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1963-08-12T14:54:43.321Z\",\n \"status\": 2878,\n \"message\": \"string\",\n \"error\": \"string\",\n \"path\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"89693fc3-a401-448d-b109-de09e632b462","name":"Create synonym","request":{"name":"Create synonym","description":{"content":"Creates a new synonym.\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User\n\n**API key permission required:** `SYNONYMS_SEARCH_CREATE`\n\n**User role permission required:** `assets_search: create`\n","type":"text/plain"},"url":{"path":["search","v2","indices",":indexId","synonyms"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"indexId","description":"(Required) Index identifier"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"synonyms\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"type\": \"oneway\",\n \"word\": \"string\",\n \"confidence\": 0.3574228364947538,\n \"reason\": \"string\",\n \"source\": \"User\",\n \"state\": \"Accepted\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"6bc24928-53c0-4de1-8097-c70ff2a50c7b","name":"Id of created synonym returned","originalRequest":{"url":{"path":["search","v2","indices",":indexId","synonyms"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"indexId","description":"(Required) Index identifier"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"synonyms\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"type\": \"oneway\",\n \"word\": \"string\",\n \"confidence\": 0.9636511399950108,\n \"reason\": \"string\",\n \"source\": \"User\",\n \"state\": \"Accepted\"\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"id\": 1760,\n \"type\": \"oneway\",\n \"word\": \"string\",\n \"synonyms\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"createdAt\": \"string\",\n \"updatedAt\": \"string\",\n \"confidence\": 0.7165364296642524,\n \"reason\": \"string\",\n \"source\": \"User\",\n \"state\": \"Accepted\",\n \"directoryId\": \"9ae86bb1-4d66-6b55-f09a-78e26b4d4839\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"1abaeb75-d83b-4e9a-818c-358896d704a3","name":"Some error occurred","originalRequest":{"url":{"path":["search","v2","indices",":indexId","synonyms"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"indexId","description":"(Required) Index identifier"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"synonyms\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"type\": \"oneway\",\n \"word\": \"string\",\n \"confidence\": 0.9636511399950108,\n \"reason\": \"string\",\n \"source\": \"User\",\n \"state\": \"Accepted\"\n}","options":{"raw":{"language":"json"}}}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1963-08-12T14:54:43.321Z\",\n \"status\": 2878,\n \"message\": \"string\",\n \"error\": \"string\",\n \"path\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"6372f3a3-1a3a-4f2e-a6dc-cbb142555534","name":"Batch insert synonyms","request":{"name":"Batch insert synonyms","description":{"content":"Insert multiple synonyms into an index at once.\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User\n\n**API key permission required:** `SYNONYMS_SEARCH_CREATE`\n\n**User role permission required:** `assets_search: create`\n","type":"text/plain"},"url":{"path":["search","v2","indices",":indexId","synonyms","batch"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"source","value":"User","description":"Source to assign to imported synonyms"}],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"indexId","description":"(Required) Index identifier"}]},"header":[{"key":"Content-Type","value":"multipart/form-data"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"formdata","formdata":[{"key":"synonyms","type":"file","description":"Uploaded CSV file to be used in synonyms update"}]}},"response":[{"id":"fef61f19-4e8e-434d-9ff0-1aeb9a9162d7","name":"Summary of batch insertion","originalRequest":{"url":{"path":["search","v2","indices",":indexId","synonyms","batch"],"host":["{{baseUrl}}"],"query":[{"key":"source","value":"User"}],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"indexId","description":"(Required) Index identifier"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"attemptedInserts\": 5386,\n \"actualInserts\": 6666,\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"0b0ed18b-553a-454b-8c83-75a0ae775f71","name":"Some error occurred","originalRequest":{"url":{"path":["search","v2","indices",":indexId","synonyms","batch"],"host":["{{baseUrl}}"],"query":[{"key":"source","value":"User"}],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"indexId","description":"(Required) Index identifier"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1963-08-12T14:54:43.321Z\",\n \"status\": 2878,\n \"message\": \"string\",\n \"error\": \"string\",\n \"path\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"07ffeb8b-d676-4972-9e0c-8ea1d3bf91fb","name":"Replace all synonyms","request":{"name":"Replace all synonyms","description":{"content":"Deletes all existing synonyms from an index and then inserts multiple new synonyms at once.\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User\n\n**API key permission required:** `SYNONYMS_SEARCH_UPDATE`\n\n**User role permission required:** `assets_search: update`\n","type":"text/plain"},"url":{"path":["search","v2","indices",":indexId","synonyms","replace-all"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"source","value":"User","description":"Source to assign to imported synonyms"}],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"indexId","description":"(Required) Index identifier"}]},"header":[{"key":"Content-Type","value":"multipart/form-data"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"formdata","formdata":[{"key":"synonyms","type":"file","description":"Uploaded CSV file to be used in synonyms update"}]}},"response":[{"id":"d2a8b2e3-d21c-4989-8f3e-235ebfdc89c9","name":"All synonyms replaced","originalRequest":{"url":{"path":["search","v2","indices",":indexId","synonyms","replace-all"],"host":["{{baseUrl}}"],"query":[{"key":"source","value":"User"}],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"indexId","description":"(Required) Index identifier"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"POST","body":{}},"status":"No Content","code":204,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"ecac61ee-deda-43fc-b365-14cae17434b4","name":"Some error occurred","originalRequest":{"url":{"path":["search","v2","indices",":indexId","synonyms","replace-all"],"host":["{{baseUrl}}"],"query":[{"key":"source","value":"User"}],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"indexId","description":"(Required) Index identifier"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1963-08-12T14:54:43.321Z\",\n \"status\": 2878,\n \"message\": \"string\",\n \"error\": \"string\",\n \"path\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"cb51f6da-f66d-4122-95b5-bc462afece82","name":"Get synonym","request":{"name":"Get synonym","description":{"content":"Retrieves a synonym.\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User\n\n**API key permission required:** `SYNONYMS_SEARCH_READ`\n\n**User role permission required:** `assets_search: read`\n","type":"text/plain"},"url":{"path":["search","v2","indices",":indexId","synonyms",":synonymId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"5612","key":"synonymId","description":"(Required) Synonym identifier"},{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"indexId","description":"(Required) Index identifier"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"7829d059-9e88-44fa-a85d-48f29d39e6e7","name":"Synonym returned.","originalRequest":{"url":{"path":["search","v2","indices",":indexId","synonyms",":synonymId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"5612","key":"synonymId","description":"(Required) Synonym identifier"},{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"indexId","description":"(Required) Index identifier"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"id\": 1760,\n \"type\": \"oneway\",\n \"word\": \"string\",\n \"synonyms\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"createdAt\": \"string\",\n \"updatedAt\": \"string\",\n \"confidence\": 0.7165364296642524,\n \"reason\": \"string\",\n \"source\": \"User\",\n \"state\": \"Accepted\",\n \"directoryId\": \"9ae86bb1-4d66-6b55-f09a-78e26b4d4839\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"114ede99-6b6c-42be-ac0c-51ed9eea313d","name":"Some error occurred","originalRequest":{"url":{"path":["search","v2","indices",":indexId","synonyms",":synonymId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"5612","key":"synonymId","description":"(Required) Synonym identifier"},{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"indexId","description":"(Required) Index identifier"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1963-08-12T14:54:43.321Z\",\n \"status\": 2878,\n \"message\": \"string\",\n \"error\": \"string\",\n \"path\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"1b0c7052-116c-4930-9c47-c16f2ca31f07","name":"Update synonym","request":{"name":"Update synonym","description":{"content":"Updates a synonym identified by `id`.\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User\n\n**API key permission required:** `SYNONYMS_SEARCH_UPDATE`\n\n**User role permission required:** `assets_search: update`\n","type":"text/plain"},"url":{"path":["search","v2","indices",":indexId","synonyms",":synonymId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"5612","key":"synonymId","description":"(Required) Synonym identifier"},{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"indexId","description":"(Required) Index identifier"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PUT","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"synonyms\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"type\": \"oneway\",\n \"word\": \"string\",\n \"confidence\": 0.9636511399950108,\n \"reason\": \"string\",\n \"source\": \"User\",\n \"state\": \"Accepted\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"07560828-18af-4bfb-829c-9b8a4e1f6816","name":"Updated synonym returned.","originalRequest":{"url":{"path":["search","v2","indices",":indexId","synonyms",":synonymId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"5612","key":"synonymId","description":"(Required) Synonym identifier"},{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"indexId","description":"(Required) Index identifier"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"{\n \"synonyms\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"type\": \"oneway\",\n \"word\": \"string\",\n \"confidence\": 0.9636511399950108,\n \"reason\": \"string\",\n \"source\": \"User\",\n \"state\": \"Accepted\"\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"id\": 1760,\n \"type\": \"oneway\",\n \"word\": \"string\",\n \"synonyms\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"createdAt\": \"string\",\n \"updatedAt\": \"string\",\n \"confidence\": 0.7165364296642524,\n \"reason\": \"string\",\n \"source\": \"User\",\n \"state\": \"Accepted\",\n \"directoryId\": \"9ae86bb1-4d66-6b55-f09a-78e26b4d4839\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"18c32b14-85e6-4754-bb3b-24f33feaa2ba","name":"Some error occurred","originalRequest":{"url":{"path":["search","v2","indices",":indexId","synonyms",":synonymId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"5612","key":"synonymId","description":"(Required) Synonym identifier"},{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"indexId","description":"(Required) Index identifier"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"{\n \"synonyms\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"type\": \"oneway\",\n \"word\": \"string\",\n \"confidence\": 0.9636511399950108,\n \"reason\": \"string\",\n \"source\": \"User\",\n \"state\": \"Accepted\"\n}","options":{"raw":{"language":"json"}}}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1963-08-12T14:54:43.321Z\",\n \"status\": 2878,\n \"message\": \"string\",\n \"error\": \"string\",\n \"path\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"c1cb2b3b-ba4a-4c81-8dca-d68cf5f4821e","name":"Delete synonym","request":{"name":"Delete synonym","description":{"content":"Deletes a synonym with given id.\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User\n\n**API key permission required:** `SYNONYMS_SEARCH_DELETE`\n\n**User role permission required:** `assets_search: delete`\n","type":"text/plain"},"url":{"path":["search","v2","indices",":indexId","synonyms",":synonymId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"5612","key":"synonymId","description":"(Required) Synonym identifier"},{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"indexId","description":"(Required) Index identifier"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"8e075605-ac35-4761-aadb-11d86eed487c","name":"Synonym deleted","originalRequest":{"url":{"path":["search","v2","indices",":indexId","synonyms",":synonymId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"5612","key":"synonymId","description":"(Required) Synonym identifier"},{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"indexId","description":"(Required) Index identifier"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"DELETE","body":{}},"status":"No Content","code":204,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"e7b91326-5856-41cc-afd7-c5b72fa8bc40","name":"Some error occurred","originalRequest":{"url":{"path":["search","v2","indices",":indexId","synonyms",":synonymId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"5612","key":"synonymId","description":"(Required) Synonym identifier"},{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"indexId","description":"(Required) Index identifier"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1963-08-12T14:54:43.321Z\",\n \"status\": 2878,\n \"message\": \"string\",\n \"error\": \"string\",\n \"path\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}],"event":[]},{"id":"0844a631-e1f6-45be-858b-42f18895a768","name":"Search Configuration","description":{"content":"","type":"text/plain"},"item":[{"id":"93c45612-a9f6-4fe0-bb7f-76aa1661cef0","name":"Get values of filterable attributes","request":{"name":"Get values of filterable attributes","description":{"content":"Retrieve values of filterable attributes.\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User\n\n**API key permission required:** `ITEMS_SEARCH_SEARCH_READ`\n\n**User role permission required:** `assets_search: read`\n","type":"text/plain"},"url":{"path":["search","v2","indices",":indexId","attributes","filterable","values"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"attribute","value":"string","description":"(Required) List of attributes for which values will be fetched"},{"disabled":false,"key":"attribute","value":"string","description":"(Required) List of attributes for which values will be fetched"}],"variable":[{"disabled":false,"type":"any","value":"string","key":"indexId","description":"(Required) ID of the index to be used in the search operation"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"08b4a0a7-cd9a-471d-81c4-4a104dc678b8","name":"Values returned","originalRequest":{"url":{"path":["search","v2","indices",":indexId","attributes","filterable","values"],"host":["{{baseUrl}}"],"query":[{"key":"attribute","value":"string"},{"key":"attribute","value":"string"}],"variable":[{"disabled":false,"type":"any","value":"string","key":"indexId","description":"(Required) ID of the index to be used in the search operation"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"key_0\": [\n \"string\",\n \"string\"\n ],\n \"key_1\": [\n \"string\",\n \"string\"\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"5197c2db-6aca-4505-a856-252d01c77969","name":"Service not available","originalRequest":{"url":{"path":["search","v2","indices",":indexId","attributes","filterable","values"],"host":["{{baseUrl}}"],"query":[{"key":"attribute","value":"string"},{"key":"attribute","value":"string"}],"variable":[{"disabled":false,"type":"any","value":"string","key":"indexId","description":"(Required) ID of the index to be used in the search operation"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1963-08-12T14:54:43.321Z\",\n \"status\": 2878,\n \"message\": \"string\",\n \"error\": \"string\",\n \"path\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"a7ea3aee-91b9-4d4f-b0c5-9d65d0078154","name":"Get configurations of all indices","request":{"name":"Get configurations of all indices","description":{"content":"Retrieve the configurations of all indices.\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User\n\n**API key permission required:** `ITEMS_SEARCH_CONFIG_SEARCH_READ`\n\n**User role permission required:** `assets_search: read`\n","type":"text/plain"},"url":{"path":["search","v2","indices"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"page","value":"4","description":"Page number to return for pagination. The first page has the index `1`."},{"disabled":false,"key":"limit","value":"100","description":"The number of items to return per page"},{"disabled":false,"key":"sortBy","value":"createdAt:desc","description":"Name of the attribute by which the data will be sorted, optionally with the sorting direction\nappended after a colon - `sortBy=createdAt:desc`. A direction given this way takes precedence\nover the `ordering` parameter.\n"},{"disabled":false,"key":"ordering","value":"desc","description":"Sorting order"},{"disabled":false,"key":"includeMeta","value":"false","description":"\nWhen `true`, pagination metadata is included in the response body.\n\nWhen `false`, the data is included in the response headers:\n\n- Link: links to neighbors, first, and last pages in pagination.\n\n- X-Pagination-Total-Count: total number of items on all pages\n\n- X-Pagination-Total-Pages: total number of pages\n\n- X-Pagination-Page: current page\n\n- X-Pagination-Limit: maximum number of items on a page\n\n- X-Pagination-Sorted-By: parameter that the items were sorted by\n\n- X-Pagination-Ordering: sorting direction\n"},{"disabled":false,"key":"name","value":"string","description":"Deprecated parameter. If `search` or `query` is provided, this parameter is ignored.\nIf an index has an `id` equal to the value of this parameter, only that index will be retrieved. Otherwise, all indices containing this value in their `name` will be retrieved.\n"},{"disabled":false,"key":"query","value":"string","description":"Deprecated parameter. If `search` is provided, this parameter is ignored.\nIf an index has an `id` equal to the value of this parameter, only that index will be retrieved. Otherwise, all indices containing this value in their `name` will be retrieved.\n"},{"disabled":false,"key":"search","value":"string","description":"If an index has an `id` equal to the value of this parameter, only that index will be retrieved. Otherwise, all indices containing this value in their `name` will be retrieved. This parameter replaces the deprecated `query` and `name` parameters."},{"disabled":false,"key":"excludeAbTests","value":"true","description":"Only indices not involved in currently running AB tests will be retrieved."},{"disabled":false,"key":"directoryId","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","description":"Requested directoryId of the rule."},{"disabled":false,"key":"type","value":"Semantic","description":"Requested type of the rule."}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"8d124697-9d15-4ea8-a5c5-a72092d704f6","name":"Configurations returned","originalRequest":{"url":{"path":["search","v2","indices"],"host":["{{baseUrl}}"],"query":[{"key":"page","value":"4"},{"key":"limit","value":"100"},{"key":"sortBy","value":"createdAt:desc"},{"key":"ordering","value":"desc"},{"key":"includeMeta","value":"false"},{"key":"name","value":"string"},{"key":"query","value":"string"},{"key":"search","value":"string"},{"key":"excludeAbTests","value":"true"},{"key":"directoryId","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750"},{"key":"type","value":"Semantic"}],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"data\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"meta\": {\n \"totalPages\": {\n \"value\": \"\"\n },\n \"totalCount\": {\n \"value\": \"\"\n },\n \"page\": {\n \"value\": \"\"\n },\n \"limit\": {\n \"value\": \"\"\n },\n \"sortedBy\": {\n \"value\": \"\"\n },\n \"ordering\": {\n \"value\": \"\"\n },\n \"code\": {\n \"value\": \"\"\n },\n \"link\": {\n \"value\": \"\"\n }\n },\n \"extras\": {\n \"indexLimit\": {\n \"value\": \"\"\n },\n \"indexLimitReached\": {\n \"value\": \"\"\n }\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"9672c6e0-d221-4d6a-ba20-89975ea13354","name":"Service not available","originalRequest":{"url":{"path":["search","v2","indices"],"host":["{{baseUrl}}"],"query":[{"key":"page","value":"4"},{"key":"limit","value":"100"},{"key":"sortBy","value":"createdAt:desc"},{"key":"ordering","value":"desc"},{"key":"includeMeta","value":"false"},{"key":"name","value":"string"},{"key":"query","value":"string"},{"key":"search","value":"string"},{"key":"excludeAbTests","value":"true"},{"key":"directoryId","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750"},{"key":"type","value":"Semantic"}],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1963-08-12T14:54:43.321Z\",\n \"status\": 2878,\n \"message\": \"string\",\n \"error\": \"string\",\n \"path\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"9757eb5f-5947-4f17-bd00-0e3991767d48","name":"Post index configuration","request":{"name":"Post index configuration","description":{"content":"Creates a new configuration of a single index.\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User\n\n**API key permission required:** `ITEMS_SEARCH_CONFIG_SEARCH_CREATE`\n\n**User role permission required:** `assets_search: create`\n","type":"text/plain"},"url":{"path":["search","v2","indices"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"indexName\": \"string\",\n \"itemsCatalogId\": \"string\",\n \"language\": \"string\",\n \"enabled\": true,\n \"description\": \"string\",\n \"ignoreUnavailableItems\": true,\n \"scoring\": {\n \"pageVisitsPopularity\": {\n \"value\": \"\"\n },\n \"transactionsPopularity\": {\n \"value\": \"\"\n },\n \"personalized\": {\n \"value\": \"\"\n },\n \"personalizationWeights\": {\n \"value\": \"\"\n },\n \"tieBreaker\": {\n \"value\": \"\"\n },\n \"matching\": {\n \"value\": \"\"\n },\n \"fallbackMatching\": {\n \"value\": \"\"\n },\n \"similarity\": {\n \"value\": \"\"\n },\n \"crossWorkspaceMode\": {\n \"value\": \"\"\n },\n \"textScoring\": {\n \"value\": \"\"\n }\n },\n \"suggestions\": {\n \"smoothingModel\": {\n \"value\": \"\"\n },\n \"gramSize\": {\n \"value\": \"\"\n },\n \"maxErrors\": {\n \"value\": \"\"\n },\n \"minWordLength\": {\n \"value\": \"\"\n },\n \"useAlways\": {\n \"value\": \"\"\n }\n },\n \"tokenizer\": {\n \"value\": \"\"\n },\n \"analyzers\": {\n \"autocomplete\": {\n \"value\": \"\"\n },\n \"stopwords\": {\n \"value\": \"\"\n }\n },\n \"attributesWithoutPrefixSearch\": [\n \"brand\",\n \"color\",\n \"promotion.type\"\n ],\n \"attributesWithoutTypoTolerance\": [\n \"itemId\",\n \"link\"\n ],\n \"valuesWithoutTypoTolerance\": [\n \"Nike\",\n \"blue\",\n \"74997\"\n ],\n \"typoToleranceOnNumericValues\": true,\n \"searchableAttributes\": {\n \"fullText\": {\n \"value\": \"\"\n },\n \"fullTextBoosted\": {\n \"value\": \"\"\n },\n \"fullTextStronglyBoosted\": {\n \"value\": \"\"\n }\n },\n \"displayableAttributes\": [\n \"brand\",\n \"color\",\n \"promotion.type\"\n ],\n \"facetableAttributes\": {\n \"range\": {\n \"value\": \"\"\n },\n \"text\": {\n \"value\": \"\"\n },\n \"datetime\": {\n \"value\": \"\"\n }\n },\n \"filterableAttributes\": {\n \"range\": {\n \"value\": \"\"\n },\n \"text\": {\n \"value\": \"\"\n },\n \"datetime\": {\n \"value\": \"\"\n }\n },\n \"sortableAttributes\": {\n \"range\": {\n \"value\": \"\"\n },\n \"text\": {\n \"value\": \"\"\n },\n \"datetime\": {\n \"value\": \"\"\n }\n },\n \"distinctFilterAttributes\": {\n \"range\": {\n \"value\": \"\"\n },\n \"text\": {\n \"value\": \"\"\n },\n \"datetime\": {\n \"value\": \"\"\n }\n },\n \"recentSearches\": {\n \"windowSize\": {\n \"value\": \"\"\n },\n \"timeSpan\": {\n \"value\": \"\"\n }\n },\n \"reranking\": {\n \"dynamicReranker\": {\n \"value\": \"\"\n },\n \"queryClassification\": {\n \"value\": \"\"\n }\n },\n \"optimization\": {\n \"enabled\": {\n \"value\": \"\"\n },\n \"target\": {\n \"value\": \"\"\n },\n \"optimizedWeights\": {\n \"value\": \"\"\n }\n },\n \"geoSearch\": {\n \"geoSearchableAttribute\": {\n \"value\": \"\"\n }\n },\n \"queryRules\": {\n \"consequencesJoinOperators\": {\n \"value\": \"\"\n }\n },\n \"indexType\": \"Document\",\n \"chunking\": {\n \"strategy\": {\n \"value\": \"\"\n },\n \"tokenLimit\": {\n \"value\": \"\"\n },\n \"passageTokenLimit\": {\n \"value\": \"\"\n },\n \"prependHeadingPath\": {\n \"value\": \"\"\n },\n \"overlapTokens\": {\n \"value\": \"\"\n },\n \"minChunkTokens\": {\n \"value\": \"\"\n }\n },\n \"documentFields\": {\n \"contentField\": {\n \"value\": \"\"\n },\n \"titleField\": {\n \"value\": \"\"\n },\n \"contentFormat\": {\n \"value\": \"\"\n },\n \"metadataFields\": {\n \"value\": \"\"\n }\n }\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"ada7b72b-3288-4d77-b523-789381d179be","name":"Returned created configuration","originalRequest":{"url":{"path":["search","v2","indices"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"indexName\": \"string\",\n \"itemsCatalogId\": \"string\",\n \"language\": \"string\",\n \"enabled\": true,\n \"description\": \"string\",\n \"ignoreUnavailableItems\": true,\n \"scoring\": {\n \"pageVisitsPopularity\": {\n \"value\": \"\"\n },\n \"transactionsPopularity\": {\n \"value\": \"\"\n },\n \"personalized\": {\n \"value\": \"\"\n },\n \"personalizationWeights\": {\n \"value\": \"\"\n },\n \"tieBreaker\": {\n \"value\": \"\"\n },\n \"matching\": {\n \"value\": \"\"\n },\n \"fallbackMatching\": {\n \"value\": \"\"\n },\n \"similarity\": {\n \"value\": \"\"\n },\n \"crossWorkspaceMode\": {\n \"value\": \"\"\n },\n \"textScoring\": {\n \"value\": \"\"\n }\n },\n \"suggestions\": {\n \"smoothingModel\": {\n \"value\": \"\"\n },\n \"gramSize\": {\n \"value\": \"\"\n },\n \"maxErrors\": {\n \"value\": \"\"\n },\n \"minWordLength\": {\n \"value\": \"\"\n },\n \"useAlways\": {\n \"value\": \"\"\n }\n },\n \"tokenizer\": {\n \"value\": \"\"\n },\n \"analyzers\": {\n \"autocomplete\": {\n \"value\": \"\"\n },\n \"stopwords\": {\n \"value\": \"\"\n }\n },\n \"attributesWithoutPrefixSearch\": [\n \"brand\",\n \"color\",\n \"promotion.type\"\n ],\n \"attributesWithoutTypoTolerance\": [\n \"itemId\",\n \"link\"\n ],\n \"valuesWithoutTypoTolerance\": [\n \"Nike\",\n \"blue\",\n \"74997\"\n ],\n \"typoToleranceOnNumericValues\": true,\n \"searchableAttributes\": {\n \"fullText\": {\n \"value\": \"\"\n },\n \"fullTextBoosted\": {\n \"value\": \"\"\n },\n \"fullTextStronglyBoosted\": {\n \"value\": \"\"\n }\n },\n \"displayableAttributes\": [\n \"brand\",\n \"color\",\n \"promotion.type\"\n ],\n \"facetableAttributes\": {\n \"range\": {\n \"value\": \"\"\n },\n \"text\": {\n \"value\": \"\"\n },\n \"datetime\": {\n \"value\": \"\"\n }\n },\n \"filterableAttributes\": {\n \"range\": {\n \"value\": \"\"\n },\n \"text\": {\n \"value\": \"\"\n },\n \"datetime\": {\n \"value\": \"\"\n }\n },\n \"sortableAttributes\": {\n \"range\": {\n \"value\": \"\"\n },\n \"text\": {\n \"value\": \"\"\n },\n \"datetime\": {\n \"value\": \"\"\n }\n },\n \"distinctFilterAttributes\": {\n \"range\": {\n \"value\": \"\"\n },\n \"text\": {\n \"value\": \"\"\n },\n \"datetime\": {\n \"value\": \"\"\n }\n },\n \"recentSearches\": {\n \"windowSize\": {\n \"value\": \"\"\n },\n \"timeSpan\": {\n \"value\": \"\"\n }\n },\n \"reranking\": {\n \"dynamicReranker\": {\n \"value\": \"\"\n },\n \"queryClassification\": {\n \"value\": \"\"\n }\n },\n \"optimization\": {\n \"enabled\": {\n \"value\": \"\"\n },\n \"target\": {\n \"value\": \"\"\n },\n \"optimizedWeights\": {\n \"value\": \"\"\n }\n },\n \"geoSearch\": {\n \"geoSearchableAttribute\": {\n \"value\": \"\"\n }\n },\n \"queryRules\": {\n \"consequencesJoinOperators\": {\n \"value\": \"\"\n }\n },\n \"indexType\": \"Product\",\n \"chunking\": {\n \"strategy\": {\n \"value\": \"\"\n },\n \"tokenLimit\": {\n \"value\": \"\"\n },\n \"passageTokenLimit\": {\n \"value\": \"\"\n },\n \"prependHeadingPath\": {\n \"value\": \"\"\n },\n \"overlapTokens\": {\n \"value\": \"\"\n },\n \"minChunkTokens\": {\n \"value\": \"\"\n }\n },\n \"documentFields\": {\n \"contentField\": {\n \"value\": \"\"\n },\n \"titleField\": {\n \"value\": \"\"\n },\n \"contentFormat\": {\n \"value\": \"\"\n },\n \"metadataFields\": {\n \"value\": \"\"\n }\n }\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"indexId\": \"string\",\n \"indexName\": \"string\",\n \"description\": \"string\",\n \"itemsCatalogId\": \"string\",\n \"language\": \"string\",\n \"enabled\": true,\n \"disabledReason\": \"Manual\",\n \"ignoreUnavailableItems\": true,\n \"scoring\": {\n \"pageVisitsPopularity\": {\n \"value\": \"\"\n },\n \"transactionsPopularity\": {\n \"value\": \"\"\n },\n \"personalized\": {\n \"value\": \"\"\n },\n \"personalizationWeights\": {\n \"value\": \"\"\n },\n \"tieBreaker\": {\n \"value\": \"\"\n },\n \"matching\": {\n \"value\": \"\"\n },\n \"fallbackMatching\": {\n \"value\": \"\"\n },\n \"similarity\": {\n \"value\": \"\"\n },\n \"crossWorkspaceMode\": {\n \"value\": \"\"\n },\n \"textScoring\": {\n \"value\": \"\"\n }\n },\n \"suggestions\": {\n \"smoothingModel\": {\n \"value\": \"\"\n },\n \"gramSize\": {\n \"value\": \"\"\n },\n \"maxErrors\": {\n \"value\": \"\"\n },\n \"minWordLength\": {\n \"value\": \"\"\n },\n \"useAlways\": {\n \"value\": \"\"\n }\n },\n \"tokenizer\": {\n \"value\": \"\"\n },\n \"analyzers\": {\n \"autocomplete\": {\n \"value\": \"\"\n },\n \"stopwords\": {\n \"value\": \"\"\n }\n },\n \"attributesWithoutPrefixSearch\": [\n \"brand\",\n \"color\",\n \"promotion.type\"\n ],\n \"attributesWithoutTypoTolerance\": [\n \"itemId\",\n \"link\"\n ],\n \"valuesWithoutTypoTolerance\": [\n \"Nike\",\n \"blue\",\n \"74997\"\n ],\n \"typoToleranceOnNumericValues\": true,\n \"searchableAttributes\": {\n \"fullText\": {\n \"value\": \"\"\n },\n \"fullTextBoosted\": {\n \"value\": \"\"\n },\n \"fullTextStronglyBoosted\": {\n \"value\": \"\"\n }\n },\n \"displayableAttributes\": [\n \"brand\",\n \"color\",\n \"promotion.type\"\n ],\n \"facetableAttributes\": {\n \"range\": {\n \"value\": \"\"\n },\n \"text\": {\n \"value\": \"\"\n },\n \"datetime\": {\n \"value\": \"\"\n }\n },\n \"filterableAttributes\": {\n \"range\": {\n \"value\": \"\"\n },\n \"text\": {\n \"value\": \"\"\n },\n \"datetime\": {\n \"value\": \"\"\n }\n },\n \"sortableAttributes\": {\n \"range\": {\n \"value\": \"\"\n },\n \"text\": {\n \"value\": \"\"\n },\n \"datetime\": {\n \"value\": \"\"\n }\n },\n \"distinctFilterAttributes\": {\n \"range\": {\n \"value\": \"\"\n },\n \"text\": {\n \"value\": \"\"\n },\n \"datetime\": {\n \"value\": \"\"\n }\n },\n \"recentSearches\": {\n \"windowSize\": {\n \"value\": \"\"\n },\n \"timeSpan\": {\n \"value\": \"\"\n }\n },\n \"reranking\": {\n \"dynamicReranker\": {\n \"value\": \"\"\n },\n \"queryClassification\": {\n \"value\": \"\"\n }\n },\n \"optimization\": {\n \"enabled\": {\n \"value\": \"\"\n },\n \"target\": {\n \"value\": \"\"\n },\n \"optimizedWeights\": {\n \"value\": \"\"\n }\n },\n \"dynamicSynonyms\": {\n \"enabled\": {\n \"value\": \"\"\n },\n \"workflowIntervalDays\": {\n \"value\": \"\"\n },\n \"coldStart\": {\n \"value\": \"\"\n },\n \"autoAcceptThreshold\": {\n \"value\": \"\"\n }\n },\n \"dynamicFacets\": {\n \"enabled\": {\n \"value\": \"\"\n },\n \"maxFacets\": {\n \"value\": \"\"\n },\n \"minCoverageThreshold\": {\n \"value\": \"\"\n },\n \"objective\": {\n \"value\": \"\"\n }\n },\n \"geoSearch\": {\n \"geoSearchableAttribute\": {\n \"value\": \"\"\n }\n },\n \"queryRules\": {\n \"consequencesJoinOperators\": {\n \"value\": \"\"\n }\n },\n \"updatedAt\": \"2009-08-09T16:24:20.627Z\",\n \"createdAt\": \"1975-08-07T00:03:36.251Z\",\n \"indexType\": \"Document\",\n \"chunking\": {\n \"strategy\": {\n \"value\": \"\"\n },\n \"tokenLimit\": {\n \"value\": \"\"\n },\n \"passageTokenLimit\": {\n \"value\": \"\"\n },\n \"prependHeadingPath\": {\n \"value\": \"\"\n },\n \"overlapTokens\": {\n \"value\": \"\"\n },\n \"minChunkTokens\": {\n \"value\": \"\"\n }\n },\n \"documentFields\": {\n \"contentField\": {\n \"value\": \"\"\n },\n \"titleField\": {\n \"value\": \"\"\n },\n \"contentFormat\": {\n \"value\": \"\"\n },\n \"metadataFields\": {\n \"value\": \"\"\n }\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"7f97f912-6fc3-40f2-90f0-4c0aa13e533c","name":"Service not available","originalRequest":{"url":{"path":["search","v2","indices"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"indexName\": \"string\",\n \"itemsCatalogId\": \"string\",\n \"language\": \"string\",\n \"enabled\": true,\n \"description\": \"string\",\n \"ignoreUnavailableItems\": true,\n \"scoring\": {\n \"pageVisitsPopularity\": {\n \"value\": \"\"\n },\n \"transactionsPopularity\": {\n \"value\": \"\"\n },\n \"personalized\": {\n \"value\": \"\"\n },\n \"personalizationWeights\": {\n \"value\": \"\"\n },\n \"tieBreaker\": {\n \"value\": \"\"\n },\n \"matching\": {\n \"value\": \"\"\n },\n \"fallbackMatching\": {\n \"value\": \"\"\n },\n \"similarity\": {\n \"value\": \"\"\n },\n \"crossWorkspaceMode\": {\n \"value\": \"\"\n },\n \"textScoring\": {\n \"value\": \"\"\n }\n },\n \"suggestions\": {\n \"smoothingModel\": {\n \"value\": \"\"\n },\n \"gramSize\": {\n \"value\": \"\"\n },\n \"maxErrors\": {\n \"value\": \"\"\n },\n \"minWordLength\": {\n \"value\": \"\"\n },\n \"useAlways\": {\n \"value\": \"\"\n }\n },\n \"tokenizer\": {\n \"value\": \"\"\n },\n \"analyzers\": {\n \"autocomplete\": {\n \"value\": \"\"\n },\n \"stopwords\": {\n \"value\": \"\"\n }\n },\n \"attributesWithoutPrefixSearch\": [\n \"brand\",\n \"color\",\n \"promotion.type\"\n ],\n \"attributesWithoutTypoTolerance\": [\n \"itemId\",\n \"link\"\n ],\n \"valuesWithoutTypoTolerance\": [\n \"Nike\",\n \"blue\",\n \"74997\"\n ],\n \"typoToleranceOnNumericValues\": true,\n \"searchableAttributes\": {\n \"fullText\": {\n \"value\": \"\"\n },\n \"fullTextBoosted\": {\n \"value\": \"\"\n },\n \"fullTextStronglyBoosted\": {\n \"value\": \"\"\n }\n },\n \"displayableAttributes\": [\n \"brand\",\n \"color\",\n \"promotion.type\"\n ],\n \"facetableAttributes\": {\n \"range\": {\n \"value\": \"\"\n },\n \"text\": {\n \"value\": \"\"\n },\n \"datetime\": {\n \"value\": \"\"\n }\n },\n \"filterableAttributes\": {\n \"range\": {\n \"value\": \"\"\n },\n \"text\": {\n \"value\": \"\"\n },\n \"datetime\": {\n \"value\": \"\"\n }\n },\n \"sortableAttributes\": {\n \"range\": {\n \"value\": \"\"\n },\n \"text\": {\n \"value\": \"\"\n },\n \"datetime\": {\n \"value\": \"\"\n }\n },\n \"distinctFilterAttributes\": {\n \"range\": {\n \"value\": \"\"\n },\n \"text\": {\n \"value\": \"\"\n },\n \"datetime\": {\n \"value\": \"\"\n }\n },\n \"recentSearches\": {\n \"windowSize\": {\n \"value\": \"\"\n },\n \"timeSpan\": {\n \"value\": \"\"\n }\n },\n \"reranking\": {\n \"dynamicReranker\": {\n \"value\": \"\"\n },\n \"queryClassification\": {\n \"value\": \"\"\n }\n },\n \"optimization\": {\n \"enabled\": {\n \"value\": \"\"\n },\n \"target\": {\n \"value\": \"\"\n },\n \"optimizedWeights\": {\n \"value\": \"\"\n }\n },\n \"geoSearch\": {\n \"geoSearchableAttribute\": {\n \"value\": \"\"\n }\n },\n \"queryRules\": {\n \"consequencesJoinOperators\": {\n \"value\": \"\"\n }\n },\n \"indexType\": \"Product\",\n \"chunking\": {\n \"strategy\": {\n \"value\": \"\"\n },\n \"tokenLimit\": {\n \"value\": \"\"\n },\n \"passageTokenLimit\": {\n \"value\": \"\"\n },\n \"prependHeadingPath\": {\n \"value\": \"\"\n },\n \"overlapTokens\": {\n \"value\": \"\"\n },\n \"minChunkTokens\": {\n \"value\": \"\"\n }\n },\n \"documentFields\": {\n \"contentField\": {\n \"value\": \"\"\n },\n \"titleField\": {\n \"value\": \"\"\n },\n \"contentFormat\": {\n \"value\": \"\"\n },\n \"metadataFields\": {\n \"value\": \"\"\n }\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1963-08-12T14:54:43.321Z\",\n \"status\": 2878,\n \"message\": \"string\",\n \"error\": \"string\",\n \"path\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"3f031e0d-2e53-419f-be71-03eacec5c26f","name":"Get index configuration","request":{"name":"Get index configuration","description":{"content":"Retrieve the configuration of a single index.\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User\n\n**API key permission required:** `ITEMS_SEARCH_CONFIG_SEARCH_READ`\n\n**User role permission required:** `assets_search: read`\n","type":"text/plain"},"url":{"path":["search","v2","indices",":indexId","config"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"indexId","description":"(Required) ID of the index"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"57c2ea80-a739-40f9-a8b2-7133a6a336a4","name":"Configuration returned","originalRequest":{"url":{"path":["search","v2","indices",":indexId","config"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"indexId","description":"(Required) ID of the index"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"indexId\": \"string\",\n \"indexName\": \"string\",\n \"description\": \"string\",\n \"itemsCatalogId\": \"string\",\n \"language\": \"string\",\n \"enabled\": true,\n \"disabledReason\": \"Manual\",\n \"ignoreUnavailableItems\": true,\n \"scoring\": {\n \"pageVisitsPopularity\": {\n \"value\": \"\"\n },\n \"transactionsPopularity\": {\n \"value\": \"\"\n },\n \"personalized\": {\n \"value\": \"\"\n },\n \"personalizationWeights\": {\n \"value\": \"\"\n },\n \"tieBreaker\": {\n \"value\": \"\"\n },\n \"matching\": {\n \"value\": \"\"\n },\n \"fallbackMatching\": {\n \"value\": \"\"\n },\n \"similarity\": {\n \"value\": \"\"\n },\n \"crossWorkspaceMode\": {\n \"value\": \"\"\n },\n \"textScoring\": {\n \"value\": \"\"\n }\n },\n \"suggestions\": {\n \"smoothingModel\": {\n \"value\": \"\"\n },\n \"gramSize\": {\n \"value\": \"\"\n },\n \"maxErrors\": {\n \"value\": \"\"\n },\n \"minWordLength\": {\n \"value\": \"\"\n },\n \"useAlways\": {\n \"value\": \"\"\n }\n },\n \"tokenizer\": {\n \"value\": \"\"\n },\n \"analyzers\": {\n \"autocomplete\": {\n \"value\": \"\"\n },\n \"stopwords\": {\n \"value\": \"\"\n }\n },\n \"attributesWithoutPrefixSearch\": [\n \"brand\",\n \"color\",\n \"promotion.type\"\n ],\n \"attributesWithoutTypoTolerance\": [\n \"itemId\",\n \"link\"\n ],\n \"valuesWithoutTypoTolerance\": [\n \"Nike\",\n \"blue\",\n \"74997\"\n ],\n \"typoToleranceOnNumericValues\": true,\n \"searchableAttributes\": {\n \"fullText\": {\n \"value\": \"\"\n },\n \"fullTextBoosted\": {\n \"value\": \"\"\n },\n \"fullTextStronglyBoosted\": {\n \"value\": \"\"\n }\n },\n \"displayableAttributes\": [\n \"brand\",\n \"color\",\n \"promotion.type\"\n ],\n \"facetableAttributes\": {\n \"range\": {\n \"value\": \"\"\n },\n \"text\": {\n \"value\": \"\"\n },\n \"datetime\": {\n \"value\": \"\"\n }\n },\n \"filterableAttributes\": {\n \"range\": {\n \"value\": \"\"\n },\n \"text\": {\n \"value\": \"\"\n },\n \"datetime\": {\n \"value\": \"\"\n }\n },\n \"sortableAttributes\": {\n \"range\": {\n \"value\": \"\"\n },\n \"text\": {\n \"value\": \"\"\n },\n \"datetime\": {\n \"value\": \"\"\n }\n },\n \"distinctFilterAttributes\": {\n \"range\": {\n \"value\": \"\"\n },\n \"text\": {\n \"value\": \"\"\n },\n \"datetime\": {\n \"value\": \"\"\n }\n },\n \"recentSearches\": {\n \"windowSize\": {\n \"value\": \"\"\n },\n \"timeSpan\": {\n \"value\": \"\"\n }\n },\n \"reranking\": {\n \"dynamicReranker\": {\n \"value\": \"\"\n },\n \"queryClassification\": {\n \"value\": \"\"\n }\n },\n \"optimization\": {\n \"enabled\": {\n \"value\": \"\"\n },\n \"target\": {\n \"value\": \"\"\n },\n \"optimizedWeights\": {\n \"value\": \"\"\n }\n },\n \"dynamicSynonyms\": {\n \"enabled\": {\n \"value\": \"\"\n },\n \"workflowIntervalDays\": {\n \"value\": \"\"\n },\n \"coldStart\": {\n \"value\": \"\"\n },\n \"autoAcceptThreshold\": {\n \"value\": \"\"\n }\n },\n \"dynamicFacets\": {\n \"enabled\": {\n \"value\": \"\"\n },\n \"maxFacets\": {\n \"value\": \"\"\n },\n \"minCoverageThreshold\": {\n \"value\": \"\"\n },\n \"objective\": {\n \"value\": \"\"\n }\n },\n \"geoSearch\": {\n \"geoSearchableAttribute\": {\n \"value\": \"\"\n }\n },\n \"queryRules\": {\n \"consequencesJoinOperators\": {\n \"value\": \"\"\n }\n },\n \"updatedAt\": \"2009-08-09T16:24:20.627Z\",\n \"createdAt\": \"1975-08-07T00:03:36.251Z\",\n \"indexType\": \"Document\",\n \"chunking\": {\n \"strategy\": {\n \"value\": \"\"\n },\n \"tokenLimit\": {\n \"value\": \"\"\n },\n \"passageTokenLimit\": {\n \"value\": \"\"\n },\n \"prependHeadingPath\": {\n \"value\": \"\"\n },\n \"overlapTokens\": {\n \"value\": \"\"\n },\n \"minChunkTokens\": {\n \"value\": \"\"\n }\n },\n \"documentFields\": {\n \"contentField\": {\n \"value\": \"\"\n },\n \"titleField\": {\n \"value\": \"\"\n },\n \"contentFormat\": {\n \"value\": \"\"\n },\n \"metadataFields\": {\n \"value\": \"\"\n }\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"34a23c85-23c2-41f9-a9e2-db9267df1ab0","name":"Service not available","originalRequest":{"url":{"path":["search","v2","indices",":indexId","config"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"indexId","description":"(Required) ID of the index"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1963-08-12T14:54:43.321Z\",\n \"status\": 2878,\n \"message\": \"string\",\n \"error\": \"string\",\n \"path\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"a1ac6747-0539-4d60-9797-9afc6219da5a","name":"Delete index configuration","request":{"name":"Delete index configuration","description":{"content":"Delete the configuration of a single index.\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User\n\n**API key permission required:** `ITEMS_SEARCH_CONFIG_SEARCH_DELETE`\n\n**User role permission required:** `assets_search: delete`\n","type":"text/plain"},"url":{"path":["search","v2","indices",":indexId","config"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"indexId","description":"(Required) ID of the index"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"6c5c4e74-531e-4f03-9b92-7aa4bbc16c91","name":"Configuration deleted","originalRequest":{"url":{"path":["search","v2","indices",":indexId","config"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"indexId","description":"(Required) ID of the index"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"DELETE","body":{}},"status":"No Content","code":204,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"8039c14d-2f6b-4f9c-ac7e-ac19ab134ab7","name":"Service not available","originalRequest":{"url":{"path":["search","v2","indices",":indexId","config"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"indexId","description":"(Required) ID of the index"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1963-08-12T14:54:43.321Z\",\n \"status\": 2878,\n \"message\": \"string\",\n \"error\": \"string\",\n \"path\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"08c34770-1cc8-4e51-ba11-18aebdb408d6","name":"Update index configuration","request":{"name":"Update index configuration","description":{"content":"Update the configuration of a single index.\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User\n\n**API key permission required:** `ITEMS_SEARCH_CONFIG_SEARCH_UPDATE`\n\n**User role permission required:** `assets_search: update`\n","type":"text/plain"},"url":{"path":["search","v2","indices",":indexId","config"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"indexId","description":"(Required) ID of the index"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PUT","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"indexName\": \"string\",\n \"itemsCatalogId\": \"string\",\n \"language\": \"string\",\n \"enabled\": true,\n \"description\": \"string\",\n \"ignoreUnavailableItems\": true,\n \"scoring\": {\n \"pageVisitsPopularity\": {\n \"value\": \"\"\n },\n \"transactionsPopularity\": {\n \"value\": \"\"\n },\n \"personalized\": {\n \"value\": \"\"\n },\n \"personalizationWeights\": {\n \"value\": \"\"\n },\n \"tieBreaker\": {\n \"value\": \"\"\n },\n \"matching\": {\n \"value\": \"\"\n },\n \"fallbackMatching\": {\n \"value\": \"\"\n },\n \"similarity\": {\n \"value\": \"\"\n },\n \"crossWorkspaceMode\": {\n \"value\": \"\"\n },\n \"textScoring\": {\n \"value\": \"\"\n }\n },\n \"suggestions\": {\n \"smoothingModel\": {\n \"value\": \"\"\n },\n \"gramSize\": {\n \"value\": \"\"\n },\n \"maxErrors\": {\n \"value\": \"\"\n },\n \"minWordLength\": {\n \"value\": \"\"\n },\n \"useAlways\": {\n \"value\": \"\"\n }\n },\n \"tokenizer\": {\n \"value\": \"\"\n },\n \"analyzers\": {\n \"autocomplete\": {\n \"value\": \"\"\n },\n \"stopwords\": {\n \"value\": \"\"\n }\n },\n \"attributesWithoutPrefixSearch\": [\n \"brand\",\n \"color\",\n \"promotion.type\"\n ],\n \"attributesWithoutTypoTolerance\": [\n \"itemId\",\n \"link\"\n ],\n \"valuesWithoutTypoTolerance\": [\n \"Nike\",\n \"blue\",\n \"74997\"\n ],\n \"typoToleranceOnNumericValues\": true,\n \"searchableAttributes\": {\n \"fullText\": {\n \"value\": \"\"\n },\n \"fullTextBoosted\": {\n \"value\": \"\"\n },\n \"fullTextStronglyBoosted\": {\n \"value\": \"\"\n }\n },\n \"displayableAttributes\": [\n \"brand\",\n \"color\",\n \"promotion.type\"\n ],\n \"facetableAttributes\": {\n \"range\": {\n \"value\": \"\"\n },\n \"text\": {\n \"value\": \"\"\n },\n \"datetime\": {\n \"value\": \"\"\n }\n },\n \"filterableAttributes\": {\n \"range\": {\n \"value\": \"\"\n },\n \"text\": {\n \"value\": \"\"\n },\n \"datetime\": {\n \"value\": \"\"\n }\n },\n \"sortableAttributes\": {\n \"range\": {\n \"value\": \"\"\n },\n \"text\": {\n \"value\": \"\"\n },\n \"datetime\": {\n \"value\": \"\"\n }\n },\n \"distinctFilterAttributes\": {\n \"range\": {\n \"value\": \"\"\n },\n \"text\": {\n \"value\": \"\"\n },\n \"datetime\": {\n \"value\": \"\"\n }\n },\n \"recentSearches\": {\n \"windowSize\": {\n \"value\": \"\"\n },\n \"timeSpan\": {\n \"value\": \"\"\n }\n },\n \"reranking\": {\n \"dynamicReranker\": {\n \"value\": \"\"\n },\n \"queryClassification\": {\n \"value\": \"\"\n }\n },\n \"optimization\": {\n \"enabled\": {\n \"value\": \"\"\n },\n \"target\": {\n \"value\": \"\"\n },\n \"optimizedWeights\": {\n \"value\": \"\"\n }\n },\n \"geoSearch\": {\n \"geoSearchableAttribute\": {\n \"value\": \"\"\n }\n },\n \"queryRules\": {\n \"consequencesJoinOperators\": {\n \"value\": \"\"\n }\n },\n \"indexType\": \"Product\",\n \"chunking\": {\n \"strategy\": {\n \"value\": \"\"\n },\n \"tokenLimit\": {\n \"value\": \"\"\n },\n \"passageTokenLimit\": {\n \"value\": \"\"\n },\n \"prependHeadingPath\": {\n \"value\": \"\"\n },\n \"overlapTokens\": {\n \"value\": \"\"\n },\n \"minChunkTokens\": {\n \"value\": \"\"\n }\n },\n \"documentFields\": {\n \"contentField\": {\n \"value\": \"\"\n },\n \"titleField\": {\n \"value\": \"\"\n },\n \"contentFormat\": {\n \"value\": \"\"\n },\n \"metadataFields\": {\n \"value\": \"\"\n }\n }\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"5570cc68-9971-4d1c-9175-512bd9ad5a58","name":"Returned updated configuration","originalRequest":{"url":{"path":["search","v2","indices",":indexId","config"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"indexId","description":"(Required) ID of the index"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"{\n \"indexName\": \"string\",\n \"itemsCatalogId\": \"string\",\n \"language\": \"string\",\n \"enabled\": true,\n \"description\": \"string\",\n \"ignoreUnavailableItems\": true,\n \"scoring\": {\n \"pageVisitsPopularity\": {\n \"value\": \"\"\n },\n \"transactionsPopularity\": {\n \"value\": \"\"\n },\n \"personalized\": {\n \"value\": \"\"\n },\n \"personalizationWeights\": {\n \"value\": \"\"\n },\n \"tieBreaker\": {\n \"value\": \"\"\n },\n \"matching\": {\n \"value\": \"\"\n },\n \"fallbackMatching\": {\n \"value\": \"\"\n },\n \"similarity\": {\n \"value\": \"\"\n },\n \"crossWorkspaceMode\": {\n \"value\": \"\"\n },\n \"textScoring\": {\n \"value\": \"\"\n }\n },\n \"suggestions\": {\n \"smoothingModel\": {\n \"value\": \"\"\n },\n \"gramSize\": {\n \"value\": \"\"\n },\n \"maxErrors\": {\n \"value\": \"\"\n },\n \"minWordLength\": {\n \"value\": \"\"\n },\n \"useAlways\": {\n \"value\": \"\"\n }\n },\n \"tokenizer\": {\n \"value\": \"\"\n },\n \"analyzers\": {\n \"autocomplete\": {\n \"value\": \"\"\n },\n \"stopwords\": {\n \"value\": \"\"\n }\n },\n \"attributesWithoutPrefixSearch\": [\n \"brand\",\n \"color\",\n \"promotion.type\"\n ],\n \"attributesWithoutTypoTolerance\": [\n \"itemId\",\n \"link\"\n ],\n \"valuesWithoutTypoTolerance\": [\n \"Nike\",\n \"blue\",\n \"74997\"\n ],\n \"typoToleranceOnNumericValues\": true,\n \"searchableAttributes\": {\n \"fullText\": {\n \"value\": \"\"\n },\n \"fullTextBoosted\": {\n \"value\": \"\"\n },\n \"fullTextStronglyBoosted\": {\n \"value\": \"\"\n }\n },\n \"displayableAttributes\": [\n \"brand\",\n \"color\",\n \"promotion.type\"\n ],\n \"facetableAttributes\": {\n \"range\": {\n \"value\": \"\"\n },\n \"text\": {\n \"value\": \"\"\n },\n \"datetime\": {\n \"value\": \"\"\n }\n },\n \"filterableAttributes\": {\n \"range\": {\n \"value\": \"\"\n },\n \"text\": {\n \"value\": \"\"\n },\n \"datetime\": {\n \"value\": \"\"\n }\n },\n \"sortableAttributes\": {\n \"range\": {\n \"value\": \"\"\n },\n \"text\": {\n \"value\": \"\"\n },\n \"datetime\": {\n \"value\": \"\"\n }\n },\n \"distinctFilterAttributes\": {\n \"range\": {\n \"value\": \"\"\n },\n \"text\": {\n \"value\": \"\"\n },\n \"datetime\": {\n \"value\": \"\"\n }\n },\n \"recentSearches\": {\n \"windowSize\": {\n \"value\": \"\"\n },\n \"timeSpan\": {\n \"value\": \"\"\n }\n },\n \"reranking\": {\n \"dynamicReranker\": {\n \"value\": \"\"\n },\n \"queryClassification\": {\n \"value\": \"\"\n }\n },\n \"optimization\": {\n \"enabled\": {\n \"value\": \"\"\n },\n \"target\": {\n \"value\": \"\"\n },\n \"optimizedWeights\": {\n \"value\": \"\"\n }\n },\n \"geoSearch\": {\n \"geoSearchableAttribute\": {\n \"value\": \"\"\n }\n },\n \"queryRules\": {\n \"consequencesJoinOperators\": {\n \"value\": \"\"\n }\n },\n \"indexType\": \"Product\",\n \"chunking\": {\n \"strategy\": {\n \"value\": \"\"\n },\n \"tokenLimit\": {\n \"value\": \"\"\n },\n \"passageTokenLimit\": {\n \"value\": \"\"\n },\n \"prependHeadingPath\": {\n \"value\": \"\"\n },\n \"overlapTokens\": {\n \"value\": \"\"\n },\n \"minChunkTokens\": {\n \"value\": \"\"\n }\n },\n \"documentFields\": {\n \"contentField\": {\n \"value\": \"\"\n },\n \"titleField\": {\n \"value\": \"\"\n },\n \"contentFormat\": {\n \"value\": \"\"\n },\n \"metadataFields\": {\n \"value\": \"\"\n }\n }\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"indexId\": \"string\",\n \"indexName\": \"string\",\n \"description\": \"string\",\n \"itemsCatalogId\": \"string\",\n \"language\": \"string\",\n \"enabled\": true,\n \"disabledReason\": \"Manual\",\n \"ignoreUnavailableItems\": true,\n \"scoring\": {\n \"pageVisitsPopularity\": {\n \"value\": \"\"\n },\n \"transactionsPopularity\": {\n \"value\": \"\"\n },\n \"personalized\": {\n \"value\": \"\"\n },\n \"personalizationWeights\": {\n \"value\": \"\"\n },\n \"tieBreaker\": {\n \"value\": \"\"\n },\n \"matching\": {\n \"value\": \"\"\n },\n \"fallbackMatching\": {\n \"value\": \"\"\n },\n \"similarity\": {\n \"value\": \"\"\n },\n \"crossWorkspaceMode\": {\n \"value\": \"\"\n },\n \"textScoring\": {\n \"value\": \"\"\n }\n },\n \"suggestions\": {\n \"smoothingModel\": {\n \"value\": \"\"\n },\n \"gramSize\": {\n \"value\": \"\"\n },\n \"maxErrors\": {\n \"value\": \"\"\n },\n \"minWordLength\": {\n \"value\": \"\"\n },\n \"useAlways\": {\n \"value\": \"\"\n }\n },\n \"tokenizer\": {\n \"value\": \"\"\n },\n \"analyzers\": {\n \"autocomplete\": {\n \"value\": \"\"\n },\n \"stopwords\": {\n \"value\": \"\"\n }\n },\n \"attributesWithoutPrefixSearch\": [\n \"brand\",\n \"color\",\n \"promotion.type\"\n ],\n \"attributesWithoutTypoTolerance\": [\n \"itemId\",\n \"link\"\n ],\n \"valuesWithoutTypoTolerance\": [\n \"Nike\",\n \"blue\",\n \"74997\"\n ],\n \"typoToleranceOnNumericValues\": true,\n \"searchableAttributes\": {\n \"fullText\": {\n \"value\": \"\"\n },\n \"fullTextBoosted\": {\n \"value\": \"\"\n },\n \"fullTextStronglyBoosted\": {\n \"value\": \"\"\n }\n },\n \"displayableAttributes\": [\n \"brand\",\n \"color\",\n \"promotion.type\"\n ],\n \"facetableAttributes\": {\n \"range\": {\n \"value\": \"\"\n },\n \"text\": {\n \"value\": \"\"\n },\n \"datetime\": {\n \"value\": \"\"\n }\n },\n \"filterableAttributes\": {\n \"range\": {\n \"value\": \"\"\n },\n \"text\": {\n \"value\": \"\"\n },\n \"datetime\": {\n \"value\": \"\"\n }\n },\n \"sortableAttributes\": {\n \"range\": {\n \"value\": \"\"\n },\n \"text\": {\n \"value\": \"\"\n },\n \"datetime\": {\n \"value\": \"\"\n }\n },\n \"distinctFilterAttributes\": {\n \"range\": {\n \"value\": \"\"\n },\n \"text\": {\n \"value\": \"\"\n },\n \"datetime\": {\n \"value\": \"\"\n }\n },\n \"recentSearches\": {\n \"windowSize\": {\n \"value\": \"\"\n },\n \"timeSpan\": {\n \"value\": \"\"\n }\n },\n \"reranking\": {\n \"dynamicReranker\": {\n \"value\": \"\"\n },\n \"queryClassification\": {\n \"value\": \"\"\n }\n },\n \"optimization\": {\n \"enabled\": {\n \"value\": \"\"\n },\n \"target\": {\n \"value\": \"\"\n },\n \"optimizedWeights\": {\n \"value\": \"\"\n }\n },\n \"dynamicSynonyms\": {\n \"enabled\": {\n \"value\": \"\"\n },\n \"workflowIntervalDays\": {\n \"value\": \"\"\n },\n \"coldStart\": {\n \"value\": \"\"\n },\n \"autoAcceptThreshold\": {\n \"value\": \"\"\n }\n },\n \"dynamicFacets\": {\n \"enabled\": {\n \"value\": \"\"\n },\n \"maxFacets\": {\n \"value\": \"\"\n },\n \"minCoverageThreshold\": {\n \"value\": \"\"\n },\n \"objective\": {\n \"value\": \"\"\n }\n },\n \"geoSearch\": {\n \"geoSearchableAttribute\": {\n \"value\": \"\"\n }\n },\n \"queryRules\": {\n \"consequencesJoinOperators\": {\n \"value\": \"\"\n }\n },\n \"updatedAt\": \"2009-08-09T16:24:20.627Z\",\n \"createdAt\": \"1975-08-07T00:03:36.251Z\",\n \"indexType\": \"Document\",\n \"chunking\": {\n \"strategy\": {\n \"value\": \"\"\n },\n \"tokenLimit\": {\n \"value\": \"\"\n },\n \"passageTokenLimit\": {\n \"value\": \"\"\n },\n \"prependHeadingPath\": {\n \"value\": \"\"\n },\n \"overlapTokens\": {\n \"value\": \"\"\n },\n \"minChunkTokens\": {\n \"value\": \"\"\n }\n },\n \"documentFields\": {\n \"contentField\": {\n \"value\": \"\"\n },\n \"titleField\": {\n \"value\": \"\"\n },\n \"contentFormat\": {\n \"value\": \"\"\n },\n \"metadataFields\": {\n \"value\": \"\"\n }\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"370490d3-e319-42d1-8a34-16d23bfe9533","name":"Service not available","originalRequest":{"url":{"path":["search","v2","indices",":indexId","config"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"indexId","description":"(Required) ID of the index"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"{\n \"indexName\": \"string\",\n \"itemsCatalogId\": \"string\",\n \"language\": \"string\",\n \"enabled\": true,\n \"description\": \"string\",\n \"ignoreUnavailableItems\": true,\n \"scoring\": {\n \"pageVisitsPopularity\": {\n \"value\": \"\"\n },\n \"transactionsPopularity\": {\n \"value\": \"\"\n },\n \"personalized\": {\n \"value\": \"\"\n },\n \"personalizationWeights\": {\n \"value\": \"\"\n },\n \"tieBreaker\": {\n \"value\": \"\"\n },\n \"matching\": {\n \"value\": \"\"\n },\n \"fallbackMatching\": {\n \"value\": \"\"\n },\n \"similarity\": {\n \"value\": \"\"\n },\n \"crossWorkspaceMode\": {\n \"value\": \"\"\n },\n \"textScoring\": {\n \"value\": \"\"\n }\n },\n \"suggestions\": {\n \"smoothingModel\": {\n \"value\": \"\"\n },\n \"gramSize\": {\n \"value\": \"\"\n },\n \"maxErrors\": {\n \"value\": \"\"\n },\n \"minWordLength\": {\n \"value\": \"\"\n },\n \"useAlways\": {\n \"value\": \"\"\n }\n },\n \"tokenizer\": {\n \"value\": \"\"\n },\n \"analyzers\": {\n \"autocomplete\": {\n \"value\": \"\"\n },\n \"stopwords\": {\n \"value\": \"\"\n }\n },\n \"attributesWithoutPrefixSearch\": [\n \"brand\",\n \"color\",\n \"promotion.type\"\n ],\n \"attributesWithoutTypoTolerance\": [\n \"itemId\",\n \"link\"\n ],\n \"valuesWithoutTypoTolerance\": [\n \"Nike\",\n \"blue\",\n \"74997\"\n ],\n \"typoToleranceOnNumericValues\": true,\n \"searchableAttributes\": {\n \"fullText\": {\n \"value\": \"\"\n },\n \"fullTextBoosted\": {\n \"value\": \"\"\n },\n \"fullTextStronglyBoosted\": {\n \"value\": \"\"\n }\n },\n \"displayableAttributes\": [\n \"brand\",\n \"color\",\n \"promotion.type\"\n ],\n \"facetableAttributes\": {\n \"range\": {\n \"value\": \"\"\n },\n \"text\": {\n \"value\": \"\"\n },\n \"datetime\": {\n \"value\": \"\"\n }\n },\n \"filterableAttributes\": {\n \"range\": {\n \"value\": \"\"\n },\n \"text\": {\n \"value\": \"\"\n },\n \"datetime\": {\n \"value\": \"\"\n }\n },\n \"sortableAttributes\": {\n \"range\": {\n \"value\": \"\"\n },\n \"text\": {\n \"value\": \"\"\n },\n \"datetime\": {\n \"value\": \"\"\n }\n },\n \"distinctFilterAttributes\": {\n \"range\": {\n \"value\": \"\"\n },\n \"text\": {\n \"value\": \"\"\n },\n \"datetime\": {\n \"value\": \"\"\n }\n },\n \"recentSearches\": {\n \"windowSize\": {\n \"value\": \"\"\n },\n \"timeSpan\": {\n \"value\": \"\"\n }\n },\n \"reranking\": {\n \"dynamicReranker\": {\n \"value\": \"\"\n },\n \"queryClassification\": {\n \"value\": \"\"\n }\n },\n \"optimization\": {\n \"enabled\": {\n \"value\": \"\"\n },\n \"target\": {\n \"value\": \"\"\n },\n \"optimizedWeights\": {\n \"value\": \"\"\n }\n },\n \"geoSearch\": {\n \"geoSearchableAttribute\": {\n \"value\": \"\"\n }\n },\n \"queryRules\": {\n \"consequencesJoinOperators\": {\n \"value\": \"\"\n }\n },\n \"indexType\": \"Product\",\n \"chunking\": {\n \"strategy\": {\n \"value\": \"\"\n },\n \"tokenLimit\": {\n \"value\": \"\"\n },\n \"passageTokenLimit\": {\n \"value\": \"\"\n },\n \"prependHeadingPath\": {\n \"value\": \"\"\n },\n \"overlapTokens\": {\n \"value\": \"\"\n },\n \"minChunkTokens\": {\n \"value\": \"\"\n }\n },\n \"documentFields\": {\n \"contentField\": {\n \"value\": \"\"\n },\n \"titleField\": {\n \"value\": \"\"\n },\n \"contentFormat\": {\n \"value\": \"\"\n },\n \"metadataFields\": {\n \"value\": \"\"\n }\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1963-08-12T14:54:43.321Z\",\n \"status\": 2878,\n \"message\": \"string\",\n \"error\": \"string\",\n \"path\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"1f0f878f-6db6-47f2-b600-05415c74bfd5","name":"Get index state","request":{"name":"Get index state","description":{"content":"Retrieve the state of a single index.\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User\n\n**API key permission required:** `ITEMS_SEARCH_CONFIG_SEARCH_READ`\n\n**User role permission required:** `assets_search: read`\n","type":"text/plain"},"url":{"path":["search","v2","indices",":indexId","state"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"indexId","description":"(Required) ID of the index"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"fb4ed795-685e-45d7-a4e2-882bcf9e0492","name":"State returned","originalRequest":{"url":{"path":["search","v2","indices",":indexId","state"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"indexId","description":"(Required) ID of the index"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"indexId\": \"string\",\n \"state\": \"ReadyUpToDate\",\n \"lastConfigChange\": \"2011-12-13T09:41:58.986Z\",\n \"lastSuccessfulBuildDate\": \"1947-08-19T19:31:34.282Z\",\n \"indexMetadata\": {},\n \"errorReason\": \"string\",\n \"log\": \"string\",\n \"dynamicRerankerStatus\": \"NotReady\",\n \"canEnableDynamicReranker\": false,\n \"queryClassificationStatus\": \"NotReady\",\n \"canEnableQueryClassification\": true,\n \"canEnableTargetOptimization\": false,\n \"queryTaggerStatus\": \"NotTrained\",\n \"queryTaggerModelVersion\": \"string\",\n \"queryTaggerTrainedAt\": \"1983-10-25T00:25:02.265Z\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"ac763357-59d4-4772-8b5a-0e4852dd9a36","name":"Service not available","originalRequest":{"url":{"path":["search","v2","indices",":indexId","state"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"indexId","description":"(Required) ID of the index"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1963-08-12T14:54:43.321Z\",\n \"status\": 2878,\n \"message\": \"string\",\n \"error\": \"string\",\n \"path\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"37508fae-2b79-4f0c-8a5d-e04ba84807fc","name":"Get supported languages","request":{"name":"Get supported languages","description":{"content":"Retrieve supported languages.\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User\n\n**API key permission required:** `ITEMS_SEARCH_CONFIG_SEARCH_READ`\n\n**User role permission required:** `assets_search: read`\n","type":"text/plain"},"url":{"path":["search","v2","supported-languages"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"16235dc2-3592-48c2-a84f-88169b344162","name":"Supported search languages as ISO 639-1 codes","originalRequest":{"url":{"path":["search","v2","supported-languages"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"pl\": \"Polish\",\n \"ro\": \"Romanian\",\n \"ru\": \"Russian\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"29d15cb5-ee35-40f1-a2ed-75ebe577ea6b","name":"Service not available","originalRequest":{"url":{"path":["search","v2","supported-languages"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1963-08-12T14:54:43.321Z\",\n \"status\": 2878,\n \"message\": \"string\",\n \"error\": \"string\",\n \"path\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"56fd5383-3819-4975-9d5d-bf3c2b2befe4","name":"Duplicate index","request":{"name":"Duplicate index","description":{"content":"duplicate index.\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User\n\n**API key permission required:** `ITEMS_SEARCH_CONFIG_SEARCH_CREATE`\n\n**User role permission required:** `assets_search: create`\n","type":"text/plain"},"url":{"path":["search","v2","indices",":indexId","duplicate"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"indexId","description":"(Required) ID of the index"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"eb9272af-f45c-4d7c-aeb8-a0d544b125c1","name":"Returned newly created duplicate index","originalRequest":{"url":{"path":["search","v2","indices",":indexId","duplicate"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"indexId","description":"(Required) ID of the index"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"indexId\": \"string\",\n \"indexName\": \"string\",\n \"description\": \"string\",\n \"itemsCatalogId\": \"string\",\n \"language\": \"string\",\n \"enabled\": true,\n \"disabledReason\": \"Manual\",\n \"ignoreUnavailableItems\": true,\n \"scoring\": {\n \"pageVisitsPopularity\": {\n \"value\": \"\"\n },\n \"transactionsPopularity\": {\n \"value\": \"\"\n },\n \"personalized\": {\n \"value\": \"\"\n },\n \"personalizationWeights\": {\n \"value\": \"\"\n },\n \"tieBreaker\": {\n \"value\": \"\"\n },\n \"matching\": {\n \"value\": \"\"\n },\n \"fallbackMatching\": {\n \"value\": \"\"\n },\n \"similarity\": {\n \"value\": \"\"\n },\n \"crossWorkspaceMode\": {\n \"value\": \"\"\n },\n \"textScoring\": {\n \"value\": \"\"\n }\n },\n \"suggestions\": {\n \"smoothingModel\": {\n \"value\": \"\"\n },\n \"gramSize\": {\n \"value\": \"\"\n },\n \"maxErrors\": {\n \"value\": \"\"\n },\n \"minWordLength\": {\n \"value\": \"\"\n },\n \"useAlways\": {\n \"value\": \"\"\n }\n },\n \"tokenizer\": {\n \"value\": \"\"\n },\n \"analyzers\": {\n \"autocomplete\": {\n \"value\": \"\"\n },\n \"stopwords\": {\n \"value\": \"\"\n }\n },\n \"attributesWithoutPrefixSearch\": [\n \"brand\",\n \"color\",\n \"promotion.type\"\n ],\n \"attributesWithoutTypoTolerance\": [\n \"itemId\",\n \"link\"\n ],\n \"valuesWithoutTypoTolerance\": [\n \"Nike\",\n \"blue\",\n \"74997\"\n ],\n \"typoToleranceOnNumericValues\": true,\n \"searchableAttributes\": {\n \"fullText\": {\n \"value\": \"\"\n },\n \"fullTextBoosted\": {\n \"value\": \"\"\n },\n \"fullTextStronglyBoosted\": {\n \"value\": \"\"\n }\n },\n \"displayableAttributes\": [\n \"brand\",\n \"color\",\n \"promotion.type\"\n ],\n \"facetableAttributes\": {\n \"range\": {\n \"value\": \"\"\n },\n \"text\": {\n \"value\": \"\"\n },\n \"datetime\": {\n \"value\": \"\"\n }\n },\n \"filterableAttributes\": {\n \"range\": {\n \"value\": \"\"\n },\n \"text\": {\n \"value\": \"\"\n },\n \"datetime\": {\n \"value\": \"\"\n }\n },\n \"sortableAttributes\": {\n \"range\": {\n \"value\": \"\"\n },\n \"text\": {\n \"value\": \"\"\n },\n \"datetime\": {\n \"value\": \"\"\n }\n },\n \"distinctFilterAttributes\": {\n \"range\": {\n \"value\": \"\"\n },\n \"text\": {\n \"value\": \"\"\n },\n \"datetime\": {\n \"value\": \"\"\n }\n },\n \"recentSearches\": {\n \"windowSize\": {\n \"value\": \"\"\n },\n \"timeSpan\": {\n \"value\": \"\"\n }\n },\n \"reranking\": {\n \"dynamicReranker\": {\n \"value\": \"\"\n },\n \"queryClassification\": {\n \"value\": \"\"\n }\n },\n \"optimization\": {\n \"enabled\": {\n \"value\": \"\"\n },\n \"target\": {\n \"value\": \"\"\n },\n \"optimizedWeights\": {\n \"value\": \"\"\n }\n },\n \"dynamicSynonyms\": {\n \"enabled\": {\n \"value\": \"\"\n },\n \"workflowIntervalDays\": {\n \"value\": \"\"\n },\n \"coldStart\": {\n \"value\": \"\"\n },\n \"autoAcceptThreshold\": {\n \"value\": \"\"\n }\n },\n \"dynamicFacets\": {\n \"enabled\": {\n \"value\": \"\"\n },\n \"maxFacets\": {\n \"value\": \"\"\n },\n \"minCoverageThreshold\": {\n \"value\": \"\"\n },\n \"objective\": {\n \"value\": \"\"\n }\n },\n \"geoSearch\": {\n \"geoSearchableAttribute\": {\n \"value\": \"\"\n }\n },\n \"queryRules\": {\n \"consequencesJoinOperators\": {\n \"value\": \"\"\n }\n },\n \"updatedAt\": \"2009-08-09T16:24:20.627Z\",\n \"createdAt\": \"1975-08-07T00:03:36.251Z\",\n \"indexType\": \"Document\",\n \"chunking\": {\n \"strategy\": {\n \"value\": \"\"\n },\n \"tokenLimit\": {\n \"value\": \"\"\n },\n \"passageTokenLimit\": {\n \"value\": \"\"\n },\n \"prependHeadingPath\": {\n \"value\": \"\"\n },\n \"overlapTokens\": {\n \"value\": \"\"\n },\n \"minChunkTokens\": {\n \"value\": \"\"\n }\n },\n \"documentFields\": {\n \"contentField\": {\n \"value\": \"\"\n },\n \"titleField\": {\n \"value\": \"\"\n },\n \"contentFormat\": {\n \"value\": \"\"\n },\n \"metadataFields\": {\n \"value\": \"\"\n }\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"f46442dd-5fe1-4b5c-8320-3351c327d8aa","name":"Service not available","originalRequest":{"url":{"path":["search","v2","indices",":indexId","duplicate"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"indexId","description":"(Required) ID of the index"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1963-08-12T14:54:43.321Z\",\n \"status\": 2878,\n \"message\": \"string\",\n \"error\": \"string\",\n \"path\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}],"event":[]},{"id":"3147e8a1-7696-401f-9f93-120a9a08de7c","name":"Suggestions Configuration","description":{"content":"","type":"text/plain"},"item":[{"id":"484be366-df2f-4962-8257-25d329447e20","name":"Get suggestion indices","request":{"name":"Get suggestion indices","description":{"content":"Retrieve a list of all suggestion index configurations in the workspace.\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User\n\n**API key permission required:** `ITEMS_SEARCH_CONFIG_SEARCH_READ`\n\n**User role permission required:** `assets_search: read`\n","type":"text/plain"},"url":{"path":["search","v2","suggestion-indices"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"page","value":"4","description":"Page number to return for pagination. The first page has the index `1`."},{"disabled":false,"key":"limit","value":"100","description":"The number of items to return per page"},{"disabled":false,"key":"sortBy","value":"createdAt:desc","description":"Name of the attribute by which the data will be sorted, optionally with the sorting direction\nappended after a colon - `sortBy=createdAt:desc`. A direction given this way takes precedence\nover the `ordering` parameter.\n"},{"disabled":false,"key":"ordering","value":"desc","description":"Sorting order"},{"disabled":false,"key":"includeMeta","value":"false","description":"\nWhen `true`, pagination metadata is included in the response body.\n\nWhen `false`, the data is included in the response headers:\n\n- Link: links to neighbors, first, and last pages in pagination.\n\n- X-Pagination-Total-Count: total number of items on all pages\n\n- X-Pagination-Total-Pages: total number of pages\n\n- X-Pagination-Page: current page\n\n- X-Pagination-Limit: maximum number of items on a page\n\n- X-Pagination-Sorted-By: parameter that the items were sorted by\n\n- X-Pagination-Ordering: sorting direction\n"},{"disabled":false,"key":"name","value":"string","description":"Deprecated parameter. If `search` or `query` is provided, this parameter is ignored.\nIf an index has an `id` equal to the value of this parameter, only that index will be retrieved. Otherwise, all indices containing this value in their `name` will be retrieved.\n"},{"disabled":false,"key":"query","value":"string","description":"Deprecated parameter. If `search` is provided, this parameter is ignored.\nIf an index has an `id` equal to the value of this parameter, only that index will be retrieved. Otherwise, all indices containing this value in their `name` will be retrieved.\n"},{"disabled":false,"key":"search","value":"string","description":"If an index has an `id` equal to the value of this parameter, only that index will be retrieved. Otherwise, all indices containing this value in their `name` will be retrieved. This parameter replaces the deprecated `query` and `name` parameters."}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"e3f6c210-3339-40b9-b0c3-bd3307c0032e","name":"List of suggestion index configurations","originalRequest":{"url":{"path":["search","v2","suggestion-indices"],"host":["{{baseUrl}}"],"query":[{"key":"page","value":"4"},{"key":"limit","value":"100"},{"key":"sortBy","value":"createdAt:desc"},{"key":"ordering","value":"desc"},{"key":"includeMeta","value":"false"},{"key":"name","value":"string"},{"key":"query","value":"string"},{"key":"search","value":"string"}],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"data\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"meta\": {\n \"totalPages\": {\n \"value\": \"\"\n },\n \"totalCount\": {\n \"value\": \"\"\n },\n \"page\": {\n \"value\": \"\"\n },\n \"limit\": {\n \"value\": \"\"\n },\n \"sortedBy\": {\n \"value\": \"\"\n },\n \"ordering\": {\n \"value\": \"\"\n },\n \"code\": {\n \"value\": \"\"\n },\n \"link\": {\n \"value\": \"\"\n }\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"b79f80c1-edff-485a-9736-06c77a2675e3","name":"An error occurred","originalRequest":{"url":{"path":["search","v2","suggestion-indices"],"host":["{{baseUrl}}"],"query":[{"key":"page","value":"4"},{"key":"limit","value":"100"},{"key":"sortBy","value":"createdAt:desc"},{"key":"ordering","value":"desc"},{"key":"includeMeta","value":"false"},{"key":"name","value":"string"},{"key":"query","value":"string"},{"key":"search","value":"string"}],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1963-08-12T14:54:43.321Z\",\n \"status\": 2878,\n \"message\": \"string\",\n \"error\": \"string\",\n \"path\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"8dd9347f-321c-4c9f-b580-9b59f1d9fd8c","name":"Create suggestion index","request":{"name":"Create suggestion index","description":{"content":"Create a suggestion index configuration.\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User\n\n**API key permission required:** `ITEMS_SEARCH_CONFIG_SEARCH_CREATE`\n\n**User role permission required:** `assets_search: create`\n","type":"text/plain"},"url":{"path":["search","v2","suggestion-indices"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"indexName\": \"string\",\n \"enabled\": true,\n \"sources\": {\n \"indices\": {\n \"value\": \"\"\n },\n \"external\": {\n \"value\": \"\"\n },\n \"generate\": {\n \"value\": \"\"\n }\n },\n \"description\": \"string\",\n \"author\": 6985,\n \"denylist\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"ebcb9c90-a0f0-47d2-b998-0afbde05b180","name":"Suggestion index config created","originalRequest":{"url":{"path":["search","v2","suggestion-indices"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"indexName\": \"string\",\n \"enabled\": true,\n \"sources\": {\n \"indices\": {\n \"value\": \"\"\n },\n \"external\": {\n \"value\": \"\"\n },\n \"generate\": {\n \"value\": \"\"\n }\n },\n \"description\": \"string\",\n \"author\": 4426,\n \"denylist\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"indexId\": \"string\",\n \"indexName\": \"string\",\n \"description\": \"string\",\n \"author\": 2693,\n \"enabled\": true,\n \"disabledReason\": \"NoActivity\",\n \"sources\": {\n \"indices\": {\n \"value\": \"\"\n },\n \"external\": {\n \"value\": \"\"\n },\n \"generate\": {\n \"value\": \"\"\n }\n },\n \"denylist\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"updatedAt\": \"1999-10-02T19:27:11.595Z\",\n \"createdAt\": \"1985-10-03T11:06:39.657Z\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"8c93e035-2f8b-4edd-9140-083ce3cead8f","name":"An error occurred","originalRequest":{"url":{"path":["search","v2","suggestion-indices"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"indexName\": \"string\",\n \"enabled\": true,\n \"sources\": {\n \"indices\": {\n \"value\": \"\"\n },\n \"external\": {\n \"value\": \"\"\n },\n \"generate\": {\n \"value\": \"\"\n }\n },\n \"description\": \"string\",\n \"author\": 4426,\n \"denylist\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1963-08-12T14:54:43.321Z\",\n \"status\": 2878,\n \"message\": \"string\",\n \"error\": \"string\",\n \"path\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"024b05c5-b3f2-4863-99e8-cb61a0b76476","name":"Get suggestion index","request":{"name":"Get suggestion index","description":{"content":"Retrieve a suggestion index configuration.\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User\n\n**API key permission required:** `ITEMS_SEARCH_CONFIG_SEARCH_READ`\n\n**User role permission required:** `assets_search: read`\n","type":"text/plain"},"url":{"path":["search","v2","suggestion-indices",":indexId","config"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"indexId","description":"(Required) ID of the index"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"0f832622-892e-4c46-ab37-7b4edf6518bd","name":"Suggestion index configuration","originalRequest":{"url":{"path":["search","v2","suggestion-indices",":indexId","config"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"indexId","description":"(Required) ID of the index"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"indexId\": \"string\",\n \"indexName\": \"string\",\n \"description\": \"string\",\n \"author\": 2693,\n \"enabled\": true,\n \"disabledReason\": \"NoActivity\",\n \"sources\": {\n \"indices\": {\n \"value\": \"\"\n },\n \"external\": {\n \"value\": \"\"\n },\n \"generate\": {\n \"value\": \"\"\n }\n },\n \"denylist\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"updatedAt\": \"1999-10-02T19:27:11.595Z\",\n \"createdAt\": \"1985-10-03T11:06:39.657Z\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"738119f2-92e7-44eb-9ac7-9ea6fdc9b1fe","name":"An error occurred","originalRequest":{"url":{"path":["search","v2","suggestion-indices",":indexId","config"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"indexId","description":"(Required) ID of the index"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1963-08-12T14:54:43.321Z\",\n \"status\": 2878,\n \"message\": \"string\",\n \"error\": \"string\",\n \"path\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"0d07d9dc-e2e2-4e17-b5f2-c928e846b32f","name":"Create/replace suggestion index","request":{"name":"Create/replace suggestion index","description":{"content":"Create a suggestion index configuration or replace an existing one, given the index ID.\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User\n\n**API key permission required:** `ITEMS_SEARCH_CONFIG_SEARCH_UPDATE`\n\n**User role permission required:** `assets_search: update`\n","type":"text/plain"},"url":{"path":["search","v2","suggestion-indices",":indexId","config"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"indexId","description":"(Required) ID of the index"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PUT","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"indexName\": \"string\",\n \"enabled\": true,\n \"sources\": {\n \"indices\": {\n \"value\": \"\"\n },\n \"external\": {\n \"value\": \"\"\n },\n \"generate\": {\n \"value\": \"\"\n }\n },\n \"description\": \"string\",\n \"author\": 4426,\n \"denylist\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"35a5523b-406c-4516-a3e2-8ecd8b16eb87","name":"Suggestion index config created or replaced successfully","originalRequest":{"url":{"path":["search","v2","suggestion-indices",":indexId","config"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"indexId","description":"(Required) ID of the index"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"{\n \"indexName\": \"string\",\n \"enabled\": true,\n \"sources\": {\n \"indices\": {\n \"value\": \"\"\n },\n \"external\": {\n \"value\": \"\"\n },\n \"generate\": {\n \"value\": \"\"\n }\n },\n \"description\": \"string\",\n \"author\": 4426,\n \"denylist\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"indexId\": \"string\",\n \"indexName\": \"string\",\n \"description\": \"string\",\n \"author\": 2693,\n \"enabled\": true,\n \"disabledReason\": \"NoActivity\",\n \"sources\": {\n \"indices\": {\n \"value\": \"\"\n },\n \"external\": {\n \"value\": \"\"\n },\n \"generate\": {\n \"value\": \"\"\n }\n },\n \"denylist\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"updatedAt\": \"1999-10-02T19:27:11.595Z\",\n \"createdAt\": \"1985-10-03T11:06:39.657Z\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"e48bd35e-ac9e-4be0-a73a-74663e9568a6","name":"An error occurred","originalRequest":{"url":{"path":["search","v2","suggestion-indices",":indexId","config"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"indexId","description":"(Required) ID of the index"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"{\n \"indexName\": \"string\",\n \"enabled\": true,\n \"sources\": {\n \"indices\": {\n \"value\": \"\"\n },\n \"external\": {\n \"value\": \"\"\n },\n \"generate\": {\n \"value\": \"\"\n }\n },\n \"description\": \"string\",\n \"author\": 4426,\n \"denylist\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1963-08-12T14:54:43.321Z\",\n \"status\": 2878,\n \"message\": \"string\",\n \"error\": \"string\",\n \"path\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"9084897e-55d6-4576-87e8-fe79648187d0","name":"Delete suggestion index","request":{"name":"Delete suggestion index","description":{"content":"Delete a suggestion index configuration.\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User\n\n**API key permission required:** `ITEMS_SEARCH_CONFIG_SEARCH_DELETE`\n\n**User role permission required:** `assets_search: delete`\n","type":"text/plain"},"url":{"path":["search","v2","suggestion-indices",":indexId","config"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"indexId","description":"(Required) ID of the index"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"a1c82830-1bd8-4ef8-a768-daf1e7e06c0b","name":"Suggestion index config deleted","originalRequest":{"url":{"path":["search","v2","suggestion-indices",":indexId","config"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"indexId","description":"(Required) ID of the index"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"DELETE","body":{}},"status":"No Content","code":204,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"c32f6a39-c702-4737-aa12-61348b0c1d55","name":"An error occurred","originalRequest":{"url":{"path":["search","v2","suggestion-indices",":indexId","config"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"indexId","description":"(Required) ID of the index"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1963-08-12T14:54:43.321Z\",\n \"status\": 2878,\n \"message\": \"string\",\n \"error\": \"string\",\n \"path\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"4d84d936-eec4-42ff-9c1f-a0b7e66a12c3","name":"Get suggestion index state","request":{"name":"Get suggestion index state","description":{"content":"Retrieve the state of a single suggestion index.\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User\n\n**API key permission required:** `ITEMS_SEARCH_CONFIG_SEARCH_READ`\n\n**User role permission required:** `assets_search: read`\n","type":"text/plain"},"url":{"path":["search","v2","suggestion-indices",":indexId","state"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"indexId","description":"(Required) ID of the index"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"0b2d6498-f2f8-4692-906c-040673796ae1","name":"Suggestion index state","originalRequest":{"url":{"path":["search","v2","suggestion-indices",":indexId","state"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"indexId","description":"(Required) ID of the index"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"indexId\": \"string\",\n \"state\": \"ReadyUpToDate\",\n \"lastConfigChange\": \"2011-12-13T09:41:58.986Z\",\n \"lastSuccessfulBuildDate\": \"1947-08-19T19:31:34.282Z\",\n \"indexMetadata\": {},\n \"errorReason\": \"string\",\n \"log\": \"string\",\n \"dynamicRerankerStatus\": \"NotReady\",\n \"canEnableDynamicReranker\": false,\n \"queryClassificationStatus\": \"NotReady\",\n \"canEnableQueryClassification\": true,\n \"canEnableTargetOptimization\": false,\n \"queryTaggerStatus\": \"NotTrained\",\n \"queryTaggerModelVersion\": \"string\",\n \"queryTaggerTrainedAt\": \"1983-10-25T00:25:02.265Z\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"ba875b8c-145b-459e-99cb-fe7d391a74a4","name":"An error occurred","originalRequest":{"url":{"path":["search","v2","suggestion-indices",":indexId","state"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"indexId","description":"(Required) ID of the index"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1963-08-12T14:54:43.321Z\",\n \"status\": 2878,\n \"message\": \"string\",\n \"error\": \"string\",\n \"path\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}],"event":[]},{"id":"cac7a695-31f2-40c2-9221-66d37c092a77","name":"Query Rules","description":{"content":"","type":"text/plain"},"item":[{"id":"e78e2ec7-f55f-47b6-8624-37a433d89e61","name":"Get rules","request":{"name":"Get rules","description":{"content":"Retrieves a list of rules.\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User\n\n**API key permission required:** `QUERY_RULES_SEARCH_READ`\n\n**User role permission required:** `assets_search: read`\n","type":"text/plain"},"url":{"path":["search","v2","indices",":indexId","rules"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"status","value":"paused","description":"Only rules with this status will be retrieved."},{"disabled":false,"key":"name","value":"string","description":"Only rules containing this name will be retrieved."},{"disabled":false,"key":"page","value":"4","description":"Page number to return for pagination. The first page has the index `1`."},{"disabled":false,"key":"limit","value":"100","description":"The number of items to return per page"},{"disabled":false,"key":"sortBy","value":"string","description":"Name of the attribute by which the data will be sorted"},{"disabled":false,"key":"ordering","value":"desc","description":"Sorting order"},{"disabled":false,"key":"includeMeta","value":"false","description":"\nWhen `true`, pagination metadata is included in the response body.\n\nWhen `false`, the data is included in the response headers:\n\n- Link: links to neighbors, first, and last pages in pagination.\n\n- X-Pagination-Total-Count: total number of items on all pages\n\n- X-Pagination-Total-Pages: total number of pages\n\n- X-Pagination-Page: current page\n\n- X-Pagination-Limit: maximum number of items on a page\n\n- X-Pagination-Sorted-By: parameter that the items were sorted by\n\n- X-Pagination-Ordering: sorting direction\n"},{"disabled":false,"key":"directoryId","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","description":"Requested directoryId of the rule."},{"disabled":false,"key":"search","value":"string","description":"Requested part of the name or the id of the rule."},{"disabled":false,"key":"consequenceType","value":"hide","description":"Only rules producing at least one of the given consequence types will be retrieved. May be repeated."},{"disabled":false,"key":"consequenceType","value":"topHits","description":"Only rules producing at least one of the given consequence types will be retrieved. May be repeated."}],"variable":[{"disabled":false,"type":"any","value":"string","key":"indexId","description":"(Required) ID of the index"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"d339cafc-6a3e-4476-a251-6383c14f728d","name":"List of rules","originalRequest":{"url":{"path":["search","v2","indices",":indexId","rules"],"host":["{{baseUrl}}"],"query":[{"key":"status","value":"paused"},{"key":"name","value":"string"},{"key":"page","value":"4"},{"key":"limit","value":"100"},{"key":"sortBy","value":"string"},{"key":"ordering","value":"desc"},{"key":"includeMeta","value":"false"},{"key":"directoryId","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750"},{"key":"search","value":"string"},{"key":"consequenceType","value":"hide"},{"key":"consequenceType","value":"hideFacet"}],"variable":[{"disabled":false,"type":"any","value":"string","key":"indexId","description":"(Required) ID of the index"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"data\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"extras\": {\n \"statuses\": {\n \"Finished\": {\n \"value\": \"\"\n },\n \"Draft\": {\n \"value\": \"\"\n },\n \"Paused\": {\n \"value\": \"\"\n },\n \"Scheduled\": {\n \"value\": \"\"\n },\n \"Active\": {\n \"value\": \"\"\n }\n }\n },\n \"meta\": {\n \"totalPages\": {\n \"value\": \"\"\n },\n \"totalCount\": {\n \"value\": \"\"\n },\n \"page\": {\n \"value\": \"\"\n },\n \"limit\": {\n \"value\": \"\"\n },\n \"sortedBy\": {\n \"value\": \"\"\n },\n \"ordering\": {\n \"value\": \"\"\n },\n \"code\": {\n \"value\": \"\"\n },\n \"link\": {\n \"value\": \"\"\n }\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"cb7bd77a-3575-41f2-8816-f905ba5f51de","name":"An error occurred","originalRequest":{"url":{"path":["search","v2","indices",":indexId","rules"],"host":["{{baseUrl}}"],"query":[{"key":"status","value":"paused"},{"key":"name","value":"string"},{"key":"page","value":"4"},{"key":"limit","value":"100"},{"key":"sortBy","value":"string"},{"key":"ordering","value":"desc"},{"key":"includeMeta","value":"false"},{"key":"directoryId","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750"},{"key":"search","value":"string"},{"key":"consequenceType","value":"hide"},{"key":"consequenceType","value":"hideFacet"}],"variable":[{"disabled":false,"type":"any","value":"string","key":"indexId","description":"(Required) ID of the index"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1963-08-12T14:54:43.321Z\",\n \"status\": 2878,\n \"message\": \"string\",\n \"error\": \"string\",\n \"path\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"da9de040-6eaf-4713-963d-17d425a4c4b9","name":"Create rule","request":{"name":"Create rule","description":{"content":"Creates a new rule.\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User\n\n**API key permission required:** `QUERY_RULES_SEARCH_CREATE`\n\n**User role permission required:** `assets_search: create`\n","type":"text/plain"},"url":{"path":["search","v2","indices",":indexId","rules"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"indexId","description":"(Required) ID of the index"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"name\": \"string\",\n \"author\": 1375,\n \"activeFrom\": \"string\",\n \"activeTo\": \"string\",\n \"timezone\": \"string\",\n \"data\": {\n \"conditions\": {\n \"value\": \"\"\n },\n \"queryConsequences\": {\n \"value\": \"\"\n },\n \"postQueryConsequences\": {\n \"value\": \"\"\n },\n \"audience\": {\n \"value\": \"\"\n }\n }\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"b17c393c-f87b-47b9-a370-8735dc425d33","name":"ID of the new rule","originalRequest":{"url":{"path":["search","v2","indices",":indexId","rules"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"indexId","description":"(Required) ID of the index"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"name\": \"string\",\n \"author\": 1375,\n \"activeFrom\": \"string\",\n \"activeTo\": \"string\",\n \"timezone\": \"string\",\n \"data\": {\n \"conditions\": {\n \"value\": \"\"\n },\n \"queryConsequences\": {\n \"value\": \"\"\n },\n \"postQueryConsequences\": {\n \"value\": \"\"\n },\n \"audience\": {\n \"value\": \"\"\n }\n }\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"status\": \"string\",\n \"rule\": {\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"author\": {\n \"value\": \"\"\n },\n \"state\": {\n \"value\": \"\"\n },\n \"activeFrom\": {\n \"value\": \"\"\n },\n \"activeTo\": {\n \"value\": \"\"\n },\n \"timezone\": {\n \"value\": \"\"\n },\n \"updatedAt\": {\n \"value\": \"\"\n },\n \"createdAt\": {\n \"value\": \"\"\n },\n \"data\": {\n \"value\": \"\"\n },\n \"source\": {\n \"value\": \"\"\n }\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"dfa0ebb3-c68e-4289-9ac5-0bee589996a8","name":"An error occurred","originalRequest":{"url":{"path":["search","v2","indices",":indexId","rules"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"indexId","description":"(Required) ID of the index"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"name\": \"string\",\n \"author\": 1375,\n \"activeFrom\": \"string\",\n \"activeTo\": \"string\",\n \"timezone\": \"string\",\n \"data\": {\n \"conditions\": {\n \"value\": \"\"\n },\n \"queryConsequences\": {\n \"value\": \"\"\n },\n \"postQueryConsequences\": {\n \"value\": \"\"\n },\n \"audience\": {\n \"value\": \"\"\n }\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1963-08-12T14:54:43.321Z\",\n \"status\": 2878,\n \"message\": \"string\",\n \"error\": \"string\",\n \"path\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"084cb36b-b03d-4fbf-864d-43eb3e61da78","name":"Get rule","request":{"name":"Get rule","description":{"content":"Retrieves a rule.\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User\n\n**API key permission required:** `QUERY_RULES_SEARCH_CREATE`\n\n**User role permission required:** `assets_search: create`\n","type":"text/plain"},"url":{"path":["search","v2","indices",":indexId","rules",":ruleId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"indexId","description":"(Required) ID of the index"},{"disabled":false,"type":"any","value":"5612","key":"ruleId","description":"(Required) Rule identifier"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"689506b6-8bfa-4b9e-be46-fc581f335ccc","name":"Query rule returned","originalRequest":{"url":{"path":["search","v2","indices",":indexId","rules",":ruleId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"indexId","description":"(Required) ID of the index"},{"disabled":false,"type":"any","value":"5612","key":"ruleId","description":"(Required) Rule identifier"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"status\": \"string\",\n \"rule\": {\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"author\": {\n \"value\": \"\"\n },\n \"state\": {\n \"value\": \"\"\n },\n \"activeFrom\": {\n \"value\": \"\"\n },\n \"activeTo\": {\n \"value\": \"\"\n },\n \"timezone\": {\n \"value\": \"\"\n },\n \"updatedAt\": {\n \"value\": \"\"\n },\n \"createdAt\": {\n \"value\": \"\"\n },\n \"data\": {\n \"value\": \"\"\n },\n \"source\": {\n \"value\": \"\"\n }\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"2041c4f2-623f-45bf-bb9c-6ea883c500e2","name":"An error occurred","originalRequest":{"url":{"path":["search","v2","indices",":indexId","rules",":ruleId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"indexId","description":"(Required) ID of the index"},{"disabled":false,"type":"any","value":"5612","key":"ruleId","description":"(Required) Rule identifier"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1963-08-12T14:54:43.321Z\",\n \"status\": 2878,\n \"message\": \"string\",\n \"error\": \"string\",\n \"path\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"ba45cc9a-8894-437c-bd68-e498cfe19e3d","name":"Update query rule","request":{"name":"Update query rule","description":{"content":"Updates a rule identified by `id`.\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User\n\n**API key permission required:** `QUERY_RULES_SEARCH_UPDATE`\n\n**User role permission required:** `assets_search: update`\n","type":"text/plain"},"url":{"path":["search","v2","indices",":indexId","rules",":ruleId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"indexId","description":"(Required) ID of the index"},{"disabled":false,"type":"any","value":"5612","key":"ruleId","description":"(Required) Rule identifier"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PUT","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"name\": \"string\",\n \"author\": 1375,\n \"activeFrom\": \"string\",\n \"activeTo\": \"string\",\n \"timezone\": \"string\",\n \"data\": {\n \"conditions\": {\n \"value\": \"\"\n },\n \"queryConsequences\": {\n \"value\": \"\"\n },\n \"postQueryConsequences\": {\n \"value\": \"\"\n },\n \"audience\": {\n \"value\": \"\"\n }\n }\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"cc93c126-7480-492c-8c30-da60235a6933","name":"Query rule updated","originalRequest":{"url":{"path":["search","v2","indices",":indexId","rules",":ruleId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"indexId","description":"(Required) ID of the index"},{"disabled":false,"type":"any","value":"5612","key":"ruleId","description":"(Required) Rule identifier"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"{\n \"name\": \"string\",\n \"author\": 1375,\n \"activeFrom\": \"string\",\n \"activeTo\": \"string\",\n \"timezone\": \"string\",\n \"data\": {\n \"conditions\": {\n \"value\": \"\"\n },\n \"queryConsequences\": {\n \"value\": \"\"\n },\n \"postQueryConsequences\": {\n \"value\": \"\"\n },\n \"audience\": {\n \"value\": \"\"\n }\n }\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"status\": \"string\",\n \"rule\": {\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"author\": {\n \"value\": \"\"\n },\n \"state\": {\n \"value\": \"\"\n },\n \"activeFrom\": {\n \"value\": \"\"\n },\n \"activeTo\": {\n \"value\": \"\"\n },\n \"timezone\": {\n \"value\": \"\"\n },\n \"updatedAt\": {\n \"value\": \"\"\n },\n \"createdAt\": {\n \"value\": \"\"\n },\n \"data\": {\n \"value\": \"\"\n },\n \"source\": {\n \"value\": \"\"\n }\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"de3f39d2-b094-48d8-b810-aa65a2db5c29","name":"The rule is inherited from the parent index and cannot be modified on the child index","originalRequest":{"url":{"path":["search","v2","indices",":indexId","rules",":ruleId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"indexId","description":"(Required) ID of the index"},{"disabled":false,"type":"any","value":"5612","key":"ruleId","description":"(Required) Rule identifier"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"{\n \"name\": \"string\",\n \"author\": 1375,\n \"activeFrom\": \"string\",\n \"activeTo\": \"string\",\n \"timezone\": \"string\",\n \"data\": {\n \"conditions\": {\n \"value\": \"\"\n },\n \"queryConsequences\": {\n \"value\": \"\"\n },\n \"postQueryConsequences\": {\n \"value\": \"\"\n },\n \"audience\": {\n \"value\": \"\"\n }\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Conflict","code":409,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1963-08-12T14:54:43.321Z\",\n \"status\": 2878,\n \"message\": \"string\",\n \"error\": \"string\",\n \"path\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"b2628908-a5cd-4b34-94be-9dd356218a9e","name":"An error occurred","originalRequest":{"url":{"path":["search","v2","indices",":indexId","rules",":ruleId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"indexId","description":"(Required) ID of the index"},{"disabled":false,"type":"any","value":"5612","key":"ruleId","description":"(Required) Rule identifier"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"{\n \"name\": \"string\",\n \"author\": 1375,\n \"activeFrom\": \"string\",\n \"activeTo\": \"string\",\n \"timezone\": \"string\",\n \"data\": {\n \"conditions\": {\n \"value\": \"\"\n },\n \"queryConsequences\": {\n \"value\": \"\"\n },\n \"postQueryConsequences\": {\n \"value\": \"\"\n },\n \"audience\": {\n \"value\": \"\"\n }\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1963-08-12T14:54:43.321Z\",\n \"status\": 2878,\n \"message\": \"string\",\n \"error\": \"string\",\n \"path\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"ae54aacb-2896-499e-98eb-addecdb2ebaa","name":"Delete rule","request":{"name":"Delete rule","description":{"content":"Deletes a rule identified by `id`.\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User\n\n**API key permission required:** `QUERY_RULES_SEARCH_DELETE`\n\n**User role permission required:** `assets_search: delete`\n","type":"text/plain"},"url":{"path":["search","v2","indices",":indexId","rules",":ruleId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"indexId","description":"(Required) ID of the index"},{"disabled":false,"type":"any","value":"5612","key":"ruleId","description":"(Required) Rule identifier"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"3fa00802-03ad-4191-84cd-3d78982443c7","name":"Query rule deleted","originalRequest":{"url":{"path":["search","v2","indices",":indexId","rules",":ruleId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"indexId","description":"(Required) ID of the index"},{"disabled":false,"type":"any","value":"5612","key":"ruleId","description":"(Required) Rule identifier"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"DELETE","body":{}},"status":"No Content","code":204,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"686c7080-dd9c-4f55-8996-386fb462fa55","name":"The rule is inherited from the parent index and cannot be modified on the child index","originalRequest":{"url":{"path":["search","v2","indices",":indexId","rules",":ruleId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"indexId","description":"(Required) ID of the index"},{"disabled":false,"type":"any","value":"5612","key":"ruleId","description":"(Required) Rule identifier"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{}},"status":"Conflict","code":409,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1963-08-12T14:54:43.321Z\",\n \"status\": 2878,\n \"message\": \"string\",\n \"error\": \"string\",\n \"path\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"1dbba0ec-fe59-46e1-9d21-e376dba930ce","name":"An error occurred","originalRequest":{"url":{"path":["search","v2","indices",":indexId","rules",":ruleId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"indexId","description":"(Required) ID of the index"},{"disabled":false,"type":"any","value":"5612","key":"ruleId","description":"(Required) Rule identifier"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1963-08-12T14:54:43.321Z\",\n \"status\": 2878,\n \"message\": \"string\",\n \"error\": \"string\",\n \"path\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"f22ad7cf-0cab-46cc-bff9-6256adffa8d6","name":"Activate rule","request":{"name":"Activate rule","description":{"content":"Activates a rule identified by `id`.\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User\n\n**API key permission required:** `QUERY_RULES_SEARCH_UPDATE`\n\n**User role permission required:** `assets_search: update`\n","type":"text/plain"},"url":{"path":["search","v2","indices",":indexId","rules",":ruleId","activate"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"indexId","description":"(Required) ID of the index"},{"disabled":false,"type":"any","value":"5612","key":"ruleId","description":"(Required) Rule identifier"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"7e048065-320e-4285-a0d7-6ff998a35153","name":"Query rule activated","originalRequest":{"url":{"path":["search","v2","indices",":indexId","rules",":ruleId","activate"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"indexId","description":"(Required) ID of the index"},{"disabled":false,"type":"any","value":"5612","key":"ruleId","description":"(Required) Rule identifier"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"POST","body":{}},"status":"No Content","code":204,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"60040839-c141-4d1c-9e72-78e28a6d1697","name":"The rule is inherited from the parent index and cannot be modified on the child index","originalRequest":{"url":{"path":["search","v2","indices",":indexId","rules",":ruleId","activate"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"indexId","description":"(Required) ID of the index"},{"disabled":false,"type":"any","value":"5612","key":"ruleId","description":"(Required) Rule identifier"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"Conflict","code":409,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1963-08-12T14:54:43.321Z\",\n \"status\": 2878,\n \"message\": \"string\",\n \"error\": \"string\",\n \"path\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"f6e58ec6-1f2e-420b-8917-e6f69aa36b01","name":"An error occurred","originalRequest":{"url":{"path":["search","v2","indices",":indexId","rules",":ruleId","activate"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"indexId","description":"(Required) ID of the index"},{"disabled":false,"type":"any","value":"5612","key":"ruleId","description":"(Required) Rule identifier"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1963-08-12T14:54:43.321Z\",\n \"status\": 2878,\n \"message\": \"string\",\n \"error\": \"string\",\n \"path\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"54e58315-9ce4-4f05-bb87-b6793f5d34d3","name":"Pause rule","request":{"name":"Pause rule","description":{"content":"Pauses a rule identified by `id`.\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User\n\n**API key permission required:** `QUERY_RULES_SEARCH_UPDATE`\n\n**User role permission required:** `assets_search: update`\n","type":"text/plain"},"url":{"path":["search","v2","indices",":indexId","rules",":ruleId","pause"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"indexId","description":"(Required) ID of the index"},{"disabled":false,"type":"any","value":"5612","key":"ruleId","description":"(Required) Rule identifier"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"5b377735-ee29-4f2c-9b88-c40323e84c34","name":"Query rule paused","originalRequest":{"url":{"path":["search","v2","indices",":indexId","rules",":ruleId","pause"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"indexId","description":"(Required) ID of the index"},{"disabled":false,"type":"any","value":"5612","key":"ruleId","description":"(Required) Rule identifier"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"POST","body":{}},"status":"No Content","code":204,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"7e1dd46a-0c68-4907-817a-6e6e26221e99","name":"The rule is inherited from the parent index and cannot be modified on the child index","originalRequest":{"url":{"path":["search","v2","indices",":indexId","rules",":ruleId","pause"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"indexId","description":"(Required) ID of the index"},{"disabled":false,"type":"any","value":"5612","key":"ruleId","description":"(Required) Rule identifier"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"Conflict","code":409,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1963-08-12T14:54:43.321Z\",\n \"status\": 2878,\n \"message\": \"string\",\n \"error\": \"string\",\n \"path\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"d500515d-5d20-4cce-8f64-d3e9eb1e82c1","name":"An error occurred","originalRequest":{"url":{"path":["search","v2","indices",":indexId","rules",":ruleId","pause"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"indexId","description":"(Required) ID of the index"},{"disabled":false,"type":"any","value":"5612","key":"ruleId","description":"(Required) Rule identifier"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1963-08-12T14:54:43.321Z\",\n \"status\": 2878,\n \"message\": \"string\",\n \"error\": \"string\",\n \"path\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"a9c5856d-1741-4c78-808a-4f4564593c7e","name":"Draft rule","request":{"name":"Draft rule","description":{"content":"Marks a rule as draft.\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User\n\n**API key permission required:** `QUERY_RULES_SEARCH_UPDATE`\n\n**User role permission required:** `assets_search: update`\n","type":"text/plain"},"url":{"path":["search","v2","indices",":indexId","rules",":ruleId","draft"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"indexId","description":"(Required) ID of the index"},{"disabled":false,"type":"any","value":"5612","key":"ruleId","description":"(Required) Rule identifier"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"58cd1330-79ba-4e96-bb61-1712e486fc30","name":"Query rule marked as draft","originalRequest":{"url":{"path":["search","v2","indices",":indexId","rules",":ruleId","draft"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"indexId","description":"(Required) ID of the index"},{"disabled":false,"type":"any","value":"5612","key":"ruleId","description":"(Required) Rule identifier"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"POST","body":{}},"status":"No Content","code":204,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"bd1f496b-357c-4030-a656-f7036fe715ad","name":"The rule is inherited from the parent index and cannot be modified on the child index","originalRequest":{"url":{"path":["search","v2","indices",":indexId","rules",":ruleId","draft"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"indexId","description":"(Required) ID of the index"},{"disabled":false,"type":"any","value":"5612","key":"ruleId","description":"(Required) Rule identifier"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"Conflict","code":409,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1963-08-12T14:54:43.321Z\",\n \"status\": 2878,\n \"message\": \"string\",\n \"error\": \"string\",\n \"path\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"96aaaae1-2a62-448e-8d1e-8a7f8bd7e834","name":"An error occurred","originalRequest":{"url":{"path":["search","v2","indices",":indexId","rules",":ruleId","draft"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"indexId","description":"(Required) ID of the index"},{"disabled":false,"type":"any","value":"5612","key":"ruleId","description":"(Required) Rule identifier"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1963-08-12T14:54:43.321Z\",\n \"status\": 2878,\n \"message\": \"string\",\n \"error\": \"string\",\n \"path\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"c1ca9ab7-c6dc-4016-aea8-c7a5219535b1","name":"Finish rule","request":{"name":"Finish rule","description":{"content":"Marks a rule as finished. The rule becomes inactive and can never be activated again.\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User\n\n**API key permission required:** `QUERY_RULES_SEARCH_UPDATE`\n\n**User role permission required:** `assets_search: update`\n","type":"text/plain"},"url":{"path":["search","v2","indices",":indexId","rules",":ruleId","finish"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"indexId","description":"(Required) ID of the index"},{"disabled":false,"type":"any","value":"5612","key":"ruleId","description":"(Required) Rule identifier"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"397e6a23-6621-4d26-8493-424a9c9d69ad","name":"Query rule marked as finished","originalRequest":{"url":{"path":["search","v2","indices",":indexId","rules",":ruleId","finish"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"indexId","description":"(Required) ID of the index"},{"disabled":false,"type":"any","value":"5612","key":"ruleId","description":"(Required) Rule identifier"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"POST","body":{}},"status":"No Content","code":204,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"bf3a6a3d-a118-4e6d-bf5a-93dea9a229f1","name":"The rule is inherited from the parent index and cannot be modified on the child index","originalRequest":{"url":{"path":["search","v2","indices",":indexId","rules",":ruleId","finish"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"indexId","description":"(Required) ID of the index"},{"disabled":false,"type":"any","value":"5612","key":"ruleId","description":"(Required) Rule identifier"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"Conflict","code":409,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1963-08-12T14:54:43.321Z\",\n \"status\": 2878,\n \"message\": \"string\",\n \"error\": \"string\",\n \"path\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"41338ff2-a0ac-4fe1-aeb2-179f4db3e051","name":"An error occurred","originalRequest":{"url":{"path":["search","v2","indices",":indexId","rules",":ruleId","finish"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"indexId","description":"(Required) ID of the index"},{"disabled":false,"type":"any","value":"5612","key":"ruleId","description":"(Required) Rule identifier"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1963-08-12T14:54:43.321Z\",\n \"status\": 2878,\n \"message\": \"string\",\n \"error\": \"string\",\n \"path\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}],"event":[]},{"id":"7116a22b-7ee3-498a-a756-85f00b20f1eb","name":"Search Stats","description":{"content":"","type":"text/plain"},"item":[{"id":"1644c2de-fac5-4d60-b60f-328a38f26136","name":"Get queries stats summary","request":{"name":"Get queries stats summary","description":{"content":"Retrieves the statistics of all queries or a single query defined in the request.\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User\n\n**API key permission required:** `AI_STATS_READ`\n\n**User role permission required:** `assets_search: read`\n","type":"text/plain"},"url":{"path":["search","v2","indices",":indexId","stats","queries","summary"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"dateFrom","value":"1987-03-02","description":"Upper bound of the interval for which the statistics will be retrieved. \nMust be provided with `to`, otherwise the filter is treated as unspecified. \nIf not specified, the interval is last 7 days.\n"},{"disabled":false,"key":"dateTo","value":"1987-03-02","description":"Lower bound of the interval for which the statistics will be retrieved.\nIf not specified, the interval is last 7 days.\n"},{"disabled":false,"key":"query","value":"string","description":"Query for which stats will be returned. If not provided, the results are returned for the most popular queries."},{"disabled":false,"key":"searchType","value":"all","description":"Search type for which stats will be retrieved."},{"disabled":false,"key":"groupBy","value":"date","description":"Attribute for which retrieved stats will be grouped."}],"variable":[{"disabled":false,"type":"any","value":"4add1a1fa877c1651906bb22c9dfd37a1618852272","key":"indexId","description":"(Required) ID of the index for which the stats are requested"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"ac52f095-3929-44c1-b08b-f9d486fd17f5","name":"Statistics returned","originalRequest":{"url":{"path":["search","v2","indices",":indexId","stats","queries","summary"],"host":["{{baseUrl}}"],"query":[{"key":"dateFrom","value":"1987-03-02"},{"key":"dateTo","value":"1987-03-02"},{"key":"query","value":"string"},{"key":"searchType","value":"all"},{"key":"groupBy","value":"date"}],"variable":[{"disabled":false,"type":"any","value":"4add1a1fa877c1651906bb22c9dfd37a1618852272","key":"indexId","description":"(Required) ID of the index for which the stats are requested"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"data\": {\n \"averageClickPosition\": {\n \"value\": \"\"\n },\n \"averageOrderValue\": {\n \"value\": \"\"\n },\n \"clickThroughRate\": {\n \"value\": \"\"\n },\n \"conversionRate\": {\n \"value\": \"\"\n },\n \"conversions\": {\n \"value\": \"\"\n },\n \"noResultsCount\": {\n \"value\": \"\"\n },\n \"revenue\": {\n \"value\": \"\"\n },\n \"totalClicks\": {\n \"value\": \"\"\n },\n \"totalCount\": {\n \"value\": \"\"\n },\n \"totalSuggestionsUsed\": {\n \"value\": \"\"\n }\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"6d33b208-d9a4-42db-9e0e-604230741247","name":"Service error","originalRequest":{"url":{"path":["search","v2","indices",":indexId","stats","queries","summary"],"host":["{{baseUrl}}"],"query":[{"key":"dateFrom","value":"1987-03-02"},{"key":"dateTo","value":"1987-03-02"},{"key":"query","value":"string"},{"key":"searchType","value":"all"},{"key":"groupBy","value":"date"}],"variable":[{"disabled":false,"type":"any","value":"4add1a1fa877c1651906bb22c9dfd37a1618852272","key":"indexId","description":"(Required) ID of the index for which the stats are requested"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"httpStatus\": 500,\n \"errorCode\": 8992,\n \"timestamp\": \"1994-03-23T16:52:22.343Z\",\n \"message\": \"string\",\n \"traceId\": \"string\",\n \"help\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"ea5e84ce-aec2-43cd-8716-d0f6c7eefe4f","name":"Incorrect request","originalRequest":{"url":{"path":["search","v2","indices",":indexId","stats","queries","summary"],"host":["{{baseUrl}}"],"query":[{"key":"dateFrom","value":"1987-03-02"},{"key":"dateTo","value":"1987-03-02"},{"key":"query","value":"string"},{"key":"searchType","value":"all"},{"key":"groupBy","value":"date"}],"variable":[{"disabled":false,"type":"any","value":"4add1a1fa877c1651906bb22c9dfd37a1618852272","key":"indexId","description":"(Required) ID of the index for which the stats are requested"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"httpStatus\": 500,\n \"errorCode\": 8992,\n \"timestamp\": \"1994-03-23T16:52:22.343Z\",\n \"message\": \"string\",\n \"traceId\": \"string\",\n \"help\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"adca690b-93d9-48bd-9522-475e88a45ede","name":"Get top query statistics","request":{"name":"Get top query statistics","description":{"content":"Retrieves the 1000 most popular queries. \n\nIMPORTANT: Don't use this endpoint for displaying most popular queries to end users when they're searching. Instead, use [`search/v2/indices/{indexId}/list`](https://developers.synerise.com/AISearch/AISearch.html#operation/ListingGet), where `indexId` is a suggestion index.\n\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User, AI API key (legacy)\n\n**API key permission required:** `AI_STATS_READ`\n\n**User role permission required:** `assets_search: read`\n","type":"text/plain"},"url":{"path":["search","v2","indices",":indexId","stats","queries","top"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"dateFrom","value":"1987-03-02","description":"Upper bound of the interval for which the statistics will be retrieved. \nMust be provided with `to`, otherwise the filter is treated as unspecified. \nIf not specified, the interval is last 7 days.\n"},{"disabled":false,"key":"dateTo","value":"1987-03-02","description":"Lower bound of the interval for which the statistics will be retrieved.\nIf not specified, the interval is last 7 days.\n"},{"disabled":false,"key":"query","value":"string","description":"Query for which stats will be returned. If not provided, the results are returned for the most popular queries."},{"disabled":false,"key":"searchType","value":"all","description":"Search type for which stats will be retrieved."},{"disabled":false,"key":"queryFilter","value":"queries","description":"Queries for which stats will be retrieved."},{"disabled":false,"key":"groupBy","value":"date","description":"Attribute for which retrieved stats will be grouped."},{"disabled":false,"key":"withFilters","value":"false","description":"Switch to display search statistics with enabled filters or without filters."},{"disabled":false,"key":"SortBy","value":"count","description":"Field by which results should be sorted."},{"disabled":false,"key":"ordering","value":"desc","description":"Sort order direction."}],"variable":[{"disabled":false,"type":"any","value":"4add1a1fa877c1651906bb22c9dfd37a1618852272","key":"indexId","description":"(Required) ID of the index for which the stats are requested"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"cfd139a9-38b6-4424-abff-5661734c413f","name":"Statistics returned","originalRequest":{"url":{"path":["search","v2","indices",":indexId","stats","queries","top"],"host":["{{baseUrl}}"],"query":[{"key":"dateFrom","value":"1987-03-02"},{"key":"dateTo","value":"1987-03-02"},{"key":"query","value":"string"},{"key":"searchType","value":"all"},{"key":"queryFilter","value":"queries"},{"key":"groupBy","value":"date"},{"key":"withFilters","value":"false"},{"key":"SortBy","value":"count"},{"key":"ordering","value":"desc"}],"variable":[{"disabled":false,"type":"any","value":"4add1a1fa877c1651906bb22c9dfd37a1618852272","key":"indexId","description":"(Required) ID of the index for which the stats are requested"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"data\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"8dc3a81e-a852-46fc-ae74-a33aaecf5653","name":"Service error","originalRequest":{"url":{"path":["search","v2","indices",":indexId","stats","queries","top"],"host":["{{baseUrl}}"],"query":[{"key":"dateFrom","value":"1987-03-02"},{"key":"dateTo","value":"1987-03-02"},{"key":"query","value":"string"},{"key":"searchType","value":"all"},{"key":"queryFilter","value":"queries"},{"key":"groupBy","value":"date"},{"key":"withFilters","value":"false"},{"key":"SortBy","value":"count"},{"key":"ordering","value":"desc"}],"variable":[{"disabled":false,"type":"any","value":"4add1a1fa877c1651906bb22c9dfd37a1618852272","key":"indexId","description":"(Required) ID of the index for which the stats are requested"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"httpStatus\": 500,\n \"errorCode\": 8992,\n \"timestamp\": \"1994-03-23T16:52:22.343Z\",\n \"message\": \"string\",\n \"traceId\": \"string\",\n \"help\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"cc999499-b832-4197-afca-3a2593e55ba4","name":"Incorrect request","originalRequest":{"url":{"path":["search","v2","indices",":indexId","stats","queries","top"],"host":["{{baseUrl}}"],"query":[{"key":"dateFrom","value":"1987-03-02"},{"key":"dateTo","value":"1987-03-02"},{"key":"query","value":"string"},{"key":"searchType","value":"all"},{"key":"queryFilter","value":"queries"},{"key":"groupBy","value":"date"},{"key":"withFilters","value":"false"},{"key":"SortBy","value":"count"},{"key":"ordering","value":"desc"}],"variable":[{"disabled":false,"type":"any","value":"4add1a1fa877c1651906bb22c9dfd37a1618852272","key":"indexId","description":"(Required) ID of the index for which the stats are requested"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"httpStatus\": 500,\n \"errorCode\": 8992,\n \"timestamp\": \"1994-03-23T16:52:22.343Z\",\n \"message\": \"string\",\n \"traceId\": \"string\",\n \"help\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"484fce4d-8f36-4d4b-a183-147ffff76710","name":"Get filters stats","request":{"name":"Get filters stats","description":{"content":"Retrieves the statistics of filters used in searches.\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User\n\n**API key permission required:** `AI_STATS_READ`\n\n**User role permission required:** `assets_search: read`\n","type":"text/plain"},"url":{"path":["search","v2","indices",":indexId","stats","filters","summary"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"filterName","value":"brand","description":"Name of the filterable attribute. If present top values of this filter are returned."},{"disabled":false,"key":"dateFrom","value":"1987-03-02","description":"Upper bound of the interval for which the statistics will be retrieved. \nMust be provided with `to`, otherwise the filter is treated as unspecified. \nIf not specified, the interval is last 7 days.\n"},{"disabled":false,"key":"dateTo","value":"1987-03-02","description":"Lower bound of the interval for which the statistics will be retrieved.\nIf not specified, the interval is last 7 days.\n"},{"disabled":false,"key":"groupBy","value":"date","description":"Attribute for which retrieved stats will be grouped."},{"disabled":false,"key":"ordering","value":"desc","description":"Sort order direction."}],"variable":[{"disabled":false,"type":"any","value":"4add1a1fa877c1651906bb22c9dfd37a1618852272","key":"indexId","description":"(Required) ID of the index for which the stats are requested"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"0ee1d3cb-7e26-43d6-8d69-616dc288f1e5","name":"Statistics returned","originalRequest":{"url":{"path":["search","v2","indices",":indexId","stats","filters","summary"],"host":["{{baseUrl}}"],"query":[{"key":"filterName","value":"brand"},{"key":"dateFrom","value":"1987-03-02"},{"key":"dateTo","value":"1987-03-02"},{"key":"groupBy","value":"date"},{"key":"ordering","value":"desc"}],"variable":[{"disabled":false,"type":"any","value":"4add1a1fa877c1651906bb22c9dfd37a1618852272","key":"indexId","description":"(Required) ID of the index for which the stats are requested"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"data\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"be310890-c87b-4b86-a45c-09b74a7cad3a","name":"Service error","originalRequest":{"url":{"path":["search","v2","indices",":indexId","stats","filters","summary"],"host":["{{baseUrl}}"],"query":[{"key":"filterName","value":"brand"},{"key":"dateFrom","value":"1987-03-02"},{"key":"dateTo","value":"1987-03-02"},{"key":"groupBy","value":"date"},{"key":"ordering","value":"desc"}],"variable":[{"disabled":false,"type":"any","value":"4add1a1fa877c1651906bb22c9dfd37a1618852272","key":"indexId","description":"(Required) ID of the index for which the stats are requested"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"httpStatus\": 500,\n \"errorCode\": 8992,\n \"timestamp\": \"1994-03-23T16:52:22.343Z\",\n \"message\": \"string\",\n \"traceId\": \"string\",\n \"help\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"aa78b3f7-1090-4088-b030-2c5b2b6be85f","name":"Incorrect request","originalRequest":{"url":{"path":["search","v2","indices",":indexId","stats","filters","summary"],"host":["{{baseUrl}}"],"query":[{"key":"filterName","value":"brand"},{"key":"dateFrom","value":"1987-03-02"},{"key":"dateTo","value":"1987-03-02"},{"key":"groupBy","value":"date"},{"key":"ordering","value":"desc"}],"variable":[{"disabled":false,"type":"any","value":"4add1a1fa877c1651906bb22c9dfd37a1618852272","key":"indexId","description":"(Required) ID of the index for which the stats are requested"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"httpStatus\": 500,\n \"errorCode\": 8992,\n \"timestamp\": \"1994-03-23T16:52:22.343Z\",\n \"message\": \"string\",\n \"traceId\": \"string\",\n \"help\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"b4b5763b-3dde-4611-be25-da1c7ed02dbc","name":"Get rules stats","request":{"name":"Get rules stats","description":{"content":"Retrieves the statistics of applied rules.\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User\n\n**API key permission required:** `AI_STATS_READ`\n\n**User role permission required:** `assets_search: read`\n","type":"text/plain"},"url":{"path":["search","v2","indices",":indexId","stats","rules","summary"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"dateFrom","value":"1987-03-02","description":"Upper bound of the interval for which the statistics will be retrieved. \nMust be provided with `to`, otherwise the filter is treated as unspecified. \nIf not specified, the interval is last 7 days.\n"},{"disabled":false,"key":"dateTo","value":"1987-03-02","description":"Lower bound of the interval for which the statistics will be retrieved.\nIf not specified, the interval is last 7 days.\n"},{"disabled":false,"key":"groupBy","value":"date","description":"Attribute for which retrieved stats will be grouped."}],"variable":[{"disabled":false,"type":"any","value":"4add1a1fa877c1651906bb22c9dfd37a1618852272","key":"indexId","description":"(Required) ID of the index for which the stats are requested"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"4af23cd1-b474-478d-99ec-feeae0702438","name":"Statistics returned","originalRequest":{"url":{"path":["search","v2","indices",":indexId","stats","rules","summary"],"host":["{{baseUrl}}"],"query":[{"key":"dateFrom","value":"1987-03-02"},{"key":"dateTo","value":"1987-03-02"},{"key":"groupBy","value":"date"}],"variable":[{"disabled":false,"type":"any","value":"4add1a1fa877c1651906bb22c9dfd37a1618852272","key":"indexId","description":"(Required) ID of the index for which the stats are requested"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"data\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"496fe3f6-0b45-4811-8976-3da9fe7cac8f","name":"Service error","originalRequest":{"url":{"path":["search","v2","indices",":indexId","stats","rules","summary"],"host":["{{baseUrl}}"],"query":[{"key":"dateFrom","value":"1987-03-02"},{"key":"dateTo","value":"1987-03-02"},{"key":"groupBy","value":"date"}],"variable":[{"disabled":false,"type":"any","value":"4add1a1fa877c1651906bb22c9dfd37a1618852272","key":"indexId","description":"(Required) ID of the index for which the stats are requested"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"httpStatus\": 500,\n \"errorCode\": 8992,\n \"timestamp\": \"1994-03-23T16:52:22.343Z\",\n \"message\": \"string\",\n \"traceId\": \"string\",\n \"help\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"654d9c69-dd71-41cd-95cd-62938bc29dce","name":"Incorrect request","originalRequest":{"url":{"path":["search","v2","indices",":indexId","stats","rules","summary"],"host":["{{baseUrl}}"],"query":[{"key":"dateFrom","value":"1987-03-02"},{"key":"dateTo","value":"1987-03-02"},{"key":"groupBy","value":"date"}],"variable":[{"disabled":false,"type":"any","value":"4add1a1fa877c1651906bb22c9dfd37a1618852272","key":"indexId","description":"(Required) ID of the index for which the stats are requested"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"httpStatus\": 500,\n \"errorCode\": 8992,\n \"timestamp\": \"1994-03-23T16:52:22.343Z\",\n \"message\": \"string\",\n \"traceId\": \"string\",\n \"help\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"f1d0f064-0de8-4b11-91a0-f662e2c58a09","name":"Get queries summary for multiple indices","request":{"name":"Get queries summary for multiple indices","description":{"content":"Retrieves the statistics of all queries or a single query defined in the request for multiple indices.\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User\n\n**API key permission required:** `AI_STATS_READ`\n\n**User role permission required:** `assets_search: read`\n","type":"text/plain"},"url":{"path":["search","v2","indices","stats","queries","summary"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"indexId","value":"string","description":"(Required) List of indices ids for which the stats are requested."},{"disabled":false,"key":"indexId","value":"string","description":"(Required) List of indices ids for which the stats are requested."},{"disabled":false,"key":"dateFrom","value":"1987-03-02","description":"Upper bound of the interval for which the statistics will be retrieved. \nMust be provided with `to`, otherwise the filter is treated as unspecified. \nIf not specified, the interval is last 7 days.\n"},{"disabled":false,"key":"dateTo","value":"1987-03-02","description":"Lower bound of the interval for which the statistics will be retrieved.\nIf not specified, the interval is last 7 days.\n"},{"disabled":false,"key":"query","value":"string","description":"Query for which stats will be returned. If not provided, the results are returned for the most popular queries."},{"disabled":false,"key":"searchType","value":"all","description":"Search type for which stats will be retrieved."},{"disabled":false,"key":"groupBy","value":"date","description":"Attribute for which retrieved stats will be grouped."}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"1090daf6-06b0-4bea-8a09-c38ec79dcbaf","name":"Statistics returned","originalRequest":{"url":{"path":["search","v2","indices","stats","queries","summary"],"host":["{{baseUrl}}"],"query":[{"key":"indexId","value":"string"},{"key":"indexId","value":"string"},{"key":"dateFrom","value":"1987-03-02"},{"key":"dateTo","value":"1987-03-02"},{"key":"query","value":"string"},{"key":"searchType","value":"all"},{"key":"groupBy","value":"date"}],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"data\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"79d43f14-e126-41f2-a4ac-86c9ac4c8422","name":"Service error","originalRequest":{"url":{"path":["search","v2","indices","stats","queries","summary"],"host":["{{baseUrl}}"],"query":[{"key":"indexId","value":"string"},{"key":"indexId","value":"string"},{"key":"dateFrom","value":"1987-03-02"},{"key":"dateTo","value":"1987-03-02"},{"key":"query","value":"string"},{"key":"searchType","value":"all"},{"key":"groupBy","value":"date"}],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"httpStatus\": 500,\n \"errorCode\": 8992,\n \"timestamp\": \"1994-03-23T16:52:22.343Z\",\n \"message\": \"string\",\n \"traceId\": \"string\",\n \"help\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"7340923c-3f6c-449c-9936-31cef13860ec","name":"Incorrect request","originalRequest":{"url":{"path":["search","v2","indices","stats","queries","summary"],"host":["{{baseUrl}}"],"query":[{"key":"indexId","value":"string"},{"key":"indexId","value":"string"},{"key":"dateFrom","value":"1987-03-02"},{"key":"dateTo","value":"1987-03-02"},{"key":"query","value":"string"},{"key":"searchType","value":"all"},{"key":"groupBy","value":"date"}],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"httpStatus\": 500,\n \"errorCode\": 8992,\n \"timestamp\": \"1994-03-23T16:52:22.343Z\",\n \"message\": \"string\",\n \"traceId\": \"string\",\n \"help\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}],"event":[]},{"id":"bde2b4b5-ce94-410b-a9c9-4a9c7e717d7a","name":"Promotions","description":{"content":"","type":"text/plain"},"item":[{"id":"db106571-f7c9-4447-93a0-26115c2389b7","name":"Get a Profile's promotions as Profile","request":{"name":"Get a Profile's promotions as Profile","description":{"content":"A Profile can retrieve a list of all its promotions, assigned or activated. By default, only non-expired promotions are retrieved.\n\n**IMPORTANT**: \n- As a result of this request, the `targetSegments` of all the matching promotions are checked. If this results in checking more than 100 unique segments, any segments above this limit may be ignored.\n- The endpoint is limited to 25000 requests per minute (per workspace).\n\n\n---\n\n**API consumers:** Profile (Client), Anonymous Profile\n","type":"text/plain"},"url":{"path":["v4","promotions","promotion","get-for-client"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"sort","value":"requireRedeemedPoints,desc","description":"The sorting order of the response.\n\n\n You can sort by any combination of the following attributes:\n * `headerName`: promotion header name\n * `name`: promotion name\n * `code`: promotion code\n * `startAt`: time when the promotion starts\n * `createdAt`: time when the promotion was created\n * `updatedAt`: time when the promotion was last updated\n * `expireAt`: time when the promotion expires\n * `requireRedeemedPoints`: how many loyalty points are needed to redeem the promotion\n * `type`: type of the promotion\n * `priority`: priority of the promotion\n * `status` : status of the promotion for the Profile\n\n You can sort ascending (default) or descending by adding `asc` or `desc` after the parameter, separated by a comma.\n\n **Example**: `sort=requireRedeemedPoints&sort=expireAt,asc&sort=status,desc`\n"},{"disabled":false,"key":"status","value":"REDEEMED,ACTIVE","description":"Filter by promotion status"},{"disabled":false,"key":"presentOnly","value":"true","description":"When set to:\n- `true`, the response includes only promotions that are currently active (startAt later than now or null, expireAt later than now or null)\n- `false`, the response includes the above and also promotions that are expired or will become active in the future.\n"},{"disabled":false,"key":"displayableOnly","value":"true","description":"When set to `true`, promotions which are not currently active are included in response, according to date range defined in promotion fields `displayFrom` and `displayTo`."},{"disabled":false,"key":"tagNames","value":"string,string","description":"Filter the response to promotions with a certain tag or tags"},{"disabled":false,"key":"limit","value":"100","description":"The number of items to return per page"},{"disabled":false,"key":"page","value":"4","description":"Page number to return for pagination. The first page has the index `1`."},{"disabled":false,"key":"includeMeta","value":"false","description":"\nWhen `true`, pagination metadata is included in the response body.\n\nWhen `false`, the data is included in the response headers:\n\n- Link: links to neighbors, first, and last pages in pagination.\n\n- X-Pagination-Total-Count: total number of items on all pages\n\n- X-Pagination-Total-Pages: total number of pages\n\n- X-Pagination-Page: current page\n\n- X-Pagination-Limit: maximum number of items on a page\n"},{"disabled":false,"key":"checkGlobalActivationLimits","value":"true","description":"Flag to indicate if global limits should be checked"},{"disabled":false,"key":"includeVouchers","value":"false","description":"\nWhen `true`, promotion with defined vouchers will also have list of assigned vouchers.\n\nWhen `false`, vouchers will not be fetched.\n"},{"disabled":false,"key":"storeIds","value":"string","description":"Limits the response to data from particular stores, identified by IDs."}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"ed57a35e-d360-4118-bd57-dd72104def36","name":"An array of promotions","originalRequest":{"url":{"path":["v4","promotions","promotion","get-for-client"],"host":["{{baseUrl}}"],"query":[{"key":"sort","value":"requireRedeemedPoints,desc"},{"key":"status","value":"REDEEMED,ACTIVE"},{"key":"presentOnly","value":"true"},{"key":"displayableOnly","value":"true"},{"key":"tagNames","value":"string,string"},{"key":"limit","value":"100"},{"key":"page","value":"4"},{"key":"includeMeta","value":"false"},{"key":"checkGlobalActivationLimits","value":"true"},{"key":"includeVouchers","value":"false"},{"key":"storeIds","value":"string"}],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"data\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"meta\": {\n \"code\": {\n \"value\": \"\"\n },\n \"limit\": {\n \"value\": \"\"\n },\n \"link\": {\n \"value\": \"\"\n },\n \"page\": {\n \"value\": \"\"\n },\n \"totalCount\": {\n \"value\": \"\"\n },\n \"totalPages\": {\n \"value\": \"\"\n }\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"11732684-a958-439e-adc7-66144825b67f","name":"Request body invalid/malformed/missing elements","originalRequest":{"url":{"path":["v4","promotions","promotion","get-for-client"],"host":["{{baseUrl}}"],"query":[{"key":"sort","value":"requireRedeemedPoints,desc"},{"key":"status","value":"REDEEMED,ACTIVE"},{"key":"presentOnly","value":"true"},{"key":"displayableOnly","value":"true"},{"key":"tagNames","value":"string,string"},{"key":"limit","value":"100"},{"key":"page","value":"4"},{"key":"includeMeta","value":"false"},{"key":"checkGlobalActivationLimits","value":"true"},{"key":"includeVouchers","value":"false"},{"key":"storeIds","value":"string"}],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"message\": {\n \"value\": \"\"\n },\n \"error\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"866ea3e4-72d7-4a17-aebc-25aae69bf541","name":"Unauthorized","originalRequest":{"url":{"path":["v4","promotions","promotion","get-for-client"],"host":["{{baseUrl}}"],"query":[{"key":"sort","value":"requireRedeemedPoints,desc"},{"key":"status","value":"REDEEMED,ACTIVE"},{"key":"presentOnly","value":"true"},{"key":"displayableOnly","value":"true"},{"key":"tagNames","value":"string,string"},{"key":"limit","value":"100"},{"key":"page","value":"4"},{"key":"includeMeta","value":"false"},{"key":"checkGlobalActivationLimits","value":"true"},{"key":"includeVouchers","value":"false"},{"key":"storeIds","value":"string"}],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"status\": 7751,\n \"error\": \"string\",\n \"message\": \"string\",\n \"timestamp\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"a607b02d-0bfe-4020-95de-5d71c0df8706","name":"Forbidden","originalRequest":{"url":{"path":["v4","promotions","promotion","get-for-client"],"host":["{{baseUrl}}"],"query":[{"key":"sort","value":"requireRedeemedPoints,desc"},{"key":"status","value":"REDEEMED,ACTIVE"},{"key":"presentOnly","value":"true"},{"key":"displayableOnly","value":"true"},{"key":"tagNames","value":"string,string"},{"key":"limit","value":"100"},{"key":"page","value":"4"},{"key":"includeMeta","value":"false"},{"key":"checkGlobalActivationLimits","value":"true"},{"key":"includeVouchers","value":"false"},{"key":"storeIds","value":"string"}],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"status\": 7751,\n \"error\": \"string\",\n \"message\": \"string\",\n \"timestamp\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"f8c077e8-bbed-48eb-9d04-23701f54e7f9","name":"Duplicate existing promotion","request":{"name":"Duplicate existing promotion","description":{"content":"You can duplicate an existing promotion.\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `PROMOTIONS_DUPLICATE_PROMOTIONS_CREATE`\n\n**User role permission required:** `campaigns_promotions: create`\n","type":"text/plain"},"url":{"path":["v4","promotions","promotion","duplicate"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":null,"body":{"mode":"raw","raw":"{\n \"uuid\": \"string\",\n \"code\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"a89d0f03-0ecb-4897-8578-8124a9805d0f","name":"Promotion duplicated","originalRequest":{"url":{"path":["v4","promotions","promotion","duplicate"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"uuid\": \"string\",\n \"code\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"uuid\": \"string\",\n \"code\": \"string\",\n \"status\": \"DRAFT\",\n \"type\": \"GENERAL\",\n \"redeemLimitPerClient\": 0,\n \"redeemQuantityPerActivation\": 6013467,\n \"redeemLimitGlobal\": 0,\n \"activationLimitGlobalType\": \"LIFETIME\",\n \"activationLimitGlobalLimit\": 372893468,\n \"activationLimitGlobalCounter\": 9174,\n \"activationLimitGlobalRelativeMinutes\": null,\n \"activationLimitGlobalReached\": null,\n \"redeemType\": \"FULL\",\n \"discountType\": \"NONE\",\n \"details\": {\n \"discountType\": {\n \"value\": \"\"\n },\n \"cashbackSettings\": {\n \"value\": \"\"\n }\n },\n \"discountValue\": 0,\n \"discountMode\": \"STATIC\",\n \"discountModeDetails\": {\n \"steps\": {\n \"value\": \"\"\n },\n \"discountUsageTrigger\": {\n \"value\": \"\"\n }\n },\n \"preDiscountValue\": 0,\n \"requireRedeemedPoints\": 8647.821074775815,\n \"headerName\": \"string\",\n \"headerDescription\": \"string\",\n \"name\": \"string\",\n \"headline\": \"string\",\n \"description\": \"string\",\n \"images\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"tags\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"createdAt\": \"1956-03-07T14:17:29.341Z\",\n \"startAt\": \"2017-04-05T05:46:24.084Z\",\n \"expireAt\": \"2007-05-29T07:17:21.073Z\",\n \"displayFrom\": \"string\",\n \"displayTo\": \"string\",\n \"lastingTime\": 0,\n \"params\": {\n \"key_0\": 9869\n },\n \"itemScope\": \"LINE_ITEM\",\n \"minBasketValue\": null,\n \"maxBasketValue\": null,\n \"catalog\": \"221\",\n \"catalogItemType\": \"FILTERED\",\n \"catalogFilterIds\": [\n \"f978b20f-7156-40ed-99c2-3af62b76af12\"\n ],\n \"catalogFilterQuery\": \"color==green;price=lt=100\",\n \"storeCatalog\": \"string\",\n \"storeItemType\": \"ALL\",\n \"storeIds\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"targetType\": \"ALL\",\n \"targetSegment\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"behavioralFilter\": \"productbuyhistory=has='sku=in=(SKU123);ts=rolling=30d'\",\n \"price\": 0,\n \"priority\": 250,\n \"metric\": \"string\",\n \"importHash\": \"dc0c7dd9-b445-1809-514a-d7c0ab7f07b6\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"d727b54b-3727-4172-8a7e-1df1d5deb3bc","name":"Unauthorized","originalRequest":{"url":{"path":["v4","promotions","promotion","duplicate"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"uuid\": \"string\",\n \"code\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"status\": 7751,\n \"error\": \"string\",\n \"message\": \"string\",\n \"timestamp\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"be8c7802-519d-45ca-91d2-2e18a529dcc2","name":"Forbidden","originalRequest":{"url":{"path":["v4","promotions","promotion","duplicate"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"uuid\": \"string\",\n \"code\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"status\": 7751,\n \"error\": \"string\",\n \"message\": \"string\",\n \"timestamp\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"44ed9d11-908e-47f5-aa96-e27cbc85ec5f","name":"Promotion not found","originalRequest":{"url":{"path":["v4","promotions","promotion","duplicate"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"uuid\": \"string\",\n \"code\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"message\": \"Promotion not found\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"7530a5b2-22d6-4281-b1fa-3aebad7441ae","name":"Internal Server Error","originalRequest":{"url":{"path":["v4","promotions","promotion","duplicate"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"method":"POST","body":{"mode":"raw","raw":"{\n \"uuid\": \"string\",\n \"code\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"ccdb004b-065e-43e2-a164-bfe8b6c0c459","name":"Activate a promotion","request":{"name":"Activate a promotion","description":{"content":"A Profile can change the status of a promotion from `assigned` to `active`, the promotion can now be applied to a purchase.\n\n---\n\n**API consumers:** Profile (Client), Anonymous Profile\n","type":"text/plain"},"url":{"path":["v4","promotions","promotion","activate"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"key\": \"code\",\n \"value\": \"7893467834GG\",\n \"pointsToUse\": 100\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"3d1c8137-d83b-4e3f-9442-162fc2583961","name":"Promotion activated","originalRequest":{"url":{"path":["v4","promotions","promotion","activate"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"key\": \"code\",\n \"value\": \"7893467834GG\",\n \"pointsToUse\": 100\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"uuid\": \"string\",\n \"code\": \"string\",\n \"status\": \"REDEEMED\",\n \"type\": \"GENERAL\",\n \"redeemLimitPerClient\": 0,\n \"redeemQuantityPerActivation\": 7896328,\n \"currentRedeemedQuantity\": 9741,\n \"currentRedeemedLimit\": 2273,\n \"activationCounter\": 7479,\n \"possibleRedeems\": 1967,\n \"details\": {\n \"discountType\": {\n \"value\": \"\"\n }\n },\n \"discountType\": \"NONE\",\n \"discountValue\": 0,\n \"discountMode\": \"STATIC\",\n \"discountModeDetails\": {\n \"steps\": {\n \"value\": \"\"\n },\n \"discountUsageTrigger\": {\n \"value\": \"\"\n }\n },\n \"requireRedeemedPoints\": 3693.8440305836784,\n \"name\": \"string\",\n \"headline\": \"string\",\n \"description\": \"string\",\n \"images\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"tags\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"startAt\": \"2010-08-19T14:38:35.118Z\",\n \"expireAt\": \"1953-02-22T19:59:36.495Z\",\n \"displayFrom\": \"string\",\n \"displayTo\": \"string\",\n \"assignedAt\": \"1995-03-24T14:43:58.127Z\",\n \"lastingTime\": 0,\n \"lastingAt\": \"2023-12-16T00:25:41.532Z\",\n \"params\": {\n \"key_0\": 933.4623360965566,\n \"key_1\": 6235.16372017178,\n \"key_2\": true\n },\n \"price\": 0,\n \"priority\": 250,\n \"itemScope\": \"LINE_ITEM\",\n \"minBasketValue\": null,\n \"maxBasketValue\": null,\n \"vouchers\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"extra\": {\n \"slot\": 6477,\n \"assignmentSource\": \"ai_relaxed_filter\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"45edfdb2-7b1c-4724-901f-b8336d7d41ab","name":"Request body invalid/malformed/missing elements","originalRequest":{"url":{"path":["v4","promotions","promotion","activate"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"key\": \"code\",\n \"value\": \"7893467834GG\",\n \"pointsToUse\": 100\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"message\": {\n \"value\": \"\"\n },\n \"error\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"3ea101b7-8d56-4aed-8915-d3f2ef7a82ee","name":"Unauthorized","originalRequest":{"url":{"path":["v4","promotions","promotion","activate"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"key\": \"code\",\n \"value\": \"7893467834GG\",\n \"pointsToUse\": 100\n}","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"status\": 7751,\n \"error\": \"string\",\n \"message\": \"string\",\n \"timestamp\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"b68276fd-b2b1-4b03-b369-6aa95dc7596b","name":"Forbidden","originalRequest":{"url":{"path":["v4","promotions","promotion","activate"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"key\": \"code\",\n \"value\": \"7893467834GG\",\n \"pointsToUse\": 100\n}","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"status\": 7751,\n \"error\": \"string\",\n \"message\": \"string\",\n \"timestamp\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"3c8f106e-c8f0-459e-a202-7acaccce0d61","name":"Profile, promotion, or related resource not found","originalRequest":{"url":{"path":["v4","promotions","promotion","activate"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"key\": \"code\",\n \"value\": \"7893467834GG\",\n \"pointsToUse\": 100\n}","options":{"raw":{"language":"json"}}}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"message\": \"string\",\n \"error\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"eb9d1aa2-e0a1-43f4-ba00-d848922372db","name":"Waiting for profile lock release","originalRequest":{"url":{"path":["v4","promotions","promotion","activate"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"key\": \"code\",\n \"value\": \"7893467834GG\",\n \"pointsToUse\": 100\n}","options":{"raw":{"language":"json"}}}},"status":"Conflict","code":409,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"message\": \"string\",\n \"error\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"c825eada-6a83-47d0-8e20-340291d84722","name":"Already activated/Already redeemed/Activation limit reached/Promotion not started/Promotion expired","originalRequest":{"url":{"path":["v4","promotions","promotion","activate"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"key\": \"code\",\n \"value\": \"7893467834GG\",\n \"pointsToUse\": 100\n}","options":{"raw":{"language":"json"}}}},"status":"Precondition Failed","code":412,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"message\": \"string\",\n \"error\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"3c8520c4-db13-44d6-84fe-47fb2c1d9a5a","name":"Global Activation limit reached","originalRequest":{"url":{"path":["v4","promotions","promotion","activate"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"key\": \"code\",\n \"value\": \"7893467834GG\",\n \"pointsToUse\": 100\n}","options":{"raw":{"language":"json"}}}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"message\": \"string\",\n \"error\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"ede2a7d2-ca23-4a6b-b263-cf23c6529a7e","name":"Profile promotions blocked","originalRequest":{"url":{"path":["v4","promotions","promotion","activate"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"key\": \"code\",\n \"value\": \"7893467834GG\",\n \"pointsToUse\": 100\n}","options":{"raw":{"language":"json"}}}},"status":"Locked (WebDAV) (RFC 4918)","code":423,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"message\": \"string\",\n \"error\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"4ca4f0e5-454b-46cf-b61a-2971122e790c","name":"General error","originalRequest":{"url":{"path":["v4","promotions","promotion","activate"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"POST","body":{"mode":"raw","raw":"{\n \"key\": \"code\",\n \"value\": \"7893467834GG\",\n \"pointsToUse\": 100\n}","options":{"raw":{"language":"json"}}}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"559a3c60-6063-414f-92ff-f52f45eb0fee","name":"Batch activate promotions","request":{"name":"Batch activate promotions","description":{"content":"A Profile can change the status of a number of promotions from `assigned` to `active`, the promotion can now be applied to a purchase.\nThis method **can't be used to activate promotions which require voucher assignment**. You need to activate such promotions individually.\n\n---\n\n**API consumers:** Profile (Client), Anonymous Profile\n","type":"text/plain"},"url":{"path":["v4","promotions","promotion","batch-activate"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"[\n {\n \"key\": \"code\",\n \"value\": \"7893467834GG\",\n \"pointsToUse\": 100\n }\n]","options":{"raw":{"language":"json"}}}},"response":[{"id":"f7941e07-9934-433e-9a12-d09bdfee3d7e","name":"Promotions activated","originalRequest":{"url":{"path":["v4","promotions","promotion","batch-activate"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"[\n {\n \"key\": \"code\",\n \"value\": \"7893467834GG\",\n \"pointsToUse\": 100\n }\n]","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{}","cookie":[],"_postman_previewlanguage":"json"},{"id":"c6232243-51b5-4312-81d5-27221f72b0fd","name":"Request body invalid/malformed/missing elements","originalRequest":{"url":{"path":["v4","promotions","promotion","batch-activate"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"[\n {\n \"key\": \"code\",\n \"value\": \"7893467834GG\",\n \"pointsToUse\": 100\n }\n]","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"message\": {\n \"value\": \"\"\n },\n \"error\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"7e449498-2ba5-49e0-9f4a-6ddb175bc432","name":"Unauthorized","originalRequest":{"url":{"path":["v4","promotions","promotion","batch-activate"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"[\n {\n \"key\": \"code\",\n \"value\": \"7893467834GG\",\n \"pointsToUse\": 100\n }\n]","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"status\": 7751,\n \"error\": \"string\",\n \"message\": \"string\",\n \"timestamp\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"a59fa1c7-6835-4fb7-8dff-5b705b65a68d","name":"Forbidden","originalRequest":{"url":{"path":["v4","promotions","promotion","batch-activate"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"[\n {\n \"key\": \"code\",\n \"value\": \"7893467834GG\",\n \"pointsToUse\": 100\n }\n]","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"status\": 7751,\n \"error\": \"string\",\n \"message\": \"string\",\n \"timestamp\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"1a59b261-7afa-418d-9c0c-7148630893af","name":"Profile, promotion, or related resource not found","originalRequest":{"url":{"path":["v4","promotions","promotion","batch-activate"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"[\n {\n \"key\": \"code\",\n \"value\": \"7893467834GG\",\n \"pointsToUse\": 100\n }\n]","options":{"raw":{"language":"json"}}}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"message\": \"string\",\n \"error\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"2a7a6d23-ec80-48b5-80c4-5851b159c2de","name":"Waiting for profile lock release","originalRequest":{"url":{"path":["v4","promotions","promotion","batch-activate"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"[\n {\n \"key\": \"code\",\n \"value\": \"7893467834GG\",\n \"pointsToUse\": 100\n }\n]","options":{"raw":{"language":"json"}}}},"status":"Conflict","code":409,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"message\": \"string\",\n \"error\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"7ff7ffca-97bd-4e5d-9ba7-c273a0562470","name":"Already activated/Already redeemed/Activation limit reached/Promotion not started/Promotion expired","originalRequest":{"url":{"path":["v4","promotions","promotion","batch-activate"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"[\n {\n \"key\": \"code\",\n \"value\": \"7893467834GG\",\n \"pointsToUse\": 100\n }\n]","options":{"raw":{"language":"json"}}}},"status":"Precondition Failed","code":412,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"message\": \"string\",\n \"error\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"cc599d8e-08fa-42a9-b0a2-f7f92c9a70a7","name":"Profile promotions blocked","originalRequest":{"url":{"path":["v4","promotions","promotion","batch-activate"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"[\n {\n \"key\": \"code\",\n \"value\": \"7893467834GG\",\n \"pointsToUse\": 100\n }\n]","options":{"raw":{"language":"json"}}}},"status":"Locked (WebDAV) (RFC 4918)","code":423,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"message\": \"string\",\n \"error\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"67c08b24-d703-4a3d-b4e0-f7ec18368a6c","name":"General error","originalRequest":{"url":{"path":["v4","promotions","promotion","batch-activate"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"POST","body":{"mode":"raw","raw":"[\n {\n \"key\": \"code\",\n \"value\": \"7893467834GG\",\n \"pointsToUse\": 100\n }\n]","options":{"raw":{"language":"json"}}}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"b0a445be-ba33-4f3d-bf5f-f65dd8db4827","name":"Deactivate a promotion","request":{"name":"Deactivate a promotion","description":{"content":"A Profile can change the status of an activated promotion back to `assigned`.\n\n---\n\n**API consumers:** Profile (Client), Anonymous Profile\n","type":"text/plain"},"url":{"path":["v4","promotions","promotion","deactivate"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"key\": \"code\",\n \"value\": \"7893467834GG\",\n \"pointsToUse\": 100\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"648dcfe1-fc81-4f4d-96fe-8ce57b8b582c","name":"Promotion deactivated","originalRequest":{"url":{"path":["v4","promotions","promotion","deactivate"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"key\": \"code\",\n \"value\": \"7893467834GG\",\n \"pointsToUse\": 100\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"uuid\": \"string\",\n \"code\": \"string\",\n \"status\": \"ACTIVE\",\n \"type\": \"GENERAL\",\n \"redeemLimitPerClient\": 0,\n \"redeemQuantityPerActivation\": 2170570,\n \"currentRedeemedQuantity\": 8259,\n \"currentRedeemedLimit\": 4350,\n \"activationCounter\": 2353,\n \"possibleRedeems\": 1362,\n \"details\": {\n \"discountType\": {\n \"value\": \"\"\n }\n },\n \"discountType\": \"NONE\",\n \"discountValue\": 0,\n \"discountMode\": \"STATIC\",\n \"discountModeDetails\": {\n \"steps\": {\n \"value\": \"\"\n },\n \"discountUsageTrigger\": {\n \"value\": \"\"\n }\n },\n \"requireRedeemedPoints\": 6699.245140664446,\n \"name\": \"string\",\n \"headline\": \"string\",\n \"description\": \"string\",\n \"images\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"tags\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"startAt\": \"2016-02-27T00:38:19.077Z\",\n \"expireAt\": \"1976-02-23T19:44:15.402Z\",\n \"displayFrom\": \"string\",\n \"displayTo\": \"string\",\n \"assignedAt\": \"1986-12-28T17:37:24.769Z\",\n \"lastingTime\": 0,\n \"lastingAt\": \"1986-08-08T22:51:48.900Z\",\n \"params\": {\n \"key_0\": 3227,\n \"key_1\": \"string\",\n \"key_2\": false\n },\n \"price\": 0,\n \"priority\": 250,\n \"itemScope\": \"LINE_ITEM\",\n \"minBasketValue\": null,\n \"maxBasketValue\": null,\n \"vouchers\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"extra\": {\n \"slot\": 7998,\n \"assignmentSource\": \"fallback_pool\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"0ccb6811-639b-43dc-aef2-cb92869045e0","name":"Request body invalid/malformed/missing elements","originalRequest":{"url":{"path":["v4","promotions","promotion","deactivate"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"key\": \"code\",\n \"value\": \"7893467834GG\",\n \"pointsToUse\": 100\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"message\": {\n \"value\": \"\"\n },\n \"error\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"a04670c4-56ba-40ef-8f78-3ed1e63134e1","name":"Unauthorized","originalRequest":{"url":{"path":["v4","promotions","promotion","deactivate"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"key\": \"code\",\n \"value\": \"7893467834GG\",\n \"pointsToUse\": 100\n}","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"status\": 7751,\n \"error\": \"string\",\n \"message\": \"string\",\n \"timestamp\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"e4e8c3ec-aa31-489d-ad9e-788192693cd3","name":"Promotion deactivation is forbidden due to promotion setup.","originalRequest":{"url":{"path":["v4","promotions","promotion","deactivate"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"key\": \"code\",\n \"value\": \"7893467834GG\",\n \"pointsToUse\": 100\n}","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"message\": \"string\",\n \"error\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"20542d74-c8ff-4688-b795-9b44b053c326","name":"Not Found","originalRequest":{"url":{"path":["v4","promotions","promotion","deactivate"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"key\": \"code\",\n \"value\": \"7893467834GG\",\n \"pointsToUse\": 100\n}","options":{"raw":{"language":"json"}}}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"message\": \"Promotion for profile not found\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"81fa2749-cb2b-4310-81ce-35fce00a836f","name":"Waiting for profile lock release","originalRequest":{"url":{"path":["v4","promotions","promotion","deactivate"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"key\": \"code\",\n \"value\": \"7893467834GG\",\n \"pointsToUse\": 100\n}","options":{"raw":{"language":"json"}}}},"status":"Too Many Requests","code":429,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"message\": \"string\",\n \"error\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"10a01a7b-70de-4ae8-91d9-cbbca38ad5a6","name":"Batch deactivate promotions","request":{"name":"Batch deactivate promotions","description":{"content":"A Profile can change the status of a number of activated promotions back to `assigned`.\n\n---\n\n**API consumers:** Profile (Client), Anonymous Profile\n","type":"text/plain"},"url":{"path":["v4","promotions","promotion","batch-deactivate"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"[\n {\n \"key\": \"code\",\n \"value\": \"7893467834GG\",\n \"pointsToUse\": 100\n }\n]","options":{"raw":{"language":"json"}}}},"response":[{"id":"5a811586-8ab0-4bbc-ab78-c3907202a567","name":"Promotions deactivated","originalRequest":{"url":{"path":["v4","promotions","promotion","batch-deactivate"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"[\n {\n \"key\": \"code\",\n \"value\": \"7893467834GG\",\n \"pointsToUse\": 100\n }\n]","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{}","cookie":[],"_postman_previewlanguage":"json"},{"id":"6afc8119-11c7-4ea2-a6cf-ee0ace68ad7e","name":"Request body invalid/malformed/missing elements","originalRequest":{"url":{"path":["v4","promotions","promotion","batch-deactivate"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"[\n {\n \"key\": \"code\",\n \"value\": \"7893467834GG\",\n \"pointsToUse\": 100\n }\n]","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"message\": {\n \"value\": \"\"\n },\n \"error\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"436f0e7f-b1fa-4b14-a14e-139513d520a6","name":"Unauthorized","originalRequest":{"url":{"path":["v4","promotions","promotion","batch-deactivate"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"[\n {\n \"key\": \"code\",\n \"value\": \"7893467834GG\",\n \"pointsToUse\": 100\n }\n]","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"status\": 7751,\n \"error\": \"string\",\n \"message\": \"string\",\n \"timestamp\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"b23f9ea5-a350-4273-87ab-99cdf956efd7","name":"Forbidden","originalRequest":{"url":{"path":["v4","promotions","promotion","batch-deactivate"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"[\n {\n \"key\": \"code\",\n \"value\": \"7893467834GG\",\n \"pointsToUse\": 100\n }\n]","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"status\": 7751,\n \"error\": \"string\",\n \"message\": \"string\",\n \"timestamp\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"d1efd353-4eb8-4dfe-b14d-ae7799eebc5b","name":"Not Found","originalRequest":{"url":{"path":["v4","promotions","promotion","batch-deactivate"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"[\n {\n \"key\": \"code\",\n \"value\": \"7893467834GG\",\n \"pointsToUse\": 100\n }\n]","options":{"raw":{"language":"json"}}}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"message\": \"Promotions for profile not found\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"69727cab-21a1-4c9f-84fe-00d25b0383a6","name":"Waiting for profile lock release","originalRequest":{"url":{"path":["v4","promotions","promotion","batch-deactivate"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"[\n {\n \"key\": \"code\",\n \"value\": \"7893467834GG\",\n \"pointsToUse\": 100\n }\n]","options":{"raw":{"language":"json"}}}},"status":"Too Many Requests","code":429,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"message\": \"string\",\n \"error\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"3ec67d23-2665-4e00-8a65-7f945609d36d","name":"Deactivate all promotions for a Profile as Workspace","request":{"name":"Deactivate all promotions for a Profile as Workspace","description":{"content":"You can deactivate all promotions assigned to a Profile.\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User\n\n**API key permission required:** `PROMOTIONS_DEACTIVATE_PROMOTIONS_UPDATE`\n\n**User role permission required:** `campaigns_promotions: update`\n","type":"text/plain"},"url":{"path":["v4","promotions","promotion","deactivate-all-for-client",":identifierType",":identifierValue"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"returnCodes","value":"true","description":"Return deactivated codes"},{"disabled":false,"key":"lockPoints","value":"true","description":"Lock profile points during the deactivation process"},{"disabled":false,"key":"excludeTags","value":"string,string","description":"Promotions with the tags included in this list will not be deactivated"}],"variable":[{"disabled":false,"type":"any","value":"email","key":"identifierType","description":"(Required) The Profile identifier to use for the request.\n\n`externalId` is known as `customId` or `custom_identify` in other Synerise services.\n"},{"disabled":false,"type":"any","value":"string","key":"identifierValue","description":"(Required) The value of the selected identifier"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","auth":null},"response":[{"id":"e56be1fd-8f65-4d42-910f-0effd4fc9009","name":"All promotions deactivated","originalRequest":{"url":{"path":["v4","promotions","promotion","deactivate-all-for-client",":identifierType",":identifierValue"],"host":["{{baseUrl}}"],"query":[{"key":"returnCodes","value":"true"},{"key":"lockPoints","value":"true"},{"key":"excludeTags","value":"string,string"}],"variable":[{"disabled":false,"type":"any","value":"email","key":"identifierType","description":"(Required) The Profile identifier to use for the request.\n\n`externalId` is known as `customId` or `custom_identify` in other Synerise services.\n"},{"disabled":false,"type":"any","value":"string","key":"identifierValue","description":"(Required) The value of the selected identifier"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"fa700b7f-9480-4b25-979a-17549c87d94d","name":"Request body invalid/malformed/missing elements","originalRequest":{"url":{"path":["v4","promotions","promotion","deactivate-all-for-client",":identifierType",":identifierValue"],"host":["{{baseUrl}}"],"query":[{"key":"returnCodes","value":"true"},{"key":"lockPoints","value":"true"},{"key":"excludeTags","value":"string,string"}],"variable":[{"disabled":false,"type":"any","value":"email","key":"identifierType","description":"(Required) The Profile identifier to use for the request.\n\n`externalId` is known as `customId` or `custom_identify` in other Synerise services.\n"},{"disabled":false,"type":"any","value":"string","key":"identifierValue","description":"(Required) The value of the selected identifier"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"message\": {\n \"value\": \"\"\n },\n \"error\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"2a7f9495-6ade-4709-a88b-05e6a503ba60","name":"Unauthorized","originalRequest":{"url":{"path":["v4","promotions","promotion","deactivate-all-for-client",":identifierType",":identifierValue"],"host":["{{baseUrl}}"],"query":[{"key":"returnCodes","value":"true"},{"key":"lockPoints","value":"true"},{"key":"excludeTags","value":"string,string"}],"variable":[{"disabled":false,"type":"any","value":"email","key":"identifierType","description":"(Required) The Profile identifier to use for the request.\n\n`externalId` is known as `customId` or `custom_identify` in other Synerise services.\n"},{"disabled":false,"type":"any","value":"string","key":"identifierValue","description":"(Required) The value of the selected identifier"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"status\": 7751,\n \"error\": \"string\",\n \"message\": \"string\",\n \"timestamp\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"ce8ccc4a-aa24-4080-a685-1faf87583aba","name":"Forbidden","originalRequest":{"url":{"path":["v4","promotions","promotion","deactivate-all-for-client",":identifierType",":identifierValue"],"host":["{{baseUrl}}"],"query":[{"key":"returnCodes","value":"true"},{"key":"lockPoints","value":"true"},{"key":"excludeTags","value":"string,string"}],"variable":[{"disabled":false,"type":"any","value":"email","key":"identifierType","description":"(Required) The Profile identifier to use for the request.\n\n`externalId` is known as `customId` or `custom_identify` in other Synerise services.\n"},{"disabled":false,"type":"any","value":"string","key":"identifierValue","description":"(Required) The value of the selected identifier"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"status\": 7751,\n \"error\": \"string\",\n \"message\": \"string\",\n \"timestamp\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"c497037a-8f1c-4f9c-b831-8bd57f323e83","name":"Profile not found","originalRequest":{"url":{"path":["v4","promotions","promotion","deactivate-all-for-client",":identifierType",":identifierValue"],"host":["{{baseUrl}}"],"query":[{"key":"returnCodes","value":"true"},{"key":"lockPoints","value":"true"},{"key":"excludeTags","value":"string,string"}],"variable":[{"disabled":false,"type":"any","value":"email","key":"identifierType","description":"(Required) The Profile identifier to use for the request.\n\n`externalId` is known as `customId` or `custom_identify` in other Synerise services.\n"},{"disabled":false,"type":"any","value":"string","key":"identifierValue","description":"(Required) The value of the selected identifier"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"message\": \"Profile not found\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"b0b23ea4-9fc2-47b0-aa9a-90749371d868","name":"Redeem a promotion","request":{"name":"Redeem a promotion","description":{"content":"You can redeem a promotion and loyalty points.\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User\n\n**API key permission required:** `PROMOTIONS_REDEEM_PROMOTIONS_CREATE`\n\n**User role permission required:** `campaigns_promotions: create`\n","type":"text/plain"},"url":{"path":["v4","promotions","promotion","redeem"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"code\": \"75d9090f-06ac-46a2-a0ce-4b8eb287efb9\",\n \"clientKey\": \"clientId\",\n \"clientKeyValue\": \"434428563\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"7723d732-74e2-437c-8248-983e8a3fe38f","name":"Promotion redeemed successfully","originalRequest":{"url":{"path":["v4","promotions","promotion","redeem"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"code\": \"75d9090f-06ac-46a2-a0ce-4b8eb287efb9\",\n \"clientKey\": \"clientId\",\n \"clientKeyValue\": \"434428563\"\n}","options":{"raw":{"language":"json"}}}},"status":"Created","code":201,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"message\": \"Promotion redeemed successfully\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"45894782-5a79-479f-8eff-58f551c0c7bb","name":"Promotion is already redeemed","originalRequest":{"url":{"path":["v4","promotions","promotion","redeem"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"code\": \"75d9090f-06ac-46a2-a0ce-4b8eb287efb9\",\n \"clientKey\": \"clientId\",\n \"clientKeyValue\": \"434428563\"\n}","options":{"raw":{"language":"json"}}}},"code":209,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"message\": \"Promotion is already redeemed\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"e0f27cbf-cdd5-482e-bed3-b2e3c320cfb1","name":"Request body invalid/malformed/missing elements","originalRequest":{"url":{"path":["v4","promotions","promotion","redeem"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"code\": \"75d9090f-06ac-46a2-a0ce-4b8eb287efb9\",\n \"clientKey\": \"clientId\",\n \"clientKeyValue\": \"434428563\"\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"message\": {\n \"value\": \"\"\n },\n \"error\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"990bcc45-bc98-460c-b4ab-70c413f73136","name":"Unauthorized","originalRequest":{"url":{"path":["v4","promotions","promotion","redeem"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"code\": \"75d9090f-06ac-46a2-a0ce-4b8eb287efb9\",\n \"clientKey\": \"clientId\",\n \"clientKeyValue\": \"434428563\"\n}","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"status\": 7751,\n \"error\": \"string\",\n \"message\": \"string\",\n \"timestamp\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"58ae9720-bd1e-4955-b20e-0e1162b1ce81","name":"Forbidden","originalRequest":{"url":{"path":["v4","promotions","promotion","redeem"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"code\": \"75d9090f-06ac-46a2-a0ce-4b8eb287efb9\",\n \"clientKey\": \"clientId\",\n \"clientKeyValue\": \"434428563\"\n}","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"status\": 7751,\n \"error\": \"string\",\n \"message\": \"string\",\n \"timestamp\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"120cc085-a858-4f73-bed3-7009c2c72881","name":"Not found error","originalRequest":{"url":{"path":["v4","promotions","promotion","redeem"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"code\": \"75d9090f-06ac-46a2-a0ce-4b8eb287efb9\",\n \"clientKey\": \"clientId\",\n \"clientKeyValue\": \"434428563\"\n}","options":{"raw":{"language":"json"}}}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"message\": \"Profile not found\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"e7ac4262-77f6-418e-9e72-1144ddb45f9a","name":"Waiting for profile lock release","originalRequest":{"url":{"path":["v4","promotions","promotion","redeem"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"code\": \"75d9090f-06ac-46a2-a0ce-4b8eb287efb9\",\n \"clientKey\": \"clientId\",\n \"clientKeyValue\": \"434428563\"\n}","options":{"raw":{"language":"json"}}}},"status":"Conflict","code":409,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"message\": \"string\",\n \"error\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"3d56549a-06b1-4f28-b1ad-f8974dba18d2","name":"Unprocessable redemption","originalRequest":{"url":{"path":["v4","promotions","promotion","redeem"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"code\": \"75d9090f-06ac-46a2-a0ce-4b8eb287efb9\",\n \"clientKey\": \"clientId\",\n \"clientKeyValue\": \"434428563\"\n}","options":{"raw":{"language":"json"}}}},"status":"Precondition Failed","code":412,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"message\": \"Promotion not activated\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"49152016-d85a-4732-8269-adb1c30669a8","name":"Profile promotions blocked","originalRequest":{"url":{"path":["v4","promotions","promotion","redeem"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"code\": \"75d9090f-06ac-46a2-a0ce-4b8eb287efb9\",\n \"clientKey\": \"clientId\",\n \"clientKeyValue\": \"434428563\"\n}","options":{"raw":{"language":"json"}}}},"status":"Locked (WebDAV) (RFC 4918)","code":423,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"message\": \"string\",\n \"error\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"93cd6599-d744-407b-98d3-a882b492bf46","name":"Batch redeem promotions","request":{"name":"Batch redeem promotions","description":{"content":"You can redeem up to 100 promotions and loyalty points relevant to them.\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User\n\n**API key permission required:** `PROMOTIONS_BATCH_REDEEM_PROMOTIONS_CREATE`\n\n**User role permission required:** `campaigns_promotions: create`\n","type":"text/plain"},"url":{"path":["v4","promotions","promotion","batch-redeem"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"[\n {\n \"code\": \"75d9090f-06ac-46a2-a0ce-4b8eb287efb9\",\n \"clientKey\": \"clientId\",\n \"clientKeyValue\": \"434428563\"\n }\n]","options":{"raw":{"language":"json"}}}},"response":[{"id":"5d6f9083-ed86-43af-b211-d39bc6dd9929","name":"Promotion redeemed successfully","originalRequest":{"url":{"path":["v4","promotions","promotion","batch-redeem"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"[\n {\n \"code\": \"75d9090f-06ac-46a2-a0ce-4b8eb287efb9\",\n \"clientKey\": \"clientId\",\n \"clientKeyValue\": \"434428563\"\n }\n]","options":{"raw":{"language":"json"}}}},"status":"Created","code":201,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"message\": \"Promotion redeemed successfully\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"5e71b4b8-8afe-4d62-9a0c-e3653cfc6b04","name":"Promotion is already redeemed","originalRequest":{"url":{"path":["v4","promotions","promotion","batch-redeem"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"[\n {\n \"code\": \"75d9090f-06ac-46a2-a0ce-4b8eb287efb9\",\n \"clientKey\": \"clientId\",\n \"clientKeyValue\": \"434428563\"\n }\n]","options":{"raw":{"language":"json"}}}},"code":209,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"message\": \"Promotion is already redeemed\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"8062d824-3f8d-4179-b71a-c5b31b27ee75","name":"Request body invalid/malformed/missing elements","originalRequest":{"url":{"path":["v4","promotions","promotion","batch-redeem"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"[\n {\n \"code\": \"75d9090f-06ac-46a2-a0ce-4b8eb287efb9\",\n \"clientKey\": \"clientId\",\n \"clientKeyValue\": \"434428563\"\n }\n]","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"message\": {\n \"value\": \"\"\n },\n \"error\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"df27a4aa-920f-405c-bacb-9a3df868049d","name":"Unauthorized","originalRequest":{"url":{"path":["v4","promotions","promotion","batch-redeem"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"[\n {\n \"code\": \"75d9090f-06ac-46a2-a0ce-4b8eb287efb9\",\n \"clientKey\": \"clientId\",\n \"clientKeyValue\": \"434428563\"\n }\n]","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"status\": 7751,\n \"error\": \"string\",\n \"message\": \"string\",\n \"timestamp\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"c375aca4-2177-4a11-a0ff-51cca6cd9d2e","name":"Forbidden","originalRequest":{"url":{"path":["v4","promotions","promotion","batch-redeem"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"[\n {\n \"code\": \"75d9090f-06ac-46a2-a0ce-4b8eb287efb9\",\n \"clientKey\": \"clientId\",\n \"clientKeyValue\": \"434428563\"\n }\n]","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"status\": 7751,\n \"error\": \"string\",\n \"message\": \"string\",\n \"timestamp\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"9603229b-dea4-4722-9468-489e11c7e032","name":"Not found error","originalRequest":{"url":{"path":["v4","promotions","promotion","batch-redeem"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"[\n {\n \"code\": \"75d9090f-06ac-46a2-a0ce-4b8eb287efb9\",\n \"clientKey\": \"clientId\",\n \"clientKeyValue\": \"434428563\"\n }\n]","options":{"raw":{"language":"json"}}}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"message\": \"Profile not found\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"eacfdefe-b0e4-46a9-8cb9-f69d6705b9a0","name":"Waiting for profile lock release","originalRequest":{"url":{"path":["v4","promotions","promotion","batch-redeem"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"[\n {\n \"code\": \"75d9090f-06ac-46a2-a0ce-4b8eb287efb9\",\n \"clientKey\": \"clientId\",\n \"clientKeyValue\": \"434428563\"\n }\n]","options":{"raw":{"language":"json"}}}},"status":"Conflict","code":409,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"message\": \"string\",\n \"error\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"dc303bb9-0f26-4661-9890-d593ac4a5b95","name":"Unprocessable redemption","originalRequest":{"url":{"path":["v4","promotions","promotion","batch-redeem"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"[\n {\n \"code\": \"75d9090f-06ac-46a2-a0ce-4b8eb287efb9\",\n \"clientKey\": \"clientId\",\n \"clientKeyValue\": \"434428563\"\n }\n]","options":{"raw":{"language":"json"}}}},"status":"Precondition Failed","code":412,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"message\": \"Promotion not activated\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"5bf35f1f-4512-4fe7-b36d-e77b5e92d016","name":"Profile promotions blocked","originalRequest":{"url":{"path":["v4","promotions","promotion","batch-redeem"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"[\n {\n \"code\": \"75d9090f-06ac-46a2-a0ce-4b8eb287efb9\",\n \"clientKey\": \"clientId\",\n \"clientKeyValue\": \"434428563\"\n }\n]","options":{"raw":{"language":"json"}}}},"status":"Locked (WebDAV) (RFC 4918)","code":423,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"message\": \"string\",\n \"error\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"ec52531f-e221-411b-a351-9a7d50f124fd","name":"Get a Profile's promotions as Workspace (v2)","request":{"name":"Get a Profile's promotions as Workspace (v2)","description":{"content":"A Workspace can retrieve a list of a profile's promotions. By default, only non-expired promotions are retrieved.\n\n**IMPORTANT**: \n- As a result of this request, the `targetSegments` of all the matching promotions are checked. If this results in checking more than 100 unique segments, any segments above this limit may be ignored.\n- The endpoint is limited to 25000 requests per minute (per workspace).\n\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User\n\n**API key permission required:** `PROMOTIONS_LIST_PROMOTIONS_READ`\n\n**User role permission required:** `campaigns_promotions: read`\n","type":"text/plain"},"url":{"path":["v4","promotions","v2","promotion","get-for-client",":identifierType",":identifierValue"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"sort","value":"requireRedeemedPoints,desc","description":"The sorting order of the response.\n\n\n You can sort by any combination of the following attributes:\n * `headerName`: promotion header name\n * `name`: promotion name\n * `code`: promotion code\n * `startAt`: time when the promotion starts\n * `createdAt`: time when the promotion was created\n * `updatedAt`: time when the promotion was last updated\n * `expireAt`: time when the promotion expires\n * `requireRedeemedPoints`: how many loyalty points are needed to redeem the promotion\n * `type`: type of the promotion\n * `priority`: priority of the promotion\n * `status` : status of the promotion for the Profile\n\n You can sort ascending (default) or descending by adding `asc` or `desc` after the parameter, separated by a comma.\n\n **Example**: `sort=requireRedeemedPoints&sort=expireAt,asc&sort=status,desc`\n"},{"disabled":false,"key":"status","value":"REDEEMED,ACTIVE","description":"Filter by promotion status"},{"disabled":false,"key":"presentOnly","value":"true","description":"When set to:\n- `true`, the response includes only promotions that are currently active (startAt later than now or null, expireAt later than now or null)\n- `false`, the response includes the above and also promotions that are expired or will become active in the future.\n"},{"disabled":false,"key":"displayableOnly","value":"true","description":"When set to `true`, promotions which are not currently active are included in response, according to date range defined in promotion fields `displayFrom` and `displayTo`."},{"disabled":false,"key":"tagNames","value":"string,string","description":"Filter the response to promotions with a certain tag or tags"},{"disabled":false,"key":"limit","value":"100","description":"The number of items to return per page"},{"disabled":false,"key":"page","value":"4","description":"Page number to return for pagination. The first page has the index `1`."},{"disabled":false,"key":"includeMeta","value":"false","description":"\nWhen `true`, pagination metadata is included in the response body.\n\nWhen `false`, the data is included in the response headers:\n\n- Link: links to neighbors, first, and last pages in pagination.\n\n- X-Pagination-Total-Count: total number of items on all pages\n\n- X-Pagination-Total-Pages: total number of pages\n\n- X-Pagination-Page: current page\n\n- X-Pagination-Limit: maximum number of items on a page\n"},{"disabled":false,"key":"fields","value":"minBasketValue,type","description":"Return only specified promotion fields. If `fields` is not specified, all fields are returned."},{"disabled":false,"key":"promotionUuids","value":"fc1ee5bf-ad97-47a8-a474-e1b6e755ff38,aabaed4e-4ee7-44d5-b079-445a017ec6fe","description":"Filters the response data by a list of promotion UUIDs."},{"disabled":false,"key":"checkGlobalActivationLimits","value":"true","description":"Flag to indicate if global limits should be checked"},{"disabled":false,"key":"includeVouchers","value":"false","description":"\nWhen `true`, promotion with defined vouchers will also have list of assigned vouchers.\n\nWhen `false`, vouchers will not be fetched.\n"},{"disabled":false,"key":"storeIds","value":"string","description":"Limits the response to data from particular stores, identified by IDs."}],"variable":[{"disabled":false,"type":"any","value":"email","key":"identifierType","description":"(Required) The Profile identifier to use for the request.\n\n`externalId` is known as `customId` or `custom_identify` in other Synerise services.\n"},{"disabled":false,"type":"any","value":"string","key":"identifierValue","description":"(Required) The value of the selected identifier"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"50d0f5ea-659b-4a91-966d-983f38ed933e","name":"An array of promotions","originalRequest":{"url":{"path":["v4","promotions","v2","promotion","get-for-client",":identifierType",":identifierValue"],"host":["{{baseUrl}}"],"query":[{"key":"sort","value":"requireRedeemedPoints,desc"},{"key":"status","value":"REDEEMED,ACTIVE"},{"key":"presentOnly","value":"true"},{"key":"displayableOnly","value":"true"},{"key":"tagNames","value":"string,string"},{"key":"limit","value":"100"},{"key":"page","value":"4"},{"key":"includeMeta","value":"false"},{"key":"fields","value":"minBasketValue,type"},{"key":"promotionUuids","value":"fc1ee5bf-ad97-47a8-a474-e1b6e755ff38,aabaed4e-4ee7-44d5-b079-445a017ec6fe"},{"key":"checkGlobalActivationLimits","value":"true"},{"key":"includeVouchers","value":"false"},{"key":"storeIds","value":"string"}],"variable":[{"disabled":false,"type":"any","value":"email","key":"identifierType","description":"(Required) The Profile identifier to use for the request.\n\n`externalId` is known as `customId` or `custom_identify` in other Synerise services.\n"},{"disabled":false,"type":"any","value":"string","key":"identifierValue","description":"(Required) The value of the selected identifier"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"data\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"meta\": {\n \"code\": {\n \"value\": \"\"\n },\n \"limit\": {\n \"value\": \"\"\n },\n \"link\": {\n \"value\": \"\"\n },\n \"page\": {\n \"value\": \"\"\n },\n \"totalCount\": {\n \"value\": \"\"\n },\n \"totalPages\": {\n \"value\": \"\"\n }\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"80730cd9-d92d-4f1f-8df4-827c1a44fb35","name":"Unauthorized","originalRequest":{"url":{"path":["v4","promotions","v2","promotion","get-for-client",":identifierType",":identifierValue"],"host":["{{baseUrl}}"],"query":[{"key":"sort","value":"requireRedeemedPoints,desc"},{"key":"status","value":"REDEEMED,ACTIVE"},{"key":"presentOnly","value":"true"},{"key":"displayableOnly","value":"true"},{"key":"tagNames","value":"string,string"},{"key":"limit","value":"100"},{"key":"page","value":"4"},{"key":"includeMeta","value":"false"},{"key":"fields","value":"minBasketValue,type"},{"key":"promotionUuids","value":"fc1ee5bf-ad97-47a8-a474-e1b6e755ff38,aabaed4e-4ee7-44d5-b079-445a017ec6fe"},{"key":"checkGlobalActivationLimits","value":"true"},{"key":"includeVouchers","value":"false"},{"key":"storeIds","value":"string"}],"variable":[{"disabled":false,"type":"any","value":"email","key":"identifierType","description":"(Required) The Profile identifier to use for the request.\n\n`externalId` is known as `customId` or `custom_identify` in other Synerise services.\n"},{"disabled":false,"type":"any","value":"string","key":"identifierValue","description":"(Required) The value of the selected identifier"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"status\": 7751,\n \"error\": \"string\",\n \"message\": \"string\",\n \"timestamp\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"8bf2ab27-2380-430a-b51f-4d01a5d1ec5a","name":"Forbidden","originalRequest":{"url":{"path":["v4","promotions","v2","promotion","get-for-client",":identifierType",":identifierValue"],"host":["{{baseUrl}}"],"query":[{"key":"sort","value":"requireRedeemedPoints,desc"},{"key":"status","value":"REDEEMED,ACTIVE"},{"key":"presentOnly","value":"true"},{"key":"displayableOnly","value":"true"},{"key":"tagNames","value":"string,string"},{"key":"limit","value":"100"},{"key":"page","value":"4"},{"key":"includeMeta","value":"false"},{"key":"fields","value":"minBasketValue,type"},{"key":"promotionUuids","value":"fc1ee5bf-ad97-47a8-a474-e1b6e755ff38,aabaed4e-4ee7-44d5-b079-445a017ec6fe"},{"key":"checkGlobalActivationLimits","value":"true"},{"key":"includeVouchers","value":"false"},{"key":"storeIds","value":"string"}],"variable":[{"disabled":false,"type":"any","value":"email","key":"identifierType","description":"(Required) The Profile identifier to use for the request.\n\n`externalId` is known as `customId` or `custom_identify` in other Synerise services.\n"},{"disabled":false,"type":"any","value":"string","key":"identifierValue","description":"(Required) The value of the selected identifier"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"status\": 7751,\n \"error\": \"string\",\n \"message\": \"string\",\n \"timestamp\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"615c2091-ea08-42ae-889e-b14dfde37e8b","name":"Profile not found","originalRequest":{"url":{"path":["v4","promotions","v2","promotion","get-for-client",":identifierType",":identifierValue"],"host":["{{baseUrl}}"],"query":[{"key":"sort","value":"requireRedeemedPoints,desc"},{"key":"status","value":"REDEEMED,ACTIVE"},{"key":"presentOnly","value":"true"},{"key":"displayableOnly","value":"true"},{"key":"tagNames","value":"string,string"},{"key":"limit","value":"100"},{"key":"page","value":"4"},{"key":"includeMeta","value":"false"},{"key":"fields","value":"minBasketValue,type"},{"key":"promotionUuids","value":"fc1ee5bf-ad97-47a8-a474-e1b6e755ff38,aabaed4e-4ee7-44d5-b079-445a017ec6fe"},{"key":"checkGlobalActivationLimits","value":"true"},{"key":"includeVouchers","value":"false"},{"key":"storeIds","value":"string"}],"variable":[{"disabled":false,"type":"any","value":"email","key":"identifierType","description":"(Required) The Profile identifier to use for the request.\n\n`externalId` is known as `customId` or `custom_identify` in other Synerise services.\n"},{"disabled":false,"type":"any","value":"string","key":"identifierValue","description":"(Required) The value of the selected identifier"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"message\": \"Profile not found\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"60b71c51-c457-4c9c-b57b-645fc689f2cf","name":"View promotion details as Profile","request":{"name":"View promotion details as Profile","description":{"content":"A Profile can view all the details of an assigned or activated promotion.\n\n---\n\n**API consumers:** Profile (Client), Anonymous Profile\n\n**User role permission required:** `campaigns_promotions: read`\n","type":"text/plain"},"url":{"path":["v4","promotions","promotion","get-item-for-client",":identifierType",":identifierValue"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"lastingOnly","value":"true","description":"When set to `true`, shows promotions/vouchers that are currently active and those that are still inactivated. (lastingAt set to null or lastingAt in future)"}],"variable":[{"disabled":false,"type":"any","value":"uuid","key":"identifierType","description":"(Required) The promotion identifier to use for the request"},{"disabled":false,"type":"any","value":"string","key":"identifierValue","description":"(Required) The value of the selected identifier"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"8ec1f046-4c3e-4c9a-9cce-a481a55a3852","name":"Details of a promotion","originalRequest":{"url":{"path":["v4","promotions","promotion","get-item-for-client",":identifierType",":identifierValue"],"host":["{{baseUrl}}"],"query":[{"key":"lastingOnly","value":"true"}],"variable":[{"disabled":false,"type":"any","value":"uuid","key":"identifierType","description":"(Required) The promotion identifier to use for the request"},{"disabled":false,"type":"any","value":"string","key":"identifierValue","description":"(Required) The value of the selected identifier"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"data\": {\n \"uuid\": {\n \"value\": \"\"\n },\n \"code\": {\n \"value\": \"\"\n },\n \"status\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"redeemLimitPerClient\": {\n \"value\": \"\"\n },\n \"redeemQuantityPerActivation\": {\n \"value\": \"\"\n },\n \"currentRedeemedQuantity\": {\n \"value\": \"\"\n },\n \"currentRedeemedLimit\": {\n \"value\": \"\"\n },\n \"activationCounter\": {\n \"value\": \"\"\n },\n \"possibleRedeems\": {\n \"value\": \"\"\n },\n \"details\": {\n \"value\": \"\"\n },\n \"discountType\": {\n \"value\": \"\"\n },\n \"discountValue\": {\n \"value\": \"\"\n },\n \"discountMode\": {\n \"value\": \"\"\n },\n \"discountModeDetails\": {\n \"value\": \"\"\n },\n \"requireRedeemedPoints\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"headline\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n },\n \"images\": {\n \"value\": \"\"\n },\n \"tags\": {\n \"value\": \"\"\n },\n \"startAt\": {\n \"value\": \"\"\n },\n \"expireAt\": {\n \"value\": \"\"\n },\n \"displayFrom\": {\n \"value\": \"\"\n },\n \"displayTo\": {\n \"value\": \"\"\n },\n \"assignedAt\": {\n \"value\": \"\"\n },\n \"lastingTime\": {\n \"value\": \"\"\n },\n \"lastingAt\": {\n \"value\": \"\"\n },\n \"params\": {\n \"value\": \"\"\n },\n \"catalogIndexItems\": {\n \"value\": \"\"\n },\n \"price\": {\n \"value\": \"\"\n },\n \"priority\": {\n \"value\": \"\"\n },\n \"itemScope\": {\n \"value\": \"\"\n },\n \"minBasketValue\": {\n \"value\": \"\"\n },\n \"maxBasketValue\": {\n \"value\": \"\"\n },\n \"vouchers\": {\n \"value\": \"\"\n },\n \"extra\": {\n \"value\": \"\"\n }\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"70619ce0-8323-456e-8a03-d60ed8f299bd","name":"Request body invalid/malformed/missing elements","originalRequest":{"url":{"path":["v4","promotions","promotion","get-item-for-client",":identifierType",":identifierValue"],"host":["{{baseUrl}}"],"query":[{"key":"lastingOnly","value":"true"}],"variable":[{"disabled":false,"type":"any","value":"uuid","key":"identifierType","description":"(Required) The promotion identifier to use for the request"},{"disabled":false,"type":"any","value":"string","key":"identifierValue","description":"(Required) The value of the selected identifier"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"message\": {\n \"value\": \"\"\n },\n \"error\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"7ca9bdad-5c76-4f18-82b5-d7afee79e9ec","name":"Unauthorized","originalRequest":{"url":{"path":["v4","promotions","promotion","get-item-for-client",":identifierType",":identifierValue"],"host":["{{baseUrl}}"],"query":[{"key":"lastingOnly","value":"true"}],"variable":[{"disabled":false,"type":"any","value":"uuid","key":"identifierType","description":"(Required) The promotion identifier to use for the request"},{"disabled":false,"type":"any","value":"string","key":"identifierValue","description":"(Required) The value of the selected identifier"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"status\": 7751,\n \"error\": \"string\",\n \"message\": \"string\",\n \"timestamp\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"c0002610-93ad-4f7e-925c-b7e544ed67ba","name":"Forbidden","originalRequest":{"url":{"path":["v4","promotions","promotion","get-item-for-client",":identifierType",":identifierValue"],"host":["{{baseUrl}}"],"query":[{"key":"lastingOnly","value":"true"}],"variable":[{"disabled":false,"type":"any","value":"uuid","key":"identifierType","description":"(Required) The promotion identifier to use for the request"},{"disabled":false,"type":"any","value":"string","key":"identifierValue","description":"(Required) The value of the selected identifier"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"status\": 7751,\n \"error\": \"string\",\n \"message\": \"string\",\n \"timestamp\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"aa6e25fd-8a0e-42af-9a96-159e79a7cac3","name":"Not Found","originalRequest":{"url":{"path":["v4","promotions","promotion","get-item-for-client",":identifierType",":identifierValue"],"host":["{{baseUrl}}"],"query":[{"key":"lastingOnly","value":"true"}],"variable":[{"disabled":false,"type":"any","value":"uuid","key":"identifierType","description":"(Required) The promotion identifier to use for the request"},{"disabled":false,"type":"any","value":"string","key":"identifierValue","description":"(Required) The value of the selected identifier"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"message\": \"Object not found\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"61360c91-1ff9-400c-b50e-9919e6540d70","name":"View promotion details as Profile","request":{"name":"View promotion details as Profile","description":{"content":"A Profile can view all the details of an assigned or activated promotion.\n\n---\n\n**API consumers:** Profile (Client), Anonymous Profile\n\n**User role permission required:** `campaigns_promotions: read`\n","type":"text/plain"},"url":{"path":["v4","promotions","promotion","get-item-for-client-no-data",":identifierType",":identifierValue"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"uuid","key":"identifierType","description":"(Required) The promotion identifier to use for the request"},{"disabled":false,"type":"any","value":"string","key":"identifierValue","description":"(Required) The value of the selected identifier"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"1bb34d39-1594-49be-82cb-af84e864b40f","name":"Details of a promotion","originalRequest":{"url":{"path":["v4","promotions","promotion","get-item-for-client-no-data",":identifierType",":identifierValue"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"uuid","key":"identifierType","description":"(Required) The promotion identifier to use for the request"},{"disabled":false,"type":"any","value":"string","key":"identifierValue","description":"(Required) The value of the selected identifier"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"data\": {\n \"uuid\": {\n \"value\": \"\"\n },\n \"code\": {\n \"value\": \"\"\n },\n \"status\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"redeemLimitPerClient\": {\n \"value\": \"\"\n },\n \"redeemQuantityPerActivation\": {\n \"value\": \"\"\n },\n \"currentRedeemedQuantity\": {\n \"value\": \"\"\n },\n \"currentRedeemedLimit\": {\n \"value\": \"\"\n },\n \"activationCounter\": {\n \"value\": \"\"\n },\n \"possibleRedeems\": {\n \"value\": \"\"\n },\n \"details\": {\n \"value\": \"\"\n },\n \"discountType\": {\n \"value\": \"\"\n },\n \"discountValue\": {\n \"value\": \"\"\n },\n \"discountMode\": {\n \"value\": \"\"\n },\n \"discountModeDetails\": {\n \"value\": \"\"\n },\n \"requireRedeemedPoints\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"headline\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n },\n \"images\": {\n \"value\": \"\"\n },\n \"tags\": {\n \"value\": \"\"\n },\n \"startAt\": {\n \"value\": \"\"\n },\n \"expireAt\": {\n \"value\": \"\"\n },\n \"displayFrom\": {\n \"value\": \"\"\n },\n \"displayTo\": {\n \"value\": \"\"\n },\n \"assignedAt\": {\n \"value\": \"\"\n },\n \"lastingTime\": {\n \"value\": \"\"\n },\n \"lastingAt\": {\n \"value\": \"\"\n },\n \"params\": {\n \"value\": \"\"\n },\n \"catalogIndexItems\": {\n \"value\": \"\"\n },\n \"price\": {\n \"value\": \"\"\n },\n \"priority\": {\n \"value\": \"\"\n },\n \"itemScope\": {\n \"value\": \"\"\n },\n \"minBasketValue\": {\n \"value\": \"\"\n },\n \"maxBasketValue\": {\n \"value\": \"\"\n },\n \"vouchers\": {\n \"value\": \"\"\n },\n \"extra\": {\n \"value\": \"\"\n }\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"adfa5532-8d8a-43fb-833d-5b87f81e95a8","name":"Request body invalid/malformed/missing elements","originalRequest":{"url":{"path":["v4","promotions","promotion","get-item-for-client-no-data",":identifierType",":identifierValue"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"uuid","key":"identifierType","description":"(Required) The promotion identifier to use for the request"},{"disabled":false,"type":"any","value":"string","key":"identifierValue","description":"(Required) The value of the selected identifier"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"message\": {\n \"value\": \"\"\n },\n \"error\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"7cbd5b9b-070f-4816-a96a-54052bf17314","name":"Unauthorized","originalRequest":{"url":{"path":["v4","promotions","promotion","get-item-for-client-no-data",":identifierType",":identifierValue"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"uuid","key":"identifierType","description":"(Required) The promotion identifier to use for the request"},{"disabled":false,"type":"any","value":"string","key":"identifierValue","description":"(Required) The value of the selected identifier"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"status\": 7751,\n \"error\": \"string\",\n \"message\": \"string\",\n \"timestamp\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"d6845f3f-a680-4cbc-98f7-cf4a43581afa","name":"Forbidden","originalRequest":{"url":{"path":["v4","promotions","promotion","get-item-for-client-no-data",":identifierType",":identifierValue"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"uuid","key":"identifierType","description":"(Required) The promotion identifier to use for the request"},{"disabled":false,"type":"any","value":"string","key":"identifierValue","description":"(Required) The value of the selected identifier"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"status\": 7751,\n \"error\": \"string\",\n \"message\": \"string\",\n \"timestamp\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"8f1b45df-59e3-4d3c-884b-35c6c1a1652a","name":"Not Found","originalRequest":{"url":{"path":["v4","promotions","promotion","get-item-for-client-no-data",":identifierType",":identifierValue"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"uuid","key":"identifierType","description":"(Required) The promotion identifier to use for the request"},{"disabled":false,"type":"any","value":"string","key":"identifierValue","description":"(Required) The value of the selected identifier"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"message\": \"Object not found\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"fdca0a57-9fbe-40e9-a836-82de3d2d3a94","name":"View Workspace promotions","request":{"name":"View Workspace promotions","description":{"content":"You can retrieve a list of all promotions defined in your Workspaces. It includes configured promotions, ready to be used or already in use.\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User\n\n**API key permission required:** `PROMOTIONS_LIST_PROMOTIONS_READ`\n\n**User role permission required:** `campaigns_promotions: read`\n","type":"text/plain"},"url":{"path":["v4","promotions","promotion","list"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"limit","value":"100","description":"The number of items to return per page"},{"disabled":false,"key":"page","value":"4","description":"Page number to return for pagination. The first page has the index `1`."},{"disabled":false,"key":"storeCatalog","value":"string","description":"Limits the response to data from stores included in a catalog."},{"disabled":false,"key":"storeIds","value":"string","description":"Limits the response to data from particular stores, identified by IDs."},{"disabled":false,"key":"includeMeta","value":"false","description":"\nWhen `true`, pagination metadata is included in the response body.\n\nWhen `false`, the data is included in the response headers:\n\n- Link: links to neighbors, first, and last pages in pagination.\n\n- X-Pagination-Total-Count: total number of items on all pages\n\n- X-Pagination-Total-Pages: total number of pages\n\n- X-Pagination-Page: current page\n\n- X-Pagination-Limit: maximum number of items on a page\n"},{"disabled":false,"key":"orderFieldName","value":"createdAt","description":"Name of the parameter used for sorting"},{"disabled":false,"key":"order","value":"asc","description":"Sorting order"},{"disabled":false,"key":"query","value":"string","description":"A string to search for in the `headerName` parameter or fragment of UUID."},{"disabled":false,"key":"promotionUuids","value":"fc1ee5bf-ad97-47a8-a474-e1b6e755ff38,aabaed4e-4ee7-44d5-b079-445a017ec6fe","description":"Filters the response data by a list of promotion UUIDs."},{"disabled":false,"key":"targetByType","value":"[SEGMENT]=ACTIVE","description":"A combination of target and type, for example `[SEGMENT]=ACTIVE`"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"afc99a18-2c1a-4d53-81bf-8a71f1bd6c52","name":"An array of promotions","originalRequest":{"url":{"path":["v4","promotions","promotion","list"],"host":["{{baseUrl}}"],"query":[{"key":"limit","value":"100"},{"key":"page","value":"4"},{"key":"storeCatalog","value":"string"},{"key":"storeIds","value":"string"},{"key":"includeMeta","value":"false"},{"key":"orderFieldName","value":"createdAt"},{"key":"order","value":"asc"},{"key":"query","value":"string"},{"key":"promotionUuids","value":"fc1ee5bf-ad97-47a8-a474-e1b6e755ff38,aabaed4e-4ee7-44d5-b079-445a017ec6fe"},{"key":"targetByType","value":"[SEGMENT]=ACTIVE"}],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"data\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"meta\": {\n \"code\": {\n \"value\": \"\"\n },\n \"limit\": {\n \"value\": \"\"\n },\n \"link\": {\n \"value\": \"\"\n },\n \"page\": {\n \"value\": \"\"\n },\n \"totalCount\": {\n \"value\": \"\"\n },\n \"totalPages\": {\n \"value\": \"\"\n }\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"0a7c04fb-12be-41da-964b-914cbf4a1398","name":"Request body invalid/malformed/missing elements","originalRequest":{"url":{"path":["v4","promotions","promotion","list"],"host":["{{baseUrl}}"],"query":[{"key":"limit","value":"100"},{"key":"page","value":"4"},{"key":"storeCatalog","value":"string"},{"key":"storeIds","value":"string"},{"key":"includeMeta","value":"false"},{"key":"orderFieldName","value":"createdAt"},{"key":"order","value":"asc"},{"key":"query","value":"string"},{"key":"promotionUuids","value":"fc1ee5bf-ad97-47a8-a474-e1b6e755ff38,aabaed4e-4ee7-44d5-b079-445a017ec6fe"},{"key":"targetByType","value":"[SEGMENT]=ACTIVE"}],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"message\": {\n \"value\": \"\"\n },\n \"error\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"341443b5-f9b0-4226-a55b-b540565c1f1c","name":"Unauthorized","originalRequest":{"url":{"path":["v4","promotions","promotion","list"],"host":["{{baseUrl}}"],"query":[{"key":"limit","value":"100"},{"key":"page","value":"4"},{"key":"storeCatalog","value":"string"},{"key":"storeIds","value":"string"},{"key":"includeMeta","value":"false"},{"key":"orderFieldName","value":"createdAt"},{"key":"order","value":"asc"},{"key":"query","value":"string"},{"key":"promotionUuids","value":"fc1ee5bf-ad97-47a8-a474-e1b6e755ff38,aabaed4e-4ee7-44d5-b079-445a017ec6fe"},{"key":"targetByType","value":"[SEGMENT]=ACTIVE"}],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"status\": 7751,\n \"error\": \"string\",\n \"message\": \"string\",\n \"timestamp\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"fefd1aea-cfc2-44a7-9100-e82da1dfdeed","name":"Forbidden","originalRequest":{"url":{"path":["v4","promotions","promotion","list"],"host":["{{baseUrl}}"],"query":[{"key":"limit","value":"100"},{"key":"page","value":"4"},{"key":"storeCatalog","value":"string"},{"key":"storeIds","value":"string"},{"key":"includeMeta","value":"false"},{"key":"orderFieldName","value":"createdAt"},{"key":"order","value":"asc"},{"key":"query","value":"string"},{"key":"promotionUuids","value":"fc1ee5bf-ad97-47a8-a474-e1b6e755ff38,aabaed4e-4ee7-44d5-b079-445a017ec6fe"},{"key":"targetByType","value":"[SEGMENT]=ACTIVE"}],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"status\": 7751,\n \"error\": \"string\",\n \"message\": \"string\",\n \"timestamp\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"3a7bf458-8edb-4178-9d66-7122b0a2576c","name":"View recently updated promotions","request":{"name":"View recently updated promotions","description":{"content":"You can retrieve a list of promotions that were updated. You can filter, sort, and paginate the results.\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User\n\n**API key permission required:** `PROMOTIONS_DIFF_LIST_PROMOTIONS_READ`\n\n**User role permission required:** `campaigns_promotions: read`\n","type":"text/plain"},"url":{"path":["v4","promotions","promotion","diff-list"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"limit","value":"100","description":"The number of items to return per page"},{"disabled":false,"key":"page","value":"4","description":"Page number to return for pagination. The first page has the index `1`."},{"disabled":false,"key":"storeCatalog","value":"string","description":"Limits the response to data from stores included in a catalog."},{"disabled":false,"key":"storeIds","value":"string","description":"Limits the response to data from particular stores, identified by IDs."},{"disabled":false,"key":"target","value":"ALL,ALL","description":"The target of the promotion"},{"disabled":false,"key":"includeMeta","value":"false","description":"\nWhen `true`, pagination metadata is included in the response body.\n\nWhen `false`, the data is included in the response headers:\n\n- Link: links to neighbors, first, and last pages in pagination.\n\n- X-Pagination-Total-Count: total number of items on all pages\n\n- X-Pagination-Total-Pages: total number of pages\n\n- X-Pagination-Page: current page\n\n- X-Pagination-Limit: maximum number of items on a page\n"},{"disabled":false,"key":"presentOnly","value":"true","description":"When set to:\n- `true`, the response includes only promotions that are currently active (startAt later than now or null, expireAt later than now or null)\n- `false`, the response includes the above and also promotions that are expired or will become active in the future.\n"},{"disabled":false,"key":"visibilityStatus","value":"HIDDEN","description":"Visibility status"},{"disabled":false,"key":"visibilityStatus","value":"DRAFT","description":"Visibility status"},{"disabled":false,"key":"upsertTimestamp","value":"2008-02-12T03:58:30.166Z","description":"Defines the date since which the differences are shown. If not defined, defaults to infinity."},{"disabled":false,"key":"orderFieldName","value":"createdAt","description":"Name of the parameter used for sorting"},{"disabled":false,"key":"order","value":"asc","description":"Sorting order"},{"disabled":false,"key":"query","value":"string","description":"A string to search for in the `headerName` parameter or fragment of UUID."}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"42f0adb2-827f-4fc2-9d44-b11d86a6153d","name":"An array of promotions. If a promotion was deleted, the `deletedAt` field is included","originalRequest":{"url":{"path":["v4","promotions","promotion","diff-list"],"host":["{{baseUrl}}"],"query":[{"key":"limit","value":"100"},{"key":"page","value":"4"},{"key":"storeCatalog","value":"string"},{"key":"storeIds","value":"string"},{"key":"target","value":"ALL,ALL"},{"key":"includeMeta","value":"false"},{"key":"presentOnly","value":"true"},{"key":"visibilityStatus","value":"HIDDEN"},{"key":"visibilityStatus","value":"DRAFT"},{"key":"upsertTimestamp","value":"2008-02-12T03:58:30.166Z"},{"key":"orderFieldName","value":"createdAt"},{"key":"order","value":"asc"},{"key":"query","value":"string"}],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"data\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"meta\": {\n \"code\": {\n \"value\": \"\"\n },\n \"limit\": {\n \"value\": \"\"\n },\n \"link\": {\n \"value\": \"\"\n },\n \"page\": {\n \"value\": \"\"\n },\n \"totalCount\": {\n \"value\": \"\"\n },\n \"totalPages\": {\n \"value\": \"\"\n }\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"f5696882-8b04-469b-95cb-1b1db81cbe5d","name":"Request body invalid/malformed/missing elements","originalRequest":{"url":{"path":["v4","promotions","promotion","diff-list"],"host":["{{baseUrl}}"],"query":[{"key":"limit","value":"100"},{"key":"page","value":"4"},{"key":"storeCatalog","value":"string"},{"key":"storeIds","value":"string"},{"key":"target","value":"ALL,ALL"},{"key":"includeMeta","value":"false"},{"key":"presentOnly","value":"true"},{"key":"visibilityStatus","value":"HIDDEN"},{"key":"visibilityStatus","value":"DRAFT"},{"key":"upsertTimestamp","value":"2008-02-12T03:58:30.166Z"},{"key":"orderFieldName","value":"createdAt"},{"key":"order","value":"asc"},{"key":"query","value":"string"}],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"message\": {\n \"value\": \"\"\n },\n \"error\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"39646799-33ec-46cc-90de-62f54886800e","name":"Unauthorized","originalRequest":{"url":{"path":["v4","promotions","promotion","diff-list"],"host":["{{baseUrl}}"],"query":[{"key":"limit","value":"100"},{"key":"page","value":"4"},{"key":"storeCatalog","value":"string"},{"key":"storeIds","value":"string"},{"key":"target","value":"ALL,ALL"},{"key":"includeMeta","value":"false"},{"key":"presentOnly","value":"true"},{"key":"visibilityStatus","value":"HIDDEN"},{"key":"visibilityStatus","value":"DRAFT"},{"key":"upsertTimestamp","value":"2008-02-12T03:58:30.166Z"},{"key":"orderFieldName","value":"createdAt"},{"key":"order","value":"asc"},{"key":"query","value":"string"}],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"status\": 7751,\n \"error\": \"string\",\n \"message\": \"string\",\n \"timestamp\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"494a3172-bbd1-43d6-9cad-e04167cf76ff","name":"Forbidden","originalRequest":{"url":{"path":["v4","promotions","promotion","diff-list"],"host":["{{baseUrl}}"],"query":[{"key":"limit","value":"100"},{"key":"page","value":"4"},{"key":"storeCatalog","value":"string"},{"key":"storeIds","value":"string"},{"key":"target","value":"ALL,ALL"},{"key":"includeMeta","value":"false"},{"key":"presentOnly","value":"true"},{"key":"visibilityStatus","value":"HIDDEN"},{"key":"visibilityStatus","value":"DRAFT"},{"key":"upsertTimestamp","value":"2008-02-12T03:58:30.166Z"},{"key":"orderFieldName","value":"createdAt"},{"key":"order","value":"asc"},{"key":"query","value":"string"}],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"status\": 7751,\n \"error\": \"string\",\n \"message\": \"string\",\n \"timestamp\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"6eb7b065-8e94-490b-a035-6eca7b170f58","name":"Get a Profile's promotions as Workspace","request":{"name":"Get a Profile's promotions as Workspace","description":{"content":"**Deprecated.** Use [/v2/promotion/get-for-client/{identifierType}/{identifierValue}](#operation/GetAllClientPromotionsV2) instead.\n\nA Workspace can retrieve a list of all promotions assigned to a Profile.\n\n**IMPORTANT**:\n- As a result of this request, the `targetSegments` of all the matching promotions are checked. If this results in checking more than 100 unique segments, any segments above this limit may be ignored.\n- The endpoint does not support redemption limits per client for Multi-buy promotions (promotions with redeemQuantityPerActivation greater than 1). For redemption limits, please use [/v2/promotion/get-for-client/{identifierType}/{identifierValue}](#operation/GetAllClientPromotionsV2).\n- The endpoint is limited to 25000 requests per minute (per workspace).\n\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User\n\n**API key permission required:** `PROMOTIONS_LIST_PROMOTIONS_READ`\n\n**User role permission required:** `campaigns_promotions: read`\n","type":"text/plain"},"url":{"path":["v4","promotions","promotion","get-for-client",":identifierType",":identifierValue"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"sort","value":"requireRedeemedPoints,desc","description":"The sorting order of the response.\n\n\n You can sort by any combination of the following attributes:\n * `headerName`: promotion header name\n * `name`: promotion name\n * `code`: promotion code\n * `startAt`: time when the promotion starts\n * `createdAt`: time when the promotion was created\n * `updatedAt`: time when the promotion was last updated\n * `expireAt`: time when the promotion expires\n * `requireRedeemedPoints`: how many loyalty points are needed to redeem the promotion\n * `type`: type of the promotion\n * `priority`: priority of the promotion\n * `status` : status of the promotion for the Profile\n\n You can sort ascending (default) or descending by adding `asc` or `desc` after the parameter, separated by a comma.\n\n **Example**: `sort=requireRedeemedPoints&sort=expireAt,asc&sort=status,desc`\n"},{"disabled":false,"key":"status","value":"ACTIVE,ACTIVE","description":"Filter by promotion status. If not provided, defaults to ACTIVE. If status is not provided and no promotions are active, the response is an empty array."},{"disabled":false,"key":"tagNames","value":"string,string","description":"Filter the response to promotions with a certain tag or tags"},{"disabled":false,"key":"target","value":"ALL,ALL","description":"The target of the promotion"},{"disabled":false,"key":"type","value":"GENERAL,CUSTOM","description":"Promotion type"},{"disabled":false,"key":"presentOnly","value":"true","description":"When set to:\n- `true`, the response includes only promotions that are currently active (startAt later than now or null, expireAt later than now or null)\n- `false`, the response includes the above and also promotions that are expired or will become active in the future.\n"},{"disabled":false,"key":"lastingOnly","value":"true","description":"When set to `true`, shows promotions/vouchers that are currently active and those that are still inactivated. (lastingAt set to null or lastingAt in future)"},{"disabled":false,"key":"displayableOnly","value":"true","description":"When set to `true`, promotions which are not currently active are included in response, according to date range defined in promotion fields `displayFrom` and `displayTo`."},{"disabled":false,"key":"limit","value":"100","description":"The number of items to return per page"},{"disabled":false,"key":"page","value":"4","description":"Page number to return for pagination. The first page has the index `1`."},{"disabled":false,"key":"includeMeta","value":"false","description":"\nWhen `true`, pagination metadata is included in the response body.\n\nWhen `false`, the data is included in the response headers:\n\n- Link: links to neighbors, first, and last pages in pagination.\n\n- X-Pagination-Total-Count: total number of items on all pages\n\n- X-Pagination-Total-Pages: total number of pages\n\n- X-Pagination-Page: current page\n\n- X-Pagination-Limit: maximum number of items on a page\n"},{"disabled":false,"key":"includeVouchers","value":"false","description":"\nWhen `true`, promotion with defined vouchers will also have list of assigned vouchers.\n\nWhen `false`, vouchers will not be fetched.\n"},{"disabled":false,"key":"storeIds","value":"string","description":"Limits the response to data from particular stores, identified by IDs."}],"variable":[{"disabled":false,"type":"any","value":"email","key":"identifierType","description":"(Required) The Profile identifier to use for the request.\n\n`externalId` is known as `customId` or `custom_identify` in other Synerise services.\n"},{"disabled":false,"type":"any","value":"string","key":"identifierValue","description":"(Required) The value of the selected identifier"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"e8b98ae8-4f63-472c-911a-f3d499614a6a","name":"An array of promotions","originalRequest":{"url":{"path":["v4","promotions","promotion","get-for-client",":identifierType",":identifierValue"],"host":["{{baseUrl}}"],"query":[{"key":"sort","value":"requireRedeemedPoints,desc"},{"key":"status","value":"ACTIVE,ACTIVE"},{"key":"tagNames","value":"string,string"},{"key":"target","value":"ALL,ALL"},{"key":"type","value":"GENERAL,CUSTOM"},{"key":"presentOnly","value":"true"},{"key":"lastingOnly","value":"true"},{"key":"displayableOnly","value":"true"},{"key":"limit","value":"100"},{"key":"page","value":"4"},{"key":"includeMeta","value":"false"},{"key":"includeVouchers","value":"false"},{"key":"storeIds","value":"string"}],"variable":[{"disabled":false,"type":"any","value":"email","key":"identifierType","description":"(Required) The Profile identifier to use for the request.\n\n`externalId` is known as `customId` or `custom_identify` in other Synerise services.\n"},{"disabled":false,"type":"any","value":"string","key":"identifierValue","description":"(Required) The value of the selected identifier"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"data\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"meta\": {\n \"code\": {\n \"value\": \"\"\n },\n \"limit\": {\n \"value\": \"\"\n },\n \"link\": {\n \"value\": \"\"\n },\n \"page\": {\n \"value\": \"\"\n },\n \"totalCount\": {\n \"value\": \"\"\n },\n \"totalPages\": {\n \"value\": \"\"\n }\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"1286b324-ace6-417f-81c1-e2f80085909d","name":"Request body invalid/malformed/missing elements","originalRequest":{"url":{"path":["v4","promotions","promotion","get-for-client",":identifierType",":identifierValue"],"host":["{{baseUrl}}"],"query":[{"key":"sort","value":"requireRedeemedPoints,desc"},{"key":"status","value":"ACTIVE,ACTIVE"},{"key":"tagNames","value":"string,string"},{"key":"target","value":"ALL,ALL"},{"key":"type","value":"GENERAL,CUSTOM"},{"key":"presentOnly","value":"true"},{"key":"lastingOnly","value":"true"},{"key":"displayableOnly","value":"true"},{"key":"limit","value":"100"},{"key":"page","value":"4"},{"key":"includeMeta","value":"false"},{"key":"includeVouchers","value":"false"},{"key":"storeIds","value":"string"}],"variable":[{"disabled":false,"type":"any","value":"email","key":"identifierType","description":"(Required) The Profile identifier to use for the request.\n\n`externalId` is known as `customId` or `custom_identify` in other Synerise services.\n"},{"disabled":false,"type":"any","value":"string","key":"identifierValue","description":"(Required) The value of the selected identifier"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"message\": {\n \"value\": \"\"\n },\n \"error\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"61f0e616-0412-4ef7-be89-88a33dc5ecc7","name":"Unauthorized","originalRequest":{"url":{"path":["v4","promotions","promotion","get-for-client",":identifierType",":identifierValue"],"host":["{{baseUrl}}"],"query":[{"key":"sort","value":"requireRedeemedPoints,desc"},{"key":"status","value":"ACTIVE,ACTIVE"},{"key":"tagNames","value":"string,string"},{"key":"target","value":"ALL,ALL"},{"key":"type","value":"GENERAL,CUSTOM"},{"key":"presentOnly","value":"true"},{"key":"lastingOnly","value":"true"},{"key":"displayableOnly","value":"true"},{"key":"limit","value":"100"},{"key":"page","value":"4"},{"key":"includeMeta","value":"false"},{"key":"includeVouchers","value":"false"},{"key":"storeIds","value":"string"}],"variable":[{"disabled":false,"type":"any","value":"email","key":"identifierType","description":"(Required) The Profile identifier to use for the request.\n\n`externalId` is known as `customId` or `custom_identify` in other Synerise services.\n"},{"disabled":false,"type":"any","value":"string","key":"identifierValue","description":"(Required) The value of the selected identifier"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"status\": 7751,\n \"error\": \"string\",\n \"message\": \"string\",\n \"timestamp\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"9e531269-eed1-4f34-b80a-f0a40133fb60","name":"Forbidden","originalRequest":{"url":{"path":["v4","promotions","promotion","get-for-client",":identifierType",":identifierValue"],"host":["{{baseUrl}}"],"query":[{"key":"sort","value":"requireRedeemedPoints,desc"},{"key":"status","value":"ACTIVE,ACTIVE"},{"key":"tagNames","value":"string,string"},{"key":"target","value":"ALL,ALL"},{"key":"type","value":"GENERAL,CUSTOM"},{"key":"presentOnly","value":"true"},{"key":"lastingOnly","value":"true"},{"key":"displayableOnly","value":"true"},{"key":"limit","value":"100"},{"key":"page","value":"4"},{"key":"includeMeta","value":"false"},{"key":"includeVouchers","value":"false"},{"key":"storeIds","value":"string"}],"variable":[{"disabled":false,"type":"any","value":"email","key":"identifierType","description":"(Required) The Profile identifier to use for the request.\n\n`externalId` is known as `customId` or `custom_identify` in other Synerise services.\n"},{"disabled":false,"type":"any","value":"string","key":"identifierValue","description":"(Required) The value of the selected identifier"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"status\": 7751,\n \"error\": \"string\",\n \"message\": \"string\",\n \"timestamp\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"739b2dbb-9b88-406f-a295-9535cd784f27","name":"Profile not found","originalRequest":{"url":{"path":["v4","promotions","promotion","get-for-client",":identifierType",":identifierValue"],"host":["{{baseUrl}}"],"query":[{"key":"sort","value":"requireRedeemedPoints,desc"},{"key":"status","value":"ACTIVE,ACTIVE"},{"key":"tagNames","value":"string,string"},{"key":"target","value":"ALL,ALL"},{"key":"type","value":"GENERAL,CUSTOM"},{"key":"presentOnly","value":"true"},{"key":"lastingOnly","value":"true"},{"key":"displayableOnly","value":"true"},{"key":"limit","value":"100"},{"key":"page","value":"4"},{"key":"includeMeta","value":"false"},{"key":"includeVouchers","value":"false"},{"key":"storeIds","value":"string"}],"variable":[{"disabled":false,"type":"any","value":"email","key":"identifierType","description":"(Required) The Profile identifier to use for the request.\n\n`externalId` is known as `customId` or `custom_identify` in other Synerise services.\n"},{"disabled":false,"type":"any","value":"string","key":"identifierValue","description":"(Required) The value of the selected identifier"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"message\": \"Profile not found\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"7673ea55-20d8-42b1-89ff-0c30ab3aa36a","name":"Get redeemable promotions of a Profile","request":{"name":"Get redeemable promotions of a Profile","description":{"content":"Retrieve all redeemable promotions related to a Profile.\n\n**IMPORTANT**: \n- As a result of this request, the `targetSegments` of all the matching promotions are checked. If this results in checking more than 100 unique segments, any segments above this limit may be ignored.\n- The endpoint is limited to 25000 requests per minute (per workspace).\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User\n\n**API key permission required:** `PROMOTIONS_REDEEM_PROMOTIONS_READ`\n\n**User role permission required:** `campaigns_promotions: read`\n","type":"text/plain"},"url":{"path":["v4","promotions","promotion","get-for-client-possible-to-redeem",":identifierType",":identifierValue"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"sort","value":"requireRedeemedPoints,desc","description":"The sorting order of the response.\n\n\n You can sort by any combination of the following attributes:\n * `headerName`: promotion header name\n * `name`: promotion name\n * `code`: promotion code\n * `startAt`: time when the promotion starts\n * `createdAt`: time when the promotion was created\n * `updatedAt`: time when the promotion was last updated\n * `expireAt`: time when the promotion expires\n * `requireRedeemedPoints`: how many loyalty points are needed to redeem the promotion\n * `type`: type of the promotion\n * `priority`: priority of the promotion\n * `status` : status of the promotion for the Profile\n\n You can sort ascending (default) or descending by adding `asc` or `desc` after the parameter, separated by a comma.\n\n **Example**: `sort=requireRedeemedPoints&sort=expireAt,asc&sort=status,desc`\n"},{"disabled":false,"key":"presentOnly","value":"true","description":"When set to:\n- `true`, the response includes only promotions that are currently active (startAt later than now or null, expireAt later than now or null)\n- `false`, the response includes the above and also promotions that are expired or will become active in the future.\n"},{"disabled":false,"key":"lastingOnly","value":"true","description":"When set to `true`, shows promotions/vouchers that are currently active and those that are still inactivated. (lastingAt set to null or lastingAt in future)"},{"disabled":false,"key":"displayableOnly","value":"true","description":"When set to `true`, promotions which are not currently active are included in response, according to date range defined in promotion fields `displayFrom` and `displayTo`."},{"disabled":false,"key":"status","value":"REDEEMED,ACTIVE","description":"Filter by promotion status"},{"disabled":false,"key":"type","value":"GENERAL,CUSTOM","description":"Promotion type"},{"disabled":false,"key":"statusByType","value":"[CUSTOM]=ACTIVE","description":"A combination of status and type, for example `[CUSTOM]=ACTIVE`"},{"disabled":false,"key":"targetByType","value":"[SEGMENT]=ACTIVE","description":"A combination of target and type, for example `[SEGMENT]=ACTIVE`"},{"disabled":false,"key":"includeMeta","value":"false","description":"\nWhen `true`, pagination metadata is included in the response body.\n\nWhen `false`, the data is included in the response headers:\n\n- Link: links to neighbors, first, and last pages in pagination.\n\n- X-Pagination-Total-Count: total number of items on all pages\n\n- X-Pagination-Total-Pages: total number of pages\n\n- X-Pagination-Page: current page\n\n- X-Pagination-Limit: maximum number of items on a page\n"},{"disabled":false,"key":"page","value":"4","description":"Page number to return for pagination. The first page has the index `1`."},{"disabled":false,"key":"limit","value":"100","description":"The number of items to return per page"},{"disabled":false,"key":"target","value":"ALL,ALL","description":"The target of the promotion"},{"disabled":false,"key":"storeIds","value":"string","description":"Limits the response to data from particular stores, identified by IDs."}],"variable":[{"disabled":false,"type":"any","value":"email","key":"identifierType","description":"(Required) The Profile identifier to use for the request.\n\n`externalId` is known as `customId` or `custom_identify` in other Synerise services.\n"},{"disabled":false,"type":"any","value":"string","key":"identifierValue","description":"(Required) The value of the selected identifier"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"37059ad8-7b82-41d5-b01c-8724e96b9a4e","name":"An array of promotions","originalRequest":{"url":{"path":["v4","promotions","promotion","get-for-client-possible-to-redeem",":identifierType",":identifierValue"],"host":["{{baseUrl}}"],"query":[{"key":"sort","value":"requireRedeemedPoints,desc"},{"key":"presentOnly","value":"true"},{"key":"lastingOnly","value":"true"},{"key":"displayableOnly","value":"true"},{"key":"status","value":"REDEEMED,ACTIVE"},{"key":"type","value":"GENERAL,CUSTOM"},{"key":"statusByType","value":"[CUSTOM]=ACTIVE"},{"key":"targetByType","value":"[SEGMENT]=ACTIVE"},{"key":"includeMeta","value":"false"},{"key":"page","value":"4"},{"key":"limit","value":"100"},{"key":"target","value":"ALL,ALL"},{"key":"storeIds","value":"string"}],"variable":[{"disabled":false,"type":"any","value":"email","key":"identifierType","description":"(Required) The Profile identifier to use for the request.\n\n`externalId` is known as `customId` or `custom_identify` in other Synerise services.\n"},{"disabled":false,"type":"any","value":"string","key":"identifierValue","description":"(Required) The value of the selected identifier"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"data\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"meta\": {\n \"code\": {\n \"value\": \"\"\n },\n \"limit\": {\n \"value\": \"\"\n },\n \"link\": {\n \"value\": \"\"\n },\n \"page\": {\n \"value\": \"\"\n },\n \"totalCount\": {\n \"value\": \"\"\n },\n \"totalPages\": {\n \"value\": \"\"\n }\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"0dc40f99-f24e-4af1-920c-98693421e02d","name":"Request body invalid/malformed/missing elements","originalRequest":{"url":{"path":["v4","promotions","promotion","get-for-client-possible-to-redeem",":identifierType",":identifierValue"],"host":["{{baseUrl}}"],"query":[{"key":"sort","value":"requireRedeemedPoints,desc"},{"key":"presentOnly","value":"true"},{"key":"lastingOnly","value":"true"},{"key":"displayableOnly","value":"true"},{"key":"status","value":"REDEEMED,ACTIVE"},{"key":"type","value":"GENERAL,CUSTOM"},{"key":"statusByType","value":"[CUSTOM]=ACTIVE"},{"key":"targetByType","value":"[SEGMENT]=ACTIVE"},{"key":"includeMeta","value":"false"},{"key":"page","value":"4"},{"key":"limit","value":"100"},{"key":"target","value":"ALL,ALL"},{"key":"storeIds","value":"string"}],"variable":[{"disabled":false,"type":"any","value":"email","key":"identifierType","description":"(Required) The Profile identifier to use for the request.\n\n`externalId` is known as `customId` or `custom_identify` in other Synerise services.\n"},{"disabled":false,"type":"any","value":"string","key":"identifierValue","description":"(Required) The value of the selected identifier"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"message\": {\n \"value\": \"\"\n },\n \"error\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"861c82d7-279c-44d1-b8b5-1b4a7bebf6b4","name":"Unauthorized","originalRequest":{"url":{"path":["v4","promotions","promotion","get-for-client-possible-to-redeem",":identifierType",":identifierValue"],"host":["{{baseUrl}}"],"query":[{"key":"sort","value":"requireRedeemedPoints,desc"},{"key":"presentOnly","value":"true"},{"key":"lastingOnly","value":"true"},{"key":"displayableOnly","value":"true"},{"key":"status","value":"REDEEMED,ACTIVE"},{"key":"type","value":"GENERAL,CUSTOM"},{"key":"statusByType","value":"[CUSTOM]=ACTIVE"},{"key":"targetByType","value":"[SEGMENT]=ACTIVE"},{"key":"includeMeta","value":"false"},{"key":"page","value":"4"},{"key":"limit","value":"100"},{"key":"target","value":"ALL,ALL"},{"key":"storeIds","value":"string"}],"variable":[{"disabled":false,"type":"any","value":"email","key":"identifierType","description":"(Required) The Profile identifier to use for the request.\n\n`externalId` is known as `customId` or `custom_identify` in other Synerise services.\n"},{"disabled":false,"type":"any","value":"string","key":"identifierValue","description":"(Required) The value of the selected identifier"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"status\": 7751,\n \"error\": \"string\",\n \"message\": \"string\",\n \"timestamp\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"4d0c5127-5810-43cd-b724-e7e3e402bc0a","name":"Forbidden","originalRequest":{"url":{"path":["v4","promotions","promotion","get-for-client-possible-to-redeem",":identifierType",":identifierValue"],"host":["{{baseUrl}}"],"query":[{"key":"sort","value":"requireRedeemedPoints,desc"},{"key":"presentOnly","value":"true"},{"key":"lastingOnly","value":"true"},{"key":"displayableOnly","value":"true"},{"key":"status","value":"REDEEMED,ACTIVE"},{"key":"type","value":"GENERAL,CUSTOM"},{"key":"statusByType","value":"[CUSTOM]=ACTIVE"},{"key":"targetByType","value":"[SEGMENT]=ACTIVE"},{"key":"includeMeta","value":"false"},{"key":"page","value":"4"},{"key":"limit","value":"100"},{"key":"target","value":"ALL,ALL"},{"key":"storeIds","value":"string"}],"variable":[{"disabled":false,"type":"any","value":"email","key":"identifierType","description":"(Required) The Profile identifier to use for the request.\n\n`externalId` is known as `customId` or `custom_identify` in other Synerise services.\n"},{"disabled":false,"type":"any","value":"string","key":"identifierValue","description":"(Required) The value of the selected identifier"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"status\": 7751,\n \"error\": \"string\",\n \"message\": \"string\",\n \"timestamp\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"74c9d050-a92d-4857-ba73-3b4f4a007b6e","name":"Get promotion details as Workspace","request":{"name":"Get promotion details as Workspace","description":{"content":"Retrieve the details of a promotion by its code.\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User\n\n**API key permission required:** `PROMOTIONS_DETAILS_FOR_PROFILE_PROMOTIONS_READ`\n\n**User role permission required:** `campaigns_promotions: read`\n","type":"text/plain"},"url":{"path":["v4","promotions","promotion",":identifierType",":identifierValue"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"uuid","key":"identifierType","description":"(Required) The promotion identifier to use for the request"},{"disabled":false,"type":"any","value":"string","key":"identifierValue","description":"(Required) The value of the selected identifier"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"48e0abdd-b6a3-49db-aeef-e9698e51838d","name":"Details of a promotion","originalRequest":{"url":{"path":["v4","promotions","promotion",":identifierType",":identifierValue"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"uuid","key":"identifierType","description":"(Required) The promotion identifier to use for the request"},{"disabled":false,"type":"any","value":"string","key":"identifierValue","description":"(Required) The value of the selected identifier"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"data\": {\n \"uuid\": {\n \"value\": \"\"\n },\n \"code\": {\n \"value\": \"\"\n },\n \"status\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"redeemLimitPerClient\": {\n \"value\": \"\"\n },\n \"redeemQuantityPerActivation\": {\n \"value\": \"\"\n },\n \"redeemLimitGlobal\": {\n \"value\": \"\"\n },\n \"activationLimitGlobalType\": {\n \"value\": \"\"\n },\n \"activationLimitGlobalLimit\": {\n \"value\": \"\"\n },\n \"activationLimitGlobalCounter\": {\n \"value\": \"\"\n },\n \"activationLimitGlobalRelativeMinutes\": {\n \"value\": \"\"\n },\n \"activationLimitGlobalReached\": {\n \"value\": \"\"\n },\n \"redeemType\": {\n \"value\": \"\"\n },\n \"discountType\": {\n \"value\": \"\"\n },\n \"details\": {\n \"value\": \"\"\n },\n \"discountValue\": {\n \"value\": \"\"\n },\n \"discountMode\": {\n \"value\": \"\"\n },\n \"discountModeDetails\": {\n \"value\": \"\"\n },\n \"preDiscountValue\": {\n \"value\": \"\"\n },\n \"requireRedeemedPoints\": {\n \"value\": \"\"\n },\n \"headerName\": {\n \"value\": \"\"\n },\n \"headerDescription\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"headline\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n },\n \"images\": {\n \"value\": \"\"\n },\n \"tags\": {\n \"value\": \"\"\n },\n \"createdAt\": {\n \"value\": \"\"\n },\n \"startAt\": {\n \"value\": \"\"\n },\n \"expireAt\": {\n \"value\": \"\"\n },\n \"displayFrom\": {\n \"value\": \"\"\n },\n \"displayTo\": {\n \"value\": \"\"\n },\n \"lastingTime\": {\n \"value\": \"\"\n },\n \"params\": {\n \"value\": \"\"\n },\n \"itemScope\": {\n \"value\": \"\"\n },\n \"minBasketValue\": {\n \"value\": \"\"\n },\n \"maxBasketValue\": {\n \"value\": \"\"\n },\n \"catalog\": {\n \"value\": \"\"\n },\n \"catalogItemType\": {\n \"value\": \"\"\n },\n \"catalogIndexItems\": {\n \"value\": \"\"\n },\n \"catalogFilterIds\": {\n \"value\": \"\"\n },\n \"catalogFilterQuery\": {\n \"value\": \"\"\n },\n \"storeCatalog\": {\n \"value\": \"\"\n },\n \"storeItemType\": {\n \"value\": \"\"\n },\n \"storeIds\": {\n \"value\": \"\"\n },\n \"targetType\": {\n \"value\": \"\"\n },\n \"targetSegment\": {\n \"value\": \"\"\n },\n \"behavioralFilter\": {\n \"value\": \"\"\n },\n \"price\": {\n \"value\": \"\"\n },\n \"priority\": {\n \"value\": \"\"\n },\n \"metric\": {\n \"value\": \"\"\n },\n \"importHash\": {\n \"value\": \"\"\n }\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"cabdbf68-63ab-49cd-979e-798c6d484c28","name":"Request body invalid/malformed/missing elements","originalRequest":{"url":{"path":["v4","promotions","promotion",":identifierType",":identifierValue"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"uuid","key":"identifierType","description":"(Required) The promotion identifier to use for the request"},{"disabled":false,"type":"any","value":"string","key":"identifierValue","description":"(Required) The value of the selected identifier"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"message\": {\n \"value\": \"\"\n },\n \"error\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"afc3c947-cde0-4132-97fc-945bcacc04c3","name":"Unauthorized","originalRequest":{"url":{"path":["v4","promotions","promotion",":identifierType",":identifierValue"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"uuid","key":"identifierType","description":"(Required) The promotion identifier to use for the request"},{"disabled":false,"type":"any","value":"string","key":"identifierValue","description":"(Required) The value of the selected identifier"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"status\": 7751,\n \"error\": \"string\",\n \"message\": \"string\",\n \"timestamp\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"8762fad6-d95f-4590-a92c-d74898a7d04d","name":"Forbidden","originalRequest":{"url":{"path":["v4","promotions","promotion",":identifierType",":identifierValue"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"uuid","key":"identifierType","description":"(Required) The promotion identifier to use for the request"},{"disabled":false,"type":"any","value":"string","key":"identifierValue","description":"(Required) The value of the selected identifier"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"status\": 7751,\n \"error\": \"string\",\n \"message\": \"string\",\n \"timestamp\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"0a95d17a-e352-4d69-baf0-6534d8a6f95d","name":"Not Found","originalRequest":{"url":{"path":["v4","promotions","promotion",":identifierType",":identifierValue"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"uuid","key":"identifierType","description":"(Required) The promotion identifier to use for the request"},{"disabled":false,"type":"any","value":"string","key":"identifierValue","description":"(Required) The value of the selected identifier"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"message\": \"Object not found\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"7685d2c1-b62d-47ab-9adb-073dc974f757","name":"Update a promotion","request":{"name":"Update a promotion","description":{"content":"You can update an existing promotion. Include only the fields that you want to change. Inserting a null value overwrites an existing value.\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User\n\n**API key permission required:** `PROMOTIONS_DETAILS_FOR_PROFILE_PROMOTIONS_UPDATE`\n\n**User role permission required:** `campaigns_promotions: update`\n","type":"text/plain"},"url":{"path":["v4","promotions","promotion",":identifierType",":identifierValue"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"uuid","key":"identifierType","description":"(Required) The promotion identifier to use for the request"},{"disabled":false,"type":"any","value":"string","key":"identifierValue","description":"(Required) The value of the selected identifier"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PUT","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"visibilityStatus\": \"DRAFT\",\n \"type\": \"GENERAL\",\n \"redeemLimitPerClient\": 0,\n \"redeemQuantityPerActivation\": 3806075,\n \"redeemLimitGlobal\": 0,\n \"redeemType\": \"FULL\",\n \"details\": {\n \"discountType\": {\n \"value\": \"\"\n },\n \"cashbackSettings\": {\n \"value\": \"\"\n }\n },\n \"discountType\": \"NONE\",\n \"discountValue\": 0,\n \"discountMode\": \"STATIC\",\n \"discountModeDetails\": {\n \"steps\": {\n \"value\": \"\"\n },\n \"discountUsageTrigger\": {\n \"value\": \"\"\n }\n },\n \"preDiscountValue\": 0,\n \"requireRedeemedPoints\": 9638.335689473051,\n \"headerName\": \"string\",\n \"headerDescription\": \"string\",\n \"name\": \"string\",\n \"headline\": \"string\",\n \"description\": \"string\",\n \"images\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"tags\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"startAt\": \"2026-05-16T18:27:31.621Z\",\n \"expireAt\": \"1981-08-14T17:43:57.894Z\",\n \"displayFrom\": \"string\",\n \"displayTo\": \"string\",\n \"lastingTime\": 0,\n \"params\": {\n \"key_0\": 4338.417462735775\n },\n \"itemScope\": \"LINE_ITEM\",\n \"minBasketValue\": null,\n \"maxBasketValue\": null,\n \"catalog\": \"221\",\n \"catalogItemType\": \"FILTERED\",\n \"catalogFilterIds\": [\n \"f978b20f-7156-40ed-99c2-3af62b76af12\"\n ],\n \"catalogFilterQuery\": \"color==green;price=lt=100\",\n \"excludeCatalog\": \"string\",\n \"excludeCatalogItemType\": \"SELECTED\",\n \"excludeCatalogIndexItems\": [\n \"29727276\"\n ],\n \"excludeCatalogFilterQuery\": \"brand==acme\",\n \"activationLimitGlobalType\": \"LIFETIME\",\n \"activationLimitGlobalLimit\": 1946494398,\n \"activationLimitGlobalRelativeMinutes\": null,\n \"storeCatalog\": \"string\",\n \"storeItemType\": \"ALL\",\n \"storeIds\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"targetType\": \"ALL\",\n \"targetSegment\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"behavioralFilter\": \"productbuyhistory=has='sku=in=(SKU123);ts=rolling=30d'\",\n \"price\": 0,\n \"priority\": 250,\n \"voucherPool\": {\n \"enabled\": {\n \"value\": \"\"\n },\n \"uuid\": {\n \"value\": \"\"\n },\n \"transferable\": {\n \"value\": \"\"\n }\n },\n \"importHash\": \"d0bcc8ba-79f5-b4ef-4209-b200bea2e6db\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"9f2531b2-deb9-4a91-b6f9-7fe6e189802a","name":"Promotion updated","originalRequest":{"url":{"path":["v4","promotions","promotion",":identifierType",":identifierValue"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"uuid","key":"identifierType","description":"(Required) The promotion identifier to use for the request"},{"disabled":false,"type":"any","value":"string","key":"identifierValue","description":"(Required) The value of the selected identifier"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"{\n \"visibilityStatus\": \"DRAFT\",\n \"type\": \"GENERAL\",\n \"redeemLimitPerClient\": 0,\n \"redeemQuantityPerActivation\": 24493,\n \"redeemLimitGlobal\": 0,\n \"redeemType\": \"PARTIAL\",\n \"details\": {\n \"discountType\": {\n \"value\": \"\"\n },\n \"cashbackSettings\": {\n \"value\": \"\"\n }\n },\n \"discountType\": \"NONE\",\n \"discountValue\": 0,\n \"discountMode\": \"STATIC\",\n \"discountModeDetails\": {\n \"steps\": {\n \"value\": \"\"\n },\n \"discountUsageTrigger\": {\n \"value\": \"\"\n }\n },\n \"preDiscountValue\": 0,\n \"requireRedeemedPoints\": 2687.0724602141804,\n \"headerName\": \"string\",\n \"headerDescription\": \"string\",\n \"name\": \"string\",\n \"headline\": \"string\",\n \"description\": \"string\",\n \"images\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"tags\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"startAt\": \"1988-05-05T10:25:04.449Z\",\n \"expireAt\": \"2004-10-22T16:51:51.993Z\",\n \"displayFrom\": \"string\",\n \"displayTo\": \"string\",\n \"lastingTime\": 0,\n \"params\": {\n \"key_0\": true\n },\n \"itemScope\": \"LINE_ITEM\",\n \"minBasketValue\": null,\n \"maxBasketValue\": null,\n \"catalog\": \"221\",\n \"catalogItemType\": \"FILTERED\",\n \"catalogFilterIds\": [\n \"f978b20f-7156-40ed-99c2-3af62b76af12\"\n ],\n \"catalogFilterQuery\": \"color==green;price=lt=100\",\n \"excludeCatalog\": \"string\",\n \"excludeCatalogItemType\": \"SELECTED\",\n \"excludeCatalogIndexItems\": [\n \"29727276\"\n ],\n \"excludeCatalogFilterQuery\": \"brand==acme\",\n \"activationLimitGlobalType\": \"LIFETIME\",\n \"activationLimitGlobalLimit\": 711368197,\n \"activationLimitGlobalRelativeMinutes\": null,\n \"storeCatalog\": \"string\",\n \"storeItemType\": \"ALL\",\n \"storeIds\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"targetType\": \"ALL\",\n \"targetSegment\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"behavioralFilter\": \"productbuyhistory=has='sku=in=(SKU123);ts=rolling=30d'\",\n \"price\": 0,\n \"priority\": 250,\n \"voucherPool\": {\n \"enabled\": {\n \"value\": \"\"\n },\n \"uuid\": {\n \"value\": \"\"\n },\n \"transferable\": {\n \"value\": \"\"\n }\n },\n \"importHash\": \"30608498-a578-d9b6-a244-a1a305e303db\"\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"message\": \"string\",\n \"data\": {\n \"uuid\": {\n \"value\": \"\"\n },\n \"code\": {\n \"value\": \"\"\n },\n \"status\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"redeemLimitPerClient\": {\n \"value\": \"\"\n },\n \"redeemQuantityPerActivation\": {\n \"value\": \"\"\n },\n \"redeemLimitGlobal\": {\n \"value\": \"\"\n },\n \"activationLimitGlobalType\": {\n \"value\": \"\"\n },\n \"activationLimitGlobalLimit\": {\n \"value\": \"\"\n },\n \"activationLimitGlobalCounter\": {\n \"value\": \"\"\n },\n \"activationLimitGlobalRelativeMinutes\": {\n \"value\": \"\"\n },\n \"activationLimitGlobalReached\": {\n \"value\": \"\"\n },\n \"redeemType\": {\n \"value\": \"\"\n },\n \"discountType\": {\n \"value\": \"\"\n },\n \"details\": {\n \"value\": \"\"\n },\n \"discountValue\": {\n \"value\": \"\"\n },\n \"discountMode\": {\n \"value\": \"\"\n },\n \"discountModeDetails\": {\n \"value\": \"\"\n },\n \"preDiscountValue\": {\n \"value\": \"\"\n },\n \"requireRedeemedPoints\": {\n \"value\": \"\"\n },\n \"headerName\": {\n \"value\": \"\"\n },\n \"headerDescription\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"headline\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n },\n \"images\": {\n \"value\": \"\"\n },\n \"tags\": {\n \"value\": \"\"\n },\n \"createdAt\": {\n \"value\": \"\"\n },\n \"startAt\": {\n \"value\": \"\"\n },\n \"expireAt\": {\n \"value\": \"\"\n },\n \"displayFrom\": {\n \"value\": \"\"\n },\n \"displayTo\": {\n \"value\": \"\"\n },\n \"lastingTime\": {\n \"value\": \"\"\n },\n \"params\": {\n \"value\": \"\"\n },\n \"itemScope\": {\n \"value\": \"\"\n },\n \"minBasketValue\": {\n \"value\": \"\"\n },\n \"maxBasketValue\": {\n \"value\": \"\"\n },\n \"catalog\": {\n \"value\": \"\"\n },\n \"catalogItemType\": {\n \"value\": \"\"\n },\n \"catalogIndexItems\": {\n \"value\": \"\"\n },\n \"catalogFilterIds\": {\n \"value\": \"\"\n },\n \"catalogFilterQuery\": {\n \"value\": \"\"\n },\n \"storeCatalog\": {\n \"value\": \"\"\n },\n \"storeItemType\": {\n \"value\": \"\"\n },\n \"storeIds\": {\n \"value\": \"\"\n },\n \"targetType\": {\n \"value\": \"\"\n },\n \"targetSegment\": {\n \"value\": \"\"\n },\n \"behavioralFilter\": {\n \"value\": \"\"\n },\n \"price\": {\n \"value\": \"\"\n },\n \"priority\": {\n \"value\": \"\"\n },\n \"metric\": {\n \"value\": \"\"\n },\n \"importHash\": {\n \"value\": \"\"\n }\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"fb4d2c8e-7a4b-4f41-a3ec-8e82c9e16f88","name":"Request body invalid/malformed/missing elements","originalRequest":{"url":{"path":["v4","promotions","promotion",":identifierType",":identifierValue"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"uuid","key":"identifierType","description":"(Required) The promotion identifier to use for the request"},{"disabled":false,"type":"any","value":"string","key":"identifierValue","description":"(Required) The value of the selected identifier"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"{\n \"visibilityStatus\": \"DRAFT\",\n \"type\": \"GENERAL\",\n \"redeemLimitPerClient\": 0,\n \"redeemQuantityPerActivation\": 24493,\n \"redeemLimitGlobal\": 0,\n \"redeemType\": \"PARTIAL\",\n \"details\": {\n \"discountType\": {\n \"value\": \"\"\n },\n \"cashbackSettings\": {\n \"value\": \"\"\n }\n },\n \"discountType\": \"NONE\",\n \"discountValue\": 0,\n \"discountMode\": \"STATIC\",\n \"discountModeDetails\": {\n \"steps\": {\n \"value\": \"\"\n },\n \"discountUsageTrigger\": {\n \"value\": \"\"\n }\n },\n \"preDiscountValue\": 0,\n \"requireRedeemedPoints\": 2687.0724602141804,\n \"headerName\": \"string\",\n \"headerDescription\": \"string\",\n \"name\": \"string\",\n \"headline\": \"string\",\n \"description\": \"string\",\n \"images\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"tags\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"startAt\": \"1988-05-05T10:25:04.449Z\",\n \"expireAt\": \"2004-10-22T16:51:51.993Z\",\n \"displayFrom\": \"string\",\n \"displayTo\": \"string\",\n \"lastingTime\": 0,\n \"params\": {\n \"key_0\": true\n },\n \"itemScope\": \"LINE_ITEM\",\n \"minBasketValue\": null,\n \"maxBasketValue\": null,\n \"catalog\": \"221\",\n \"catalogItemType\": \"FILTERED\",\n \"catalogFilterIds\": [\n \"f978b20f-7156-40ed-99c2-3af62b76af12\"\n ],\n \"catalogFilterQuery\": \"color==green;price=lt=100\",\n \"excludeCatalog\": \"string\",\n \"excludeCatalogItemType\": \"SELECTED\",\n \"excludeCatalogIndexItems\": [\n \"29727276\"\n ],\n \"excludeCatalogFilterQuery\": \"brand==acme\",\n \"activationLimitGlobalType\": \"LIFETIME\",\n \"activationLimitGlobalLimit\": 711368197,\n \"activationLimitGlobalRelativeMinutes\": null,\n \"storeCatalog\": \"string\",\n \"storeItemType\": \"ALL\",\n \"storeIds\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"targetType\": \"ALL\",\n \"targetSegment\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"behavioralFilter\": \"productbuyhistory=has='sku=in=(SKU123);ts=rolling=30d'\",\n \"price\": 0,\n \"priority\": 250,\n \"voucherPool\": {\n \"enabled\": {\n \"value\": \"\"\n },\n \"uuid\": {\n \"value\": \"\"\n },\n \"transferable\": {\n \"value\": \"\"\n }\n },\n \"importHash\": \"30608498-a578-d9b6-a244-a1a305e303db\"\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"message\": {\n \"value\": \"\"\n },\n \"error\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"5ba91848-f003-4f19-9a5e-8547407840d7","name":"Unauthorized","originalRequest":{"url":{"path":["v4","promotions","promotion",":identifierType",":identifierValue"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"uuid","key":"identifierType","description":"(Required) The promotion identifier to use for the request"},{"disabled":false,"type":"any","value":"string","key":"identifierValue","description":"(Required) The value of the selected identifier"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"{\n \"visibilityStatus\": \"DRAFT\",\n \"type\": \"GENERAL\",\n \"redeemLimitPerClient\": 0,\n \"redeemQuantityPerActivation\": 24493,\n \"redeemLimitGlobal\": 0,\n \"redeemType\": \"PARTIAL\",\n \"details\": {\n \"discountType\": {\n \"value\": \"\"\n },\n \"cashbackSettings\": {\n \"value\": \"\"\n }\n },\n \"discountType\": \"NONE\",\n \"discountValue\": 0,\n \"discountMode\": \"STATIC\",\n \"discountModeDetails\": {\n \"steps\": {\n \"value\": \"\"\n },\n \"discountUsageTrigger\": {\n \"value\": \"\"\n }\n },\n \"preDiscountValue\": 0,\n \"requireRedeemedPoints\": 2687.0724602141804,\n \"headerName\": \"string\",\n \"headerDescription\": \"string\",\n \"name\": \"string\",\n \"headline\": \"string\",\n \"description\": \"string\",\n \"images\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"tags\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"startAt\": \"1988-05-05T10:25:04.449Z\",\n \"expireAt\": \"2004-10-22T16:51:51.993Z\",\n \"displayFrom\": \"string\",\n \"displayTo\": \"string\",\n \"lastingTime\": 0,\n \"params\": {\n \"key_0\": true\n },\n \"itemScope\": \"LINE_ITEM\",\n \"minBasketValue\": null,\n \"maxBasketValue\": null,\n \"catalog\": \"221\",\n \"catalogItemType\": \"FILTERED\",\n \"catalogFilterIds\": [\n \"f978b20f-7156-40ed-99c2-3af62b76af12\"\n ],\n \"catalogFilterQuery\": \"color==green;price=lt=100\",\n \"excludeCatalog\": \"string\",\n \"excludeCatalogItemType\": \"SELECTED\",\n \"excludeCatalogIndexItems\": [\n \"29727276\"\n ],\n \"excludeCatalogFilterQuery\": \"brand==acme\",\n \"activationLimitGlobalType\": \"LIFETIME\",\n \"activationLimitGlobalLimit\": 711368197,\n \"activationLimitGlobalRelativeMinutes\": null,\n \"storeCatalog\": \"string\",\n \"storeItemType\": \"ALL\",\n \"storeIds\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"targetType\": \"ALL\",\n \"targetSegment\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"behavioralFilter\": \"productbuyhistory=has='sku=in=(SKU123);ts=rolling=30d'\",\n \"price\": 0,\n \"priority\": 250,\n \"voucherPool\": {\n \"enabled\": {\n \"value\": \"\"\n },\n \"uuid\": {\n \"value\": \"\"\n },\n \"transferable\": {\n \"value\": \"\"\n }\n },\n \"importHash\": \"30608498-a578-d9b6-a244-a1a305e303db\"\n}","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"status\": 7751,\n \"error\": \"string\",\n \"message\": \"string\",\n \"timestamp\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"72bd9a65-34da-4861-beac-bd54686ff775","name":"Forbidden","originalRequest":{"url":{"path":["v4","promotions","promotion",":identifierType",":identifierValue"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"uuid","key":"identifierType","description":"(Required) The promotion identifier to use for the request"},{"disabled":false,"type":"any","value":"string","key":"identifierValue","description":"(Required) The value of the selected identifier"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"{\n \"visibilityStatus\": \"DRAFT\",\n \"type\": \"GENERAL\",\n \"redeemLimitPerClient\": 0,\n \"redeemQuantityPerActivation\": 24493,\n \"redeemLimitGlobal\": 0,\n \"redeemType\": \"PARTIAL\",\n \"details\": {\n \"discountType\": {\n \"value\": \"\"\n },\n \"cashbackSettings\": {\n \"value\": \"\"\n }\n },\n \"discountType\": \"NONE\",\n \"discountValue\": 0,\n \"discountMode\": \"STATIC\",\n \"discountModeDetails\": {\n \"steps\": {\n \"value\": \"\"\n },\n \"discountUsageTrigger\": {\n \"value\": \"\"\n }\n },\n \"preDiscountValue\": 0,\n \"requireRedeemedPoints\": 2687.0724602141804,\n \"headerName\": \"string\",\n \"headerDescription\": \"string\",\n \"name\": \"string\",\n \"headline\": \"string\",\n \"description\": \"string\",\n \"images\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"tags\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"startAt\": \"1988-05-05T10:25:04.449Z\",\n \"expireAt\": \"2004-10-22T16:51:51.993Z\",\n \"displayFrom\": \"string\",\n \"displayTo\": \"string\",\n \"lastingTime\": 0,\n \"params\": {\n \"key_0\": true\n },\n \"itemScope\": \"LINE_ITEM\",\n \"minBasketValue\": null,\n \"maxBasketValue\": null,\n \"catalog\": \"221\",\n \"catalogItemType\": \"FILTERED\",\n \"catalogFilterIds\": [\n \"f978b20f-7156-40ed-99c2-3af62b76af12\"\n ],\n \"catalogFilterQuery\": \"color==green;price=lt=100\",\n \"excludeCatalog\": \"string\",\n \"excludeCatalogItemType\": \"SELECTED\",\n \"excludeCatalogIndexItems\": [\n \"29727276\"\n ],\n \"excludeCatalogFilterQuery\": \"brand==acme\",\n \"activationLimitGlobalType\": \"LIFETIME\",\n \"activationLimitGlobalLimit\": 711368197,\n \"activationLimitGlobalRelativeMinutes\": null,\n \"storeCatalog\": \"string\",\n \"storeItemType\": \"ALL\",\n \"storeIds\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"targetType\": \"ALL\",\n \"targetSegment\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"behavioralFilter\": \"productbuyhistory=has='sku=in=(SKU123);ts=rolling=30d'\",\n \"price\": 0,\n \"priority\": 250,\n \"voucherPool\": {\n \"enabled\": {\n \"value\": \"\"\n },\n \"uuid\": {\n \"value\": \"\"\n },\n \"transferable\": {\n \"value\": \"\"\n }\n },\n \"importHash\": \"30608498-a578-d9b6-a244-a1a305e303db\"\n}","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"status\": 7751,\n \"error\": \"string\",\n \"message\": \"string\",\n \"timestamp\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"bbc561b3-e0c1-43aa-9960-e314331b73cc","name":"Get Profile promotions by a custom filter","request":{"name":"Get Profile promotions by a custom filter","description":{"content":"Retrieve a list of promotions related to a Profile by a custom,\npre-defined filter.\n\nThe filter is maintained by your backend administrator.\n\n**IMPORTANT**: \n- As a result of this request, the `targetSegments` of all the matching promotions are checked. If this results in checking more than 100 unique segments, any segments above this limit may be ignored.\n- The endpoint is limited to 25000 requests per minute (per workspace).\n\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User\n\n**API key permission required:** `PROMOTIONS_GET_FOR_CLIENT_BY_CUSTOM_SETTINGS_PROMOTIONS_READ`\n\n**User role permission required:** `campaigns_promotions: read`\n","type":"text/plain"},"url":{"path":["v4","promotions","promotion","get-for-client-by-custom-settings",":identifierType",":identifierValue"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"page","value":"4","description":"Page number to return for pagination. The first page has the index `1`."},{"disabled":false,"key":"limit","value":"100","description":"The number of items to return per page"},{"disabled":false,"key":"lockIdentifier","value":"6561d87b-2697-46ad-8f9a-0550736b86e3","description":"Identifier of the lock which will be created with this request. The lock disables the profile's possibility to fetch promotion lists.\n\nThis lock will be active until one of those conditions is met:\n\n- the TTL (configured with the [settings](#operation/endpointSettingsUpdateSettingsPUT) endpoint) expires.\n- it is removed using the [Release \"promotion requested\" lock](#operation/endpointLockReleasePromotionRequestedLockForClientPOST) endpoint.\n- a promotion is redeemed and this lock's identifier is provided with the redemption request."}],"variable":[{"disabled":false,"type":"any","value":"email","key":"identifierType","description":"(Required) The Profile identifier to use for the request.\n\n`externalId` is known as `customId` or `custom_identify` in other Synerise services.\n"},{"disabled":false,"type":"any","value":"string","key":"identifierValue","description":"(Required) The value of the selected identifier"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"f21b9cb9-2009-44e2-b3cd-707740b03d53","name":"An array of promotions","originalRequest":{"url":{"path":["v4","promotions","promotion","get-for-client-by-custom-settings",":identifierType",":identifierValue"],"host":["{{baseUrl}}"],"query":[{"key":"page","value":"4"},{"key":"limit","value":"100"},{"key":"lockIdentifier","value":"6561d87b-2697-46ad-8f9a-0550736b86e3"}],"variable":[{"disabled":false,"type":"any","value":"email","key":"identifierType","description":"(Required) The Profile identifier to use for the request.\n\n`externalId` is known as `customId` or `custom_identify` in other Synerise services.\n"},{"disabled":false,"type":"any","value":"string","key":"identifierValue","description":"(Required) The value of the selected identifier"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"data\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"bc573ba3-8dbe-4080-992f-44ca9a3fd02c","name":"Request body invalid/malformed/missing elements","originalRequest":{"url":{"path":["v4","promotions","promotion","get-for-client-by-custom-settings",":identifierType",":identifierValue"],"host":["{{baseUrl}}"],"query":[{"key":"page","value":"4"},{"key":"limit","value":"100"},{"key":"lockIdentifier","value":"6561d87b-2697-46ad-8f9a-0550736b86e3"}],"variable":[{"disabled":false,"type":"any","value":"email","key":"identifierType","description":"(Required) The Profile identifier to use for the request.\n\n`externalId` is known as `customId` or `custom_identify` in other Synerise services.\n"},{"disabled":false,"type":"any","value":"string","key":"identifierValue","description":"(Required) The value of the selected identifier"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"message\": {\n \"value\": \"\"\n },\n \"error\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"d8ca4310-f4d9-4758-a9a7-ed33a4a1f13d","name":"Unauthorized","originalRequest":{"url":{"path":["v4","promotions","promotion","get-for-client-by-custom-settings",":identifierType",":identifierValue"],"host":["{{baseUrl}}"],"query":[{"key":"page","value":"4"},{"key":"limit","value":"100"},{"key":"lockIdentifier","value":"6561d87b-2697-46ad-8f9a-0550736b86e3"}],"variable":[{"disabled":false,"type":"any","value":"email","key":"identifierType","description":"(Required) The Profile identifier to use for the request.\n\n`externalId` is known as `customId` or `custom_identify` in other Synerise services.\n"},{"disabled":false,"type":"any","value":"string","key":"identifierValue","description":"(Required) The value of the selected identifier"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"status\": 7751,\n \"error\": \"string\",\n \"message\": \"string\",\n \"timestamp\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"fc9a7409-3e8f-4776-ad0a-24320b28ba65","name":"Forbidden","originalRequest":{"url":{"path":["v4","promotions","promotion","get-for-client-by-custom-settings",":identifierType",":identifierValue"],"host":["{{baseUrl}}"],"query":[{"key":"page","value":"4"},{"key":"limit","value":"100"},{"key":"lockIdentifier","value":"6561d87b-2697-46ad-8f9a-0550736b86e3"}],"variable":[{"disabled":false,"type":"any","value":"email","key":"identifierType","description":"(Required) The Profile identifier to use for the request.\n\n`externalId` is known as `customId` or `custom_identify` in other Synerise services.\n"},{"disabled":false,"type":"any","value":"string","key":"identifierValue","description":"(Required) The value of the selected identifier"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"status\": 7751,\n \"error\": \"string\",\n \"message\": \"string\",\n \"timestamp\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"5358f4de-8b89-45a1-9ce0-f812bfb7a0b8","name":"Waiting for profile lock release","originalRequest":{"url":{"path":["v4","promotions","promotion","get-for-client-by-custom-settings",":identifierType",":identifierValue"],"host":["{{baseUrl}}"],"query":[{"key":"page","value":"4"},{"key":"limit","value":"100"},{"key":"lockIdentifier","value":"6561d87b-2697-46ad-8f9a-0550736b86e3"}],"variable":[{"disabled":false,"type":"any","value":"email","key":"identifierType","description":"(Required) The Profile identifier to use for the request.\n\n`externalId` is known as `customId` or `custom_identify` in other Synerise services.\n"},{"disabled":false,"type":"any","value":"string","key":"identifierValue","description":"(Required) The value of the selected identifier"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Conflict","code":409,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"message\": \"string\",\n \"error\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"504052fd-b049-4434-ad60-cd49451e0bb2","name":"Activate a promotion as Workspace","request":{"name":"Activate a promotion as Workspace","description":{"content":"You can change the status of a Profile's promotion from `assigned` to `active`, the promotion can now be applied to a purchase.\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User\n\n**API key permission required:** `PROMOTIONS_ACTIVATE_PROMOTIONS_UPDATE`\n\n**User role permission required:** `campaigns_promotions: update`\n","type":"text/plain"},"url":{"path":["v4","promotions","promotion","activate-for-client",":identifierType",":identifierValue"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"email","key":"identifierType","description":"(Required) The Profile identifier to use for the request.\n\n`externalId` is known as `customId` or `custom_identify` in other Synerise services.\n"},{"disabled":false,"type":"any","value":"string","key":"identifierValue","description":"(Required) The value of the selected identifier"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"key\": \"code\",\n \"value\": \"7893467834GG\",\n \"pointsToUse\": 100\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"116fb885-47ec-4b75-ba8a-0c246d6fccac","name":"Promotion activated","originalRequest":{"url":{"path":["v4","promotions","promotion","activate-for-client",":identifierType",":identifierValue"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"email","key":"identifierType","description":"(Required) The Profile identifier to use for the request.\n\n`externalId` is known as `customId` or `custom_identify` in other Synerise services.\n"},{"disabled":false,"type":"any","value":"string","key":"identifierValue","description":"(Required) The value of the selected identifier"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"key\": \"code\",\n \"value\": \"7893467834GG\",\n \"pointsToUse\": 100\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"uuid\": \"string\",\n \"code\": \"string\",\n \"status\": \"ACTIVE\",\n \"type\": \"GENERAL\",\n \"redeemLimitPerClient\": 0,\n \"redeemQuantityPerActivation\": 2170570,\n \"currentRedeemedQuantity\": 8259,\n \"currentRedeemedLimit\": 4350,\n \"activationCounter\": 2353,\n \"possibleRedeems\": 1362,\n \"details\": {\n \"discountType\": {\n \"value\": \"\"\n }\n },\n \"discountType\": \"NONE\",\n \"discountValue\": 0,\n \"discountMode\": \"STATIC\",\n \"discountModeDetails\": {\n \"steps\": {\n \"value\": \"\"\n },\n \"discountUsageTrigger\": {\n \"value\": \"\"\n }\n },\n \"requireRedeemedPoints\": 6699.245140664446,\n \"name\": \"string\",\n \"headline\": \"string\",\n \"description\": \"string\",\n \"images\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"tags\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"startAt\": \"2016-02-27T00:38:19.077Z\",\n \"expireAt\": \"1976-02-23T19:44:15.402Z\",\n \"displayFrom\": \"string\",\n \"displayTo\": \"string\",\n \"assignedAt\": \"1986-12-28T17:37:24.769Z\",\n \"lastingTime\": 0,\n \"lastingAt\": \"1986-08-08T22:51:48.900Z\",\n \"params\": {\n \"key_0\": 3227,\n \"key_1\": \"string\",\n \"key_2\": false\n },\n \"price\": 0,\n \"priority\": 250,\n \"itemScope\": \"LINE_ITEM\",\n \"minBasketValue\": null,\n \"maxBasketValue\": null,\n \"vouchers\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"extra\": {\n \"slot\": 7998,\n \"assignmentSource\": \"fallback_pool\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"3f5fb5c2-784f-425c-a239-8223aec8f1ab","name":"Request body invalid/malformed/missing elements","originalRequest":{"url":{"path":["v4","promotions","promotion","activate-for-client",":identifierType",":identifierValue"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"email","key":"identifierType","description":"(Required) The Profile identifier to use for the request.\n\n`externalId` is known as `customId` or `custom_identify` in other Synerise services.\n"},{"disabled":false,"type":"any","value":"string","key":"identifierValue","description":"(Required) The value of the selected identifier"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"key\": \"code\",\n \"value\": \"7893467834GG\",\n \"pointsToUse\": 100\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"message\": {\n \"value\": \"\"\n },\n \"error\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"5e25cbbb-ee31-4601-a586-ba239e741471","name":"Unauthorized","originalRequest":{"url":{"path":["v4","promotions","promotion","activate-for-client",":identifierType",":identifierValue"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"email","key":"identifierType","description":"(Required) The Profile identifier to use for the request.\n\n`externalId` is known as `customId` or `custom_identify` in other Synerise services.\n"},{"disabled":false,"type":"any","value":"string","key":"identifierValue","description":"(Required) The value of the selected identifier"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"key\": \"code\",\n \"value\": \"7893467834GG\",\n \"pointsToUse\": 100\n}","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"status\": 7751,\n \"error\": \"string\",\n \"message\": \"string\",\n \"timestamp\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"9bfc813b-8c37-48d0-a6d8-5e1d032dd3ed","name":"Forbidden","originalRequest":{"url":{"path":["v4","promotions","promotion","activate-for-client",":identifierType",":identifierValue"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"email","key":"identifierType","description":"(Required) The Profile identifier to use for the request.\n\n`externalId` is known as `customId` or `custom_identify` in other Synerise services.\n"},{"disabled":false,"type":"any","value":"string","key":"identifierValue","description":"(Required) The value of the selected identifier"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"key\": \"code\",\n \"value\": \"7893467834GG\",\n \"pointsToUse\": 100\n}","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"status\": 7751,\n \"error\": \"string\",\n \"message\": \"string\",\n \"timestamp\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"c3dceef3-8b8c-44c4-99c2-9aeaf90eef23","name":"Not Found","originalRequest":{"url":{"path":["v4","promotions","promotion","activate-for-client",":identifierType",":identifierValue"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"email","key":"identifierType","description":"(Required) The Profile identifier to use for the request.\n\n`externalId` is known as `customId` or `custom_identify` in other Synerise services.\n"},{"disabled":false,"type":"any","value":"string","key":"identifierValue","description":"(Required) The value of the selected identifier"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"key\": \"code\",\n \"value\": \"7893467834GG\",\n \"pointsToUse\": 100\n}","options":{"raw":{"language":"json"}}}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"message\": \"Promotion for profile not found\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"cbb1fef2-b05d-4b08-bd67-e3f680475285","name":"Waiting for profile lock release","originalRequest":{"url":{"path":["v4","promotions","promotion","activate-for-client",":identifierType",":identifierValue"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"email","key":"identifierType","description":"(Required) The Profile identifier to use for the request.\n\n`externalId` is known as `customId` or `custom_identify` in other Synerise services.\n"},{"disabled":false,"type":"any","value":"string","key":"identifierValue","description":"(Required) The value of the selected identifier"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"key\": \"code\",\n \"value\": \"7893467834GG\",\n \"pointsToUse\": 100\n}","options":{"raw":{"language":"json"}}}},"status":"Conflict","code":409,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"message\": \"string\",\n \"error\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"b9012e0c-85c4-4201-8f77-a3d8d1351b0b","name":"Already activated/Already redeemed/Activation limit reached/Promotion not started/Promotion expired","originalRequest":{"url":{"path":["v4","promotions","promotion","activate-for-client",":identifierType",":identifierValue"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"email","key":"identifierType","description":"(Required) The Profile identifier to use for the request.\n\n`externalId` is known as `customId` or `custom_identify` in other Synerise services.\n"},{"disabled":false,"type":"any","value":"string","key":"identifierValue","description":"(Required) The value of the selected identifier"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"key\": \"code\",\n \"value\": \"7893467834GG\",\n \"pointsToUse\": 100\n}","options":{"raw":{"language":"json"}}}},"status":"Precondition Failed","code":412,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"message\": \"string\",\n \"error\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"e4679177-10b4-4d81-b3fa-446c77a9feb7","name":"Global Activation limit reached","originalRequest":{"url":{"path":["v4","promotions","promotion","activate-for-client",":identifierType",":identifierValue"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"email","key":"identifierType","description":"(Required) The Profile identifier to use for the request.\n\n`externalId` is known as `customId` or `custom_identify` in other Synerise services.\n"},{"disabled":false,"type":"any","value":"string","key":"identifierValue","description":"(Required) The value of the selected identifier"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"key\": \"code\",\n \"value\": \"7893467834GG\",\n \"pointsToUse\": 100\n}","options":{"raw":{"language":"json"}}}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"message\": \"string\",\n \"error\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"cf7a5640-3321-41ae-99e3-a6fad6d48cc1","name":"Profile promotions blocked","originalRequest":{"url":{"path":["v4","promotions","promotion","activate-for-client",":identifierType",":identifierValue"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"email","key":"identifierType","description":"(Required) The Profile identifier to use for the request.\n\n`externalId` is known as `customId` or `custom_identify` in other Synerise services.\n"},{"disabled":false,"type":"any","value":"string","key":"identifierValue","description":"(Required) The value of the selected identifier"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"key\": \"code\",\n \"value\": \"7893467834GG\",\n \"pointsToUse\": 100\n}","options":{"raw":{"language":"json"}}}},"status":"Locked (WebDAV) (RFC 4918)","code":423,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"message\": \"string\",\n \"error\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"dfaab1bf-3803-44c0-bc94-2e77acc3f82d","name":"General error","originalRequest":{"url":{"path":["v4","promotions","promotion","activate-for-client",":identifierType",":identifierValue"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"email","key":"identifierType","description":"(Required) The Profile identifier to use for the request.\n\n`externalId` is known as `customId` or `custom_identify` in other Synerise services.\n"},{"disabled":false,"type":"any","value":"string","key":"identifierValue","description":"(Required) The value of the selected identifier"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"POST","body":{"mode":"raw","raw":"{\n \"key\": \"code\",\n \"value\": \"7893467834GG\",\n \"pointsToUse\": 100\n}","options":{"raw":{"language":"json"}}}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"6776a101-4d3a-46d9-8bc5-7b20f9594f08","name":"Batch activate promotions as Workspace","request":{"name":"Batch activate promotions as Workspace","description":{"content":"You can change the status of a number of Profile's promotions promotion from `assigned` to `active`, the promotion can now be applied to a purchase.\nThis method **can't be used to activate promotions which require voucher assignment**. You need to activate such promotions individually.\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User\n\n**API key permission required:** `PROMOTIONS_BATCH_ACTIVATE_PROMOTIONS_UPDATE`\n\n**User role permission required:** `campaigns_promotions: update`\n","type":"text/plain"},"url":{"path":["v4","promotions","promotion","batch-activate-for-client",":identifierType",":identifierValue"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"email","key":"identifierType","description":"(Required) The Profile identifier to use for the request.\n\n`externalId` is known as `customId` or `custom_identify` in other Synerise services.\n"},{"disabled":false,"type":"any","value":"string","key":"identifierValue","description":"(Required) The value of the selected identifier"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"[\n {\n \"key\": \"code\",\n \"value\": \"7893467834GG\",\n \"pointsToUse\": 100\n }\n]","options":{"raw":{"language":"json"}}}},"response":[{"id":"e160a63a-1420-4c5d-a884-31c7e1906a9f","name":"Promotions activated","originalRequest":{"url":{"path":["v4","promotions","promotion","batch-activate-for-client",":identifierType",":identifierValue"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"email","key":"identifierType","description":"(Required) The Profile identifier to use for the request.\n\n`externalId` is known as `customId` or `custom_identify` in other Synerise services.\n"},{"disabled":false,"type":"any","value":"string","key":"identifierValue","description":"(Required) The value of the selected identifier"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"[\n {\n \"key\": \"code\",\n \"value\": \"7893467834GG\",\n \"pointsToUse\": 100\n }\n]","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{}","cookie":[],"_postman_previewlanguage":"json"},{"id":"0873475a-7fc0-46ab-bbb3-ba0035f51aa4","name":"Request body invalid/malformed/missing elements","originalRequest":{"url":{"path":["v4","promotions","promotion","batch-activate-for-client",":identifierType",":identifierValue"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"email","key":"identifierType","description":"(Required) The Profile identifier to use for the request.\n\n`externalId` is known as `customId` or `custom_identify` in other Synerise services.\n"},{"disabled":false,"type":"any","value":"string","key":"identifierValue","description":"(Required) The value of the selected identifier"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"[\n {\n \"key\": \"code\",\n \"value\": \"7893467834GG\",\n \"pointsToUse\": 100\n }\n]","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"message\": {\n \"value\": \"\"\n },\n \"error\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"42e50447-22d4-430a-9022-6bb508be57d1","name":"Unauthorized","originalRequest":{"url":{"path":["v4","promotions","promotion","batch-activate-for-client",":identifierType",":identifierValue"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"email","key":"identifierType","description":"(Required) The Profile identifier to use for the request.\n\n`externalId` is known as `customId` or `custom_identify` in other Synerise services.\n"},{"disabled":false,"type":"any","value":"string","key":"identifierValue","description":"(Required) The value of the selected identifier"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"[\n {\n \"key\": \"code\",\n \"value\": \"7893467834GG\",\n \"pointsToUse\": 100\n }\n]","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"status\": 7751,\n \"error\": \"string\",\n \"message\": \"string\",\n \"timestamp\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"5641d311-1aa1-4563-ba18-782ec3bd3945","name":"Forbidden","originalRequest":{"url":{"path":["v4","promotions","promotion","batch-activate-for-client",":identifierType",":identifierValue"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"email","key":"identifierType","description":"(Required) The Profile identifier to use for the request.\n\n`externalId` is known as `customId` or `custom_identify` in other Synerise services.\n"},{"disabled":false,"type":"any","value":"string","key":"identifierValue","description":"(Required) The value of the selected identifier"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"[\n {\n \"key\": \"code\",\n \"value\": \"7893467834GG\",\n \"pointsToUse\": 100\n }\n]","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"status\": 7751,\n \"error\": \"string\",\n \"message\": \"string\",\n \"timestamp\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"e084b8ed-75db-4e56-9069-e37270807422","name":"Not Found","originalRequest":{"url":{"path":["v4","promotions","promotion","batch-activate-for-client",":identifierType",":identifierValue"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"email","key":"identifierType","description":"(Required) The Profile identifier to use for the request.\n\n`externalId` is known as `customId` or `custom_identify` in other Synerise services.\n"},{"disabled":false,"type":"any","value":"string","key":"identifierValue","description":"(Required) The value of the selected identifier"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"[\n {\n \"key\": \"code\",\n \"value\": \"7893467834GG\",\n \"pointsToUse\": 100\n }\n]","options":{"raw":{"language":"json"}}}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"message\": \"Promotions for profile not found\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"7c1ea38f-6488-4e80-90ac-7650165d3792","name":"Waiting for profile lock release","originalRequest":{"url":{"path":["v4","promotions","promotion","batch-activate-for-client",":identifierType",":identifierValue"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"email","key":"identifierType","description":"(Required) The Profile identifier to use for the request.\n\n`externalId` is known as `customId` or `custom_identify` in other Synerise services.\n"},{"disabled":false,"type":"any","value":"string","key":"identifierValue","description":"(Required) The value of the selected identifier"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"[\n {\n \"key\": \"code\",\n \"value\": \"7893467834GG\",\n \"pointsToUse\": 100\n }\n]","options":{"raw":{"language":"json"}}}},"status":"Conflict","code":409,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"message\": \"string\",\n \"error\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"21af19d9-ed88-41d6-b1f5-5be85e2256f1","name":"Already activated/Already redeemed/Activation limit reached/Promotion not started/Promotion expired","originalRequest":{"url":{"path":["v4","promotions","promotion","batch-activate-for-client",":identifierType",":identifierValue"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"email","key":"identifierType","description":"(Required) The Profile identifier to use for the request.\n\n`externalId` is known as `customId` or `custom_identify` in other Synerise services.\n"},{"disabled":false,"type":"any","value":"string","key":"identifierValue","description":"(Required) The value of the selected identifier"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"[\n {\n \"key\": \"code\",\n \"value\": \"7893467834GG\",\n \"pointsToUse\": 100\n }\n]","options":{"raw":{"language":"json"}}}},"status":"Precondition Failed","code":412,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"message\": \"string\",\n \"error\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"7ad5345a-a6d7-40a0-9fd1-61dbfeac70d0","name":"General error","originalRequest":{"url":{"path":["v4","promotions","promotion","batch-activate-for-client",":identifierType",":identifierValue"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"email","key":"identifierType","description":"(Required) The Profile identifier to use for the request.\n\n`externalId` is known as `customId` or `custom_identify` in other Synerise services.\n"},{"disabled":false,"type":"any","value":"string","key":"identifierValue","description":"(Required) The value of the selected identifier"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"POST","body":{"mode":"raw","raw":"[\n {\n \"key\": \"code\",\n \"value\": \"7893467834GG\",\n \"pointsToUse\": 100\n }\n]","options":{"raw":{"language":"json"}}}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"61b32de0-acf6-4b5d-8abc-c02bf60b49b5","name":"Deactivate a promotion as Workspace","request":{"name":"Deactivate a promotion as Workspace","description":{"content":"You can change the status of a Profile's activated promotion back to `assigned`.\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User\n\n**API key permission required:** `PROMOTIONS_DEACTIVATE_PROMOTIONS_UPDATE`\n\n**User role permission required:** `campaigns_promotions: update`\n","type":"text/plain"},"url":{"path":["v4","promotions","promotion","deactivate-for-client",":identifierType",":identifierValue"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"email","key":"identifierType","description":"(Required) The Profile identifier to use for the request.\n\n`externalId` is known as `customId` or `custom_identify` in other Synerise services.\n"},{"disabled":false,"type":"any","value":"string","key":"identifierValue","description":"(Required) The value of the selected identifier"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"key\": \"code\",\n \"value\": \"7893467834GG\",\n \"pointsToUse\": 100\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"eadbc587-0b2d-4fd7-b0d5-154e76182235","name":"Promotion deactivated","originalRequest":{"url":{"path":["v4","promotions","promotion","deactivate-for-client",":identifierType",":identifierValue"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"email","key":"identifierType","description":"(Required) The Profile identifier to use for the request.\n\n`externalId` is known as `customId` or `custom_identify` in other Synerise services.\n"},{"disabled":false,"type":"any","value":"string","key":"identifierValue","description":"(Required) The value of the selected identifier"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"key\": \"code\",\n \"value\": \"7893467834GG\",\n \"pointsToUse\": 100\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"uuid\": \"string\",\n \"code\": \"string\",\n \"status\": \"ACTIVE\",\n \"type\": \"GENERAL\",\n \"redeemLimitPerClient\": 0,\n \"redeemQuantityPerActivation\": 2170570,\n \"currentRedeemedQuantity\": 8259,\n \"currentRedeemedLimit\": 4350,\n \"activationCounter\": 2353,\n \"possibleRedeems\": 1362,\n \"details\": {\n \"discountType\": {\n \"value\": \"\"\n }\n },\n \"discountType\": \"NONE\",\n \"discountValue\": 0,\n \"discountMode\": \"STATIC\",\n \"discountModeDetails\": {\n \"steps\": {\n \"value\": \"\"\n },\n \"discountUsageTrigger\": {\n \"value\": \"\"\n }\n },\n \"requireRedeemedPoints\": 6699.245140664446,\n \"name\": \"string\",\n \"headline\": \"string\",\n \"description\": \"string\",\n \"images\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"tags\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"startAt\": \"2016-02-27T00:38:19.077Z\",\n \"expireAt\": \"1976-02-23T19:44:15.402Z\",\n \"displayFrom\": \"string\",\n \"displayTo\": \"string\",\n \"assignedAt\": \"1986-12-28T17:37:24.769Z\",\n \"lastingTime\": 0,\n \"lastingAt\": \"1986-08-08T22:51:48.900Z\",\n \"params\": {\n \"key_0\": 3227,\n \"key_1\": \"string\",\n \"key_2\": false\n },\n \"price\": 0,\n \"priority\": 250,\n \"itemScope\": \"LINE_ITEM\",\n \"minBasketValue\": null,\n \"maxBasketValue\": null,\n \"vouchers\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"extra\": {\n \"slot\": 7998,\n \"assignmentSource\": \"fallback_pool\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"11f84ce6-d487-4000-aecb-5367227fb9a9","name":"Request body invalid/malformed/missing elements","originalRequest":{"url":{"path":["v4","promotions","promotion","deactivate-for-client",":identifierType",":identifierValue"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"email","key":"identifierType","description":"(Required) The Profile identifier to use for the request.\n\n`externalId` is known as `customId` or `custom_identify` in other Synerise services.\n"},{"disabled":false,"type":"any","value":"string","key":"identifierValue","description":"(Required) The value of the selected identifier"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"key\": \"code\",\n \"value\": \"7893467834GG\",\n \"pointsToUse\": 100\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"message\": {\n \"value\": \"\"\n },\n \"error\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"30078f37-2470-4bd2-936b-a6f34c99b2f0","name":"Unauthorized","originalRequest":{"url":{"path":["v4","promotions","promotion","deactivate-for-client",":identifierType",":identifierValue"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"email","key":"identifierType","description":"(Required) The Profile identifier to use for the request.\n\n`externalId` is known as `customId` or `custom_identify` in other Synerise services.\n"},{"disabled":false,"type":"any","value":"string","key":"identifierValue","description":"(Required) The value of the selected identifier"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"key\": \"code\",\n \"value\": \"7893467834GG\",\n \"pointsToUse\": 100\n}","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"status\": 7751,\n \"error\": \"string\",\n \"message\": \"string\",\n \"timestamp\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"37936ee5-f256-4637-b53d-50c9bbacaa68","name":"Forbidden","originalRequest":{"url":{"path":["v4","promotions","promotion","deactivate-for-client",":identifierType",":identifierValue"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"email","key":"identifierType","description":"(Required) The Profile identifier to use for the request.\n\n`externalId` is known as `customId` or `custom_identify` in other Synerise services.\n"},{"disabled":false,"type":"any","value":"string","key":"identifierValue","description":"(Required) The value of the selected identifier"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"key\": \"code\",\n \"value\": \"7893467834GG\",\n \"pointsToUse\": 100\n}","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"status\": 7751,\n \"error\": \"string\",\n \"message\": \"string\",\n \"timestamp\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"34893ea7-0e19-4c27-99e3-8bf130ab09ac","name":"Not Found","originalRequest":{"url":{"path":["v4","promotions","promotion","deactivate-for-client",":identifierType",":identifierValue"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"email","key":"identifierType","description":"(Required) The Profile identifier to use for the request.\n\n`externalId` is known as `customId` or `custom_identify` in other Synerise services.\n"},{"disabled":false,"type":"any","value":"string","key":"identifierValue","description":"(Required) The value of the selected identifier"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"key\": \"code\",\n \"value\": \"7893467834GG\",\n \"pointsToUse\": 100\n}","options":{"raw":{"language":"json"}}}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"message\": \"Promotion for profile not found\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"ebd49fd5-5a0d-4364-bf3a-a82f917e6a59","name":"Waiting for profile lock release","originalRequest":{"url":{"path":["v4","promotions","promotion","deactivate-for-client",":identifierType",":identifierValue"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"email","key":"identifierType","description":"(Required) The Profile identifier to use for the request.\n\n`externalId` is known as `customId` or `custom_identify` in other Synerise services.\n"},{"disabled":false,"type":"any","value":"string","key":"identifierValue","description":"(Required) The value of the selected identifier"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"key\": \"code\",\n \"value\": \"7893467834GG\",\n \"pointsToUse\": 100\n}","options":{"raw":{"language":"json"}}}},"status":"Too Many Requests","code":429,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"message\": \"string\",\n \"error\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"dc4863a7-3a3b-4ef9-9f93-3d64d2dcf9b6","name":"Batch deactivate promotions","request":{"name":"Batch deactivate promotions","description":{"content":"You can change the status of a number of Profile's activated promotions back to `assigned`.\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User\n\n**API key permission required:** `PROMOTIONS_BATCH_DEACTIVATE_PROMOTIONS_UPDATE`\n\n**User role permission required:** `campaigns_promotions: update`\n","type":"text/plain"},"url":{"path":["v4","promotions","promotion","batch-deactivate-for-client",":identifierType",":identifierValue"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"email","key":"identifierType","description":"(Required) The Profile identifier to use for the request.\n\n`externalId` is known as `customId` or `custom_identify` in other Synerise services.\n"},{"disabled":false,"type":"any","value":"string","key":"identifierValue","description":"(Required) The value of the selected identifier"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"[\n {\n \"key\": \"code\",\n \"value\": \"7893467834GG\",\n \"pointsToUse\": 100\n }\n]","options":{"raw":{"language":"json"}}}},"response":[{"id":"a4db893e-e3c3-4b3f-88df-2a104a178cde","name":"Promotions deactivated","originalRequest":{"url":{"path":["v4","promotions","promotion","batch-deactivate-for-client",":identifierType",":identifierValue"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"email","key":"identifierType","description":"(Required) The Profile identifier to use for the request.\n\n`externalId` is known as `customId` or `custom_identify` in other Synerise services.\n"},{"disabled":false,"type":"any","value":"string","key":"identifierValue","description":"(Required) The value of the selected identifier"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"[\n {\n \"key\": \"code\",\n \"value\": \"7893467834GG\",\n \"pointsToUse\": 100\n }\n]","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"\"{}\"","cookie":[],"_postman_previewlanguage":"json"},{"id":"490d8fb6-7a0c-402e-b1f0-112c7ff123b0","name":"Request body invalid/malformed/missing elements","originalRequest":{"url":{"path":["v4","promotions","promotion","batch-deactivate-for-client",":identifierType",":identifierValue"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"email","key":"identifierType","description":"(Required) The Profile identifier to use for the request.\n\n`externalId` is known as `customId` or `custom_identify` in other Synerise services.\n"},{"disabled":false,"type":"any","value":"string","key":"identifierValue","description":"(Required) The value of the selected identifier"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"[\n {\n \"key\": \"code\",\n \"value\": \"7893467834GG\",\n \"pointsToUse\": 100\n }\n]","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"message\": {\n \"value\": \"\"\n },\n \"error\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"8340c174-f091-450e-9c4b-e8980de7752d","name":"Unauthorized","originalRequest":{"url":{"path":["v4","promotions","promotion","batch-deactivate-for-client",":identifierType",":identifierValue"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"email","key":"identifierType","description":"(Required) The Profile identifier to use for the request.\n\n`externalId` is known as `customId` or `custom_identify` in other Synerise services.\n"},{"disabled":false,"type":"any","value":"string","key":"identifierValue","description":"(Required) The value of the selected identifier"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"[\n {\n \"key\": \"code\",\n \"value\": \"7893467834GG\",\n \"pointsToUse\": 100\n }\n]","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"status\": 7751,\n \"error\": \"string\",\n \"message\": \"string\",\n \"timestamp\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"cc46af66-0206-4323-9bca-70da2bee218b","name":"Forbidden","originalRequest":{"url":{"path":["v4","promotions","promotion","batch-deactivate-for-client",":identifierType",":identifierValue"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"email","key":"identifierType","description":"(Required) The Profile identifier to use for the request.\n\n`externalId` is known as `customId` or `custom_identify` in other Synerise services.\n"},{"disabled":false,"type":"any","value":"string","key":"identifierValue","description":"(Required) The value of the selected identifier"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"[\n {\n \"key\": \"code\",\n \"value\": \"7893467834GG\",\n \"pointsToUse\": 100\n }\n]","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"status\": 7751,\n \"error\": \"string\",\n \"message\": \"string\",\n \"timestamp\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"2710c37f-aaf8-4942-91fc-8f8dacfe0d54","name":"Not Found","originalRequest":{"url":{"path":["v4","promotions","promotion","batch-deactivate-for-client",":identifierType",":identifierValue"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"email","key":"identifierType","description":"(Required) The Profile identifier to use for the request.\n\n`externalId` is known as `customId` or `custom_identify` in other Synerise services.\n"},{"disabled":false,"type":"any","value":"string","key":"identifierValue","description":"(Required) The value of the selected identifier"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"[\n {\n \"key\": \"code\",\n \"value\": \"7893467834GG\",\n \"pointsToUse\": 100\n }\n]","options":{"raw":{"language":"json"}}}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"message\": \"Promotions for profile not found\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"f6f36985-6413-42ea-a0ea-b8e2390353e2","name":"Waiting for profile lock release","originalRequest":{"url":{"path":["v4","promotions","promotion","batch-deactivate-for-client",":identifierType",":identifierValue"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"email","key":"identifierType","description":"(Required) The Profile identifier to use for the request.\n\n`externalId` is known as `customId` or `custom_identify` in other Synerise services.\n"},{"disabled":false,"type":"any","value":"string","key":"identifierValue","description":"(Required) The value of the selected identifier"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"[\n {\n \"key\": \"code\",\n \"value\": \"7893467834GG\",\n \"pointsToUse\": 100\n }\n]","options":{"raw":{"language":"json"}}}},"status":"Too Many Requests","code":429,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"message\": \"string\",\n \"error\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"0ba5a332-3f13-4af5-9ed9-c7763b94327a","name":"Create a promotion","request":{"name":"Create a promotion","description":{"content":"You can create a new promotion in the Synerise application.\n\n\nIf you don't enter a code or UUID, they are generated automatically.\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User\n\n**API key permission required:** `PROMOTIONS_PROMOTIONS_CREATE`\n\n**User role permission required:** `campaigns_promotions: create`\n","type":"text/plain"},"url":{"path":["v4","promotions","promotion"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"visibilityStatus\": \"DRAFT\",\n \"type\": \"GENERAL\",\n \"redeemLimitPerClient\": 0,\n \"redeemQuantityPerActivation\": 24493,\n \"redeemLimitGlobal\": 0,\n \"redeemType\": \"PARTIAL\",\n \"details\": {\n \"discountType\": {\n \"value\": \"\"\n },\n \"cashbackSettings\": {\n \"value\": \"\"\n }\n },\n \"discountType\": \"NONE\",\n \"discountValue\": 0,\n \"discountMode\": \"STATIC\",\n \"discountModeDetails\": {\n \"steps\": {\n \"value\": \"\"\n },\n \"discountUsageTrigger\": {\n \"value\": \"\"\n }\n },\n \"preDiscountValue\": 0,\n \"requireRedeemedPoints\": 2687.0724602141804,\n \"headerName\": \"string\",\n \"headerDescription\": \"string\",\n \"name\": \"string\",\n \"headline\": \"string\",\n \"description\": \"string\",\n \"images\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"tags\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"startAt\": \"1988-05-05T10:25:04.449Z\",\n \"expireAt\": \"2004-10-22T16:51:51.993Z\",\n \"displayFrom\": \"string\",\n \"displayTo\": \"string\",\n \"lastingTime\": 0,\n \"params\": {\n \"key_0\": true\n },\n \"itemScope\": \"LINE_ITEM\",\n \"minBasketValue\": null,\n \"maxBasketValue\": null,\n \"catalog\": \"221\",\n \"catalogItemType\": \"FILTERED\",\n \"catalogFilterIds\": [\n \"f978b20f-7156-40ed-99c2-3af62b76af12\"\n ],\n \"catalogFilterQuery\": \"color==green;price=lt=100\",\n \"excludeCatalog\": \"string\",\n \"excludeCatalogItemType\": \"SELECTED\",\n \"excludeCatalogIndexItems\": [\n \"29727276\"\n ],\n \"excludeCatalogFilterQuery\": \"brand==acme\",\n \"activationLimitGlobalType\": \"LIFETIME\",\n \"activationLimitGlobalLimit\": 711368197,\n \"activationLimitGlobalRelativeMinutes\": null,\n \"storeCatalog\": \"string\",\n \"storeItemType\": \"ALL\",\n \"storeIds\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"targetType\": \"ALL\",\n \"targetSegment\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"behavioralFilter\": \"productbuyhistory=has='sku=in=(SKU123);ts=rolling=30d'\",\n \"price\": 0,\n \"priority\": 250,\n \"voucherPool\": {\n \"enabled\": {\n \"value\": \"\"\n },\n \"uuid\": {\n \"value\": \"\"\n },\n \"transferable\": {\n \"value\": \"\"\n }\n },\n \"importHash\": \"30608498-a578-d9b6-a244-a1a305e303db\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"68f208bc-8a68-4036-8626-2e87af0f262c","name":"Promotion created","originalRequest":{"url":{"path":["v4","promotions","promotion"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"visibilityStatus\": \"DRAFT\",\n \"type\": \"GENERAL\",\n \"redeemLimitPerClient\": 0,\n \"redeemQuantityPerActivation\": 24493,\n \"redeemLimitGlobal\": 0,\n \"redeemType\": \"PARTIAL\",\n \"details\": {\n \"discountType\": {\n \"value\": \"\"\n },\n \"cashbackSettings\": {\n \"value\": \"\"\n }\n },\n \"discountType\": \"NONE\",\n \"discountValue\": 0,\n \"discountMode\": \"STATIC\",\n \"discountModeDetails\": {\n \"steps\": {\n \"value\": \"\"\n },\n \"discountUsageTrigger\": {\n \"value\": \"\"\n }\n },\n \"preDiscountValue\": 0,\n \"requireRedeemedPoints\": 2687.0724602141804,\n \"headerName\": \"string\",\n \"headerDescription\": \"string\",\n \"name\": \"string\",\n \"headline\": \"string\",\n \"description\": \"string\",\n \"images\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"tags\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"startAt\": \"1988-05-05T10:25:04.449Z\",\n \"expireAt\": \"2004-10-22T16:51:51.993Z\",\n \"displayFrom\": \"string\",\n \"displayTo\": \"string\",\n \"lastingTime\": 0,\n \"params\": {\n \"key_0\": true\n },\n \"itemScope\": \"LINE_ITEM\",\n \"minBasketValue\": null,\n \"maxBasketValue\": null,\n \"catalog\": \"221\",\n \"catalogItemType\": \"FILTERED\",\n \"catalogFilterIds\": [\n \"f978b20f-7156-40ed-99c2-3af62b76af12\"\n ],\n \"catalogFilterQuery\": \"color==green;price=lt=100\",\n \"excludeCatalog\": \"string\",\n \"excludeCatalogItemType\": \"SELECTED\",\n \"excludeCatalogIndexItems\": [\n \"29727276\"\n ],\n \"excludeCatalogFilterQuery\": \"brand==acme\",\n \"activationLimitGlobalType\": \"LIFETIME\",\n \"activationLimitGlobalLimit\": 711368197,\n \"activationLimitGlobalRelativeMinutes\": null,\n \"storeCatalog\": \"string\",\n \"storeItemType\": \"ALL\",\n \"storeIds\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"targetType\": \"ALL\",\n \"targetSegment\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"behavioralFilter\": \"productbuyhistory=has='sku=in=(SKU123);ts=rolling=30d'\",\n \"price\": 0,\n \"priority\": 250,\n \"voucherPool\": {\n \"enabled\": {\n \"value\": \"\"\n },\n \"uuid\": {\n \"value\": \"\"\n },\n \"transferable\": {\n \"value\": \"\"\n }\n },\n \"importHash\": \"30608498-a578-d9b6-a244-a1a305e303db\"\n}","options":{"raw":{"language":"json"}}}},"status":"Created","code":201,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"message\": \"string\",\n \"data\": {\n \"uuid\": {\n \"value\": \"\"\n },\n \"code\": {\n \"value\": \"\"\n },\n \"status\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"redeemLimitPerClient\": {\n \"value\": \"\"\n },\n \"redeemQuantityPerActivation\": {\n \"value\": \"\"\n },\n \"redeemLimitGlobal\": {\n \"value\": \"\"\n },\n \"activationLimitGlobalType\": {\n \"value\": \"\"\n },\n \"activationLimitGlobalLimit\": {\n \"value\": \"\"\n },\n \"activationLimitGlobalCounter\": {\n \"value\": \"\"\n },\n \"activationLimitGlobalRelativeMinutes\": {\n \"value\": \"\"\n },\n \"activationLimitGlobalReached\": {\n \"value\": \"\"\n },\n \"redeemType\": {\n \"value\": \"\"\n },\n \"discountType\": {\n \"value\": \"\"\n },\n \"details\": {\n \"value\": \"\"\n },\n \"discountValue\": {\n \"value\": \"\"\n },\n \"discountMode\": {\n \"value\": \"\"\n },\n \"discountModeDetails\": {\n \"value\": \"\"\n },\n \"preDiscountValue\": {\n \"value\": \"\"\n },\n \"requireRedeemedPoints\": {\n \"value\": \"\"\n },\n \"headerName\": {\n \"value\": \"\"\n },\n \"headerDescription\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"headline\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n },\n \"images\": {\n \"value\": \"\"\n },\n \"tags\": {\n \"value\": \"\"\n },\n \"createdAt\": {\n \"value\": \"\"\n },\n \"startAt\": {\n \"value\": \"\"\n },\n \"expireAt\": {\n \"value\": \"\"\n },\n \"displayFrom\": {\n \"value\": \"\"\n },\n \"displayTo\": {\n \"value\": \"\"\n },\n \"lastingTime\": {\n \"value\": \"\"\n },\n \"params\": {\n \"value\": \"\"\n },\n \"itemScope\": {\n \"value\": \"\"\n },\n \"minBasketValue\": {\n \"value\": \"\"\n },\n \"maxBasketValue\": {\n \"value\": \"\"\n },\n \"catalog\": {\n \"value\": \"\"\n },\n \"catalogItemType\": {\n \"value\": \"\"\n },\n \"catalogIndexItems\": {\n \"value\": \"\"\n },\n \"catalogFilterIds\": {\n \"value\": \"\"\n },\n \"catalogFilterQuery\": {\n \"value\": \"\"\n },\n \"storeCatalog\": {\n \"value\": \"\"\n },\n \"storeItemType\": {\n \"value\": \"\"\n },\n \"storeIds\": {\n \"value\": \"\"\n },\n \"targetType\": {\n \"value\": \"\"\n },\n \"targetSegment\": {\n \"value\": \"\"\n },\n \"behavioralFilter\": {\n \"value\": \"\"\n },\n \"price\": {\n \"value\": \"\"\n },\n \"priority\": {\n \"value\": \"\"\n },\n \"metric\": {\n \"value\": \"\"\n },\n \"importHash\": {\n \"value\": \"\"\n }\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"8c8ed6dd-86b8-4b6f-ac0b-ab2578f96164","name":"Request body invalid/malformed/missing elements","originalRequest":{"url":{"path":["v4","promotions","promotion"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"visibilityStatus\": \"DRAFT\",\n \"type\": \"GENERAL\",\n \"redeemLimitPerClient\": 0,\n \"redeemQuantityPerActivation\": 24493,\n \"redeemLimitGlobal\": 0,\n \"redeemType\": \"PARTIAL\",\n \"details\": {\n \"discountType\": {\n \"value\": \"\"\n },\n \"cashbackSettings\": {\n \"value\": \"\"\n }\n },\n \"discountType\": \"NONE\",\n \"discountValue\": 0,\n \"discountMode\": \"STATIC\",\n \"discountModeDetails\": {\n \"steps\": {\n \"value\": \"\"\n },\n \"discountUsageTrigger\": {\n \"value\": \"\"\n }\n },\n \"preDiscountValue\": 0,\n \"requireRedeemedPoints\": 2687.0724602141804,\n \"headerName\": \"string\",\n \"headerDescription\": \"string\",\n \"name\": \"string\",\n \"headline\": \"string\",\n \"description\": \"string\",\n \"images\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"tags\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"startAt\": \"1988-05-05T10:25:04.449Z\",\n \"expireAt\": \"2004-10-22T16:51:51.993Z\",\n \"displayFrom\": \"string\",\n \"displayTo\": \"string\",\n \"lastingTime\": 0,\n \"params\": {\n \"key_0\": true\n },\n \"itemScope\": \"LINE_ITEM\",\n \"minBasketValue\": null,\n \"maxBasketValue\": null,\n \"catalog\": \"221\",\n \"catalogItemType\": \"FILTERED\",\n \"catalogFilterIds\": [\n \"f978b20f-7156-40ed-99c2-3af62b76af12\"\n ],\n \"catalogFilterQuery\": \"color==green;price=lt=100\",\n \"excludeCatalog\": \"string\",\n \"excludeCatalogItemType\": \"SELECTED\",\n \"excludeCatalogIndexItems\": [\n \"29727276\"\n ],\n \"excludeCatalogFilterQuery\": \"brand==acme\",\n \"activationLimitGlobalType\": \"LIFETIME\",\n \"activationLimitGlobalLimit\": 711368197,\n \"activationLimitGlobalRelativeMinutes\": null,\n \"storeCatalog\": \"string\",\n \"storeItemType\": \"ALL\",\n \"storeIds\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"targetType\": \"ALL\",\n \"targetSegment\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"behavioralFilter\": \"productbuyhistory=has='sku=in=(SKU123);ts=rolling=30d'\",\n \"price\": 0,\n \"priority\": 250,\n \"voucherPool\": {\n \"enabled\": {\n \"value\": \"\"\n },\n \"uuid\": {\n \"value\": \"\"\n },\n \"transferable\": {\n \"value\": \"\"\n }\n },\n \"importHash\": \"30608498-a578-d9b6-a244-a1a305e303db\"\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"message\": {\n \"value\": \"\"\n },\n \"error\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"37a5475a-275e-41e9-a880-7152dbde49dd","name":"Unauthorized","originalRequest":{"url":{"path":["v4","promotions","promotion"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"visibilityStatus\": \"DRAFT\",\n \"type\": \"GENERAL\",\n \"redeemLimitPerClient\": 0,\n \"redeemQuantityPerActivation\": 24493,\n \"redeemLimitGlobal\": 0,\n \"redeemType\": \"PARTIAL\",\n \"details\": {\n \"discountType\": {\n \"value\": \"\"\n },\n \"cashbackSettings\": {\n \"value\": \"\"\n }\n },\n \"discountType\": \"NONE\",\n \"discountValue\": 0,\n \"discountMode\": \"STATIC\",\n \"discountModeDetails\": {\n \"steps\": {\n \"value\": \"\"\n },\n \"discountUsageTrigger\": {\n \"value\": \"\"\n }\n },\n \"preDiscountValue\": 0,\n \"requireRedeemedPoints\": 2687.0724602141804,\n \"headerName\": \"string\",\n \"headerDescription\": \"string\",\n \"name\": \"string\",\n \"headline\": \"string\",\n \"description\": \"string\",\n \"images\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"tags\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"startAt\": \"1988-05-05T10:25:04.449Z\",\n \"expireAt\": \"2004-10-22T16:51:51.993Z\",\n \"displayFrom\": \"string\",\n \"displayTo\": \"string\",\n \"lastingTime\": 0,\n \"params\": {\n \"key_0\": true\n },\n \"itemScope\": \"LINE_ITEM\",\n \"minBasketValue\": null,\n \"maxBasketValue\": null,\n \"catalog\": \"221\",\n \"catalogItemType\": \"FILTERED\",\n \"catalogFilterIds\": [\n \"f978b20f-7156-40ed-99c2-3af62b76af12\"\n ],\n \"catalogFilterQuery\": \"color==green;price=lt=100\",\n \"excludeCatalog\": \"string\",\n \"excludeCatalogItemType\": \"SELECTED\",\n \"excludeCatalogIndexItems\": [\n \"29727276\"\n ],\n \"excludeCatalogFilterQuery\": \"brand==acme\",\n \"activationLimitGlobalType\": \"LIFETIME\",\n \"activationLimitGlobalLimit\": 711368197,\n \"activationLimitGlobalRelativeMinutes\": null,\n \"storeCatalog\": \"string\",\n \"storeItemType\": \"ALL\",\n \"storeIds\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"targetType\": \"ALL\",\n \"targetSegment\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"behavioralFilter\": \"productbuyhistory=has='sku=in=(SKU123);ts=rolling=30d'\",\n \"price\": 0,\n \"priority\": 250,\n \"voucherPool\": {\n \"enabled\": {\n \"value\": \"\"\n },\n \"uuid\": {\n \"value\": \"\"\n },\n \"transferable\": {\n \"value\": \"\"\n }\n },\n \"importHash\": \"30608498-a578-d9b6-a244-a1a305e303db\"\n}","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"status\": 7751,\n \"error\": \"string\",\n \"message\": \"string\",\n \"timestamp\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"0c623cbc-6cc7-4340-9e37-437ff6a2b76d","name":"Forbidden","originalRequest":{"url":{"path":["v4","promotions","promotion"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"visibilityStatus\": \"DRAFT\",\n \"type\": \"GENERAL\",\n \"redeemLimitPerClient\": 0,\n \"redeemQuantityPerActivation\": 24493,\n \"redeemLimitGlobal\": 0,\n \"redeemType\": \"PARTIAL\",\n \"details\": {\n \"discountType\": {\n \"value\": \"\"\n },\n \"cashbackSettings\": {\n \"value\": \"\"\n }\n },\n \"discountType\": \"NONE\",\n \"discountValue\": 0,\n \"discountMode\": \"STATIC\",\n \"discountModeDetails\": {\n \"steps\": {\n \"value\": \"\"\n },\n \"discountUsageTrigger\": {\n \"value\": \"\"\n }\n },\n \"preDiscountValue\": 0,\n \"requireRedeemedPoints\": 2687.0724602141804,\n \"headerName\": \"string\",\n \"headerDescription\": \"string\",\n \"name\": \"string\",\n \"headline\": \"string\",\n \"description\": \"string\",\n \"images\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"tags\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"startAt\": \"1988-05-05T10:25:04.449Z\",\n \"expireAt\": \"2004-10-22T16:51:51.993Z\",\n \"displayFrom\": \"string\",\n \"displayTo\": \"string\",\n \"lastingTime\": 0,\n \"params\": {\n \"key_0\": true\n },\n \"itemScope\": \"LINE_ITEM\",\n \"minBasketValue\": null,\n \"maxBasketValue\": null,\n \"catalog\": \"221\",\n \"catalogItemType\": \"FILTERED\",\n \"catalogFilterIds\": [\n \"f978b20f-7156-40ed-99c2-3af62b76af12\"\n ],\n \"catalogFilterQuery\": \"color==green;price=lt=100\",\n \"excludeCatalog\": \"string\",\n \"excludeCatalogItemType\": \"SELECTED\",\n \"excludeCatalogIndexItems\": [\n \"29727276\"\n ],\n \"excludeCatalogFilterQuery\": \"brand==acme\",\n \"activationLimitGlobalType\": \"LIFETIME\",\n \"activationLimitGlobalLimit\": 711368197,\n \"activationLimitGlobalRelativeMinutes\": null,\n \"storeCatalog\": \"string\",\n \"storeItemType\": \"ALL\",\n \"storeIds\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"targetType\": \"ALL\",\n \"targetSegment\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"behavioralFilter\": \"productbuyhistory=has='sku=in=(SKU123);ts=rolling=30d'\",\n \"price\": 0,\n \"priority\": 250,\n \"voucherPool\": {\n \"enabled\": {\n \"value\": \"\"\n },\n \"uuid\": {\n \"value\": \"\"\n },\n \"transferable\": {\n \"value\": \"\"\n }\n },\n \"importHash\": \"30608498-a578-d9b6-a244-a1a305e303db\"\n}","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"status\": 7751,\n \"error\": \"string\",\n \"message\": \"string\",\n \"timestamp\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"a651392c-a634-4a55-abdc-648353bfa2ea","name":"Delete a promotion","request":{"name":"Delete a promotion","description":{"content":"This method is used to delete an existing promotion. It can be used by a backend business administrator.\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User\n\n**API key permission required:** `PROMOTIONS_PROMOTIONS_DELETE`\n\n**User role permission required:** `campaigns_promotions: delete`\n","type":"text/plain"},"url":{"path":["v4","promotions","promotion"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"DELETE","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"value\": \"8f3457075b2769d039\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"5875b385-6c6c-45ee-827e-198c6d91b1e3","name":"Promotion deleted","originalRequest":{"url":{"path":["v4","promotions","promotion"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{"mode":"raw","raw":"{\n \"value\": \"8f3457075b2769d039\"\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"message\": \"string\",\n \"data\": {\n \"uuid\": {\n \"value\": \"\"\n },\n \"code\": {\n \"value\": \"\"\n },\n \"status\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"redeemLimitPerClient\": {\n \"value\": \"\"\n },\n \"redeemQuantityPerActivation\": {\n \"value\": \"\"\n },\n \"redeemLimitGlobal\": {\n \"value\": \"\"\n },\n \"activationLimitGlobalType\": {\n \"value\": \"\"\n },\n \"activationLimitGlobalLimit\": {\n \"value\": \"\"\n },\n \"activationLimitGlobalCounter\": {\n \"value\": \"\"\n },\n \"activationLimitGlobalRelativeMinutes\": {\n \"value\": \"\"\n },\n \"activationLimitGlobalReached\": {\n \"value\": \"\"\n },\n \"redeemType\": {\n \"value\": \"\"\n },\n \"discountType\": {\n \"value\": \"\"\n },\n \"details\": {\n \"value\": \"\"\n },\n \"discountValue\": {\n \"value\": \"\"\n },\n \"discountMode\": {\n \"value\": \"\"\n },\n \"discountModeDetails\": {\n \"value\": \"\"\n },\n \"preDiscountValue\": {\n \"value\": \"\"\n },\n \"requireRedeemedPoints\": {\n \"value\": \"\"\n },\n \"headerName\": {\n \"value\": \"\"\n },\n \"headerDescription\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"headline\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n },\n \"images\": {\n \"value\": \"\"\n },\n \"tags\": {\n \"value\": \"\"\n },\n \"createdAt\": {\n \"value\": \"\"\n },\n \"startAt\": {\n \"value\": \"\"\n },\n \"expireAt\": {\n \"value\": \"\"\n },\n \"displayFrom\": {\n \"value\": \"\"\n },\n \"displayTo\": {\n \"value\": \"\"\n },\n \"lastingTime\": {\n \"value\": \"\"\n },\n \"params\": {\n \"value\": \"\"\n },\n \"itemScope\": {\n \"value\": \"\"\n },\n \"minBasketValue\": {\n \"value\": \"\"\n },\n \"maxBasketValue\": {\n \"value\": \"\"\n },\n \"catalog\": {\n \"value\": \"\"\n },\n \"catalogItemType\": {\n \"value\": \"\"\n },\n \"catalogIndexItems\": {\n \"value\": \"\"\n },\n \"catalogFilterIds\": {\n \"value\": \"\"\n },\n \"catalogFilterQuery\": {\n \"value\": \"\"\n },\n \"storeCatalog\": {\n \"value\": \"\"\n },\n \"storeItemType\": {\n \"value\": \"\"\n },\n \"storeIds\": {\n \"value\": \"\"\n },\n \"targetType\": {\n \"value\": \"\"\n },\n \"targetSegment\": {\n \"value\": \"\"\n },\n \"behavioralFilter\": {\n \"value\": \"\"\n },\n \"price\": {\n \"value\": \"\"\n },\n \"priority\": {\n \"value\": \"\"\n },\n \"metric\": {\n \"value\": \"\"\n },\n \"importHash\": {\n \"value\": \"\"\n }\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"374f8cf9-0cc8-4f6a-bced-7735c0a50085","name":"Request body invalid/malformed/missing elements","originalRequest":{"url":{"path":["v4","promotions","promotion"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{"mode":"raw","raw":"{\n \"value\": \"8f3457075b2769d039\"\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"message\": {\n \"value\": \"\"\n },\n \"error\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"bcd890fb-27ba-464a-99e5-7dbd00211978","name":"Unauthorized","originalRequest":{"url":{"path":["v4","promotions","promotion"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{"mode":"raw","raw":"{\n \"value\": \"8f3457075b2769d039\"\n}","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"status\": 7751,\n \"error\": \"string\",\n \"message\": \"string\",\n \"timestamp\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"eebb5ec3-9a57-4882-8a7e-29cced0a66ec","name":"Forbidden","originalRequest":{"url":{"path":["v4","promotions","promotion"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{"mode":"raw","raw":"{\n \"value\": \"8f3457075b2769d039\"\n}","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"status\": 7751,\n \"error\": \"string\",\n \"message\": \"string\",\n \"timestamp\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"251c1806-a483-487f-9c32-368fc050dae5","name":"Profile, promotion, or related resource not found","originalRequest":{"url":{"path":["v4","promotions","promotion"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{"mode":"raw","raw":"{\n \"value\": \"8f3457075b2769d039\"\n}","options":{"raw":{"language":"json"}}}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"message\": \"string\",\n \"error\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"6089ca4f-853a-4564-b30a-47f273a8de1f","name":"Waiting for profile lock release","originalRequest":{"url":{"path":["v4","promotions","promotion"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{"mode":"raw","raw":"{\n \"value\": \"8f3457075b2769d039\"\n}","options":{"raw":{"language":"json"}}}},"status":"Conflict","code":409,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"message\": \"string\",\n \"error\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"496c78f9-a4a3-4bc4-b87b-a9ccfc4c2f3e","name":"Create or update a promotion","request":{"name":"Create or update a promotion","description":{"content":"You can use this endpoint to create a new promotion or update an existing one that matches the UUID or promotion code that you send.\n\n\nWhen updating an existing promotion include only the fields that you want to change. Inserting a null value overwrites an existing value.\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User\n\n**API key permissions required (at least one):** `PROMOTIONS_PROMOTIONS_CREATE`, `PROMOTIONS_PROMOTIONS_UPDATE`\n\n**User role permission required:** `campaigns_promotions: create`\n","type":"text/plain"},"url":{"path":["v4","promotions","promotion","create-or-update"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"uuid\": \"string\",\n \"code\": \"string\",\n \"visibilityStatus\": \"DRAFT\",\n \"type\": \"GENERAL\",\n \"redeemLimitPerClient\": 0,\n \"redeemQuantityPerActivation\": 126688,\n \"redeemLimitGlobal\": 0,\n \"redeemType\": \"FULL\",\n \"discountType\": \"NONE\",\n \"details\": {\n \"discountType\": {\n \"value\": \"\"\n },\n \"cashbackSettings\": {\n \"value\": \"\"\n }\n },\n \"discountValue\": 0,\n \"discountMode\": \"STATIC\",\n \"discountModeDetails\": {\n \"steps\": {\n \"value\": \"\"\n },\n \"discountUsageTrigger\": {\n \"value\": \"\"\n }\n },\n \"preDiscountValue\": 0,\n \"requireRedeemedPoints\": 6932.96532300038,\n \"headerName\": \"string\",\n \"headerDescription\": \"string\",\n \"name\": \"string\",\n \"headline\": \"string\",\n \"description\": \"string\",\n \"images\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"tags\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"startAt\": \"1948-10-21T13:49:14.844Z\",\n \"expireAt\": \"2006-09-18T21:15:29.357Z\",\n \"displayFrom\": \"string\",\n \"displayTo\": \"string\",\n \"lastingTime\": 0,\n \"params\": {\n \"key_0\": 6687.963239774547,\n \"key_1\": false\n },\n \"itemScope\": \"LINE_ITEM\",\n \"minBasketValue\": null,\n \"maxBasketValue\": null,\n \"catalog\": \"221\",\n \"catalogItemType\": \"FILTERED\",\n \"catalogFilterIds\": [\n \"f978b20f-7156-40ed-99c2-3af62b76af12\"\n ],\n \"catalogFilterQuery\": \"color==green;price=lt=100\",\n \"excludeCatalog\": \"string\",\n \"excludeCatalogItemType\": \"SELECTED\",\n \"excludeCatalogIndexItems\": [\n \"29727276\"\n ],\n \"excludeCatalogFilterQuery\": \"brand==acme\",\n \"storeCatalog\": \"string\",\n \"storeItemType\": \"ALL\",\n \"storeIds\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"targetType\": \"ALL\",\n \"targetSegment\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"behavioralFilter\": \"productbuyhistory=has='sku=in=(SKU123);ts=rolling=30d'\",\n \"price\": 0,\n \"priority\": 250,\n \"voucherPool\": {\n \"enabled\": {\n \"value\": \"\"\n },\n \"uuid\": {\n \"value\": \"\"\n },\n \"transferable\": {\n \"value\": \"\"\n }\n },\n \"importHash\": \"3c5b6803-1ac2-e002-3b9d-a75664b3cda6\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"2e6d5879-c468-4563-af38-1659062fcbcf","name":"Promotion updated","originalRequest":{"url":{"path":["v4","promotions","promotion","create-or-update"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"uuid\": \"string\",\n \"code\": \"string\",\n \"visibilityStatus\": \"DRAFT\",\n \"type\": \"GENERAL\",\n \"redeemLimitPerClient\": 0,\n \"redeemQuantityPerActivation\": 126688,\n \"redeemLimitGlobal\": 0,\n \"redeemType\": \"FULL\",\n \"discountType\": \"NONE\",\n \"details\": {\n \"discountType\": {\n \"value\": \"\"\n },\n \"cashbackSettings\": {\n \"value\": \"\"\n }\n },\n \"discountValue\": 0,\n \"discountMode\": \"STATIC\",\n \"discountModeDetails\": {\n \"steps\": {\n \"value\": \"\"\n },\n \"discountUsageTrigger\": {\n \"value\": \"\"\n }\n },\n \"preDiscountValue\": 0,\n \"requireRedeemedPoints\": 6932.96532300038,\n \"headerName\": \"string\",\n \"headerDescription\": \"string\",\n \"name\": \"string\",\n \"headline\": \"string\",\n \"description\": \"string\",\n \"images\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"tags\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"startAt\": \"1948-10-21T13:49:14.844Z\",\n \"expireAt\": \"2006-09-18T21:15:29.357Z\",\n \"displayFrom\": \"string\",\n \"displayTo\": \"string\",\n \"lastingTime\": 0,\n \"params\": {\n \"key_0\": 6687.963239774547,\n \"key_1\": false\n },\n \"itemScope\": \"LINE_ITEM\",\n \"minBasketValue\": null,\n \"maxBasketValue\": null,\n \"catalog\": \"221\",\n \"catalogItemType\": \"FILTERED\",\n \"catalogFilterIds\": [\n \"f978b20f-7156-40ed-99c2-3af62b76af12\"\n ],\n \"catalogFilterQuery\": \"color==green;price=lt=100\",\n \"excludeCatalog\": \"string\",\n \"excludeCatalogItemType\": \"SELECTED\",\n \"excludeCatalogIndexItems\": [\n \"29727276\"\n ],\n \"excludeCatalogFilterQuery\": \"brand==acme\",\n \"storeCatalog\": \"string\",\n \"storeItemType\": \"ALL\",\n \"storeIds\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"targetType\": \"ALL\",\n \"targetSegment\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"behavioralFilter\": \"productbuyhistory=has='sku=in=(SKU123);ts=rolling=30d'\",\n \"price\": 0,\n \"priority\": 250,\n \"voucherPool\": {\n \"enabled\": {\n \"value\": \"\"\n },\n \"uuid\": {\n \"value\": \"\"\n },\n \"transferable\": {\n \"value\": \"\"\n }\n },\n \"importHash\": \"3c5b6803-1ac2-e002-3b9d-a75664b3cda6\"\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"60c15bfa-7ff2-4f06-a463-96bb8bd2ea40","name":"Promotion created","originalRequest":{"url":{"path":["v4","promotions","promotion","create-or-update"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"uuid\": \"string\",\n \"code\": \"string\",\n \"visibilityStatus\": \"DRAFT\",\n \"type\": \"GENERAL\",\n \"redeemLimitPerClient\": 0,\n \"redeemQuantityPerActivation\": 126688,\n \"redeemLimitGlobal\": 0,\n \"redeemType\": \"FULL\",\n \"discountType\": \"NONE\",\n \"details\": {\n \"discountType\": {\n \"value\": \"\"\n },\n \"cashbackSettings\": {\n \"value\": \"\"\n }\n },\n \"discountValue\": 0,\n \"discountMode\": \"STATIC\",\n \"discountModeDetails\": {\n \"steps\": {\n \"value\": \"\"\n },\n \"discountUsageTrigger\": {\n \"value\": \"\"\n }\n },\n \"preDiscountValue\": 0,\n \"requireRedeemedPoints\": 6932.96532300038,\n \"headerName\": \"string\",\n \"headerDescription\": \"string\",\n \"name\": \"string\",\n \"headline\": \"string\",\n \"description\": \"string\",\n \"images\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"tags\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"startAt\": \"1948-10-21T13:49:14.844Z\",\n \"expireAt\": \"2006-09-18T21:15:29.357Z\",\n \"displayFrom\": \"string\",\n \"displayTo\": \"string\",\n \"lastingTime\": 0,\n \"params\": {\n \"key_0\": 6687.963239774547,\n \"key_1\": false\n },\n \"itemScope\": \"LINE_ITEM\",\n \"minBasketValue\": null,\n \"maxBasketValue\": null,\n \"catalog\": \"221\",\n \"catalogItemType\": \"FILTERED\",\n \"catalogFilterIds\": [\n \"f978b20f-7156-40ed-99c2-3af62b76af12\"\n ],\n \"catalogFilterQuery\": \"color==green;price=lt=100\",\n \"excludeCatalog\": \"string\",\n \"excludeCatalogItemType\": \"SELECTED\",\n \"excludeCatalogIndexItems\": [\n \"29727276\"\n ],\n \"excludeCatalogFilterQuery\": \"brand==acme\",\n \"storeCatalog\": \"string\",\n \"storeItemType\": \"ALL\",\n \"storeIds\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"targetType\": \"ALL\",\n \"targetSegment\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"behavioralFilter\": \"productbuyhistory=has='sku=in=(SKU123);ts=rolling=30d'\",\n \"price\": 0,\n \"priority\": 250,\n \"voucherPool\": {\n \"enabled\": {\n \"value\": \"\"\n },\n \"uuid\": {\n \"value\": \"\"\n },\n \"transferable\": {\n \"value\": \"\"\n }\n },\n \"importHash\": \"3c5b6803-1ac2-e002-3b9d-a75664b3cda6\"\n}","options":{"raw":{"language":"json"}}}},"status":"Created","code":201,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"a1bf7670-9d53-45d2-8a45-5273a3939d3f","name":"Request body invalid/malformed/missing elements","originalRequest":{"url":{"path":["v4","promotions","promotion","create-or-update"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"uuid\": \"string\",\n \"code\": \"string\",\n \"visibilityStatus\": \"DRAFT\",\n \"type\": \"GENERAL\",\n \"redeemLimitPerClient\": 0,\n \"redeemQuantityPerActivation\": 126688,\n \"redeemLimitGlobal\": 0,\n \"redeemType\": \"FULL\",\n \"discountType\": \"NONE\",\n \"details\": {\n \"discountType\": {\n \"value\": \"\"\n },\n \"cashbackSettings\": {\n \"value\": \"\"\n }\n },\n \"discountValue\": 0,\n \"discountMode\": \"STATIC\",\n \"discountModeDetails\": {\n \"steps\": {\n \"value\": \"\"\n },\n \"discountUsageTrigger\": {\n \"value\": \"\"\n }\n },\n \"preDiscountValue\": 0,\n \"requireRedeemedPoints\": 6932.96532300038,\n \"headerName\": \"string\",\n \"headerDescription\": \"string\",\n \"name\": \"string\",\n \"headline\": \"string\",\n \"description\": \"string\",\n \"images\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"tags\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"startAt\": \"1948-10-21T13:49:14.844Z\",\n \"expireAt\": \"2006-09-18T21:15:29.357Z\",\n \"displayFrom\": \"string\",\n \"displayTo\": \"string\",\n \"lastingTime\": 0,\n \"params\": {\n \"key_0\": 6687.963239774547,\n \"key_1\": false\n },\n \"itemScope\": \"LINE_ITEM\",\n \"minBasketValue\": null,\n \"maxBasketValue\": null,\n \"catalog\": \"221\",\n \"catalogItemType\": \"FILTERED\",\n \"catalogFilterIds\": [\n \"f978b20f-7156-40ed-99c2-3af62b76af12\"\n ],\n \"catalogFilterQuery\": \"color==green;price=lt=100\",\n \"excludeCatalog\": \"string\",\n \"excludeCatalogItemType\": \"SELECTED\",\n \"excludeCatalogIndexItems\": [\n \"29727276\"\n ],\n \"excludeCatalogFilterQuery\": \"brand==acme\",\n \"storeCatalog\": \"string\",\n \"storeItemType\": \"ALL\",\n \"storeIds\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"targetType\": \"ALL\",\n \"targetSegment\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"behavioralFilter\": \"productbuyhistory=has='sku=in=(SKU123);ts=rolling=30d'\",\n \"price\": 0,\n \"priority\": 250,\n \"voucherPool\": {\n \"enabled\": {\n \"value\": \"\"\n },\n \"uuid\": {\n \"value\": \"\"\n },\n \"transferable\": {\n \"value\": \"\"\n }\n },\n \"importHash\": \"3c5b6803-1ac2-e002-3b9d-a75664b3cda6\"\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"message\": {\n \"value\": \"\"\n },\n \"error\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"9e99cb6b-474e-4243-a1f6-b62dcda331f7","name":"Unauthorized","originalRequest":{"url":{"path":["v4","promotions","promotion","create-or-update"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"uuid\": \"string\",\n \"code\": \"string\",\n \"visibilityStatus\": \"DRAFT\",\n \"type\": \"GENERAL\",\n \"redeemLimitPerClient\": 0,\n \"redeemQuantityPerActivation\": 126688,\n \"redeemLimitGlobal\": 0,\n \"redeemType\": \"FULL\",\n \"discountType\": \"NONE\",\n \"details\": {\n \"discountType\": {\n \"value\": \"\"\n },\n \"cashbackSettings\": {\n \"value\": \"\"\n }\n },\n \"discountValue\": 0,\n \"discountMode\": \"STATIC\",\n \"discountModeDetails\": {\n \"steps\": {\n \"value\": \"\"\n },\n \"discountUsageTrigger\": {\n \"value\": \"\"\n }\n },\n \"preDiscountValue\": 0,\n \"requireRedeemedPoints\": 6932.96532300038,\n \"headerName\": \"string\",\n \"headerDescription\": \"string\",\n \"name\": \"string\",\n \"headline\": \"string\",\n \"description\": \"string\",\n \"images\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"tags\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"startAt\": \"1948-10-21T13:49:14.844Z\",\n \"expireAt\": \"2006-09-18T21:15:29.357Z\",\n \"displayFrom\": \"string\",\n \"displayTo\": \"string\",\n \"lastingTime\": 0,\n \"params\": {\n \"key_0\": 6687.963239774547,\n \"key_1\": false\n },\n \"itemScope\": \"LINE_ITEM\",\n \"minBasketValue\": null,\n \"maxBasketValue\": null,\n \"catalog\": \"221\",\n \"catalogItemType\": \"FILTERED\",\n \"catalogFilterIds\": [\n \"f978b20f-7156-40ed-99c2-3af62b76af12\"\n ],\n \"catalogFilterQuery\": \"color==green;price=lt=100\",\n \"excludeCatalog\": \"string\",\n \"excludeCatalogItemType\": \"SELECTED\",\n \"excludeCatalogIndexItems\": [\n \"29727276\"\n ],\n \"excludeCatalogFilterQuery\": \"brand==acme\",\n \"storeCatalog\": \"string\",\n \"storeItemType\": \"ALL\",\n \"storeIds\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"targetType\": \"ALL\",\n \"targetSegment\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"behavioralFilter\": \"productbuyhistory=has='sku=in=(SKU123);ts=rolling=30d'\",\n \"price\": 0,\n \"priority\": 250,\n \"voucherPool\": {\n \"enabled\": {\n \"value\": \"\"\n },\n \"uuid\": {\n \"value\": \"\"\n },\n \"transferable\": {\n \"value\": \"\"\n }\n },\n \"importHash\": \"3c5b6803-1ac2-e002-3b9d-a75664b3cda6\"\n}","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"status\": 7751,\n \"error\": \"string\",\n \"message\": \"string\",\n \"timestamp\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"db030814-b80c-4255-b176-9c2e24906a19","name":"Forbidden","originalRequest":{"url":{"path":["v4","promotions","promotion","create-or-update"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"uuid\": \"string\",\n \"code\": \"string\",\n \"visibilityStatus\": \"DRAFT\",\n \"type\": \"GENERAL\",\n \"redeemLimitPerClient\": 0,\n \"redeemQuantityPerActivation\": 126688,\n \"redeemLimitGlobal\": 0,\n \"redeemType\": \"FULL\",\n \"discountType\": \"NONE\",\n \"details\": {\n \"discountType\": {\n \"value\": \"\"\n },\n \"cashbackSettings\": {\n \"value\": \"\"\n }\n },\n \"discountValue\": 0,\n \"discountMode\": \"STATIC\",\n \"discountModeDetails\": {\n \"steps\": {\n \"value\": \"\"\n },\n \"discountUsageTrigger\": {\n \"value\": \"\"\n }\n },\n \"preDiscountValue\": 0,\n \"requireRedeemedPoints\": 6932.96532300038,\n \"headerName\": \"string\",\n \"headerDescription\": \"string\",\n \"name\": \"string\",\n \"headline\": \"string\",\n \"description\": \"string\",\n \"images\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"tags\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"startAt\": \"1948-10-21T13:49:14.844Z\",\n \"expireAt\": \"2006-09-18T21:15:29.357Z\",\n \"displayFrom\": \"string\",\n \"displayTo\": \"string\",\n \"lastingTime\": 0,\n \"params\": {\n \"key_0\": 6687.963239774547,\n \"key_1\": false\n },\n \"itemScope\": \"LINE_ITEM\",\n \"minBasketValue\": null,\n \"maxBasketValue\": null,\n \"catalog\": \"221\",\n \"catalogItemType\": \"FILTERED\",\n \"catalogFilterIds\": [\n \"f978b20f-7156-40ed-99c2-3af62b76af12\"\n ],\n \"catalogFilterQuery\": \"color==green;price=lt=100\",\n \"excludeCatalog\": \"string\",\n \"excludeCatalogItemType\": \"SELECTED\",\n \"excludeCatalogIndexItems\": [\n \"29727276\"\n ],\n \"excludeCatalogFilterQuery\": \"brand==acme\",\n \"storeCatalog\": \"string\",\n \"storeItemType\": \"ALL\",\n \"storeIds\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"targetType\": \"ALL\",\n \"targetSegment\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"behavioralFilter\": \"productbuyhistory=has='sku=in=(SKU123);ts=rolling=30d'\",\n \"price\": 0,\n \"priority\": 250,\n \"voucherPool\": {\n \"enabled\": {\n \"value\": \"\"\n },\n \"uuid\": {\n \"value\": \"\"\n },\n \"transferable\": {\n \"value\": \"\"\n }\n },\n \"importHash\": \"3c5b6803-1ac2-e002-3b9d-a75664b3cda6\"\n}","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"status\": 7751,\n \"error\": \"string\",\n \"message\": \"string\",\n \"timestamp\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"ecbaaa68-ab79-45e9-92e9-989bb98b4c82","name":"Batch redeem vouchers","request":{"name":"Batch redeem vouchers","description":{"content":"You can redeem up to 100 vouchers.\n\n---\n\n**API consumers:** Profile (Client), Anonymous Profile\n\n**User role permission required:** `campaigns_promotions: create`\n","type":"text/plain"},"url":{"path":["v4","promotions","voucher","batch-redeem"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"[\n {\n \"voucherKey\": \"code\",\n \"voucherValue\": \"75d9090f-06ac-46a2-a0ce-4b8eb287efb9\",\n \"options\": {\n \"quantity\": 1,\n \"sourceId\": \"75d9090f-06ac-46a2-a0ce-4b8eb287efb9-1\",\n \"orderId\": \"75d9090f-06ac-46a2-a0ce-4b8eb287efb9-1\",\n \"lockIdentifier\": \"75d9090f-06ac-46a2-a0ce-4b8eb287efb9\"\n }\n }\n]","options":{"raw":{"language":"json"}}}},"response":[{"id":"c5291392-9b05-4b77-9189-2ad900b75adf","name":"Vouchers redeemed","originalRequest":{"url":{"path":["v4","promotions","voucher","batch-redeem"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"[\n {\n \"voucherKey\": \"code\",\n \"voucherValue\": \"75d9090f-06ac-46a2-a0ce-4b8eb287efb9\",\n \"options\": {\n \"quantity\": 1,\n \"sourceId\": \"75d9090f-06ac-46a2-a0ce-4b8eb287efb9-1\",\n \"orderId\": \"75d9090f-06ac-46a2-a0ce-4b8eb287efb9-1\",\n \"lockIdentifier\": \"75d9090f-06ac-46a2-a0ce-4b8eb287efb9\"\n }\n }\n]","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"message\": \"string\",\n \"data\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"da30c2b7-f5e8-492d-a78b-728a8fffaba1","name":"Some vouchers couldn't be redeemed","originalRequest":{"url":{"path":["v4","promotions","voucher","batch-redeem"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"[\n {\n \"voucherKey\": \"code\",\n \"voucherValue\": \"75d9090f-06ac-46a2-a0ce-4b8eb287efb9\",\n \"options\": {\n \"quantity\": 1,\n \"sourceId\": \"75d9090f-06ac-46a2-a0ce-4b8eb287efb9-1\",\n \"orderId\": \"75d9090f-06ac-46a2-a0ce-4b8eb287efb9-1\",\n \"lockIdentifier\": \"75d9090f-06ac-46a2-a0ce-4b8eb287efb9\"\n }\n }\n]","options":{"raw":{"language":"json"}}}},"status":"Multi-Status (WebDAV) (RFC 4918)","code":207,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"httpStatus\": 207,\n \"traceId\": \"c72d530fd1b813ae\",\n \"timestamp\": \"2021-12-28T08:27:54.549Z\",\n \"errorCode\": \"ERR-003\",\n \"message\": \"Batch operation failed\",\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"data\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"20ea7875-ebfe-4647-901c-e5d88b753e3b","name":"Batch redeem vouchers for profiles","request":{"name":"Batch redeem vouchers for profiles","description":{"content":"You can redeem up to 100 vouchers.\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User\n\n**API key permission required:** `PROMOTIONS_BATCH_REDEEM_VOUCHERS_PROMOTIONS_CREATE`\n\n**User role permission required:** `campaigns_promotions: create`\n","type":"text/plain"},"url":{"path":["v4","promotions","voucher","batch-redeem-for-profile"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"[\n {\n \"profileKey\": {\n \"value\": \"\"\n },\n \"profileValue\": {\n \"value\": \"\"\n },\n \"voucherKey\": {\n \"value\": \"\"\n },\n \"voucherValue\": {\n \"value\": \"\"\n },\n \"options\": {\n \"value\": \"\"\n }\n }\n]","options":{"raw":{"language":"json"}}}},"response":[{"id":"77a9e95c-2e47-45cc-a717-a8293eb56b72","name":"Vouchers redeemed","originalRequest":{"url":{"path":["v4","promotions","voucher","batch-redeem-for-profile"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"[\n {\n \"profileKey\": {\n \"value\": \"\"\n },\n \"profileValue\": {\n \"value\": \"\"\n },\n \"voucherKey\": {\n \"value\": \"\"\n },\n \"voucherValue\": {\n \"value\": \"\"\n },\n \"options\": {\n \"value\": \"\"\n }\n }\n]","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"message\": \"string\",\n \"data\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"fae1f15c-8dc2-45da-a7ab-6a40b730db65","name":"Some vouchers couldn't be redeemed","originalRequest":{"url":{"path":["v4","promotions","voucher","batch-redeem-for-profile"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"[\n {\n \"profileKey\": {\n \"value\": \"\"\n },\n \"profileValue\": {\n \"value\": \"\"\n },\n \"voucherKey\": {\n \"value\": \"\"\n },\n \"voucherValue\": {\n \"value\": \"\"\n },\n \"options\": {\n \"value\": \"\"\n }\n }\n]","options":{"raw":{"language":"json"}}}},"status":"Multi-Status (WebDAV) (RFC 4918)","code":207,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"httpStatus\": 207,\n \"traceId\": \"c72d530fd1b813ae\",\n \"timestamp\": \"2021-12-28T08:27:54.549Z\",\n \"errorCode\": \"ERR-003\",\n \"message\": \"Batch operation failed\",\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"data\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"6f926edd-bd5a-4fea-82f7-22b5b3a2d199","name":"Batch import promotions","request":{"name":"Batch import promotions","description":{"content":"Submit a batch of promotions for asynchronous import (upsert). Items are validated individually and queued for processing. Returns 202 if all items are valid, or 207 if some fail validation.\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User\n\n**API key permission required:** `PROMOTIONS_IMPORT_PROMOTIONS_CREATE`\n\n**User role permission required:** `campaigns_promotions: create`\n","type":"text/plain"},"url":{"path":["v4","promotions","v2","promotion","batch"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"data\": [\n {\n \"value\": \"\"\n }\n ],\n \"extra\": {\n \"importHash\": \"string\"\n }\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"e7f4227c-c43f-4bce-a38b-381b4e248153","name":"All items accepted for processing","originalRequest":{"url":{"path":["v4","promotions","v2","promotion","batch"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"data\": [\n {\n \"value\": \"\"\n }\n ],\n \"extra\": {\n \"importHash\": \"string\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Accepted","code":202,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"data\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"e82d31f4-8fc6-4fca-bfd1-3dde8b326479","name":"Some items failed validation","originalRequest":{"url":{"path":["v4","promotions","v2","promotion","batch"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"data\": [\n {\n \"value\": \"\"\n }\n ],\n \"extra\": {\n \"importHash\": \"string\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Multi-Status (WebDAV) (RFC 4918)","code":207,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"httpStatus\": 207,\n \"errorCode\": \"ERR-001\",\n \"message\": \"Internal Error\",\n \"help\": \"string\",\n \"data\": {\n \"value\": \"\"\n },\n \"errors\": [\n {\n \"source\": {\n \"value\": \"\"\n },\n \"errorCode\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"help\": {\n \"value\": \"\"\n },\n \"httpStatus\": {\n \"value\": \"\"\n },\n \"errors\": {\n \"value\": \"\"\n }\n },\n {\n \"source\": {\n \"value\": \"\"\n },\n \"errorCode\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"help\": {\n \"value\": \"\"\n },\n \"httpStatus\": {\n \"value\": \"\"\n },\n \"errors\": {\n \"value\": \"\"\n }\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"22ce3569-7f08-4c43-b28d-308991219bcc","name":"Request body invalid/malformed/missing elements","originalRequest":{"url":{"path":["v4","promotions","v2","promotion","batch"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"data\": [\n {\n \"value\": \"\"\n }\n ],\n \"extra\": {\n \"importHash\": \"string\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"message\": {\n \"value\": \"\"\n },\n \"error\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"ae9ae84c-0ba9-49fd-b81a-8ee6bfa52c7c","name":"Unauthorized","originalRequest":{"url":{"path":["v4","promotions","v2","promotion","batch"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"data\": [\n {\n \"value\": \"\"\n }\n ],\n \"extra\": {\n \"importHash\": \"string\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"status\": 7751,\n \"error\": \"string\",\n \"message\": \"string\",\n \"timestamp\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"8c3e3bc3-858a-4d46-8ec6-a52ef292942a","name":"Forbidden","originalRequest":{"url":{"path":["v4","promotions","v2","promotion","batch"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"data\": [\n {\n \"value\": \"\"\n }\n ],\n \"extra\": {\n \"importHash\": \"string\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"status\": 7751,\n \"error\": \"string\",\n \"message\": \"string\",\n \"timestamp\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"587b49ea-924c-4618-b1fc-a5d9f042860a","name":"Batch delete promotions","request":{"name":"Batch delete promotions","description":{"content":"Submit a batch of promotion codes for asynchronous deletion. Items are validated individually and queued for processing . Returns 202 if all items are valid, or 207 if some fail validation. \nThis method doesn't check if a promotion with the provide code exists.\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User\n\n**API key permission required:** `PROMOTIONS_IMPORT_PROMOTIONS_DELETE`\n\n**User role permission required:** `campaigns_promotions: delete`\n","type":"text/plain"},"url":{"path":["v4","promotions","v2","promotion","batch"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"DELETE","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"data\": [\n {\n \"value\": \"\"\n }\n ],\n \"extra\": {\n \"importHash\": \"string\"\n }\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"3a7934ad-56e5-4bc0-a18f-bc1fdb828e29","name":"All items accepted for processing","originalRequest":{"url":{"path":["v4","promotions","v2","promotion","batch"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{"mode":"raw","raw":"{\n \"data\": [\n {\n \"value\": \"\"\n }\n ],\n \"extra\": {\n \"importHash\": \"string\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Accepted","code":202,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"data\": [\n {\n \"code\": {\n \"value\": \"\"\n }\n },\n {\n \"code\": {\n \"value\": \"\"\n }\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"19cbb4cb-c9b3-45e9-bf9f-717928e6fd3b","name":"Some items failed validation","originalRequest":{"url":{"path":["v4","promotions","v2","promotion","batch"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{"mode":"raw","raw":"{\n \"data\": [\n {\n \"value\": \"\"\n }\n ],\n \"extra\": {\n \"importHash\": \"string\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Multi-Status (WebDAV) (RFC 4918)","code":207,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"httpStatus\": 207,\n \"errorCode\": \"ERR-001\",\n \"message\": \"Internal Error\",\n \"help\": \"string\",\n \"data\": {\n \"value\": \"\"\n },\n \"errors\": [\n {\n \"source\": {\n \"value\": \"\"\n },\n \"errorCode\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"help\": {\n \"value\": \"\"\n },\n \"httpStatus\": {\n \"value\": \"\"\n },\n \"errors\": {\n \"value\": \"\"\n }\n },\n {\n \"source\": {\n \"value\": \"\"\n },\n \"errorCode\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"help\": {\n \"value\": \"\"\n },\n \"httpStatus\": {\n \"value\": \"\"\n },\n \"errors\": {\n \"value\": \"\"\n }\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"eb14e113-75f0-4f39-849a-eb94a5588b11","name":"Request body invalid/malformed/missing elements","originalRequest":{"url":{"path":["v4","promotions","v2","promotion","batch"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{"mode":"raw","raw":"{\n \"data\": [\n {\n \"value\": \"\"\n }\n ],\n \"extra\": {\n \"importHash\": \"string\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"message\": {\n \"value\": \"\"\n },\n \"error\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"b45013f0-80d1-4da0-8204-7c0ece31398c","name":"Unauthorized","originalRequest":{"url":{"path":["v4","promotions","v2","promotion","batch"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{"mode":"raw","raw":"{\n \"data\": [\n {\n \"value\": \"\"\n }\n ],\n \"extra\": {\n \"importHash\": \"string\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"status\": 7751,\n \"error\": \"string\",\n \"message\": \"string\",\n \"timestamp\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"18086bac-973f-4301-9c39-86a1e1e88aaf","name":"Forbidden","originalRequest":{"url":{"path":["v4","promotions","v2","promotion","batch"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{"mode":"raw","raw":"{\n \"data\": [\n {\n \"value\": \"\"\n }\n ],\n \"extra\": {\n \"importHash\": \"string\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"status\": 7751,\n \"error\": \"string\",\n \"message\": \"string\",\n \"timestamp\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"56c32231-0d2e-430b-803f-360819ddddb2","name":"Process basket","request":{"name":"Process basket","description":{"content":"Assign promotions to a basket and recalculate item values after discount.\n\nThis method DOES NOT redeem any promotions or create a transaction.\n\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User\n\n**API key permission required:** `PROMOTIONS_SALE_PROMOTIONS_READ`\n\n**User role permission required:** `campaigns_promotions: read`\n","type":"text/plain"},"url":{"path":["v4","promotions","v2","sale","process-sale",":identifierType",":identifierValue"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"email","key":"identifierType","description":"(Required) The Profile identifier to use for the request.\n\n`externalId` is known as `customId` or `custom_identify` in other Synerise services.\n"},{"disabled":false,"type":"any","value":"string","key":"identifierValue","description":"(Required) The value of the selected identifier"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"operationId\": 4790,\n \"clientDateTime\": \"1969-01-11T15:47:44.209Z\",\n \"terminal\": {\n \"storeId\": {\n \"value\": \"\"\n },\n \"posId\": {\n \"value\": \"\"\n }\n },\n \"transactionMetric\": {\n \"posTransactionId\": {\n \"value\": \"\"\n },\n \"beginDateTime\": {\n \"value\": \"\"\n },\n \"globalTransactionId\": {\n \"value\": \"\"\n }\n },\n \"finalValue\": \"string\",\n \"transactionItems\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"transactionAdditionalItems\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"promotionsToActivate\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"dfac4380-415e-45a0-b1b2-830d2feee251","name":"Basket processed","originalRequest":{"url":{"path":["v4","promotions","v2","sale","process-sale",":identifierType",":identifierValue"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"email","key":"identifierType","description":"(Required) The Profile identifier to use for the request.\n\n`externalId` is known as `customId` or `custom_identify` in other Synerise services.\n"},{"disabled":false,"type":"any","value":"string","key":"identifierValue","description":"(Required) The value of the selected identifier"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"operationId\": 2387,\n \"clientDateTime\": \"1961-01-22T15:31:20.261Z\",\n \"terminal\": {\n \"storeId\": {\n \"value\": \"\"\n },\n \"posId\": {\n \"value\": \"\"\n }\n },\n \"transactionMetric\": {\n \"posTransactionId\": {\n \"value\": \"\"\n },\n \"beginDateTime\": {\n \"value\": \"\"\n },\n \"globalTransactionId\": {\n \"value\": \"\"\n }\n },\n \"finalValue\": \"string\",\n \"transactionItems\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"transactionAdditionalItems\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"promotionsToActivate\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"responseCode\": 989.7410283067298,\n \"responseDescription\": \"string\",\n \"operationId\": 239,\n \"clientDateTime\": \"1981-03-24T21:59:08.361Z\",\n \"terminal\": {\n \"storeId\": {\n \"value\": \"\"\n },\n \"posId\": {\n \"value\": \"\"\n }\n },\n \"transactionMetric\": {\n \"posTransactionId\": {\n \"value\": \"\"\n },\n \"beginDateTime\": {\n \"value\": \"\"\n },\n \"globalTransactionId\": {\n \"value\": \"\"\n }\n },\n \"finalValue\": \"string\",\n \"promotionErrors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"transactionItems\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"transactionAdditionalItem\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"9889bdb1-936e-4f61-9b53-21842c8e8307","name":"Request body invalid/malformed/missing elements","originalRequest":{"url":{"path":["v4","promotions","v2","sale","process-sale",":identifierType",":identifierValue"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"email","key":"identifierType","description":"(Required) The Profile identifier to use for the request.\n\n`externalId` is known as `customId` or `custom_identify` in other Synerise services.\n"},{"disabled":false,"type":"any","value":"string","key":"identifierValue","description":"(Required) The value of the selected identifier"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"operationId\": 2387,\n \"clientDateTime\": \"1961-01-22T15:31:20.261Z\",\n \"terminal\": {\n \"storeId\": {\n \"value\": \"\"\n },\n \"posId\": {\n \"value\": \"\"\n }\n },\n \"transactionMetric\": {\n \"posTransactionId\": {\n \"value\": \"\"\n },\n \"beginDateTime\": {\n \"value\": \"\"\n },\n \"globalTransactionId\": {\n \"value\": \"\"\n }\n },\n \"finalValue\": \"string\",\n \"transactionItems\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"transactionAdditionalItems\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"promotionsToActivate\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"message\": {\n \"value\": \"\"\n },\n \"error\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"edbac372-cf5e-4697-9f09-2b030554aa3a","name":"Unauthorized","originalRequest":{"url":{"path":["v4","promotions","v2","sale","process-sale",":identifierType",":identifierValue"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"email","key":"identifierType","description":"(Required) The Profile identifier to use for the request.\n\n`externalId` is known as `customId` or `custom_identify` in other Synerise services.\n"},{"disabled":false,"type":"any","value":"string","key":"identifierValue","description":"(Required) The value of the selected identifier"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"operationId\": 2387,\n \"clientDateTime\": \"1961-01-22T15:31:20.261Z\",\n \"terminal\": {\n \"storeId\": {\n \"value\": \"\"\n },\n \"posId\": {\n \"value\": \"\"\n }\n },\n \"transactionMetric\": {\n \"posTransactionId\": {\n \"value\": \"\"\n },\n \"beginDateTime\": {\n \"value\": \"\"\n },\n \"globalTransactionId\": {\n \"value\": \"\"\n }\n },\n \"finalValue\": \"string\",\n \"transactionItems\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"transactionAdditionalItems\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"promotionsToActivate\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"status\": 7751,\n \"error\": \"string\",\n \"message\": \"string\",\n \"timestamp\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"14294616-fa67-4191-89c2-b78b734349b0","name":"Forbidden","originalRequest":{"url":{"path":["v4","promotions","v2","sale","process-sale",":identifierType",":identifierValue"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"email","key":"identifierType","description":"(Required) The Profile identifier to use for the request.\n\n`externalId` is known as `customId` or `custom_identify` in other Synerise services.\n"},{"disabled":false,"type":"any","value":"string","key":"identifierValue","description":"(Required) The value of the selected identifier"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"operationId\": 2387,\n \"clientDateTime\": \"1961-01-22T15:31:20.261Z\",\n \"terminal\": {\n \"storeId\": {\n \"value\": \"\"\n },\n \"posId\": {\n \"value\": \"\"\n }\n },\n \"transactionMetric\": {\n \"posTransactionId\": {\n \"value\": \"\"\n },\n \"beginDateTime\": {\n \"value\": \"\"\n },\n \"globalTransactionId\": {\n \"value\": \"\"\n }\n },\n \"finalValue\": \"string\",\n \"transactionItems\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"transactionAdditionalItems\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"promotionsToActivate\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"status\": 7751,\n \"error\": \"string\",\n \"message\": \"string\",\n \"timestamp\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"ac05c887-0519-4b08-b5b9-d679f93c6716","name":"Process checkout on POS","request":{"name":"Process checkout on POS","description":{"content":"Assign checkout handbill coupons for a profile, based on items in the basket and historical transactions.\n\nThis method DOES NOT redeem any promotions or create a transaction.\n\n**IMPORTANT**: When assigning handbill promotions, candidate promotions are bounded by configurable limits: at most 40,000 candidates are read per handbill slot (ordered by priority), and the total number of candidates sent to the recommendation (AI) engine in a single request is capped at 45,000. If the combined candidates across all slots exceed the AI request cap, each slot is reduced proportionally to the number of candidates it contributed, but never below a configurable per-slot floor (default 1,000), so the smallest slots are left intact.\n\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User\n\n**API key permission required:** `PROMOTIONS_SALE_PROMOTIONS_READ`\n\n**User role permission required:** `campaigns_promotions: read`\n","type":"text/plain"},"url":{"path":["v4","promotions","sale","process-checkout",":identifierType",":identifierValue"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"email","key":"identifierType","description":"(Required) The Profile identifier to use for the request.\n\n`externalId` is known as `customId` or `custom_identify` in other Synerise services.\n"},{"disabled":false,"type":"any","value":"string","key":"identifierValue","description":"(Required) The value of the selected identifier"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"operationId\": 3274,\n \"clientDateTime\": \"1959-06-17T06:43:44.246Z\",\n \"terminal\": {\n \"storeId\": {\n \"value\": \"\"\n },\n \"posId\": {\n \"value\": \"\"\n }\n },\n \"transactionMetric\": {\n \"posTransactionId\": {\n \"value\": \"\"\n },\n \"beginDateTime\": {\n \"value\": \"\"\n },\n \"globalTransactionId\": {\n \"value\": \"\"\n }\n },\n \"finalValue\": \"string\",\n \"transactionItems\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"transactionAdditionalItems\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"paymentsReport\": {\n \"paymentItems\": {\n \"value\": \"\"\n }\n }\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"4cb9916f-449f-4792-a58e-29427696789e","name":"POS checkout processed","originalRequest":{"url":{"path":["v4","promotions","sale","process-checkout",":identifierType",":identifierValue"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"email","key":"identifierType","description":"(Required) The Profile identifier to use for the request.\n\n`externalId` is known as `customId` or `custom_identify` in other Synerise services.\n"},{"disabled":false,"type":"any","value":"string","key":"identifierValue","description":"(Required) The value of the selected identifier"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"operationId\": 2951,\n \"clientDateTime\": \"2008-11-30T22:50:31.462Z\",\n \"terminal\": {\n \"storeId\": {\n \"value\": \"\"\n },\n \"posId\": {\n \"value\": \"\"\n }\n },\n \"transactionMetric\": {\n \"posTransactionId\": {\n \"value\": \"\"\n },\n \"beginDateTime\": {\n \"value\": \"\"\n },\n \"globalTransactionId\": {\n \"value\": \"\"\n }\n },\n \"finalValue\": \"string\",\n \"transactionItems\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"transactionAdditionalItems\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"paymentsReport\": {\n \"paymentItems\": {\n \"value\": \"\"\n }\n }\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"responseCode\": 5355.06157364716,\n \"responseDescription\": \"string\",\n \"operationId\": 6650,\n \"clientDateTime\": \"1954-05-10T06:46:46.357Z\",\n \"terminal\": {\n \"storeId\": {\n \"value\": \"\"\n },\n \"posId\": {\n \"value\": \"\"\n }\n },\n \"transactionGrantReport\": {\n \"printouts\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"f29cd264-9033-4c14-8ded-02709e115380","name":"Request body invalid/malformed/missing elements","originalRequest":{"url":{"path":["v4","promotions","sale","process-checkout",":identifierType",":identifierValue"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"email","key":"identifierType","description":"(Required) The Profile identifier to use for the request.\n\n`externalId` is known as `customId` or `custom_identify` in other Synerise services.\n"},{"disabled":false,"type":"any","value":"string","key":"identifierValue","description":"(Required) The value of the selected identifier"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"operationId\": 2951,\n \"clientDateTime\": \"2008-11-30T22:50:31.462Z\",\n \"terminal\": {\n \"storeId\": {\n \"value\": \"\"\n },\n \"posId\": {\n \"value\": \"\"\n }\n },\n \"transactionMetric\": {\n \"posTransactionId\": {\n \"value\": \"\"\n },\n \"beginDateTime\": {\n \"value\": \"\"\n },\n \"globalTransactionId\": {\n \"value\": \"\"\n }\n },\n \"finalValue\": \"string\",\n \"transactionItems\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"transactionAdditionalItems\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"paymentsReport\": {\n \"paymentItems\": {\n \"value\": \"\"\n }\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"message\": {\n \"value\": \"\"\n },\n \"error\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"972e1729-2963-4ef4-ac6f-c386b97a6bb0","name":"Unauthorized","originalRequest":{"url":{"path":["v4","promotions","sale","process-checkout",":identifierType",":identifierValue"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"email","key":"identifierType","description":"(Required) The Profile identifier to use for the request.\n\n`externalId` is known as `customId` or `custom_identify` in other Synerise services.\n"},{"disabled":false,"type":"any","value":"string","key":"identifierValue","description":"(Required) The value of the selected identifier"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"operationId\": 2951,\n \"clientDateTime\": \"2008-11-30T22:50:31.462Z\",\n \"terminal\": {\n \"storeId\": {\n \"value\": \"\"\n },\n \"posId\": {\n \"value\": \"\"\n }\n },\n \"transactionMetric\": {\n \"posTransactionId\": {\n \"value\": \"\"\n },\n \"beginDateTime\": {\n \"value\": \"\"\n },\n \"globalTransactionId\": {\n \"value\": \"\"\n }\n },\n \"finalValue\": \"string\",\n \"transactionItems\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"transactionAdditionalItems\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"paymentsReport\": {\n \"paymentItems\": {\n \"value\": \"\"\n }\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"status\": 7751,\n \"error\": \"string\",\n \"message\": \"string\",\n \"timestamp\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"ed6f86cd-6698-4d49-b1e1-fce73448478f","name":"Forbidden","originalRequest":{"url":{"path":["v4","promotions","sale","process-checkout",":identifierType",":identifierValue"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"email","key":"identifierType","description":"(Required) The Profile identifier to use for the request.\n\n`externalId` is known as `customId` or `custom_identify` in other Synerise services.\n"},{"disabled":false,"type":"any","value":"string","key":"identifierValue","description":"(Required) The value of the selected identifier"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"operationId\": 2951,\n \"clientDateTime\": \"2008-11-30T22:50:31.462Z\",\n \"terminal\": {\n \"storeId\": {\n \"value\": \"\"\n },\n \"posId\": {\n \"value\": \"\"\n }\n },\n \"transactionMetric\": {\n \"posTransactionId\": {\n \"value\": \"\"\n },\n \"beginDateTime\": {\n \"value\": \"\"\n },\n \"globalTransactionId\": {\n \"value\": \"\"\n }\n },\n \"finalValue\": \"string\",\n \"transactionItems\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"transactionAdditionalItems\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"paymentsReport\": {\n \"paymentItems\": {\n \"value\": \"\"\n }\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"status\": 7751,\n \"error\": \"string\",\n \"message\": \"string\",\n \"timestamp\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"49de6a3a-8a2f-4260-8594-1f779f83a576","name":"Process anonymous Profile's basket","request":{"name":"Process anonymous Profile's basket","description":{"content":"Assign promotions to a basket and recalculate item values after discount.\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User\n\n**API key permission required:** `PROMOTIONS_SALE_PROMOTIONS_READ`\n\n**User role permission required:** `campaigns_promotions: read`\n","type":"text/plain"},"url":{"path":["v4","promotions","v2","sale","process-anonymous-sale"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"operationId\": 2387,\n \"clientDateTime\": \"1961-01-22T15:31:20.261Z\",\n \"terminal\": {\n \"storeId\": {\n \"value\": \"\"\n },\n \"posId\": {\n \"value\": \"\"\n }\n },\n \"transactionMetric\": {\n \"posTransactionId\": {\n \"value\": \"\"\n },\n \"beginDateTime\": {\n \"value\": \"\"\n },\n \"globalTransactionId\": {\n \"value\": \"\"\n }\n },\n \"finalValue\": \"string\",\n \"transactionItems\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"transactionAdditionalItems\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"promotionsToActivate\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"1cfe01f3-4b46-4660-a007-882cf365591e","name":"Basket processed","originalRequest":{"url":{"path":["v4","promotions","v2","sale","process-anonymous-sale"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"operationId\": 2387,\n \"clientDateTime\": \"1961-01-22T15:31:20.261Z\",\n \"terminal\": {\n \"storeId\": {\n \"value\": \"\"\n },\n \"posId\": {\n \"value\": \"\"\n }\n },\n \"transactionMetric\": {\n \"posTransactionId\": {\n \"value\": \"\"\n },\n \"beginDateTime\": {\n \"value\": \"\"\n },\n \"globalTransactionId\": {\n \"value\": \"\"\n }\n },\n \"finalValue\": \"string\",\n \"transactionItems\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"transactionAdditionalItems\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"promotionsToActivate\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"responseCode\": 7394.194827542592,\n \"responseDescription\": \"string\",\n \"operationId\": 6839,\n \"clientDateTime\": \"1980-04-10T11:46:51.765Z\",\n \"terminal\": {\n \"storeId\": {\n \"value\": \"\"\n },\n \"posId\": {\n \"value\": \"\"\n }\n },\n \"transactionMetric\": {\n \"posTransactionId\": {\n \"value\": \"\"\n },\n \"beginDateTime\": {\n \"value\": \"\"\n },\n \"globalTransactionId\": {\n \"value\": \"\"\n }\n },\n \"finalValue\": \"string\",\n \"promotionErrors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"transactionItems\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"transactionAdditionalItem\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"bf816068-185c-4a46-b21d-d6419b6373a7","name":"Request body invalid/malformed/missing elements","originalRequest":{"url":{"path":["v4","promotions","v2","sale","process-anonymous-sale"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"operationId\": 2387,\n \"clientDateTime\": \"1961-01-22T15:31:20.261Z\",\n \"terminal\": {\n \"storeId\": {\n \"value\": \"\"\n },\n \"posId\": {\n \"value\": \"\"\n }\n },\n \"transactionMetric\": {\n \"posTransactionId\": {\n \"value\": \"\"\n },\n \"beginDateTime\": {\n \"value\": \"\"\n },\n \"globalTransactionId\": {\n \"value\": \"\"\n }\n },\n \"finalValue\": \"string\",\n \"transactionItems\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"transactionAdditionalItems\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"promotionsToActivate\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"message\": {\n \"value\": \"\"\n },\n \"error\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"99e83a9e-ae31-47c6-a9d3-5c4fd7d55ee8","name":"Unauthorized","originalRequest":{"url":{"path":["v4","promotions","v2","sale","process-anonymous-sale"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"operationId\": 2387,\n \"clientDateTime\": \"1961-01-22T15:31:20.261Z\",\n \"terminal\": {\n \"storeId\": {\n \"value\": \"\"\n },\n \"posId\": {\n \"value\": \"\"\n }\n },\n \"transactionMetric\": {\n \"posTransactionId\": {\n \"value\": \"\"\n },\n \"beginDateTime\": {\n \"value\": \"\"\n },\n \"globalTransactionId\": {\n \"value\": \"\"\n }\n },\n \"finalValue\": \"string\",\n \"transactionItems\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"transactionAdditionalItems\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"promotionsToActivate\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"status\": 7751,\n \"error\": \"string\",\n \"message\": \"string\",\n \"timestamp\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"6a784720-74fb-466b-8d7a-e24fdb56cfd8","name":"Forbidden","originalRequest":{"url":{"path":["v4","promotions","v2","sale","process-anonymous-sale"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"operationId\": 2387,\n \"clientDateTime\": \"1961-01-22T15:31:20.261Z\",\n \"terminal\": {\n \"storeId\": {\n \"value\": \"\"\n },\n \"posId\": {\n \"value\": \"\"\n }\n },\n \"transactionMetric\": {\n \"posTransactionId\": {\n \"value\": \"\"\n },\n \"beginDateTime\": {\n \"value\": \"\"\n },\n \"globalTransactionId\": {\n \"value\": \"\"\n }\n },\n \"finalValue\": \"string\",\n \"transactionItems\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"transactionAdditionalItems\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"promotionsToActivate\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"status\": 7751,\n \"error\": \"string\",\n \"message\": \"string\",\n \"timestamp\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"9330452c-ab73-474d-a7c5-1ac05994e50d","name":"Property discountSourceType in sale settings is not defined","originalRequest":{"url":{"path":["v4","promotions","v2","sale","process-anonymous-sale"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"operationId\": 2387,\n \"clientDateTime\": \"1961-01-22T15:31:20.261Z\",\n \"terminal\": {\n \"storeId\": {\n \"value\": \"\"\n },\n \"posId\": {\n \"value\": \"\"\n }\n },\n \"transactionMetric\": {\n \"posTransactionId\": {\n \"value\": \"\"\n },\n \"beginDateTime\": {\n \"value\": \"\"\n },\n \"globalTransactionId\": {\n \"value\": \"\"\n }\n },\n \"finalValue\": \"string\",\n \"transactionItems\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"transactionAdditionalItems\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"promotionsToActivate\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"Precondition Required","code":428,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"message\": \"string\",\n \"error\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"294adcda-4d00-4155-b436-00d99444177b","name":"Process anonymous Profile's checkout on POS","request":{"name":"Process anonymous Profile's checkout on POS","description":{"content":"Assign checkout handbill coupons for anonymous profile, based on items in basket and historical transactions.\n\n**IMPORTANT**: When assigning handbill promotions, candidate promotions are bounded by configurable limits: at most 40,000 candidates are read per handbill slot (ordered by priority), and the total number of candidates sent to the recommendation (AI) engine in a single request is capped at 45,000. If the combined candidates across all slots exceed the AI request cap, each slot is reduced proportionally to the number of candidates it contributed, but never below a configurable per-slot floor (default 1,000), so the smallest slots are left intact.\n\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User\n\n**API key permission required:** `PROMOTIONS_SALE_PROMOTIONS_READ`\n\n**User role permission required:** `campaigns_promotions: read`\n","type":"text/plain"},"url":{"path":["v4","promotions","sale","process-anonymous-checkout"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"operationId\": 2951,\n \"clientDateTime\": \"2008-11-30T22:50:31.462Z\",\n \"terminal\": {\n \"storeId\": {\n \"value\": \"\"\n },\n \"posId\": {\n \"value\": \"\"\n }\n },\n \"transactionMetric\": {\n \"posTransactionId\": {\n \"value\": \"\"\n },\n \"beginDateTime\": {\n \"value\": \"\"\n },\n \"globalTransactionId\": {\n \"value\": \"\"\n }\n },\n \"finalValue\": \"string\",\n \"transactionItems\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"transactionAdditionalItems\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"paymentsReport\": {\n \"paymentItems\": {\n \"value\": \"\"\n }\n }\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"8a1775b9-c364-45a6-bd97-132b4542ff7c","name":"POS checkout processed","originalRequest":{"url":{"path":["v4","promotions","sale","process-anonymous-checkout"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"operationId\": 2951,\n \"clientDateTime\": \"2008-11-30T22:50:31.462Z\",\n \"terminal\": {\n \"storeId\": {\n \"value\": \"\"\n },\n \"posId\": {\n \"value\": \"\"\n }\n },\n \"transactionMetric\": {\n \"posTransactionId\": {\n \"value\": \"\"\n },\n \"beginDateTime\": {\n \"value\": \"\"\n },\n \"globalTransactionId\": {\n \"value\": \"\"\n }\n },\n \"finalValue\": \"string\",\n \"transactionItems\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"transactionAdditionalItems\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"paymentsReport\": {\n \"paymentItems\": {\n \"value\": \"\"\n }\n }\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"responseCode\": 3385.0248764354697,\n \"responseDescription\": \"string\",\n \"operationId\": 3805,\n \"clientDateTime\": \"2001-07-29T09:02:29.327Z\",\n \"terminal\": {\n \"storeId\": {\n \"value\": \"\"\n },\n \"posId\": {\n \"value\": \"\"\n }\n },\n \"transactionGrantReport\": {\n \"printouts\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"7ba71e67-0484-4f57-bf68-d36f9282eb18","name":"Request body invalid/malformed/missing elements","originalRequest":{"url":{"path":["v4","promotions","sale","process-anonymous-checkout"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"operationId\": 2951,\n \"clientDateTime\": \"2008-11-30T22:50:31.462Z\",\n \"terminal\": {\n \"storeId\": {\n \"value\": \"\"\n },\n \"posId\": {\n \"value\": \"\"\n }\n },\n \"transactionMetric\": {\n \"posTransactionId\": {\n \"value\": \"\"\n },\n \"beginDateTime\": {\n \"value\": \"\"\n },\n \"globalTransactionId\": {\n \"value\": \"\"\n }\n },\n \"finalValue\": \"string\",\n \"transactionItems\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"transactionAdditionalItems\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"paymentsReport\": {\n \"paymentItems\": {\n \"value\": \"\"\n }\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"message\": {\n \"value\": \"\"\n },\n \"error\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"9e0908bb-73a5-4d98-bcca-9fe53ef9de7c","name":"Unauthorized","originalRequest":{"url":{"path":["v4","promotions","sale","process-anonymous-checkout"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"operationId\": 2951,\n \"clientDateTime\": \"2008-11-30T22:50:31.462Z\",\n \"terminal\": {\n \"storeId\": {\n \"value\": \"\"\n },\n \"posId\": {\n \"value\": \"\"\n }\n },\n \"transactionMetric\": {\n \"posTransactionId\": {\n \"value\": \"\"\n },\n \"beginDateTime\": {\n \"value\": \"\"\n },\n \"globalTransactionId\": {\n \"value\": \"\"\n }\n },\n \"finalValue\": \"string\",\n \"transactionItems\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"transactionAdditionalItems\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"paymentsReport\": {\n \"paymentItems\": {\n \"value\": \"\"\n }\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"status\": 7751,\n \"error\": \"string\",\n \"message\": \"string\",\n \"timestamp\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"59a0411f-6642-4972-8682-2899f4c33582","name":"Forbidden","originalRequest":{"url":{"path":["v4","promotions","sale","process-anonymous-checkout"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"operationId\": 2951,\n \"clientDateTime\": \"2008-11-30T22:50:31.462Z\",\n \"terminal\": {\n \"storeId\": {\n \"value\": \"\"\n },\n \"posId\": {\n \"value\": \"\"\n }\n },\n \"transactionMetric\": {\n \"posTransactionId\": {\n \"value\": \"\"\n },\n \"beginDateTime\": {\n \"value\": \"\"\n },\n \"globalTransactionId\": {\n \"value\": \"\"\n }\n },\n \"finalValue\": \"string\",\n \"transactionItems\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"transactionAdditionalItems\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"paymentsReport\": {\n \"paymentItems\": {\n \"value\": \"\"\n }\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"status\": 7751,\n \"error\": \"string\",\n \"message\": \"string\",\n \"timestamp\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}],"event":[]},{"id":"a391b4b5-045c-47ba-858f-20e380e69bf2","name":"Vouchers","description":{"content":"","type":"text/plain"},"item":[{"id":"a83404a7-47f1-45ec-bca1-db32ecf82bb3","name":"Assign a voucher from a pool to Profile","request":{"name":"Assign a voucher from a pool to Profile","description":{"content":"Assign a voucher code from an existing pool to a Profile.\n\n---\n\n**API consumers:** Profile (Client), Anonymous Profile, Incognito Profile\n\n**User role permission required:** `assets_code_pool: create`\n","type":"text/plain"},"url":{"path":["v4","vouchers","item","assign"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.2"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"poolUuid\": \"faec32b0-c343-4362-ba32-c6148c649da4\",\n \"clientUuid\": \"17243772-008a-42e1-ba37-c3807cebde8f\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"6d627f8e-830d-4d30-a98f-f79961800739","name":"Code assigned","originalRequest":{"url":{"path":["v4","vouchers","item","assign"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Accept","value":"application/json"},{"disabled":false,"description":"(Required) ","key":"Content-Type","value":"application/json"},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.2"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"poolUuid\": \"faec32b0-c343-4362-ba32-c6148c649da4\",\n \"clientUuid\": \"17243772-008a-42e1-ba37-c3807cebde8f\"\n}","options":{"raw":{"language":"json"}}}},"status":"Created","code":201,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"message\": \"Code assigned with success\",\n \"data\": {\n \"uuid\": {\n \"value\": \"\"\n },\n \"poolUuid\": {\n \"value\": \"\"\n },\n \"createdAt\": {\n \"value\": \"\"\n },\n \"updatedAt\": {\n \"value\": \"\"\n },\n \"clientId\": {\n \"value\": \"\"\n }\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"f997e8ab-2395-4dae-8028-67da3337f8ea","name":"Range Not Satisfiable","originalRequest":{"url":{"path":["v4","vouchers","item","assign"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Accept","value":"application/json"},{"disabled":false,"description":"(Required) ","key":"Content-Type","value":"application/json"},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.2"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"poolUuid\": \"faec32b0-c343-4362-ba32-c6148c649da4\",\n \"clientUuid\": \"17243772-008a-42e1-ba37-c3807cebde8f\"\n}","options":{"raw":{"language":"json"}}}},"status":"Requested Range Not Satisfiable","code":416,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"message\": \"Out of scope. Pool is empty.\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"edc48159-8a33-439a-a1d8-1d00b38a5982","name":"Get assigned vouchers","request":{"name":"Get assigned vouchers","description":{"content":"Retrieve all vouchers assigned to a Profile.\n\n---\n\n**API consumers:** Profile (Client), Anonymous Profile, Incognito Profile\n\n**User role permission required:** `assets_code_pool: read`\n","type":"text/plain"},"url":{"path":["v4","vouchers","item","get-assigned"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.2"},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"ad418c3e-831e-4905-a32f-eec7279773dc","name":"An array of vouchers","originalRequest":{"url":{"path":["v4","vouchers","item","get-assigned"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Accept","value":"application/json"},{"disabled":false,"description":"(Required) ","key":"Content-Type","value":"application/json"},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.2"},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"data\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"e1245c55-69c8-4534-ad52-dc719fcff666","name":"Get or assign and get voucher as Profile","request":{"name":"Get or assign and get voucher as Profile","description":{"content":"Retrieve the code assigned to a Profile. If no code was assigned earlier, the method assigns one.\n\n\nFor each Profile, the same code is retrieved every time. This can be used, for example, to retrieve unique codes used to identify a Profile.\n\n---\n\n**API consumers:** Profile (Client), Anonymous Profile, Incognito Profile\n\n**User role permission required:** `assets_code_pool: read`\n","type":"text/plain"},"url":{"path":["v4","vouchers","item","get-or-assign"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.2"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"poolUuid\": \"faec32b0-c343-4362-ba32-c6148c649da4\",\n \"clientUuid\": \"17243772-008a-42e1-ba37-c3807cebde8f\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"be4c94b5-a8b5-466d-b7bd-2628503a52e9","name":"Details of the code","originalRequest":{"url":{"path":["v4","vouchers","item","get-or-assign"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Accept","value":"application/json"},{"disabled":false,"description":"(Required) ","key":"Content-Type","value":"application/json"},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.2"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"poolUuid\": \"faec32b0-c343-4362-ba32-c6148c649da4\",\n \"clientUuid\": \"17243772-008a-42e1-ba37-c3807cebde8f\"\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"message\": \"Code found with success\",\n \"data\": {\n \"code\": {\n \"value\": \"\"\n },\n \"expireIn\": {\n \"value\": \"\"\n },\n \"redeemAt\": {\n \"value\": \"\"\n },\n \"assignedAt\": {\n \"value\": \"\"\n },\n \"createdAt\": {\n \"value\": \"\"\n },\n \"updatedAt\": {\n \"value\": \"\"\n }\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"7d8d3c5d-6239-43f6-a6d2-f66622ce5548","name":"Range Not Satisfiable","originalRequest":{"url":{"path":["v4","vouchers","item","get-or-assign"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Accept","value":"application/json"},{"disabled":false,"description":"(Required) ","key":"Content-Type","value":"application/json"},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.2"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"poolUuid\": \"faec32b0-c343-4362-ba32-c6148c649da4\",\n \"clientUuid\": \"17243772-008a-42e1-ba37-c3807cebde8f\"\n}","options":{"raw":{"language":"json"}}}},"status":"Requested Range Not Satisfiable","code":416,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"message\": \"Out of scope. Pool is empty.\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"21f81343-5adf-4a9d-9e65-f0be9cfa870b","name":"Create a voucher","request":{"name":"Create a voucher","description":{"content":"Create a single code and store it in a pool.\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User\n\n**API key permission required:** `VOUCHERS_ITEM_CREATE`\n\n**User role permission required:** `assets_code_pool: create`\n","type":"text/plain"},"url":{"path":["v4","vouchers","item"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.2"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"poolUuid\": \"faec32b0-c343-4362-ba32-c6148c649da4\",\n \"clientUuid\": \"07243772-008a-42e1-ba37-c3807cebde8f\",\n \"clientId\": 8859,\n \"code\": \"code123\",\n \"expireIn\": \"2019-01-26T10:54:35.699Z\",\n \"redeemAt\": \"1991-10-24T17:24:25.201Z\",\n \"assignedAt\": \"2026-04-20T14:36:39.014Z\",\n \"status\": \"ASSIGNED\",\n \"createdAt\": \"1957-05-08T20:10:53.827Z\",\n \"updatedAt\": \"1953-09-20T01:34:52.326Z\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"b7260608-0891-42d1-98a5-28a84aa76e2f","name":"Voucher created","originalRequest":{"url":{"path":["v4","vouchers","item"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Accept","value":"application/json"},{"disabled":false,"description":"(Required) ","key":"Content-Type","value":"application/json"},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.2"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"poolUuid\": \"faec32b0-c343-4362-ba32-c6148c649da4\",\n \"clientUuid\": \"07243772-008a-42e1-ba37-c3807cebde8f\",\n \"clientId\": 8859,\n \"code\": \"code123\",\n \"expireIn\": \"2019-01-26T10:54:35.699Z\",\n \"redeemAt\": \"1991-10-24T17:24:25.201Z\",\n \"assignedAt\": \"2026-04-20T14:36:39.014Z\",\n \"status\": \"ASSIGNED\",\n \"createdAt\": \"1957-05-08T20:10:53.827Z\",\n \"updatedAt\": \"1953-09-20T01:34:52.326Z\"\n}","options":{"raw":{"language":"json"}}}},"status":"Created","code":201,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"message\": \"Create object with success\",\n \"data\": {\n \"uuid\": {\n \"value\": \"\"\n },\n \"poolUuid\": {\n \"value\": \"\"\n },\n \"createdAt\": {\n \"value\": \"\"\n },\n \"updatedAt\": {\n \"value\": \"\"\n },\n \"clientId\": {\n \"value\": \"\"\n }\n }\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"092c5c98-e026-4117-a197-6b3b9664c8d3","name":"Bulk create vouchers","request":{"name":"Bulk create vouchers","description":{"content":"Create a number of codes and add them to a pool.\n\nWARNING: The request body cannot contain more than 10 000 items or exceed 10 MB in size.\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User\n\n**API key permission required:** `VOUCHERS_ITEM_BULK_CREATE`\n\n**User role permission required:** `assets_code_pool: create`\n","type":"text/plain"},"url":{"path":["v4","vouchers","item","bulk-create"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.2"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"poolUuid\": \"faec32b0-c343-4362-ba32-c6148c649da4\",\n \"codeList\": \"3845734682364756454534;384574634564545456;567868678345234346748\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"e79fc468-d9a4-49a9-a359-3a1f507e2432","name":"Vouchers created","originalRequest":{"url":{"path":["v4","vouchers","item","bulk-create"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Accept","value":"application/json"},{"disabled":false,"description":"(Required) ","key":"Content-Type","value":"application/json"},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.2"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"poolUuid\": \"faec32b0-c343-4362-ba32-c6148c649da4\",\n \"codeList\": \"3845734682364756454534;384574634564545456;567868678345234346748\"\n}","options":{"raw":{"language":"json"}}}},"status":"Created","code":201,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"data\": {\n \"message\": {\n \"value\": \"\"\n },\n \"data\": {\n \"value\": \"\"\n }\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"1c3f13aa-3db8-4607-a079-31b746116af8","name":"Bad Request","originalRequest":{"url":{"path":["v4","vouchers","item","bulk-create"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Accept","value":"application/json"},{"disabled":false,"description":"(Required) ","key":"Content-Type","value":"application/json"},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.2"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"poolUuid\": \"faec32b0-c343-4362-ba32-c6148c649da4\",\n \"codeList\": \"3845734682364756454534;384574634564545456;567868678345234346748\"\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"message\": \"Data format is not valid\",\n \"error\": [\n {\n \"field\": \"code\",\n \"message\": \"code must be unique\",\n \"validatorKey\": \"not_unique\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"655e8921-c839-4382-9458-fddf96842b00","name":"List all vouchers","request":{"name":"List all vouchers","description":{"content":"Retrieve all vouchers for a Workspace. You can customize the search.\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User\n\n**API key permission required:** `VOUCHERS_ITEM_LIST_READ`\n\n**User role permission required:** `assets_code_pool: read`\n","type":"text/plain"},"url":{"path":["v4","vouchers","item","list"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"limit","value":"100","description":"The number of items to return per page"},{"disabled":false,"key":"page","value":"4","description":"Page number to return for pagination. The first page has the index `1`."},{"disabled":false,"key":"includeMeta","value":"false","description":"\nWhen `true`, pagination metadata is included in the response body.\n\nWhen `false`, the data is included in the response headers:\n\n- Link: links to neighbors, first, and last pages in pagination.\n\n- X-Pagination-Total-Count: total number of items on all pages\n\n- X-Pagination-Total-Pages: total number of pages\n\n- X-Pagination-Page: current page\n\n- X-Pagination-Limit: maximum number of items on a page\n"}],"variable":[]},"header":[{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.2"},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"e6fd744a-bc3a-4c19-bb22-5a81769f3feb","name":"An array of vouchers","originalRequest":{"url":{"path":["v4","vouchers","item","list"],"host":["{{baseUrl}}"],"query":[{"key":"limit","value":"100"},{"key":"page","value":"4"},{"key":"includeMeta","value":"false"}],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Accept","value":"application/json"},{"disabled":false,"description":"(Required) ","key":"Content-Type","value":"application/json"},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.2"},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"data\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"meta\": {\n \"link\": {\n \"value\": \"\"\n },\n \"totalCount\": {\n \"value\": \"\"\n },\n \"totalPages\": {\n \"value\": \"\"\n },\n \"page\": {\n \"value\": \"\"\n },\n \"limit\": {\n \"value\": \"\"\n },\n \"code\": {\n \"value\": \"\"\n }\n }\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"8bc81166-32c2-4132-a8ca-64e39a3bc027","name":"View voucher details","request":{"name":"View voucher details","description":{"content":"Retrieve all details of a single code.\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User\n\n**API key permission required:** `VOUCHERS_ITEM_READ`\n\n**User role permission required:** `assets_code_pool: read`\n","type":"text/plain"},"url":{"path":["v4","vouchers","item",":voucherUuid"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"29392878-d43f-402e-8297-f63d465cf173","key":"voucherUuid","description":"(Required) UUID of the voucher"}]},"header":[{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.2"},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"4a229751-f99a-40f5-932e-ba2f97845ddb","name":"Details of a voucher","originalRequest":{"url":{"path":["v4","vouchers","item",":voucherUuid"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"29392878-d43f-402e-8297-f63d465cf173","key":"voucherUuid","description":"(Required) UUID of the voucher"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Accept","value":"application/json"},{"disabled":false,"description":"(Required) ","key":"Content-Type","value":"application/json"},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.2"},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"data\": {\n \"poolUuid\": {\n \"value\": \"\"\n },\n \"clientUuid\": {\n \"value\": \"\"\n },\n \"clientId\": {\n \"value\": \"\"\n },\n \"code\": {\n \"value\": \"\"\n },\n \"expireIn\": {\n \"value\": \"\"\n },\n \"redeemAt\": {\n \"value\": \"\"\n },\n \"assignedAt\": {\n \"value\": \"\"\n },\n \"status\": {\n \"value\": \"\"\n },\n \"createdAt\": {\n \"value\": \"\"\n },\n \"updatedAt\": {\n \"value\": \"\"\n }\n }\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"08331846-4825-4617-a2b7-f5896b1f4269","name":"Update a voucher","request":{"name":"Update a voucher","description":{"content":"Update an existing code.\n\n\nIf you don't want to change a field, omit it entirely. Sending a null-value field replaces an existing value.\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User\n\n**API key permission required:** `VOUCHERS_ITEM_UPDATE`\n\n**User role permission required:** `assets_code_pool: update`\n","type":"text/plain"},"url":{"path":["v4","vouchers","item",":voucherUuid"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"29392878-d43f-402e-8297-f63d465cf173","key":"voucherUuid","description":"(Required) UUID of the voucher"}]},"header":[{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.2"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PUT","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"poolUuid\": \"faec32b0-c343-4362-ba32-c6148c649da4\",\n \"clientUuid\": \"07243772-008a-42e1-ba37-c3807cebde8f\",\n \"clientId\": 8859,\n \"code\": \"code123\",\n \"expireIn\": \"2019-01-26T10:54:35.699Z\",\n \"redeemAt\": \"1991-10-24T17:24:25.201Z\",\n \"assignedAt\": \"2026-04-20T14:36:39.014Z\",\n \"status\": \"ASSIGNED\",\n \"createdAt\": \"1957-05-08T20:10:53.827Z\",\n \"updatedAt\": \"1953-09-20T01:34:52.326Z\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"99821908-386c-4769-99fd-467df5b3a733","originalRequest":{"url":{"path":["v4","vouchers","item",":voucherUuid"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"29392878-d43f-402e-8297-f63d465cf173","key":"voucherUuid","description":"(Required) UUID of the voucher"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Accept","value":"application/json"},{"disabled":false,"description":"(Required) ","key":"Content-Type","value":"application/json"},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.2"},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"{\n \"poolUuid\": \"faec32b0-c343-4362-ba32-c6148c649da4\",\n \"clientUuid\": \"07243772-008a-42e1-ba37-c3807cebde8f\",\n \"clientId\": 8859,\n \"code\": \"code123\",\n \"expireIn\": \"2019-01-26T10:54:35.699Z\",\n \"redeemAt\": \"1991-10-24T17:24:25.201Z\",\n \"assignedAt\": \"2026-04-20T14:36:39.014Z\",\n \"status\": \"ASSIGNED\",\n \"createdAt\": \"1957-05-08T20:10:53.827Z\",\n \"updatedAt\": \"1953-09-20T01:34:52.326Z\"\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"message\": \"Update object with success\",\n \"data\": {\n \"uuid\": {\n \"value\": \"\"\n },\n \"poolUuid\": {\n \"value\": \"\"\n },\n \"createdAt\": {\n \"value\": \"\"\n },\n \"updatedAt\": {\n \"value\": \"\"\n },\n \"clientId\": {\n \"value\": \"\"\n }\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"3a95fd5b-4012-4887-8720-e7b173dd75c9","name":"Bad Request","originalRequest":{"url":{"path":["v4","vouchers","item",":voucherUuid"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"29392878-d43f-402e-8297-f63d465cf173","key":"voucherUuid","description":"(Required) UUID of the voucher"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Accept","value":"application/json"},{"disabled":false,"description":"(Required) ","key":"Content-Type","value":"application/json"},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.2"},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"{\n \"poolUuid\": \"faec32b0-c343-4362-ba32-c6148c649da4\",\n \"clientUuid\": \"07243772-008a-42e1-ba37-c3807cebde8f\",\n \"clientId\": 8859,\n \"code\": \"code123\",\n \"expireIn\": \"2019-01-26T10:54:35.699Z\",\n \"redeemAt\": \"1991-10-24T17:24:25.201Z\",\n \"assignedAt\": \"2026-04-20T14:36:39.014Z\",\n \"status\": \"ASSIGNED\",\n \"createdAt\": \"1957-05-08T20:10:53.827Z\",\n \"updatedAt\": \"1953-09-20T01:34:52.326Z\"\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"message\": \"Data format is not valid\",\n \"error\": [\n {\n \"field\": \"status\",\n \"message\": \"Validation isIn on status failed\",\n \"validatorKey\": \"isIn\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"b968dee4-4362-4db3-9b35-de0cc3a6f58e","name":"Delete a voucher","request":{"name":"Delete a voucher","description":{"content":"Delete an existing code.\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User\n\n**API key permission required:** `VOUCHERS_ITEM_DELETE`\n\n**User role permission required:** `assets_code_pool: delete`\n","type":"text/plain"},"url":{"path":["v4","vouchers","item",":voucherUuid"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"29392878-d43f-402e-8297-f63d465cf173","key":"voucherUuid","description":"(Required) UUID of the voucher"}]},"header":[{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.2"},{"key":"Accept","value":"application/json"}],"method":"DELETE","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"5197c58e-cf8e-4939-9bfa-4d1674af9f2a","name":"Voucher deleted","originalRequest":{"url":{"path":["v4","vouchers","item",":voucherUuid"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"29392878-d43f-402e-8297-f63d465cf173","key":"voucherUuid","description":"(Required) UUID of the voucher"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Accept","value":"application/json"},{"disabled":false,"description":"(Required) ","key":"Content-Type","value":"application/json"},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.2"},{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"message\": \"Delete object with success\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"95c958a6-7e93-4bf7-990b-cbbd43455919","name":"View voucher details by search key","request":{"name":"View voucher details by search key","description":{"content":"Retrieve all details of a single voucher. As the key (identifier), you can use the promotion's code or UUID.\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User\n\n**API key permission required:** `VOUCHERS_ITEM_BY_SEARCH_KEY_READ`\n\n**User role permission required:** `assets_code_pool: read`\n","type":"text/plain"},"url":{"path":["v4","vouchers","item",":searchKey",":searchValue"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"code","key":"searchKey","description":"(Required) The key type to search by"},{"disabled":false,"type":"any","value":"29392878-d43f-402e-8297-f63d465cf173","key":"searchValue","description":"(Required) The value to search for"}]},"header":[{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.2"},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"60e1568a-36f8-4235-946d-0308ff97c16b","name":"Details of a voucher","originalRequest":{"url":{"path":["v4","vouchers","item",":searchKey",":searchValue"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"code","key":"searchKey","description":"(Required) The key type to search by"},{"disabled":false,"type":"any","value":"29392878-d43f-402e-8297-f63d465cf173","key":"searchValue","description":"(Required) The value to search for"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Accept","value":"application/json"},{"disabled":false,"description":"(Required) ","key":"Content-Type","value":"application/json"},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.2"},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"data\": {\n \"poolUuid\": {\n \"value\": \"\"\n },\n \"clientUuid\": {\n \"value\": \"\"\n },\n \"clientId\": {\n \"value\": \"\"\n },\n \"code\": {\n \"value\": \"\"\n },\n \"expireIn\": {\n \"value\": \"\"\n },\n \"redeemAt\": {\n \"value\": \"\"\n },\n \"assignedAt\": {\n \"value\": \"\"\n },\n \"status\": {\n \"value\": \"\"\n },\n \"createdAt\": {\n \"value\": \"\"\n },\n \"updatedAt\": {\n \"value\": \"\"\n }\n }\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"47829580-0482-4359-a2ee-d913c2a342de","name":"Assign a voucher to a Profile","request":{"name":"Assign a voucher to a Profile","description":{"content":"Assign a code to a Profile and retrieve it. Every time this method is used, a different code is assigned.\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User\n\n**API key permission required:** `VOUCHERS_ITEM_ASSIGN_FOR_CLIENT_CREATE`\n\n**User role permission required:** `assets_code_pool: create`\n","type":"text/plain"},"url":{"path":["v4","vouchers","item","assign-for-client"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.2"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"poolUuid\": \"faec32b0-c343-4362-ba32-c6148c649da4\",\n \"clientUuid\": \"07243772-008a-42e1-ba37-c3807cebde8f\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"ebd6022a-d661-4d2e-877e-97f5aada1d78","name":"Voucher assigned","originalRequest":{"url":{"path":["v4","vouchers","item","assign-for-client"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Accept","value":"application/json"},{"disabled":false,"description":"(Required) ","key":"Content-Type","value":"application/json"},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.2"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"poolUuid\": \"faec32b0-c343-4362-ba32-c6148c649da4\",\n \"clientUuid\": \"07243772-008a-42e1-ba37-c3807cebde8f\"\n}","options":{"raw":{"language":"json"}}}},"status":"Created","code":201,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"message\": \"Code assigned with success\",\n \"data\": {\n \"code\": {\n \"value\": \"\"\n },\n \"expireIn\": {\n \"value\": \"\"\n },\n \"redeemAt\": {\n \"value\": \"\"\n },\n \"assignedAt\": {\n \"value\": \"\"\n },\n \"createdAt\": {\n \"value\": \"\"\n },\n \"updatedAt\": {\n \"value\": \"\"\n }\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"2c4f4736-c5d7-4c02-87eb-96121391be70","name":"Pool empty, expired, not found, or Profile not found","originalRequest":{"url":{"path":["v4","vouchers","item","assign-for-client"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Accept","value":"application/json"},{"disabled":false,"description":"(Required) ","key":"Content-Type","value":"application/json"},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.2"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"poolUuid\": \"faec32b0-c343-4362-ba32-c6148c649da4\",\n \"clientUuid\": \"07243772-008a-42e1-ba37-c3807cebde8f\"\n}","options":{"raw":{"language":"json"}}}},"status":"Requested Range Not Satisfiable","code":416,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"message\": \"Pool does not exist or expired\",\n \"error\": {\n \"message\": \"Pool does not exist or expired\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"7b4fab1f-a5ff-4291-832b-9cee0c5ecc72","name":"Get vouchers assigned to a Profile","request":{"name":"Get vouchers assigned to a Profile","description":{"content":"Get all codes assigned to a Profile.\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User\n\n**API key permission required:** `VOUCHERS_ITEM_ASSIGN_FOR_CLIENT_READ`\n\n**User role permission required:** `assets_code_pool: read`\n","type":"text/plain"},"url":{"path":["v4","vouchers","item","get-assigned-for-client",":clientUuid"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"e9e6840b-b9d4-4c7b-8191-9c4f9e751c76","key":"clientUuid","description":"(Required) UUID of the Profile"}]},"header":[{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.2"},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"27381bf6-1389-4801-88f1-ad92622bfab7","name":"An array of vouchers","originalRequest":{"url":{"path":["v4","vouchers","item","get-assigned-for-client",":clientUuid"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"e9e6840b-b9d4-4c7b-8191-9c4f9e751c76","key":"clientUuid","description":"(Required) UUID of the Profile"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Accept","value":"application/json"},{"disabled":false,"description":"(Required) ","key":"Content-Type","value":"application/json"},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.2"},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"data\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"3a112da4-47dc-4d9c-891d-58aad9390089","name":"Get or assign and get voucher as Workspace","request":{"name":"Get or assign and get voucher as Workspace","description":{"content":"Retrieve the code assigned to a profile. If no code was assigned earlier, the method assigns one.\n\n\nFor each profile, the same code is retrieved every time. This can be used, for example, to retrieve unique codes used to identify a profile.\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User\n\n**API key permission required:** `VOUCHERS_ITEM_ASSIGN_FOR_CLIENT_CREATE`\n\n**User role permission required:** `assets_code_pool: create`\n","type":"text/plain"},"url":{"path":["v4","vouchers","item","get-or-assign-for-client"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.2"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"poolUuid\": \"faec32b0-c343-4362-ba32-c6148c649da4\",\n \"clientUuid\": \"07243772-008a-42e1-ba37-c3807cebde8f\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"e81c9e7c-3d89-4241-90f2-b76e4a7b0c4d","name":"Details of a voucher","originalRequest":{"url":{"path":["v4","vouchers","item","get-or-assign-for-client"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Accept","value":"application/json"},{"disabled":false,"description":"(Required) ","key":"Content-Type","value":"application/json"},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.2"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"poolUuid\": \"faec32b0-c343-4362-ba32-c6148c649da4\",\n \"clientUuid\": \"07243772-008a-42e1-ba37-c3807cebde8f\"\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"data\": {\n \"code\": {\n \"value\": \"\"\n },\n \"expireIn\": {\n \"value\": \"\"\n },\n \"redeemAt\": {\n \"value\": \"\"\n },\n \"assignedAt\": {\n \"value\": \"\"\n },\n \"createdAt\": {\n \"value\": \"\"\n },\n \"updatedAt\": {\n \"value\": \"\"\n }\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"18b3d9bb-4bc2-4a99-9d6c-ac60371b574c","name":"Pool empty, expired, not found, or Profile not found","originalRequest":{"url":{"path":["v4","vouchers","item","get-or-assign-for-client"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Accept","value":"application/json"},{"disabled":false,"description":"(Required) ","key":"Content-Type","value":"application/json"},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.2"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"poolUuid\": \"faec32b0-c343-4362-ba32-c6148c649da4\",\n \"clientUuid\": \"07243772-008a-42e1-ba37-c3807cebde8f\"\n}","options":{"raw":{"language":"json"}}}},"status":"Requested Range Not Satisfiable","code":416,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"message\": \"Pool does not exist or expired\",\n \"error\": {\n \"message\": \"Pool does not exist or expired\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"043b372b-1e9d-4f29-b516-8b3e93424e2b","name":"Get vouchers assigned to a Profile by identifier","request":{"name":"Get vouchers assigned to a Profile by identifier","description":{"content":"Get all codes assigned to a Profile.\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User\n\n**API key permission required:** `VOUCHERS_ITEM_ASSIGN_FOR_CLIENT_READ`\n\n**User role permission required:** `assets_code_pool: read`\n","type":"text/plain"},"url":{"path":["v4","vouchers","item","get-assigned-for-client","by-identifier"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"clientIdentifierName","value":"custom_identify","description":"(Required) The Profile identifier to use for the request."},{"disabled":false,"key":"clientIdentifierValue","value":"custom_identify_123456","description":"(Required) The value of the selected profile identifier"}],"variable":[]},"header":[{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.2"},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"bcfa1f83-4128-484e-97f0-eab49cf5325e","name":"An array of vouchers","originalRequest":{"url":{"path":["v4","vouchers","item","get-assigned-for-client","by-identifier"],"host":["{{baseUrl}}"],"query":[{"key":"clientIdentifierName","value":"custom_identify"},{"key":"clientIdentifierValue","value":"custom_identify_123456"}],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Accept","value":"application/json"},{"disabled":false,"description":"(Required) ","key":"Content-Type","value":"application/json"},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.2"},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"data\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"d3baa215-d5db-408f-a78e-96dc8f3d12af","name":"Bad Request","originalRequest":{"url":{"path":["v4","vouchers","item","get-assigned-for-client","by-identifier"],"host":["{{baseUrl}}"],"query":[{"key":"clientIdentifierName","value":"custom_identify"},{"key":"clientIdentifierValue","value":"custom_identify_123456"}],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Accept","value":"application/json"},{"disabled":false,"description":"(Required) ","key":"Content-Type","value":"application/json"},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.2"},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"message\": \"Query params are not valid\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"4b35e45c-ddcf-4076-9c36-05f36200aedd","name":"Invalid parameter","originalRequest":{"url":{"path":["v4","vouchers","item","get-assigned-for-client","by-identifier"],"host":["{{baseUrl}}"],"query":[{"key":"clientIdentifierName","value":"custom_identify"},{"key":"clientIdentifierValue","value":"custom_identify_123456"}],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Accept","value":"application/json"},{"disabled":false,"description":"(Required) ","key":"Content-Type","value":"application/json"},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.2"},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Requested Range Not Satisfiable","code":416,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"message\": \"Invalid parameter\",\n \"error\": {\n \"message\": \"Invalid parameter\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"8d8c13ab-e4bb-404e-93d0-9f060063d275","name":"Get or assign and get voucher as Workspace","request":{"name":"Get or assign and get voucher as Workspace","description":{"content":"Retrieve the code assigned to a profile. If no code was assigned earlier, the method assigns one (it uses the provided profile identifier).\n\nFor each profile, the same code is retrieved every time. This can be used, for example, to retrieve unique codes used to identify a profile.\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User\n\n**API key permission required:** `VOUCHERS_ITEM_ASSIGN_FOR_CLIENT_CREATE`\n\n**User role permission required:** `assets_code_pool: create`\n","type":"text/plain"},"url":{"path":["v4","vouchers","item","get-or-assign-for-client","by-identifier"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"clientIdentifierName","value":"custom_identify","description":"(Required) The Profile identifier to use for the request."}],"variable":[]},"header":[{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.2"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"poolUuid\": \"faec32b0-c343-4362-ba32-c6148c649da4\",\n \"clientIdentifierValue\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"b55203f6-4721-4946-9c48-6a6d62571ce5","name":"Details of a voucher","originalRequest":{"url":{"path":["v4","vouchers","item","get-or-assign-for-client","by-identifier"],"host":["{{baseUrl}}"],"query":[{"key":"clientIdentifierName","value":"custom_identify"}],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Accept","value":"application/json"},{"disabled":false,"description":"(Required) ","key":"Content-Type","value":"application/json"},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.2"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"poolUuid\": \"faec32b0-c343-4362-ba32-c6148c649da4\",\n \"clientIdentifierValue\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"data\": {\n \"code\": {\n \"value\": \"\"\n },\n \"expireIn\": {\n \"value\": \"\"\n },\n \"redeemAt\": {\n \"value\": \"\"\n },\n \"assignedAt\": {\n \"value\": \"\"\n },\n \"createdAt\": {\n \"value\": \"\"\n },\n \"updatedAt\": {\n \"value\": \"\"\n }\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"4b71be6d-e7d7-45e5-b9db-a1b9e88f0b4e","name":"Pool empty, expired, not found, or Profile not found","originalRequest":{"url":{"path":["v4","vouchers","item","get-or-assign-for-client","by-identifier"],"host":["{{baseUrl}}"],"query":[{"key":"clientIdentifierName","value":"custom_identify"}],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Accept","value":"application/json"},{"disabled":false,"description":"(Required) ","key":"Content-Type","value":"application/json"},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.2"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"poolUuid\": \"faec32b0-c343-4362-ba32-c6148c649da4\",\n \"clientIdentifierValue\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Requested Range Not Satisfiable","code":416,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"message\": \"Pool does not exist or expired\",\n \"error\": {\n \"message\": \"Pool does not exist or expired\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"4a7bbb9d-0eef-4b76-bd70-e0dc7590b8c8","name":"Assign and get voucher as Workspace","request":{"name":"Assign and get voucher as Workspace","description":{"content":"Assign a code to a profile and retrieve it. Every time this method is used, a different code is assigned.\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User\n\n**API key permission required:** `VOUCHERS_ITEM_ASSIGN_FOR_CLIENT_CREATE`\n\n**User role permission required:** `assets_code_pool: create`\n","type":"text/plain"},"url":{"path":["v4","vouchers","item","assign-for-client","by-identifier"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"clientIdentifierName","value":"custom_identify","description":"(Required) The Profile identifier to use for the request."}],"variable":[]},"header":[{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.2"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"poolUuid\": \"faec32b0-c343-4362-ba32-c6148c649da4\",\n \"clientIdentifierValue\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"ca774bf4-1e0b-4607-bd7d-b157c93a6329","name":"Voucher assigned","originalRequest":{"url":{"path":["v4","vouchers","item","assign-for-client","by-identifier"],"host":["{{baseUrl}}"],"query":[{"key":"clientIdentifierName","value":"custom_identify"}],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Accept","value":"application/json"},{"disabled":false,"description":"(Required) ","key":"Content-Type","value":"application/json"},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.2"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"poolUuid\": \"faec32b0-c343-4362-ba32-c6148c649da4\",\n \"clientIdentifierValue\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Created","code":201,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"data\": {\n \"code\": {\n \"value\": \"\"\n },\n \"expireIn\": {\n \"value\": \"\"\n },\n \"redeemAt\": {\n \"value\": \"\"\n },\n \"assignedAt\": {\n \"value\": \"\"\n },\n \"createdAt\": {\n \"value\": \"\"\n },\n \"updatedAt\": {\n \"value\": \"\"\n }\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"8f42dfb2-5986-4da0-a389-16b9cce4c9e1","name":"Pool empty, expired, not found, or Profile not found","originalRequest":{"url":{"path":["v4","vouchers","item","assign-for-client","by-identifier"],"host":["{{baseUrl}}"],"query":[{"key":"clientIdentifierName","value":"custom_identify"}],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Accept","value":"application/json"},{"disabled":false,"description":"(Required) ","key":"Content-Type","value":"application/json"},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.2"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"poolUuid\": \"faec32b0-c343-4362-ba32-c6148c649da4\",\n \"clientIdentifierValue\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Requested Range Not Satisfiable","code":416,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"message\": \"Pool does not exist or expired\",\n \"error\": {\n \"message\": \"Pool does not exist or expired\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"880d9c84-1dca-4a5d-9331-6e5f4cbca5d8","name":"Redeem a voucher","request":{"name":"Redeem a voucher","description":{"content":"Redeem a code.\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User\n\n**API key permission required:** `VOUCHERS_ITEM_REDEEM_CREATE`\n\n**User role permission required:** `assets_code_pool: create`\n","type":"text/plain"},"url":{"path":["v4","vouchers","item","redeem"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.2"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"code\": \"code123\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"e4192a19-6963-44b7-8a0c-0e1746c95bca","name":"Voucher redeemed","originalRequest":{"url":{"path":["v4","vouchers","item","redeem"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Accept","value":"application/json"},{"disabled":false,"description":"(Required) ","key":"Content-Type","value":"application/json"},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.2"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"code\": \"code123\"\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"message\": \"Code redeemed with success\",\n \"data\": {\n \"poolUuid\": {\n \"value\": \"\"\n },\n \"clientUuid\": {\n \"value\": \"\"\n },\n \"clientId\": {\n \"value\": \"\"\n },\n \"code\": {\n \"value\": \"\"\n },\n \"expireIn\": {\n \"value\": \"\"\n },\n \"redeemAt\": {\n \"value\": \"\"\n },\n \"assignedAt\": {\n \"value\": \"\"\n },\n \"status\": {\n \"value\": \"\"\n },\n \"createdAt\": {\n \"value\": \"\"\n },\n \"updatedAt\": {\n \"value\": \"\"\n }\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"05f9229e-130d-4e37-a860-2aefc3f01a23","name":"Data format is not valid.","originalRequest":{"url":{"path":["v4","vouchers","item","redeem"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Accept","value":"application/json"},{"disabled":false,"description":"(Required) ","key":"Content-Type","value":"application/json"},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.2"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"code\": \"code123\"\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"message\": \"Param code is required\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"9a56b6a5-450f-48da-99ad-1b1eb236a644","name":"List pools","request":{"name":"List pools","description":{"content":"Retrieve a list of voucher pools.\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User\n\n**API key permission required:** `VOUCHERS_POOL_LIST_READ`\n\n**User role permission required:** `assets_code_pool: read`\n","type":"text/plain"},"url":{"path":["v4","vouchers","pool","list"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"includeMeta","value":"false","description":"\nWhen `true`, pagination metadata is included in the response body.\n\nWhen `false`, the data is included in the response headers:\n\n- Link: links to neighbors, first, and last pages in pagination.\n\n- X-Pagination-Total-Count: total number of items on all pages\n\n- X-Pagination-Total-Pages: total number of pages\n\n- X-Pagination-Page: current page\n\n- X-Pagination-Limit: maximum number of items on a page\n"},{"disabled":false,"key":"orderFieldName","value":"createdAt","description":"Name of the parameter used for sorting. If you include this parameter, you **must** also send the `order` parameter."},{"disabled":false,"key":"order","value":"asc","description":"Sorting order. If you include this parameter, you **must** also send the `orderFieldName` parameter."},{"disabled":false,"key":"query","value":"string","description":"Filter by phrase in pool name."},{"disabled":false,"key":"limit","value":"100","description":"The number of items to return per page"},{"disabled":false,"key":"page","value":"4","description":"Page number to return for pagination. The first page has the index `1`."}],"variable":[]},"header":[{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.2"},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"8bacb927-59a1-4117-b13f-a2d311ee957a","name":"An array of voucher pools","originalRequest":{"url":{"path":["v4","vouchers","pool","list"],"host":["{{baseUrl}}"],"query":[{"key":"includeMeta","value":"false"},{"key":"orderFieldName","value":"createdAt"},{"key":"order","value":"asc"},{"key":"query","value":"string"},{"key":"limit","value":"100"},{"key":"page","value":"4"}],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Accept","value":"application/json"},{"disabled":false,"description":"(Required) ","key":"Content-Type","value":"application/json"},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.2"},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"data\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"meta\": {\n \"link\": {\n \"value\": \"\"\n },\n \"totalCount\": {\n \"value\": \"\"\n },\n \"totalPages\": {\n \"value\": \"\"\n },\n \"page\": {\n \"value\": \"\"\n },\n \"limit\": {\n \"value\": \"\"\n },\n \"code\": {\n \"value\": \"\"\n }\n }\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"3482f52c-a936-40d0-8fbd-a556e1d7c5a3","name":"Create a voucher pool","request":{"name":"Create a voucher pool","description":{"content":"Create a pool for voucher storage.\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User\n\n**API key permission required:** `VOUCHERS_POOL_CREATE`\n\n**User role permission required:** `assets_code_pool: create`\n","type":"text/plain"},"url":{"path":["v4","vouchers","pool"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.2"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"name\": \"string\",\n \"expireIn\": \"2005-10-08T13:21:33.930Z\",\n \"description\": \"string\",\n \"startAt\": \"1990-09-01T05:44:14.987Z\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"c951656a-7cb4-470e-80b0-c63335ebff76","name":"Pool created","originalRequest":{"url":{"path":["v4","vouchers","pool"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Accept","value":"application/json"},{"disabled":false,"description":"(Required) ","key":"Content-Type","value":"application/json"},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.2"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"name\": \"string\",\n \"expireIn\": \"2005-10-08T13:21:33.930Z\",\n \"description\": \"string\",\n \"startAt\": \"1990-09-01T05:44:14.987Z\"\n}","options":{"raw":{"language":"json"}}}},"status":"Created","code":201,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"message\": \"Create object with success\",\n \"data\": {\n \"uuid\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n },\n \"startAt\": {\n \"value\": \"\"\n },\n \"expireIn\": {\n \"value\": \"\"\n },\n \"userId\": {\n \"value\": \"\"\n },\n \"assignedCount\": {\n \"value\": \"\"\n },\n \"activeCount\": {\n \"value\": \"\"\n },\n \"countAt\": {\n \"value\": \"\"\n }\n }\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"a0276c77-04a6-486d-b062-d66f8a77d8c1","name":"Get pool details","request":{"name":"Get pool details","description":{"content":"Retrieve the details of a single voucher pool.\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User\n\n**API key permission required:** `VOUCHERS_POOL_READ`\n\n**User role permission required:** `assets_code_pool: read`\n","type":"text/plain"},"url":{"path":["v4","vouchers","pool",":poolUuid"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"8465c240-d38e-42f8-af29-b9fa1ed05115","key":"poolUuid","description":"(Required) UUID of the voucher pool"}]},"header":[{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.2"},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"d67eb3ef-0242-49ae-88e9-6d90c4c8e1e9","name":"Details of a voucher pool","originalRequest":{"url":{"path":["v4","vouchers","pool",":poolUuid"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"8465c240-d38e-42f8-af29-b9fa1ed05115","key":"poolUuid","description":"(Required) UUID of the voucher pool"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Accept","value":"application/json"},{"disabled":false,"description":"(Required) ","key":"Content-Type","value":"application/json"},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.2"},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"data\": {\n \"uuid\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n },\n \"startAt\": {\n \"value\": \"\"\n },\n \"expireIn\": {\n \"value\": \"\"\n },\n \"userId\": {\n \"value\": \"\"\n },\n \"assignedCount\": {\n \"value\": \"\"\n },\n \"activeCount\": {\n \"value\": \"\"\n },\n \"countAt\": {\n \"value\": \"\"\n }\n }\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"87181a3f-77f0-45b6-8e79-893d86b13225","name":"Update a voucher pool","request":{"name":"Update a voucher pool","description":{"content":"Update an existing pool of vouchers. If you don't want to change a parameter, omit it entirely.\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User\n\n**API key permission required:** `VOUCHERS_POOL_UPDATE`\n\n**User role permission required:** `assets_code_pool: update`\n","type":"text/plain"},"url":{"path":["v4","vouchers","pool",":poolUuid"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"8465c240-d38e-42f8-af29-b9fa1ed05115","key":"poolUuid","description":"(Required) UUID of the voucher pool"}]},"header":[{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.2"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PUT","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"name\": \"string\",\n \"description\": \"string\",\n \"startAt\": \"1991-07-08T05:24:09.638Z\",\n \"expireIn\": \"1974-09-24T11:26:22.576Z\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"b377c335-a8db-4fbb-a291-e8171d264f60","name":"Voucher pool","originalRequest":{"url":{"path":["v4","vouchers","pool",":poolUuid"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"8465c240-d38e-42f8-af29-b9fa1ed05115","key":"poolUuid","description":"(Required) UUID of the voucher pool"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Accept","value":"application/json"},{"disabled":false,"description":"(Required) ","key":"Content-Type","value":"application/json"},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.2"},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"{\n \"name\": \"string\",\n \"description\": \"string\",\n \"startAt\": \"1991-07-08T05:24:09.638Z\",\n \"expireIn\": \"1974-09-24T11:26:22.576Z\"\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"message\": \"Update object with success\",\n \"data\": {\n \"uuid\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n },\n \"startAt\": {\n \"value\": \"\"\n },\n \"expireIn\": {\n \"value\": \"\"\n },\n \"userId\": {\n \"value\": \"\"\n },\n \"assignedCount\": {\n \"value\": \"\"\n },\n \"activeCount\": {\n \"value\": \"\"\n },\n \"countAt\": {\n \"value\": \"\"\n }\n }\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"f6b2b4d8-5afd-4575-b65e-281249efd500","name":"Delete a voucher pool","request":{"name":"Delete a voucher pool","description":{"content":"Delete an existing pool of vouchers.\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User\n\n**API key permission required:** `VOUCHERS_POOL_DELETE`\n\n**User role permission required:** `assets_code_pool: delete`\n","type":"text/plain"},"url":{"path":["v4","vouchers","pool",":poolUuid"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"8465c240-d38e-42f8-af29-b9fa1ed05115","key":"poolUuid","description":"(Required) UUID of the voucher pool"}]},"header":[{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.2"},{"key":"Accept","value":"application/json"}],"method":"DELETE","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"80be78b6-c885-4bed-a68e-aaeeb28aa46c","name":"Voucher pool deleted","originalRequest":{"url":{"path":["v4","vouchers","pool",":poolUuid"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"8465c240-d38e-42f8-af29-b9fa1ed05115","key":"poolUuid","description":"(Required) UUID of the voucher pool"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Accept","value":"application/json"},{"disabled":false,"description":"(Required) ","key":"Content-Type","value":"application/json"},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.2"},{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"message\": \"Delete object with success\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"0ff2c8b4-5fca-443d-8cd8-9172dbba44d2","name":"List vouchers from a pool","request":{"name":"List vouchers from a pool","description":{"content":"Retrieve vouchers from a single pool.\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User\n\n**API key permission required:** `VOUCHERS_ITEM_LIST_BY_POOL_READ`\n\n**User role permission required:** `assets_code_pool: read`\n","type":"text/plain"},"url":{"path":["v4","vouchers","item","list",":poolUuid"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"limit","value":"100","description":"The number of items to return per page"},{"disabled":false,"key":"page","value":"4","description":"Page number to return for pagination. The first page has the index `1`."},{"disabled":false,"key":"includeMeta","value":"false","description":"\nWhen `true`, pagination metadata is included in the response body.\n\nWhen `false`, the data is included in the response headers:\n\n- Link: links to neighbors, first, and last pages in pagination.\n\n- X-Pagination-Total-Count: total number of items on all pages\n\n- X-Pagination-Total-Pages: total number of pages\n\n- X-Pagination-Page: current page\n\n- X-Pagination-Limit: maximum number of items on a page\n"}],"variable":[{"disabled":false,"type":"any","value":"8465c240-d38e-42f8-af29-b9fa1ed05115","key":"poolUuid","description":"(Required) UUID of the voucher pool"}]},"header":[{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.2"},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"35431af9-ed2c-40e2-b879-6560e68b00f6","name":"An array of vouchers in the pool","originalRequest":{"url":{"path":["v4","vouchers","item","list",":poolUuid"],"host":["{{baseUrl}}"],"query":[{"key":"limit","value":"100"},{"key":"page","value":"4"},{"key":"includeMeta","value":"false"}],"variable":[{"disabled":false,"type":"any","value":"8465c240-d38e-42f8-af29-b9fa1ed05115","key":"poolUuid","description":"(Required) UUID of the voucher pool"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Accept","value":"application/json"},{"disabled":false,"description":"(Required) ","key":"Content-Type","value":"application/json"},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.2"},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"data\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"meta\": {\n \"link\": {\n \"value\": \"\"\n },\n \"totalCount\": {\n \"value\": \"\"\n },\n \"totalPages\": {\n \"value\": \"\"\n },\n \"page\": {\n \"value\": \"\"\n },\n \"limit\": {\n \"value\": \"\"\n },\n \"code\": {\n \"value\": \"\"\n }\n }\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"3f91974b-b108-4044-8782-4e9bbd28fa41","name":"Delete vouchers by poolUuid","request":{"name":"Delete vouchers by poolUuid","description":{"content":"Delete vouchers assigned to pool.\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User\n\n**API key permission required:** `VOUCHERS_ITEM_BY_POOL_DELETE`\n\n**User role permission required:** `assets_code_pool: delete`\n","type":"text/plain"},"url":{"path":["v4","vouchers","item","list",":poolUuid"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"8465c240-d38e-42f8-af29-b9fa1ed05115","key":"poolUuid","description":"(Required) UUID of the voucher pool"}]},"header":[{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.2"},{"key":"Accept","value":"application/json"}],"method":"DELETE","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"d36ce403-d4db-43c3-b270-e0843349a8a1","name":"Vouchers deleted","originalRequest":{"url":{"path":["v4","vouchers","item","list",":poolUuid"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"8465c240-d38e-42f8-af29-b9fa1ed05115","key":"poolUuid","description":"(Required) UUID of the voucher pool"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Accept","value":"application/json"},{"disabled":false,"description":"(Required) ","key":"Content-Type","value":"application/json"},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.2"},{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"message\": \"Delete object with success\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"2694a0f6-cc9b-4b80-afe8-00cc0e0fe510","name":"Count vouchers","request":{"name":"Count vouchers","description":{"content":"Count (re-calculate) vouchers in a pool, group the results by status.\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User\n\n**API key permission required:** `VOUCHERS_ITEM_LIST_BY_POOL_READ`\n\n**User role permission required:** `assets_code_pool: read`\n","type":"text/plain"},"url":{"path":["v4","vouchers","item","count",":poolUuid"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"8465c240-d38e-42f8-af29-b9fa1ed05115","key":"poolUuid","description":"(Required) UUID of the voucher pool"}]},"header":[{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.2"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"4cc0af6b-5ecc-4016-97b9-6f6b162e9281","name":"Set of counters","originalRequest":{"url":{"path":["v4","vouchers","item","count",":poolUuid"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"8465c240-d38e-42f8-af29-b9fa1ed05115","key":"poolUuid","description":"(Required) UUID of the voucher pool"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"disabled":false,"description":"(Required) ","key":"Accept","value":"application/json"},{"disabled":false,"description":"(Required) ","key":"Content-Type","value":"application/json"},{"disabled":false,"description":"(Required) ","key":"Api-Version","value":"4.2"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"data\": {\n \"assignedCount\": 25,\n \"activeCount\": 100,\n \"countAt\": \"2026-09-17T09:12:44.318Z\",\n \"poolName\": \"Summer campaign vouchers\",\n \"poolUuid\": \"8465c240-d38e-42f8-af29-b9fa1ed05115\",\n \"remainingCount\": 75,\n \"remainingPercentage\": 75\n }\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}],"event":[]},{"id":"85eeef2b-2816-47d7-8817-79f071bb6fa4","name":"Handbills","description":{"content":"","type":"text/plain"},"item":[{"id":"e6182162-2558-4379-a742-09ada3790f00","name":"Get all handbill configurations","request":{"name":"Get all handbill configurations","description":{"content":"Retrieve a list of all handbill configurations available in the current Workspace.\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User\n\n**API key permission required:** `PROMOTIONS_HANDBILL_READ`\n\n**User role permission required:** `campaigns_personalised_promotions: read`\n","type":"text/plain"},"url":{"path":["v4","promotions","handbill"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"limit","value":"100","description":"The number of items to return per page"},{"disabled":false,"key":"page","value":"4","description":"Page number to return for pagination. The first page has the index `1`."},{"disabled":false,"key":"sort","value":"createdAt,desc","description":"The sorting order of the response.\n\n\nYou can sort by any combination of the following attributes:\n\n* `createdAt`: time when the configuration was created\n\n* `updatedAt`: time when the configuration was last updated\n\n\nYou can sort ascending (default) or descending by adding `asc` or `desc` after the parameter, separated by a comma.\"\n"},{"disabled":false,"key":"includeMeta","value":"false","description":"\nWhen `true`, pagination metadata is included in the response body.\n\nWhen `false`, the data is included in the response headers:\n\n- Link: links to neighbors, first, and last pages in pagination.\n\n- X-Pagination-Total-Count: total number of items on all pages\n\n- X-Pagination-Total-Pages: total number of pages\n\n- X-Pagination-Page: current page\n\n- X-Pagination-Limit: maximum number of items on a page\n"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"88bd209c-438b-49c1-b1eb-dd3aa6849338","name":"List of handbill configurations","originalRequest":{"url":{"path":["v4","promotions","handbill"],"host":["{{baseUrl}}"],"query":[{"key":"limit","value":"100"},{"key":"page","value":"4"},{"key":"sort","value":"createdAt,desc"},{"key":"includeMeta","value":"false"}],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"data\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"meta\": {\n \"code\": {\n \"value\": \"\"\n },\n \"limit\": {\n \"value\": \"\"\n },\n \"link\": {\n \"value\": \"\"\n },\n \"page\": {\n \"value\": \"\"\n },\n \"totalCount\": {\n \"value\": \"\"\n },\n \"totalPages\": {\n \"value\": \"\"\n }\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"8f7b52b2-2268-4216-a9c7-cea67148fce7","name":"Unauthorized","originalRequest":{"url":{"path":["v4","promotions","handbill"],"host":["{{baseUrl}}"],"query":[{"key":"limit","value":"100"},{"key":"page","value":"4"},{"key":"sort","value":"createdAt,desc"},{"key":"includeMeta","value":"false"}],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"status\": 7751,\n \"error\": \"string\",\n \"message\": \"string\",\n \"timestamp\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"725969e5-8abf-47f3-b84f-800111ea3dde","name":"Forbidden","originalRequest":{"url":{"path":["v4","promotions","handbill"],"host":["{{baseUrl}}"],"query":[{"key":"limit","value":"100"},{"key":"page","value":"4"},{"key":"sort","value":"createdAt,desc"},{"key":"includeMeta","value":"false"}],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"status\": 7751,\n \"error\": \"string\",\n \"message\": \"string\",\n \"timestamp\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"ac8b5dd2-111b-4be8-9652-8b2073427ef7","name":"General error","originalRequest":{"url":{"path":["v4","promotions","handbill"],"host":["{{baseUrl}}"],"query":[{"key":"limit","value":"100"},{"key":"page","value":"4"},{"key":"sort","value":"createdAt,desc"},{"key":"includeMeta","value":"false"}],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"GET","body":{}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"e7a90c0d-bdc3-47fa-8fc0-73dc8f3c4cd6","name":"Create handbill configuration","request":{"name":"Create handbill configuration","description":{"content":"Create a new handbill configuration for use in handbill-type promotions.\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User\n\n**API key permission required:** `PROMOTIONS_HANDBILL_CREATE`\n\n**User role permission required:** `campaigns_personalised_promotions: create`\n","type":"text/plain"},"url":{"path":["v4","promotions","handbill"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"channel\": \"CHECK_OUT\",\n \"status\": \"ACTIVE\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"controlGroup\": {\n \"name\": {\n \"value\": \"\"\n },\n \"percentage\": {\n \"value\": \"\"\n }\n },\n \"variants\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"74039d78-b42b-4cf4-a414-81af99a3cc6e","name":"Configuration created","originalRequest":{"url":{"path":["v4","promotions","handbill"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"channel\": \"CHECK_OUT\",\n \"status\": \"ACTIVE\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"controlGroup\": {\n \"name\": {\n \"value\": \"\"\n },\n \"percentage\": {\n \"value\": \"\"\n }\n },\n \"variants\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"Created","code":201,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"data\": {\n \"uuid\": {\n \"value\": \"\"\n },\n \"createdAt\": {\n \"value\": \"\"\n },\n \"updatedAt\": {\n \"value\": \"\"\n },\n \"channel\": {\n \"value\": \"\"\n },\n \"status\": {\n \"value\": \"\"\n },\n \"userId\": {\n \"value\": \"\"\n },\n \"origin\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n },\n \"controlGroup\": {\n \"value\": \"\"\n },\n \"variants\": {\n \"value\": \"\"\n }\n },\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"91fa97af-33a4-4878-b8fa-057122f5d85a","name":"JSON is null","originalRequest":{"url":{"path":["v4","promotions","handbill"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"channel\": \"CHECK_OUT\",\n \"status\": \"ACTIVE\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"controlGroup\": {\n \"name\": {\n \"value\": \"\"\n },\n \"percentage\": {\n \"value\": \"\"\n }\n },\n \"variants\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"message\": \"Invalid parameter\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"8ac49618-ef96-4339-8da5-169edd26045c","name":"Unauthorized","originalRequest":{"url":{"path":["v4","promotions","handbill"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"channel\": \"CHECK_OUT\",\n \"status\": \"ACTIVE\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"controlGroup\": {\n \"name\": {\n \"value\": \"\"\n },\n \"percentage\": {\n \"value\": \"\"\n }\n },\n \"variants\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"status\": 7751,\n \"error\": \"string\",\n \"message\": \"string\",\n \"timestamp\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"3c4ba697-a432-4351-9135-44de8bb8b68a","name":"Forbidden","originalRequest":{"url":{"path":["v4","promotions","handbill"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"channel\": \"CHECK_OUT\",\n \"status\": \"ACTIVE\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"controlGroup\": {\n \"name\": {\n \"value\": \"\"\n },\n \"percentage\": {\n \"value\": \"\"\n }\n },\n \"variants\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"status\": 7751,\n \"error\": \"string\",\n \"message\": \"string\",\n \"timestamp\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"2290d4eb-bb7b-4f98-aa19-10b66ab497d4","name":"Request payload failed schema validation, for example: missing required value, wrong data type","originalRequest":{"url":{"path":["v4","promotions","handbill"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"channel\": \"CHECK_OUT\",\n \"status\": \"ACTIVE\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"controlGroup\": {\n \"name\": {\n \"value\": \"\"\n },\n \"percentage\": {\n \"value\": \"\"\n }\n },\n \"variants\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"statusCode\": 422,\n \"error\": \"Unprocessable Entity\",\n \"message\": \"validation failed\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"c3389c25-c6ad-4ea3-b785-a840865d5a43","name":"Get handbill configuration","request":{"name":"Get handbill configuration","description":{"content":"Retrieve the details of a single handbill configuration.\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User\n\n**API key permission required:** `PROMOTIONS_HANDBILL_READ`\n\n**User role permission required:** `campaigns_personalised_promotions: read`\n","type":"text/plain"},"url":{"path":["v4","promotions","handbill",":handbillUuid"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"handbillUuid","description":"(Required) UUID of the handbill configuration"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"d6a81052-ae6f-42bb-90f2-9e435a599b45","name":"Handbill configuration","originalRequest":{"url":{"path":["v4","promotions","handbill",":handbillUuid"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"handbillUuid","description":"(Required) UUID of the handbill configuration"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"data\": {\n \"uuid\": {\n \"value\": \"\"\n },\n \"createdAt\": {\n \"value\": \"\"\n },\n \"updatedAt\": {\n \"value\": \"\"\n },\n \"channel\": {\n \"value\": \"\"\n },\n \"status\": {\n \"value\": \"\"\n },\n \"userId\": {\n \"value\": \"\"\n },\n \"origin\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n },\n \"controlGroup\": {\n \"value\": \"\"\n },\n \"variants\": {\n \"value\": \"\"\n }\n },\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"922de229-b289-4585-82a7-5c980a3d7e4d","name":"Request body invalid/malformed/missing elements","originalRequest":{"url":{"path":["v4","promotions","handbill",":handbillUuid"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"handbillUuid","description":"(Required) UUID of the handbill configuration"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"message\": {\n \"value\": \"\"\n },\n \"error\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"faec92a2-0400-4138-85d1-d33b29f5f409","name":"Unauthorized","originalRequest":{"url":{"path":["v4","promotions","handbill",":handbillUuid"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"handbillUuid","description":"(Required) UUID of the handbill configuration"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"status\": 7751,\n \"error\": \"string\",\n \"message\": \"string\",\n \"timestamp\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"e86b3025-d425-425a-90b1-fc4f283826ec","name":"Forbidden","originalRequest":{"url":{"path":["v4","promotions","handbill",":handbillUuid"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"handbillUuid","description":"(Required) UUID of the handbill configuration"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"status\": 7751,\n \"error\": \"string\",\n \"message\": \"string\",\n \"timestamp\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"cd77ca3d-21ef-4f30-b69e-3c7ffb536f55","name":"Update handbill configuration","request":{"name":"Update handbill configuration","description":{"content":"Update an existing handbill configuration.\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User\n\n**API key permission required:** `PROMOTIONS_HANDBILL_UPDATE`\n\n**User role permission required:** `campaigns_personalised_promotions: update`\n","type":"text/plain"},"url":{"path":["v4","promotions","handbill",":handbillUuid"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"handbillUuid","description":"(Required) UUID of the handbill configuration"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PATCH","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"channel\": \"CHECK_OUT\",\n \"status\": \"INACTIVE\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"controlGroup\": {\n \"name\": {\n \"value\": \"\"\n },\n \"percentage\": {\n \"value\": \"\"\n }\n },\n \"variants\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"8fc578fb-6a5a-41e5-a02e-97ece00351a5","name":"Configuration updated","originalRequest":{"url":{"path":["v4","promotions","handbill",":handbillUuid"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"handbillUuid","description":"(Required) UUID of the handbill configuration"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"{\n \"channel\": \"CHECK_OUT\",\n \"status\": \"INACTIVE\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"controlGroup\": {\n \"name\": {\n \"value\": \"\"\n },\n \"percentage\": {\n \"value\": \"\"\n }\n },\n \"variants\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"data\": {\n \"uuid\": {\n \"value\": \"\"\n },\n \"createdAt\": {\n \"value\": \"\"\n },\n \"updatedAt\": {\n \"value\": \"\"\n },\n \"channel\": {\n \"value\": \"\"\n },\n \"status\": {\n \"value\": \"\"\n },\n \"userId\": {\n \"value\": \"\"\n },\n \"origin\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n },\n \"controlGroup\": {\n \"value\": \"\"\n },\n \"variants\": {\n \"value\": \"\"\n }\n },\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"8ef9ef1a-3e80-416b-a9f9-d0c0881e4a30","name":"JSON is null","originalRequest":{"url":{"path":["v4","promotions","handbill",":handbillUuid"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"handbillUuid","description":"(Required) UUID of the handbill configuration"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"{\n \"channel\": \"CHECK_OUT\",\n \"status\": \"INACTIVE\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"controlGroup\": {\n \"name\": {\n \"value\": \"\"\n },\n \"percentage\": {\n \"value\": \"\"\n }\n },\n \"variants\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"message\": \"Invalid parameter\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"2d1dcfd6-6c6f-4a7d-9a07-944f553165d3","name":"Unauthorized","originalRequest":{"url":{"path":["v4","promotions","handbill",":handbillUuid"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"handbillUuid","description":"(Required) UUID of the handbill configuration"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"{\n \"channel\": \"CHECK_OUT\",\n \"status\": \"INACTIVE\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"controlGroup\": {\n \"name\": {\n \"value\": \"\"\n },\n \"percentage\": {\n \"value\": \"\"\n }\n },\n \"variants\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"status\": 7751,\n \"error\": \"string\",\n \"message\": \"string\",\n \"timestamp\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"3d06f5cd-e726-4d65-824f-317cf9eeda75","name":"Forbidden","originalRequest":{"url":{"path":["v4","promotions","handbill",":handbillUuid"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"handbillUuid","description":"(Required) UUID of the handbill configuration"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"{\n \"channel\": \"CHECK_OUT\",\n \"status\": \"INACTIVE\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"controlGroup\": {\n \"name\": {\n \"value\": \"\"\n },\n \"percentage\": {\n \"value\": \"\"\n }\n },\n \"variants\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"status\": 7751,\n \"error\": \"string\",\n \"message\": \"string\",\n \"timestamp\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"ad84496e-6c6e-42cd-8d4c-6f81d9afc5fa","name":"Request payload failed schema validation, for example: missing required value, wrong data type","originalRequest":{"url":{"path":["v4","promotions","handbill",":handbillUuid"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"handbillUuid","description":"(Required) UUID of the handbill configuration"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"{\n \"channel\": \"CHECK_OUT\",\n \"status\": \"INACTIVE\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"controlGroup\": {\n \"name\": {\n \"value\": \"\"\n },\n \"percentage\": {\n \"value\": \"\"\n }\n },\n \"variants\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"statusCode\": 422,\n \"error\": \"Unprocessable Entity\",\n \"message\": \"validation failed\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"4d9fb106-e061-4ced-944c-a2e49c589b0e","name":"Generate handbill for Profile","request":{"name":"Generate handbill for Profile","description":{"content":"Assign handbill promotions to a Profile. They can be randomized or suggested by the AI engine.\n\n**IMPORTANT**: \n- The endpoint is limited to 1000 requests per minute (per workspace).\n- The algorithm that selects promotions for assignment candidates applies all the following filters:\n - Promotions must be of the specified type, assigned to a handbill campaign, and with the `PUBLISH` status.\n - Promotions must be available for the entire duration of the handbill assignment, considering `startAt` and `expireAt` dates. For example, when generating assignments on May 1, 2024 at 9:00 a.m. that are expected to last 3 hours, the algorithm will consider promotions whose `startAt` date is equal to or earlier than May 1, 2024 9:00 a.m. and `expireAt` date is equal to or later than May 1, 2024 12:00 p.m. \n - Promotions can't currently be assigned within another handbill campaign.\n - Promotions must match the filter for the slot (if applicable). Promotions are handled by the `binoculars` service and identified by UUID.\n - Promotions are deduplicated. First they are sorted by priority, then the algorithm rejects promotions with at least one product that occurred earlier. In a special case, if a promotion with a high priority has an extensive catalog of products covering other promotions, it could exclude all promotions with a lower priority.\n - If `excludeByAvailableProducts` is set to `true`, the algorithm rejects promotions for items that are available as part of other promotions (regardless of their type)\n - After sorting promotions by priority, the algorithm rejects promotions for segments that occur after the 100th unique segment is encountered. (only 100 segments can be checked per handbill assignment, consider limiting the number of segments and reusing them).\n - After checking the first 100 unique segments, the algorithm rejects promotions for segments that don't match the user.\n - To ensure the correctness of promotion usage and redemption, the algorithm rejects promotions that are currently in the `ACTIVE` or `REDEEMED` status.\n - Candidate promotions are gathered per handbill slot. For each slot, at most a configurable number of promotions (default 40,000) is read from the database, ordered by priority ascending (`1` = highest); any promotions beyond that limit are not considered for that slot. Promotions sharing the same priority have no guaranteed order between them, so when the limit falls within a group of equal priority it is not defined which of them are kept — assign distinct priorities to control this.\n - When using the AI engine, the total number of candidate promotions sent to the recommendation engine in a single request is capped by a configurable limit (default 45,000). If the combined candidates across all slots exceed this limit, each slot is reduced proportionally to the number of candidates it contributed, but never below a configurable per-slot floor (default 1,000), so the smallest slots are left intact.\n\n\n---\n\n**API consumers:** Profile (Client), Anonymous Profile\n","type":"text/plain"},"url":{"path":["v4","promotions","promotion","get-for-client","handbill",":handbillUuid"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"limit","value":"100","description":"The number of items to return per page"},{"disabled":false,"key":"page","value":"4","description":"Page number to return for pagination. The first page has the index `1`."},{"disabled":false,"key":"fields","value":"handbillUuid,activationCounter","description":"Return only specified promotion fields. If `fields` is not specified, all fields are returned."}],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"handbillUuid","description":"(Required) UUID of the handbill configuration"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"f3893075-5781-409c-9767-70a206387454","name":"A list of handbill-type promotions assigned to this profile","originalRequest":{"url":{"path":["v4","promotions","promotion","get-for-client","handbill",":handbillUuid"],"host":["{{baseUrl}}"],"query":[{"key":"limit","value":"100"},{"key":"page","value":"4"},{"key":"fields","value":"minBasketValue,type"}],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"handbillUuid","description":"(Required) UUID of the handbill configuration"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"data\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"meta\": {\n \"code\": {\n \"value\": \"\"\n },\n \"limit\": {\n \"value\": \"\"\n },\n \"link\": {\n \"value\": \"\"\n },\n \"page\": {\n \"value\": \"\"\n },\n \"totalCount\": {\n \"value\": \"\"\n },\n \"totalPages\": {\n \"value\": \"\"\n }\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"21c1df12-94cc-424d-9318-9e72ef662bac","name":"Request body invalid/malformed/missing elements","originalRequest":{"url":{"path":["v4","promotions","promotion","get-for-client","handbill",":handbillUuid"],"host":["{{baseUrl}}"],"query":[{"key":"limit","value":"100"},{"key":"page","value":"4"},{"key":"fields","value":"minBasketValue,type"}],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"handbillUuid","description":"(Required) UUID of the handbill configuration"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"message\": {\n \"value\": \"\"\n },\n \"error\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"c75c5b3b-c613-41fc-b4db-ef65cee3afe9","name":"Unauthorized","originalRequest":{"url":{"path":["v4","promotions","promotion","get-for-client","handbill",":handbillUuid"],"host":["{{baseUrl}}"],"query":[{"key":"limit","value":"100"},{"key":"page","value":"4"},{"key":"fields","value":"minBasketValue,type"}],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"handbillUuid","description":"(Required) UUID of the handbill configuration"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"status\": 7751,\n \"error\": \"string\",\n \"message\": \"string\",\n \"timestamp\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"ff746c31-f2bc-48fb-8472-09686f5af9e1","name":"Forbidden","originalRequest":{"url":{"path":["v4","promotions","promotion","get-for-client","handbill",":handbillUuid"],"host":["{{baseUrl}}"],"query":[{"key":"limit","value":"100"},{"key":"page","value":"4"},{"key":"fields","value":"minBasketValue,type"}],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"handbillUuid","description":"(Required) UUID of the handbill configuration"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"status\": 7751,\n \"error\": \"string\",\n \"message\": \"string\",\n \"timestamp\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"a246008b-911d-4eaa-b6bb-e85ecb1d3d60","name":"Waiting for profile lock release","originalRequest":{"url":{"path":["v4","promotions","promotion","get-for-client","handbill",":handbillUuid"],"host":["{{baseUrl}}"],"query":[{"key":"limit","value":"100"},{"key":"page","value":"4"},{"key":"fields","value":"minBasketValue,type"}],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"handbillUuid","description":"(Required) UUID of the handbill configuration"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Conflict","code":409,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"message\": \"string\",\n \"error\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"ded1a671-3245-4f11-9a08-d9de55fb1250","name":"Generate batch of handbills for Profile","request":{"name":"Generate batch of handbills for Profile","description":{"content":"Assign a batch of handbill promotions to a Profile. They can be randomized or suggested by the AI engine.\n\n**IMPORTANT**: \n- The endpoint is limited to 1000 requests per minute (per workspace).\n- The algorithm that selects promotions for assignment candidates applies all the following filters:\n - Promotions must be of the specified type, assigned to a handbill campaign, and with the `PUBLISH` status.\n - Promotions must be available for the entire duration of the handbill assignment, considering `startAt` and `expireAt` dates. For example, when generating assignments on May 1, 2024 at 9:00 a.m. that are expected to last 3 hours, the algorithm will consider promotions whose `startAt` date is equal to or earlier than May 1, 2024 9:00 a.m. and `expireAt` date is equal to or later than May 1, 2024 12:00 p.m. \n - Promotions can't currently be assigned within another handbill campaign.\n - Promotions must match the filter for the slot (if applicable). Promotions are handled by the `binoculars` service and identified by UUID.\n - Promotions are deduplicated. First they are sorted by priority, then the algorithm rejects promotions with at least one product that occurred earlier. In a special case, if a promotion with a high priority has an extensive catalog of products covering other promotions, it could exclude all promotions with a lower priority.\n - If `excludeByAvailableProducts` is set to `true`, the algorithm rejects promotions for items that are available as part of other promotions (regardless of their type)\n - After sorting promotions by priority, the algorithm rejects promotions for segments that occur after the 100th unique segment is encountered. (only 100 segments can be checked per handbill assignment, consider limiting the number of segments and reusing them).\n - After checking the first 100 unique segments, the algorithm rejects promotions for segments that don't match the user.\n - To ensure the correctness of promotion usage and redemption, the algorithm rejects promotions that are currently in the `ACTIVE` or `REDEEMED` status.\n - Candidate promotions are gathered per handbill slot. For each slot, at most a configurable number of promotions (default 40,000) is read from the database, ordered by priority ascending (`1` = highest); any promotions beyond that limit are not considered for that slot. Promotions sharing the same priority have no guaranteed order between them, so when the limit falls within a group of equal priority it is not defined which of them are kept — assign distinct priorities to control this.\n - When using the AI engine, the total number of candidate promotions sent to the recommendation engine in a single request is capped by a configurable limit (default 45,000). If the combined candidates across all slots exceed this limit, each slot is reduced proportionally to the number of candidates it contributed, but never below a configurable per-slot floor (default 1,000), so the smallest slots are left intact.\n\n\n---\n\n**API consumers:** Profile (Client), Anonymous Profile\n","type":"text/plain"},"url":{"path":["v4","promotions","promotion","get-for-client","handbills"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"handbillUuid","value":"string","description":"(Required) "},{"disabled":false,"key":"handbillUuid","value":"string","description":"(Required) "},{"disabled":false,"key":"page","value":"4","description":"Page number to return for pagination. The first page has the index `1`."},{"disabled":false,"key":"limit","value":"100","description":"The number of items to return per page"},{"disabled":false,"key":"includeMeta","value":"false","description":"\nWhen `true`, pagination metadata is included in the response body.\n\nWhen `false`, the data is included in the response headers:\n\n- Link: links to neighbors, first, and last pages in pagination.\n\n- X-Pagination-Total-Count: total number of items on all pages\n\n- X-Pagination-Total-Pages: total number of pages\n\n- X-Pagination-Page: current page\n\n- X-Pagination-Limit: maximum number of items on a page\n"},{"disabled":false,"key":"fields","value":"minBasketValue,type","description":"Return only specified promotion fields. If `fields` is not specified, all fields are returned."}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"5748b95e-7834-4227-9bdf-d43a72ada17a","name":"A list of handbill-type promotions assigned to this profile","originalRequest":{"url":{"path":["v4","promotions","promotion","get-for-client","handbills"],"host":["{{baseUrl}}"],"query":[{"key":"handbillUuid","value":"string"},{"key":"handbillUuid","value":"string"},{"key":"page","value":"4"},{"key":"limit","value":"100"},{"key":"includeMeta","value":"false"},{"key":"fields","value":"minBasketValue,type"}],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"data\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"meta\": {\n \"code\": {\n \"value\": \"\"\n },\n \"limit\": {\n \"value\": \"\"\n },\n \"link\": {\n \"value\": \"\"\n },\n \"page\": {\n \"value\": \"\"\n },\n \"totalCount\": {\n \"value\": \"\"\n },\n \"totalPages\": {\n \"value\": \"\"\n }\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"4ea3cdab-d0da-4ebd-816e-b52de7587ed3","name":"Request body invalid/malformed/missing elements","originalRequest":{"url":{"path":["v4","promotions","promotion","get-for-client","handbills"],"host":["{{baseUrl}}"],"query":[{"key":"handbillUuid","value":"string"},{"key":"handbillUuid","value":"string"},{"key":"page","value":"4"},{"key":"limit","value":"100"},{"key":"includeMeta","value":"false"},{"key":"fields","value":"minBasketValue,type"}],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"message\": {\n \"value\": \"\"\n },\n \"error\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"927fadce-2197-4e56-9d18-410d30f1756e","name":"Unauthorized","originalRequest":{"url":{"path":["v4","promotions","promotion","get-for-client","handbills"],"host":["{{baseUrl}}"],"query":[{"key":"handbillUuid","value":"string"},{"key":"handbillUuid","value":"string"},{"key":"page","value":"4"},{"key":"limit","value":"100"},{"key":"includeMeta","value":"false"},{"key":"fields","value":"minBasketValue,type"}],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"status\": 7751,\n \"error\": \"string\",\n \"message\": \"string\",\n \"timestamp\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"ab540694-3039-4412-b872-d2d2fb9a27e4","name":"Forbidden","originalRequest":{"url":{"path":["v4","promotions","promotion","get-for-client","handbills"],"host":["{{baseUrl}}"],"query":[{"key":"handbillUuid","value":"string"},{"key":"handbillUuid","value":"string"},{"key":"page","value":"4"},{"key":"limit","value":"100"},{"key":"includeMeta","value":"false"},{"key":"fields","value":"minBasketValue,type"}],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"status\": 7751,\n \"error\": \"string\",\n \"message\": \"string\",\n \"timestamp\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"f40d4a73-07bc-4394-9fcc-eac9d656d403","name":"Waiting for profile lock release","originalRequest":{"url":{"path":["v4","promotions","promotion","get-for-client","handbills"],"host":["{{baseUrl}}"],"query":[{"key":"handbillUuid","value":"string"},{"key":"handbillUuid","value":"string"},{"key":"page","value":"4"},{"key":"limit","value":"100"},{"key":"includeMeta","value":"false"},{"key":"fields","value":"minBasketValue,type"}],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Conflict","code":409,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"message\": \"string\",\n \"error\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"a9420bf5-0228-4ff0-8237-b387f9c944f0","name":"Generate handbill for Profile and get Profile promotions","request":{"name":"Generate handbill for Profile and get Profile promotions","description":{"content":"**Deprecated.** Use [/v2/promotion/get-for-client/{identifierType}/{identifierValue}/handbill/{handbillUuid}](#operation/getHandbillForClientV2_GET) instead.\n\nAssign a handbill to a Profile and retrieve a list of promotions assigned to the Profile.\n\n**IMPORTANT**:\n- The endpoint is limited to 1000 requests per minute (per workspace).\n- The algorithm that selects promotions for assignment candidates applies all the following filters:\n - Promotions must be of the specified type, assigned to a handbill campaign, and with the `PUBLISH` status.\n - Promotions must be available for the entire duration of the handbill assignment, considering `startAt` and `expireAt` dates. For example, when generating assignments on May 1, 2024 at 9:00 a.m. that are expected to last 3 hours, the algorithm will consider promotions whose `startAt` date is equal to or earlier than May 1, 2024 9:00 a.m. and `expireAt` date is equal to or later than May 1, 2024 12:00 p.m. \n - Promotions can't currently be assigned within another handbill campaign.\n - Promotions must match the filter for the slot (if applicable). Promotions are handled by the `binoculars` service and identified by UUID.\n - Promotions are deduplicated. First they are sorted by priority, then the algorithm rejects promotions with at least one product that occurred earlier. In a special case, if a promotion with a high priority has an extensive catalog of products covering other promotions, it could exclude all promotions with a lower priority.\n - If `excludeByAvailableProducts` is set to `true`, the algorithm rejects promotions for items that are available as part of other promotions (regardless of their type)\n - After sorting promotions by priority, the algorithm rejects promotions for segments that occur after the 100th unique segment is encountered. (only 100 segments can be checked per handbill assignment, consider limiting the number of segments and reusing them).\n - After checking the first 100 unique segments, the algorithm rejects promotions for segments that don't match the user.\n - To ensure the correctness of promotion usage and redemption, the algorithm rejects promotions that are currently in the `ACTIVE` or `REDEEMED` status.\n - Candidate promotions are gathered per handbill slot. For each slot, at most a configurable number of promotions (default 40,000) is read from the database, ordered by priority ascending (`1` = highest); any promotions beyond that limit are not considered for that slot. Promotions sharing the same priority have no guaranteed order between them, so when the limit falls within a group of equal priority it is not defined which of them are kept — assign distinct priorities to control this.\n - When using the AI engine, the total number of candidate promotions sent to the recommendation engine in a single request is capped by a configurable limit (default 45,000). If the combined candidates across all slots exceed this limit, each slot is reduced proportionally to the number of candidates it contributed, but never below a configurable per-slot floor (default 1,000), so the smallest slots are left intact.\n\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User\n\n**API key permission required:** `PROMOTIONS_FOR_CLIENT_HANDBILL_READ`\n\n**User role permission required:** `campaigns_personalised_promotions: read`\n","type":"text/plain"},"url":{"path":["v4","promotions","promotion","get-for-client",":identifierType",":identifierValue","handbill",":handbillUuid"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"type","value":"MEMBERS_ONLY,MEMBERS_ONLY","description":"Promotion type"},{"disabled":false,"key":"status","value":"ASSIGNED,ASSIGNED","description":"Filter by promotion status"},{"disabled":false,"key":"visibilityStatus","value":"PUBLISH","description":"Visibility status"},{"disabled":false,"key":"visibilityStatus","value":"DRAFT","description":"Visibility status"},{"disabled":false,"key":"tagNames","value":"string,string","description":"Filter the response to promotions with a certain tag or tags"},{"disabled":false,"key":"target","value":"ALL,ALL","description":"The target of the promotion"},{"disabled":false,"key":"presentOnly","value":"true","description":"When set to:\n- `true`, the response includes only promotions that are currently active (startAt later than now or null, expireAt later than now or null)\n- `false`, the response includes the above and also promotions that are expired or will become active in the future.\n"},{"disabled":false,"key":"lastingOnly","value":"true","description":"When set to `true`, shows promotions/vouchers that are currently active and those that are still inactivated. (lastingAt set to null or lastingAt in future)"},{"disabled":false,"key":"page","value":"4","description":"Page number to return for pagination. The first page has the index `1`."},{"disabled":false,"key":"limit","value":"100","description":"The number of items to return per page"},{"disabled":false,"key":"sort","value":"createdAt,desc","description":"The sorting order of the response.\n\n\nYou can sort by any combination of the following attributes:\n\n* `createdAt`: time when the configuration was created\n\n* `updatedAt`: time when the configuration was last updated\n\n\nYou can sort ascending (default) or descending by adding `asc` or `desc` after the parameter, separated by a comma.\"\n"},{"disabled":false,"key":"includeMeta","value":"false","description":"\nWhen `true`, pagination metadata is included in the response body.\n\nWhen `false`, the data is included in the response headers:\n\n- Link: links to neighbors, first, and last pages in pagination.\n\n- X-Pagination-Total-Count: total number of items on all pages\n\n- X-Pagination-Total-Pages: total number of pages\n\n- X-Pagination-Page: current page\n\n- X-Pagination-Limit: maximum number of items on a page\n"},{"disabled":false,"key":"fields","value":"minBasketValue,type","description":"Return only specified promotion fields. If `fields` is not specified, all fields are returned."}],"variable":[{"disabled":false,"type":"any","value":"email","key":"identifierType","description":"(Required) The Profile identifier to use for the request.\n\n`externalId` is known as `customId` or `custom_identify` in other Synerise services.\n"},{"disabled":false,"type":"any","value":"string","key":"identifierValue","description":"(Required) The value of the selected identifier"},{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"handbillUuid","description":"(Required) UUID of the handbill configuration"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"40efee55-571f-48e4-8365-43188f25ac00","name":"A list of promotions assigned to this profile","originalRequest":{"url":{"path":["v4","promotions","promotion","get-for-client",":identifierType",":identifierValue","handbill",":handbillUuid"],"host":["{{baseUrl}}"],"query":[{"key":"type","value":"GENERAL,CUSTOM"},{"key":"status","value":"REDEEMED,ACTIVE"},{"key":"visibilityStatus","value":"HIDDEN"},{"key":"visibilityStatus","value":"DRAFT"},{"key":"tagNames","value":"string,string"},{"key":"target","value":"ALL,ALL"},{"key":"presentOnly","value":"true"},{"key":"lastingOnly","value":"true"},{"key":"page","value":"4"},{"key":"limit","value":"100"},{"key":"sort","value":"createdAt,desc"},{"key":"includeMeta","value":"false"},{"key":"fields","value":"minBasketValue,type"}],"variable":[{"disabled":false,"type":"any","value":"email","key":"identifierType","description":"(Required) The Profile identifier to use for the request.\n\n`externalId` is known as `customId` or `custom_identify` in other Synerise services.\n"},{"disabled":false,"type":"any","value":"string","key":"identifierValue","description":"(Required) The value of the selected identifier"},{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"handbillUuid","description":"(Required) UUID of the handbill configuration"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"data\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"meta\": {\n \"code\": {\n \"value\": \"\"\n },\n \"limit\": {\n \"value\": \"\"\n },\n \"link\": {\n \"value\": \"\"\n },\n \"page\": {\n \"value\": \"\"\n },\n \"totalCount\": {\n \"value\": \"\"\n },\n \"totalPages\": {\n \"value\": \"\"\n }\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"091000c6-f28e-4f04-9d36-0b87f325fc73","name":"Request body invalid/malformed/missing elements","originalRequest":{"url":{"path":["v4","promotions","promotion","get-for-client",":identifierType",":identifierValue","handbill",":handbillUuid"],"host":["{{baseUrl}}"],"query":[{"key":"type","value":"GENERAL,CUSTOM"},{"key":"status","value":"REDEEMED,ACTIVE"},{"key":"visibilityStatus","value":"HIDDEN"},{"key":"visibilityStatus","value":"DRAFT"},{"key":"tagNames","value":"string,string"},{"key":"target","value":"ALL,ALL"},{"key":"presentOnly","value":"true"},{"key":"lastingOnly","value":"true"},{"key":"page","value":"4"},{"key":"limit","value":"100"},{"key":"sort","value":"createdAt,desc"},{"key":"includeMeta","value":"false"},{"key":"fields","value":"minBasketValue,type"}],"variable":[{"disabled":false,"type":"any","value":"email","key":"identifierType","description":"(Required) The Profile identifier to use for the request.\n\n`externalId` is known as `customId` or `custom_identify` in other Synerise services.\n"},{"disabled":false,"type":"any","value":"string","key":"identifierValue","description":"(Required) The value of the selected identifier"},{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"handbillUuid","description":"(Required) UUID of the handbill configuration"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"message\": {\n \"value\": \"\"\n },\n \"error\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"51c250da-ecdd-41d8-950d-987d7f870549","name":"Unauthorized","originalRequest":{"url":{"path":["v4","promotions","promotion","get-for-client",":identifierType",":identifierValue","handbill",":handbillUuid"],"host":["{{baseUrl}}"],"query":[{"key":"type","value":"GENERAL,CUSTOM"},{"key":"status","value":"REDEEMED,ACTIVE"},{"key":"visibilityStatus","value":"HIDDEN"},{"key":"visibilityStatus","value":"DRAFT"},{"key":"tagNames","value":"string,string"},{"key":"target","value":"ALL,ALL"},{"key":"presentOnly","value":"true"},{"key":"lastingOnly","value":"true"},{"key":"page","value":"4"},{"key":"limit","value":"100"},{"key":"sort","value":"createdAt,desc"},{"key":"includeMeta","value":"false"},{"key":"fields","value":"minBasketValue,type"}],"variable":[{"disabled":false,"type":"any","value":"email","key":"identifierType","description":"(Required) The Profile identifier to use for the request.\n\n`externalId` is known as `customId` or `custom_identify` in other Synerise services.\n"},{"disabled":false,"type":"any","value":"string","key":"identifierValue","description":"(Required) The value of the selected identifier"},{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"handbillUuid","description":"(Required) UUID of the handbill configuration"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"status\": 7751,\n \"error\": \"string\",\n \"message\": \"string\",\n \"timestamp\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"11c55636-fbbd-45c6-9682-a62a567e9fba","name":"Forbidden","originalRequest":{"url":{"path":["v4","promotions","promotion","get-for-client",":identifierType",":identifierValue","handbill",":handbillUuid"],"host":["{{baseUrl}}"],"query":[{"key":"type","value":"GENERAL,CUSTOM"},{"key":"status","value":"REDEEMED,ACTIVE"},{"key":"visibilityStatus","value":"HIDDEN"},{"key":"visibilityStatus","value":"DRAFT"},{"key":"tagNames","value":"string,string"},{"key":"target","value":"ALL,ALL"},{"key":"presentOnly","value":"true"},{"key":"lastingOnly","value":"true"},{"key":"page","value":"4"},{"key":"limit","value":"100"},{"key":"sort","value":"createdAt,desc"},{"key":"includeMeta","value":"false"},{"key":"fields","value":"minBasketValue,type"}],"variable":[{"disabled":false,"type":"any","value":"email","key":"identifierType","description":"(Required) The Profile identifier to use for the request.\n\n`externalId` is known as `customId` or `custom_identify` in other Synerise services.\n"},{"disabled":false,"type":"any","value":"string","key":"identifierValue","description":"(Required) The value of the selected identifier"},{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"handbillUuid","description":"(Required) UUID of the handbill configuration"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"status\": 7751,\n \"error\": \"string\",\n \"message\": \"string\",\n \"timestamp\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"b2a73f3e-0286-4e7f-9d58-edbf1000e6bf","name":"Generate handbill for Profile (v2)","request":{"name":"Generate handbill for Profile (v2)","description":{"content":"Assign handbill promotions to a Profile. They can be randomized or suggested by the AI engine.\n\n**IMPORTANT**: \n- The endpoint is limited to 1000 requests per minute (per workspace).\n- The algorithm that selects promotions for assignment candidates applies all the following filters:\n - Promotions must be of the specified type, assigned to a handbill campaign, and with the `PUBLISH` status.\n - Promotions must be available for the entire duration of the handbill assignment, considering `startAt` and `expireAt` dates. For example, when generating assignments on May 1, 2024 at 9:00 a.m. that are expected to last 3 hours, the algorithm will consider promotions whose `startAt` date is equal to or earlier than May 1, 2024 9:00 a.m. and `expireAt` date is equal to or later than May 1, 2024 12:00 p.m. \n - Promotions can't currently be assigned within another handbill campaign.\n - Promotions must match the filter for the slot (if applicable). Promotions are handled by the `binoculars` service and identified by UUID.\n - Promotions are deduplicated. First they are sorted by priority, then the algorithm rejects promotions with at least one product that occurred earlier. In a special case, if a promotion with a high priority has an extensive catalog of products covering other promotions, it could exclude all promotions with a lower priority.\n - If `excludeByAvailableProducts` is set to `true`, the algorithm rejects promotions for items that are available as part of other promotions (regardless of their type)\n - After sorting promotions by priority, the algorithm rejects promotions for segments that occur after the 100th unique segment is encountered. (only 100 segments can be checked per handbill assignment, consider limiting the number of segments and reusing them).\n - After checking the first 100 unique segments, the algorithm rejects promotions for segments that don't match the user.\n - To ensure the correctness of promotion usage and redemption, the algorithm rejects promotions that are currently in the `ACTIVE` or `REDEEMED` status.\n - Candidate promotions are gathered per handbill slot. For each slot, at most a configurable number of promotions (default 40,000) is read from the database, ordered by priority ascending (`1` = highest); any promotions beyond that limit are not considered for that slot. Promotions sharing the same priority have no guaranteed order between them, so when the limit falls within a group of equal priority it is not defined which of them are kept — assign distinct priorities to control this.\n - When using the AI engine, the total number of candidate promotions sent to the recommendation engine in a single request is capped by a configurable limit (default 45,000). If the combined candidates across all slots exceed this limit, each slot is reduced proportionally to the number of candidates it contributed, but never below a configurable per-slot floor (default 1,000), so the smallest slots are left intact.\n\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User\n\n**API key permission required:** `PROMOTIONS_FOR_CLIENT_HANDBILL_READ`\n\n**User role permission required:** `campaigns_personalised_promotions: read`\n","type":"text/plain"},"url":{"path":["v4","promotions","v2","promotion","get-for-client",":identifierType",":identifierValue","handbill",":handbillUuid"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"limit","value":"100","description":"The number of items to return per page"},{"disabled":false,"key":"page","value":"4","description":"Page number to return for pagination. The first page has the index `1`."}],"variable":[{"disabled":false,"type":"any","value":"email","key":"identifierType","description":"(Required) The Profile identifier to use for the request.\n\n`externalId` is known as `customId` or `custom_identify` in other Synerise services.\n"},{"disabled":false,"type":"any","value":"string","key":"identifierValue","description":"(Required) The value of the selected identifier"},{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"handbillUuid","description":"(Required) UUID of the handbill configuration"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"2f0bacee-a3d3-43ce-9ac3-f79847257aa9","name":"A list of handbill-type promotions assigned to this profile","originalRequest":{"url":{"path":["v4","promotions","v2","promotion","get-for-client",":identifierType",":identifierValue","handbill",":handbillUuid"],"host":["{{baseUrl}}"],"query":[{"key":"limit","value":"100"},{"key":"page","value":"4"}],"variable":[{"disabled":false,"type":"any","value":"email","key":"identifierType","description":"(Required) The Profile identifier to use for the request.\n\n`externalId` is known as `customId` or `custom_identify` in other Synerise services.\n"},{"disabled":false,"type":"any","value":"string","key":"identifierValue","description":"(Required) The value of the selected identifier"},{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"handbillUuid","description":"(Required) UUID of the handbill configuration"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"data\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"meta\": {\n \"code\": {\n \"value\": \"\"\n },\n \"limit\": {\n \"value\": \"\"\n },\n \"link\": {\n \"value\": \"\"\n },\n \"page\": {\n \"value\": \"\"\n },\n \"totalCount\": {\n \"value\": \"\"\n },\n \"totalPages\": {\n \"value\": \"\"\n }\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"ff58280c-938a-448f-86a2-78c5e49915ce","name":"Request body invalid/malformed/missing elements","originalRequest":{"url":{"path":["v4","promotions","v2","promotion","get-for-client",":identifierType",":identifierValue","handbill",":handbillUuid"],"host":["{{baseUrl}}"],"query":[{"key":"limit","value":"100"},{"key":"page","value":"4"}],"variable":[{"disabled":false,"type":"any","value":"email","key":"identifierType","description":"(Required) The Profile identifier to use for the request.\n\n`externalId` is known as `customId` or `custom_identify` in other Synerise services.\n"},{"disabled":false,"type":"any","value":"string","key":"identifierValue","description":"(Required) The value of the selected identifier"},{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"handbillUuid","description":"(Required) UUID of the handbill configuration"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"message\": {\n \"value\": \"\"\n },\n \"error\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"0cee65da-6093-4e7f-b075-925a2daaf411","name":"Unauthorized","originalRequest":{"url":{"path":["v4","promotions","v2","promotion","get-for-client",":identifierType",":identifierValue","handbill",":handbillUuid"],"host":["{{baseUrl}}"],"query":[{"key":"limit","value":"100"},{"key":"page","value":"4"}],"variable":[{"disabled":false,"type":"any","value":"email","key":"identifierType","description":"(Required) The Profile identifier to use for the request.\n\n`externalId` is known as `customId` or `custom_identify` in other Synerise services.\n"},{"disabled":false,"type":"any","value":"string","key":"identifierValue","description":"(Required) The value of the selected identifier"},{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"handbillUuid","description":"(Required) UUID of the handbill configuration"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"status\": 7751,\n \"error\": \"string\",\n \"message\": \"string\",\n \"timestamp\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"d9da4d1a-4f22-4802-af8a-35df845aeb96","name":"Forbidden","originalRequest":{"url":{"path":["v4","promotions","v2","promotion","get-for-client",":identifierType",":identifierValue","handbill",":handbillUuid"],"host":["{{baseUrl}}"],"query":[{"key":"limit","value":"100"},{"key":"page","value":"4"}],"variable":[{"disabled":false,"type":"any","value":"email","key":"identifierType","description":"(Required) The Profile identifier to use for the request.\n\n`externalId` is known as `customId` or `custom_identify` in other Synerise services.\n"},{"disabled":false,"type":"any","value":"string","key":"identifierValue","description":"(Required) The value of the selected identifier"},{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"handbillUuid","description":"(Required) UUID of the handbill configuration"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"status\": 7751,\n \"error\": \"string\",\n \"message\": \"string\",\n \"timestamp\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"90fd44b5-b9b0-48ee-b635-39cd5df097d0","name":"Waiting for profile lock release","originalRequest":{"url":{"path":["v4","promotions","v2","promotion","get-for-client",":identifierType",":identifierValue","handbill",":handbillUuid"],"host":["{{baseUrl}}"],"query":[{"key":"limit","value":"100"},{"key":"page","value":"4"}],"variable":[{"disabled":false,"type":"any","value":"email","key":"identifierType","description":"(Required) The Profile identifier to use for the request.\n\n`externalId` is known as `customId` or `custom_identify` in other Synerise services.\n"},{"disabled":false,"type":"any","value":"string","key":"identifierValue","description":"(Required) The value of the selected identifier"},{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"handbillUuid","description":"(Required) UUID of the handbill configuration"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Conflict","code":409,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"message\": \"string\",\n \"error\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"d70f551b-8c99-466c-8651-a087c2ee943d","name":"Generate batch handbill for Profile and get Profile promotions","request":{"name":"Generate batch handbill for Profile and get Profile promotions","description":{"content":"\nAssign a batch handbill to a Profile and retrieve a list of promotions assigned to the Profile.\n\n**IMPORTANT**: \n- The endpoint is limited to 1000 requests per minute (per workspace).\n- The algorithm that selects promotions for assignment candidates applies all the following filters:\n - Promotions must be of the specified type, assigned to a handbill campaign, and with the `PUBLISH` status.\n - Promotions must be available for the entire duration of the handbill assignment, considering `startAt` and `expireAt` dates. For example, when generating assignments on May 1, 2024 at 9:00 a.m. that are expected to last 3 hours, the algorithm will consider promotions whose `startAt` date is equal to or earlier than May 1, 2024 9:00 a.m. and `expireAt` date is equal to or later than May 1, 2024 12:00 p.m. \n - Promotions can't currently be assigned within another handbill campaign.\n - Promotions must match the filter for the slot (if applicable). Promotions are handled by the `binoculars` service and identified by UUID.\n - Promotions are deduplicated. First they are sorted by priority, then the algorithm rejects promotions with at least one product that occurred earlier. In a special case, if a promotion with a high priority has an extensive catalog of products covering other promotions, it could exclude all promotions with a lower priority.\n - If `excludeByAvailableProducts` is set to `true`, the algorithm rejects promotions for items that are available as part of other promotions (regardless of their type)\n - After sorting promotions by priority, the algorithm rejects promotions for segments that occur after the 100th unique segment is encountered. (only 100 segments can be checked per handbill assignment, consider limiting the number of segments and reusing them).\n - After checking the first 100 unique segments, the algorithm rejects promotions for segments that don't match the user.\n - To ensure the correctness of promotion usage and redemption, the algorithm rejects promotions that are currently in the `ACTIVE` or `REDEEMED` status.\n - Candidate promotions are gathered per handbill slot. For each slot, at most a configurable number of promotions (default 40,000) is read from the database, ordered by priority ascending (`1` = highest); any promotions beyond that limit are not considered for that slot. Promotions sharing the same priority have no guaranteed order between them, so when the limit falls within a group of equal priority it is not defined which of them are kept — assign distinct priorities to control this.\n - When using the AI engine, the total number of candidate promotions sent to the recommendation engine in a single request is capped by a configurable limit (default 45,000). If the combined candidates across all slots exceed this limit, each slot is reduced proportionally to the number of candidates it contributed, but never below a configurable per-slot floor (default 1,000), so the smallest slots are left intact.\n\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User\n\n**API key permission required:** `PROMOTIONS_FOR_CLIENT_HANDBILL_READ`\n\n**User role permission required:** `campaigns_personalised_promotions: read`\n","type":"text/plain"},"url":{"path":["v4","promotions","promotion","get-for-client",":identifierType",":identifierValue","with-handbills"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"handbillUuid","value":"string","description":"(Required) "},{"disabled":false,"key":"handbillUuid","value":"string","description":"(Required) "},{"disabled":false,"key":"type","value":"GENERAL,CUSTOM","description":"Promotion type"},{"disabled":false,"key":"page","value":"4","description":"Page number to return for pagination. The first page has the index `1`."},{"disabled":false,"key":"limit","value":"100","description":"The number of items to return per page"},{"disabled":false,"key":"includeMeta","value":"false","description":"\nWhen `true`, pagination metadata is included in the response body.\n\nWhen `false`, the data is included in the response headers:\n\n- Link: links to neighbors, first, and last pages in pagination.\n\n- X-Pagination-Total-Count: total number of items on all pages\n\n- X-Pagination-Total-Pages: total number of pages\n\n- X-Pagination-Page: current page\n\n- X-Pagination-Limit: maximum number of items on a page\n"},{"disabled":false,"key":"status","value":"REDEEMED,ACTIVE","description":"Filter by promotion status"},{"disabled":false,"key":"fields","value":"minBasketValue,type","description":"Return only specified promotion fields. If `fields` is not specified, all fields are returned."}],"variable":[{"disabled":false,"type":"any","value":"email","key":"identifierType","description":"(Required) The Profile identifier to use for the request.\n\n`externalId` is known as `customId` or `custom_identify` in other Synerise services.\n"},{"disabled":false,"type":"any","value":"string","key":"identifierValue","description":"(Required) The value of the selected identifier"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"7373c46c-a0c9-4176-804e-835c4f771885","name":"A list of promotions assigned to this profile","originalRequest":{"url":{"path":["v4","promotions","promotion","get-for-client",":identifierType",":identifierValue","with-handbills"],"host":["{{baseUrl}}"],"query":[{"key":"handbillUuid","value":"string"},{"key":"handbillUuid","value":"string"},{"key":"type","value":"GENERAL,CUSTOM"},{"key":"page","value":"4"},{"key":"limit","value":"100"},{"key":"includeMeta","value":"false"},{"key":"status","value":"REDEEMED,ACTIVE"},{"key":"fields","value":"minBasketValue,type"}],"variable":[{"disabled":false,"type":"any","value":"email","key":"identifierType","description":"(Required) The Profile identifier to use for the request.\n\n`externalId` is known as `customId` or `custom_identify` in other Synerise services.\n"},{"disabled":false,"type":"any","value":"string","key":"identifierValue","description":"(Required) The value of the selected identifier"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"data\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"meta\": {\n \"code\": {\n \"value\": \"\"\n },\n \"limit\": {\n \"value\": \"\"\n },\n \"link\": {\n \"value\": \"\"\n },\n \"page\": {\n \"value\": \"\"\n },\n \"totalCount\": {\n \"value\": \"\"\n },\n \"totalPages\": {\n \"value\": \"\"\n }\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"2040dc75-0497-426e-8b2c-c1c078f7dd43","name":"Request body invalid/malformed/missing elements","originalRequest":{"url":{"path":["v4","promotions","promotion","get-for-client",":identifierType",":identifierValue","with-handbills"],"host":["{{baseUrl}}"],"query":[{"key":"handbillUuid","value":"string"},{"key":"handbillUuid","value":"string"},{"key":"type","value":"GENERAL,CUSTOM"},{"key":"page","value":"4"},{"key":"limit","value":"100"},{"key":"includeMeta","value":"false"},{"key":"status","value":"REDEEMED,ACTIVE"},{"key":"fields","value":"minBasketValue,type"}],"variable":[{"disabled":false,"type":"any","value":"email","key":"identifierType","description":"(Required) The Profile identifier to use for the request.\n\n`externalId` is known as `customId` or `custom_identify` in other Synerise services.\n"},{"disabled":false,"type":"any","value":"string","key":"identifierValue","description":"(Required) The value of the selected identifier"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"message\": {\n \"value\": \"\"\n },\n \"error\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"53463043-0b0f-4576-9be2-a7b375b6d7c2","name":"Unauthorized","originalRequest":{"url":{"path":["v4","promotions","promotion","get-for-client",":identifierType",":identifierValue","with-handbills"],"host":["{{baseUrl}}"],"query":[{"key":"handbillUuid","value":"string"},{"key":"handbillUuid","value":"string"},{"key":"type","value":"GENERAL,CUSTOM"},{"key":"page","value":"4"},{"key":"limit","value":"100"},{"key":"includeMeta","value":"false"},{"key":"status","value":"REDEEMED,ACTIVE"},{"key":"fields","value":"minBasketValue,type"}],"variable":[{"disabled":false,"type":"any","value":"email","key":"identifierType","description":"(Required) The Profile identifier to use for the request.\n\n`externalId` is known as `customId` or `custom_identify` in other Synerise services.\n"},{"disabled":false,"type":"any","value":"string","key":"identifierValue","description":"(Required) The value of the selected identifier"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"status\": 7751,\n \"error\": \"string\",\n \"message\": \"string\",\n \"timestamp\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"1999b610-dcb3-4d03-87b6-f9d7292a854c","name":"Forbidden","originalRequest":{"url":{"path":["v4","promotions","promotion","get-for-client",":identifierType",":identifierValue","with-handbills"],"host":["{{baseUrl}}"],"query":[{"key":"handbillUuid","value":"string"},{"key":"handbillUuid","value":"string"},{"key":"type","value":"GENERAL,CUSTOM"},{"key":"page","value":"4"},{"key":"limit","value":"100"},{"key":"includeMeta","value":"false"},{"key":"status","value":"REDEEMED,ACTIVE"},{"key":"fields","value":"minBasketValue,type"}],"variable":[{"disabled":false,"type":"any","value":"email","key":"identifierType","description":"(Required) The Profile identifier to use for the request.\n\n`externalId` is known as `customId` or `custom_identify` in other Synerise services.\n"},{"disabled":false,"type":"any","value":"string","key":"identifierValue","description":"(Required) The value of the selected identifier"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"status\": 7751,\n \"error\": \"string\",\n \"message\": \"string\",\n \"timestamp\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}],"event":[]},{"id":"611d28b8-586b-4753-8b8b-d9678d56849a","name":"Wallet passes","description":{"content":"","type":"text/plain"},"item":[{"id":"37f51ea9-dc78-4211-bf8b-8d4d610495fa","name":"Issue wallet pass","request":{"name":"Issue wallet pass","description":{"content":"**IMPORTANT**: This feature is in private preview mode and accessible only on selected workspaces. To get access, contact your account manager or Synerise Support.\n\n---\n\nHandle issuing a wallet pass.\n- If the platform (IOS, ANDROID) is not specified, the endpoint returns a landing page where the user can choose their OS.\n- If the platform is specified, the endpoint issues a wallet card.\n\nTo obtain the parameters required by this endpoint, generate a link with the `/wallets/issue/link` endpoint. You can also generate the link with Jinjava inserts in communication, for example in push messages or when rendering content from Brickworks.\n\n\n---\n\n**Authentication:** Not required\n","type":"text/plain"},"url":{"path":["device-hub","wallets","issue"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"clientUuid","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","description":"When present, also goes into the HMAC payload depending on the wallet pass record configuration. If an UUID was used to generate the link, make sure to use the same UUID when issuing the wallet pass."},{"disabled":false,"key":"issueId","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","description":"(Required) Primary key for the IssueLinkEntity lookup. Returned as part of the link by `/wallets/issue/link` or a Jinjava insert."},{"disabled":false,"key":"hmac","value":"string","description":"(Required) Base64url-no-padding HMAC-SHA256 returned as part of the link by `/wallets/issue/link` or a Jinjava insert."},{"disabled":false,"key":"platform","value":"ANDROID","description":"When absent, the server renders the HTML landing page. When platform is specified, then wallet pass issuance is performed for selected platform.\n"}],"variable":[]},"header":[{"key":"Accept","value":"text/html"}],"method":"GET","auth":null},"response":[{"id":"9b0996b2-5e5e-466a-a3a6-a92d5d0a7b31","name":"OK: Apple .pkpass file or landing page with platform selection","originalRequest":{"url":{"path":["device-hub","wallets","issue"],"host":["{{baseUrl}}"],"query":[{"key":"clientUuid","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750"},{"key":"issueId","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750"},{"key":"hmac","value":"string"},{"key":"platform","value":"ANDROID"}],"variable":[]},"header":[{"key":"Accept","value":"text/html"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"text/html"}],"body":"string","cookie":[],"_postman_previewlanguage":"text"},{"id":"19671a45-49e3-4356-8bfe-d03b0bccd20b","name":"Found - Issued wallet pass for Android. The Location header points at `https://pay.google.com/gp/v/save/`. Empty body.\n","originalRequest":{"url":{"path":["device-hub","wallets","issue"],"host":["{{baseUrl}}"],"query":[{"key":"clientUuid","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750"},{"key":"issueId","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750"},{"key":"hmac","value":"string"},{"key":"platform","value":"ANDROID"}],"variable":[]},"method":"GET","body":{}},"status":"Found","code":302,"header":[{"disabled":false,"description":"The Google Wallet save-jwt URL the browser should follow.","key":"Location","value":"https://pay.google.com/gp/v/save/eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9..."},{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"00dc6a46-4752-403d-879a-71f2957aad1b","name":"Bad Request - Missing/malformed required query parameter, malformed platform enum value, or HMAC verification failed (rendered as the link-error view for the HMAC case).\n","originalRequest":{"url":{"path":["device-hub","wallets","issue"],"host":["{{baseUrl}}"],"query":[{"key":"clientUuid","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750"},{"key":"issueId","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750"},{"key":"hmac","value":"string"},{"key":"platform","value":"ANDROID"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"70a7610b-4a20-4584-907b-70687391fb74","name":"Not Found - issueId not found in issue_links (including soft-deleted entries), or the wallet pass record's googleCredentialId does not resolve to a credential for this tenant.\n","originalRequest":{"url":{"path":["device-hub","wallets","issue"],"host":["{{baseUrl}}"],"query":[{"key":"clientUuid","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750"},{"key":"issueId","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750"},{"key":"hmac","value":"string"},{"key":"platform","value":"ANDROID"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"5f2a2660-20a8-4e5e-be7b-d513ef67d008","name":"Gone - The issue link has expired.","originalRequest":{"url":{"path":["device-hub","wallets","issue"],"host":["{{baseUrl}}"],"query":[{"key":"clientUuid","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750"},{"key":"issueId","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750"},{"key":"hmac","value":"string"},{"key":"platform","value":"ANDROID"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Gone","code":410,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"0e6f9abe-01fe-491d-9cbc-d686278fff02","name":"Internal Server Error.\n","originalRequest":{"url":{"path":["device-hub","wallets","issue"],"host":["{{baseUrl}}"],"query":[{"key":"clientUuid","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750"},{"key":"issueId","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750"},{"key":"hmac","value":"string"},{"key":"platform","value":"ANDROID"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"90833c8f-6bef-48fa-8f54-9a4675c91a59","name":"Bad Gateway - another service or Google Wallet returned an error or is unreachable.\n","originalRequest":{"url":{"path":["device-hub","wallets","issue"],"host":["{{baseUrl}}"],"query":[{"key":"clientUuid","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750"},{"key":"issueId","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750"},{"key":"hmac","value":"string"},{"key":"platform","value":"ANDROID"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Bad Gateway","code":502,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"167b951a-2d0f-468b-85d6-cf2c6c71c66f","name":"Create wallet pass issue link","request":{"name":"Create wallet pass issue link","description":{"content":"**IMPORTANT**: This feature is in private preview mode and accessible only on selected workspaces. To get access, contact your account manager or Synerise Support.\n\n---\n\nCreate (or reuse) a wallet issue link for the authenticated workspace.\nThe link's origin is fetched from the given record under the\nwallet pass template. Calls with the same `recordId` and `expirationTime`\nreturn the same `issueId` (and therefore the same HMAC when `clientUuid` is not\nincluded in the signature).\n\nAfter using this endpoint, use the link from the response as a the request to the `/wallets/issue` endpoint.\n\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `WALLET_PASSES_UPDATE`\n\n**User role permission required:** `campaigns_wallets: update`\n","type":"text/plain"},"url":{"path":["device-hub","wallets","issue","link"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":null,"body":{"mode":"raw","raw":"{\n \"recordId\": \"82fc422a-7387-456d-5436-50ee16b854cb\",\n \"clientUuid\": \"da02f502-3ebf-be4f-0a11-6f2de1decf1d\",\n \"expirationTime\": \"2008-05-04T09:23:07.890Z\",\n \"eventParams\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\",\n \"key_2\": \"string\"\n },\n \"context\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\",\n \"key_2\": \"string\",\n \"key_3\": \"string\"\n }\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"98dbe450-63f0-4fb0-bf64-73194b2a8949","name":"OK","originalRequest":{"url":{"path":["device-hub","wallets","issue","link"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"recordId\": \"82fc422a-7387-456d-5436-50ee16b854cb\",\n \"clientUuid\": \"da02f502-3ebf-be4f-0a11-6f2de1decf1d\",\n \"expirationTime\": \"2008-05-04T09:23:07.890Z\",\n \"eventParams\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\",\n \"key_2\": \"string\"\n },\n \"context\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\",\n \"key_2\": \"string\",\n \"key_3\": \"string\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"link\": \"https://api.synerise.com/device-hub/wallets/issue?issueId=b40385e1-3394-48bc-86a5-000000000000&hmac=uX3Wa-wYwJdJ7Geinvldd1iWyAAfPEk\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"cbd93da1-5dcf-4c16-8bdf-0e3567c9ddb1","name":"Bad Request - Validation failed (missing/invalid recordId, or malformed UUID/Instant)","originalRequest":{"url":{"path":["device-hub","wallets","issue","link"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"recordId\": \"82fc422a-7387-456d-5436-50ee16b854cb\",\n \"clientUuid\": \"da02f502-3ebf-be4f-0a11-6f2de1decf1d\",\n \"expirationTime\": \"2008-05-04T09:23:07.890Z\",\n \"eventParams\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\",\n \"key_2\": \"string\"\n },\n \"context\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\",\n \"key_2\": \"string\",\n \"key_3\": \"string\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"83bc84d2-65df-4d59-99b0-f752abe4b45b","name":"Unauthorized","originalRequest":{"url":{"path":["device-hub","wallets","issue","link"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"recordId\": \"82fc422a-7387-456d-5436-50ee16b854cb\",\n \"clientUuid\": \"da02f502-3ebf-be4f-0a11-6f2de1decf1d\",\n \"expirationTime\": \"2008-05-04T09:23:07.890Z\",\n \"eventParams\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\",\n \"key_2\": \"string\"\n },\n \"context\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\",\n \"key_2\": \"string\",\n \"key_3\": \"string\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\",\n \"message\": \"string\",\n \"status\": 8,\n \"timestamp\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"9e4331e1-da26-4479-ae4a-c575305128bb","name":"Forbidden","originalRequest":{"url":{"path":["device-hub","wallets","issue","link"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"recordId\": \"82fc422a-7387-456d-5436-50ee16b854cb\",\n \"clientUuid\": \"da02f502-3ebf-be4f-0a11-6f2de1decf1d\",\n \"expirationTime\": \"2008-05-04T09:23:07.890Z\",\n \"eventParams\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\",\n \"key_2\": \"string\"\n },\n \"context\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\",\n \"key_2\": \"string\",\n \"key_3\": \"string\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\",\n \"message\": \"string\",\n \"status\": 8,\n \"timestamp\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"31d510ec-9f0b-419d-8b56-3e9b0afaf2c1","name":"Not Found - no such wallet pass template/record for this tenant","originalRequest":{"url":{"path":["device-hub","wallets","issue","link"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"recordId\": \"82fc422a-7387-456d-5436-50ee16b854cb\",\n \"clientUuid\": \"da02f502-3ebf-be4f-0a11-6f2de1decf1d\",\n \"expirationTime\": \"2008-05-04T09:23:07.890Z\",\n \"eventParams\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\",\n \"key_2\": \"string\"\n },\n \"context\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\",\n \"key_2\": \"string\",\n \"key_3\": \"string\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"357adcec-cb7b-4d46-b41b-ff6d7007b8fd","name":"Internal Server Error - unexpected error during request processing","originalRequest":{"url":{"path":["device-hub","wallets","issue","link"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"recordId\": \"82fc422a-7387-456d-5436-50ee16b854cb\",\n \"clientUuid\": \"da02f502-3ebf-be4f-0a11-6f2de1decf1d\",\n \"expirationTime\": \"2008-05-04T09:23:07.890Z\",\n \"eventParams\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\",\n \"key_2\": \"string\"\n },\n \"context\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\",\n \"key_2\": \"string\",\n \"key_3\": \"string\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"71a875ed-2802-4e86-bab7-16f6245cbe63","name":"Bad Gateway - external service returned 5xx or is unreachable","originalRequest":{"url":{"path":["device-hub","wallets","issue","link"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"recordId\": \"82fc422a-7387-456d-5436-50ee16b854cb\",\n \"clientUuid\": \"da02f502-3ebf-be4f-0a11-6f2de1decf1d\",\n \"expirationTime\": \"2008-05-04T09:23:07.890Z\",\n \"eventParams\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\",\n \"key_2\": \"string\"\n },\n \"context\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\",\n \"key_2\": \"string\",\n \"key_3\": \"string\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Gateway","code":502,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"83cc6b6a-4ee5-4587-8055-497f8fdf27cf","name":"Update wallet pass","request":{"name":"Update wallet pass","description":{"content":"**IMPORTANT**: This feature is in private preview mode and accessible only on selected workspaces. To get access, contact your account manager or Synerise Support.\n\n---\n\nQueue a wallet pass update for asynchronous update. The request is\nvalidated and enqueued and the endpoint return the HTTP 202 status. You must provide one profile identifier (`clientId` or `clientUuid`, but not both). \nThe system locates the pass and makes an update request to the associated service: Apple sends an APN background push (the device re-fetches the pass from the web service), Google PATCHes the wallet object.\n\nEach card emits one terminal event per platform — `walletPass.updated` on success or `walletPass.updateFailed` on failure, both always carrying the card's specific parameters. Failures add `cause=noDevicesFound` for an iOS pass with no registered device left (removed or automatic updates off, which are indistinguishable) or `error=` for any other Apple or Google failure, the sole exception being an iOS pass that was issued but never installed, which is skipped with no event at all.\n\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `WALLET_PASSES_UPDATE`\n\n**User role permission required:** `campaigns_wallets: update`\n","type":"text/plain"},"url":{"path":["device-hub","wallets","update"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":null,"body":{"mode":"raw","raw":"{\n \"recordId\": \"84c9c47a-e1e5-471c-40b8-0246b11afe08\",\n \"clientId\": 139,\n \"clientUuid\": \"903c0075-fee1-0fba-0c13-258fbce3993b\",\n \"platform\": \"IOS\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"0d2d5fc1-7d84-41e6-bdbd-7c20f0c81496","name":"Accepted - the update was enqueued and will be processed asynchronously","originalRequest":{"url":{"path":["device-hub","wallets","update"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"method":"POST","body":{"mode":"raw","raw":"{\n \"recordId\": \"84c9c47a-e1e5-471c-40b8-0246b11afe08\",\n \"clientId\": 139,\n \"clientUuid\": \"903c0075-fee1-0fba-0c13-258fbce3993b\",\n \"platform\": \"IOS\"\n}","options":{"raw":{"language":"json"}}}},"status":"Accepted","code":202,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"48682a35-17c1-4cc2-ad7c-5e7f6a3b0c65","name":"Bad Request - Validation failed (recordId missing, or not exactly one of clientId/clientUuid)","originalRequest":{"url":{"path":["device-hub","wallets","update"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"recordId\": \"84c9c47a-e1e5-471c-40b8-0246b11afe08\",\n \"clientId\": 139,\n \"clientUuid\": \"903c0075-fee1-0fba-0c13-258fbce3993b\",\n \"platform\": \"IOS\"\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"a0de49b1-5a29-426a-826a-cd384c5991eb","name":"Unauthorized","originalRequest":{"url":{"path":["device-hub","wallets","update"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"recordId\": \"84c9c47a-e1e5-471c-40b8-0246b11afe08\",\n \"clientId\": 139,\n \"clientUuid\": \"903c0075-fee1-0fba-0c13-258fbce3993b\",\n \"platform\": \"IOS\"\n}","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\",\n \"message\": \"string\",\n \"status\": 8,\n \"timestamp\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"8e7c30c1-563b-4da6-b194-419161e60cfe","name":"Forbidden","originalRequest":{"url":{"path":["device-hub","wallets","update"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"recordId\": \"84c9c47a-e1e5-471c-40b8-0246b11afe08\",\n \"clientId\": 139,\n \"clientUuid\": \"903c0075-fee1-0fba-0c13-258fbce3993b\",\n \"platform\": \"IOS\"\n}","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\",\n \"message\": \"string\",\n \"status\": 8,\n \"timestamp\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"e2eed87d-d400-401b-b82e-0200b20667e6","name":"Bad Gateway - failed to enqueue the command","originalRequest":{"url":{"path":["device-hub","wallets","update"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"recordId\": \"84c9c47a-e1e5-471c-40b8-0246b11afe08\",\n \"clientId\": 139,\n \"clientUuid\": \"903c0075-fee1-0fba-0c13-258fbce3993b\",\n \"platform\": \"IOS\"\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Gateway","code":502,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}],"event":[]},{"id":"86f885f4-3a36-4c04-bc79-2bed585cc823","name":"Screen views","description":{"content":"","type":"text/plain"},"item":[{"id":"814c2ba4-812b-4210-bfb9-5d68af4370e2","name":"Generate screen view from feed","request":{"name":"Generate screen view from feed","description":{"content":"When this method is called, the Synerise backend finds all screen view campaigns applicable to the JWT context and returns the screen view with the highest priority (1). Inserts are processed. If an insert can't be processed, the returned `data` is empty.\n\n**IMPORTANT**: When the request's context is a Workspace or Synerise User JWT, only screen views with the audience set to `ALL` (\"Everyone\" in the Synerise Web Application) can be generated.\n\nIf the feed doesn't contain any screen views whose audience matches the JWT context of the request, the response is error 404.\n\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User, Profile (Client), Anonymous Profile, Incognito Profile\n\n**API key permission required:** `SCHEMA_SERVICE_SCHEMA_READ`\n\n**User role permission required:** `assets_docs: read`\n","type":"text/plain"},"url":{"path":["schema-service","v3","screen-views",":feedSlug","generate"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"feedSlug","description":"(Required) Slug of the screen view feed"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"c6d82ef6-9af9-462f-b91b-03f07cca0d18","name":"Processed JSON content","originalRequest":{"url":{"path":["schema-service","v3","screen-views",":feedSlug","generate"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"feedSlug","description":"(Required) Slug of the screen view feed"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"id\": \"aa92d2ba-0872-e060-a0fe-88174ab6f136\",\n \"hash\": \"4c441c9e-c3f6-c990-3a8a-321f69aa6738\",\n \"priority\": 99,\n \"name\": \"string\",\n \"createdAt\": \"1948-12-30T07:35:55.570Z\",\n \"updatedAt\": \"1964-10-09T05:06:50.834Z\",\n \"audience\": {\n \"targetType\": {\n \"value\": \"\"\n },\n \"segments\": {\n \"value\": \"\"\n },\n \"query\": {\n \"value\": \"\"\n }\n },\n \"data\": {\n \"collection\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"key_0\": {},\n \"key_1\": {}\n },\n \"path\": \"/v2/screen-views/f9215cb9-4a7e-410b-88cb-8bc40363cc10\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"7c2983b4-d659-49e7-97d3-5111d9d298f3","name":"See error message for details","originalRequest":{"url":{"path":["schema-service","v3","screen-views",":feedSlug","generate"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"feedSlug","description":"(Required) Slug of the screen view feed"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"74357cf6-94e8-4db3-9126-23647aff62c2","name":"Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc.","originalRequest":{"url":{"path":["schema-service","v3","screen-views",":feedSlug","generate"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"feedSlug","description":"(Required) Slug of the screen view feed"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"string\",\n \"error\": \"string\",\n \"message\": \"string\",\n \"status\": 6404\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"f54fb96a-8bfe-4c4b-a99b-bb5faa6f7a85","name":"Forbidden; insufficient permissions","originalRequest":{"url":{"path":["schema-service","v3","screen-views",":feedSlug","generate"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"feedSlug","description":"(Required) Slug of the screen view feed"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"string\",\n \"error\": \"string\",\n \"message\": \"string\",\n \"status\": 6404\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"cba3183f-56c7-45bd-a3db-db53a78378a6","name":"Resource not found","originalRequest":{"url":{"path":["schema-service","v3","screen-views",":feedSlug","generate"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"feedSlug","description":"(Required) Slug of the screen view feed"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"0084b839-1935-4274-bc4f-f24466ef1f72","name":"See error message for details","originalRequest":{"url":{"path":["schema-service","v3","screen-views",":feedSlug","generate"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"feedSlug","description":"(Required) Slug of the screen view feed"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"c100ef37-5a33-4794-bffb-edb2d0577243","name":"Generate screen view from feed","request":{"name":"Generate screen view from feed","description":{"content":"When this method is called, the Synerise backend finds all screen view campaigns applicable to the JWT context and returns the screen view with the highest priority (1). Inserts are processed. If an insert can't be processed, the returned `data` is empty.\n\n**IMPORTANT**: When the request's context is a Workspace or Synerise User JWT, only screen views with the audience set to `ALL` (\"Everyone\" in the Synerise Web Application) can be generated.\n\nIf the feed doesn't contain any screen views whose audience matches the JWT context of the request, the response is error 404.\n\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User, Profile (Client), Anonymous Profile, Incognito Profile\n\n**API key permission required:** `SCHEMA_SERVICE_SCHEMA_READ`\n\n**User role permission required:** `assets_docs: read`\n","type":"text/plain"},"url":{"path":["schema-service","v3","screen-views",":feedSlug","generate"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"feedSlug","description":"(Required) Slug of the screen view feed"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"8bfaf1cb-f652-4f69-9b67-2e57390ae8a8","name":"Processed JSON content","originalRequest":{"url":{"path":["schema-service","v3","screen-views",":feedSlug","generate"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"feedSlug","description":"(Required) Slug of the screen view feed"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"id\": \"050d96b4-1927-42f5-5c35-227c8cd9164d\",\n \"hash\": \"51f3f9e4-1cc8-c2a9-e86b-a4b487566e75\",\n \"priority\": 99,\n \"name\": \"string\",\n \"createdAt\": \"1989-10-28T23:03:27.289Z\",\n \"updatedAt\": \"1999-01-02T00:05:22.456Z\",\n \"audience\": {\n \"targetType\": {\n \"value\": \"\"\n },\n \"segments\": {\n \"value\": \"\"\n },\n \"query\": {\n \"value\": \"\"\n }\n },\n \"data\": {\n \"collection\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"key_0\": {}\n },\n \"path\": \"/v2/screen-views/f9215cb9-4a7e-410b-88cb-8bc40363cc10\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"1d80a2e9-24c8-4e82-9b44-f6ff9a1992cc","name":"See error message for details","originalRequest":{"url":{"path":["schema-service","v3","screen-views",":feedSlug","generate"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"feedSlug","description":"(Required) Slug of the screen view feed"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"504060c1-7189-4d40-9a00-1f13a7599b77","name":"Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc.","originalRequest":{"url":{"path":["schema-service","v3","screen-views",":feedSlug","generate"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"feedSlug","description":"(Required) Slug of the screen view feed"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"string\",\n \"error\": \"string\",\n \"message\": \"string\",\n \"status\": 6404\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"be2b5a41-d202-44c8-a551-7b247721d7d5","name":"Forbidden; insufficient permissions","originalRequest":{"url":{"path":["schema-service","v3","screen-views",":feedSlug","generate"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"feedSlug","description":"(Required) Slug of the screen view feed"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"string\",\n \"error\": \"string\",\n \"message\": \"string\",\n \"status\": 6404\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"be36619b-1acb-46f8-890b-183816b2cf67","name":"Resource not found","originalRequest":{"url":{"path":["schema-service","v3","screen-views",":feedSlug","generate"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"feedSlug","description":"(Required) Slug of the screen view feed"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"277c31e2-625b-473e-ba06-65cfe75052d7","name":"See error message for details","originalRequest":{"url":{"path":["schema-service","v3","screen-views",":feedSlug","generate"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"feedSlug","description":"(Required) Slug of the screen view feed"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"728aa15d-2454-479d-960b-65cd69e4ee24","name":"Create screen view","request":{"name":"Create screen view","description":{"content":"Create a screen view.\n\n---\n\n**API consumer:** Synerise User\n\n**User role permission required:** `assets_docs: create`\n","type":"text/plain"},"url":{"path":["schema-service","screen-views","create"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"priority\": 99,\n \"directoryId\": \"eda84457-0194-3e69-f250-8f2af9bc4d95\",\n \"content\": {\n \"json\": {\n \"value\": \"\"\n },\n \"documents\": {\n \"value\": \"\"\n },\n \"groups\": {\n \"value\": \"\"\n },\n \"data\": {\n \"value\": \"\"\n },\n \"groupsOrder\": {\n \"value\": \"\"\n }\n },\n \"audience\": {\n \"targetType\": {\n \"value\": \"\"\n },\n \"segments\": {\n \"value\": \"\"\n },\n \"query\": {\n \"value\": \"\"\n }\n },\n \"feedId\": \"fa60fca1-25d9-78fa-307f-9678dd9749ff\",\n \"name\": \"string\",\n \"schedule\": {\n \"enabled\": {\n \"value\": \"\"\n },\n \"endDate\": {\n \"value\": \"\"\n },\n \"endType\": {\n \"value\": \"\"\n },\n \"parts\": {\n \"value\": \"\"\n },\n \"periodType\": {\n \"value\": \"\"\n },\n \"startDate\": {\n \"value\": \"\"\n },\n \"startType\": {\n \"value\": \"\"\n },\n \"timezone\": {\n \"value\": \"\"\n }\n }\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"e94633cc-a266-4b6f-bf58-62f4d1711e28","name":"Success","originalRequest":{"url":{"path":["schema-service","screen-views","create"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"priority\": 99,\n \"directoryId\": \"eda84457-0194-3e69-f250-8f2af9bc4d95\",\n \"content\": {\n \"json\": {\n \"value\": \"\"\n },\n \"documents\": {\n \"value\": \"\"\n },\n \"groups\": {\n \"value\": \"\"\n },\n \"data\": {\n \"value\": \"\"\n },\n \"groupsOrder\": {\n \"value\": \"\"\n }\n },\n \"audience\": {\n \"targetType\": {\n \"value\": \"\"\n },\n \"segments\": {\n \"value\": \"\"\n },\n \"query\": {\n \"value\": \"\"\n }\n },\n \"feedId\": \"fa60fca1-25d9-78fa-307f-9678dd9749ff\",\n \"name\": \"string\",\n \"schedule\": {\n \"enabled\": {\n \"value\": \"\"\n },\n \"endDate\": {\n \"value\": \"\"\n },\n \"endType\": {\n \"value\": \"\"\n },\n \"parts\": {\n \"value\": \"\"\n },\n \"periodType\": {\n \"value\": \"\"\n },\n \"startDate\": {\n \"value\": \"\"\n },\n \"startType\": {\n \"value\": \"\"\n },\n \"timezone\": {\n \"value\": \"\"\n }\n }\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"id\": \"eaf836cb-6920-010e-d828-1064f89c04f6\",\n \"businessProfileId\": 9067,\n \"name\": \"string\",\n \"status\": \"SCHEDULED\",\n \"priority\": 99,\n \"scheduled\": false,\n \"author\": {\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"avatar\": {\n \"value\": \"\"\n }\n },\n \"content\": {\n \"json\": {\n \"value\": \"\"\n },\n \"documents\": {\n \"value\": \"\"\n },\n \"groups\": {\n \"value\": \"\"\n },\n \"data\": {\n \"value\": \"\"\n },\n \"groupsOrder\": {\n \"value\": \"\"\n }\n },\n \"audience\": {\n \"targetType\": {\n \"value\": \"\"\n },\n \"segments\": {\n \"value\": \"\"\n },\n \"query\": {\n \"value\": \"\"\n }\n },\n \"createdAt\": \"2022-09-08T07:32:03.255Z\",\n \"updatedAt\": \"1963-04-30T03:52:50.562Z\",\n \"directory\": {\n \"value\": \"\"\n },\n \"feed\": {\n \"value\": \"\"\n },\n \"description\": \"string\",\n \"deletedAt\": \"2016-03-20T13:47:57.366Z\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"6dc3a3d5-054b-47f2-8fbb-fe896c11af5f","name":"See error message for details","originalRequest":{"url":{"path":["schema-service","screen-views","create"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"priority\": 99,\n \"directoryId\": \"eda84457-0194-3e69-f250-8f2af9bc4d95\",\n \"content\": {\n \"json\": {\n \"value\": \"\"\n },\n \"documents\": {\n \"value\": \"\"\n },\n \"groups\": {\n \"value\": \"\"\n },\n \"data\": {\n \"value\": \"\"\n },\n \"groupsOrder\": {\n \"value\": \"\"\n }\n },\n \"audience\": {\n \"targetType\": {\n \"value\": \"\"\n },\n \"segments\": {\n \"value\": \"\"\n },\n \"query\": {\n \"value\": \"\"\n }\n },\n \"feedId\": \"fa60fca1-25d9-78fa-307f-9678dd9749ff\",\n \"name\": \"string\",\n \"schedule\": {\n \"enabled\": {\n \"value\": \"\"\n },\n \"endDate\": {\n \"value\": \"\"\n },\n \"endType\": {\n \"value\": \"\"\n },\n \"parts\": {\n \"value\": \"\"\n },\n \"periodType\": {\n \"value\": \"\"\n },\n \"startDate\": {\n \"value\": \"\"\n },\n \"startType\": {\n \"value\": \"\"\n },\n \"timezone\": {\n \"value\": \"\"\n }\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"fa7aed13-aec7-492e-81c0-49f91737e128","name":"Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc.","originalRequest":{"url":{"path":["schema-service","screen-views","create"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"priority\": 99,\n \"directoryId\": \"eda84457-0194-3e69-f250-8f2af9bc4d95\",\n \"content\": {\n \"json\": {\n \"value\": \"\"\n },\n \"documents\": {\n \"value\": \"\"\n },\n \"groups\": {\n \"value\": \"\"\n },\n \"data\": {\n \"value\": \"\"\n },\n \"groupsOrder\": {\n \"value\": \"\"\n }\n },\n \"audience\": {\n \"targetType\": {\n \"value\": \"\"\n },\n \"segments\": {\n \"value\": \"\"\n },\n \"query\": {\n \"value\": \"\"\n }\n },\n \"feedId\": \"fa60fca1-25d9-78fa-307f-9678dd9749ff\",\n \"name\": \"string\",\n \"schedule\": {\n \"enabled\": {\n \"value\": \"\"\n },\n \"endDate\": {\n \"value\": \"\"\n },\n \"endType\": {\n \"value\": \"\"\n },\n \"parts\": {\n \"value\": \"\"\n },\n \"periodType\": {\n \"value\": \"\"\n },\n \"startDate\": {\n \"value\": \"\"\n },\n \"startType\": {\n \"value\": \"\"\n },\n \"timezone\": {\n \"value\": \"\"\n }\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"string\",\n \"error\": \"string\",\n \"message\": \"string\",\n \"status\": 6404\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"b5fa908e-cbc5-428d-93c4-ae25feca0973","name":"Forbidden; insufficient permissions","originalRequest":{"url":{"path":["schema-service","screen-views","create"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"priority\": 99,\n \"directoryId\": \"eda84457-0194-3e69-f250-8f2af9bc4d95\",\n \"content\": {\n \"json\": {\n \"value\": \"\"\n },\n \"documents\": {\n \"value\": \"\"\n },\n \"groups\": {\n \"value\": \"\"\n },\n \"data\": {\n \"value\": \"\"\n },\n \"groupsOrder\": {\n \"value\": \"\"\n }\n },\n \"audience\": {\n \"targetType\": {\n \"value\": \"\"\n },\n \"segments\": {\n \"value\": \"\"\n },\n \"query\": {\n \"value\": \"\"\n }\n },\n \"feedId\": \"fa60fca1-25d9-78fa-307f-9678dd9749ff\",\n \"name\": \"string\",\n \"schedule\": {\n \"enabled\": {\n \"value\": \"\"\n },\n \"endDate\": {\n \"value\": \"\"\n },\n \"endType\": {\n \"value\": \"\"\n },\n \"parts\": {\n \"value\": \"\"\n },\n \"periodType\": {\n \"value\": \"\"\n },\n \"startDate\": {\n \"value\": \"\"\n },\n \"startType\": {\n \"value\": \"\"\n },\n \"timezone\": {\n \"value\": \"\"\n }\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"string\",\n \"error\": \"string\",\n \"message\": \"string\",\n \"status\": 6404\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"9febf4dc-aebc-450d-ba6f-96700d0d982d","name":"Resource not found","originalRequest":{"url":{"path":["schema-service","screen-views","create"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"priority\": 99,\n \"directoryId\": \"eda84457-0194-3e69-f250-8f2af9bc4d95\",\n \"content\": {\n \"json\": {\n \"value\": \"\"\n },\n \"documents\": {\n \"value\": \"\"\n },\n \"groups\": {\n \"value\": \"\"\n },\n \"data\": {\n \"value\": \"\"\n },\n \"groupsOrder\": {\n \"value\": \"\"\n }\n },\n \"audience\": {\n \"targetType\": {\n \"value\": \"\"\n },\n \"segments\": {\n \"value\": \"\"\n },\n \"query\": {\n \"value\": \"\"\n }\n },\n \"feedId\": \"fa60fca1-25d9-78fa-307f-9678dd9749ff\",\n \"name\": \"string\",\n \"schedule\": {\n \"enabled\": {\n \"value\": \"\"\n },\n \"endDate\": {\n \"value\": \"\"\n },\n \"endType\": {\n \"value\": \"\"\n },\n \"parts\": {\n \"value\": \"\"\n },\n \"periodType\": {\n \"value\": \"\"\n },\n \"startDate\": {\n \"value\": \"\"\n },\n \"startType\": {\n \"value\": \"\"\n },\n \"timezone\": {\n \"value\": \"\"\n }\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"58c0b4a2-ed04-405f-8699-fc94b859f863","name":"See error message for details","originalRequest":{"url":{"path":["schema-service","screen-views","create"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"priority\": 99,\n \"directoryId\": \"eda84457-0194-3e69-f250-8f2af9bc4d95\",\n \"content\": {\n \"json\": {\n \"value\": \"\"\n },\n \"documents\": {\n \"value\": \"\"\n },\n \"groups\": {\n \"value\": \"\"\n },\n \"data\": {\n \"value\": \"\"\n },\n \"groupsOrder\": {\n \"value\": \"\"\n }\n },\n \"audience\": {\n \"targetType\": {\n \"value\": \"\"\n },\n \"segments\": {\n \"value\": \"\"\n },\n \"query\": {\n \"value\": \"\"\n }\n },\n \"feedId\": \"fa60fca1-25d9-78fa-307f-9678dd9749ff\",\n \"name\": \"string\",\n \"schedule\": {\n \"enabled\": {\n \"value\": \"\"\n },\n \"endDate\": {\n \"value\": \"\"\n },\n \"endType\": {\n \"value\": \"\"\n },\n \"parts\": {\n \"value\": \"\"\n },\n \"periodType\": {\n \"value\": \"\"\n },\n \"startDate\": {\n \"value\": \"\"\n },\n \"startType\": {\n \"value\": \"\"\n },\n \"timezone\": {\n \"value\": \"\"\n }\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"42399197-f3cb-42cb-bb1b-58cf1ab68205","name":"Initialize screen view","request":{"name":"Initialize screen view","description":{"content":"Create a screen view. It is created as a blank, without any conditions.\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User\n\n**API key permission required:** `SCHEMA_SERVICE_SCHEMA_CREATE`\n\n**User role permission required:** `assets_docs: create`\n","type":"text/plain"},"url":{"path":["schema-service","v2","screen-views","createNew"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"name\": \"string\",\n \"directory\": \"354acd68-b73d-498a-be94-37f681f607bb\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"492f613e-825c-42cc-b75f-ed0e484625db","name":"Success","originalRequest":{"url":{"path":["schema-service","v2","screen-views","createNew"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"name\": \"string\",\n \"directory\": \"354acd68-b73d-498a-be94-37f681f607bb\"\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"id\": \"eaf836cb-6920-010e-d828-1064f89c04f6\",\n \"businessProfileId\": 9067,\n \"name\": \"string\",\n \"status\": \"SCHEDULED\",\n \"priority\": 99,\n \"scheduled\": false,\n \"author\": {\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"avatar\": {\n \"value\": \"\"\n }\n },\n \"content\": {\n \"json\": {\n \"value\": \"\"\n },\n \"documents\": {\n \"value\": \"\"\n },\n \"groups\": {\n \"value\": \"\"\n },\n \"data\": {\n \"value\": \"\"\n },\n \"groupsOrder\": {\n \"value\": \"\"\n }\n },\n \"audience\": {\n \"targetType\": {\n \"value\": \"\"\n },\n \"segments\": {\n \"value\": \"\"\n },\n \"query\": {\n \"value\": \"\"\n }\n },\n \"createdAt\": \"2022-09-08T07:32:03.255Z\",\n \"updatedAt\": \"1963-04-30T03:52:50.562Z\",\n \"directory\": {\n \"value\": \"\"\n },\n \"feed\": {\n \"value\": \"\"\n },\n \"description\": \"string\",\n \"deletedAt\": \"2016-03-20T13:47:57.366Z\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"ed8ac8be-72c0-426f-940e-e4466a56ee75","name":"See error message for details","originalRequest":{"url":{"path":["schema-service","v2","screen-views","createNew"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"name\": \"string\",\n \"directory\": \"354acd68-b73d-498a-be94-37f681f607bb\"\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"8fa80c0b-4d4d-4ca0-a63a-349dd57dea06","name":"Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc.","originalRequest":{"url":{"path":["schema-service","v2","screen-views","createNew"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"name\": \"string\",\n \"directory\": \"354acd68-b73d-498a-be94-37f681f607bb\"\n}","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"string\",\n \"error\": \"string\",\n \"message\": \"string\",\n \"status\": 6404\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"143786d6-4525-42d3-89be-a01f07eef038","name":"Forbidden; insufficient permissions","originalRequest":{"url":{"path":["schema-service","v2","screen-views","createNew"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"name\": \"string\",\n \"directory\": \"354acd68-b73d-498a-be94-37f681f607bb\"\n}","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"string\",\n \"error\": \"string\",\n \"message\": \"string\",\n \"status\": 6404\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"65569cb0-c490-4ab2-9095-b3b17033b5a6","name":"Resource not found","originalRequest":{"url":{"path":["schema-service","v2","screen-views","createNew"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"name\": \"string\",\n \"directory\": \"354acd68-b73d-498a-be94-37f681f607bb\"\n}","options":{"raw":{"language":"json"}}}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"1bc75c6a-dce7-4305-9a47-b9c3312015f3","name":"See error message for details","originalRequest":{"url":{"path":["schema-service","v2","screen-views","createNew"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"name\": \"string\",\n \"directory\": \"354acd68-b73d-498a-be94-37f681f607bb\"\n}","options":{"raw":{"language":"json"}}}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"cc6bc2d6-8610-451f-acea-ad2fdfb04dbb","name":"Add content to screen view","request":{"name":"Add content to screen view","description":{"content":"Add content to a screen view. This overwrites any existing content.\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User\n\n**API key permission required:** `SCHEMA_SERVICE_SCHEMA_CREATE`\n\n**User role permission required:** `assets_docs: create`\n","type":"text/plain"},"url":{"path":["schema-service","v2","screen-views",":screenViewId","content"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"screenViewId","description":"(Required) UUID of the screen view"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"json\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n }\n },\n \"documents\": [\n \"string\",\n \"string\"\n ],\n \"groups\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"data\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"groupsOrder\": false\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"a95b233e-3226-46c4-8788-bcf06fbc5846","name":"Success","originalRequest":{"url":{"path":["schema-service","v2","screen-views",":screenViewId","content"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"screenViewId","description":"(Required) UUID of the screen view"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"json\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n }\n },\n \"documents\": [\n \"string\",\n \"string\"\n ],\n \"groups\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"data\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"groupsOrder\": false\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"status\": \"string\",\n \"body\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"29c4d0e7-80e3-49a2-a1a6-3343a4ae9caf","name":"See error message for details","originalRequest":{"url":{"path":["schema-service","v2","screen-views",":screenViewId","content"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"screenViewId","description":"(Required) UUID of the screen view"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"json\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n }\n },\n \"documents\": [\n \"string\",\n \"string\"\n ],\n \"groups\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"data\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"groupsOrder\": false\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"04d4640f-775a-4ad2-86b8-67f107d6dedf","name":"Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc.","originalRequest":{"url":{"path":["schema-service","v2","screen-views",":screenViewId","content"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"screenViewId","description":"(Required) UUID of the screen view"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"json\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n }\n },\n \"documents\": [\n \"string\",\n \"string\"\n ],\n \"groups\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"data\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"groupsOrder\": false\n}","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"string\",\n \"error\": \"string\",\n \"message\": \"string\",\n \"status\": 6404\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"16863c37-43b5-4cd9-92fd-2d80af2a0177","name":"Forbidden; insufficient permissions","originalRequest":{"url":{"path":["schema-service","v2","screen-views",":screenViewId","content"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"screenViewId","description":"(Required) UUID of the screen view"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"json\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n }\n },\n \"documents\": [\n \"string\",\n \"string\"\n ],\n \"groups\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"data\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"groupsOrder\": false\n}","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"string\",\n \"error\": \"string\",\n \"message\": \"string\",\n \"status\": 6404\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"053752d0-db73-4ccc-b28a-5edcc2cabe0b","name":"Resource not found","originalRequest":{"url":{"path":["schema-service","v2","screen-views",":screenViewId","content"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"screenViewId","description":"(Required) UUID of the screen view"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"json\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n }\n },\n \"documents\": [\n \"string\",\n \"string\"\n ],\n \"groups\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"data\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"groupsOrder\": false\n}","options":{"raw":{"language":"json"}}}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"0ceeb90e-2135-442a-9dfc-28318fd948f1","name":"See error message for details","originalRequest":{"url":{"path":["schema-service","v2","screen-views",":screenViewId","content"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"screenViewId","description":"(Required) UUID of the screen view"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"json\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n }\n },\n \"documents\": [\n \"string\",\n \"string\"\n ],\n \"groups\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"data\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"groupsOrder\": false\n}","options":{"raw":{"language":"json"}}}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"194ff7b1-5e18-4c25-9aec-30721c1b911f","name":"Add audience to screen view","request":{"name":"Add audience to screen view","description":{"content":"Define the audience for a screen view.\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User\n\n**API key permission required:** `SCHEMA_SERVICE_SCHEMA_CREATE`\n\n**User role permission required:** `assets_docs: create`\n","type":"text/plain"},"url":{"path":["schema-service","v2","screen-views",":screenViewId","audience"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"screenViewId","description":"(Required) UUID of the screen view"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"targetType\": \"SEGMENT\",\n \"segments\": [\n \"string\",\n \"string\"\n ],\n \"query\": \"{\\\"analysis\\\":{\\\"title\\\":\\\"Unnamed segmentation\\\",\\\"description\\\":\\\"\\\",\\\"unique\\\":true,\\\"segments\\\":[{\\\"title\\\":\\\"Segmentation A\\\",\\\"description\\\":\\\"\\\",\\\"filter\\\":{\\\"matching\\\":true,\\\"expressions\\\":[{\\\"_id\\\":\\\"a9b76c8e-34bd-4ac3-be8f-f37041d126bd\\\",\\\"name\\\":\\\"\\\",\\\"type\\\":\\\"FUNNEL\\\",\\\"matching\\\":true,\\\"funnel\\\":{\\\"_id\\\":\\\"5c759d73-49c6-409f-96a3-b569dff8f8ff\\\",\\\"title\\\":\\\"Unnamed\\\",\\\"completedWithin\\\":null,\\\"dateFilter\\\":{\\\"type\\\":\\\"RELATIVE\\\",\\\"offset\\\":{\\\"type\\\":\\\"DAYS\\\",\\\"value\\\":0},\\\"duration\\\":{\\\"type\\\":\\\"DAYS\\\",\\\"value\\\":30}},\\\"steps\\\":[{\\\"_id\\\":\\\"78b97ae0-1bc5-45fb-82a4-4f1280cfbdff\\\",\\\"title\\\":\\\"\\\",\\\"action\\\":{\\\"id\\\":944,\\\"name\\\":\\\"page.visit\\\"},\\\"eventName\\\":\\\"page.visit\\\",\\\"expressions\\\":[]}],\\\"exact\\\":false}}]}}]}}\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"d8c01af0-a964-4c18-8455-078b162a09f2","name":"Success","originalRequest":{"url":{"path":["schema-service","v2","screen-views",":screenViewId","audience"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"screenViewId","description":"(Required) UUID of the screen view"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"targetType\": \"SEGMENT\",\n \"segments\": [\n \"string\",\n \"string\"\n ],\n \"query\": \"{\\\"analysis\\\":{\\\"title\\\":\\\"Unnamed segmentation\\\",\\\"description\\\":\\\"\\\",\\\"unique\\\":true,\\\"segments\\\":[{\\\"title\\\":\\\"Segmentation A\\\",\\\"description\\\":\\\"\\\",\\\"filter\\\":{\\\"matching\\\":true,\\\"expressions\\\":[{\\\"_id\\\":\\\"a9b76c8e-34bd-4ac3-be8f-f37041d126bd\\\",\\\"name\\\":\\\"\\\",\\\"type\\\":\\\"FUNNEL\\\",\\\"matching\\\":true,\\\"funnel\\\":{\\\"_id\\\":\\\"5c759d73-49c6-409f-96a3-b569dff8f8ff\\\",\\\"title\\\":\\\"Unnamed\\\",\\\"completedWithin\\\":null,\\\"dateFilter\\\":{\\\"type\\\":\\\"RELATIVE\\\",\\\"offset\\\":{\\\"type\\\":\\\"DAYS\\\",\\\"value\\\":0},\\\"duration\\\":{\\\"type\\\":\\\"DAYS\\\",\\\"value\\\":30}},\\\"steps\\\":[{\\\"_id\\\":\\\"78b97ae0-1bc5-45fb-82a4-4f1280cfbdff\\\",\\\"title\\\":\\\"\\\",\\\"action\\\":{\\\"id\\\":944,\\\"name\\\":\\\"page.visit\\\"},\\\"eventName\\\":\\\"page.visit\\\",\\\"expressions\\\":[]}],\\\"exact\\\":false}}]}}]}}\"\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"status\": \"string\",\n \"body\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"d875a484-aa72-4e25-a7d7-1a80c0df1841","name":"See error message for details","originalRequest":{"url":{"path":["schema-service","v2","screen-views",":screenViewId","audience"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"screenViewId","description":"(Required) UUID of the screen view"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"targetType\": \"SEGMENT\",\n \"segments\": [\n \"string\",\n \"string\"\n ],\n \"query\": \"{\\\"analysis\\\":{\\\"title\\\":\\\"Unnamed segmentation\\\",\\\"description\\\":\\\"\\\",\\\"unique\\\":true,\\\"segments\\\":[{\\\"title\\\":\\\"Segmentation A\\\",\\\"description\\\":\\\"\\\",\\\"filter\\\":{\\\"matching\\\":true,\\\"expressions\\\":[{\\\"_id\\\":\\\"a9b76c8e-34bd-4ac3-be8f-f37041d126bd\\\",\\\"name\\\":\\\"\\\",\\\"type\\\":\\\"FUNNEL\\\",\\\"matching\\\":true,\\\"funnel\\\":{\\\"_id\\\":\\\"5c759d73-49c6-409f-96a3-b569dff8f8ff\\\",\\\"title\\\":\\\"Unnamed\\\",\\\"completedWithin\\\":null,\\\"dateFilter\\\":{\\\"type\\\":\\\"RELATIVE\\\",\\\"offset\\\":{\\\"type\\\":\\\"DAYS\\\",\\\"value\\\":0},\\\"duration\\\":{\\\"type\\\":\\\"DAYS\\\",\\\"value\\\":30}},\\\"steps\\\":[{\\\"_id\\\":\\\"78b97ae0-1bc5-45fb-82a4-4f1280cfbdff\\\",\\\"title\\\":\\\"\\\",\\\"action\\\":{\\\"id\\\":944,\\\"name\\\":\\\"page.visit\\\"},\\\"eventName\\\":\\\"page.visit\\\",\\\"expressions\\\":[]}],\\\"exact\\\":false}}]}}]}}\"\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"e4e737a0-5bcd-4ca8-9fb1-685a9286fa11","name":"Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc.","originalRequest":{"url":{"path":["schema-service","v2","screen-views",":screenViewId","audience"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"screenViewId","description":"(Required) UUID of the screen view"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"targetType\": \"SEGMENT\",\n \"segments\": [\n \"string\",\n \"string\"\n ],\n \"query\": \"{\\\"analysis\\\":{\\\"title\\\":\\\"Unnamed segmentation\\\",\\\"description\\\":\\\"\\\",\\\"unique\\\":true,\\\"segments\\\":[{\\\"title\\\":\\\"Segmentation A\\\",\\\"description\\\":\\\"\\\",\\\"filter\\\":{\\\"matching\\\":true,\\\"expressions\\\":[{\\\"_id\\\":\\\"a9b76c8e-34bd-4ac3-be8f-f37041d126bd\\\",\\\"name\\\":\\\"\\\",\\\"type\\\":\\\"FUNNEL\\\",\\\"matching\\\":true,\\\"funnel\\\":{\\\"_id\\\":\\\"5c759d73-49c6-409f-96a3-b569dff8f8ff\\\",\\\"title\\\":\\\"Unnamed\\\",\\\"completedWithin\\\":null,\\\"dateFilter\\\":{\\\"type\\\":\\\"RELATIVE\\\",\\\"offset\\\":{\\\"type\\\":\\\"DAYS\\\",\\\"value\\\":0},\\\"duration\\\":{\\\"type\\\":\\\"DAYS\\\",\\\"value\\\":30}},\\\"steps\\\":[{\\\"_id\\\":\\\"78b97ae0-1bc5-45fb-82a4-4f1280cfbdff\\\",\\\"title\\\":\\\"\\\",\\\"action\\\":{\\\"id\\\":944,\\\"name\\\":\\\"page.visit\\\"},\\\"eventName\\\":\\\"page.visit\\\",\\\"expressions\\\":[]}],\\\"exact\\\":false}}]}}]}}\"\n}","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"string\",\n \"error\": \"string\",\n \"message\": \"string\",\n \"status\": 6404\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"39e1d585-a751-4f87-9550-1eb950722e74","name":"Forbidden; insufficient permissions","originalRequest":{"url":{"path":["schema-service","v2","screen-views",":screenViewId","audience"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"screenViewId","description":"(Required) UUID of the screen view"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"targetType\": \"SEGMENT\",\n \"segments\": [\n \"string\",\n \"string\"\n ],\n \"query\": \"{\\\"analysis\\\":{\\\"title\\\":\\\"Unnamed segmentation\\\",\\\"description\\\":\\\"\\\",\\\"unique\\\":true,\\\"segments\\\":[{\\\"title\\\":\\\"Segmentation A\\\",\\\"description\\\":\\\"\\\",\\\"filter\\\":{\\\"matching\\\":true,\\\"expressions\\\":[{\\\"_id\\\":\\\"a9b76c8e-34bd-4ac3-be8f-f37041d126bd\\\",\\\"name\\\":\\\"\\\",\\\"type\\\":\\\"FUNNEL\\\",\\\"matching\\\":true,\\\"funnel\\\":{\\\"_id\\\":\\\"5c759d73-49c6-409f-96a3-b569dff8f8ff\\\",\\\"title\\\":\\\"Unnamed\\\",\\\"completedWithin\\\":null,\\\"dateFilter\\\":{\\\"type\\\":\\\"RELATIVE\\\",\\\"offset\\\":{\\\"type\\\":\\\"DAYS\\\",\\\"value\\\":0},\\\"duration\\\":{\\\"type\\\":\\\"DAYS\\\",\\\"value\\\":30}},\\\"steps\\\":[{\\\"_id\\\":\\\"78b97ae0-1bc5-45fb-82a4-4f1280cfbdff\\\",\\\"title\\\":\\\"\\\",\\\"action\\\":{\\\"id\\\":944,\\\"name\\\":\\\"page.visit\\\"},\\\"eventName\\\":\\\"page.visit\\\",\\\"expressions\\\":[]}],\\\"exact\\\":false}}]}}]}}\"\n}","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"string\",\n \"error\": \"string\",\n \"message\": \"string\",\n \"status\": 6404\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"092b770a-7e95-4d47-a21c-56f33546e940","name":"Resource not found","originalRequest":{"url":{"path":["schema-service","v2","screen-views",":screenViewId","audience"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"screenViewId","description":"(Required) UUID of the screen view"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"targetType\": \"SEGMENT\",\n \"segments\": [\n \"string\",\n \"string\"\n ],\n \"query\": \"{\\\"analysis\\\":{\\\"title\\\":\\\"Unnamed segmentation\\\",\\\"description\\\":\\\"\\\",\\\"unique\\\":true,\\\"segments\\\":[{\\\"title\\\":\\\"Segmentation A\\\",\\\"description\\\":\\\"\\\",\\\"filter\\\":{\\\"matching\\\":true,\\\"expressions\\\":[{\\\"_id\\\":\\\"a9b76c8e-34bd-4ac3-be8f-f37041d126bd\\\",\\\"name\\\":\\\"\\\",\\\"type\\\":\\\"FUNNEL\\\",\\\"matching\\\":true,\\\"funnel\\\":{\\\"_id\\\":\\\"5c759d73-49c6-409f-96a3-b569dff8f8ff\\\",\\\"title\\\":\\\"Unnamed\\\",\\\"completedWithin\\\":null,\\\"dateFilter\\\":{\\\"type\\\":\\\"RELATIVE\\\",\\\"offset\\\":{\\\"type\\\":\\\"DAYS\\\",\\\"value\\\":0},\\\"duration\\\":{\\\"type\\\":\\\"DAYS\\\",\\\"value\\\":30}},\\\"steps\\\":[{\\\"_id\\\":\\\"78b97ae0-1bc5-45fb-82a4-4f1280cfbdff\\\",\\\"title\\\":\\\"\\\",\\\"action\\\":{\\\"id\\\":944,\\\"name\\\":\\\"page.visit\\\"},\\\"eventName\\\":\\\"page.visit\\\",\\\"expressions\\\":[]}],\\\"exact\\\":false}}]}}]}}\"\n}","options":{"raw":{"language":"json"}}}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"a0680e34-f1d2-45a3-991d-95d5f9e8f5eb","name":"See error message for details","originalRequest":{"url":{"path":["schema-service","v2","screen-views",":screenViewId","audience"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"screenViewId","description":"(Required) UUID of the screen view"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"targetType\": \"SEGMENT\",\n \"segments\": [\n \"string\",\n \"string\"\n ],\n \"query\": \"{\\\"analysis\\\":{\\\"title\\\":\\\"Unnamed segmentation\\\",\\\"description\\\":\\\"\\\",\\\"unique\\\":true,\\\"segments\\\":[{\\\"title\\\":\\\"Segmentation A\\\",\\\"description\\\":\\\"\\\",\\\"filter\\\":{\\\"matching\\\":true,\\\"expressions\\\":[{\\\"_id\\\":\\\"a9b76c8e-34bd-4ac3-be8f-f37041d126bd\\\",\\\"name\\\":\\\"\\\",\\\"type\\\":\\\"FUNNEL\\\",\\\"matching\\\":true,\\\"funnel\\\":{\\\"_id\\\":\\\"5c759d73-49c6-409f-96a3-b569dff8f8ff\\\",\\\"title\\\":\\\"Unnamed\\\",\\\"completedWithin\\\":null,\\\"dateFilter\\\":{\\\"type\\\":\\\"RELATIVE\\\",\\\"offset\\\":{\\\"type\\\":\\\"DAYS\\\",\\\"value\\\":0},\\\"duration\\\":{\\\"type\\\":\\\"DAYS\\\",\\\"value\\\":30}},\\\"steps\\\":[{\\\"_id\\\":\\\"78b97ae0-1bc5-45fb-82a4-4f1280cfbdff\\\",\\\"title\\\":\\\"\\\",\\\"action\\\":{\\\"id\\\":944,\\\"name\\\":\\\"page.visit\\\"},\\\"eventName\\\":\\\"page.visit\\\",\\\"expressions\\\":[]}],\\\"exact\\\":false}}]}}]}}\"\n}","options":{"raw":{"language":"json"}}}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"ac932063-7b3e-44f3-9498-4772c96d8ff1","name":"Update screen view priority","request":{"name":"Update screen view priority","description":{"content":"Update priority in a screen view.\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User\n\n**API key permission required:** `SCHEMA_SERVICE_SCHEMA_CREATE`\n\n**User role permission required:** `assets_docs: create`\n","type":"text/plain"},"url":{"path":["schema-service","v2","screen-views",":screenViewId","priority"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"screenViewId","description":"(Required) UUID of the screen view"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PUT","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"99","options":{"raw":{"language":"json"}}}},"response":[{"id":"0f1dd481-c7b0-49b9-b509-cb51766c6f9d","name":"Success","originalRequest":{"url":{"path":["schema-service","v2","screen-views",":screenViewId","priority"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"screenViewId","description":"(Required) UUID of the screen view"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"99","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"status\": \"string\",\n \"body\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"cf1c7ddd-6486-4342-b06e-6f85ba54459a","name":"See error message for details","originalRequest":{"url":{"path":["schema-service","v2","screen-views",":screenViewId","priority"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"screenViewId","description":"(Required) UUID of the screen view"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"99","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"5d3f56c1-e569-4862-8163-56a4f16d43fd","name":"Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc.","originalRequest":{"url":{"path":["schema-service","v2","screen-views",":screenViewId","priority"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"screenViewId","description":"(Required) UUID of the screen view"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"99","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"string\",\n \"error\": \"string\",\n \"message\": \"string\",\n \"status\": 6404\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"a7326df1-62d4-4e62-aa95-8518400ea986","name":"Forbidden; insufficient permissions","originalRequest":{"url":{"path":["schema-service","v2","screen-views",":screenViewId","priority"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"screenViewId","description":"(Required) UUID of the screen view"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"99","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"string\",\n \"error\": \"string\",\n \"message\": \"string\",\n \"status\": 6404\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"1a9677c7-e748-4f59-a34d-962b4c35bf76","name":"Resource not found","originalRequest":{"url":{"path":["schema-service","v2","screen-views",":screenViewId","priority"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"screenViewId","description":"(Required) UUID of the screen view"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"99","options":{"raw":{"language":"json"}}}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"32a34caa-1cae-4357-9f03-de68f5411355","name":"See error message for details","originalRequest":{"url":{"path":["schema-service","v2","screen-views",":screenViewId","priority"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"screenViewId","description":"(Required) UUID of the screen view"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"99","options":{"raw":{"language":"json"}}}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"89f4f0f8-ca5f-4423-83ea-0e0371a452d1","name":"Rename screen view","request":{"name":"Rename screen view","description":{"content":"Update the name of a screen view. You can update the names of active screen views.\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User\n\n**API key permission required:** `SCHEMA_SERVICE_SCHEMA_CREATE`\n\n**User role permission required:** `assets_docs: create`\n","type":"text/plain"},"url":{"path":["schema-service","v2","screen-views",":screenViewId","name"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"screenViewId","description":"(Required) UUID of the screen view"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PUT","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"string","options":{"raw":{"language":"json"}}}},"response":[{"id":"6d066fe2-9088-4171-838b-09be1b362a8a","name":"Success","originalRequest":{"url":{"path":["schema-service","v2","screen-views",":screenViewId","name"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"screenViewId","description":"(Required) UUID of the screen view"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"string","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"status\": \"string\",\n \"body\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"ce4a8b90-0c2e-471f-950a-0934247f5f88","name":"See error message for details","originalRequest":{"url":{"path":["schema-service","v2","screen-views",":screenViewId","name"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"screenViewId","description":"(Required) UUID of the screen view"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"string","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"e9e3b1a6-fd29-4759-b351-1c541022afed","name":"Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc.","originalRequest":{"url":{"path":["schema-service","v2","screen-views",":screenViewId","name"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"screenViewId","description":"(Required) UUID of the screen view"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"string","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"string\",\n \"error\": \"string\",\n \"message\": \"string\",\n \"status\": 6404\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"b61d568e-b004-4cd3-a974-6d9727e59491","name":"Forbidden; insufficient permissions","originalRequest":{"url":{"path":["schema-service","v2","screen-views",":screenViewId","name"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"screenViewId","description":"(Required) UUID of the screen view"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"string","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"string\",\n \"error\": \"string\",\n \"message\": \"string\",\n \"status\": 6404\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"687e3b16-cee6-422b-9def-9be605d2e6e8","name":"Resource not found","originalRequest":{"url":{"path":["schema-service","v2","screen-views",":screenViewId","name"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"screenViewId","description":"(Required) UUID of the screen view"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"string","options":{"raw":{"language":"json"}}}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"3b814e09-4a62-467a-935e-20a2b75b297a","name":"See error message for details","originalRequest":{"url":{"path":["schema-service","v2","screen-views",":screenViewId","name"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"screenViewId","description":"(Required) UUID of the screen view"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"string","options":{"raw":{"language":"json"}}}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"663c9c8e-b56b-41cc-aea6-296aeb0a3abf","name":"Preview screen view with a profile context","request":{"name":"Preview screen view with a profile context","description":{"content":"This endpoint can be used to preview a generated document as a Workspace or Synerise User. To generate the output as a profile (client), use one of the following methods:\n- [POST `/v3/screen-views/{feedSlug}/generate`](#operation/generateScreenViewByFeedPostV2)\n- [GET `/v3/screen-views/{feedSlug}/generate`](#operation/generateScreenViewByFeedGetV2)\n\n\nWhen this method is called, the Synerise backend finds all screen view campaigns in the requested feed which are applicable to the profile and returns the screen view with the highest priority (1). Inserts are processed. If an insert can't be processed, the returned `data` is empty.\n\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User\n\n**API key permission required:** `SCHEMA_SERVICE_SCHEMA_READ`\n\n**User role permission required:** `assets_docs: read`\n","type":"text/plain"},"url":{"path":["schema-service","v2","screen-views",":feedSlug","generate","by",":identifierType"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"feedSlug","description":"(Required) Slug of the screen view feed"},{"disabled":false,"type":"any","value":"uuid","key":"identifierType","description":"(Required) Type of the profile identifier. The value is sent in `identifierValue` in the request body."}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"identifierValue\": \"string\",\n \"params\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n }\n }\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"0370dc8a-61d9-4753-bb92-7478bd3d2923","name":"Processed JSON content","originalRequest":{"url":{"path":["schema-service","v2","screen-views",":feedSlug","generate","by",":identifierType"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"feedSlug","description":"(Required) Slug of the screen view feed"},{"disabled":false,"type":"any","value":"uuid","key":"identifierType","description":"(Required) Type of the profile identifier. The value is sent in `identifierValue` in the request body."}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"identifierValue\": \"string\",\n \"params\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n }\n }\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"id\": \"050d96b4-1927-42f5-5c35-227c8cd9164d\",\n \"hash\": \"51f3f9e4-1cc8-c2a9-e86b-a4b487566e75\",\n \"priority\": 99,\n \"name\": \"string\",\n \"createdAt\": \"1989-10-28T23:03:27.289Z\",\n \"updatedAt\": \"1999-01-02T00:05:22.456Z\",\n \"audience\": {\n \"targetType\": {\n \"value\": \"\"\n },\n \"segments\": {\n \"value\": \"\"\n },\n \"query\": {\n \"value\": \"\"\n }\n },\n \"data\": {\n \"collection\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"key_0\": {}\n },\n \"path\": \"/v2/screen-views/f9215cb9-4a7e-410b-88cb-8bc40363cc10\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"50e2a6cf-bac8-47df-a5d7-ab6e55196af9","name":"See error message for details","originalRequest":{"url":{"path":["schema-service","v2","screen-views",":feedSlug","generate","by",":identifierType"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"feedSlug","description":"(Required) Slug of the screen view feed"},{"disabled":false,"type":"any","value":"uuid","key":"identifierType","description":"(Required) Type of the profile identifier. The value is sent in `identifierValue` in the request body."}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"identifierValue\": \"string\",\n \"params\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n }\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"87fb36f6-2ce8-4d35-9265-ae4c25f5194a","name":"Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc.","originalRequest":{"url":{"path":["schema-service","v2","screen-views",":feedSlug","generate","by",":identifierType"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"feedSlug","description":"(Required) Slug of the screen view feed"},{"disabled":false,"type":"any","value":"uuid","key":"identifierType","description":"(Required) Type of the profile identifier. The value is sent in `identifierValue` in the request body."}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"identifierValue\": \"string\",\n \"params\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n }\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"string\",\n \"error\": \"string\",\n \"message\": \"string\",\n \"status\": 6404\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"49a49022-9b2e-4c29-a1bb-7091b939843e","name":"Forbidden; insufficient permissions","originalRequest":{"url":{"path":["schema-service","v2","screen-views",":feedSlug","generate","by",":identifierType"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"feedSlug","description":"(Required) Slug of the screen view feed"},{"disabled":false,"type":"any","value":"uuid","key":"identifierType","description":"(Required) Type of the profile identifier. The value is sent in `identifierValue` in the request body."}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"identifierValue\": \"string\",\n \"params\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n }\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"string\",\n \"error\": \"string\",\n \"message\": \"string\",\n \"status\": 6404\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"d4c098b6-f6aa-4cf8-9261-3a87919adbfc","name":"Resource not found","originalRequest":{"url":{"path":["schema-service","v2","screen-views",":feedSlug","generate","by",":identifierType"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"feedSlug","description":"(Required) Slug of the screen view feed"},{"disabled":false,"type":"any","value":"uuid","key":"identifierType","description":"(Required) Type of the profile identifier. The value is sent in `identifierValue` in the request body."}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"identifierValue\": \"string\",\n \"params\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n }\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"ea7d4cba-480f-4ef5-b56b-9b7aefa1109d","name":"See error message for details","originalRequest":{"url":{"path":["schema-service","v2","screen-views",":feedSlug","generate","by",":identifierType"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"feedSlug","description":"(Required) Slug of the screen view feed"},{"disabled":false,"type":"any","value":"uuid","key":"identifierType","description":"(Required) Type of the profile identifier. The value is sent in `identifierValue` in the request body."}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"identifierValue\": \"string\",\n \"params\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n }\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"b49f10e6-4011-4c7e-b662-870d1b6ff05a","name":"Create screen view feed","request":{"name":"Create screen view feed","description":{"content":"Create a new screen view feed.\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User\n\n**API key permission required:** `SCHEMA_SERVICE_SCHEMA_CREATE`\n\n**User role permission required:** `assets_docs: create`\n","type":"text/plain"},"url":{"path":["schema-service","v2","screen-views","feeds"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"name\": \"string\",\n \"slug\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"6db0ede0-8c05-4c4e-aab9-71da17cbcea2","name":"Feed created","originalRequest":{"url":{"path":["schema-service","v2","screen-views","feeds"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"name\": \"string\",\n \"slug\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"id\": \"d24cd5a2-9b3c-3c9e-09ae-d58abca1e2c2\",\n \"slug\": \"string\",\n \"name\": \"string\",\n \"createdAt\": \"2011-10-26T19:47:56.893Z\",\n \"default\": false\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"c4870fc6-144b-4bf7-90c9-c6d214474b37","name":"See error message for details","originalRequest":{"url":{"path":["schema-service","v2","screen-views","feeds"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"name\": \"string\",\n \"slug\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"65e4f44f-4577-4ebb-898e-7a119d202c0f","name":"Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc.","originalRequest":{"url":{"path":["schema-service","v2","screen-views","feeds"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"name\": \"string\",\n \"slug\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"string\",\n \"error\": \"string\",\n \"message\": \"string\",\n \"status\": 6404\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"08b1faf1-8667-4656-9f72-5b54b7cdfcd8","name":"Forbidden; insufficient permissions","originalRequest":{"url":{"path":["schema-service","v2","screen-views","feeds"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"name\": \"string\",\n \"slug\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"string\",\n \"error\": \"string\",\n \"message\": \"string\",\n \"status\": 6404\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"1d4e256f-4685-43e6-bf83-09a89b94d4d0","name":"Resource not found","originalRequest":{"url":{"path":["schema-service","v2","screen-views","feeds"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"name\": \"string\",\n \"slug\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"4a2750ed-9f35-467b-92cf-e882ea9c7e9d","name":"See error message for details","originalRequest":{"url":{"path":["schema-service","v2","screen-views","feeds"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"name\": \"string\",\n \"slug\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"01079ff9-6dd3-4efb-a85b-ff759d8dcdd5","name":"List screen view feeds","request":{"name":"List screen view feeds","description":{"content":"Returns a list of screen view feeds.\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `SCHEMA_SERVICE_SCHEMA_CREATE`\n\n**User role permission required:** `assets_docs: create`\n","type":"text/plain"},"url":{"path":["schema-service","v2","screen-views","feeds"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"a31dbfd6-137f-4cd6-98ef-a1567c309695","name":"List of feeds","originalRequest":{"url":{"path":["schema-service","v2","screen-views","feeds"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"[\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n]","cookie":[],"_postman_previewlanguage":"json"},{"id":"974e55b5-e6dd-4a67-9601-bb96cf9bf161","name":"See error message for details","originalRequest":{"url":{"path":["schema-service","v2","screen-views","feeds"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"6d7acf36-b0be-4e8f-aedf-8ed4ea37db1b","name":"Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc.","originalRequest":{"url":{"path":["schema-service","v2","screen-views","feeds"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"string\",\n \"error\": \"string\",\n \"message\": \"string\",\n \"status\": 6404\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"b683d4f7-69c6-41f7-99e8-03b237826c5f","name":"Forbidden; insufficient permissions","originalRequest":{"url":{"path":["schema-service","v2","screen-views","feeds"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"string\",\n \"error\": \"string\",\n \"message\": \"string\",\n \"status\": 6404\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"94c95111-f8c9-4b75-9cff-9eb16d746914","name":"Resource not found","originalRequest":{"url":{"path":["schema-service","v2","screen-views","feeds"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"cbb836ab-7fb6-4a5a-b3e4-f1fe53ceede4","name":"See error message for details","originalRequest":{"url":{"path":["schema-service","v2","screen-views","feeds"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"7a328447-0964-445c-a800-faa650d40fe7","name":"List screen views","request":{"name":"List screen views","description":{"content":"Returns a paginated list of screen views.\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User\n\n**API key permission required:** `SCHEMA_SERVICE_SCHEMA_CREATE`\n\n**User role permission required:** `assets_docs: create`\n","type":"text/plain"},"url":{"path":["schema-service","v2","screen-views"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"page","value":"1"},{"disabled":false,"key":"limit","value":"25","description":"Limit of items per page"},{"disabled":false,"key":"search","value":"string","description":"A string to search for in resource names"},{"disabled":false,"key":"directoryId","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","description":"UUID of the directory for filtering the results"},{"disabled":false,"key":"status","value":"DRAFT"},{"disabled":false,"key":"feedId","value":"bb467b97-7c48-fcb4-40d5-92c4af02b7a6"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"3bf2728b-79a5-4fdd-9b47-5dfc78174858","name":"List of screen views","originalRequest":{"url":{"path":["schema-service","v2","screen-views"],"host":["{{baseUrl}}"],"query":[{"key":"page","value":"1"},{"key":"limit","value":"25"},{"key":"search","value":"string"},{"key":"directoryId","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750"},{"key":"status","value":"DRAFT"},{"key":"feedId","value":"bb467b97-7c48-fcb4-40d5-92c4af02b7a6"}],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"meta\": {\n \"links\": {\n \"value\": \"\"\n },\n \"limit\": {\n \"value\": \"\"\n },\n \"count\": {\n \"value\": \"\"\n }\n },\n \"data\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"b03c1fc2-c664-4af7-8570-c125998f0417","name":"See error message for details","originalRequest":{"url":{"path":["schema-service","v2","screen-views"],"host":["{{baseUrl}}"],"query":[{"key":"page","value":"1"},{"key":"limit","value":"25"},{"key":"search","value":"string"},{"key":"directoryId","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750"},{"key":"status","value":"DRAFT"},{"key":"feedId","value":"bb467b97-7c48-fcb4-40d5-92c4af02b7a6"}],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"644da0e6-3cc5-437e-8483-091d4b107c78","name":"Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc.","originalRequest":{"url":{"path":["schema-service","v2","screen-views"],"host":["{{baseUrl}}"],"query":[{"key":"page","value":"1"},{"key":"limit","value":"25"},{"key":"search","value":"string"},{"key":"directoryId","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750"},{"key":"status","value":"DRAFT"},{"key":"feedId","value":"bb467b97-7c48-fcb4-40d5-92c4af02b7a6"}],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"string\",\n \"error\": \"string\",\n \"message\": \"string\",\n \"status\": 6404\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"fda89a27-6dd5-4b00-acee-d9cd72adfb7a","name":"Forbidden; insufficient permissions","originalRequest":{"url":{"path":["schema-service","v2","screen-views"],"host":["{{baseUrl}}"],"query":[{"key":"page","value":"1"},{"key":"limit","value":"25"},{"key":"search","value":"string"},{"key":"directoryId","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750"},{"key":"status","value":"DRAFT"},{"key":"feedId","value":"bb467b97-7c48-fcb4-40d5-92c4af02b7a6"}],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"string\",\n \"error\": \"string\",\n \"message\": \"string\",\n \"status\": 6404\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"a25a9880-f14d-4cf3-9b8f-de771c6f529a","name":"Resource not found","originalRequest":{"url":{"path":["schema-service","v2","screen-views"],"host":["{{baseUrl}}"],"query":[{"key":"page","value":"1"},{"key":"limit","value":"25"},{"key":"search","value":"string"},{"key":"directoryId","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750"},{"key":"status","value":"DRAFT"},{"key":"feedId","value":"bb467b97-7c48-fcb4-40d5-92c4af02b7a6"}],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"9e6a6871-7832-48d1-94c8-0892d2063177","name":"See error message for details","originalRequest":{"url":{"path":["schema-service","v2","screen-views"],"host":["{{baseUrl}}"],"query":[{"key":"page","value":"1"},{"key":"limit","value":"25"},{"key":"search","value":"string"},{"key":"directoryId","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750"},{"key":"status","value":"DRAFT"},{"key":"feedId","value":"bb467b97-7c48-fcb4-40d5-92c4af02b7a6"}],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"18f550db-9ab3-417c-be28-186923f344e2","name":"Get screen view","request":{"name":"Get screen view","description":{"content":"Retrieve the details of a screen view.\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User\n\n**API key permission required:** `SCHEMA_SERVICE_SCHEMA_READ`\n\n**User role permission required:** `assets_docs: read`\n","type":"text/plain"},"url":{"path":["schema-service","v2","screen-views",":screenViewId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"screenViewId","description":"(Required) UUID of the screen view"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"5bd969d3-e6fe-46e2-93c3-34b68161f5c7","name":"Details of the screen view","originalRequest":{"url":{"path":["schema-service","v2","screen-views",":screenViewId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"screenViewId","description":"(Required) UUID of the screen view"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"id\": \"eaf836cb-6920-010e-d828-1064f89c04f6\",\n \"businessProfileId\": 9067,\n \"name\": \"string\",\n \"status\": \"SCHEDULED\",\n \"priority\": 99,\n \"scheduled\": false,\n \"author\": {\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"avatar\": {\n \"value\": \"\"\n }\n },\n \"content\": {\n \"json\": {\n \"value\": \"\"\n },\n \"documents\": {\n \"value\": \"\"\n },\n \"groups\": {\n \"value\": \"\"\n },\n \"data\": {\n \"value\": \"\"\n },\n \"groupsOrder\": {\n \"value\": \"\"\n }\n },\n \"audience\": {\n \"targetType\": {\n \"value\": \"\"\n },\n \"segments\": {\n \"value\": \"\"\n },\n \"query\": {\n \"value\": \"\"\n }\n },\n \"createdAt\": \"2022-09-08T07:32:03.255Z\",\n \"updatedAt\": \"1963-04-30T03:52:50.562Z\",\n \"directory\": {\n \"value\": \"\"\n },\n \"feed\": {\n \"value\": \"\"\n },\n \"description\": \"string\",\n \"deletedAt\": \"2016-03-20T13:47:57.366Z\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"fe843b39-9aaa-4842-a984-172cada21e36","name":"See error message for details","originalRequest":{"url":{"path":["schema-service","v2","screen-views",":screenViewId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"screenViewId","description":"(Required) UUID of the screen view"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"6c4fb7f8-9d48-4afb-b368-2068a615c84a","name":"Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc.","originalRequest":{"url":{"path":["schema-service","v2","screen-views",":screenViewId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"screenViewId","description":"(Required) UUID of the screen view"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"string\",\n \"error\": \"string\",\n \"message\": \"string\",\n \"status\": 6404\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"e1adfcfd-5533-4147-9fb2-bd5dea3d3edc","name":"Forbidden; insufficient permissions","originalRequest":{"url":{"path":["schema-service","v2","screen-views",":screenViewId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"screenViewId","description":"(Required) UUID of the screen view"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"string\",\n \"error\": \"string\",\n \"message\": \"string\",\n \"status\": 6404\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"007ce93d-fe11-4bd1-b714-3faf7e2668d4","name":"Resource not found","originalRequest":{"url":{"path":["schema-service","v2","screen-views",":screenViewId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"screenViewId","description":"(Required) UUID of the screen view"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"785959f2-5534-4e6e-b017-2fc06bfd9ec9","name":"See error message for details","originalRequest":{"url":{"path":["schema-service","v2","screen-views",":screenViewId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"screenViewId","description":"(Required) UUID of the screen view"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"cfd4483b-3615-41b2-af6f-8ad3f30938d3","name":"Delete screen view","request":{"name":"Delete screen view","description":{"content":"Delete a screen view.\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User\n\n**API key permission required:** `SCHEMA_SERVICE_SCHEMA_DELETE`\n\n**User role permission required:** `assets_docs: delete`\n","type":"text/plain"},"url":{"path":["schema-service","v2","screen-views",":screenViewId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"screenViewId","description":"(Required) UUID of the screen view"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"11362aa1-800c-43fb-97b2-67d0bfba5038","name":"Screen view deleted","originalRequest":{"url":{"path":["schema-service","v2","screen-views",":screenViewId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"screenViewId","description":"(Required) UUID of the screen view"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"status\": \"string\",\n \"body\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"898b746c-ef8b-4f21-a906-8cbdd86fb17f","name":"See error message for details","originalRequest":{"url":{"path":["schema-service","v2","screen-views",":screenViewId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"screenViewId","description":"(Required) UUID of the screen view"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"89470745-4dbe-4b45-b6af-b28a0765d9a6","name":"Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc.","originalRequest":{"url":{"path":["schema-service","v2","screen-views",":screenViewId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"screenViewId","description":"(Required) UUID of the screen view"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"string\",\n \"error\": \"string\",\n \"message\": \"string\",\n \"status\": 6404\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"e98cdae8-8046-497e-bb13-cc9d14e670c2","name":"Forbidden; insufficient permissions","originalRequest":{"url":{"path":["schema-service","v2","screen-views",":screenViewId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"screenViewId","description":"(Required) UUID of the screen view"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"string\",\n \"error\": \"string\",\n \"message\": \"string\",\n \"status\": 6404\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"2c445586-8c8d-4e78-b734-8be0a431a458","name":"Resource not found","originalRequest":{"url":{"path":["schema-service","v2","screen-views",":screenViewId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"screenViewId","description":"(Required) UUID of the screen view"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"31cb2bc0-5e93-4575-ae66-cefbf8334364","name":"See error message for details","originalRequest":{"url":{"path":["schema-service","v2","screen-views",":screenViewId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"screenViewId","description":"(Required) UUID of the screen view"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"0dd29ed6-c2ba-4c2f-a63d-857e8d1dfd2d","name":"Copy screen view","request":{"name":"Copy screen view","description":{"content":"Copy a screen view. The copy receives the DRAFT status, regardless of the status of the original screen view.\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User\n\n**API key permission required:** `SCHEMA_SERVICE_SCHEMA_CREATE`\n\n**User role permission required:** `assets_docs: create`\n","type":"text/plain"},"url":{"path":["schema-service","v2","screen-views",":screenViewId","copy"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"screenViewId","description":"(Required) UUID of the screen view"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"8adb6569-d766-4071-9263-602aaeaa2739","name":"Data of the created copy","originalRequest":{"url":{"path":["schema-service","v2","screen-views",":screenViewId","copy"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"screenViewId","description":"(Required) UUID of the screen view"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"id\": \"368b5283-6e32-fc11-8bda-2ceff8e32a05\",\n \"version\": \"string\",\n \"status\": \"SCHEDULED\",\n \"hash\": \"bb6639b2-a98e-49d9-804f-ed6c0e2a0d2f:2019-12-05T08:22:10.094\",\n \"parentVersion\": \"string\",\n \"authorId\": \"string\",\n \"businessProfileId\": 1407,\n \"priority\": 99,\n \"name\": \"string\",\n \"description\": \"string\",\n \"isActive\": false,\n \"createdAt\": \"2002-02-11T13:04:32.013Z\",\n \"updatedAt\": \"1949-12-17T02:16:43.643Z\",\n \"deletedAt\": \"2005-01-13T11:28:43.265Z\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"5e65db96-d194-46f7-beb6-1b204f4cb9a3","name":"See error message for details","originalRequest":{"url":{"path":["schema-service","v2","screen-views",":screenViewId","copy"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"screenViewId","description":"(Required) UUID of the screen view"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"9d8e1aca-198f-440c-874e-0b001cb16c5e","name":"Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc.","originalRequest":{"url":{"path":["schema-service","v2","screen-views",":screenViewId","copy"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"screenViewId","description":"(Required) UUID of the screen view"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"string\",\n \"error\": \"string\",\n \"message\": \"string\",\n \"status\": 6404\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"20bc26ec-b4f1-4ffd-bd0f-441c458d37f0","name":"Forbidden; insufficient permissions","originalRequest":{"url":{"path":["schema-service","v2","screen-views",":screenViewId","copy"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"screenViewId","description":"(Required) UUID of the screen view"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"string\",\n \"error\": \"string\",\n \"message\": \"string\",\n \"status\": 6404\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"4dbb0ed8-1f7e-4250-a4ea-05715f2ce5a6","name":"Resource not found","originalRequest":{"url":{"path":["schema-service","v2","screen-views",":screenViewId","copy"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"screenViewId","description":"(Required) UUID of the screen view"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"e18410d9-18e3-4b4f-9507-54740f1b438f","name":"See error message for details","originalRequest":{"url":{"path":["schema-service","v2","screen-views",":screenViewId","copy"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"screenViewId","description":"(Required) UUID of the screen view"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"e963a9f9-0e64-47bc-b9a3-caf3d765793f","name":"Get predecessors for screen view","request":{"name":"Get predecessors for screen view","description":{"content":"Retrieve information about documents or screen views that refer **to** the requested screen view.\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User\n\n**API key permission required:** `SCHEMA_SERVICE_SCHEMA_READ`\n\n**User role permission required:** `assets_docs: read`\n","type":"text/plain"},"url":{"path":["schema-service","v2","screen-views",":screenViewId","predecessors"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"screenViewId","description":"(Required) UUID of the screen view"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"043082c5-6bb8-41b9-91ee-d323c62bab4f","name":"Entities which refer to the requested screen view","originalRequest":{"url":{"path":["schema-service","v2","screen-views",":screenViewId","predecessors"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"screenViewId","description":"(Required) UUID of the screen view"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"[\n {\n \"id\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"children\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n },\n {\n \"id\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"children\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n }\n]","cookie":[],"_postman_previewlanguage":"json"},{"id":"91b9a25a-1990-41f9-9cc0-d69710443dec","name":"See error message for details","originalRequest":{"url":{"path":["schema-service","v2","screen-views",":screenViewId","predecessors"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"screenViewId","description":"(Required) UUID of the screen view"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"9f76f779-33f4-4923-98e7-d538dbf545e2","name":"Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc.","originalRequest":{"url":{"path":["schema-service","v2","screen-views",":screenViewId","predecessors"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"screenViewId","description":"(Required) UUID of the screen view"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"string\",\n \"error\": \"string\",\n \"message\": \"string\",\n \"status\": 6404\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"c6488819-bb49-4906-9ebf-e437359bc8cb","name":"Forbidden; insufficient permissions","originalRequest":{"url":{"path":["schema-service","v2","screen-views",":screenViewId","predecessors"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"screenViewId","description":"(Required) UUID of the screen view"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"string\",\n \"error\": \"string\",\n \"message\": \"string\",\n \"status\": 6404\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"1c215e52-e3fe-436f-9266-4a07f8dd9794","name":"Resource not found","originalRequest":{"url":{"path":["schema-service","v2","screen-views",":screenViewId","predecessors"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"screenViewId","description":"(Required) UUID of the screen view"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"d9cb9339-a35c-4264-947f-9bfc3c470f8d","name":"See error message for details","originalRequest":{"url":{"path":["schema-service","v2","screen-views",":screenViewId","predecessors"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"screenViewId","description":"(Required) UUID of the screen view"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"f6c39a1a-de1e-417c-aec5-fcc0ef1972cb","name":"Get successors for screen view","request":{"name":"Get successors for screen view","description":{"content":"Retrieve information about documents referenced **from** the requested screen view.\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User\n\n**API key permission required:** `SCHEMA_SERVICE_SCHEMA_READ`\n\n**User role permission required:** `assets_docs: read`\n","type":"text/plain"},"url":{"path":["schema-service","v2","screen-views",":screenViewId","successors"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"screenViewId","description":"(Required) UUID of the screen view"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"a71f4a6f-c614-4d70-97b0-ec88a4b03fdb","name":"Documents referenced from the requested screen view","originalRequest":{"url":{"path":["schema-service","v2","screen-views",":screenViewId","successors"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"screenViewId","description":"(Required) UUID of the screen view"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"[\n {\n \"id\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"children\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n },\n {\n \"id\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"children\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n }\n]","cookie":[],"_postman_previewlanguage":"json"},{"id":"ea2a7c21-2c9c-43bf-8718-5f6047739e77","name":"See error message for details","originalRequest":{"url":{"path":["schema-service","v2","screen-views",":screenViewId","successors"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"screenViewId","description":"(Required) UUID of the screen view"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"deb9ede5-8046-42a8-98a1-06b5f09440e2","name":"Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc.","originalRequest":{"url":{"path":["schema-service","v2","screen-views",":screenViewId","successors"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"screenViewId","description":"(Required) UUID of the screen view"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"string\",\n \"error\": \"string\",\n \"message\": \"string\",\n \"status\": 6404\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"b9e452c7-e6a8-4dfe-9e60-c5ecc732d7db","name":"Forbidden; insufficient permissions","originalRequest":{"url":{"path":["schema-service","v2","screen-views",":screenViewId","successors"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"screenViewId","description":"(Required) UUID of the screen view"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"string\",\n \"error\": \"string\",\n \"message\": \"string\",\n \"status\": 6404\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"381f4071-c814-4d85-add7-b966863faf25","name":"Resource not found","originalRequest":{"url":{"path":["schema-service","v2","screen-views",":screenViewId","successors"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"screenViewId","description":"(Required) UUID of the screen view"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"f103555c-7c39-484f-a116-e6ece8a3d4fa","name":"See error message for details","originalRequest":{"url":{"path":["schema-service","v2","screen-views",":screenViewId","successors"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"screenViewId","description":"(Required) UUID of the screen view"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"155f9322-6be3-47db-b787-bed27e66ac92","name":"Add screen view directory","request":{"name":"Add screen view directory","description":{"content":"Create a directory for screen views.\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User\n\n**API key permission required:** `SCHEMA_SERVICE_SCHEMA_CREATE`\n\n**User role permission required:** `assets_docs: create`\n","type":"text/plain"},"url":{"path":["schema-service","v2","screen-views","directory"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"name\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"bc436619-de55-4345-b5a0-6decc21f9a2e","name":"Directory created","originalRequest":{"url":{"path":["schema-service","v2","screen-views","directory"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"name\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"id\": \"19596830-d5b3-7eb5-326f-a3a26498c1e7\",\n \"name\": \"string\",\n \"createdAt\": \"1978-12-12T03:23:33.448Z\",\n \"default\": false\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"99005397-91ab-4766-9b81-0377c1901dfe","name":"See error message for details","originalRequest":{"url":{"path":["schema-service","v2","screen-views","directory"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"name\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"8b42d958-8b26-4ea0-a506-338e299cebdd","name":"Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc.","originalRequest":{"url":{"path":["schema-service","v2","screen-views","directory"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"name\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"string\",\n \"error\": \"string\",\n \"message\": \"string\",\n \"status\": 6404\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"ec3ccde9-58e5-404f-aa0a-a97ef2921815","name":"Forbidden; insufficient permissions","originalRequest":{"url":{"path":["schema-service","v2","screen-views","directory"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"name\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"string\",\n \"error\": \"string\",\n \"message\": \"string\",\n \"status\": 6404\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"593c8aaa-c4a3-4b38-83f6-ccc2f0e9d5ae","name":"Resource not found","originalRequest":{"url":{"path":["schema-service","v2","screen-views","directory"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"name\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"735b8fb9-292f-48c3-a69b-b2cb86fe91c6","name":"See error message for details","originalRequest":{"url":{"path":["schema-service","v2","screen-views","directory"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"name\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"c998ddcb-dc97-4d40-a707-61583b060111","name":"List screen view directories","request":{"name":"List screen view directories","description":{"content":"Returns a list of screen view directories.\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `SCHEMA_SERVICE_SCHEMA_CREATE`\n\n**User role permission required:** `assets_docs: create`\n","type":"text/plain"},"url":{"path":["schema-service","v2","screen-views","directory"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"ad97a721-588b-4b7e-99cf-7766f32094db","name":"List of directories","originalRequest":{"url":{"path":["schema-service","v2","screen-views","directory"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"[\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n]","cookie":[],"_postman_previewlanguage":"json"},{"id":"f04b1ccd-ca61-411f-817f-dbdb64defe21","name":"See error message for details","originalRequest":{"url":{"path":["schema-service","v2","screen-views","directory"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"a13d0192-cdcf-4ad0-86cf-6faf8c2cfc4d","name":"Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc.","originalRequest":{"url":{"path":["schema-service","v2","screen-views","directory"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"string\",\n \"error\": \"string\",\n \"message\": \"string\",\n \"status\": 6404\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"afd8a491-620b-4803-9681-6c969c42a204","name":"Forbidden; insufficient permissions","originalRequest":{"url":{"path":["schema-service","v2","screen-views","directory"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"string\",\n \"error\": \"string\",\n \"message\": \"string\",\n \"status\": 6404\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"5fa5eb5b-a78a-4205-9acd-77244c33f5aa","name":"Resource not found","originalRequest":{"url":{"path":["schema-service","v2","screen-views","directory"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"4a2d85e7-97a0-4670-bd30-f0d834b1340c","name":"See error message for details","originalRequest":{"url":{"path":["schema-service","v2","screen-views","directory"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"0d77cd53-ba1f-4de5-8f49-066c74f5bd96","name":"Rename screen view directory","request":{"name":"Rename screen view directory","description":{"content":"Update the name of a screen view directory.\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User\n\n**API key permission required:** `SCHEMA_SERVICE_SCHEMA_DELETE`\n\n**User role permission required:** `assets_docs: delete`\n","type":"text/plain"},"url":{"path":["schema-service","v2","screen-views","directory",":directoryId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"directoryId","description":"(Required) UUID of the directory"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"name\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"ee517d29-8c27-490b-a6f2-8be2596e4a0d","name":"Success","originalRequest":{"url":{"path":["schema-service","v2","screen-views","directory",":directoryId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"directoryId","description":"(Required) UUID of the directory"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"name\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"id\": \"19596830-d5b3-7eb5-326f-a3a26498c1e7\",\n \"name\": \"string\",\n \"createdAt\": \"1978-12-12T03:23:33.448Z\",\n \"default\": false\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"f1335933-1805-4f52-b572-b00314304928","name":"See error message for details","originalRequest":{"url":{"path":["schema-service","v2","screen-views","directory",":directoryId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"directoryId","description":"(Required) UUID of the directory"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"name\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"6be08361-d353-416d-b435-72d91a518132","name":"Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc.","originalRequest":{"url":{"path":["schema-service","v2","screen-views","directory",":directoryId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"directoryId","description":"(Required) UUID of the directory"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"name\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"string\",\n \"error\": \"string\",\n \"message\": \"string\",\n \"status\": 6404\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"9a9d1800-1057-4cf6-80d6-714aa03e4c75","name":"Forbidden; insufficient permissions","originalRequest":{"url":{"path":["schema-service","v2","screen-views","directory",":directoryId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"directoryId","description":"(Required) UUID of the directory"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"name\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"string\",\n \"error\": \"string\",\n \"message\": \"string\",\n \"status\": 6404\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"c228d133-5e98-4a52-922c-69d5f3effbef","name":"Resource not found","originalRequest":{"url":{"path":["schema-service","v2","screen-views","directory",":directoryId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"directoryId","description":"(Required) UUID of the directory"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"name\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"31d0c45a-3a85-49f6-ba4f-fcff594ee065","name":"See error message for details","originalRequest":{"url":{"path":["schema-service","v2","screen-views","directory",":directoryId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"directoryId","description":"(Required) UUID of the directory"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"name\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"20262318-6028-4923-80e4-b3a03d63fc50","name":"Delete screen view directory","request":{"name":"Delete screen view directory","description":{"content":"Delete a screen view directory. The contents are moved into the default directory.\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User\n\n**API key permission required:** `SCHEMA_SERVICE_SCHEMA_DELETE`\n\n**User role permission required:** `assets_docs: delete`\n","type":"text/plain"},"url":{"path":["schema-service","v2","screen-views","directory",":directoryId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"directoryId","description":"(Required) UUID of the directory"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"16f1c716-bfad-41bc-bd2d-1b0fbd20dac8","name":"Success","originalRequest":{"url":{"path":["schema-service","v2","screen-views","directory",":directoryId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"directoryId","description":"(Required) UUID of the directory"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"id\": \"19596830-d5b3-7eb5-326f-a3a26498c1e7\",\n \"name\": \"string\",\n \"createdAt\": \"1978-12-12T03:23:33.448Z\",\n \"default\": false\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"987a26e6-b4be-4f09-a0ca-c4ae2338d99f","name":"See error message for details","originalRequest":{"url":{"path":["schema-service","v2","screen-views","directory",":directoryId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"directoryId","description":"(Required) UUID of the directory"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"e9645f14-5c99-4609-b265-6d6759ae669f","name":"Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc.","originalRequest":{"url":{"path":["schema-service","v2","screen-views","directory",":directoryId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"directoryId","description":"(Required) UUID of the directory"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"string\",\n \"error\": \"string\",\n \"message\": \"string\",\n \"status\": 6404\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"de37ee95-5ba2-4b39-bf0f-0c192cecc20a","name":"Forbidden; insufficient permissions","originalRequest":{"url":{"path":["schema-service","v2","screen-views","directory",":directoryId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"directoryId","description":"(Required) UUID of the directory"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"string\",\n \"error\": \"string\",\n \"message\": \"string\",\n \"status\": 6404\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"206fb1bd-ebe0-4632-9755-400f5d9fb091","name":"Resource not found","originalRequest":{"url":{"path":["schema-service","v2","screen-views","directory",":directoryId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"directoryId","description":"(Required) UUID of the directory"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"d085c473-37ce-4628-9b27-6a025a91287c","name":"See error message for details","originalRequest":{"url":{"path":["schema-service","v2","screen-views","directory",":directoryId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"directoryId","description":"(Required) UUID of the directory"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"e7e68918-742c-42f0-8ed8-dfbb2b2b580f","name":"Assign screen view to directory","request":{"name":"Assign screen view to directory","description":{"content":"Assign a screen view to a directory. A screen view can only belong to one directory and using this endpoint overwrites the current assignment.\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User\n\n**API key permission required:** `SCHEMA_SERVICE_SCHEMA_DELETE`\n\n**User role permission required:** `assets_docs: delete`\n","type":"text/plain"},"url":{"path":["schema-service","v2","screen-views",":screenViewId","directory",":directoryId","attach"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"screenViewId","description":"(Required) UUID of the screen view"},{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"directoryId","description":"(Required) UUID of the directory"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"a45142b5-4fce-4fec-97da-548c51325b78","name":"Success","originalRequest":{"url":{"path":["schema-service","v2","screen-views",":screenViewId","directory",":directoryId","attach"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"screenViewId","description":"(Required) UUID of the screen view"},{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"directoryId","description":"(Required) UUID of the directory"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"docId\": \"1ef68633-4bae-cc8a-64eb-dc167eaed4b5\",\n \"name\": \"string\",\n \"status\": \"DRAFT\",\n \"scheduled\": true,\n \"authorId\": 7895,\n \"directoryId\": \"92767e45-4c8b-7f49-ad28-dfe066b9cac7\",\n \"createdAt\": \"2023-12-27T20:17:40.943Z\",\n \"updatedAt\": \"1990-02-18T09:16:38.422Z\",\n \"deletedAt\": \"1997-04-25T19:44:58.062Z\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"bf786946-5cd5-4e5d-b730-e5b4cda434bb","name":"See error message for details","originalRequest":{"url":{"path":["schema-service","v2","screen-views",":screenViewId","directory",":directoryId","attach"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"screenViewId","description":"(Required) UUID of the screen view"},{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"directoryId","description":"(Required) UUID of the directory"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"7f4623a2-f012-4579-b64b-3c3a41be66cd","name":"Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc.","originalRequest":{"url":{"path":["schema-service","v2","screen-views",":screenViewId","directory",":directoryId","attach"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"screenViewId","description":"(Required) UUID of the screen view"},{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"directoryId","description":"(Required) UUID of the directory"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"string\",\n \"error\": \"string\",\n \"message\": \"string\",\n \"status\": 6404\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"ab1c8bfe-9cf5-4558-9525-04e573a2a284","name":"Forbidden; insufficient permissions","originalRequest":{"url":{"path":["schema-service","v2","screen-views",":screenViewId","directory",":directoryId","attach"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"screenViewId","description":"(Required) UUID of the screen view"},{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"directoryId","description":"(Required) UUID of the directory"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"string\",\n \"error\": \"string\",\n \"message\": \"string\",\n \"status\": 6404\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"c37b5317-a57e-488d-81d2-64342aa168f3","name":"Resource not found","originalRequest":{"url":{"path":["schema-service","v2","screen-views",":screenViewId","directory",":directoryId","attach"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"screenViewId","description":"(Required) UUID of the screen view"},{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"directoryId","description":"(Required) UUID of the directory"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"21ec2e16-c9c3-480a-92e0-15e68ddf979d","name":"See error message for details","originalRequest":{"url":{"path":["schema-service","v2","screen-views",":screenViewId","directory",":directoryId","attach"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"screenViewId","description":"(Required) UUID of the screen view"},{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"directoryId","description":"(Required) UUID of the directory"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"1facea3f-d72a-4ffe-a2c9-7a979c8290e0","name":"Assign screen view to feed","request":{"name":"Assign screen view to feed","description":{"content":"Assign a screen view to a feed.\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User\n\n**API key permission required:** `SCHEMA_SERVICE_SCHEMA_CREATE`\n\n**User role permission required:** `assets_docs: create`\n","type":"text/plain"},"url":{"path":["schema-service","v2","screen-views",":screenViewId","feed"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"screenViewId","description":"(Required) UUID of the screen view"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"c862adca-e6a0-f8ed-2be7-cac52b95e6ea","options":{"raw":{"language":"json"}}}},"response":[{"id":"ba9cb25e-a9c9-4164-b568-44b4f56e73df","name":"Success","originalRequest":{"url":{"path":["schema-service","v2","screen-views",":screenViewId","feed"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"screenViewId","description":"(Required) UUID of the screen view"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"c862adca-e6a0-f8ed-2be7-cac52b95e6ea","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"status\": \"string\",\n \"body\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"f1bf9085-5f24-4b87-a6c3-083f77b90303","name":"See error message for details","originalRequest":{"url":{"path":["schema-service","v2","screen-views",":screenViewId","feed"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"screenViewId","description":"(Required) UUID of the screen view"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"c862adca-e6a0-f8ed-2be7-cac52b95e6ea","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"ed7e7eaa-1855-44a6-b855-5ac265f6c512","name":"Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc.","originalRequest":{"url":{"path":["schema-service","v2","screen-views",":screenViewId","feed"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"screenViewId","description":"(Required) UUID of the screen view"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"c862adca-e6a0-f8ed-2be7-cac52b95e6ea","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"string\",\n \"error\": \"string\",\n \"message\": \"string\",\n \"status\": 6404\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"dcd2ac56-f7f5-4873-af43-f8d4d3092ee1","name":"Forbidden; insufficient permissions","originalRequest":{"url":{"path":["schema-service","v2","screen-views",":screenViewId","feed"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"screenViewId","description":"(Required) UUID of the screen view"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"c862adca-e6a0-f8ed-2be7-cac52b95e6ea","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"string\",\n \"error\": \"string\",\n \"message\": \"string\",\n \"status\": 6404\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"1be74bc9-7645-4df7-bc3c-17789ed0fb4a","name":"Resource not found","originalRequest":{"url":{"path":["schema-service","v2","screen-views",":screenViewId","feed"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"screenViewId","description":"(Required) UUID of the screen view"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"c862adca-e6a0-f8ed-2be7-cac52b95e6ea","options":{"raw":{"language":"json"}}}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"8bf74f7a-77c5-4ac9-873a-efed2571d0c2","name":"See error message for details","originalRequest":{"url":{"path":["schema-service","v2","screen-views",":screenViewId","feed"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"screenViewId","description":"(Required) UUID of the screen view"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"c862adca-e6a0-f8ed-2be7-cac52b95e6ea","options":{"raw":{"language":"json"}}}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"c9161f7e-3688-4233-a43b-880f7357e62c","name":"Rename screen view feed","request":{"name":"Rename screen view feed","description":{"content":"Update the name of a screen view feed.\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User\n\n**API key permission required:** `SCHEMA_SERVICE_SCHEMA_CREATE`\n\n**User role permission required:** `assets_docs: create`\n","type":"text/plain"},"url":{"path":["schema-service","v2","screen-views","feeds",":feedId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"feedId","description":"(Required) UUID of a screen view feed"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"name\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"e922a0d4-69ff-479e-bc09-cc48a9fbda07","name":"Success","originalRequest":{"url":{"path":["schema-service","v2","screen-views","feeds",":feedId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"feedId","description":"(Required) UUID of a screen view feed"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"name\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"id\": \"19596830-d5b3-7eb5-326f-a3a26498c1e7\",\n \"name\": \"string\",\n \"createdAt\": \"1978-12-12T03:23:33.448Z\",\n \"default\": false\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"72ccd3b2-30ec-4853-aca8-af95fcadeb40","name":"See error message for details","originalRequest":{"url":{"path":["schema-service","v2","screen-views","feeds",":feedId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"feedId","description":"(Required) UUID of a screen view feed"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"name\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"1d154b1c-cb06-472d-9538-fed7d05be0de","name":"Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc.","originalRequest":{"url":{"path":["schema-service","v2","screen-views","feeds",":feedId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"feedId","description":"(Required) UUID of a screen view feed"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"name\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"string\",\n \"error\": \"string\",\n \"message\": \"string\",\n \"status\": 6404\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"9e633bdd-4321-4692-a9bb-169ffca09e1b","name":"Forbidden; insufficient permissions","originalRequest":{"url":{"path":["schema-service","v2","screen-views","feeds",":feedId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"feedId","description":"(Required) UUID of a screen view feed"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"name\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"string\",\n \"error\": \"string\",\n \"message\": \"string\",\n \"status\": 6404\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"81be506a-708b-4138-9f03-c9af90a102d8","name":"Resource not found","originalRequest":{"url":{"path":["schema-service","v2","screen-views","feeds",":feedId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"feedId","description":"(Required) UUID of a screen view feed"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"name\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"5047ab70-5b31-4bef-b8f0-7e26d9ad260f","name":"See error message for details","originalRequest":{"url":{"path":["schema-service","v2","screen-views","feeds",":feedId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"feedId","description":"(Required) UUID of a screen view feed"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"name\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"1a288488-f6fa-4d25-8fd9-1913644c3bcf","name":"Delete screen view feed","request":{"name":"Delete screen view feed","description":{"content":"Delete a screen view feed. The screen views currently in this feed are moved to the default feed.\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User\n\n**API key permission required:** `SCHEMA_SERVICE_SCHEMA_DELETE`\n\n**User role permission required:** `assets_docs: delete`\n","type":"text/plain"},"url":{"path":["schema-service","v2","screen-views","feeds",":feedId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"feedId","description":"(Required) UUID of a screen view feed"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"5e37ea8b-fefb-4dd0-86a9-363b13b09ad0","name":"Success","originalRequest":{"url":{"path":["schema-service","v2","screen-views","feeds",":feedId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"feedId","description":"(Required) UUID of a screen view feed"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"id\": \"d24cd5a2-9b3c-3c9e-09ae-d58abca1e2c2\",\n \"slug\": \"string\",\n \"name\": \"string\",\n \"createdAt\": \"2011-10-26T19:47:56.893Z\",\n \"default\": false\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"f115f84f-b978-4ac8-863c-7ba2966cd5a8","name":"See error message for details","originalRequest":{"url":{"path":["schema-service","v2","screen-views","feeds",":feedId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"feedId","description":"(Required) UUID of a screen view feed"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"760a186c-121b-403b-963d-d6b96a111972","name":"Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc.","originalRequest":{"url":{"path":["schema-service","v2","screen-views","feeds",":feedId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"feedId","description":"(Required) UUID of a screen view feed"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"string\",\n \"error\": \"string\",\n \"message\": \"string\",\n \"status\": 6404\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"226ae5ea-1e5a-481a-96d6-7a519e11709f","name":"Forbidden; insufficient permissions","originalRequest":{"url":{"path":["schema-service","v2","screen-views","feeds",":feedId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"feedId","description":"(Required) UUID of a screen view feed"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"string\",\n \"error\": \"string\",\n \"message\": \"string\",\n \"status\": 6404\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"ad6bd8a7-ac5b-4098-abad-cddb7810dae6","name":"Resource not found","originalRequest":{"url":{"path":["schema-service","v2","screen-views","feeds",":feedId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"feedId","description":"(Required) UUID of a screen view feed"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"00700a2f-4bb5-44da-b456-1cf3d0c2e422","name":"See error message for details","originalRequest":{"url":{"path":["schema-service","v2","screen-views","feeds",":feedId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"feedId","description":"(Required) UUID of a screen view feed"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"f8ab3fb7-ab16-4d0a-aa97-59ede660e784","name":"Schedule object","request":{"name":"Schedule object","description":{"content":"Add a schedule to a document or screen view.\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User\n\n**API key permission required:** `SCHEMA_SERVICE_SCHEMA_CREATE`\n\n**User role permission required:** `assets_docs: create`\n","type":"text/plain"},"url":{"path":["schema-service","scheduler","entry"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"externalId\": \"9bd30734-bac6-03f4-e754-beb08979b50f\",\n \"type\": \"SCREENVIEW\",\n \"schedule\": {\n \"enabled\": {\n \"value\": \"\"\n },\n \"endDate\": {\n \"value\": \"\"\n },\n \"endType\": {\n \"value\": \"\"\n },\n \"parts\": {\n \"value\": \"\"\n },\n \"periodType\": {\n \"value\": \"\"\n },\n \"startDate\": {\n \"value\": \"\"\n },\n \"startType\": {\n \"value\": \"\"\n },\n \"timezone\": {\n \"value\": \"\"\n }\n }\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"34e7dff0-78b9-4e39-8365-a221e58f52d4","name":"Schedule added","originalRequest":{"url":{"path":["schema-service","scheduler","entry"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"externalId\": \"9bd30734-bac6-03f4-e754-beb08979b50f\",\n \"type\": \"SCREENVIEW\",\n \"schedule\": {\n \"enabled\": {\n \"value\": \"\"\n },\n \"endDate\": {\n \"value\": \"\"\n },\n \"endType\": {\n \"value\": \"\"\n },\n \"parts\": {\n \"value\": \"\"\n },\n \"periodType\": {\n \"value\": \"\"\n },\n \"startDate\": {\n \"value\": \"\"\n },\n \"startType\": {\n \"value\": \"\"\n },\n \"timezone\": {\n \"value\": \"\"\n }\n }\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"active\": false,\n \"externalId\": \"c2c2c416-e05f-5988-0862-84a86925e3a4\",\n \"type\": \"SCREENVIEW\",\n \"finished\": true,\n \"schedule\": {\n \"enabled\": {\n \"value\": \"\"\n },\n \"endDate\": {\n \"value\": \"\"\n },\n \"endType\": {\n \"value\": \"\"\n },\n \"parts\": {\n \"value\": \"\"\n },\n \"periodType\": {\n \"value\": \"\"\n },\n \"startDate\": {\n \"value\": \"\"\n },\n \"startType\": {\n \"value\": \"\"\n },\n \"timezone\": {\n \"value\": \"\"\n }\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"77bc55d6-60c1-4f3e-b4ec-a10eef280ca3","name":"See error message for details","originalRequest":{"url":{"path":["schema-service","scheduler","entry"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"externalId\": \"9bd30734-bac6-03f4-e754-beb08979b50f\",\n \"type\": \"SCREENVIEW\",\n \"schedule\": {\n \"enabled\": {\n \"value\": \"\"\n },\n \"endDate\": {\n \"value\": \"\"\n },\n \"endType\": {\n \"value\": \"\"\n },\n \"parts\": {\n \"value\": \"\"\n },\n \"periodType\": {\n \"value\": \"\"\n },\n \"startDate\": {\n \"value\": \"\"\n },\n \"startType\": {\n \"value\": \"\"\n },\n \"timezone\": {\n \"value\": \"\"\n }\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"3c30cb81-0804-476d-b1d8-26231f7e050c","name":"Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc.","originalRequest":{"url":{"path":["schema-service","scheduler","entry"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"externalId\": \"9bd30734-bac6-03f4-e754-beb08979b50f\",\n \"type\": \"SCREENVIEW\",\n \"schedule\": {\n \"enabled\": {\n \"value\": \"\"\n },\n \"endDate\": {\n \"value\": \"\"\n },\n \"endType\": {\n \"value\": \"\"\n },\n \"parts\": {\n \"value\": \"\"\n },\n \"periodType\": {\n \"value\": \"\"\n },\n \"startDate\": {\n \"value\": \"\"\n },\n \"startType\": {\n \"value\": \"\"\n },\n \"timezone\": {\n \"value\": \"\"\n }\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"string\",\n \"error\": \"string\",\n \"message\": \"string\",\n \"status\": 6404\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"09b601c6-b1b8-4728-af14-a18916688804","name":"Forbidden; insufficient permissions","originalRequest":{"url":{"path":["schema-service","scheduler","entry"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"externalId\": \"9bd30734-bac6-03f4-e754-beb08979b50f\",\n \"type\": \"SCREENVIEW\",\n \"schedule\": {\n \"enabled\": {\n \"value\": \"\"\n },\n \"endDate\": {\n \"value\": \"\"\n },\n \"endType\": {\n \"value\": \"\"\n },\n \"parts\": {\n \"value\": \"\"\n },\n \"periodType\": {\n \"value\": \"\"\n },\n \"startDate\": {\n \"value\": \"\"\n },\n \"startType\": {\n \"value\": \"\"\n },\n \"timezone\": {\n \"value\": \"\"\n }\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"string\",\n \"error\": \"string\",\n \"message\": \"string\",\n \"status\": 6404\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"bb302fa1-6436-4f50-a0d1-f9cce65245bd","name":"Resource not found","originalRequest":{"url":{"path":["schema-service","scheduler","entry"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"externalId\": \"9bd30734-bac6-03f4-e754-beb08979b50f\",\n \"type\": \"SCREENVIEW\",\n \"schedule\": {\n \"enabled\": {\n \"value\": \"\"\n },\n \"endDate\": {\n \"value\": \"\"\n },\n \"endType\": {\n \"value\": \"\"\n },\n \"parts\": {\n \"value\": \"\"\n },\n \"periodType\": {\n \"value\": \"\"\n },\n \"startDate\": {\n \"value\": \"\"\n },\n \"startType\": {\n \"value\": \"\"\n },\n \"timezone\": {\n \"value\": \"\"\n }\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"30f7a735-9a50-4449-aa01-de90d09059bc","name":"See error message for details","originalRequest":{"url":{"path":["schema-service","scheduler","entry"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"externalId\": \"9bd30734-bac6-03f4-e754-beb08979b50f\",\n \"type\": \"SCREENVIEW\",\n \"schedule\": {\n \"enabled\": {\n \"value\": \"\"\n },\n \"endDate\": {\n \"value\": \"\"\n },\n \"endType\": {\n \"value\": \"\"\n },\n \"parts\": {\n \"value\": \"\"\n },\n \"periodType\": {\n \"value\": \"\"\n },\n \"startDate\": {\n \"value\": \"\"\n },\n \"startType\": {\n \"value\": \"\"\n },\n \"timezone\": {\n \"value\": \"\"\n }\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"3e837bae-a1f9-4437-af42-cee846be578c","name":"Get schedule the schedule of an object","request":{"name":"Get schedule the schedule of an object","description":{"content":"Get schedule object.\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User\n\n**API key permission required:** `SCHEMA_SERVICE_SCHEMA_CREATE`\n\n**User role permission required:** `assets_docs: create`\n","type":"text/plain"},"url":{"path":["schema-service","scheduler","entry",":objectType",":objectId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"objectId","description":"(Required) Screen view or document ID"},{"disabled":false,"type":"any","value":"DOCUMENT","key":"objectType","description":"(Required) Object type"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"6bd561be-7415-47ee-8f81-ec55c3c0b04c","name":"Schedule details","originalRequest":{"url":{"path":["schema-service","scheduler","entry",":objectType",":objectId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"objectId","description":"(Required) Screen view or document ID"},{"disabled":false,"type":"any","value":"DOCUMENT","key":"objectType","description":"(Required) Object type"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"active\": false,\n \"externalId\": \"c2c2c416-e05f-5988-0862-84a86925e3a4\",\n \"type\": \"SCREENVIEW\",\n \"finished\": true,\n \"schedule\": {\n \"enabled\": {\n \"value\": \"\"\n },\n \"endDate\": {\n \"value\": \"\"\n },\n \"endType\": {\n \"value\": \"\"\n },\n \"parts\": {\n \"value\": \"\"\n },\n \"periodType\": {\n \"value\": \"\"\n },\n \"startDate\": {\n \"value\": \"\"\n },\n \"startType\": {\n \"value\": \"\"\n },\n \"timezone\": {\n \"value\": \"\"\n }\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"734ea108-7ce8-41a4-b9a6-92de210fdcfd","name":"See error message for details","originalRequest":{"url":{"path":["schema-service","scheduler","entry",":objectType",":objectId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"objectId","description":"(Required) Screen view or document ID"},{"disabled":false,"type":"any","value":"DOCUMENT","key":"objectType","description":"(Required) Object type"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"7cd06dcf-97ae-45bf-891f-3ec3f9af84ac","name":"Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc.","originalRequest":{"url":{"path":["schema-service","scheduler","entry",":objectType",":objectId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"objectId","description":"(Required) Screen view or document ID"},{"disabled":false,"type":"any","value":"DOCUMENT","key":"objectType","description":"(Required) Object type"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"string\",\n \"error\": \"string\",\n \"message\": \"string\",\n \"status\": 6404\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"98f50179-59c2-44fd-9df6-acbbc51f8761","name":"Forbidden; insufficient permissions","originalRequest":{"url":{"path":["schema-service","scheduler","entry",":objectType",":objectId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"objectId","description":"(Required) Screen view or document ID"},{"disabled":false,"type":"any","value":"DOCUMENT","key":"objectType","description":"(Required) Object type"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"string\",\n \"error\": \"string\",\n \"message\": \"string\",\n \"status\": 6404\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"9c759880-608d-4bf6-b179-f904c4bcc7c9","name":"Resource not found","originalRequest":{"url":{"path":["schema-service","scheduler","entry",":objectType",":objectId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"objectId","description":"(Required) Screen view or document ID"},{"disabled":false,"type":"any","value":"DOCUMENT","key":"objectType","description":"(Required) Object type"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"65a21d5b-6899-4094-873d-72680fe9f80f","name":"Object has no schedule; or an exception occurred.","originalRequest":{"url":{"path":["schema-service","scheduler","entry",":objectType",":objectId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"objectId","description":"(Required) Screen view or document ID"},{"disabled":false,"type":"any","value":"DOCUMENT","key":"objectType","description":"(Required) Object type"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"f62b32bf-3737-4d12-94cd-70d1f530231e","name":"Finish screen view","request":{"name":"Finish screen view","description":{"content":"Finish a screen view. A finished document is no longer displayed.\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User\n\n**API key permission required:** `SCHEMA_SERVICE_SCHEMA_CREATE`\n\n**User role permission required:** `assets_docs: create`\n","type":"text/plain"},"url":{"path":["schema-service","v2","screen-views",":screenViewId","status","finish"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"screenViewId","description":"(Required) UUID of the screen view"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"4b7ea8b8-7d3a-4ab1-af24-9a2f05bf9551","name":"Success","originalRequest":{"url":{"path":["schema-service","v2","screen-views",":screenViewId","status","finish"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"screenViewId","description":"(Required) UUID of the screen view"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"status\": \"string\",\n \"body\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"b7119fb8-1ac0-48ec-8019-c4934254dde1","name":"See error message for details","originalRequest":{"url":{"path":["schema-service","v2","screen-views",":screenViewId","status","finish"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"screenViewId","description":"(Required) UUID of the screen view"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"fe3eeb99-c82e-45de-85f9-b422705a6120","name":"Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc.","originalRequest":{"url":{"path":["schema-service","v2","screen-views",":screenViewId","status","finish"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"screenViewId","description":"(Required) UUID of the screen view"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"string\",\n \"error\": \"string\",\n \"message\": \"string\",\n \"status\": 6404\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"aab9f7cc-0aa5-495b-b5d8-18d5afd6d850","name":"Forbidden; insufficient permissions","originalRequest":{"url":{"path":["schema-service","v2","screen-views",":screenViewId","status","finish"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"screenViewId","description":"(Required) UUID of the screen view"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"string\",\n \"error\": \"string\",\n \"message\": \"string\",\n \"status\": 6404\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"0c92ae7b-78ad-4cea-8e28-657323c4639b","name":"Resource not found","originalRequest":{"url":{"path":["schema-service","v2","screen-views",":screenViewId","status","finish"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"screenViewId","description":"(Required) UUID of the screen view"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"15e78b2f-c44d-4309-99eb-ff6cc7932e29","name":"See error message for details","originalRequest":{"url":{"path":["schema-service","v2","screen-views",":screenViewId","status","finish"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"screenViewId","description":"(Required) UUID of the screen view"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"8c539f3f-0784-48d2-b93f-d2ea6c8f50af","name":"Resume screen view","request":{"name":"Resume screen view","description":{"content":"Resume a screen view that was paused.\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User\n\n**API key permission required:** `SCHEMA_SERVICE_SCHEMA_CREATE`\n\n**User role permission required:** `assets_docs: create`\n","type":"text/plain"},"url":{"path":["schema-service","v2","screen-views",":screenViewId","status","resume"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"screenViewId","description":"(Required) UUID of the screen view"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"589b4f95-e659-4f44-9371-20a72d156708","name":"Success","originalRequest":{"url":{"path":["schema-service","v2","screen-views",":screenViewId","status","resume"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"screenViewId","description":"(Required) UUID of the screen view"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"status\": \"string\",\n \"body\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"b8cceeed-b017-4bdd-8597-4d98a7043851","name":"See error message for details","originalRequest":{"url":{"path":["schema-service","v2","screen-views",":screenViewId","status","resume"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"screenViewId","description":"(Required) UUID of the screen view"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"546b82d9-b395-45de-9f05-6973658953e3","name":"Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc.","originalRequest":{"url":{"path":["schema-service","v2","screen-views",":screenViewId","status","resume"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"screenViewId","description":"(Required) UUID of the screen view"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"string\",\n \"error\": \"string\",\n \"message\": \"string\",\n \"status\": 6404\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"3c67d453-61c5-44e9-856a-d9d6ef61ecca","name":"Forbidden; insufficient permissions","originalRequest":{"url":{"path":["schema-service","v2","screen-views",":screenViewId","status","resume"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"screenViewId","description":"(Required) UUID of the screen view"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"string\",\n \"error\": \"string\",\n \"message\": \"string\",\n \"status\": 6404\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"b8f198ad-8fd5-4444-a28b-0c4d46a13a7e","name":"Resource not found","originalRequest":{"url":{"path":["schema-service","v2","screen-views",":screenViewId","status","resume"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"screenViewId","description":"(Required) UUID of the screen view"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"a56bc848-6433-424a-b3fd-d61cfeff83b4","name":"See error message for details","originalRequest":{"url":{"path":["schema-service","v2","screen-views",":screenViewId","status","resume"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"screenViewId","description":"(Required) UUID of the screen view"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"a0ae137e-0651-4d85-a3da-fa188b467898","name":"Activate screen view","request":{"name":"Activate screen view","description":{"content":"Activate a screen view. It can be displayed to customers.\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User\n\n**API key permission required:** `SCHEMA_SERVICE_SCHEMA_CREATE`\n\n**User role permission required:** `assets_docs: create`\n","type":"text/plain"},"url":{"path":["schema-service","v2","screen-views",":screenViewId","status","activate"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"screenViewId","description":"(Required) UUID of the screen view"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"8298c08d-42d7-4698-9769-dc2399e5c128","name":"Success","originalRequest":{"url":{"path":["schema-service","v2","screen-views",":screenViewId","status","activate"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"screenViewId","description":"(Required) UUID of the screen view"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"status\": \"string\",\n \"body\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"4b536ce8-dbcd-4cda-8eb0-581bfd9c49be","name":"See error message for details","originalRequest":{"url":{"path":["schema-service","v2","screen-views",":screenViewId","status","activate"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"screenViewId","description":"(Required) UUID of the screen view"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"f96076f5-d8ae-49a6-a7be-c9b2d72f3681","name":"Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc.","originalRequest":{"url":{"path":["schema-service","v2","screen-views",":screenViewId","status","activate"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"screenViewId","description":"(Required) UUID of the screen view"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"string\",\n \"error\": \"string\",\n \"message\": \"string\",\n \"status\": 6404\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"52245233-8ac5-44c7-b4f0-753f532c43d5","name":"Forbidden; insufficient permissions","originalRequest":{"url":{"path":["schema-service","v2","screen-views",":screenViewId","status","activate"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"screenViewId","description":"(Required) UUID of the screen view"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"string\",\n \"error\": \"string\",\n \"message\": \"string\",\n \"status\": 6404\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"4ea44ebe-48b9-4c93-b0e0-422a84e75360","name":"Resource not found","originalRequest":{"url":{"path":["schema-service","v2","screen-views",":screenViewId","status","activate"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"screenViewId","description":"(Required) UUID of the screen view"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"5487e425-bc48-4f43-a9b4-37a8f1cdf153","name":"See error message for details","originalRequest":{"url":{"path":["schema-service","v2","screen-views",":screenViewId","status","activate"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"screenViewId","description":"(Required) UUID of the screen view"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"419ab9c8-51e6-42d5-bd36-dbb741d547d3","name":"Pause screen view","request":{"name":"Pause screen view","description":{"content":"Pause a screen view. Until resumed, it can't be displayed to customers.\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User\n\n**API key permission required:** `SCHEMA_SERVICE_SCHEMA_CREATE`\n\n**User role permission required:** `assets_docs: create`\n","type":"text/plain"},"url":{"path":["schema-service","v2","screen-views",":screenViewId","status","pause"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"screenViewId","description":"(Required) UUID of the screen view"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"69607fd2-d712-4d50-a216-9b5354b2adaa","name":"Success","originalRequest":{"url":{"path":["schema-service","v2","screen-views",":screenViewId","status","pause"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"screenViewId","description":"(Required) UUID of the screen view"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"status\": \"string\",\n \"body\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"8df8ecca-74a6-4fa5-8e28-7bb9409d47bf","name":"See error message for details","originalRequest":{"url":{"path":["schema-service","v2","screen-views",":screenViewId","status","pause"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"screenViewId","description":"(Required) UUID of the screen view"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"870c7590-cd66-4dba-b9ee-3e823ebb9158","name":"Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc.","originalRequest":{"url":{"path":["schema-service","v2","screen-views",":screenViewId","status","pause"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"screenViewId","description":"(Required) UUID of the screen view"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"string\",\n \"error\": \"string\",\n \"message\": \"string\",\n \"status\": 6404\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"6e5af2e4-6859-4e5f-97c6-3f80a359bf99","name":"Forbidden; insufficient permissions","originalRequest":{"url":{"path":["schema-service","v2","screen-views",":screenViewId","status","pause"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"screenViewId","description":"(Required) UUID of the screen view"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"string\",\n \"error\": \"string\",\n \"message\": \"string\",\n \"status\": 6404\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"c94657a3-d1ab-4f06-a178-4175eedd0bcb","name":"Resource not found","originalRequest":{"url":{"path":["schema-service","v2","screen-views",":screenViewId","status","pause"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"screenViewId","description":"(Required) UUID of the screen view"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"afdbc42e-03b2-434d-b9a3-f278c344ebc3","name":"See error message for details","originalRequest":{"url":{"path":["schema-service","v2","screen-views",":screenViewId","status","pause"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"screenViewId","description":"(Required) UUID of the screen view"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}],"event":[]},{"id":"f4f52f67-2265-400d-b294-4851d320d2c8","name":"Promotions points","description":{"content":"","type":"text/plain"},"item":[{"id":"3dac4e01-af7c-413c-8594-f7cf544c9b5b","name":"Transfer points to another profile","request":{"name":"Transfer points to another profile","description":{"content":"With this method, a profile can send some of their points to another profile.\n\n---\n\n**API consumers:** Profile (Client), Anonymous Profile\n","type":"text/plain"},"url":{"path":["v4","promotions","v2","points","transfer"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"pointsAmount\": 7383,\n \"recipient\": {\n \"clientKey\": {\n \"value\": \"\"\n },\n \"clientKeyValue\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n },\n \"sender\": {\n \"name\": {\n \"value\": \"\"\n }\n },\n \"message\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"3812ab7c-f421-48b1-b617-8e5cc09688b3","name":"Point transfer scheduled","originalRequest":{"url":{"path":["v4","promotions","v2","points","transfer"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"pointsAmount\": 7383,\n \"recipient\": {\n \"clientKey\": {\n \"value\": \"\"\n },\n \"clientKeyValue\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n },\n \"sender\": {\n \"name\": {\n \"value\": \"\"\n }\n },\n \"message\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Accepted","code":202,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"message\": \"Point transfer scheduled\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"5f924d36-f7f2-4cb3-a4a3-44476a069172","name":"Bad request","originalRequest":{"url":{"path":["v4","promotions","v2","points","transfer"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"pointsAmount\": 7383,\n \"recipient\": {\n \"clientKey\": {\n \"value\": \"\"\n },\n \"clientKeyValue\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n },\n \"sender\": {\n \"name\": {\n \"value\": \"\"\n }\n },\n \"message\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"errorCode\": \"ERR-042\",\n \"httpStatus\": 400,\n \"message\": \"Invalid data\",\n \"timestamp\": \"2020-10-05T10:59:21.000Z\",\n \"traceId\": \"8705651679b203e7\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"5478539a-b521-4779-a2c8-81d7464c4059","name":"Profile not found","originalRequest":{"url":{"path":["v4","promotions","v2","points","transfer"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"pointsAmount\": 7383,\n \"recipient\": {\n \"clientKey\": {\n \"value\": \"\"\n },\n \"clientKeyValue\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n },\n \"sender\": {\n \"name\": {\n \"value\": \"\"\n }\n },\n \"message\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"errorCode\": \"CLI-001\",\n \"httpStatus\": 404,\n \"message\": \"Profile not found\",\n \"timestamp\": \"2020-10-05T10:59:21.000Z\",\n \"traceId\": \"8705651679b203e7\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"8ca5c80a-c8fa-4d16-afd1-f255cae61b07","name":"Unprocessable point transfer","originalRequest":{"url":{"path":["v4","promotions","v2","points","transfer"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"pointsAmount\": 7383,\n \"recipient\": {\n \"clientKey\": {\n \"value\": \"\"\n },\n \"clientKeyValue\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n },\n \"sender\": {\n \"name\": {\n \"value\": \"\"\n }\n },\n \"message\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"value\": \"\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"5d7fc9ea-33cc-4855-b12d-b656cb260549","name":"Profile points lock error","originalRequest":{"url":{"path":["v4","promotions","v2","points","transfer"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"pointsAmount\": 7383,\n \"recipient\": {\n \"clientKey\": {\n \"value\": \"\"\n },\n \"clientKeyValue\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n },\n \"sender\": {\n \"name\": {\n \"value\": \"\"\n }\n },\n \"message\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Locked (WebDAV) (RFC 4918)","code":423,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"errorCode\": \"PRO-016\",\n \"httpStatus\": 423,\n \"message\": \"Profile points are locked. Waiting for releasing lock for the profile.\",\n \"timestamp\": \"2020-10-05T10:59:21.000Z\",\n \"traceId\": \"8705651679b203e7\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}],"event":[]},{"id":"53d8a545-fe11-4c82-8c9c-7bcb208d0c10","name":"Promotion settings","description":{"content":"","type":"text/plain"},"item":[{"id":"48e89de9-d014-4e66-a6bb-4650ee7f298b","name":"Get settings for current Workspace","request":{"name":"Get settings for current Workspace","description":{"content":"\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User\n\n**API key permission required:** `PROMOTIONS_SETTINGS_PROMOTIONS_READ`\n\n**User role permission required:** `campaigns_personalised_promotions: read`\n","type":"text/plain"},"url":{"path":["v4","promotions","settings"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"only","value":"saleSettings.combineBasketDiscounts","description":"Return only the settings property at this dotted path (e.g. `saleSettings.discountOrder.strategy`) instead of the whole settings object. Responds with 404 when the property is not defined.\n"},{"disabled":false,"key":"withDefaults","value":"false","description":"When true, missing values are filled from the server-side defaults before the response is built. Combined with `only`, a property that has a configured default resolves even when the Workspace has not stored it; a property without a default still responds with 404.\n"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":null},"response":[{"id":"a8e7da77-3587-40f2-a4cb-20725a774f1a","name":"OK","originalRequest":{"url":{"path":["v4","promotions","settings"],"host":["{{baseUrl}}"],"query":[{"key":"only","value":"saleSettings.combineBasketDiscounts"},{"key":"withDefaults","value":"false"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"data\": {\n \"expression\": \"xxxxxxx-d047-40fd-99c8-yyyyxxxxyyy\",\n \"blockTag\": \"BLOCK_PROMOTIONS\",\n \"checkoutSettings\": {\n \"handbilUuids\": [\n \"1eb6c8f0-dc7a-4d9c-9e0e-bb995ee87699\"\n ]\n },\n \"cashbackSettings\": {\n \"exchangeRate\": 10,\n \"limits\": {\n \"minPoints\": 10,\n \"maxPoints\": 100,\n \"maxTransactionAmount\": 80,\n \"maxTransactionPercentage\": 60\n }\n },\n \"promotionListSettings\": {\n \"fields\": [\n \"code\",\n \"possibleRedeems\",\n \"lastingAt\",\n \"vouchers\"\n ],\n \"sort\": \"NONE\",\n \"limit\": 200,\n \"where\": {\n \"status\": [\n \"ASSIGNED\",\n \"ACTIVE\"\n ],\n \"type\": [\n \"CUSTOM\",\n \"MEMBERS_ONLY\",\n \"HANDBILL\"\n ],\n \"target\": [\n \"ALL\",\n \"SEGMENT\"\n ],\n \"tagNames\": null,\n \"lastingOnly\": true,\n \"presentOnly\": true,\n \"statusByType\": {\n \"CUSTOM\": [\n \"ACTIVE\"\n ],\n \"HANDBILL\": [\n \"ASSIGNED\"\n ]\n },\n \"targetByType\": {\n \"CUSTOM\": [\n \"ALL\"\n ],\n \"HANDBILL\": [\n \"ALL\"\n ],\n \"MEMBERS_ONLY\": [\n \"SEGMENT\"\n ]\n },\n \"visibilityStatus\": [\n \"PUBLISH\",\n \"HIDDEN\"\n ]\n }\n }\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"48dc23cd-a627-4d09-a7ff-d65f036ef917","name":"Request body invalid/malformed/missing elements","originalRequest":{"url":{"path":["v4","promotions","settings"],"host":["{{baseUrl}}"],"query":[{"key":"only","value":"saleSettings.combineBasketDiscounts"},{"key":"withDefaults","value":"false"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"message\": {\n \"value\": \"\"\n },\n \"error\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"87c4db99-5257-4db9-b855-e079a9c5abf9","name":"Unauthorized","originalRequest":{"url":{"path":["v4","promotions","settings"],"host":["{{baseUrl}}"],"query":[{"key":"only","value":"saleSettings.combineBasketDiscounts"},{"key":"withDefaults","value":"false"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"status\": 7751,\n \"error\": \"string\",\n \"message\": \"string\",\n \"timestamp\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"4844d67a-f9e5-4709-9e07-fdf0e6f6e085","name":"Forbidden","originalRequest":{"url":{"path":["v4","promotions","settings"],"host":["{{baseUrl}}"],"query":[{"key":"only","value":"saleSettings.combineBasketDiscounts"},{"key":"withDefaults","value":"false"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"status\": 7751,\n \"error\": \"string\",\n \"message\": \"string\",\n \"timestamp\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"d721c032-eb4c-404c-971f-9137128325bf","name":"Not Found","originalRequest":{"url":{"path":["v4","promotions","settings"],"host":["{{baseUrl}}"],"query":[{"key":"only","value":"saleSettings.combineBasketDiscounts"},{"key":"withDefaults","value":"false"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"status\": 7751,\n \"error\": \"string\",\n \"message\": \"string\",\n \"timestamp\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"5eb4f548-5244-4d7f-82f0-7ac1438b5134","name":"Update settings for current Workspace","request":{"name":"Update settings for current Workspace","description":{"content":"This method overrides all current settings. If you do not send a setting that currently exists, it will be reverted to default value.\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User\n\n**API key permission required:** `PROMOTIONS_SETTINGS_PROMOTIONS_UPDATE`\n\n**User role permission required:** `campaigns_personalised_promotions: update`\n","type":"text/plain"},"url":{"path":["v4","promotions","settings"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PUT","auth":null,"body":{"mode":"raw","raw":"{\n \"checkoutSettings\": {\n \"handbillUuidsForCheckout\": {\n \"value\": \"\"\n },\n \"codeGeneration\": {\n \"value\": \"\"\n }\n },\n \"enableCodeGeneration\": true,\n \"codePrefix\": \"SYN\",\n \"blockTag\": \"BLOCKED\",\n \"expression\": \"7041a782-8b78-fac4-6b2f-d39db75fdabd\",\n \"promotionListSettings\": {\n \"value\": \"\"\n },\n \"promotionAssignmentSettings\": {\n \"value\": \"\"\n },\n \"restorePointsOnProfileDeactivation\": true,\n \"allowRedeemCompletionWhenBlocked\": false,\n \"saleSettings\": {\n \"discountSourceType\": {\n \"value\": \"\"\n },\n \"clientIdCardType\": {\n \"value\": \"\"\n },\n \"handbillCheckout\": {\n \"value\": \"\"\n },\n \"priceValueBaseStrategy\": {\n \"value\": \"\"\n },\n \"combineBasketDiscounts\": {\n \"value\": \"\"\n },\n \"discountOrder\": {\n \"value\": \"\"\n },\n \"returnFields\": {\n \"value\": \"\"\n }\n },\n \"lockSettings\": {\n \"lockPromotionRequestByIdentifier\": {\n \"value\": \"\"\n },\n \"promotionRequestedLockTtl\": {\n \"value\": \"\"\n },\n \"processSalePromotionActivationLockWaitTime\": {\n \"value\": \"\"\n }\n },\n \"transferSettings\": [\n {\n \"value\": \"\"\n }\n ],\n \"cashbackSettings\": {\n \"exchangeRate\": {\n \"value\": \"\"\n },\n \"limits\": {\n \"value\": \"\"\n }\n },\n \"behavioralFilter\": {\n \"productBuyHistory\": {\n \"value\": \"\"\n }\n }\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"f6c859eb-1ed2-423e-8889-01e68160b89a","name":"OK","originalRequest":{"url":{"path":["v4","promotions","settings"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"{\n \"checkoutSettings\": {\n \"handbillUuidsForCheckout\": {\n \"value\": \"\"\n },\n \"codeGeneration\": {\n \"value\": \"\"\n }\n },\n \"enableCodeGeneration\": true,\n \"codePrefix\": \"SYN\",\n \"blockTag\": \"BLOCKED\",\n \"expression\": \"7041a782-8b78-fac4-6b2f-d39db75fdabd\",\n \"promotionListSettings\": {\n \"value\": \"\"\n },\n \"promotionAssignmentSettings\": {\n \"value\": \"\"\n },\n \"restorePointsOnProfileDeactivation\": true,\n \"allowRedeemCompletionWhenBlocked\": false,\n \"saleSettings\": {\n \"discountSourceType\": {\n \"value\": \"\"\n },\n \"clientIdCardType\": {\n \"value\": \"\"\n },\n \"handbillCheckout\": {\n \"value\": \"\"\n },\n \"priceValueBaseStrategy\": {\n \"value\": \"\"\n },\n \"combineBasketDiscounts\": {\n \"value\": \"\"\n },\n \"discountOrder\": {\n \"value\": \"\"\n },\n \"returnFields\": {\n \"value\": \"\"\n }\n },\n \"lockSettings\": {\n \"lockPromotionRequestByIdentifier\": {\n \"value\": \"\"\n },\n \"promotionRequestedLockTtl\": {\n \"value\": \"\"\n },\n \"processSalePromotionActivationLockWaitTime\": {\n \"value\": \"\"\n }\n },\n \"transferSettings\": [\n {\n \"value\": \"\"\n }\n ],\n \"cashbackSettings\": {\n \"exchangeRate\": {\n \"value\": \"\"\n },\n \"limits\": {\n \"value\": \"\"\n }\n },\n \"behavioralFilter\": {\n \"productBuyHistory\": {\n \"value\": \"\"\n }\n }\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"application/json\": {\n \"data\": {\n \"expression\": \"xxxxxxx-d047-40fd-99c8-yyyyxxxxyyy\",\n \"blockTag\": \"BLOCK_PROMOTIONS\",\n \"promotionListSettings\": {\n \"fields\": [\n \"code\",\n \"possibleRedeems\",\n \"lastingAt\",\n \"vouchers\"\n ],\n \"sort\": \"NONE\",\n \"limit\": 200,\n \"where\": {\n \"status\": [\n \"ASSIGNED\",\n \"ACTIVE\"\n ],\n \"type\": [\n \"CUSTOM\",\n \"MEMBERS_ONLY\",\n \"HANDBILL\"\n ],\n \"target\": [\n \"ALL\",\n \"SEGMENT\"\n ],\n \"tagNames\": null,\n \"lastingOnly\": true,\n \"presentOnly\": true,\n \"statusByType\": {\n \"CUSTOM\": [\n \"ACTIVE\"\n ],\n \"HANDBILL\": [\n \"ASSIGNED\"\n ]\n },\n \"targetByType\": {\n \"CUSTOM\": [\n \"ALL\"\n ],\n \"HANDBILL\": [\n \"ALL\"\n ],\n \"MEMBERS_ONLY\": [\n \"SEGMENT\"\n ]\n },\n \"visibilityStatus\": [\n \"PUBLISH\",\n \"HIDDEN\"\n ]\n }\n }\n }\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"4f8ce7f1-a515-40cb-b314-eac5df919b21","name":"Request body invalid/malformed/missing elements","originalRequest":{"url":{"path":["v4","promotions","settings"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"{\n \"checkoutSettings\": {\n \"handbillUuidsForCheckout\": {\n \"value\": \"\"\n },\n \"codeGeneration\": {\n \"value\": \"\"\n }\n },\n \"enableCodeGeneration\": true,\n \"codePrefix\": \"SYN\",\n \"blockTag\": \"BLOCKED\",\n \"expression\": \"7041a782-8b78-fac4-6b2f-d39db75fdabd\",\n \"promotionListSettings\": {\n \"value\": \"\"\n },\n \"promotionAssignmentSettings\": {\n \"value\": \"\"\n },\n \"restorePointsOnProfileDeactivation\": true,\n \"allowRedeemCompletionWhenBlocked\": false,\n \"saleSettings\": {\n \"discountSourceType\": {\n \"value\": \"\"\n },\n \"clientIdCardType\": {\n \"value\": \"\"\n },\n \"handbillCheckout\": {\n \"value\": \"\"\n },\n \"priceValueBaseStrategy\": {\n \"value\": \"\"\n },\n \"combineBasketDiscounts\": {\n \"value\": \"\"\n },\n \"discountOrder\": {\n \"value\": \"\"\n },\n \"returnFields\": {\n \"value\": \"\"\n }\n },\n \"lockSettings\": {\n \"lockPromotionRequestByIdentifier\": {\n \"value\": \"\"\n },\n \"promotionRequestedLockTtl\": {\n \"value\": \"\"\n },\n \"processSalePromotionActivationLockWaitTime\": {\n \"value\": \"\"\n }\n },\n \"transferSettings\": [\n {\n \"value\": \"\"\n }\n ],\n \"cashbackSettings\": {\n \"exchangeRate\": {\n \"value\": \"\"\n },\n \"limits\": {\n \"value\": \"\"\n }\n },\n \"behavioralFilter\": {\n \"productBuyHistory\": {\n \"value\": \"\"\n }\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"message\": {\n \"value\": \"\"\n },\n \"error\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"979034cd-0546-47dc-89d9-cdbfb9f49071","name":"Unauthorized","originalRequest":{"url":{"path":["v4","promotions","settings"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"{\n \"checkoutSettings\": {\n \"handbillUuidsForCheckout\": {\n \"value\": \"\"\n },\n \"codeGeneration\": {\n \"value\": \"\"\n }\n },\n \"enableCodeGeneration\": true,\n \"codePrefix\": \"SYN\",\n \"blockTag\": \"BLOCKED\",\n \"expression\": \"7041a782-8b78-fac4-6b2f-d39db75fdabd\",\n \"promotionListSettings\": {\n \"value\": \"\"\n },\n \"promotionAssignmentSettings\": {\n \"value\": \"\"\n },\n \"restorePointsOnProfileDeactivation\": true,\n \"allowRedeemCompletionWhenBlocked\": false,\n \"saleSettings\": {\n \"discountSourceType\": {\n \"value\": \"\"\n },\n \"clientIdCardType\": {\n \"value\": \"\"\n },\n \"handbillCheckout\": {\n \"value\": \"\"\n },\n \"priceValueBaseStrategy\": {\n \"value\": \"\"\n },\n \"combineBasketDiscounts\": {\n \"value\": \"\"\n },\n \"discountOrder\": {\n \"value\": \"\"\n },\n \"returnFields\": {\n \"value\": \"\"\n }\n },\n \"lockSettings\": {\n \"lockPromotionRequestByIdentifier\": {\n \"value\": \"\"\n },\n \"promotionRequestedLockTtl\": {\n \"value\": \"\"\n },\n \"processSalePromotionActivationLockWaitTime\": {\n \"value\": \"\"\n }\n },\n \"transferSettings\": [\n {\n \"value\": \"\"\n }\n ],\n \"cashbackSettings\": {\n \"exchangeRate\": {\n \"value\": \"\"\n },\n \"limits\": {\n \"value\": \"\"\n }\n },\n \"behavioralFilter\": {\n \"productBuyHistory\": {\n \"value\": \"\"\n }\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"status\": 7751,\n \"error\": \"string\",\n \"message\": \"string\",\n \"timestamp\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"be119d06-72ad-44cb-8ef3-99314d5cc293","name":"Forbidden","originalRequest":{"url":{"path":["v4","promotions","settings"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"{\n \"checkoutSettings\": {\n \"handbillUuidsForCheckout\": {\n \"value\": \"\"\n },\n \"codeGeneration\": {\n \"value\": \"\"\n }\n },\n \"enableCodeGeneration\": true,\n \"codePrefix\": \"SYN\",\n \"blockTag\": \"BLOCKED\",\n \"expression\": \"7041a782-8b78-fac4-6b2f-d39db75fdabd\",\n \"promotionListSettings\": {\n \"value\": \"\"\n },\n \"promotionAssignmentSettings\": {\n \"value\": \"\"\n },\n \"restorePointsOnProfileDeactivation\": true,\n \"allowRedeemCompletionWhenBlocked\": false,\n \"saleSettings\": {\n \"discountSourceType\": {\n \"value\": \"\"\n },\n \"clientIdCardType\": {\n \"value\": \"\"\n },\n \"handbillCheckout\": {\n \"value\": \"\"\n },\n \"priceValueBaseStrategy\": {\n \"value\": \"\"\n },\n \"combineBasketDiscounts\": {\n \"value\": \"\"\n },\n \"discountOrder\": {\n \"value\": \"\"\n },\n \"returnFields\": {\n \"value\": \"\"\n }\n },\n \"lockSettings\": {\n \"lockPromotionRequestByIdentifier\": {\n \"value\": \"\"\n },\n \"promotionRequestedLockTtl\": {\n \"value\": \"\"\n },\n \"processSalePromotionActivationLockWaitTime\": {\n \"value\": \"\"\n }\n },\n \"transferSettings\": [\n {\n \"value\": \"\"\n }\n ],\n \"cashbackSettings\": {\n \"exchangeRate\": {\n \"value\": \"\"\n },\n \"limits\": {\n \"value\": \"\"\n }\n },\n \"behavioralFilter\": {\n \"productBuyHistory\": {\n \"value\": \"\"\n }\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"status\": 7751,\n \"error\": \"string\",\n \"message\": \"string\",\n \"timestamp\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}],"event":[]},{"id":"4c64cce9-b4cf-4362-b752-1f69781e02fc","name":"Promotion locks","description":{"content":"","type":"text/plain"},"item":[{"id":"c8b7973d-6318-41a3-9456-db5b89cb1e23","name":"Check account lock","request":{"name":"Check account lock","description":{"content":"You can check if a Profile account is locked due to processing of batch promotion/voucher activations or deactivations.\n\n\nYou must be logged in as the Profile.\n\n---\n\n**API consumers:** Profile (Client), Anonymous Profile\n","type":"text/plain"},"url":{"path":["v4","promotions","promotion","locking","check-client"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"daead9b5-eda8-408e-81bc-db8e55915688","name":"Information about Profile lock","originalRequest":{"url":{"path":["v4","promotions","promotion","locking","check-client"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"message\": \"Profile is unlocked and ready for traffic\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"073d1a42-fb09-4f13-980e-8e6115848b3c","name":"Request body invalid/malformed/missing elements","originalRequest":{"url":{"path":["v4","promotions","promotion","locking","check-client"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"message\": {\n \"value\": \"\"\n },\n \"error\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"c3767a31-2909-4f69-ae07-6fb320cd2f88","name":"Unauthorized","originalRequest":{"url":{"path":["v4","promotions","promotion","locking","check-client"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"status\": 7751,\n \"error\": \"string\",\n \"message\": \"string\",\n \"timestamp\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"a1dcd112-eac7-4b8d-b1c7-b7c513031a05","name":"Forbidden","originalRequest":{"url":{"path":["v4","promotions","promotion","locking","check-client"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"status\": 7751,\n \"error\": \"string\",\n \"message\": \"string\",\n \"timestamp\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"68437d4d-83ef-43c3-91b1-f86c98ae9ab0","name":"Create point lock for profile","request":{"name":"Create point lock for profile","description":{"content":"Create a point lock for a profile. That profile cannot activate or de-activate promotions based on loyalty points until the lock is released. The profile can still redeem promotions. \nThis lock is released with the [\"Release point lock for profile\" endpoint](#operation/endpointLockReleaseLockForClientPOST) or when its TTL (defined in the query parameters) expires.\n\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User\n\n**API key permission required:** `PROMOTIONS_LOCK_UPDATE`\n\n**User role permission required:** `campaigns_promotions: update`\n","type":"text/plain"},"url":{"path":["v4","promotions","lock","create-points-lock-for-client",":identifierType",":identifierValue"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"lockTtlSec","value":"900","description":"Lock duration in seconds"}],"variable":[{"disabled":false,"type":"any","value":"email","key":"identifierType","description":"(Required) The Profile identifier to use for the request.\n\n`externalId` is known as `customId` or `custom_identify` in other Synerise services.\n"},{"disabled":false,"type":"any","value":"string","key":"identifierValue","description":"(Required) The value of the selected identifier"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"5c79cad9-6660-4830-bc56-f710cb398b85","name":"Lock created","originalRequest":{"url":{"path":["v4","promotions","lock","create-points-lock-for-client",":identifierType",":identifierValue"],"host":["{{baseUrl}}"],"query":[{"key":"lockTtlSec","value":"900"}],"variable":[{"disabled":false,"type":"any","value":"email","key":"identifierType","description":"(Required) The Profile identifier to use for the request.\n\n`externalId` is known as `customId` or `custom_identify` in other Synerise services.\n"},{"disabled":false,"type":"any","value":"string","key":"identifierValue","description":"(Required) The value of the selected identifier"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"callback\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"7ea13753-0f5a-4e0a-8121-f37c699881f0","name":"Request body invalid/malformed/missing elements","originalRequest":{"url":{"path":["v4","promotions","lock","create-points-lock-for-client",":identifierType",":identifierValue"],"host":["{{baseUrl}}"],"query":[{"key":"lockTtlSec","value":"900"}],"variable":[{"disabled":false,"type":"any","value":"email","key":"identifierType","description":"(Required) The Profile identifier to use for the request.\n\n`externalId` is known as `customId` or `custom_identify` in other Synerise services.\n"},{"disabled":false,"type":"any","value":"string","key":"identifierValue","description":"(Required) The value of the selected identifier"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"message\": {\n \"value\": \"\"\n },\n \"error\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"16332a4a-5a7d-4bed-aad7-ad89da783cb4","name":"Unauthorized","originalRequest":{"url":{"path":["v4","promotions","lock","create-points-lock-for-client",":identifierType",":identifierValue"],"host":["{{baseUrl}}"],"query":[{"key":"lockTtlSec","value":"900"}],"variable":[{"disabled":false,"type":"any","value":"email","key":"identifierType","description":"(Required) The Profile identifier to use for the request.\n\n`externalId` is known as `customId` or `custom_identify` in other Synerise services.\n"},{"disabled":false,"type":"any","value":"string","key":"identifierValue","description":"(Required) The value of the selected identifier"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"status\": 7751,\n \"error\": \"string\",\n \"message\": \"string\",\n \"timestamp\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"b7ee0c7e-f968-4dfa-a0b3-c0b34797ebd2","name":"Forbidden","originalRequest":{"url":{"path":["v4","promotions","lock","create-points-lock-for-client",":identifierType",":identifierValue"],"host":["{{baseUrl}}"],"query":[{"key":"lockTtlSec","value":"900"}],"variable":[{"disabled":false,"type":"any","value":"email","key":"identifierType","description":"(Required) The Profile identifier to use for the request.\n\n`externalId` is known as `customId` or `custom_identify` in other Synerise services.\n"},{"disabled":false,"type":"any","value":"string","key":"identifierValue","description":"(Required) The value of the selected identifier"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"status\": 7751,\n \"error\": \"string\",\n \"message\": \"string\",\n \"timestamp\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"410f0b2a-e587-4d3d-bbee-94c949239225","name":"Profile not found","originalRequest":{"url":{"path":["v4","promotions","lock","create-points-lock-for-client",":identifierType",":identifierValue"],"host":["{{baseUrl}}"],"query":[{"key":"lockTtlSec","value":"900"}],"variable":[{"disabled":false,"type":"any","value":"email","key":"identifierType","description":"(Required) The Profile identifier to use for the request.\n\n`externalId` is known as `customId` or `custom_identify` in other Synerise services.\n"},{"disabled":false,"type":"any","value":"string","key":"identifierValue","description":"(Required) The value of the selected identifier"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"message\": \"Profile not found\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"f0157c55-4c65-4796-9f61-2faa124d3d6d","name":"Release point lock for profile","request":{"name":"Release point lock for profile","description":{"content":"Release a [point lock](#operation/endpointLockCreateLockForClientPOST) from a profile. That profile can now activate and de-activate promotions based on loyalty points.\n\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User\n\n**API key permission required:** `PROMOTIONS_LOCK_UPDATE`\n\n**User role permission required:** `campaigns_promotions: update`\n","type":"text/plain"},"url":{"path":["v4","promotions","lock","release-points-lock-for-client",":identifierType",":identifierValue",":lockIdentifier"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"2f01c1b4-4266-41cb-b8d9-fd00457eedef.1640081408119","key":"lockIdentifier","description":"(Required) Lock identifier"},{"disabled":false,"type":"any","value":"email","key":"identifierType","description":"(Required) The Profile identifier to use for the request.\n\n`externalId` is known as `customId` or `custom_identify` in other Synerise services.\n"},{"disabled":false,"type":"any","value":"string","key":"identifierValue","description":"(Required) The value of the selected identifier"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"507bb1ca-e255-43bf-bdc9-174c944d69d4","name":"Lock released","originalRequest":{"url":{"path":["v4","promotions","lock","release-points-lock-for-client",":identifierType",":identifierValue",":lockIdentifier"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"2f01c1b4-4266-41cb-b8d9-fd00457eedef.1640081408119","key":"lockIdentifier","description":"(Required) Lock identifier"},{"disabled":false,"type":"any","value":"email","key":"identifierType","description":"(Required) The Profile identifier to use for the request.\n\n`externalId` is known as `customId` or `custom_identify` in other Synerise services.\n"},{"disabled":false,"type":"any","value":"string","key":"identifierValue","description":"(Required) The value of the selected identifier"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"message\": \"Lock release succeeded\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"b1282606-f533-45f0-bc67-a962af08fc80","name":"Request body invalid/malformed/missing elements","originalRequest":{"url":{"path":["v4","promotions","lock","release-points-lock-for-client",":identifierType",":identifierValue",":lockIdentifier"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"2f01c1b4-4266-41cb-b8d9-fd00457eedef.1640081408119","key":"lockIdentifier","description":"(Required) Lock identifier"},{"disabled":false,"type":"any","value":"email","key":"identifierType","description":"(Required) The Profile identifier to use for the request.\n\n`externalId` is known as `customId` or `custom_identify` in other Synerise services.\n"},{"disabled":false,"type":"any","value":"string","key":"identifierValue","description":"(Required) The value of the selected identifier"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"message\": {\n \"value\": \"\"\n },\n \"error\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"7b11b8d4-de22-4298-8dba-3250acf867c8","name":"Unauthorized","originalRequest":{"url":{"path":["v4","promotions","lock","release-points-lock-for-client",":identifierType",":identifierValue",":lockIdentifier"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"2f01c1b4-4266-41cb-b8d9-fd00457eedef.1640081408119","key":"lockIdentifier","description":"(Required) Lock identifier"},{"disabled":false,"type":"any","value":"email","key":"identifierType","description":"(Required) The Profile identifier to use for the request.\n\n`externalId` is known as `customId` or `custom_identify` in other Synerise services.\n"},{"disabled":false,"type":"any","value":"string","key":"identifierValue","description":"(Required) The value of the selected identifier"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"status\": 7751,\n \"error\": \"string\",\n \"message\": \"string\",\n \"timestamp\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"2b733ffb-591a-47a2-be49-292339449a2a","name":"Forbidden","originalRequest":{"url":{"path":["v4","promotions","lock","release-points-lock-for-client",":identifierType",":identifierValue",":lockIdentifier"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"2f01c1b4-4266-41cb-b8d9-fd00457eedef.1640081408119","key":"lockIdentifier","description":"(Required) Lock identifier"},{"disabled":false,"type":"any","value":"email","key":"identifierType","description":"(Required) The Profile identifier to use for the request.\n\n`externalId` is known as `customId` or `custom_identify` in other Synerise services.\n"},{"disabled":false,"type":"any","value":"string","key":"identifierValue","description":"(Required) The value of the selected identifier"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"status\": 7751,\n \"error\": \"string\",\n \"message\": \"string\",\n \"timestamp\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"0c2bdef6-e28d-45ea-ab78-ec1c4d8038b2","name":"Profile not found","originalRequest":{"url":{"path":["v4","promotions","lock","release-points-lock-for-client",":identifierType",":identifierValue",":lockIdentifier"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"2f01c1b4-4266-41cb-b8d9-fd00457eedef.1640081408119","key":"lockIdentifier","description":"(Required) Lock identifier"},{"disabled":false,"type":"any","value":"email","key":"identifierType","description":"(Required) The Profile identifier to use for the request.\n\n`externalId` is known as `customId` or `custom_identify` in other Synerise services.\n"},{"disabled":false,"type":"any","value":"string","key":"identifierValue","description":"(Required) The value of the selected identifier"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"message\": \"Profile not found\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"f4c97f73-4d15-432a-9596-ea2339eac601","name":"Lock already exists","originalRequest":{"url":{"path":["v4","promotions","lock","release-points-lock-for-client",":identifierType",":identifierValue",":lockIdentifier"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"2f01c1b4-4266-41cb-b8d9-fd00457eedef.1640081408119","key":"lockIdentifier","description":"(Required) Lock identifier"},{"disabled":false,"type":"any","value":"email","key":"identifierType","description":"(Required) The Profile identifier to use for the request.\n\n`externalId` is known as `customId` or `custom_identify` in other Synerise services.\n"},{"disabled":false,"type":"any","value":"string","key":"identifierValue","description":"(Required) The value of the selected identifier"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"Conflict","code":409,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"message\": \"Lock already exits\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"e36743bc-3101-41dd-9174-4ed82773bedf","name":"Release \"promotion requested\" lock from profile","request":{"name":"Release \"promotion requested\" lock from profile","description":{"content":"Release a \"promotion requested\" lock from a profile. That profile can now fetch promotion lists. This kind of lock can be applied when using the [Get Profile promotions by a custom filter](#operation/GetClientPromotionsByACustomFilter) endpoint.\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User\n\n**API key permission required:** `PROMOTIONS_LOCK_UPDATE`\n\n**User role permission required:** `campaigns_promotions: update`\n","type":"text/plain"},"url":{"path":["v4","promotions","lock","release-promotion-requested-lock-for-client",":identifierType",":identifierValue",":lockIdentifier"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"2f01c1b4-4266-41cb-b8d9-fd00457eedef.1640081408119","key":"lockIdentifier","description":"(Required) Lock identifier"},{"disabled":false,"type":"any","value":"email","key":"identifierType","description":"(Required) The Profile identifier to use for the request.\n\n`externalId` is known as `customId` or `custom_identify` in other Synerise services.\n"},{"disabled":false,"type":"any","value":"string","key":"identifierValue","description":"(Required) The value of the selected identifier"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"803c0506-811b-4cc6-b8d3-e0aabe22d7cb","name":"Lock released","originalRequest":{"url":{"path":["v4","promotions","lock","release-promotion-requested-lock-for-client",":identifierType",":identifierValue",":lockIdentifier"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"2f01c1b4-4266-41cb-b8d9-fd00457eedef.1640081408119","key":"lockIdentifier","description":"(Required) Lock identifier"},{"disabled":false,"type":"any","value":"email","key":"identifierType","description":"(Required) The Profile identifier to use for the request.\n\n`externalId` is known as `customId` or `custom_identify` in other Synerise services.\n"},{"disabled":false,"type":"any","value":"string","key":"identifierValue","description":"(Required) The value of the selected identifier"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"message\": \"Lock release succeeded\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"c3318dcf-f50a-4c8f-b521-2f42da98ce92","name":"Request body invalid/malformed/missing elements","originalRequest":{"url":{"path":["v4","promotions","lock","release-promotion-requested-lock-for-client",":identifierType",":identifierValue",":lockIdentifier"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"2f01c1b4-4266-41cb-b8d9-fd00457eedef.1640081408119","key":"lockIdentifier","description":"(Required) Lock identifier"},{"disabled":false,"type":"any","value":"email","key":"identifierType","description":"(Required) The Profile identifier to use for the request.\n\n`externalId` is known as `customId` or `custom_identify` in other Synerise services.\n"},{"disabled":false,"type":"any","value":"string","key":"identifierValue","description":"(Required) The value of the selected identifier"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"message\": {\n \"value\": \"\"\n },\n \"error\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"c3b7720d-f07c-4642-88cf-74872a2c0f06","name":"Unauthorized","originalRequest":{"url":{"path":["v4","promotions","lock","release-promotion-requested-lock-for-client",":identifierType",":identifierValue",":lockIdentifier"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"2f01c1b4-4266-41cb-b8d9-fd00457eedef.1640081408119","key":"lockIdentifier","description":"(Required) Lock identifier"},{"disabled":false,"type":"any","value":"email","key":"identifierType","description":"(Required) The Profile identifier to use for the request.\n\n`externalId` is known as `customId` or `custom_identify` in other Synerise services.\n"},{"disabled":false,"type":"any","value":"string","key":"identifierValue","description":"(Required) The value of the selected identifier"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"status\": 7751,\n \"error\": \"string\",\n \"message\": \"string\",\n \"timestamp\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"913ca86c-084f-4490-a6e6-4c1faa23b929","name":"Forbidden","originalRequest":{"url":{"path":["v4","promotions","lock","release-promotion-requested-lock-for-client",":identifierType",":identifierValue",":lockIdentifier"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"2f01c1b4-4266-41cb-b8d9-fd00457eedef.1640081408119","key":"lockIdentifier","description":"(Required) Lock identifier"},{"disabled":false,"type":"any","value":"email","key":"identifierType","description":"(Required) The Profile identifier to use for the request.\n\n`externalId` is known as `customId` or `custom_identify` in other Synerise services.\n"},{"disabled":false,"type":"any","value":"string","key":"identifierValue","description":"(Required) The value of the selected identifier"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"status\": 7751,\n \"error\": \"string\",\n \"message\": \"string\",\n \"timestamp\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"4a71df96-9a1d-48f1-8570-6bba4530e3b2","name":"Not found","originalRequest":{"url":{"path":["v4","promotions","lock","release-promotion-requested-lock-for-client",":identifierType",":identifierValue",":lockIdentifier"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"2f01c1b4-4266-41cb-b8d9-fd00457eedef.1640081408119","key":"lockIdentifier","description":"(Required) Lock identifier"},{"disabled":false,"type":"any","value":"email","key":"identifierType","description":"(Required) The Profile identifier to use for the request.\n\n`externalId` is known as `customId` or `custom_identify` in other Synerise services.\n"},{"disabled":false,"type":"any","value":"string","key":"identifierValue","description":"(Required) The value of the selected identifier"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"message\": \"Profile not found\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}],"event":[]},{"id":"b5d54490-63b0-4b09-8c47-cb2079e43deb","name":"Screen views (legacy)","description":{"content":"","type":"text/plain"},"item":[{"id":"8597ecae-f66e-49e2-9549-00812a1d411e","name":"Get all screen views","request":{"name":"Get all screen views","description":{"content":"Retrieve a paginated list of all screen view campaigns in the workspace.\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `SCHEMA_SERVICE_SCHEMA_READ`\n\n**User role permission required:** `assets_docs: read`\n","type":"text/plain"},"url":{"path":["schema-service","screenViews"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"limit","value":"string","description":"(Required) The maximum number of items to retrieve for pagination"},{"disabled":false,"key":"page","value":"5612","description":"(Required) The number of the page to retrieve"},{"disabled":false,"key":"status","value":"ACTIVE","description":"Filter the results by screen view status"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"a2bf45a6-82dd-490a-88c6-9b0a9b9639c1","name":"Success","originalRequest":{"url":{"path":["schema-service","screenViews"],"host":["{{baseUrl}}"],"query":[{"key":"limit","value":"string"},{"key":"page","value":"5612"},{"key":"status","value":"ACTIVE"}],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"data\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"pagination\": {\n \"limit\": {\n \"value\": \"\"\n },\n \"page\": {\n \"value\": \"\"\n },\n \"pages\": {\n \"value\": \"\"\n },\n \"total\": {\n \"value\": \"\"\n }\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"0482cb15-9059-4ff3-8461-efbeb2f434a6","name":"See error message for details","originalRequest":{"url":{"path":["schema-service","screenViews"],"host":["{{baseUrl}}"],"query":[{"key":"limit","value":"string"},{"key":"page","value":"5612"},{"key":"status","value":"ACTIVE"}],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"5b625113-4fec-47bd-9394-7d8c19248b2b","name":"Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc.","originalRequest":{"url":{"path":["schema-service","screenViews"],"host":["{{baseUrl}}"],"query":[{"key":"limit","value":"string"},{"key":"page","value":"5612"},{"key":"status","value":"ACTIVE"}],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"string\",\n \"error\": \"string\",\n \"message\": \"string\",\n \"status\": 6404\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"812a5bcc-5fde-4505-9ab6-618a28f266d5","name":"Forbidden; insufficient permissions","originalRequest":{"url":{"path":["schema-service","screenViews"],"host":["{{baseUrl}}"],"query":[{"key":"limit","value":"string"},{"key":"page","value":"5612"},{"key":"status","value":"ACTIVE"}],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"string\",\n \"error\": \"string\",\n \"message\": \"string\",\n \"status\": 6404\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"989a5d4d-2244-4377-9e0a-801bb33a0ed5","name":"Resource not found","originalRequest":{"url":{"path":["schema-service","screenViews"],"host":["{{baseUrl}}"],"query":[{"key":"limit","value":"string"},{"key":"page","value":"5612"},{"key":"status","value":"ACTIVE"}],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"bef24333-4b94-4b95-a238-433868b9505d","name":"See error message for details","originalRequest":{"url":{"path":["schema-service","screenViews"],"host":["{{baseUrl}}"],"query":[{"key":"limit","value":"string"},{"key":"page","value":"5612"},{"key":"status","value":"ACTIVE"}],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"3d3934ce-a33c-48ad-8c75-0b091eb8ccc2","name":"Get screen views by keys","request":{"name":"Get screen views by keys","description":{"content":"Retrieve list of screen view campaigns by keys in the workspace.\n\n---\n\n**API consumer:** Synerise User\n\n**User role permission required:** `assets_docs: read`\n","type":"text/plain"},"url":{"path":["schema-service","screenViews","byKeys"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"[\n \"string\",\n \"string\"\n]","options":{"raw":{"language":"json"}}}},"response":[{"id":"e6f25c57-11eb-4f25-ace2-1f797e78d4d0","name":"Success","originalRequest":{"url":{"path":["schema-service","screenViews","byKeys"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"[\n \"string\",\n \"string\"\n]","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"data\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"pagination\": {\n \"limit\": {\n \"value\": \"\"\n },\n \"page\": {\n \"value\": \"\"\n },\n \"pages\": {\n \"value\": \"\"\n },\n \"total\": {\n \"value\": \"\"\n }\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"62d022f8-6e4a-482c-80d7-5de14202acf1","name":"See error message for details","originalRequest":{"url":{"path":["schema-service","screenViews","byKeys"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"[\n \"string\",\n \"string\"\n]","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"2002be83-a552-4ef3-80d3-ad9f3fb007c1","name":"Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc.","originalRequest":{"url":{"path":["schema-service","screenViews","byKeys"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"[\n \"string\",\n \"string\"\n]","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"string\",\n \"error\": \"string\",\n \"message\": \"string\",\n \"status\": 6404\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"bf295b10-afe4-4072-9363-acd19ea33cac","name":"Forbidden; insufficient permissions","originalRequest":{"url":{"path":["schema-service","screenViews","byKeys"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"[\n \"string\",\n \"string\"\n]","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"string\",\n \"error\": \"string\",\n \"message\": \"string\",\n \"status\": 6404\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"128dc026-bcfd-4d82-8268-b96cded07384","name":"Resource not found","originalRequest":{"url":{"path":["schema-service","screenViews","byKeys"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"[\n \"string\",\n \"string\"\n]","options":{"raw":{"language":"json"}}}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"f929b702-06f6-4e96-96fd-aac96fd59eea","name":"See error message for details","originalRequest":{"url":{"path":["schema-service","screenViews","byKeys"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"[\n \"string\",\n \"string\"\n]","options":{"raw":{"language":"json"}}}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"30a281c0-d8cf-4509-bc56-6c3eff92bffd","name":"Get screen view","request":{"name":"Get screen view","description":{"content":"Retrieve the details of a single screen view campaign.\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `SCHEMA_SERVICE_SCHEMA_READ`\n\n**User role permission required:** `assets_docs: read`\n","type":"text/plain"},"url":{"path":["schema-service","screenViews","single",":screenViewId",":screenViewVersion"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"screenViewId","description":"(Required) UUID of the screen view"},{"disabled":false,"type":"any","value":"string","key":"screenViewVersion","description":"(Required) Version of the screen view"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"60f2e064-375e-4712-9e86-cfb5762f7b81","name":"Success","originalRequest":{"url":{"path":["schema-service","screenViews","single",":screenViewId",":screenViewVersion"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"screenViewId","description":"(Required) UUID of the screen view"},{"disabled":false,"type":"any","value":"string","key":"screenViewVersion","description":"(Required) Version of the screen view"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"id\": \"fda740d1-f892-7bd2-821f-c900eeada15e\",\n \"businessProfileId\": 9621,\n \"name\": \"string\",\n \"status\": \"DRAFT\",\n \"priority\": 99,\n \"scheduled\": false,\n \"author\": {\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"avatar\": {\n \"value\": \"\"\n }\n },\n \"content\": {\n \"json\": {\n \"value\": \"\"\n },\n \"documents\": {\n \"value\": \"\"\n },\n \"groups\": {\n \"value\": \"\"\n },\n \"groupsOrder\": {\n \"value\": \"\"\n }\n },\n \"audience\": {\n \"targetType\": {\n \"value\": \"\"\n },\n \"segments\": {\n \"value\": \"\"\n },\n \"query\": {\n \"value\": \"\"\n }\n },\n \"createdAt\": \"1949-02-28T18:46:51.022Z\",\n \"updatedAt\": \"1982-12-06T01:47:57.153Z\",\n \"directory\": {\n \"value\": \"\"\n },\n \"feed\": {\n \"value\": \"\"\n },\n \"version\": \"string\",\n \"parentVersion\": \"string\",\n \"description\": \"string\",\n \"deletedAt\": \"1978-01-10T12:11:26.044Z\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"a080bb2e-d66f-411a-99a4-b3a0b2d7227b","name":"See error message for details","originalRequest":{"url":{"path":["schema-service","screenViews","single",":screenViewId",":screenViewVersion"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"screenViewId","description":"(Required) UUID of the screen view"},{"disabled":false,"type":"any","value":"string","key":"screenViewVersion","description":"(Required) Version of the screen view"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"53c3f826-bcc6-4f8e-88b1-cc3e5a6a49c8","name":"Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc.","originalRequest":{"url":{"path":["schema-service","screenViews","single",":screenViewId",":screenViewVersion"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"screenViewId","description":"(Required) UUID of the screen view"},{"disabled":false,"type":"any","value":"string","key":"screenViewVersion","description":"(Required) Version of the screen view"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"string\",\n \"error\": \"string\",\n \"message\": \"string\",\n \"status\": 6404\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"c93f46f1-759a-4732-af6a-2b864fab7ee7","name":"Forbidden; insufficient permissions","originalRequest":{"url":{"path":["schema-service","screenViews","single",":screenViewId",":screenViewVersion"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"screenViewId","description":"(Required) UUID of the screen view"},{"disabled":false,"type":"any","value":"string","key":"screenViewVersion","description":"(Required) Version of the screen view"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"string\",\n \"error\": \"string\",\n \"message\": \"string\",\n \"status\": 6404\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"aa750d81-8a4f-447e-97ca-71344e9251e7","name":"Resource not found","originalRequest":{"url":{"path":["schema-service","screenViews","single",":screenViewId",":screenViewVersion"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"screenViewId","description":"(Required) UUID of the screen view"},{"disabled":false,"type":"any","value":"string","key":"screenViewVersion","description":"(Required) Version of the screen view"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"eda16a7e-1536-4353-9fb4-12004c8f88a2","name":"See error message for details","originalRequest":{"url":{"path":["schema-service","screenViews","single",":screenViewId",":screenViewVersion"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"screenViewId","description":"(Required) UUID of the screen view"},{"disabled":false,"type":"any","value":"string","key":"screenViewVersion","description":"(Required) Version of the screen view"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"a91064c7-6ada-44c0-8456-6ce121599327","name":"Get screen view versions","request":{"name":"Get screen view versions","description":{"content":"Retrieve all versions of a screen view campaign.\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `SCHEMA_SERVICE_SCHEMA_READ`\n\n**User role permission required:** `assets_docs: read`\n","type":"text/plain"},"url":{"path":["schema-service","screenViews","versions",":screenViewId"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"limit","value":"string","description":"(Required) The maximum number of items to retrieve for pagination"},{"disabled":false,"key":"page","value":"5612","description":"(Required) The number of the page to retrieve"}],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"screenViewId","description":"(Required) UUID of the screen view"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"1aa731a8-dcfd-4bab-be0a-e5423e4facc1","name":"Success","originalRequest":{"url":{"path":["schema-service","screenViews","versions",":screenViewId"],"host":["{{baseUrl}}"],"query":[{"key":"limit","value":"string"},{"key":"page","value":"5612"}],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"screenViewId","description":"(Required) UUID of the screen view"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"draft\": {\n \"id\": {\n \"value\": \"\"\n },\n \"version\": {\n \"value\": \"\"\n },\n \"status\": {\n \"value\": \"\"\n },\n \"hash\": {\n \"value\": \"\"\n },\n \"parentVersion\": {\n \"value\": \"\"\n },\n \"authorId\": {\n \"value\": \"\"\n },\n \"businessProfileId\": {\n \"value\": \"\"\n },\n \"priority\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n },\n \"isActive\": {\n \"value\": \"\"\n },\n \"createdAt\": {\n \"value\": \"\"\n },\n \"updatedAt\": {\n \"value\": \"\"\n },\n \"deletedAt\": {\n \"value\": \"\"\n }\n },\n \"currentlyPublished\": {\n \"id\": {\n \"value\": \"\"\n },\n \"version\": {\n \"value\": \"\"\n },\n \"status\": {\n \"value\": \"\"\n },\n \"hash\": {\n \"value\": \"\"\n },\n \"parentVersion\": {\n \"value\": \"\"\n },\n \"authorId\": {\n \"value\": \"\"\n },\n \"businessProfileId\": {\n \"value\": \"\"\n },\n \"priority\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n },\n \"isActive\": {\n \"value\": \"\"\n },\n \"createdAt\": {\n \"value\": \"\"\n },\n \"updatedAt\": {\n \"value\": \"\"\n },\n \"deletedAt\": {\n \"value\": \"\"\n }\n },\n \"previouslyPublished\": {\n \"data\": {\n \"value\": \"\"\n },\n \"pagination\": {\n \"value\": \"\"\n }\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"549705fe-544b-4ebf-b9ab-815d51fda026","name":"See error message for details","originalRequest":{"url":{"path":["schema-service","screenViews","versions",":screenViewId"],"host":["{{baseUrl}}"],"query":[{"key":"limit","value":"string"},{"key":"page","value":"5612"}],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"screenViewId","description":"(Required) UUID of the screen view"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"3668fef1-c15f-49d0-a9df-bd09e7650d20","name":"Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc.","originalRequest":{"url":{"path":["schema-service","screenViews","versions",":screenViewId"],"host":["{{baseUrl}}"],"query":[{"key":"limit","value":"string"},{"key":"page","value":"5612"}],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"screenViewId","description":"(Required) UUID of the screen view"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"string\",\n \"error\": \"string\",\n \"message\": \"string\",\n \"status\": 6404\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"d93f510b-74eb-49f9-a299-52a626866c85","name":"Forbidden; insufficient permissions","originalRequest":{"url":{"path":["schema-service","screenViews","versions",":screenViewId"],"host":["{{baseUrl}}"],"query":[{"key":"limit","value":"string"},{"key":"page","value":"5612"}],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"screenViewId","description":"(Required) UUID of the screen view"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"string\",\n \"error\": \"string\",\n \"message\": \"string\",\n \"status\": 6404\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"ba920def-b138-4362-b9ce-b83a570e4881","name":"Resource not found","originalRequest":{"url":{"path":["schema-service","screenViews","versions",":screenViewId"],"host":["{{baseUrl}}"],"query":[{"key":"limit","value":"string"},{"key":"page","value":"5612"}],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"screenViewId","description":"(Required) UUID of the screen view"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"c5f1bc4c-cdfc-4bda-8a26-d5a24b9d9e64","name":"See error message for details","originalRequest":{"url":{"path":["schema-service","screenViews","versions",":screenViewId"],"host":["{{baseUrl}}"],"query":[{"key":"limit","value":"string"},{"key":"page","value":"5612"}],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"screenViewId","description":"(Required) UUID of the screen view"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"2917630e-8853-4b6c-bdc9-c0089c27311d","name":"Generate screen view","request":{"name":"Generate screen view","description":{"content":"When this method is called, the Synerise backend finds all screen view campaigns applicable to the profile and returns the screen view with the highest priority (1).\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User, Profile (Client), Anonymous Profile\n\n**API key permission required:** `SCHEMA_SERVICE_SCHEMA_CREATE`\n\n**User role permission required:** `assets_docs: create`\n","type":"text/plain"},"url":{"path":["schema-service","screenViews","generate"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"c1c6fffc-de94-4600-a412-b992d41d6cb8","name":"Processed JSON content","originalRequest":{"url":{"path":["schema-service","screenViews","generate"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{}","cookie":[],"_postman_previewlanguage":"json"},{"id":"efe753c2-b46e-4a06-a31a-0b50140c27ac","name":"See error message for details","originalRequest":{"url":{"path":["schema-service","screenViews","generate"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"6a1aa5af-4360-4e00-bd29-65dde5d32e2c","name":"Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc.","originalRequest":{"url":{"path":["schema-service","screenViews","generate"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"string\",\n \"error\": \"string\",\n \"message\": \"string\",\n \"status\": 6404\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"9afd8a28-b977-49d4-a2b2-70efe5059d28","name":"Forbidden; insufficient permissions","originalRequest":{"url":{"path":["schema-service","screenViews","generate"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"string\",\n \"error\": \"string\",\n \"message\": \"string\",\n \"status\": 6404\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"ac46b014-810c-40fd-ae91-834b7a38cadd","name":"Resource not found","originalRequest":{"url":{"path":["schema-service","screenViews","generate"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"300a0954-7634-4963-a224-245e250727b8","name":"See error message for details","originalRequest":{"url":{"path":["schema-service","screenViews","generate"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"8ba5602e-1ca8-41d4-b426-6494bba0fc7d","name":"Generate screen view","request":{"name":"Generate screen view","description":{"content":"When this method is called, the Synerise backend finds all screen view campaigns applicable to the profile and returns the screen view with the highest priority (1).\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User, Profile (Client), Anonymous Profile\n\n**API key permission required:** `SCHEMA_SERVICE_SCHEMA_CREATE`\n\n**User role permission required:** `assets_docs: create`\n","type":"text/plain"},"url":{"path":["schema-service","v2","screenViews","generate"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"478cb623-32cd-4347-9b74-8f477d0650a3","name":"Processed JSON content","originalRequest":{"url":{"path":["schema-service","v2","screenViews","generate"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"id\": \"52382cbd-140f-872f-96ea-e065325cb222\",\n \"version\": \"string\",\n \"hash\": \"bb6639b2-a98e-49d9-804f-ed6c0e2a0d2f:2019-12-05T08:22:10.094\",\n \"name\": \"string\",\n \"priority\": 99,\n \"audience\": {\n \"targetType\": {\n \"value\": \"\"\n },\n \"segments\": {\n \"value\": \"\"\n },\n \"query\": {\n \"value\": \"\"\n }\n },\n \"createdAt\": \"2014-03-22T07:57:24.675Z\",\n \"updatedAt\": \"2010-10-10T16:10:03.156Z\",\n \"path\": \"/screenView\",\n \"data\": {},\n \"parentVersion\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"d4e4877f-133a-47d5-96ed-ee7bd5a6e392","name":"See error message for details","originalRequest":{"url":{"path":["schema-service","v2","screenViews","generate"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"cd686319-6183-4c64-aaaf-f187ad201e40","name":"Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc.","originalRequest":{"url":{"path":["schema-service","v2","screenViews","generate"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"string\",\n \"error\": \"string\",\n \"message\": \"string\",\n \"status\": 6404\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"1c223055-3709-4418-826b-c7cd6453e053","name":"Forbidden; insufficient permissions","originalRequest":{"url":{"path":["schema-service","v2","screenViews","generate"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"string\",\n \"error\": \"string\",\n \"message\": \"string\",\n \"status\": 6404\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"dc1df121-1bcb-4b41-a6dd-ce53fc8c5ff6","name":"Resource not found","originalRequest":{"url":{"path":["schema-service","v2","screenViews","generate"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"bbace726-275a-4e98-be75-e2305bdf01f5","name":"See error message for details","originalRequest":{"url":{"path":["schema-service","v2","screenViews","generate"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"2f247d7e-8236-492a-9786-081a0125a148","name":"Initialize screen view","request":{"name":"Initialize screen view","description":{"content":"Create a new screen view campaign. It is created as a blank, without any conditions.\n\n---\n\n**API consumer:** Synerise User\n\n**User role permission required:** `assets_docs: create`\n","type":"text/plain"},"url":{"path":["schema-service","screenViews","createNew"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"56b5871a-bc82-4e0a-ba20-f1949473a637","name":"Success","originalRequest":{"url":{"path":["schema-service","screenViews","createNew"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"id\": \"368b5283-6e32-fc11-8bda-2ceff8e32a05\",\n \"version\": \"string\",\n \"status\": \"SCHEDULED\",\n \"hash\": \"bb6639b2-a98e-49d9-804f-ed6c0e2a0d2f:2019-12-05T08:22:10.094\",\n \"parentVersion\": \"string\",\n \"authorId\": \"string\",\n \"businessProfileId\": 1407,\n \"priority\": 99,\n \"name\": \"string\",\n \"description\": \"string\",\n \"isActive\": false,\n \"createdAt\": \"2002-02-11T13:04:32.013Z\",\n \"updatedAt\": \"1949-12-17T02:16:43.643Z\",\n \"deletedAt\": \"2005-01-13T11:28:43.265Z\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"552be04a-7e08-470d-aad0-1c4256782caf","name":"See error message for details","originalRequest":{"url":{"path":["schema-service","screenViews","createNew"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"c64e5174-c689-4031-b8a2-96406dffaf55","name":"Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc.","originalRequest":{"url":{"path":["schema-service","screenViews","createNew"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"string\",\n \"error\": \"string\",\n \"message\": \"string\",\n \"status\": 6404\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"1b8e0b02-adc3-40d8-8a23-8cb2a3d155dd","name":"Forbidden; insufficient permissions","originalRequest":{"url":{"path":["schema-service","screenViews","createNew"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"string\",\n \"error\": \"string\",\n \"message\": \"string\",\n \"status\": 6404\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"38320703-ccb4-46c1-982c-6dbb20bb9ffe","name":"Resource not found","originalRequest":{"url":{"path":["schema-service","screenViews","createNew"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"d799f46e-03c1-47d2-9b4f-2333ab38c58b","name":"See error message for details","originalRequest":{"url":{"path":["schema-service","screenViews","createNew"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"fbd5d025-9b07-49e1-89d6-1ae69325a27a","name":"Copy content","request":{"name":"Copy content","description":{"content":"Copy content to a screen view draft from another screen view.\n\n---\n\n**API consumer:** Synerise User\n\n**User role permission required:** `assets_docs: create`\n","type":"text/plain"},"url":{"path":["schema-service","screenViews","content",":screenViewId",":screenViewVersion","copyFromExistingScreenView"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"screenViewId","description":"(Required) UUID of the screen view"},{"disabled":false,"type":"any","value":"string","key":"screenViewVersion","description":"(Required) Version of the screen view"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"screenViewId\": \"cac29faf-9551-10a4-0fe4-aa62cb551edd\",\n \"screenViewVersion\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"038d351a-47b6-4d01-a776-179a6aa4d3a0","name":"Success","originalRequest":{"url":{"path":["schema-service","screenViews","content",":screenViewId",":screenViewVersion","copyFromExistingScreenView"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"screenViewId","description":"(Required) UUID of the screen view"},{"disabled":false,"type":"any","value":"string","key":"screenViewVersion","description":"(Required) Version of the screen view"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"screenViewId\": \"cac29faf-9551-10a4-0fe4-aa62cb551edd\",\n \"screenViewVersion\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"status\": \"string\",\n \"body\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"f9b9b73c-d22a-4084-a472-729bb0fc6058","name":"See error message for details","originalRequest":{"url":{"path":["schema-service","screenViews","content",":screenViewId",":screenViewVersion","copyFromExistingScreenView"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"screenViewId","description":"(Required) UUID of the screen view"},{"disabled":false,"type":"any","value":"string","key":"screenViewVersion","description":"(Required) Version of the screen view"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"screenViewId\": \"cac29faf-9551-10a4-0fe4-aa62cb551edd\",\n \"screenViewVersion\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"16e91a74-f410-4e27-9704-f04c5a118b24","name":"Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc.","originalRequest":{"url":{"path":["schema-service","screenViews","content",":screenViewId",":screenViewVersion","copyFromExistingScreenView"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"screenViewId","description":"(Required) UUID of the screen view"},{"disabled":false,"type":"any","value":"string","key":"screenViewVersion","description":"(Required) Version of the screen view"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"screenViewId\": \"cac29faf-9551-10a4-0fe4-aa62cb551edd\",\n \"screenViewVersion\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"string\",\n \"error\": \"string\",\n \"message\": \"string\",\n \"status\": 6404\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"9a1b5265-4e98-4b17-9b92-46e43050cbe8","name":"Forbidden; insufficient permissions","originalRequest":{"url":{"path":["schema-service","screenViews","content",":screenViewId",":screenViewVersion","copyFromExistingScreenView"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"screenViewId","description":"(Required) UUID of the screen view"},{"disabled":false,"type":"any","value":"string","key":"screenViewVersion","description":"(Required) Version of the screen view"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"screenViewId\": \"cac29faf-9551-10a4-0fe4-aa62cb551edd\",\n \"screenViewVersion\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"string\",\n \"error\": \"string\",\n \"message\": \"string\",\n \"status\": 6404\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"1bc9012f-fb93-49a8-8efd-ab1f933615d7","name":"Resource not found","originalRequest":{"url":{"path":["schema-service","screenViews","content",":screenViewId",":screenViewVersion","copyFromExistingScreenView"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"screenViewId","description":"(Required) UUID of the screen view"},{"disabled":false,"type":"any","value":"string","key":"screenViewVersion","description":"(Required) Version of the screen view"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"screenViewId\": \"cac29faf-9551-10a4-0fe4-aa62cb551edd\",\n \"screenViewVersion\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"bc5a649e-6502-4caa-9b5b-47e05c43d116","name":"See error message for details","originalRequest":{"url":{"path":["schema-service","screenViews","content",":screenViewId",":screenViewVersion","copyFromExistingScreenView"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"screenViewId","description":"(Required) UUID of the screen view"},{"disabled":false,"type":"any","value":"string","key":"screenViewVersion","description":"(Required) Version of the screen view"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"screenViewId\": \"cac29faf-9551-10a4-0fe4-aa62cb551edd\",\n \"screenViewVersion\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"d72683a8-a125-4f54-9a1d-d394d8db5e3d","name":"Add content","request":{"name":"Add content","description":{"content":"Add content to a screen view draft.\n\n---\n\n**API consumer:** Synerise User\n\n**User role permission required:** `assets_docs: create`\n","type":"text/plain"},"url":{"path":["schema-service","screenViews","content",":screenViewId",":screenViewVersion"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"screenViewId","description":"(Required) UUID of the screen view"},{"disabled":false,"type":"any","value":"string","key":"screenViewVersion","description":"(Required) Version of the screen view"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"json\": {\n \"key_0\": {\n \"value\": \"\"\n }\n },\n \"documents\": [\n \"string\",\n \"string\"\n ],\n \"groups\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"data\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"groupsOrder\": false\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"ab457014-a710-416d-a90c-781bd81f77d5","name":"Success","originalRequest":{"url":{"path":["schema-service","screenViews","content",":screenViewId",":screenViewVersion"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"screenViewId","description":"(Required) UUID of the screen view"},{"disabled":false,"type":"any","value":"string","key":"screenViewVersion","description":"(Required) Version of the screen view"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"json\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n }\n },\n \"documents\": [\n \"string\",\n \"string\"\n ],\n \"groups\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"data\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"groupsOrder\": false\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"status\": \"string\",\n \"body\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"9f2ef858-5d88-4fcf-b385-dfbd36a75b47","name":"See error message for details","originalRequest":{"url":{"path":["schema-service","screenViews","content",":screenViewId",":screenViewVersion"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"screenViewId","description":"(Required) UUID of the screen view"},{"disabled":false,"type":"any","value":"string","key":"screenViewVersion","description":"(Required) Version of the screen view"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"json\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n }\n },\n \"documents\": [\n \"string\",\n \"string\"\n ],\n \"groups\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"data\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"groupsOrder\": false\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"a57facc6-c111-4426-9e8b-58f6fd9f8fb4","name":"Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc.","originalRequest":{"url":{"path":["schema-service","screenViews","content",":screenViewId",":screenViewVersion"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"screenViewId","description":"(Required) UUID of the screen view"},{"disabled":false,"type":"any","value":"string","key":"screenViewVersion","description":"(Required) Version of the screen view"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"json\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n }\n },\n \"documents\": [\n \"string\",\n \"string\"\n ],\n \"groups\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"data\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"groupsOrder\": false\n}","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"string\",\n \"error\": \"string\",\n \"message\": \"string\",\n \"status\": 6404\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"e5419431-10b6-4f88-93de-f83e2b523ef1","name":"Forbidden; insufficient permissions","originalRequest":{"url":{"path":["schema-service","screenViews","content",":screenViewId",":screenViewVersion"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"screenViewId","description":"(Required) UUID of the screen view"},{"disabled":false,"type":"any","value":"string","key":"screenViewVersion","description":"(Required) Version of the screen view"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"json\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n }\n },\n \"documents\": [\n \"string\",\n \"string\"\n ],\n \"groups\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"data\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"groupsOrder\": false\n}","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"string\",\n \"error\": \"string\",\n \"message\": \"string\",\n \"status\": 6404\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"8d2a8463-775a-425f-bb86-79a3310b9a26","name":"Resource not found","originalRequest":{"url":{"path":["schema-service","screenViews","content",":screenViewId",":screenViewVersion"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"screenViewId","description":"(Required) UUID of the screen view"},{"disabled":false,"type":"any","value":"string","key":"screenViewVersion","description":"(Required) Version of the screen view"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"json\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n }\n },\n \"documents\": [\n \"string\",\n \"string\"\n ],\n \"groups\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"data\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"groupsOrder\": false\n}","options":{"raw":{"language":"json"}}}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"ee8ef232-e9e6-4fa8-97c5-cef36dcd09dd","name":"See error message for details","originalRequest":{"url":{"path":["schema-service","screenViews","content",":screenViewId",":screenViewVersion"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"screenViewId","description":"(Required) UUID of the screen view"},{"disabled":false,"type":"any","value":"string","key":"screenViewVersion","description":"(Required) Version of the screen view"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"json\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n }\n },\n \"documents\": [\n \"string\",\n \"string\"\n ],\n \"groups\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"data\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"groupsOrder\": false\n}","options":{"raw":{"language":"json"}}}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"b46c4ef4-f17c-432a-91c0-5c9ff2ecfe53","name":"Add audience","request":{"name":"Add audience","description":{"content":"Define the audience for a screen view draft.\n\n---\n\n**API consumer:** Synerise User\n\n**User role permission required:** `assets_docs: create`\n","type":"text/plain"},"url":{"path":["schema-service","screenViews","audience",":screenViewId",":screenViewVersion"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"screenViewId","description":"(Required) UUID of the screen view"},{"disabled":false,"type":"any","value":"string","key":"screenViewVersion","description":"(Required) Version of the screen view"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"targetType\": \"SEGMENT\",\n \"segments\": [\n \"string\",\n \"string\"\n ],\n \"query\": \"{\\\"analysis\\\":{\\\"title\\\":\\\"Unnamed segmentation\\\",\\\"description\\\":\\\"\\\",\\\"unique\\\":true,\\\"segments\\\":[{\\\"title\\\":\\\"Segmentation A\\\",\\\"description\\\":\\\"\\\",\\\"filter\\\":{\\\"matching\\\":true,\\\"expressions\\\":[{\\\"_id\\\":\\\"a9b76c8e-34bd-4ac3-be8f-f37041d126bd\\\",\\\"name\\\":\\\"\\\",\\\"type\\\":\\\"FUNNEL\\\",\\\"matching\\\":true,\\\"funnel\\\":{\\\"_id\\\":\\\"5c759d73-49c6-409f-96a3-b569dff8f8ff\\\",\\\"title\\\":\\\"Unnamed\\\",\\\"completedWithin\\\":null,\\\"dateFilter\\\":{\\\"type\\\":\\\"RELATIVE\\\",\\\"offset\\\":{\\\"type\\\":\\\"DAYS\\\",\\\"value\\\":0},\\\"duration\\\":{\\\"type\\\":\\\"DAYS\\\",\\\"value\\\":30}},\\\"steps\\\":[{\\\"_id\\\":\\\"78b97ae0-1bc5-45fb-82a4-4f1280cfbdff\\\",\\\"title\\\":\\\"\\\",\\\"action\\\":{\\\"id\\\":944,\\\"name\\\":\\\"page.visit\\\"},\\\"eventName\\\":\\\"page.visit\\\",\\\"expressions\\\":[]}],\\\"exact\\\":false}}]}}]}}\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"1d48bef3-0ce2-43a5-9a21-05573302e39a","name":"Success","originalRequest":{"url":{"path":["schema-service","screenViews","audience",":screenViewId",":screenViewVersion"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"screenViewId","description":"(Required) UUID of the screen view"},{"disabled":false,"type":"any","value":"string","key":"screenViewVersion","description":"(Required) Version of the screen view"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"targetType\": \"SEGMENT\",\n \"segments\": [\n \"string\",\n \"string\"\n ],\n \"query\": \"{\\\"analysis\\\":{\\\"title\\\":\\\"Unnamed segmentation\\\",\\\"description\\\":\\\"\\\",\\\"unique\\\":true,\\\"segments\\\":[{\\\"title\\\":\\\"Segmentation A\\\",\\\"description\\\":\\\"\\\",\\\"filter\\\":{\\\"matching\\\":true,\\\"expressions\\\":[{\\\"_id\\\":\\\"a9b76c8e-34bd-4ac3-be8f-f37041d126bd\\\",\\\"name\\\":\\\"\\\",\\\"type\\\":\\\"FUNNEL\\\",\\\"matching\\\":true,\\\"funnel\\\":{\\\"_id\\\":\\\"5c759d73-49c6-409f-96a3-b569dff8f8ff\\\",\\\"title\\\":\\\"Unnamed\\\",\\\"completedWithin\\\":null,\\\"dateFilter\\\":{\\\"type\\\":\\\"RELATIVE\\\",\\\"offset\\\":{\\\"type\\\":\\\"DAYS\\\",\\\"value\\\":0},\\\"duration\\\":{\\\"type\\\":\\\"DAYS\\\",\\\"value\\\":30}},\\\"steps\\\":[{\\\"_id\\\":\\\"78b97ae0-1bc5-45fb-82a4-4f1280cfbdff\\\",\\\"title\\\":\\\"\\\",\\\"action\\\":{\\\"id\\\":944,\\\"name\\\":\\\"page.visit\\\"},\\\"eventName\\\":\\\"page.visit\\\",\\\"expressions\\\":[]}],\\\"exact\\\":false}}]}}]}}\"\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"status\": \"string\",\n \"body\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"7e968fc0-e7b4-4e57-b30d-561360395485","name":"See error message for details","originalRequest":{"url":{"path":["schema-service","screenViews","audience",":screenViewId",":screenViewVersion"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"screenViewId","description":"(Required) UUID of the screen view"},{"disabled":false,"type":"any","value":"string","key":"screenViewVersion","description":"(Required) Version of the screen view"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"targetType\": \"SEGMENT\",\n \"segments\": [\n \"string\",\n \"string\"\n ],\n \"query\": \"{\\\"analysis\\\":{\\\"title\\\":\\\"Unnamed segmentation\\\",\\\"description\\\":\\\"\\\",\\\"unique\\\":true,\\\"segments\\\":[{\\\"title\\\":\\\"Segmentation A\\\",\\\"description\\\":\\\"\\\",\\\"filter\\\":{\\\"matching\\\":true,\\\"expressions\\\":[{\\\"_id\\\":\\\"a9b76c8e-34bd-4ac3-be8f-f37041d126bd\\\",\\\"name\\\":\\\"\\\",\\\"type\\\":\\\"FUNNEL\\\",\\\"matching\\\":true,\\\"funnel\\\":{\\\"_id\\\":\\\"5c759d73-49c6-409f-96a3-b569dff8f8ff\\\",\\\"title\\\":\\\"Unnamed\\\",\\\"completedWithin\\\":null,\\\"dateFilter\\\":{\\\"type\\\":\\\"RELATIVE\\\",\\\"offset\\\":{\\\"type\\\":\\\"DAYS\\\",\\\"value\\\":0},\\\"duration\\\":{\\\"type\\\":\\\"DAYS\\\",\\\"value\\\":30}},\\\"steps\\\":[{\\\"_id\\\":\\\"78b97ae0-1bc5-45fb-82a4-4f1280cfbdff\\\",\\\"title\\\":\\\"\\\",\\\"action\\\":{\\\"id\\\":944,\\\"name\\\":\\\"page.visit\\\"},\\\"eventName\\\":\\\"page.visit\\\",\\\"expressions\\\":[]}],\\\"exact\\\":false}}]}}]}}\"\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"8f363691-0dc8-4915-a170-b60c7864721c","name":"Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc.","originalRequest":{"url":{"path":["schema-service","screenViews","audience",":screenViewId",":screenViewVersion"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"screenViewId","description":"(Required) UUID of the screen view"},{"disabled":false,"type":"any","value":"string","key":"screenViewVersion","description":"(Required) Version of the screen view"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"targetType\": \"SEGMENT\",\n \"segments\": [\n \"string\",\n \"string\"\n ],\n \"query\": \"{\\\"analysis\\\":{\\\"title\\\":\\\"Unnamed segmentation\\\",\\\"description\\\":\\\"\\\",\\\"unique\\\":true,\\\"segments\\\":[{\\\"title\\\":\\\"Segmentation A\\\",\\\"description\\\":\\\"\\\",\\\"filter\\\":{\\\"matching\\\":true,\\\"expressions\\\":[{\\\"_id\\\":\\\"a9b76c8e-34bd-4ac3-be8f-f37041d126bd\\\",\\\"name\\\":\\\"\\\",\\\"type\\\":\\\"FUNNEL\\\",\\\"matching\\\":true,\\\"funnel\\\":{\\\"_id\\\":\\\"5c759d73-49c6-409f-96a3-b569dff8f8ff\\\",\\\"title\\\":\\\"Unnamed\\\",\\\"completedWithin\\\":null,\\\"dateFilter\\\":{\\\"type\\\":\\\"RELATIVE\\\",\\\"offset\\\":{\\\"type\\\":\\\"DAYS\\\",\\\"value\\\":0},\\\"duration\\\":{\\\"type\\\":\\\"DAYS\\\",\\\"value\\\":30}},\\\"steps\\\":[{\\\"_id\\\":\\\"78b97ae0-1bc5-45fb-82a4-4f1280cfbdff\\\",\\\"title\\\":\\\"\\\",\\\"action\\\":{\\\"id\\\":944,\\\"name\\\":\\\"page.visit\\\"},\\\"eventName\\\":\\\"page.visit\\\",\\\"expressions\\\":[]}],\\\"exact\\\":false}}]}}]}}\"\n}","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"string\",\n \"error\": \"string\",\n \"message\": \"string\",\n \"status\": 6404\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"aedf7a67-edcb-4c7b-9c03-b244261cce30","name":"Forbidden; insufficient permissions","originalRequest":{"url":{"path":["schema-service","screenViews","audience",":screenViewId",":screenViewVersion"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"screenViewId","description":"(Required) UUID of the screen view"},{"disabled":false,"type":"any","value":"string","key":"screenViewVersion","description":"(Required) Version of the screen view"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"targetType\": \"SEGMENT\",\n \"segments\": [\n \"string\",\n \"string\"\n ],\n \"query\": \"{\\\"analysis\\\":{\\\"title\\\":\\\"Unnamed segmentation\\\",\\\"description\\\":\\\"\\\",\\\"unique\\\":true,\\\"segments\\\":[{\\\"title\\\":\\\"Segmentation A\\\",\\\"description\\\":\\\"\\\",\\\"filter\\\":{\\\"matching\\\":true,\\\"expressions\\\":[{\\\"_id\\\":\\\"a9b76c8e-34bd-4ac3-be8f-f37041d126bd\\\",\\\"name\\\":\\\"\\\",\\\"type\\\":\\\"FUNNEL\\\",\\\"matching\\\":true,\\\"funnel\\\":{\\\"_id\\\":\\\"5c759d73-49c6-409f-96a3-b569dff8f8ff\\\",\\\"title\\\":\\\"Unnamed\\\",\\\"completedWithin\\\":null,\\\"dateFilter\\\":{\\\"type\\\":\\\"RELATIVE\\\",\\\"offset\\\":{\\\"type\\\":\\\"DAYS\\\",\\\"value\\\":0},\\\"duration\\\":{\\\"type\\\":\\\"DAYS\\\",\\\"value\\\":30}},\\\"steps\\\":[{\\\"_id\\\":\\\"78b97ae0-1bc5-45fb-82a4-4f1280cfbdff\\\",\\\"title\\\":\\\"\\\",\\\"action\\\":{\\\"id\\\":944,\\\"name\\\":\\\"page.visit\\\"},\\\"eventName\\\":\\\"page.visit\\\",\\\"expressions\\\":[]}],\\\"exact\\\":false}}]}}]}}\"\n}","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"string\",\n \"error\": \"string\",\n \"message\": \"string\",\n \"status\": 6404\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"63958388-c401-495b-bfe1-7803ef86519d","name":"Resource not found","originalRequest":{"url":{"path":["schema-service","screenViews","audience",":screenViewId",":screenViewVersion"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"screenViewId","description":"(Required) UUID of the screen view"},{"disabled":false,"type":"any","value":"string","key":"screenViewVersion","description":"(Required) Version of the screen view"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"targetType\": \"SEGMENT\",\n \"segments\": [\n \"string\",\n \"string\"\n ],\n \"query\": \"{\\\"analysis\\\":{\\\"title\\\":\\\"Unnamed segmentation\\\",\\\"description\\\":\\\"\\\",\\\"unique\\\":true,\\\"segments\\\":[{\\\"title\\\":\\\"Segmentation A\\\",\\\"description\\\":\\\"\\\",\\\"filter\\\":{\\\"matching\\\":true,\\\"expressions\\\":[{\\\"_id\\\":\\\"a9b76c8e-34bd-4ac3-be8f-f37041d126bd\\\",\\\"name\\\":\\\"\\\",\\\"type\\\":\\\"FUNNEL\\\",\\\"matching\\\":true,\\\"funnel\\\":{\\\"_id\\\":\\\"5c759d73-49c6-409f-96a3-b569dff8f8ff\\\",\\\"title\\\":\\\"Unnamed\\\",\\\"completedWithin\\\":null,\\\"dateFilter\\\":{\\\"type\\\":\\\"RELATIVE\\\",\\\"offset\\\":{\\\"type\\\":\\\"DAYS\\\",\\\"value\\\":0},\\\"duration\\\":{\\\"type\\\":\\\"DAYS\\\",\\\"value\\\":30}},\\\"steps\\\":[{\\\"_id\\\":\\\"78b97ae0-1bc5-45fb-82a4-4f1280cfbdff\\\",\\\"title\\\":\\\"\\\",\\\"action\\\":{\\\"id\\\":944,\\\"name\\\":\\\"page.visit\\\"},\\\"eventName\\\":\\\"page.visit\\\",\\\"expressions\\\":[]}],\\\"exact\\\":false}}]}}]}}\"\n}","options":{"raw":{"language":"json"}}}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"2a279919-1324-4355-983a-fd84a3264085","name":"See error message for details","originalRequest":{"url":{"path":["schema-service","screenViews","audience",":screenViewId",":screenViewVersion"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"screenViewId","description":"(Required) UUID of the screen view"},{"disabled":false,"type":"any","value":"string","key":"screenViewVersion","description":"(Required) Version of the screen view"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"targetType\": \"SEGMENT\",\n \"segments\": [\n \"string\",\n \"string\"\n ],\n \"query\": \"{\\\"analysis\\\":{\\\"title\\\":\\\"Unnamed segmentation\\\",\\\"description\\\":\\\"\\\",\\\"unique\\\":true,\\\"segments\\\":[{\\\"title\\\":\\\"Segmentation A\\\",\\\"description\\\":\\\"\\\",\\\"filter\\\":{\\\"matching\\\":true,\\\"expressions\\\":[{\\\"_id\\\":\\\"a9b76c8e-34bd-4ac3-be8f-f37041d126bd\\\",\\\"name\\\":\\\"\\\",\\\"type\\\":\\\"FUNNEL\\\",\\\"matching\\\":true,\\\"funnel\\\":{\\\"_id\\\":\\\"5c759d73-49c6-409f-96a3-b569dff8f8ff\\\",\\\"title\\\":\\\"Unnamed\\\",\\\"completedWithin\\\":null,\\\"dateFilter\\\":{\\\"type\\\":\\\"RELATIVE\\\",\\\"offset\\\":{\\\"type\\\":\\\"DAYS\\\",\\\"value\\\":0},\\\"duration\\\":{\\\"type\\\":\\\"DAYS\\\",\\\"value\\\":30}},\\\"steps\\\":[{\\\"_id\\\":\\\"78b97ae0-1bc5-45fb-82a4-4f1280cfbdff\\\",\\\"title\\\":\\\"\\\",\\\"action\\\":{\\\"id\\\":944,\\\"name\\\":\\\"page.visit\\\"},\\\"eventName\\\":\\\"page.visit\\\",\\\"expressions\\\":[]}],\\\"exact\\\":false}}]}}]}}\"\n}","options":{"raw":{"language":"json"}}}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"e49ab75c-4a44-4132-be02-69f7db021831","name":"Publish screen view","request":{"name":"Publish screen view","description":{"content":"Make the screen view accessible to customers.\n\n---\n\n**API consumer:** Synerise User\n\n**User role permission required:** `assets_docs: create`\n","type":"text/plain"},"url":{"path":["schema-service","screenViews","publish",":screenViewId",":screenViewVersion"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"screenViewId","description":"(Required) UUID of the screen view"},{"disabled":false,"type":"any","value":"string","key":"screenViewVersion","description":"(Required) Version of the screen view"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"overwrite\": true\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"23c58607-31e6-4b5e-947c-79b989bd3941","name":"Success","originalRequest":{"url":{"path":["schema-service","screenViews","publish",":screenViewId",":screenViewVersion"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"screenViewId","description":"(Required) UUID of the screen view"},{"disabled":false,"type":"any","value":"string","key":"screenViewVersion","description":"(Required) Version of the screen view"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"overwrite\": true\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"status\": \"string\",\n \"body\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"dd06b5d8-96ac-4707-92ca-704ffa72d2f9","name":"See error message for details","originalRequest":{"url":{"path":["schema-service","screenViews","publish",":screenViewId",":screenViewVersion"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"screenViewId","description":"(Required) UUID of the screen view"},{"disabled":false,"type":"any","value":"string","key":"screenViewVersion","description":"(Required) Version of the screen view"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"overwrite\": true\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"dbf1a55c-17ab-45d3-8538-cbbc530cd0fe","name":"Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc.","originalRequest":{"url":{"path":["schema-service","screenViews","publish",":screenViewId",":screenViewVersion"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"screenViewId","description":"(Required) UUID of the screen view"},{"disabled":false,"type":"any","value":"string","key":"screenViewVersion","description":"(Required) Version of the screen view"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"overwrite\": true\n}","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"string\",\n \"error\": \"string\",\n \"message\": \"string\",\n \"status\": 6404\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"b205d702-e541-4afe-b6fa-d881a135a2f0","name":"Forbidden; insufficient permissions","originalRequest":{"url":{"path":["schema-service","screenViews","publish",":screenViewId",":screenViewVersion"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"screenViewId","description":"(Required) UUID of the screen view"},{"disabled":false,"type":"any","value":"string","key":"screenViewVersion","description":"(Required) Version of the screen view"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"overwrite\": true\n}","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"string\",\n \"error\": \"string\",\n \"message\": \"string\",\n \"status\": 6404\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"6eda608e-e034-4889-94f0-29e6e768be68","name":"Resource not found","originalRequest":{"url":{"path":["schema-service","screenViews","publish",":screenViewId",":screenViewVersion"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"screenViewId","description":"(Required) UUID of the screen view"},{"disabled":false,"type":"any","value":"string","key":"screenViewVersion","description":"(Required) Version of the screen view"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"overwrite\": true\n}","options":{"raw":{"language":"json"}}}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"90bbbf34-77b8-4fbb-b7f3-974aed6f9caf","name":"See error message for details","originalRequest":{"url":{"path":["schema-service","screenViews","publish",":screenViewId",":screenViewVersion"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"screenViewId","description":"(Required) UUID of the screen view"},{"disabled":false,"type":"any","value":"string","key":"screenViewVersion","description":"(Required) Version of the screen view"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"overwrite\": true\n}","options":{"raw":{"language":"json"}}}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"1a614bcc-1bcd-4180-bc1f-0437b27a2008","name":"Copy draft from existing screen view","request":{"name":"Copy draft from existing screen view","description":{"content":"Copy a duplicate of an active screen view. The duplicate is in draft status.\n\n---\n\n**API consumer:** Synerise User\n\n**User role permission required:** `assets_docs: create`\n","type":"text/plain"},"url":{"path":["schema-service","screenViews","copyDraftFromExistingScreenView"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"screenViewId\": \"cac29faf-9551-10a4-0fe4-aa62cb551edd\",\n \"screenViewVersion\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"d425365a-6af5-4173-af20-627281e6d921","name":"Success","originalRequest":{"url":{"path":["schema-service","screenViews","copyDraftFromExistingScreenView"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"screenViewId\": \"cac29faf-9551-10a4-0fe4-aa62cb551edd\",\n \"screenViewVersion\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"id\": \"368b5283-6e32-fc11-8bda-2ceff8e32a05\",\n \"version\": \"string\",\n \"status\": \"SCHEDULED\",\n \"hash\": \"bb6639b2-a98e-49d9-804f-ed6c0e2a0d2f:2019-12-05T08:22:10.094\",\n \"parentVersion\": \"string\",\n \"authorId\": \"string\",\n \"businessProfileId\": 1407,\n \"priority\": 99,\n \"name\": \"string\",\n \"description\": \"string\",\n \"isActive\": false,\n \"createdAt\": \"2002-02-11T13:04:32.013Z\",\n \"updatedAt\": \"1949-12-17T02:16:43.643Z\",\n \"deletedAt\": \"2005-01-13T11:28:43.265Z\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"846b877f-4454-4a2b-b9f6-588be7124b2f","name":"See error message for details","originalRequest":{"url":{"path":["schema-service","screenViews","copyDraftFromExistingScreenView"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"screenViewId\": \"cac29faf-9551-10a4-0fe4-aa62cb551edd\",\n \"screenViewVersion\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"38f2a795-f5d0-4d00-b9a6-4d634fcec0a1","name":"Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc.","originalRequest":{"url":{"path":["schema-service","screenViews","copyDraftFromExistingScreenView"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"screenViewId\": \"cac29faf-9551-10a4-0fe4-aa62cb551edd\",\n \"screenViewVersion\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"string\",\n \"error\": \"string\",\n \"message\": \"string\",\n \"status\": 6404\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"6641bcaf-e9eb-4e11-bbbe-028932f75940","name":"Forbidden; insufficient permissions","originalRequest":{"url":{"path":["schema-service","screenViews","copyDraftFromExistingScreenView"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"screenViewId\": \"cac29faf-9551-10a4-0fe4-aa62cb551edd\",\n \"screenViewVersion\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"string\",\n \"error\": \"string\",\n \"message\": \"string\",\n \"status\": 6404\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"8c62e74b-e7d9-4b6a-a9a8-f8469f4c39c7","name":"Resource not found","originalRequest":{"url":{"path":["schema-service","screenViews","copyDraftFromExistingScreenView"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"screenViewId\": \"cac29faf-9551-10a4-0fe4-aa62cb551edd\",\n \"screenViewVersion\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"87e12893-9813-4c19-ac7d-0e9463836932","name":"See error message for details","originalRequest":{"url":{"path":["schema-service","screenViews","copyDraftFromExistingScreenView"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"screenViewId\": \"cac29faf-9551-10a4-0fe4-aa62cb551edd\",\n \"screenViewVersion\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"790f50e1-3de4-4fa8-bb5c-716500444920","name":"Create draft from existing screen view","request":{"name":"Create draft from existing screen view","description":{"content":"Create a duplicate of an active screen view. The duplicate is in draft status.\n\n---\n\n**API consumer:** Synerise User\n\n**User role permission required:** `assets_docs: create`\n","type":"text/plain"},"url":{"path":["schema-service","screenViews","createDraftFromExistingScreenView"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"screenViewId\": \"cac29faf-9551-10a4-0fe4-aa62cb551edd\",\n \"screenViewVersion\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"24ef7b00-75a2-4499-8a33-9a50d4f6eac8","name":"Success","originalRequest":{"url":{"path":["schema-service","screenViews","createDraftFromExistingScreenView"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"screenViewId\": \"cac29faf-9551-10a4-0fe4-aa62cb551edd\",\n \"screenViewVersion\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"id\": \"368b5283-6e32-fc11-8bda-2ceff8e32a05\",\n \"version\": \"string\",\n \"status\": \"SCHEDULED\",\n \"hash\": \"bb6639b2-a98e-49d9-804f-ed6c0e2a0d2f:2019-12-05T08:22:10.094\",\n \"parentVersion\": \"string\",\n \"authorId\": \"string\",\n \"businessProfileId\": 1407,\n \"priority\": 99,\n \"name\": \"string\",\n \"description\": \"string\",\n \"isActive\": false,\n \"createdAt\": \"2002-02-11T13:04:32.013Z\",\n \"updatedAt\": \"1949-12-17T02:16:43.643Z\",\n \"deletedAt\": \"2005-01-13T11:28:43.265Z\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"71f9ee64-2472-47b6-af49-4ef223ca01e5","name":"See error message for details","originalRequest":{"url":{"path":["schema-service","screenViews","createDraftFromExistingScreenView"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"screenViewId\": \"cac29faf-9551-10a4-0fe4-aa62cb551edd\",\n \"screenViewVersion\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"3221197c-7ce9-4204-bd88-dcf35e251660","name":"Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc.","originalRequest":{"url":{"path":["schema-service","screenViews","createDraftFromExistingScreenView"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"screenViewId\": \"cac29faf-9551-10a4-0fe4-aa62cb551edd\",\n \"screenViewVersion\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"string\",\n \"error\": \"string\",\n \"message\": \"string\",\n \"status\": 6404\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"47ecb8bb-6a57-4d91-9294-5e3af507a20e","name":"Forbidden; insufficient permissions","originalRequest":{"url":{"path":["schema-service","screenViews","createDraftFromExistingScreenView"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"screenViewId\": \"cac29faf-9551-10a4-0fe4-aa62cb551edd\",\n \"screenViewVersion\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"string\",\n \"error\": \"string\",\n \"message\": \"string\",\n \"status\": 6404\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"34e77768-0ed3-46ec-9437-63ae81a2b7e1","name":"Resource not found","originalRequest":{"url":{"path":["schema-service","screenViews","createDraftFromExistingScreenView"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"screenViewId\": \"cac29faf-9551-10a4-0fe4-aa62cb551edd\",\n \"screenViewVersion\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"2795a856-aee1-48d9-9da5-f39959ac72c3","name":"See error message for details","originalRequest":{"url":{"path":["schema-service","screenViews","createDraftFromExistingScreenView"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"screenViewId\": \"cac29faf-9551-10a4-0fe4-aa62cb551edd\",\n \"screenViewVersion\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"649d3a13-3791-496e-b688-de56aa833391","name":"Update screen view description","request":{"name":"Update screen view description","description":{"content":"Update the description of a screen view. You can update the descriptions of active screen views.\n\n---\n\n**API consumer:** Synerise User\n\n**User role permission required:** `assets_docs: create`\n","type":"text/plain"},"url":{"path":["schema-service","screenViews","single",":screenViewId",":screenViewVersion","description"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"screenViewId","description":"(Required) UUID of the screen view"},{"disabled":false,"type":"any","value":"string","key":"screenViewVersion","description":"(Required) Version of the screen view"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PUT","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"string","options":{"raw":{"language":"json"}}}},"response":[{"id":"0d15bb2a-7fc3-4f5b-ba03-fdd856286792","name":"Success","originalRequest":{"url":{"path":["schema-service","screenViews","single",":screenViewId",":screenViewVersion","description"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"screenViewId","description":"(Required) UUID of the screen view"},{"disabled":false,"type":"any","value":"string","key":"screenViewVersion","description":"(Required) Version of the screen view"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"string","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"status\": \"string\",\n \"body\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"978c4e98-e5fe-4bf7-86b4-91adec52b429","name":"See error message for details","originalRequest":{"url":{"path":["schema-service","screenViews","single",":screenViewId",":screenViewVersion","description"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"screenViewId","description":"(Required) UUID of the screen view"},{"disabled":false,"type":"any","value":"string","key":"screenViewVersion","description":"(Required) Version of the screen view"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"string","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"8a082eba-aed1-40dc-8776-d7dee76cf513","name":"Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc.","originalRequest":{"url":{"path":["schema-service","screenViews","single",":screenViewId",":screenViewVersion","description"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"screenViewId","description":"(Required) UUID of the screen view"},{"disabled":false,"type":"any","value":"string","key":"screenViewVersion","description":"(Required) Version of the screen view"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"string","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"string\",\n \"error\": \"string\",\n \"message\": \"string\",\n \"status\": 6404\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"6a428574-e735-4432-b02b-e96689fb1845","name":"Forbidden; insufficient permissions","originalRequest":{"url":{"path":["schema-service","screenViews","single",":screenViewId",":screenViewVersion","description"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"screenViewId","description":"(Required) UUID of the screen view"},{"disabled":false,"type":"any","value":"string","key":"screenViewVersion","description":"(Required) Version of the screen view"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"string","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"string\",\n \"error\": \"string\",\n \"message\": \"string\",\n \"status\": 6404\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"db7389b1-16c1-4825-b773-f1cfc300c5cb","name":"Resource not found","originalRequest":{"url":{"path":["schema-service","screenViews","single",":screenViewId",":screenViewVersion","description"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"screenViewId","description":"(Required) UUID of the screen view"},{"disabled":false,"type":"any","value":"string","key":"screenViewVersion","description":"(Required) Version of the screen view"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"string","options":{"raw":{"language":"json"}}}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"e60c8cd8-251d-4911-aad3-a4c05b9a9b93","name":"See error message for details","originalRequest":{"url":{"path":["schema-service","screenViews","single",":screenViewId",":screenViewVersion","description"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"screenViewId","description":"(Required) UUID of the screen view"},{"disabled":false,"type":"any","value":"string","key":"screenViewVersion","description":"(Required) Version of the screen view"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"string","options":{"raw":{"language":"json"}}}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"12511d63-61cd-4fcb-988e-7f09546941ce","name":"Update screen view priority","request":{"name":"Update screen view priority","description":{"content":"Update the priority of a screen view. You can update the priorities of active screen views.\n\n---\n\n**API consumer:** Synerise User\n\n**User role permission required:** `assets_docs: create`\n","type":"text/plain"},"url":{"path":["schema-service","screenViews","single",":screenViewId",":screenViewVersion","priority"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"screenViewId","description":"(Required) UUID of the screen view"},{"disabled":false,"type":"any","value":"string","key":"screenViewVersion","description":"(Required) Version of the screen view"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PUT","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"1834","options":{"raw":{"language":"json"}}}},"response":[{"id":"d4201c43-b137-4f3d-b255-703ae28719f9","name":"Success","originalRequest":{"url":{"path":["schema-service","screenViews","single",":screenViewId",":screenViewVersion","priority"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"screenViewId","description":"(Required) UUID of the screen view"},{"disabled":false,"type":"any","value":"string","key":"screenViewVersion","description":"(Required) Version of the screen view"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"1834","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"status\": \"string\",\n \"body\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"407167c7-d47c-4b41-adba-c85f5eaebb09","name":"See error message for details","originalRequest":{"url":{"path":["schema-service","screenViews","single",":screenViewId",":screenViewVersion","priority"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"screenViewId","description":"(Required) UUID of the screen view"},{"disabled":false,"type":"any","value":"string","key":"screenViewVersion","description":"(Required) Version of the screen view"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"1834","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"828d4539-d9e5-4276-a7bb-af783194edfc","name":"Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc.","originalRequest":{"url":{"path":["schema-service","screenViews","single",":screenViewId",":screenViewVersion","priority"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"screenViewId","description":"(Required) UUID of the screen view"},{"disabled":false,"type":"any","value":"string","key":"screenViewVersion","description":"(Required) Version of the screen view"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"1834","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"string\",\n \"error\": \"string\",\n \"message\": \"string\",\n \"status\": 6404\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"3dd39a27-68ad-4918-a647-b3fd12ef4b35","name":"Forbidden; insufficient permissions","originalRequest":{"url":{"path":["schema-service","screenViews","single",":screenViewId",":screenViewVersion","priority"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"screenViewId","description":"(Required) UUID of the screen view"},{"disabled":false,"type":"any","value":"string","key":"screenViewVersion","description":"(Required) Version of the screen view"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"1834","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"string\",\n \"error\": \"string\",\n \"message\": \"string\",\n \"status\": 6404\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"fe756263-23a5-4337-880f-9f2b94e39bd2","name":"Resource not found","originalRequest":{"url":{"path":["schema-service","screenViews","single",":screenViewId",":screenViewVersion","priority"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"screenViewId","description":"(Required) UUID of the screen view"},{"disabled":false,"type":"any","value":"string","key":"screenViewVersion","description":"(Required) Version of the screen view"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"1834","options":{"raw":{"language":"json"}}}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"b7fb780e-7bb1-4e40-a140-d40fe5cd206e","name":"See error message for details","originalRequest":{"url":{"path":["schema-service","screenViews","single",":screenViewId",":screenViewVersion","priority"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"screenViewId","description":"(Required) UUID of the screen view"},{"disabled":false,"type":"any","value":"string","key":"screenViewVersion","description":"(Required) Version of the screen view"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"1834","options":{"raw":{"language":"json"}}}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"b00b53f7-c620-45f8-a453-a43614132fea","name":"Discard changes","request":{"name":"Discard changes","description":{"content":"Discard the changes made in a version of a screen view.\n\n---\n\n**API consumer:** Synerise User\n\n**User role permission required:** `assets_docs: create`\n","type":"text/plain"},"url":{"path":["schema-service","screenViews","discardChanges",":screenViewId",":screenViewVersion"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"screenViewId","description":"(Required) UUID of the screen view"},{"disabled":false,"type":"any","value":"string","key":"screenViewVersion","description":"(Required) Version of the screen view"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"2a283152-27b8-40aa-9cb8-0ef8dcc11914","name":"Success","originalRequest":{"url":{"path":["schema-service","screenViews","discardChanges",":screenViewId",":screenViewVersion"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"screenViewId","description":"(Required) UUID of the screen view"},{"disabled":false,"type":"any","value":"string","key":"screenViewVersion","description":"(Required) Version of the screen view"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"id\": \"fda740d1-f892-7bd2-821f-c900eeada15e\",\n \"businessProfileId\": 9621,\n \"name\": \"string\",\n \"status\": \"DRAFT\",\n \"priority\": 99,\n \"scheduled\": false,\n \"author\": {\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"avatar\": {\n \"value\": \"\"\n }\n },\n \"content\": {\n \"json\": {\n \"value\": \"\"\n },\n \"documents\": {\n \"value\": \"\"\n },\n \"groups\": {\n \"value\": \"\"\n },\n \"groupsOrder\": {\n \"value\": \"\"\n }\n },\n \"audience\": {\n \"targetType\": {\n \"value\": \"\"\n },\n \"segments\": {\n \"value\": \"\"\n },\n \"query\": {\n \"value\": \"\"\n }\n },\n \"createdAt\": \"1949-02-28T18:46:51.022Z\",\n \"updatedAt\": \"1982-12-06T01:47:57.153Z\",\n \"directory\": {\n \"value\": \"\"\n },\n \"feed\": {\n \"value\": \"\"\n },\n \"version\": \"string\",\n \"parentVersion\": \"string\",\n \"description\": \"string\",\n \"deletedAt\": \"1978-01-10T12:11:26.044Z\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"232d3b1c-718b-4565-86dc-7d382d413fea","name":"See error message for details","originalRequest":{"url":{"path":["schema-service","screenViews","discardChanges",":screenViewId",":screenViewVersion"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"screenViewId","description":"(Required) UUID of the screen view"},{"disabled":false,"type":"any","value":"string","key":"screenViewVersion","description":"(Required) Version of the screen view"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"bf3e8dfd-a8ca-483b-a6b6-5076df532ff0","name":"Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc.","originalRequest":{"url":{"path":["schema-service","screenViews","discardChanges",":screenViewId",":screenViewVersion"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"screenViewId","description":"(Required) UUID of the screen view"},{"disabled":false,"type":"any","value":"string","key":"screenViewVersion","description":"(Required) Version of the screen view"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"string\",\n \"error\": \"string\",\n \"message\": \"string\",\n \"status\": 6404\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"fbf40af0-9f0b-40c9-9e18-b0b8e9cb7e69","name":"Forbidden; insufficient permissions","originalRequest":{"url":{"path":["schema-service","screenViews","discardChanges",":screenViewId",":screenViewVersion"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"screenViewId","description":"(Required) UUID of the screen view"},{"disabled":false,"type":"any","value":"string","key":"screenViewVersion","description":"(Required) Version of the screen view"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"string\",\n \"error\": \"string\",\n \"message\": \"string\",\n \"status\": 6404\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"577b2cca-b4d6-4417-a5a0-07ef3dd67cfa","name":"Resource not found","originalRequest":{"url":{"path":["schema-service","screenViews","discardChanges",":screenViewId",":screenViewVersion"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"screenViewId","description":"(Required) UUID of the screen view"},{"disabled":false,"type":"any","value":"string","key":"screenViewVersion","description":"(Required) Version of the screen view"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"bc176ea8-1ebb-4211-88b6-677eb2f4c9f3","name":"See error message for details","originalRequest":{"url":{"path":["schema-service","screenViews","discardChanges",":screenViewId",":screenViewVersion"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"screenViewId","description":"(Required) UUID of the screen view"},{"disabled":false,"type":"any","value":"string","key":"screenViewVersion","description":"(Required) Version of the screen view"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"e986ea6c-7909-4cd1-80aa-f43f406f39fc","name":"Delete screen view","request":{"name":"Delete screen view","description":{"content":"Delete a screen view and all its versions. This operation is irreversible.\n\n---\n\n**API consumer:** Synerise User\n\n**User role permission required:** `assets_docs: delete`\n","type":"text/plain"},"url":{"path":["schema-service","screenViews","delete",":screenViewId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"screenViewId","description":"(Required) UUID of the screen view"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"eafc3302-6ead-49bb-bb91-a23f914a0bc2","name":"Success","originalRequest":{"url":{"path":["schema-service","screenViews","delete",":screenViewId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"screenViewId","description":"(Required) UUID of the screen view"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"status\": \"string\",\n \"body\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"fdeadc47-ea69-487e-bc69-0f5c1c9a085a","name":"See error message for details","originalRequest":{"url":{"path":["schema-service","screenViews","delete",":screenViewId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"screenViewId","description":"(Required) UUID of the screen view"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"1245c7fe-1d19-4823-8cbe-709b1d995ae4","name":"Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc.","originalRequest":{"url":{"path":["schema-service","screenViews","delete",":screenViewId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"screenViewId","description":"(Required) UUID of the screen view"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"string\",\n \"error\": \"string\",\n \"message\": \"string\",\n \"status\": 6404\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"74426238-37fe-4005-a709-54388d080a63","name":"Forbidden; insufficient permissions","originalRequest":{"url":{"path":["schema-service","screenViews","delete",":screenViewId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"screenViewId","description":"(Required) UUID of the screen view"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"string\",\n \"error\": \"string\",\n \"message\": \"string\",\n \"status\": 6404\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"b22bdd9d-b7f0-43b3-b021-8e5cde6cdf02","name":"Resource not found","originalRequest":{"url":{"path":["schema-service","screenViews","delete",":screenViewId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"screenViewId","description":"(Required) UUID of the screen view"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"62475db2-eace-4733-a80a-b6aa15ee4947","name":"See error message for details","originalRequest":{"url":{"path":["schema-service","screenViews","delete",":screenViewId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"screenViewId","description":"(Required) UUID of the screen view"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"242d6c75-b8ec-4294-954d-31f755f1cd96","name":"Delete screen view version","request":{"name":"Delete screen view version","description":{"content":"Delete a version of a screen view.\n\n---\n\n**API consumer:** Synerise User\n\n**User role permission required:** `assets_docs: delete`\n","type":"text/plain"},"url":{"path":["schema-service","screenViews","single","delete",":screenViewId",":screenViewVersion"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"screenViewId","description":"(Required) UUID of the screen view"},{"disabled":false,"type":"any","value":"string","key":"screenViewVersion","description":"(Required) Version of the screen view"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"bf958feb-6ba2-4c46-94c5-cd6e87defdf4","name":"Success","originalRequest":{"url":{"path":["schema-service","screenViews","single","delete",":screenViewId",":screenViewVersion"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"screenViewId","description":"(Required) UUID of the screen view"},{"disabled":false,"type":"any","value":"string","key":"screenViewVersion","description":"(Required) Version of the screen view"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"status\": \"string\",\n \"body\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"bd1d5898-3c79-43e2-a005-6846eeb83c06","name":"See error message for details","originalRequest":{"url":{"path":["schema-service","screenViews","single","delete",":screenViewId",":screenViewVersion"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"screenViewId","description":"(Required) UUID of the screen view"},{"disabled":false,"type":"any","value":"string","key":"screenViewVersion","description":"(Required) Version of the screen view"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"7eb5e959-38a7-4158-9311-401f1d087225","name":"Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc.","originalRequest":{"url":{"path":["schema-service","screenViews","single","delete",":screenViewId",":screenViewVersion"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"screenViewId","description":"(Required) UUID of the screen view"},{"disabled":false,"type":"any","value":"string","key":"screenViewVersion","description":"(Required) Version of the screen view"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"string\",\n \"error\": \"string\",\n \"message\": \"string\",\n \"status\": 6404\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"e3e14272-2793-405a-8118-1ce03f9459ab","name":"Forbidden; insufficient permissions","originalRequest":{"url":{"path":["schema-service","screenViews","single","delete",":screenViewId",":screenViewVersion"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"screenViewId","description":"(Required) UUID of the screen view"},{"disabled":false,"type":"any","value":"string","key":"screenViewVersion","description":"(Required) Version of the screen view"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"string\",\n \"error\": \"string\",\n \"message\": \"string\",\n \"status\": 6404\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"0f6f88a6-ae41-4570-8a50-3a4dafe6743c","name":"Resource not found","originalRequest":{"url":{"path":["schema-service","screenViews","single","delete",":screenViewId",":screenViewVersion"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"screenViewId","description":"(Required) UUID of the screen view"},{"disabled":false,"type":"any","value":"string","key":"screenViewVersion","description":"(Required) Version of the screen view"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"647797fe-d009-4b93-8698-63de1ded3dde","name":"See error message for details","originalRequest":{"url":{"path":["schema-service","screenViews","single","delete",":screenViewId",":screenViewVersion"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"screenViewId","description":"(Required) UUID of the screen view"},{"disabled":false,"type":"any","value":"string","key":"screenViewVersion","description":"(Required) Version of the screen view"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}],"event":[]},{"id":"b58a36eb-6ba8-460d-8620-bbeed6068942","name":"Time Optimizer","description":{"content":"","type":"text/plain"},"item":[{"id":"9013dffa-1bd5-45f8-a2cf-76f362709e3e","name":"Generate activity time predictions","request":{"name":"Generate activity time predictions","description":{"content":"Calculate the probability of a profile performing an activity (event) at specific times of the week.\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User\n\n**API key permission required:** `AI_TIME_OPTIMIZER_GET_PREDICTIONS_ANALYTICS_READ`\n\n**User role permission required:** `analytics_ai_time_optimizer: read`\n","type":"text/plain"},"url":{"path":["activity-time-estimator","v1","query-model"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"clientID\": {\n \"value\": \"\"\n },\n \"mode\": {\n \"value\": \"\"\n },\n \"timeIndex\": {\n \"value\": \"\"\n },\n \"timeIndexExclude\": {\n \"value\": \"\"\n },\n \"topN\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"15e823f6-5707-408a-8a0c-0c8fd1235824","name":"Predicted activity times","originalRequest":{"url":{"path":["activity-time-estimator","v1","query-model"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"clientID\": {\n \"value\": \"\"\n },\n \"mode\": {\n \"value\": \"\"\n },\n \"timeIndex\": {\n \"value\": \"\"\n },\n \"timeIndexExclude\": {\n \"value\": \"\"\n },\n \"topN\": {\n \"value\": \"\"\n }\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"clientID\": {\n \"value\": \"\"\n },\n \"hours\": {\n \"value\": \"\"\n },\n \"predictions\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}],"event":[]},{"id":"0ba9aca3-df46-4a5e-b267-29f6821c9a62","name":"Experiments","description":{"content":"","type":"text/plain"},"item":[{"id":"266852d9-88b3-4a08-a477-0adbbc0ba5b2","name":"Create experiment","request":{"name":"Create experiment","description":{"content":"Create a new A/B/X test for recommendations or item search.\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User\n\n**API key permission required:** `OPTIMIZER_MANAGER_TESTOPTIMIZER_CREATE`\n\n**User role permission required:** `campaigns_test_optimizer: create`\n","type":"text/plain"},"url":{"path":["optimizer","v2","experiments"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"name\": \"string\",\n \"experimentKind\": \"ITEMS_SEARCH\",\n \"variantsAllocationMethod\": \"Manual\",\n \"variants\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"description\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"71eef22d-0cdb-4c37-a2e0-a296ae6fec48","name":"ID of the created experiment","originalRequest":{"url":{"path":["optimizer","v2","experiments"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"name\": \"string\",\n \"experimentKind\": \"ITEMS_SEARCH\",\n \"variantsAllocationMethod\": \"Manual\",\n \"variants\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"description\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"experimentId\": 8576\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"4645cb40-c0ae-4d51-a6fa-61cc91a69484","name":"Check error message for more details.","originalRequest":{"url":{"path":["optimizer","v2","experiments"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"name\": \"string\",\n \"experimentKind\": \"ITEMS_SEARCH\",\n \"variantsAllocationMethod\": \"Manual\",\n \"variants\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"description\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\",\n \"errorCode\": \"string\",\n \"help\": \"string\",\n \"httpStatus\": 9141,\n \"message\": \"string\",\n \"path\": \"string\",\n \"requestId\": \"string\",\n \"status\": 8174,\n \"timestamp\": \"1957-01-05T10:51:39.982Z\",\n \"traceId\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"8664807f-4ae2-493c-8816-547b44548ac6","name":"Find experiments","request":{"name":"Find experiments","description":{"content":"Find experiments. You can filter the results by campaign type, status, author, or search for a string in the name, or declare the ID of the experiment.\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User\n\n**API key permission required:** `OPTIMIZER_MANAGER_TESTOPTIMIZER_READ`\n\n**User role permission required:** `campaigns_test_optimizer: read`\n","type":"text/plain"},"url":{"path":["optimizer","v2","experiments"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"campaignType","value":"RECOMMENDATION_CAMPAIGN","description":"CampaignType of the experiment"},{"disabled":false,"key":"status","value":"Paused","description":"Requested status of the experiment. One of: NotStarted, Running, Paused, Finished, Draft. May pass more than one status."},{"disabled":false,"key":"status","value":"Paused","description":"Requested status of the experiment. One of: NotStarted, Running, Paused, Finished, Draft. May pass more than one status."},{"disabled":false,"key":"search","value":"string","description":"ID of the experiment or a part of its name."}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"15158f9a-8d9f-4e6e-a3ae-4b4dbd71e7c8","name":"Experiments returned","originalRequest":{"url":{"path":["optimizer","v2","experiments"],"host":["{{baseUrl}}"],"query":[{"key":"campaignType","value":"RECOMMENDATION_CAMPAIGN"},{"key":"status","value":"Draft"},{"key":"status","value":"Draft"},{"key":"search","value":"string"}],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"[\n {\n \"experimentId\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"experimentKind\": {\n \"value\": \"\"\n },\n \"variantsAllocationMethod\": {\n \"value\": \"\"\n },\n \"status\": {\n \"value\": \"\"\n },\n \"createdAt\": {\n \"value\": \"\"\n },\n \"variants\": {\n \"value\": \"\"\n },\n \"author\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n },\n \"startedAt\": {\n \"value\": \"\"\n },\n \"stoppedAt\": {\n \"value\": \"\"\n },\n \"updatedAt\": {\n \"value\": \"\"\n }\n },\n {\n \"experimentId\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"experimentKind\": {\n \"value\": \"\"\n },\n \"variantsAllocationMethod\": {\n \"value\": \"\"\n },\n \"status\": {\n \"value\": \"\"\n },\n \"createdAt\": {\n \"value\": \"\"\n },\n \"variants\": {\n \"value\": \"\"\n },\n \"author\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n },\n \"startedAt\": {\n \"value\": \"\"\n },\n \"stoppedAt\": {\n \"value\": \"\"\n },\n \"updatedAt\": {\n \"value\": \"\"\n }\n }\n]","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"e38a6131-91e3-464b-8137-757a7adf4c25","name":"Update experiment","request":{"name":"Update experiment","description":{"content":"Update an existing experiment.\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User\n\n**API key permission required:** `OPTIMIZER_MANAGER_TESTOPTIMIZER_UPDATE`\n\n**User role permission required:** `campaigns_test_optimizer: update`\n","type":"text/plain"},"url":{"path":["optimizer","v2","experiments",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"5612","key":"id","description":"(Required) ID of the experiment"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PUT","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"name\": \"string\",\n \"experimentKind\": \"ITEMS_SEARCH\",\n \"variantsAllocationMethod\": \"Manual\",\n \"variants\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"description\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"ccd698ec-95f1-4c3c-8c5d-87ff43055029","name":"Experiment updated successfully","originalRequest":{"url":{"path":["optimizer","v2","experiments",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"5612","key":"id","description":"(Required) ID of the experiment"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"PUT","body":{"mode":"raw","raw":"{\n \"name\": \"string\",\n \"experimentKind\": \"ITEMS_SEARCH\",\n \"variantsAllocationMethod\": \"Manual\",\n \"variants\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"description\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"No Content","code":204,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"216392eb-4b32-47c7-a14f-32b70d42866d","name":"Check error message for more details.","originalRequest":{"url":{"path":["optimizer","v2","experiments",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"5612","key":"id","description":"(Required) ID of the experiment"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"{\n \"name\": \"string\",\n \"experimentKind\": \"ITEMS_SEARCH\",\n \"variantsAllocationMethod\": \"Manual\",\n \"variants\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"description\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\",\n \"errorCode\": \"string\",\n \"help\": \"string\",\n \"httpStatus\": 9141,\n \"message\": \"string\",\n \"path\": \"string\",\n \"requestId\": \"string\",\n \"status\": 8174,\n \"timestamp\": \"1957-01-05T10:51:39.982Z\",\n \"traceId\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"90769a92-8ae7-4be1-ad67-4fa5b5553b5e","name":"Experiment not found. Check error message for more details.","originalRequest":{"url":{"path":["optimizer","v2","experiments",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"5612","key":"id","description":"(Required) ID of the experiment"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"{\n \"name\": \"string\",\n \"experimentKind\": \"ITEMS_SEARCH\",\n \"variantsAllocationMethod\": \"Manual\",\n \"variants\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"description\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\",\n \"errorCode\": \"string\",\n \"help\": \"string\",\n \"httpStatus\": 9141,\n \"message\": \"string\",\n \"path\": \"string\",\n \"requestId\": \"string\",\n \"status\": 8174,\n \"timestamp\": \"1957-01-05T10:51:39.982Z\",\n \"traceId\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"dc5f36c4-f27a-4b6b-9058-200007fdde4e","name":"Get experiment","request":{"name":"Get experiment","description":{"content":"Retrieve the details of an experiment.\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User\n\n**API key permission required:** `OPTIMIZER_MANAGER_TESTOPTIMIZER_READ`\n\n**User role permission required:** `campaigns_test_optimizer: read`\n","type":"text/plain"},"url":{"path":["optimizer","v2","experiments",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"5612","key":"id","description":"(Required) ID of the experiment"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"d179faad-5c0f-480d-9d92-365afa4933ff","name":"Extended experiment returned","originalRequest":{"url":{"path":["optimizer","v2","experiments",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"5612","key":"id","description":"(Required) ID of the experiment"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"experimentId\": 8757,\n \"name\": \"string\",\n \"experimentKind\": \"ITEMS_SEARCH\",\n \"variantsAllocationMethod\": \"Manual\",\n \"status\": \"NotStarted\",\n \"createdAt\": \"2011-03-27T17:55:57.498Z\",\n \"variants\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"author\": 7773,\n \"description\": \"string\",\n \"startedAt\": \"2018-08-07T14:05:33.670Z\",\n \"stoppedAt\": \"2018-02-28T17:42:31.657Z\",\n \"updatedAt\": \"1950-01-05T08:00:46.179Z\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"e01ab050-185d-471c-8f5a-1148f2c10696","name":"Experiment not found. Check error message for more details.","originalRequest":{"url":{"path":["optimizer","v2","experiments",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"5612","key":"id","description":"(Required) ID of the experiment"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\",\n \"errorCode\": \"string\",\n \"help\": \"string\",\n \"httpStatus\": 9141,\n \"message\": \"string\",\n \"path\": \"string\",\n \"requestId\": \"string\",\n \"status\": 8174,\n \"timestamp\": \"1957-01-05T10:51:39.982Z\",\n \"traceId\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"cc25d1f0-9d86-412c-8c46-ca29c70ac57e","name":"Delete experiment","request":{"name":"Delete experiment","description":{"content":"Delete an experiment permanently.\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User\n\n**API key permission required:** `OPTIMIZER_MANAGER_TESTOPTIMIZER_DELETE`\n\n**User role permission required:** `campaigns_test_optimizer: delete`\n","type":"text/plain"},"url":{"path":["optimizer","v2","experiments",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"5612","key":"id","description":"(Required) ID of the experiment"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"94e9121f-2ba3-4634-9bd5-a503d0e4f5ed","name":"Experiment deleted successfully","originalRequest":{"url":{"path":["optimizer","v2","experiments",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"5612","key":"id","description":"(Required) ID of the experiment"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"DELETE","body":{}},"status":"No Content","code":204,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"c245c7ae-050a-4076-b3f1-958f55dbaccf","name":"Experiment not found. Check error message for more details.","originalRequest":{"url":{"path":["optimizer","v2","experiments",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"5612","key":"id","description":"(Required) ID of the experiment"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\",\n \"errorCode\": \"string\",\n \"help\": \"string\",\n \"httpStatus\": 9141,\n \"message\": \"string\",\n \"path\": \"string\",\n \"requestId\": \"string\",\n \"status\": 8174,\n \"timestamp\": \"1957-01-05T10:51:39.982Z\",\n \"traceId\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"ff4b4a36-ee11-45e6-8fa6-cd9e20416bfc","name":"Start experiment","request":{"name":"Start experiment","description":{"content":"Start an experiment (for paused experiments, use [this method](#operation/ResumeExperiment)).\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User\n\n**API key permission required:** `OPTIMIZER_MANAGER_TESTOPTIMIZER_EXECUTE`\n\n**User role permission required:** `campaigns_test_optimizer: execute`\n","type":"text/plain"},"url":{"path":["optimizer","v2","experiments",":id","start"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"5612","key":"id","description":"(Required) ID of the experiment"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"c1013722-d7a0-4db6-bd38-661e762a2743","name":"Experiment started successfully","originalRequest":{"url":{"path":["optimizer","v2","experiments",":id","start"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"5612","key":"id","description":"(Required) ID of the experiment"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"POST","body":{}},"status":"No Content","code":204,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"8c8d3118-7d95-4f9e-936c-833dd92acbc6","name":"Check error message for more details.","originalRequest":{"url":{"path":["optimizer","v2","experiments",":id","start"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"5612","key":"id","description":"(Required) ID of the experiment"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\",\n \"errorCode\": \"string\",\n \"help\": \"string\",\n \"httpStatus\": 9141,\n \"message\": \"string\",\n \"path\": \"string\",\n \"requestId\": \"string\",\n \"status\": 8174,\n \"timestamp\": \"1957-01-05T10:51:39.982Z\",\n \"traceId\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"d511fb39-7642-47ea-9d34-84e9393ba9fc","name":"Experiment not found. Check error message for more details.","originalRequest":{"url":{"path":["optimizer","v2","experiments",":id","start"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"5612","key":"id","description":"(Required) ID of the experiment"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\",\n \"errorCode\": \"string\",\n \"help\": \"string\",\n \"httpStatus\": 9141,\n \"message\": \"string\",\n \"path\": \"string\",\n \"requestId\": \"string\",\n \"status\": 8174,\n \"timestamp\": \"1957-01-05T10:51:39.982Z\",\n \"traceId\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"8e536097-a81c-4599-b2d4-7710b9b21a47","name":"Stop experiment","request":{"name":"Stop experiment","description":{"content":"Stop an experiment. It **cannot** be started again.\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User\n\n**API key permission required:** `OPTIMIZER_MANAGER_TESTOPTIMIZER_EXECUTE`\n\n**User role permission required:** `campaigns_test_optimizer: execute`\n","type":"text/plain"},"url":{"path":["optimizer","v2","experiments",":id","stop"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"5612","key":"id","description":"(Required) ID of the experiment"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"bfce52b8-8ef0-418d-adcf-c4f9d237be3b","name":"Experiment stopped successfully","originalRequest":{"url":{"path":["optimizer","v2","experiments",":id","stop"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"5612","key":"id","description":"(Required) ID of the experiment"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"POST","body":{}},"status":"No Content","code":204,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"68664043-adec-4abc-8e33-f738a88fcd7b","name":"Check error message for more details.","originalRequest":{"url":{"path":["optimizer","v2","experiments",":id","stop"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"5612","key":"id","description":"(Required) ID of the experiment"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\",\n \"errorCode\": \"string\",\n \"help\": \"string\",\n \"httpStatus\": 9141,\n \"message\": \"string\",\n \"path\": \"string\",\n \"requestId\": \"string\",\n \"status\": 8174,\n \"timestamp\": \"1957-01-05T10:51:39.982Z\",\n \"traceId\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"4305b29f-a38e-4aa5-8c8b-8423737ed057","name":"Experiment not found. Check error message for more details.","originalRequest":{"url":{"path":["optimizer","v2","experiments",":id","stop"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"5612","key":"id","description":"(Required) ID of the experiment"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\",\n \"errorCode\": \"string\",\n \"help\": \"string\",\n \"httpStatus\": 9141,\n \"message\": \"string\",\n \"path\": \"string\",\n \"requestId\": \"string\",\n \"status\": 8174,\n \"timestamp\": \"1957-01-05T10:51:39.982Z\",\n \"traceId\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"a51e3526-0d48-4dd3-b00e-3deaf8890318","name":"Pause experiment","request":{"name":"Pause experiment","description":{"content":"Pause an experiment. It can be resumed later.\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User\n\n**API key permission required:** `OPTIMIZER_MANAGER_TESTOPTIMIZER_EXECUTE`\n\n**User role permission required:** `campaigns_test_optimizer: execute`\n","type":"text/plain"},"url":{"path":["optimizer","v2","experiments",":id","pause"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"5612","key":"id","description":"(Required) ID of the experiment"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"396427a2-4ecc-4dcb-8721-32f057724265","name":"Experiment paused successfully","originalRequest":{"url":{"path":["optimizer","v2","experiments",":id","pause"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"5612","key":"id","description":"(Required) ID of the experiment"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"POST","body":{}},"status":"No Content","code":204,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"18842589-53b6-40ad-9b91-e204de9ec7e0","name":"Check error message for more details.","originalRequest":{"url":{"path":["optimizer","v2","experiments",":id","pause"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"5612","key":"id","description":"(Required) ID of the experiment"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\",\n \"errorCode\": \"string\",\n \"help\": \"string\",\n \"httpStatus\": 9141,\n \"message\": \"string\",\n \"path\": \"string\",\n \"requestId\": \"string\",\n \"status\": 8174,\n \"timestamp\": \"1957-01-05T10:51:39.982Z\",\n \"traceId\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"98633cc6-3078-48f7-8ccb-df75b6e83ac0","name":"Experiment not found. Check error message for more details.","originalRequest":{"url":{"path":["optimizer","v2","experiments",":id","pause"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"5612","key":"id","description":"(Required) ID of the experiment"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\",\n \"errorCode\": \"string\",\n \"help\": \"string\",\n \"httpStatus\": 9141,\n \"message\": \"string\",\n \"path\": \"string\",\n \"requestId\": \"string\",\n \"status\": 8174,\n \"timestamp\": \"1957-01-05T10:51:39.982Z\",\n \"traceId\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"4a270387-8830-4d60-8eca-71471363a53e","name":"Resume experiment","request":{"name":"Resume experiment","description":{"content":"Resume an experiment after it was paused.\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User\n\n**API key permission required:** `OPTIMIZER_MANAGER_TESTOPTIMIZER_EXECUTE`\n\n**User role permission required:** `campaigns_test_optimizer: execute`\n","type":"text/plain"},"url":{"path":["optimizer","v2","experiments",":id","resume"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"5612","key":"id","description":"(Required) ID of the experiment"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"8e728c5f-c35d-4899-a51a-1c3c0ab8c584","name":"Experiment resumed successfully","originalRequest":{"url":{"path":["optimizer","v2","experiments",":id","resume"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"5612","key":"id","description":"(Required) ID of the experiment"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"POST","body":{}},"status":"No Content","code":204,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"34717a59-69ad-42fa-8488-6a7502344638","name":"Check error message for more details.","originalRequest":{"url":{"path":["optimizer","v2","experiments",":id","resume"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"5612","key":"id","description":"(Required) ID of the experiment"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\",\n \"errorCode\": \"string\",\n \"help\": \"string\",\n \"httpStatus\": 9141,\n \"message\": \"string\",\n \"path\": \"string\",\n \"requestId\": \"string\",\n \"status\": 8174,\n \"timestamp\": \"1957-01-05T10:51:39.982Z\",\n \"traceId\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"297730a6-c681-4dfa-9ddf-cedb3bf3a00a","name":"Experiment not found. Check error message for more details.","originalRequest":{"url":{"path":["optimizer","v2","experiments",":id","resume"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"5612","key":"id","description":"(Required) ID of the experiment"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1963-08-12T14:54:43.321Z\",\n \"status\": 2878,\n \"message\": \"string\",\n \"error\": \"string\",\n \"path\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"1095f99d-5e5b-48aa-a48e-e32b554eebac","name":"Duplicate experiment","request":{"name":"Duplicate experiment","description":{"content":"Create a copy of an existing experiment. You can only duplicate experiments that are stopped.\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User\n\n**API key permission required:** `OPTIMIZER_MANAGER_TESTOPTIMIZER_CREATE`\n\n**User role permission required:** `campaigns_test_optimizer: create`\n","type":"text/plain"},"url":{"path":["optimizer","v2","experiments",":id","duplicate"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"5612","key":"id","description":"(Required) ID of the experiment"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"923e9625-f8ed-4c4f-995a-6962ba956e09","name":"ID of the created experiment","originalRequest":{"url":{"path":["optimizer","v2","experiments",":id","duplicate"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"5612","key":"id","description":"(Required) ID of the experiment"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"experimentId\": 8576\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"86615f11-95fe-4e88-9289-1a56635cad73","name":"Check error message for more details.","originalRequest":{"url":{"path":["optimizer","v2","experiments",":id","duplicate"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"5612","key":"id","description":"(Required) ID of the experiment"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\",\n \"errorCode\": \"string\",\n \"help\": \"string\",\n \"httpStatus\": 9141,\n \"message\": \"string\",\n \"path\": \"string\",\n \"requestId\": \"string\",\n \"status\": 8174,\n \"timestamp\": \"1957-01-05T10:51:39.982Z\",\n \"traceId\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"e8db8a11-c763-442e-8575-80c604cc96ff","name":"Experiment not found. Check error message for more details.","originalRequest":{"url":{"path":["optimizer","v2","experiments",":id","duplicate"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"5612","key":"id","description":"(Required) ID of the experiment"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\",\n \"errorCode\": \"string\",\n \"help\": \"string\",\n \"httpStatus\": 9141,\n \"message\": \"string\",\n \"path\": \"string\",\n \"requestId\": \"string\",\n \"status\": 8174,\n \"timestamp\": \"1957-01-05T10:51:39.982Z\",\n \"traceId\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}],"event":[]},{"id":"10ca51ef-901b-46c0-a477-199cf59cbcac","name":"Item filters","description":{"content":"","type":"text/plain"},"item":[{"id":"bbee85fa-e13d-4c69-8f5b-b666786d66bd","name":"Validate item filter","request":{"name":"Validate item filter","description":{"content":"This endpoint lets you validate the syntax of a filter and preview its results.\n\nThe `parserResult` object in the response validates only the IQL syntax, it does not check if the attributes or contexts referenced in the IQL query exist!\n\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User\n\n**API key permission required:** `ITEMS_FILTER_VALIDATE_READ`\n\n**User role permission required:** `campaigns_recommendations: read`\n","type":"text/plain"},"url":{"path":["items","v2","filter","validate"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"itemsCatalogId","value":"default","description":"ID of the item catalog that contains the items tested in the request. If not provided, \"default\" is assumed - however, the \"default\" catalog may not exist in your workspace.\n\n**NOTE:** This ID is available in the details the search index or recommendation campaign you want to make test requests for.\n"},{"disabled":false,"key":"exampleItems","value":"10","description":"Controls how many example items will be returned"}],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"filteringString\": \"IF(\\\"abcd\\\" IN client.tags,discount == 0,discount > 0)\",\n \"clientUUID\": \"68df2317-0edb-4cc9-8b39-5ab68325f891\",\n \"contextItems\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"inventoryContext\": {\n \"value\": \"\"\n },\n \"candidateItems\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"8c4f58bb-12f6-4a83-830e-52b4b1f632f5","name":"Validation response","originalRequest":{"url":{"path":["items","v2","filter","validate"],"host":["{{baseUrl}}"],"query":[{"key":"itemsCatalogId","value":"default"},{"key":"exampleItems","value":"10"}],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"filteringString\": \"IF(\\\"abcd\\\" IN client.tags,discount == 0,discount > 0)\",\n \"clientUUID\": \"68df2317-0edb-4cc9-8b39-5ab68325f891\",\n \"contextItems\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"inventoryContext\": {\n \"value\": \"\"\n },\n \"candidateItems\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"filteringString\": \"IF(\\\"abcd\\\" IN client.tags,discount == 0,discount > 0)\",\n \"parserResult\": {\n \"valid\": {\n \"value\": \"\"\n },\n \"parsedFilteringString\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n },\n \"contextItems\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"clientUUID\": \"68df2317-0edb-4cc9-8b39-5ab68325f891\",\n \"evaluationResult\": {\n \"resultSize\": {\n \"value\": \"\"\n },\n \"modifiedFilteringString\": {\n \"value\": \"\"\n },\n \"evaluationErrors\": {\n \"value\": \"\"\n }\n },\n \"extracts\": {\n \"clientExtracts\": {\n \"value\": \"\"\n },\n \"contextConstants\": {\n \"value\": \"\"\n },\n \"variables\": {\n \"value\": \"\"\n }\n },\n \"candidateItems\": [\n {\n \"itemId\": {\n \"value\": \"\"\n },\n \"valid\": {\n \"value\": \"\"\n }\n },\n {\n \"itemId\": {\n \"value\": \"\"\n },\n \"valid\": {\n \"value\": \"\"\n }\n }\n ],\n \"exampleItems\": [\n \"string\",\n \"string\"\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"fb28691e-916a-4dcd-8ec2-d2c3868835a1","name":"Bad Request","originalRequest":{"url":{"path":["items","v2","filter","validate"],"host":["{{baseUrl}}"],"query":[{"key":"itemsCatalogId","value":"default"},{"key":"exampleItems","value":"10"}],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"filteringString\": \"IF(\\\"abcd\\\" IN client.tags,discount == 0,discount > 0)\",\n \"clientUUID\": \"68df2317-0edb-4cc9-8b39-5ab68325f891\",\n \"contextItems\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"inventoryContext\": {\n \"value\": \"\"\n },\n \"candidateItems\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1988-10-05T00:11:12.378Z\",\n \"status\": 8153,\n \"message\": \"string\",\n \"error\": \"string\",\n \"path\": \"string\",\n \"requestId\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"c8bfbc4f-5db2-477a-928a-73fd13db72aa","name":"Service not available","originalRequest":{"url":{"path":["items","v2","filter","validate"],"host":["{{baseUrl}}"],"query":[{"key":"itemsCatalogId","value":"default"},{"key":"exampleItems","value":"10"}],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"filteringString\": \"IF(\\\"abcd\\\" IN client.tags,discount == 0,discount > 0)\",\n \"clientUUID\": \"68df2317-0edb-4cc9-8b39-5ab68325f891\",\n \"contextItems\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"inventoryContext\": {\n \"value\": \"\"\n },\n \"candidateItems\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1988-10-05T00:11:12.378Z\",\n \"status\": 8153,\n \"message\": \"string\",\n \"error\": \"string\",\n \"path\": \"string\",\n \"requestId\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"95e88f2b-dd8f-4c8d-a3d0-e1105d8b10bd","name":"Catalog not ready","originalRequest":{"url":{"path":["items","v2","filter","validate"],"host":["{{baseUrl}}"],"query":[{"key":"itemsCatalogId","value":"default"},{"key":"exampleItems","value":"10"}],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"filteringString\": \"IF(\\\"abcd\\\" IN client.tags,discount == 0,discount > 0)\",\n \"clientUUID\": \"68df2317-0edb-4cc9-8b39-5ab68325f891\",\n \"contextItems\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"inventoryContext\": {\n \"value\": \"\"\n },\n \"candidateItems\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Gateway","code":502,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1988-10-05T00:11:12.378Z\",\n \"status\": 8153,\n \"message\": \"string\",\n \"error\": \"string\",\n \"path\": \"string\",\n \"requestId\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}],"event":[]},{"id":"20cc727c-b1bc-4639-8b25-8bdddffff527","name":"Documents","description":{"content":"","type":"text/plain"},"item":[{"id":"dc817c2a-8246-474b-b986-f2f374d3d69e","name":"Generate document (slug)","request":{"name":"Generate document (slug)","description":{"content":"Generate a document. Inserts are processed. If an insert can't be processed, the returned `content` is empty.\n\nIf the document includes inserts with a context (for example, `{% customer param %}`), you must authenticate the request with a JWT that provides the context.\n\nIf you want to authenticate with a JWT that doesn't provide the required context, you can use the [`POST /v2/documents/{slug}/generate` endpoint](operation/generateDocumentBySlug) to provide the parameter values in the request body.\n\n**IMPORTANT**: When the request's context is a Workspace or Synerise User JWT, only documents with the audience set to `ALL` (\"Everyone\" in the Synerise Web Application) can be generated.\n\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User, Profile (Client), Anonymous Profile, Incognito Profile\n\n**API key permission required:** `SCHEMA_SERVICE_SCHEMA_READ`\n\n**User role permission required:** `assets_docs: read`\n","type":"text/plain"},"url":{"path":["schema-service","v2","documents",":slug","generate"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"cvtcb-kyq67m-i2-vca-1x-gr4vo","key":"slug","description":"(Required) Slug of the document"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"bb7dbb1a-fea8-46dc-9bed-3107814aca8e","name":"Processed JSON content","originalRequest":{"url":{"path":["schema-service","v2","documents",":slug","generate"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"cvtcb-kyq67m-i2-vca-1x-gr4vo","key":"slug","description":"(Required) Slug of the document"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"slug\": \"basket\",\n \"schema\": \"containers\",\n \"content\": {\n \"value\": \"\"\n },\n \"uuid\": \"e8f9b38e-fd75-e175-c73f-e4b4aaf36d18\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"b4b7fa6a-e5d7-44a3-a4bd-00765d982e97","name":"See error message for details","originalRequest":{"url":{"path":["schema-service","v2","documents",":slug","generate"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"cvtcb-kyq67m-i2-vca-1x-gr4vo","key":"slug","description":"(Required) Slug of the document"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"e137ad2b-11f4-483a-b428-0aa0d4f764a0","name":"Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc.","originalRequest":{"url":{"path":["schema-service","v2","documents",":slug","generate"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"cvtcb-kyq67m-i2-vca-1x-gr4vo","key":"slug","description":"(Required) Slug of the document"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"string\",\n \"error\": \"string\",\n \"message\": \"string\",\n \"status\": 6404\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"9f22cfbc-d7b5-44e7-8967-4ddbf62b2aa4","name":"Forbidden; insufficient permissions","originalRequest":{"url":{"path":["schema-service","v2","documents",":slug","generate"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"cvtcb-kyq67m-i2-vca-1x-gr4vo","key":"slug","description":"(Required) Slug of the document"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"string\",\n \"error\": \"string\",\n \"message\": \"string\",\n \"status\": 6404\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"12bd3b48-fb02-4f4c-857a-18ad007ba939","name":"Resource not found","originalRequest":{"url":{"path":["schema-service","v2","documents",":slug","generate"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"cvtcb-kyq67m-i2-vca-1x-gr4vo","key":"slug","description":"(Required) Slug of the document"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"93894743-5f72-4895-95f5-ffe62e203e9d","name":"See error message for details","originalRequest":{"url":{"path":["schema-service","v2","documents",":slug","generate"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"cvtcb-kyq67m-i2-vca-1x-gr4vo","key":"slug","description":"(Required) Slug of the document"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"575e25fa-75db-4b83-b4e1-055a4243ae5e","name":"Generate document (slug)","request":{"name":"Generate document (slug)","description":{"content":"Generate a document. Inserts are processed. If an insert can't be processed, the returned `content` is empty.\n\n**IMPORTANT**: When the request's context is a Workspace or Synerise User JWT, only documents with the audience set to `ALL` (\"Everyone\" in the Synerise Web Application) can be generated.\n\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User, Profile (Client), Anonymous Profile, Incognito Profile\n\n**API key permission required:** `SCHEMA_SERVICE_SCHEMA_READ`\n\n**User role permission required:** `assets_docs: read`\n","type":"text/plain"},"url":{"path":["schema-service","v2","documents",":slug","generate"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"cvtcb-kyq67m-i2-vca-1x-gr4vo","key":"slug","description":"(Required) Slug of the document"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"customer.firstName\": \"Joe\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"5c28ea5d-5f59-4b63-a299-94247f18d903","name":"Processed JSON content","originalRequest":{"url":{"path":["schema-service","v2","documents",":slug","generate"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"cvtcb-kyq67m-i2-vca-1x-gr4vo","key":"slug","description":"(Required) Slug of the document"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"customer.firstName\": \"Joe\"\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"slug\": \"basket\",\n \"schema\": \"containers\",\n \"content\": {\n \"value\": \"\"\n },\n \"uuid\": \"e8f9b38e-fd75-e175-c73f-e4b4aaf36d18\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"c9bd2d66-48c3-4db2-9281-669fc1f2d296","name":"See error message for details","originalRequest":{"url":{"path":["schema-service","v2","documents",":slug","generate"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"cvtcb-kyq67m-i2-vca-1x-gr4vo","key":"slug","description":"(Required) Slug of the document"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"customer.firstName\": \"Joe\"\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"c4d775b1-a306-4abb-a9f7-753155ceea9c","name":"Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc.","originalRequest":{"url":{"path":["schema-service","v2","documents",":slug","generate"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"cvtcb-kyq67m-i2-vca-1x-gr4vo","key":"slug","description":"(Required) Slug of the document"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"customer.firstName\": \"Joe\"\n}","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"string\",\n \"error\": \"string\",\n \"message\": \"string\",\n \"status\": 6404\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"e4e39642-ba7d-4ecf-aa78-014f136bcc1a","name":"Forbidden; insufficient permissions","originalRequest":{"url":{"path":["schema-service","v2","documents",":slug","generate"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"cvtcb-kyq67m-i2-vca-1x-gr4vo","key":"slug","description":"(Required) Slug of the document"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"customer.firstName\": \"Joe\"\n}","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"string\",\n \"error\": \"string\",\n \"message\": \"string\",\n \"status\": 6404\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"4733ed25-27e2-46d6-ad7f-875ce2b86ed2","name":"Resource not found","originalRequest":{"url":{"path":["schema-service","v2","documents",":slug","generate"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"cvtcb-kyq67m-i2-vca-1x-gr4vo","key":"slug","description":"(Required) Slug of the document"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"customer.firstName\": \"Joe\"\n}","options":{"raw":{"language":"json"}}}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"b63a595d-de29-4ab9-b3ab-afe5adfef144","name":"See error message for details","originalRequest":{"url":{"path":["schema-service","v2","documents",":slug","generate"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"cvtcb-kyq67m-i2-vca-1x-gr4vo","key":"slug","description":"(Required) Slug of the document"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"customer.firstName\": \"Joe\"\n}","options":{"raw":{"language":"json"}}}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"5a3ccb83-b19e-4d9c-b9b1-68d4ed774652","name":"Generate document (document UUID)","request":{"name":"Generate document (document UUID)","description":{"content":"Generate a document. Inserts are processed. If an insert can't be processed, the returned `content` is empty.\n\n**IMPORTANT**: When the request's context is a Workspace or Synerise User JWT, only documents with the audience set to `ALL` (\"Everyone\" in the Synerise Web Application) can be generated.\n\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User, Profile (Client), Anonymous Profile\n\n**API key permission required:** `SCHEMA_SERVICE_SCHEMA_READ`\n\n**User role permission required:** `assets_docs: read`\n","type":"text/plain"},"url":{"path":["schema-service","v2","documents",":documentId","generate"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"documentId","description":"(Required) UUID of the document"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"customer.firstName\": \"Joe\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"05dc123a-7484-4c3a-8166-1e2f23f6d2cd","name":"Processed document","originalRequest":{"url":{"path":["schema-service","v2","documents",":documentId","generate"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"documentId","description":"(Required) UUID of the document"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"customer.firstName\": \"Joe\"\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"key_0\": {},\n \"key_1\": {}\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"605fe463-9f7a-41a0-96ca-8cf158b63bed","name":"See error message for details","originalRequest":{"url":{"path":["schema-service","v2","documents",":documentId","generate"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"documentId","description":"(Required) UUID of the document"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"customer.firstName\": \"Joe\"\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"f34f81f6-7d2a-4af5-af85-7ab6e4880ad7","name":"Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc.","originalRequest":{"url":{"path":["schema-service","v2","documents",":documentId","generate"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"documentId","description":"(Required) UUID of the document"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"customer.firstName\": \"Joe\"\n}","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"string\",\n \"error\": \"string\",\n \"message\": \"string\",\n \"status\": 6404\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"4c50fe9f-4999-41e5-a5d7-94f13dd31295","name":"Forbidden; insufficient permissions","originalRequest":{"url":{"path":["schema-service","v2","documents",":documentId","generate"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"documentId","description":"(Required) UUID of the document"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"customer.firstName\": \"Joe\"\n}","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"string\",\n \"error\": \"string\",\n \"message\": \"string\",\n \"status\": 6404\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"4f2e7e8a-23bc-4714-944e-68c177e7088f","name":"Resource not found","originalRequest":{"url":{"path":["schema-service","v2","documents",":documentId","generate"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"documentId","description":"(Required) UUID of the document"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"customer.firstName\": \"Joe\"\n}","options":{"raw":{"language":"json"}}}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"22f5dee4-1fdf-4870-891b-7e9ade6069e5","name":"See error message for details","originalRequest":{"url":{"path":["schema-service","v2","documents",":documentId","generate"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"documentId","description":"(Required) UUID of the document"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"customer.firstName\": \"Joe\"\n}","options":{"raw":{"language":"json"}}}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"0d3e0570-95df-4de5-b3c4-65a3d4f4ed44","name":"Create document","request":{"name":"Create document","description":{"content":"Create a new document.\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User\n\n**API key permission required:** `SCHEMA_SERVICE_SCHEMA_CREATE`\n\n**User role permission required:** `assets_docs: create`\n","type":"text/plain"},"url":{"path":["schema-service","v2","documents","create"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"name\": \"string\",\n \"priority\": 87,\n \"content\": {\n \"value\": \"\"\n },\n \"slug\": \"basket\",\n \"audience\": {\n \"targetType\": {\n \"value\": \"\"\n },\n \"segments\": {\n \"value\": \"\"\n },\n \"query\": {\n \"value\": \"\"\n }\n },\n \"directoryId\": \"5737a03a-2e45-7a70-f245-0d484f2c3fb2\",\n \"schema\": \"containers\",\n \"groupId\": \"0002d836-98e4-f936-3b6e-f1ea67d86420\",\n \"schedule\": {\n \"enabled\": {\n \"value\": \"\"\n },\n \"endDate\": {\n \"value\": \"\"\n },\n \"endType\": {\n \"value\": \"\"\n },\n \"parts\": {\n \"value\": \"\"\n },\n \"periodType\": {\n \"value\": \"\"\n },\n \"startDate\": {\n \"value\": \"\"\n },\n \"startType\": {\n \"value\": \"\"\n },\n \"timezone\": {\n \"value\": \"\"\n }\n }\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"8d678038-3588-4b8b-98fe-fa56383724f4","name":"Document created","originalRequest":{"url":{"path":["schema-service","v2","documents","create"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"name\": \"string\",\n \"priority\": 87,\n \"content\": {\n \"value\": \"\"\n },\n \"slug\": \"basket\",\n \"audience\": {\n \"targetType\": {\n \"value\": \"\"\n },\n \"segments\": {\n \"value\": \"\"\n },\n \"query\": {\n \"value\": \"\"\n }\n },\n \"directoryId\": \"5737a03a-2e45-7a70-f245-0d484f2c3fb2\",\n \"schema\": \"containers\",\n \"groupId\": \"0002d836-98e4-f936-3b6e-f1ea67d86420\",\n \"schedule\": {\n \"enabled\": {\n \"value\": \"\"\n },\n \"endDate\": {\n \"value\": \"\"\n },\n \"endType\": {\n \"value\": \"\"\n },\n \"parts\": {\n \"value\": \"\"\n },\n \"periodType\": {\n \"value\": \"\"\n },\n \"startDate\": {\n \"value\": \"\"\n },\n \"startType\": {\n \"value\": \"\"\n },\n \"timezone\": {\n \"value\": \"\"\n }\n }\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"id\": \"959d4e04-1728-c2af-733d-bc9f8711baa6\",\n \"name\": \"string\",\n \"priority\": 63,\n \"status\": \"ACTIVE\",\n \"scheduled\": true,\n \"createdAt\": \"1969-07-28T08:17:04.658Z\",\n \"updatedAt\": \"1986-11-11T11:52:39.622Z\",\n \"author\": {\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"avatar\": {\n \"value\": \"\"\n }\n },\n \"content\": {\n \"value\": \"\"\n },\n \"audience\": {\n \"targetType\": {\n \"value\": \"\"\n },\n \"segments\": {\n \"value\": \"\"\n },\n \"query\": {\n \"value\": \"\"\n }\n },\n \"slug\": \"basket\",\n \"schema\": \"containers\",\n \"directory\": {\n \"value\": \"\"\n },\n \"group\": {\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"createdAt\": {\n \"value\": \"\"\n },\n \"deletedAt\": {\n \"value\": \"\"\n },\n \"nr\": {\n \"value\": \"\"\n }\n },\n \"deletedAt\": \"1968-02-20T12:05:01.801Z\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"5617f1d5-3d09-4bd7-a803-bc7ed34fe01a","name":"See error message for details","originalRequest":{"url":{"path":["schema-service","v2","documents","create"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"name\": \"string\",\n \"priority\": 87,\n \"content\": {\n \"value\": \"\"\n },\n \"slug\": \"basket\",\n \"audience\": {\n \"targetType\": {\n \"value\": \"\"\n },\n \"segments\": {\n \"value\": \"\"\n },\n \"query\": {\n \"value\": \"\"\n }\n },\n \"directoryId\": \"5737a03a-2e45-7a70-f245-0d484f2c3fb2\",\n \"schema\": \"containers\",\n \"groupId\": \"0002d836-98e4-f936-3b6e-f1ea67d86420\",\n \"schedule\": {\n \"enabled\": {\n \"value\": \"\"\n },\n \"endDate\": {\n \"value\": \"\"\n },\n \"endType\": {\n \"value\": \"\"\n },\n \"parts\": {\n \"value\": \"\"\n },\n \"periodType\": {\n \"value\": \"\"\n },\n \"startDate\": {\n \"value\": \"\"\n },\n \"startType\": {\n \"value\": \"\"\n },\n \"timezone\": {\n \"value\": \"\"\n }\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"59fe5ffe-c0f5-4c52-9816-952e600966aa","name":"Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc.","originalRequest":{"url":{"path":["schema-service","v2","documents","create"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"name\": \"string\",\n \"priority\": 87,\n \"content\": {\n \"value\": \"\"\n },\n \"slug\": \"basket\",\n \"audience\": {\n \"targetType\": {\n \"value\": \"\"\n },\n \"segments\": {\n \"value\": \"\"\n },\n \"query\": {\n \"value\": \"\"\n }\n },\n \"directoryId\": \"5737a03a-2e45-7a70-f245-0d484f2c3fb2\",\n \"schema\": \"containers\",\n \"groupId\": \"0002d836-98e4-f936-3b6e-f1ea67d86420\",\n \"schedule\": {\n \"enabled\": {\n \"value\": \"\"\n },\n \"endDate\": {\n \"value\": \"\"\n },\n \"endType\": {\n \"value\": \"\"\n },\n \"parts\": {\n \"value\": \"\"\n },\n \"periodType\": {\n \"value\": \"\"\n },\n \"startDate\": {\n \"value\": \"\"\n },\n \"startType\": {\n \"value\": \"\"\n },\n \"timezone\": {\n \"value\": \"\"\n }\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"string\",\n \"error\": \"string\",\n \"message\": \"string\",\n \"status\": 6404\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"641fa59f-e180-48d9-9321-46316f3f0b30","name":"Forbidden; insufficient permissions","originalRequest":{"url":{"path":["schema-service","v2","documents","create"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"name\": \"string\",\n \"priority\": 87,\n \"content\": {\n \"value\": \"\"\n },\n \"slug\": \"basket\",\n \"audience\": {\n \"targetType\": {\n \"value\": \"\"\n },\n \"segments\": {\n \"value\": \"\"\n },\n \"query\": {\n \"value\": \"\"\n }\n },\n \"directoryId\": \"5737a03a-2e45-7a70-f245-0d484f2c3fb2\",\n \"schema\": \"containers\",\n \"groupId\": \"0002d836-98e4-f936-3b6e-f1ea67d86420\",\n \"schedule\": {\n \"enabled\": {\n \"value\": \"\"\n },\n \"endDate\": {\n \"value\": \"\"\n },\n \"endType\": {\n \"value\": \"\"\n },\n \"parts\": {\n \"value\": \"\"\n },\n \"periodType\": {\n \"value\": \"\"\n },\n \"startDate\": {\n \"value\": \"\"\n },\n \"startType\": {\n \"value\": \"\"\n },\n \"timezone\": {\n \"value\": \"\"\n }\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"string\",\n \"error\": \"string\",\n \"message\": \"string\",\n \"status\": 6404\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"20cbbdc6-9445-41bc-a84e-c5ae4d8976da","name":"Resource not found","originalRequest":{"url":{"path":["schema-service","v2","documents","create"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"name\": \"string\",\n \"priority\": 87,\n \"content\": {\n \"value\": \"\"\n },\n \"slug\": \"basket\",\n \"audience\": {\n \"targetType\": {\n \"value\": \"\"\n },\n \"segments\": {\n \"value\": \"\"\n },\n \"query\": {\n \"value\": \"\"\n }\n },\n \"directoryId\": \"5737a03a-2e45-7a70-f245-0d484f2c3fb2\",\n \"schema\": \"containers\",\n \"groupId\": \"0002d836-98e4-f936-3b6e-f1ea67d86420\",\n \"schedule\": {\n \"enabled\": {\n \"value\": \"\"\n },\n \"endDate\": {\n \"value\": \"\"\n },\n \"endType\": {\n \"value\": \"\"\n },\n \"parts\": {\n \"value\": \"\"\n },\n \"periodType\": {\n \"value\": \"\"\n },\n \"startDate\": {\n \"value\": \"\"\n },\n \"startType\": {\n \"value\": \"\"\n },\n \"timezone\": {\n \"value\": \"\"\n }\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"fb967184-49d3-4041-a164-93a6ad89e3f2","name":"See error message for details","originalRequest":{"url":{"path":["schema-service","v2","documents","create"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"name\": \"string\",\n \"priority\": 87,\n \"content\": {\n \"value\": \"\"\n },\n \"slug\": \"basket\",\n \"audience\": {\n \"targetType\": {\n \"value\": \"\"\n },\n \"segments\": {\n \"value\": \"\"\n },\n \"query\": {\n \"value\": \"\"\n }\n },\n \"directoryId\": \"5737a03a-2e45-7a70-f245-0d484f2c3fb2\",\n \"schema\": \"containers\",\n \"groupId\": \"0002d836-98e4-f936-3b6e-f1ea67d86420\",\n \"schedule\": {\n \"enabled\": {\n \"value\": \"\"\n },\n \"endDate\": {\n \"value\": \"\"\n },\n \"endType\": {\n \"value\": \"\"\n },\n \"parts\": {\n \"value\": \"\"\n },\n \"periodType\": {\n \"value\": \"\"\n },\n \"startDate\": {\n \"value\": \"\"\n },\n \"startType\": {\n \"value\": \"\"\n },\n \"timezone\": {\n \"value\": \"\"\n }\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"dd03075b-9e0f-4926-9e14-45196cde8bb7","name":"Initialize document","request":{"name":"Initialize document","description":{"content":"Create a new document. It is created as a blank, without any conditions.\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User\n\n**API key permission required:** `SCHEMA_SERVICE_SCHEMA_CREATE`\n\n**User role permission required:** `assets_docs: create`\n","type":"text/plain"},"url":{"path":["schema-service","v2","documents","createNew"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"name\": \"string\",\n \"directory\": \"354acd68-b73d-498a-be94-37f681f607bb\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"9f9d3bcc-3dc1-4274-abc5-7b8e6544ac2d","name":"Document initialized","originalRequest":{"url":{"path":["schema-service","v2","documents","createNew"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"name\": \"string\",\n \"directory\": \"354acd68-b73d-498a-be94-37f681f607bb\"\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"docId\": \"1ef68633-4bae-cc8a-64eb-dc167eaed4b5\",\n \"name\": \"string\",\n \"status\": \"DRAFT\",\n \"scheduled\": true,\n \"authorId\": 7895,\n \"directoryId\": \"92767e45-4c8b-7f49-ad28-dfe066b9cac7\",\n \"createdAt\": \"2023-12-27T20:17:40.943Z\",\n \"updatedAt\": \"1990-02-18T09:16:38.422Z\",\n \"deletedAt\": \"1997-04-25T19:44:58.062Z\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"abe46b35-5b2f-47fa-91e2-335a4ba1e15d","name":"See error message for details","originalRequest":{"url":{"path":["schema-service","v2","documents","createNew"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"name\": \"string\",\n \"directory\": \"354acd68-b73d-498a-be94-37f681f607bb\"\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"198fa093-ce86-4c0c-b603-5e904f8b93e3","name":"Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc.","originalRequest":{"url":{"path":["schema-service","v2","documents","createNew"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"name\": \"string\",\n \"directory\": \"354acd68-b73d-498a-be94-37f681f607bb\"\n}","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"string\",\n \"error\": \"string\",\n \"message\": \"string\",\n \"status\": 6404\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"8e092553-e9d8-41d1-b0d6-f82cbaacf5b3","name":"Forbidden; insufficient permissions","originalRequest":{"url":{"path":["schema-service","v2","documents","createNew"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"name\": \"string\",\n \"directory\": \"354acd68-b73d-498a-be94-37f681f607bb\"\n}","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"string\",\n \"error\": \"string\",\n \"message\": \"string\",\n \"status\": 6404\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"c0ef580c-ded8-461f-baaa-9cf6ef2fc39f","name":"Resource not found","originalRequest":{"url":{"path":["schema-service","v2","documents","createNew"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"name\": \"string\",\n \"directory\": \"354acd68-b73d-498a-be94-37f681f607bb\"\n}","options":{"raw":{"language":"json"}}}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"e091b29c-757c-4748-b684-9cda2ceea127","name":"See error message for details","originalRequest":{"url":{"path":["schema-service","v2","documents","createNew"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"name\": \"string\",\n \"directory\": \"354acd68-b73d-498a-be94-37f681f607bb\"\n}","options":{"raw":{"language":"json"}}}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"66418109-18f5-4490-ae93-8f32bcb9319f","name":"Add audience to document","request":{"name":"Add audience to document","description":{"content":"Define the audience for a document.\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User\n\n**API key permission required:** `SCHEMA_SERVICE_SCHEMA_CREATE`\n\n**User role permission required:** `assets_docs: create`\n","type":"text/plain"},"url":{"path":["schema-service","v2","documents",":documentId","audience"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"documentId","description":"(Required) UUID of the document"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"targetType\": \"QUERY\",\n \"segments\": [\n \"string\",\n \"string\"\n ],\n \"query\": \"{\\\"analysis\\\":{\\\"title\\\":\\\"Unnamed segmentation\\\",\\\"description\\\":\\\"\\\",\\\"unique\\\":true,\\\"segments\\\":[{\\\"title\\\":\\\"Segmentation A\\\",\\\"description\\\":\\\"\\\",\\\"filter\\\":{\\\"matching\\\":true,\\\"expressions\\\":[{\\\"_id\\\":\\\"a9b76c8e-34bd-4ac3-be8f-f37041d126bd\\\",\\\"name\\\":\\\"\\\",\\\"type\\\":\\\"FUNNEL\\\",\\\"matching\\\":true,\\\"funnel\\\":{\\\"_id\\\":\\\"5c759d73-49c6-409f-96a3-b569dff8f8ff\\\",\\\"title\\\":\\\"Unnamed\\\",\\\"completedWithin\\\":null,\\\"dateFilter\\\":{\\\"type\\\":\\\"RELATIVE\\\",\\\"offset\\\":{\\\"type\\\":\\\"DAYS\\\",\\\"value\\\":0},\\\"duration\\\":{\\\"type\\\":\\\"DAYS\\\",\\\"value\\\":30}},\\\"steps\\\":[{\\\"_id\\\":\\\"78b97ae0-1bc5-45fb-82a4-4f1280cfbdff\\\",\\\"title\\\":\\\"\\\",\\\"action\\\":{\\\"id\\\":944,\\\"name\\\":\\\"page.visit\\\"},\\\"eventName\\\":\\\"page.visit\\\",\\\"expressions\\\":[]}],\\\"exact\\\":false}}]}}]}}\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"d8a5edf6-d54a-423a-960b-c9673580a701","name":"Audience defined","originalRequest":{"url":{"path":["schema-service","v2","documents",":documentId","audience"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"documentId","description":"(Required) UUID of the document"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"targetType\": \"SEGMENT\",\n \"segments\": [\n \"string\",\n \"string\"\n ],\n \"query\": \"{\\\"analysis\\\":{\\\"title\\\":\\\"Unnamed segmentation\\\",\\\"description\\\":\\\"\\\",\\\"unique\\\":true,\\\"segments\\\":[{\\\"title\\\":\\\"Segmentation A\\\",\\\"description\\\":\\\"\\\",\\\"filter\\\":{\\\"matching\\\":true,\\\"expressions\\\":[{\\\"_id\\\":\\\"a9b76c8e-34bd-4ac3-be8f-f37041d126bd\\\",\\\"name\\\":\\\"\\\",\\\"type\\\":\\\"FUNNEL\\\",\\\"matching\\\":true,\\\"funnel\\\":{\\\"_id\\\":\\\"5c759d73-49c6-409f-96a3-b569dff8f8ff\\\",\\\"title\\\":\\\"Unnamed\\\",\\\"completedWithin\\\":null,\\\"dateFilter\\\":{\\\"type\\\":\\\"RELATIVE\\\",\\\"offset\\\":{\\\"type\\\":\\\"DAYS\\\",\\\"value\\\":0},\\\"duration\\\":{\\\"type\\\":\\\"DAYS\\\",\\\"value\\\":30}},\\\"steps\\\":[{\\\"_id\\\":\\\"78b97ae0-1bc5-45fb-82a4-4f1280cfbdff\\\",\\\"title\\\":\\\"\\\",\\\"action\\\":{\\\"id\\\":944,\\\"name\\\":\\\"page.visit\\\"},\\\"eventName\\\":\\\"page.visit\\\",\\\"expressions\\\":[]}],\\\"exact\\\":false}}]}}]}}\"\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"status\": \"string\",\n \"body\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"781269aa-e09e-4d0a-97f3-1a19bfdde579","name":"See error message for details","originalRequest":{"url":{"path":["schema-service","v2","documents",":documentId","audience"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"documentId","description":"(Required) UUID of the document"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"targetType\": \"SEGMENT\",\n \"segments\": [\n \"string\",\n \"string\"\n ],\n \"query\": \"{\\\"analysis\\\":{\\\"title\\\":\\\"Unnamed segmentation\\\",\\\"description\\\":\\\"\\\",\\\"unique\\\":true,\\\"segments\\\":[{\\\"title\\\":\\\"Segmentation A\\\",\\\"description\\\":\\\"\\\",\\\"filter\\\":{\\\"matching\\\":true,\\\"expressions\\\":[{\\\"_id\\\":\\\"a9b76c8e-34bd-4ac3-be8f-f37041d126bd\\\",\\\"name\\\":\\\"\\\",\\\"type\\\":\\\"FUNNEL\\\",\\\"matching\\\":true,\\\"funnel\\\":{\\\"_id\\\":\\\"5c759d73-49c6-409f-96a3-b569dff8f8ff\\\",\\\"title\\\":\\\"Unnamed\\\",\\\"completedWithin\\\":null,\\\"dateFilter\\\":{\\\"type\\\":\\\"RELATIVE\\\",\\\"offset\\\":{\\\"type\\\":\\\"DAYS\\\",\\\"value\\\":0},\\\"duration\\\":{\\\"type\\\":\\\"DAYS\\\",\\\"value\\\":30}},\\\"steps\\\":[{\\\"_id\\\":\\\"78b97ae0-1bc5-45fb-82a4-4f1280cfbdff\\\",\\\"title\\\":\\\"\\\",\\\"action\\\":{\\\"id\\\":944,\\\"name\\\":\\\"page.visit\\\"},\\\"eventName\\\":\\\"page.visit\\\",\\\"expressions\\\":[]}],\\\"exact\\\":false}}]}}]}}\"\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"a279bfea-cd75-4bc7-9f3a-474c09f1c3a7","name":"Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc.","originalRequest":{"url":{"path":["schema-service","v2","documents",":documentId","audience"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"documentId","description":"(Required) UUID of the document"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"targetType\": \"SEGMENT\",\n \"segments\": [\n \"string\",\n \"string\"\n ],\n \"query\": \"{\\\"analysis\\\":{\\\"title\\\":\\\"Unnamed segmentation\\\",\\\"description\\\":\\\"\\\",\\\"unique\\\":true,\\\"segments\\\":[{\\\"title\\\":\\\"Segmentation A\\\",\\\"description\\\":\\\"\\\",\\\"filter\\\":{\\\"matching\\\":true,\\\"expressions\\\":[{\\\"_id\\\":\\\"a9b76c8e-34bd-4ac3-be8f-f37041d126bd\\\",\\\"name\\\":\\\"\\\",\\\"type\\\":\\\"FUNNEL\\\",\\\"matching\\\":true,\\\"funnel\\\":{\\\"_id\\\":\\\"5c759d73-49c6-409f-96a3-b569dff8f8ff\\\",\\\"title\\\":\\\"Unnamed\\\",\\\"completedWithin\\\":null,\\\"dateFilter\\\":{\\\"type\\\":\\\"RELATIVE\\\",\\\"offset\\\":{\\\"type\\\":\\\"DAYS\\\",\\\"value\\\":0},\\\"duration\\\":{\\\"type\\\":\\\"DAYS\\\",\\\"value\\\":30}},\\\"steps\\\":[{\\\"_id\\\":\\\"78b97ae0-1bc5-45fb-82a4-4f1280cfbdff\\\",\\\"title\\\":\\\"\\\",\\\"action\\\":{\\\"id\\\":944,\\\"name\\\":\\\"page.visit\\\"},\\\"eventName\\\":\\\"page.visit\\\",\\\"expressions\\\":[]}],\\\"exact\\\":false}}]}}]}}\"\n}","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"string\",\n \"error\": \"string\",\n \"message\": \"string\",\n \"status\": 6404\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"34b3cf85-6471-4e38-b747-4acb2cda28c7","name":"Forbidden; insufficient permissions","originalRequest":{"url":{"path":["schema-service","v2","documents",":documentId","audience"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"documentId","description":"(Required) UUID of the document"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"targetType\": \"SEGMENT\",\n \"segments\": [\n \"string\",\n \"string\"\n ],\n \"query\": \"{\\\"analysis\\\":{\\\"title\\\":\\\"Unnamed segmentation\\\",\\\"description\\\":\\\"\\\",\\\"unique\\\":true,\\\"segments\\\":[{\\\"title\\\":\\\"Segmentation A\\\",\\\"description\\\":\\\"\\\",\\\"filter\\\":{\\\"matching\\\":true,\\\"expressions\\\":[{\\\"_id\\\":\\\"a9b76c8e-34bd-4ac3-be8f-f37041d126bd\\\",\\\"name\\\":\\\"\\\",\\\"type\\\":\\\"FUNNEL\\\",\\\"matching\\\":true,\\\"funnel\\\":{\\\"_id\\\":\\\"5c759d73-49c6-409f-96a3-b569dff8f8ff\\\",\\\"title\\\":\\\"Unnamed\\\",\\\"completedWithin\\\":null,\\\"dateFilter\\\":{\\\"type\\\":\\\"RELATIVE\\\",\\\"offset\\\":{\\\"type\\\":\\\"DAYS\\\",\\\"value\\\":0},\\\"duration\\\":{\\\"type\\\":\\\"DAYS\\\",\\\"value\\\":30}},\\\"steps\\\":[{\\\"_id\\\":\\\"78b97ae0-1bc5-45fb-82a4-4f1280cfbdff\\\",\\\"title\\\":\\\"\\\",\\\"action\\\":{\\\"id\\\":944,\\\"name\\\":\\\"page.visit\\\"},\\\"eventName\\\":\\\"page.visit\\\",\\\"expressions\\\":[]}],\\\"exact\\\":false}}]}}]}}\"\n}","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"string\",\n \"error\": \"string\",\n \"message\": \"string\",\n \"status\": 6404\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"79161518-d206-4ed7-bdce-e05e5518a2b9","name":"Resource not found","originalRequest":{"url":{"path":["schema-service","v2","documents",":documentId","audience"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"documentId","description":"(Required) UUID of the document"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"targetType\": \"SEGMENT\",\n \"segments\": [\n \"string\",\n \"string\"\n ],\n \"query\": \"{\\\"analysis\\\":{\\\"title\\\":\\\"Unnamed segmentation\\\",\\\"description\\\":\\\"\\\",\\\"unique\\\":true,\\\"segments\\\":[{\\\"title\\\":\\\"Segmentation A\\\",\\\"description\\\":\\\"\\\",\\\"filter\\\":{\\\"matching\\\":true,\\\"expressions\\\":[{\\\"_id\\\":\\\"a9b76c8e-34bd-4ac3-be8f-f37041d126bd\\\",\\\"name\\\":\\\"\\\",\\\"type\\\":\\\"FUNNEL\\\",\\\"matching\\\":true,\\\"funnel\\\":{\\\"_id\\\":\\\"5c759d73-49c6-409f-96a3-b569dff8f8ff\\\",\\\"title\\\":\\\"Unnamed\\\",\\\"completedWithin\\\":null,\\\"dateFilter\\\":{\\\"type\\\":\\\"RELATIVE\\\",\\\"offset\\\":{\\\"type\\\":\\\"DAYS\\\",\\\"value\\\":0},\\\"duration\\\":{\\\"type\\\":\\\"DAYS\\\",\\\"value\\\":30}},\\\"steps\\\":[{\\\"_id\\\":\\\"78b97ae0-1bc5-45fb-82a4-4f1280cfbdff\\\",\\\"title\\\":\\\"\\\",\\\"action\\\":{\\\"id\\\":944,\\\"name\\\":\\\"page.visit\\\"},\\\"eventName\\\":\\\"page.visit\\\",\\\"expressions\\\":[]}],\\\"exact\\\":false}}]}}]}}\"\n}","options":{"raw":{"language":"json"}}}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"c4c04abb-848c-41c5-bbf4-5dda27fe6f98","name":"See error message for details","originalRequest":{"url":{"path":["schema-service","v2","documents",":documentId","audience"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"documentId","description":"(Required) UUID of the document"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"targetType\": \"SEGMENT\",\n \"segments\": [\n \"string\",\n \"string\"\n ],\n \"query\": \"{\\\"analysis\\\":{\\\"title\\\":\\\"Unnamed segmentation\\\",\\\"description\\\":\\\"\\\",\\\"unique\\\":true,\\\"segments\\\":[{\\\"title\\\":\\\"Segmentation A\\\",\\\"description\\\":\\\"\\\",\\\"filter\\\":{\\\"matching\\\":true,\\\"expressions\\\":[{\\\"_id\\\":\\\"a9b76c8e-34bd-4ac3-be8f-f37041d126bd\\\",\\\"name\\\":\\\"\\\",\\\"type\\\":\\\"FUNNEL\\\",\\\"matching\\\":true,\\\"funnel\\\":{\\\"_id\\\":\\\"5c759d73-49c6-409f-96a3-b569dff8f8ff\\\",\\\"title\\\":\\\"Unnamed\\\",\\\"completedWithin\\\":null,\\\"dateFilter\\\":{\\\"type\\\":\\\"RELATIVE\\\",\\\"offset\\\":{\\\"type\\\":\\\"DAYS\\\",\\\"value\\\":0},\\\"duration\\\":{\\\"type\\\":\\\"DAYS\\\",\\\"value\\\":30}},\\\"steps\\\":[{\\\"_id\\\":\\\"78b97ae0-1bc5-45fb-82a4-4f1280cfbdff\\\",\\\"title\\\":\\\"\\\",\\\"action\\\":{\\\"id\\\":944,\\\"name\\\":\\\"page.visit\\\"},\\\"eventName\\\":\\\"page.visit\\\",\\\"expressions\\\":[]}],\\\"exact\\\":false}}]}}]}}\"\n}","options":{"raw":{"language":"json"}}}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"039b74a2-510a-43a9-be72-ee7ad279ad28","name":"Add content to document","request":{"name":"Add content to document","description":{"content":"Add content and configuration (priority, schema, and so on) to a document.\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User\n\n**API key permission required:** `SCHEMA_SERVICE_SCHEMA_CREATE`\n\n**User role permission required:** `assets_docs: create`\n","type":"text/plain"},"url":{"path":["schema-service","v2","documents",":documentId","content"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"documentId","description":"(Required) UUID of the document"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"priority\": 74,\n \"content\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n }\n },\n \"slug\": \"basket\",\n \"schema\": \"containers\",\n \"groupId\": \"43c97b25-4a10-45d0-99b7-d472eea2bb24\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"bed891ed-e95c-4be1-a307-1c08df8777c9","name":"Content added","originalRequest":{"url":{"path":["schema-service","v2","documents",":documentId","content"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"documentId","description":"(Required) UUID of the document"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"priority\": 74,\n \"content\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n }\n },\n \"slug\": \"basket\",\n \"schema\": \"containers\",\n \"groupId\": \"43c97b25-4a10-45d0-99b7-d472eea2bb24\"\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"status\": \"string\",\n \"body\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"3a035094-8a0a-486f-a33f-d11260fe4aec","name":"See error message for details","originalRequest":{"url":{"path":["schema-service","v2","documents",":documentId","content"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"documentId","description":"(Required) UUID of the document"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"priority\": 74,\n \"content\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n }\n },\n \"slug\": \"basket\",\n \"schema\": \"containers\",\n \"groupId\": \"43c97b25-4a10-45d0-99b7-d472eea2bb24\"\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"5150fe02-cb3a-42b8-8a57-a0cc2838bbeb","name":"Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc.","originalRequest":{"url":{"path":["schema-service","v2","documents",":documentId","content"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"documentId","description":"(Required) UUID of the document"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"priority\": 74,\n \"content\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n }\n },\n \"slug\": \"basket\",\n \"schema\": \"containers\",\n \"groupId\": \"43c97b25-4a10-45d0-99b7-d472eea2bb24\"\n}","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"string\",\n \"error\": \"string\",\n \"message\": \"string\",\n \"status\": 6404\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"9d4597d6-7b99-49f9-bfed-b121d6c9c0a1","name":"Forbidden; insufficient permissions","originalRequest":{"url":{"path":["schema-service","v2","documents",":documentId","content"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"documentId","description":"(Required) UUID of the document"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"priority\": 74,\n \"content\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n }\n },\n \"slug\": \"basket\",\n \"schema\": \"containers\",\n \"groupId\": \"43c97b25-4a10-45d0-99b7-d472eea2bb24\"\n}","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"string\",\n \"error\": \"string\",\n \"message\": \"string\",\n \"status\": 6404\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"7d650b98-6a54-4768-809f-66adf52d0713","name":"Resource not found","originalRequest":{"url":{"path":["schema-service","v2","documents",":documentId","content"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"documentId","description":"(Required) UUID of the document"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"priority\": 74,\n \"content\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n }\n },\n \"slug\": \"basket\",\n \"schema\": \"containers\",\n \"groupId\": \"43c97b25-4a10-45d0-99b7-d472eea2bb24\"\n}","options":{"raw":{"language":"json"}}}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"d03264e4-c170-4d06-a829-1a37d04c222e","name":"See error message for details","originalRequest":{"url":{"path":["schema-service","v2","documents",":documentId","content"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"documentId","description":"(Required) UUID of the document"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"priority\": 74,\n \"content\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n }\n },\n \"slug\": \"basket\",\n \"schema\": \"containers\",\n \"groupId\": \"43c97b25-4a10-45d0-99b7-d472eea2bb24\"\n}","options":{"raw":{"language":"json"}}}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"a7ae7841-c61e-4f0e-934b-626e3e7a5e21","name":"Rename document","request":{"name":"Rename document","description":{"content":"Rename a document.\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User\n\n**API key permission required:** `SCHEMA_SERVICE_SCHEMA_CREATE`\n\n**User role permission required:** `assets_docs: create`\n","type":"text/plain"},"url":{"path":["schema-service","v2","documents",":documentId","name"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"documentId","description":"(Required) UUID of the document"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PUT","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"string","options":{"raw":{"language":"json"}}}},"response":[{"id":"238c99d7-a961-4181-8c60-5fdaf41c89f6","name":"Document renamed","originalRequest":{"url":{"path":["schema-service","v2","documents",":documentId","name"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"documentId","description":"(Required) UUID of the document"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"string","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"status\": \"string\",\n \"body\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"569ce6dc-176b-47e7-bd9c-823ac4e36c87","name":"See error message for details","originalRequest":{"url":{"path":["schema-service","v2","documents",":documentId","name"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"documentId","description":"(Required) UUID of the document"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"string","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"8aac43d3-c37f-4773-b68f-0a44ec54b72c","name":"Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc.","originalRequest":{"url":{"path":["schema-service","v2","documents",":documentId","name"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"documentId","description":"(Required) UUID of the document"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"string","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"string\",\n \"error\": \"string\",\n \"message\": \"string\",\n \"status\": 6404\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"a2a417e5-1e5d-4cce-aea7-18ca4556ba93","name":"Forbidden; insufficient permissions","originalRequest":{"url":{"path":["schema-service","v2","documents",":documentId","name"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"documentId","description":"(Required) UUID of the document"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"string","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"string\",\n \"error\": \"string\",\n \"message\": \"string\",\n \"status\": 6404\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"297fafa2-b3e8-45ed-ab2c-59f18b485b65","name":"Resource not found","originalRequest":{"url":{"path":["schema-service","v2","documents",":documentId","name"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"documentId","description":"(Required) UUID of the document"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"string","options":{"raw":{"language":"json"}}}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"69b6d2c5-d8d9-4f1a-a031-e4864dd9fb46","name":"See error message for details","originalRequest":{"url":{"path":["schema-service","v2","documents",":documentId","name"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"documentId","description":"(Required) UUID of the document"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"string","options":{"raw":{"language":"json"}}}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"d29a8292-5f4a-4086-9d78-3bc103fa232f","name":"Update priority in document","request":{"name":"Update priority in document","description":{"content":"Update priority in a document.\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User\n\n**API key permission required:** `SCHEMA_SERVICE_SCHEMA_CREATE`\n\n**User role permission required:** `assets_docs: create`\n","type":"text/plain"},"url":{"path":["schema-service","v2","documents",":documentId","priority"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"documentId","description":"(Required) UUID of the document"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PUT","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"5612","options":{"raw":{"language":"json"}}}},"response":[{"id":"4922e63a-3611-4c42-b18c-a105c4a96113","name":"Priority changed","originalRequest":{"url":{"path":["schema-service","v2","documents",":documentId","priority"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"documentId","description":"(Required) UUID of the document"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"5612","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"status\": \"string\",\n \"body\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"e44751d9-faac-48ab-aa1d-bdb6febe60e4","name":"See error message for details","originalRequest":{"url":{"path":["schema-service","v2","documents",":documentId","priority"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"documentId","description":"(Required) UUID of the document"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"5612","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"989d56ae-055d-4319-b72b-3298bb8f5a1a","name":"Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc.","originalRequest":{"url":{"path":["schema-service","v2","documents",":documentId","priority"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"documentId","description":"(Required) UUID of the document"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"5612","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"string\",\n \"error\": \"string\",\n \"message\": \"string\",\n \"status\": 6404\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"ca3543c6-9d94-4c4e-bc60-8f297b28f37f","name":"Forbidden; insufficient permissions","originalRequest":{"url":{"path":["schema-service","v2","documents",":documentId","priority"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"documentId","description":"(Required) UUID of the document"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"5612","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"string\",\n \"error\": \"string\",\n \"message\": \"string\",\n \"status\": 6404\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"e71c6e43-dbcb-4853-8da2-43da26436d3a","name":"Resource not found","originalRequest":{"url":{"path":["schema-service","v2","documents",":documentId","priority"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"documentId","description":"(Required) UUID of the document"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"5612","options":{"raw":{"language":"json"}}}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"f13676f6-aab5-49e5-ace3-e21335875181","name":"See error message for details","originalRequest":{"url":{"path":["schema-service","v2","documents",":documentId","priority"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"documentId","description":"(Required) UUID of the document"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"5612","options":{"raw":{"language":"json"}}}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"7da27207-bc95-4687-879b-dfa9d3e5ce4b","name":"Preview document content for a profile","request":{"name":"Preview document content for a profile","description":{"content":"Preview document content in context of a profile. Inserts are processed. If an insert can't be processed, the returned `content` is empty.\n\nThis method should not be used in production implementations, its purpose is to test the content. Use the \"generate document\" endpoints for implementation.\n\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User\n\n**API key permission required:** `SCHEMA_SERVICE_SCHEMA_READ`\n\n**User role permission required:** `assets_docs: read`\n","type":"text/plain"},"url":{"path":["schema-service","v2","documents","preview","by",":identifierType"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"uuid","key":"identifierType","description":"(Required) Type of the profile identifier. The value is sent in `identifierValue` in the request body."}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"identifierValue\": \"string\",\n \"content\": {\n \"value\": \"\"\n },\n \"params\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n },\n \"key_2\": {\n \"value\": \"\"\n }\n }\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"b87f31ef-b6ee-4854-8439-40671ed3c58a","name":"Processed document","originalRequest":{"url":{"path":["schema-service","v2","documents","preview","by",":identifierType"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"uuid","key":"identifierType","description":"(Required) Type of the profile identifier. The value is sent in `identifierValue` in the request body."}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"identifierValue\": \"string\",\n \"content\": {\n \"value\": \"\"\n },\n \"params\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n },\n \"key_2\": {\n \"value\": \"\"\n }\n }\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"key_0\": {},\n \"key_1\": {}\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"9e04ca81-89e6-4a26-a761-8cfff3413cc3","name":"See error message for details","originalRequest":{"url":{"path":["schema-service","v2","documents","preview","by",":identifierType"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"uuid","key":"identifierType","description":"(Required) Type of the profile identifier. The value is sent in `identifierValue` in the request body."}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"identifierValue\": \"string\",\n \"content\": {\n \"value\": \"\"\n },\n \"params\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n },\n \"key_2\": {\n \"value\": \"\"\n }\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"62c1b76b-2f4e-4187-9f93-c0341de7e20c","name":"Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc.","originalRequest":{"url":{"path":["schema-service","v2","documents","preview","by",":identifierType"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"uuid","key":"identifierType","description":"(Required) Type of the profile identifier. The value is sent in `identifierValue` in the request body."}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"identifierValue\": \"string\",\n \"content\": {\n \"value\": \"\"\n },\n \"params\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n },\n \"key_2\": {\n \"value\": \"\"\n }\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"string\",\n \"error\": \"string\",\n \"message\": \"string\",\n \"status\": 6404\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"cbde4e2d-f365-41f4-b2bd-a861008abe9f","name":"Forbidden; insufficient permissions","originalRequest":{"url":{"path":["schema-service","v2","documents","preview","by",":identifierType"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"uuid","key":"identifierType","description":"(Required) Type of the profile identifier. The value is sent in `identifierValue` in the request body."}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"identifierValue\": \"string\",\n \"content\": {\n \"value\": \"\"\n },\n \"params\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n },\n \"key_2\": {\n \"value\": \"\"\n }\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"string\",\n \"error\": \"string\",\n \"message\": \"string\",\n \"status\": 6404\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"fb63922b-ba40-44ce-a4fd-cb63979bd105","name":"Resource not found","originalRequest":{"url":{"path":["schema-service","v2","documents","preview","by",":identifierType"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"uuid","key":"identifierType","description":"(Required) Type of the profile identifier. The value is sent in `identifierValue` in the request body."}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"identifierValue\": \"string\",\n \"content\": {\n \"value\": \"\"\n },\n \"params\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n },\n \"key_2\": {\n \"value\": \"\"\n }\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"0d36c3cf-903d-4c44-a8fb-d0414b47b61f","name":"See error message for details","originalRequest":{"url":{"path":["schema-service","v2","documents","preview","by",":identifierType"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"uuid","key":"identifierType","description":"(Required) Type of the profile identifier. The value is sent in `identifierValue` in the request body."}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"identifierValue\": \"string\",\n \"content\": {\n \"value\": \"\"\n },\n \"params\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n },\n \"key_2\": {\n \"value\": \"\"\n }\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"d2f53759-8f4d-4870-bfbb-3461c9dc5515","name":"Generate document for a profile","request":{"name":"Generate document for a profile","description":{"content":"Generate a document in context of a profile. Inserts are processed. If an insert can't be processed, the returned `content` is empty.\n\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User\n\n**API key permission required:** `SCHEMA_SERVICE_SCHEMA_READ`\n\n**User role permission required:** `assets_docs: read`\n","type":"text/plain"},"url":{"path":["schema-service","v2","documents",":documentIdentifier","generate","by",":identifierType"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"documentIdentifier","description":"(Required) UUID or slug of the document"},{"disabled":false,"type":"any","value":"uuid","key":"identifierType","description":"(Required) Type of the profile identifier. The value is sent in `identifierValue` in the request body."}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"identifierValue\": \"string\",\n \"params\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n }\n }\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"232f18a3-15bf-4e51-8641-8acfa5a22d02","name":"Processed document","originalRequest":{"url":{"path":["schema-service","v2","documents",":documentIdentifier","generate","by",":identifierType"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"documentIdentifier","description":"(Required) UUID or slug of the document"},{"disabled":false,"type":"any","value":"uuid","key":"identifierType","description":"(Required) Type of the profile identifier. The value is sent in `identifierValue` in the request body."}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"identifierValue\": \"string\",\n \"params\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n }\n }\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"key_0\": {},\n \"key_1\": {}\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"8ee935f1-7d53-4398-b96f-51bff3b70040","name":"See error message for details","originalRequest":{"url":{"path":["schema-service","v2","documents",":documentIdentifier","generate","by",":identifierType"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"documentIdentifier","description":"(Required) UUID or slug of the document"},{"disabled":false,"type":"any","value":"uuid","key":"identifierType","description":"(Required) Type of the profile identifier. The value is sent in `identifierValue` in the request body."}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"identifierValue\": \"string\",\n \"params\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n }\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"ba283530-f1b5-4fed-95bd-049b6094ddcd","name":"Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc.","originalRequest":{"url":{"path":["schema-service","v2","documents",":documentIdentifier","generate","by",":identifierType"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"documentIdentifier","description":"(Required) UUID or slug of the document"},{"disabled":false,"type":"any","value":"uuid","key":"identifierType","description":"(Required) Type of the profile identifier. The value is sent in `identifierValue` in the request body."}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"identifierValue\": \"string\",\n \"params\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n }\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"string\",\n \"error\": \"string\",\n \"message\": \"string\",\n \"status\": 6404\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"21c2ea07-b505-4446-b35a-26c07150ba3e","name":"Forbidden; insufficient permissions","originalRequest":{"url":{"path":["schema-service","v2","documents",":documentIdentifier","generate","by",":identifierType"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"documentIdentifier","description":"(Required) UUID or slug of the document"},{"disabled":false,"type":"any","value":"uuid","key":"identifierType","description":"(Required) Type of the profile identifier. The value is sent in `identifierValue` in the request body."}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"identifierValue\": \"string\",\n \"params\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n }\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"string\",\n \"error\": \"string\",\n \"message\": \"string\",\n \"status\": 6404\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"7abaaf10-5854-4c14-8f36-3acb67c75e07","name":"Resource not found","originalRequest":{"url":{"path":["schema-service","v2","documents",":documentIdentifier","generate","by",":identifierType"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"documentIdentifier","description":"(Required) UUID or slug of the document"},{"disabled":false,"type":"any","value":"uuid","key":"identifierType","description":"(Required) Type of the profile identifier. The value is sent in `identifierValue` in the request body."}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"identifierValue\": \"string\",\n \"params\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n }\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"6b787ae1-c1a7-438a-82eb-f456309006df","name":"See error message for details","originalRequest":{"url":{"path":["schema-service","v2","documents",":documentIdentifier","generate","by",":identifierType"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"documentIdentifier","description":"(Required) UUID or slug of the document"},{"disabled":false,"type":"any","value":"uuid","key":"identifierType","description":"(Required) Type of the profile identifier. The value is sent in `identifierValue` in the request body."}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"identifierValue\": \"string\",\n \"params\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n }\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"d787c51c-d0e1-442b-8d1e-6cea862e8104","name":"List grouped documents","request":{"name":"List grouped documents","description":{"content":"Retrieve a group or groups of documents with information about the documents in those groups and relations between them. The response is an array of arrays (groups) of objects (documents).\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User\n\n**API key permission required:** `SCHEMA_SERVICE_SCHEMA_READ`\n\n**User role permission required:** `assets_docs: read`\n","type":"text/plain"},"url":{"path":["schema-service","v2","documents","preview","grouped-by","groups","list"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"[\n \"c5a77c3e-35a7-2474-ec33-b0a8fda36f75\",\n \"aa49d0f4-a8c2-914e-2b89-cd6ff573ba82\"\n]","options":{"raw":{"language":"json"}}}},"response":[{"id":"d76ae8b4-16fa-4f19-879f-a60282f7cd84","name":"List of document groups","originalRequest":{"url":{"path":["schema-service","v2","documents","preview","grouped-by","groups","list"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"[\n \"d8beefcc-bc2a-de16-503e-b2c66cdebe90\",\n \"b7daac5e-d01d-8a3e-8e86-d5f2a97b8c5c\"\n]","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"[\n {\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"children\": {\n \"value\": \"\"\n }\n },\n {\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"children\": {\n \"value\": \"\"\n }\n }\n]","cookie":[],"_postman_previewlanguage":"json"},{"id":"5e12d32f-8b2e-43fb-9851-ea4de130b96d","name":"See error message for details","originalRequest":{"url":{"path":["schema-service","v2","documents","preview","grouped-by","groups","list"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"[\n \"d8beefcc-bc2a-de16-503e-b2c66cdebe90\",\n \"b7daac5e-d01d-8a3e-8e86-d5f2a97b8c5c\"\n]","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"aca832f5-b120-42f7-a38d-8d0b1c01f718","name":"Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc.","originalRequest":{"url":{"path":["schema-service","v2","documents","preview","grouped-by","groups","list"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"[\n \"d8beefcc-bc2a-de16-503e-b2c66cdebe90\",\n \"b7daac5e-d01d-8a3e-8e86-d5f2a97b8c5c\"\n]","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"string\",\n \"error\": \"string\",\n \"message\": \"string\",\n \"status\": 6404\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"3cf3eca5-4818-4050-aa9c-a9a4f4262a96","name":"Forbidden; insufficient permissions","originalRequest":{"url":{"path":["schema-service","v2","documents","preview","grouped-by","groups","list"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"[\n \"d8beefcc-bc2a-de16-503e-b2c66cdebe90\",\n \"b7daac5e-d01d-8a3e-8e86-d5f2a97b8c5c\"\n]","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"string\",\n \"error\": \"string\",\n \"message\": \"string\",\n \"status\": 6404\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"2b88e3d5-9099-4801-8ba8-7b9188163f7f","name":"Resource not found","originalRequest":{"url":{"path":["schema-service","v2","documents","preview","grouped-by","groups","list"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"[\n \"d8beefcc-bc2a-de16-503e-b2c66cdebe90\",\n \"b7daac5e-d01d-8a3e-8e86-d5f2a97b8c5c\"\n]","options":{"raw":{"language":"json"}}}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"30160fd4-f4e7-4cec-8f2d-89c1df903f7f","name":"See error message for details","originalRequest":{"url":{"path":["schema-service","v2","documents","preview","grouped-by","groups","list"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"[\n \"d8beefcc-bc2a-de16-503e-b2c66cdebe90\",\n \"b7daac5e-d01d-8a3e-8e86-d5f2a97b8c5c\"\n]","options":{"raw":{"language":"json"}}}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"c7a6951c-5b49-45b7-8ca8-8e24aa5b1c49","name":"List documents","request":{"name":"List documents","description":{"content":"Returns a paginated list of documents.\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User\n\n**API key permission required:** `SCHEMA_SERVICE_SCHEMA_READ`\n\n**User role permission required:** `assets_docs: read`\n","type":"text/plain"},"url":{"path":["schema-service","v2","documents"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"page","value":"1"},{"disabled":false,"key":"limit","value":"25","description":"Limit of items per page"},{"disabled":false,"key":"search","value":"string","description":"A string to search for in resource names"},{"disabled":false,"key":"directoryId","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","description":"UUID of the directory for filtering the results"},{"disabled":false,"key":"groupId","value":"57acee87-cd14-e424-a1a9-3bda1ecf2710","description":"UUID of the document group for filtering the results"},{"disabled":false,"key":"status","value":"DRAFT"},{"disabled":false,"key":"schema","value":"string","description":"Name of the document schema (type) for filtering the results"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"da1b8c6f-bb5d-4f2a-80cb-c551a87eef59","name":"List of documents","originalRequest":{"url":{"path":["schema-service","v2","documents"],"host":["{{baseUrl}}"],"query":[{"key":"page","value":"1"},{"key":"limit","value":"25"},{"key":"search","value":"string"},{"key":"directoryId","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750"},{"key":"groupId","value":"57acee87-cd14-e424-a1a9-3bda1ecf2710"},{"key":"status","value":"DRAFT"},{"key":"schema","value":"string"}],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"meta\": {\n \"links\": {\n \"value\": \"\"\n },\n \"limit\": {\n \"value\": \"\"\n },\n \"count\": {\n \"value\": \"\"\n }\n },\n \"data\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"f463ea7c-3f8c-4ed9-a634-9f06184f390b","name":"See error message for details","originalRequest":{"url":{"path":["schema-service","v2","documents"],"host":["{{baseUrl}}"],"query":[{"key":"page","value":"1"},{"key":"limit","value":"25"},{"key":"search","value":"string"},{"key":"directoryId","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750"},{"key":"groupId","value":"57acee87-cd14-e424-a1a9-3bda1ecf2710"},{"key":"status","value":"DRAFT"},{"key":"schema","value":"string"}],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"98955467-cbd9-40f1-b2f5-7c732354beac","name":"Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc.","originalRequest":{"url":{"path":["schema-service","v2","documents"],"host":["{{baseUrl}}"],"query":[{"key":"page","value":"1"},{"key":"limit","value":"25"},{"key":"search","value":"string"},{"key":"directoryId","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750"},{"key":"groupId","value":"57acee87-cd14-e424-a1a9-3bda1ecf2710"},{"key":"status","value":"DRAFT"},{"key":"schema","value":"string"}],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"string\",\n \"error\": \"string\",\n \"message\": \"string\",\n \"status\": 6404\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"808c3f55-7998-4109-9c56-5be8d124c704","name":"Forbidden; insufficient permissions","originalRequest":{"url":{"path":["schema-service","v2","documents"],"host":["{{baseUrl}}"],"query":[{"key":"page","value":"1"},{"key":"limit","value":"25"},{"key":"search","value":"string"},{"key":"directoryId","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750"},{"key":"groupId","value":"57acee87-cd14-e424-a1a9-3bda1ecf2710"},{"key":"status","value":"DRAFT"},{"key":"schema","value":"string"}],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"string\",\n \"error\": \"string\",\n \"message\": \"string\",\n \"status\": 6404\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"5eca40dd-7ca6-40fe-b17c-8eadc8abad8c","name":"Resource not found","originalRequest":{"url":{"path":["schema-service","v2","documents"],"host":["{{baseUrl}}"],"query":[{"key":"page","value":"1"},{"key":"limit","value":"25"},{"key":"search","value":"string"},{"key":"directoryId","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750"},{"key":"groupId","value":"57acee87-cd14-e424-a1a9-3bda1ecf2710"},{"key":"status","value":"DRAFT"},{"key":"schema","value":"string"}],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"33235ead-52ba-4d56-bec4-04d3784c9e1a","name":"See error message for details","originalRequest":{"url":{"path":["schema-service","v2","documents"],"host":["{{baseUrl}}"],"query":[{"key":"page","value":"1"},{"key":"limit","value":"25"},{"key":"search","value":"string"},{"key":"directoryId","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750"},{"key":"groupId","value":"57acee87-cd14-e424-a1a9-3bda1ecf2710"},{"key":"status","value":"DRAFT"},{"key":"schema","value":"string"}],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"03354ccc-55e8-4265-9290-abe5b53409ad","name":"List documents from groups","request":{"name":"List documents from groups","description":{"content":"Retrieve a list of documents from a group or groups. The response includes information about relations between documents. The response is an array of objects (documents) without sorting them by group.\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User\n\n**API key permission required:** `SCHEMA_SERVICE_SCHEMA_READ`\n\n**User role permission required:** `assets_docs: read`\n","type":"text/plain"},"url":{"path":["schema-service","v2","documents","preview","list"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"[\n \"c5a77c3e-35a7-2474-ec33-b0a8fda36f75\",\n \"aa49d0f4-a8c2-914e-2b89-cd6ff573ba82\"\n]","options":{"raw":{"language":"json"}}}},"response":[{"id":"de38a29f-1a7f-4338-994e-ec83d3b584e3","name":"List of documents from the requested groups, without sorting into groups","originalRequest":{"url":{"path":["schema-service","v2","documents","preview","list"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"[\n \"d8beefcc-bc2a-de16-503e-b2c66cdebe90\",\n \"b7daac5e-d01d-8a3e-8e86-d5f2a97b8c5c\"\n]","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"[\n {\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"status\": {\n \"value\": \"\"\n },\n \"priority\": {\n \"value\": \"\"\n },\n \"children\": {\n \"value\": \"\"\n }\n },\n {\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"status\": {\n \"value\": \"\"\n },\n \"priority\": {\n \"value\": \"\"\n },\n \"children\": {\n \"value\": \"\"\n }\n }\n]","cookie":[],"_postman_previewlanguage":"json"},{"id":"3017d365-f8d6-4c57-a6ac-764cb1bba8f1","name":"See error message for details","originalRequest":{"url":{"path":["schema-service","v2","documents","preview","list"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"[\n \"d8beefcc-bc2a-de16-503e-b2c66cdebe90\",\n \"b7daac5e-d01d-8a3e-8e86-d5f2a97b8c5c\"\n]","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"4d9dab94-56f4-4d69-aee4-2d54190c9fda","name":"Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc.","originalRequest":{"url":{"path":["schema-service","v2","documents","preview","list"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"[\n \"d8beefcc-bc2a-de16-503e-b2c66cdebe90\",\n \"b7daac5e-d01d-8a3e-8e86-d5f2a97b8c5c\"\n]","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"string\",\n \"error\": \"string\",\n \"message\": \"string\",\n \"status\": 6404\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"be341196-ea5d-491b-bbe0-3fc6ff6ad1b7","name":"Forbidden; insufficient permissions","originalRequest":{"url":{"path":["schema-service","v2","documents","preview","list"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"[\n \"d8beefcc-bc2a-de16-503e-b2c66cdebe90\",\n \"b7daac5e-d01d-8a3e-8e86-d5f2a97b8c5c\"\n]","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"string\",\n \"error\": \"string\",\n \"message\": \"string\",\n \"status\": 6404\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"c144686b-ff1a-455c-9529-8cbe5ffe2ac6","name":"Resource not found","originalRequest":{"url":{"path":["schema-service","v2","documents","preview","list"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"[\n \"d8beefcc-bc2a-de16-503e-b2c66cdebe90\",\n \"b7daac5e-d01d-8a3e-8e86-d5f2a97b8c5c\"\n]","options":{"raw":{"language":"json"}}}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"1faaba44-9fde-4e87-a304-e8d72f2203a4","name":"See error message for details","originalRequest":{"url":{"path":["schema-service","v2","documents","preview","list"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"[\n \"d8beefcc-bc2a-de16-503e-b2c66cdebe90\",\n \"b7daac5e-d01d-8a3e-8e86-d5f2a97b8c5c\"\n]","options":{"raw":{"language":"json"}}}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"f6e80751-8de4-46af-85bd-5f9636a4f148","name":"Get document by slug","request":{"name":"Get document by slug","description":{"content":"Retrieve a document and its metadata. The content isn't processed.\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User\n\n**API key permission required:** `SCHEMA_SERVICE_SCHEMA_READ`\n\n**User role permission required:** `assets_docs: read`\n","type":"text/plain"},"url":{"path":["schema-service","v2","documents",":slug"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"cvtcb-kyq67m-i2-vca-1x-gr4vo","key":"slug","description":"(Required) Slug of the document"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"3dce15ee-b74f-4111-bfb2-15e1bd892225","name":"Details of the document (content isn't processed)","originalRequest":{"url":{"path":["schema-service","v2","documents",":slug"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"cvtcb-kyq67m-i2-vca-1x-gr4vo","key":"slug","description":"(Required) Slug of the document"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"id\": \"959d4e04-1728-c2af-733d-bc9f8711baa6\",\n \"name\": \"string\",\n \"priority\": 63,\n \"status\": \"ACTIVE\",\n \"scheduled\": true,\n \"createdAt\": \"1969-07-28T08:17:04.658Z\",\n \"updatedAt\": \"1986-11-11T11:52:39.622Z\",\n \"author\": {\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"avatar\": {\n \"value\": \"\"\n }\n },\n \"content\": {\n \"value\": \"\"\n },\n \"audience\": {\n \"targetType\": {\n \"value\": \"\"\n },\n \"segments\": {\n \"value\": \"\"\n },\n \"query\": {\n \"value\": \"\"\n }\n },\n \"slug\": \"basket\",\n \"schema\": \"containers\",\n \"directory\": {\n \"value\": \"\"\n },\n \"group\": {\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"createdAt\": {\n \"value\": \"\"\n },\n \"deletedAt\": {\n \"value\": \"\"\n },\n \"nr\": {\n \"value\": \"\"\n }\n },\n \"deletedAt\": \"1968-02-20T12:05:01.801Z\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"08499124-f03a-4851-90f7-7181e24d01a8","name":"See error message for details","originalRequest":{"url":{"path":["schema-service","v2","documents",":slug"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"cvtcb-kyq67m-i2-vca-1x-gr4vo","key":"slug","description":"(Required) Slug of the document"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"e0c97d4b-8eb4-4de2-956f-c4df07d3f6d6","name":"Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc.","originalRequest":{"url":{"path":["schema-service","v2","documents",":slug"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"cvtcb-kyq67m-i2-vca-1x-gr4vo","key":"slug","description":"(Required) Slug of the document"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"string\",\n \"error\": \"string\",\n \"message\": \"string\",\n \"status\": 6404\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"de1dc05b-caed-48a3-8f3e-94f750a02425","name":"Forbidden; insufficient permissions","originalRequest":{"url":{"path":["schema-service","v2","documents",":slug"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"cvtcb-kyq67m-i2-vca-1x-gr4vo","key":"slug","description":"(Required) Slug of the document"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"string\",\n \"error\": \"string\",\n \"message\": \"string\",\n \"status\": 6404\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"e341b51b-1f7c-4b00-913a-a069df431e2a","name":"Resource not found","originalRequest":{"url":{"path":["schema-service","v2","documents",":slug"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"cvtcb-kyq67m-i2-vca-1x-gr4vo","key":"slug","description":"(Required) Slug of the document"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"bd630277-113a-48e6-be5d-865f025f656a","name":"See error message for details","originalRequest":{"url":{"path":["schema-service","v2","documents",":slug"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"cvtcb-kyq67m-i2-vca-1x-gr4vo","key":"slug","description":"(Required) Slug of the document"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"2ec9f70a-659c-4626-96d3-5fda7b06f1ca","name":"Get predecessors for document","request":{"name":"Get predecessors for document","description":{"content":"Retrieve information about documents or screen views that refer **to** the requested document.\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User\n\n**API key permission required:** `SCHEMA_SERVICE_SCHEMA_READ`\n\n**User role permission required:** `assets_docs: read`\n","type":"text/plain"},"url":{"path":["schema-service","v2","documents","by","slug",":slug","predecessors"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"cvtcb-kyq67m-i2-vca-1x-gr4vo","key":"slug","description":"(Required) Slug of the document"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"3ac3e996-e000-4910-90ad-5b7f2736df5d","name":"Documents which refer to the requested document","originalRequest":{"url":{"path":["schema-service","v2","documents","by","slug",":slug","predecessors"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"cvtcb-kyq67m-i2-vca-1x-gr4vo","key":"slug","description":"(Required) Slug of the document"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"[\n {\n \"id\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"children\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n },\n {\n \"id\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"children\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n }\n]","cookie":[],"_postman_previewlanguage":"json"},{"id":"d22d3b55-44b3-41f8-bbf7-d50de2eae917","name":"See error message for details","originalRequest":{"url":{"path":["schema-service","v2","documents","by","slug",":slug","predecessors"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"cvtcb-kyq67m-i2-vca-1x-gr4vo","key":"slug","description":"(Required) Slug of the document"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"2713af7e-6504-461e-a8d7-365e1e60219f","name":"Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc.","originalRequest":{"url":{"path":["schema-service","v2","documents","by","slug",":slug","predecessors"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"cvtcb-kyq67m-i2-vca-1x-gr4vo","key":"slug","description":"(Required) Slug of the document"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"string\",\n \"error\": \"string\",\n \"message\": \"string\",\n \"status\": 6404\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"4361504c-f9c8-4e83-9155-aa3242a1cfdf","name":"Forbidden; insufficient permissions","originalRequest":{"url":{"path":["schema-service","v2","documents","by","slug",":slug","predecessors"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"cvtcb-kyq67m-i2-vca-1x-gr4vo","key":"slug","description":"(Required) Slug of the document"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"string\",\n \"error\": \"string\",\n \"message\": \"string\",\n \"status\": 6404\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"56429ef6-9df2-4cd0-b880-e0436790b51a","name":"Resource not found","originalRequest":{"url":{"path":["schema-service","v2","documents","by","slug",":slug","predecessors"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"cvtcb-kyq67m-i2-vca-1x-gr4vo","key":"slug","description":"(Required) Slug of the document"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"aaed6701-32d6-44be-b75d-af64f54af764","name":"See error message for details","originalRequest":{"url":{"path":["schema-service","v2","documents","by","slug",":slug","predecessors"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"cvtcb-kyq67m-i2-vca-1x-gr4vo","key":"slug","description":"(Required) Slug of the document"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"111dd043-0bc9-4ce1-ab11-f53082e1c6b2","name":"Get predecessors for document","request":{"name":"Get predecessors for document","description":{"content":"Retrieve information about documents or screen views that refer **to** the requested document.\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User\n\n**API key permission required:** `SCHEMA_SERVICE_SCHEMA_READ`\n\n**User role permission required:** `assets_docs: read`\n","type":"text/plain"},"url":{"path":["schema-service","v2","documents",":documentId","predecessors"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"documentId","description":"(Required) UUID of the document"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"234d2419-491a-48b1-bc16-019989187a2d","name":"Documents which refer to the requested document","originalRequest":{"url":{"path":["schema-service","v2","documents",":documentId","predecessors"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"documentId","description":"(Required) UUID of the document"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"[\n {\n \"id\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"children\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n },\n {\n \"id\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"children\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n }\n]","cookie":[],"_postman_previewlanguage":"json"},{"id":"3ab3f9d8-a7cc-432e-ba46-120b8657a58b","name":"See error message for details","originalRequest":{"url":{"path":["schema-service","v2","documents",":documentId","predecessors"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"documentId","description":"(Required) UUID of the document"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"a30167db-3a78-4e82-bd01-818be9cf3ce2","name":"Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc.","originalRequest":{"url":{"path":["schema-service","v2","documents",":documentId","predecessors"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"documentId","description":"(Required) UUID of the document"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"string\",\n \"error\": \"string\",\n \"message\": \"string\",\n \"status\": 6404\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"8d6e4a4b-92fe-4aa5-849e-7032b050c46b","name":"Forbidden; insufficient permissions","originalRequest":{"url":{"path":["schema-service","v2","documents",":documentId","predecessors"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"documentId","description":"(Required) UUID of the document"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"string\",\n \"error\": \"string\",\n \"message\": \"string\",\n \"status\": 6404\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"b8a4b7fc-9e96-445e-b4ec-b6ad27754e3f","name":"Resource not found","originalRequest":{"url":{"path":["schema-service","v2","documents",":documentId","predecessors"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"documentId","description":"(Required) UUID of the document"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"31ad2500-8448-45eb-b4c2-c45e23387b83","name":"See error message for details","originalRequest":{"url":{"path":["schema-service","v2","documents",":documentId","predecessors"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"documentId","description":"(Required) UUID of the document"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"a7622b49-aba5-4603-a4be-323de83e526a","name":"Get successors for document","request":{"name":"Get successors for document","description":{"content":"Retrieve information about documents referenced **from** the requested document.\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User\n\n**API key permission required:** `SCHEMA_SERVICE_SCHEMA_READ`\n\n**User role permission required:** `assets_docs: read`\n","type":"text/plain"},"url":{"path":["schema-service","v2","documents","by","slug",":slug","successors"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"cvtcb-kyq67m-i2-vca-1x-gr4vo","key":"slug","description":"(Required) Slug of the document"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"3e5a5e54-92e1-4b53-838a-5bda54cd9e07","name":"Documents referenced from the requested document","originalRequest":{"url":{"path":["schema-service","v2","documents","by","slug",":slug","successors"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"cvtcb-kyq67m-i2-vca-1x-gr4vo","key":"slug","description":"(Required) Slug of the document"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"[\n {\n \"id\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"children\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n },\n {\n \"id\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"children\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n }\n]","cookie":[],"_postman_previewlanguage":"json"},{"id":"f2654da5-c4d9-4330-9f17-be3c8881cab2","name":"See error message for details","originalRequest":{"url":{"path":["schema-service","v2","documents","by","slug",":slug","successors"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"cvtcb-kyq67m-i2-vca-1x-gr4vo","key":"slug","description":"(Required) Slug of the document"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"443999bb-14bd-4752-822b-2245dd682a2b","name":"Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc.","originalRequest":{"url":{"path":["schema-service","v2","documents","by","slug",":slug","successors"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"cvtcb-kyq67m-i2-vca-1x-gr4vo","key":"slug","description":"(Required) Slug of the document"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"string\",\n \"error\": \"string\",\n \"message\": \"string\",\n \"status\": 6404\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"7cb02db8-967f-4b1a-8ecd-d457fa152e79","name":"Forbidden; insufficient permissions","originalRequest":{"url":{"path":["schema-service","v2","documents","by","slug",":slug","successors"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"cvtcb-kyq67m-i2-vca-1x-gr4vo","key":"slug","description":"(Required) Slug of the document"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"string\",\n \"error\": \"string\",\n \"message\": \"string\",\n \"status\": 6404\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"4a989041-4848-42ed-8bac-e23b248c1295","name":"Resource not found","originalRequest":{"url":{"path":["schema-service","v2","documents","by","slug",":slug","successors"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"cvtcb-kyq67m-i2-vca-1x-gr4vo","key":"slug","description":"(Required) Slug of the document"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"0c3bfe88-fdce-4b5f-b004-7c934b5b2604","name":"See error message for details","originalRequest":{"url":{"path":["schema-service","v2","documents","by","slug",":slug","successors"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"cvtcb-kyq67m-i2-vca-1x-gr4vo","key":"slug","description":"(Required) Slug of the document"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"d49d2666-7114-465e-921f-ed45377ec879","name":"Get successors for document","request":{"name":"Get successors for document","description":{"content":"Retrieve information about documents referenced **from** the requested document.\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User\n\n**API key permission required:** `SCHEMA_SERVICE_SCHEMA_READ`\n\n**User role permission required:** `assets_docs: read`\n","type":"text/plain"},"url":{"path":["schema-service","v2","documents",":documentId","successors"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"documentId","description":"(Required) UUID of the document"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"e806d7e1-ab2a-432c-bc54-93ab87add757","name":"Documents referenced from the requested document","originalRequest":{"url":{"path":["schema-service","v2","documents",":documentId","successors"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"documentId","description":"(Required) UUID of the document"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"[\n {\n \"id\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"children\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n },\n {\n \"id\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"children\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n }\n]","cookie":[],"_postman_previewlanguage":"json"},{"id":"5ee1ffb2-8a24-40d2-8924-8a65e43cb7e0","name":"See error message for details","originalRequest":{"url":{"path":["schema-service","v2","documents",":documentId","successors"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"documentId","description":"(Required) UUID of the document"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"e69655f5-4e3f-472f-a492-9fa20d8bfb6f","name":"Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc.","originalRequest":{"url":{"path":["schema-service","v2","documents",":documentId","successors"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"documentId","description":"(Required) UUID of the document"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"string\",\n \"error\": \"string\",\n \"message\": \"string\",\n \"status\": 6404\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"653e5747-ce17-4d07-8429-418771b2ac91","name":"Forbidden; insufficient permissions","originalRequest":{"url":{"path":["schema-service","v2","documents",":documentId","successors"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"documentId","description":"(Required) UUID of the document"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"string\",\n \"error\": \"string\",\n \"message\": \"string\",\n \"status\": 6404\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"f476f0ba-52cb-45c0-99e2-c8418b37d512","name":"Resource not found","originalRequest":{"url":{"path":["schema-service","v2","documents",":documentId","successors"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"documentId","description":"(Required) UUID of the document"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"24db673c-d6b2-4407-9b76-e84792b012af","name":"See error message for details","originalRequest":{"url":{"path":["schema-service","v2","documents",":documentId","successors"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"documentId","description":"(Required) UUID of the document"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"f402b623-5ed8-4d1b-b711-748401f27324","name":"Update document","request":{"name":"Update document","description":{"content":"Update a document.\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User\n\n**API key permission required:** `SCHEMA_SERVICE_SCHEMA_CREATE`\n\n**User role permission required:** `assets_docs: create`\n","type":"text/plain"},"url":{"path":["schema-service","v2","documents",":documentId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"documentId","description":"(Required) UUID of the document"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"name\": \"string\",\n \"priority\": 41,\n \"content\": {\n \"value\": \"\"\n },\n \"schema\": \"containers\",\n \"groupId\": \"43c97b25-4a10-45d0-99b7-d472eea2bb24\",\n \"audience\": {\n \"targetType\": {\n \"value\": \"\"\n },\n \"segments\": {\n \"value\": \"\"\n },\n \"query\": {\n \"value\": \"\"\n }\n },\n \"schedule\": {\n \"enabled\": {\n \"value\": \"\"\n },\n \"endDate\": {\n \"value\": \"\"\n },\n \"endType\": {\n \"value\": \"\"\n },\n \"parts\": {\n \"value\": \"\"\n },\n \"periodType\": {\n \"value\": \"\"\n },\n \"startDate\": {\n \"value\": \"\"\n },\n \"startType\": {\n \"value\": \"\"\n },\n \"timezone\": {\n \"value\": \"\"\n }\n },\n \"directoryId\": \"43190800-5a8f-b293-7c79-cdfb41f6fd08\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"82c2ddf2-91b6-4a3d-b214-957f30753663","name":"Updated document","originalRequest":{"url":{"path":["schema-service","v2","documents",":documentId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"documentId","description":"(Required) UUID of the document"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"name\": \"string\",\n \"priority\": 41,\n \"content\": {\n \"value\": \"\"\n },\n \"schema\": \"containers\",\n \"groupId\": \"43c97b25-4a10-45d0-99b7-d472eea2bb24\",\n \"audience\": {\n \"targetType\": {\n \"value\": \"\"\n },\n \"segments\": {\n \"value\": \"\"\n },\n \"query\": {\n \"value\": \"\"\n }\n },\n \"schedule\": {\n \"enabled\": {\n \"value\": \"\"\n },\n \"endDate\": {\n \"value\": \"\"\n },\n \"endType\": {\n \"value\": \"\"\n },\n \"parts\": {\n \"value\": \"\"\n },\n \"periodType\": {\n \"value\": \"\"\n },\n \"startDate\": {\n \"value\": \"\"\n },\n \"startType\": {\n \"value\": \"\"\n },\n \"timezone\": {\n \"value\": \"\"\n }\n },\n \"directoryId\": \"43190800-5a8f-b293-7c79-cdfb41f6fd08\"\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"id\": \"959d4e04-1728-c2af-733d-bc9f8711baa6\",\n \"name\": \"string\",\n \"priority\": 63,\n \"status\": \"ACTIVE\",\n \"scheduled\": true,\n \"createdAt\": \"1969-07-28T08:17:04.658Z\",\n \"updatedAt\": \"1986-11-11T11:52:39.622Z\",\n \"author\": {\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"avatar\": {\n \"value\": \"\"\n }\n },\n \"content\": {\n \"value\": \"\"\n },\n \"audience\": {\n \"targetType\": {\n \"value\": \"\"\n },\n \"segments\": {\n \"value\": \"\"\n },\n \"query\": {\n \"value\": \"\"\n }\n },\n \"slug\": \"basket\",\n \"schema\": \"containers\",\n \"directory\": {\n \"value\": \"\"\n },\n \"group\": {\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"createdAt\": {\n \"value\": \"\"\n },\n \"deletedAt\": {\n \"value\": \"\"\n },\n \"nr\": {\n \"value\": \"\"\n }\n },\n \"deletedAt\": \"1968-02-20T12:05:01.801Z\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"f2478475-0908-403a-a238-ec99cf4137c6","name":"See error message for details","originalRequest":{"url":{"path":["schema-service","v2","documents",":documentId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"documentId","description":"(Required) UUID of the document"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"name\": \"string\",\n \"priority\": 41,\n \"content\": {\n \"value\": \"\"\n },\n \"schema\": \"containers\",\n \"groupId\": \"43c97b25-4a10-45d0-99b7-d472eea2bb24\",\n \"audience\": {\n \"targetType\": {\n \"value\": \"\"\n },\n \"segments\": {\n \"value\": \"\"\n },\n \"query\": {\n \"value\": \"\"\n }\n },\n \"schedule\": {\n \"enabled\": {\n \"value\": \"\"\n },\n \"endDate\": {\n \"value\": \"\"\n },\n \"endType\": {\n \"value\": \"\"\n },\n \"parts\": {\n \"value\": \"\"\n },\n \"periodType\": {\n \"value\": \"\"\n },\n \"startDate\": {\n \"value\": \"\"\n },\n \"startType\": {\n \"value\": \"\"\n },\n \"timezone\": {\n \"value\": \"\"\n }\n },\n \"directoryId\": \"43190800-5a8f-b293-7c79-cdfb41f6fd08\"\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"eefd0f02-26ae-481a-9fc9-cae385638a34","name":"Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc.","originalRequest":{"url":{"path":["schema-service","v2","documents",":documentId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"documentId","description":"(Required) UUID of the document"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"name\": \"string\",\n \"priority\": 41,\n \"content\": {\n \"value\": \"\"\n },\n \"schema\": \"containers\",\n \"groupId\": \"43c97b25-4a10-45d0-99b7-d472eea2bb24\",\n \"audience\": {\n \"targetType\": {\n \"value\": \"\"\n },\n \"segments\": {\n \"value\": \"\"\n },\n \"query\": {\n \"value\": \"\"\n }\n },\n \"schedule\": {\n \"enabled\": {\n \"value\": \"\"\n },\n \"endDate\": {\n \"value\": \"\"\n },\n \"endType\": {\n \"value\": \"\"\n },\n \"parts\": {\n \"value\": \"\"\n },\n \"periodType\": {\n \"value\": \"\"\n },\n \"startDate\": {\n \"value\": \"\"\n },\n \"startType\": {\n \"value\": \"\"\n },\n \"timezone\": {\n \"value\": \"\"\n }\n },\n \"directoryId\": \"43190800-5a8f-b293-7c79-cdfb41f6fd08\"\n}","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"string\",\n \"error\": \"string\",\n \"message\": \"string\",\n \"status\": 6404\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"aa0758f1-273d-4280-807a-3390e52ee504","name":"Forbidden; insufficient permissions","originalRequest":{"url":{"path":["schema-service","v2","documents",":documentId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"documentId","description":"(Required) UUID of the document"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"name\": \"string\",\n \"priority\": 41,\n \"content\": {\n \"value\": \"\"\n },\n \"schema\": \"containers\",\n \"groupId\": \"43c97b25-4a10-45d0-99b7-d472eea2bb24\",\n \"audience\": {\n \"targetType\": {\n \"value\": \"\"\n },\n \"segments\": {\n \"value\": \"\"\n },\n \"query\": {\n \"value\": \"\"\n }\n },\n \"schedule\": {\n \"enabled\": {\n \"value\": \"\"\n },\n \"endDate\": {\n \"value\": \"\"\n },\n \"endType\": {\n \"value\": \"\"\n },\n \"parts\": {\n \"value\": \"\"\n },\n \"periodType\": {\n \"value\": \"\"\n },\n \"startDate\": {\n \"value\": \"\"\n },\n \"startType\": {\n \"value\": \"\"\n },\n \"timezone\": {\n \"value\": \"\"\n }\n },\n \"directoryId\": \"43190800-5a8f-b293-7c79-cdfb41f6fd08\"\n}","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"string\",\n \"error\": \"string\",\n \"message\": \"string\",\n \"status\": 6404\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"0b38dcb1-6937-4c82-bb0b-ff8664876dca","name":"Resource not found","originalRequest":{"url":{"path":["schema-service","v2","documents",":documentId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"documentId","description":"(Required) UUID of the document"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"name\": \"string\",\n \"priority\": 41,\n \"content\": {\n \"value\": \"\"\n },\n \"schema\": \"containers\",\n \"groupId\": \"43c97b25-4a10-45d0-99b7-d472eea2bb24\",\n \"audience\": {\n \"targetType\": {\n \"value\": \"\"\n },\n \"segments\": {\n \"value\": \"\"\n },\n \"query\": {\n \"value\": \"\"\n }\n },\n \"schedule\": {\n \"enabled\": {\n \"value\": \"\"\n },\n \"endDate\": {\n \"value\": \"\"\n },\n \"endType\": {\n \"value\": \"\"\n },\n \"parts\": {\n \"value\": \"\"\n },\n \"periodType\": {\n \"value\": \"\"\n },\n \"startDate\": {\n \"value\": \"\"\n },\n \"startType\": {\n \"value\": \"\"\n },\n \"timezone\": {\n \"value\": \"\"\n }\n },\n \"directoryId\": \"43190800-5a8f-b293-7c79-cdfb41f6fd08\"\n}","options":{"raw":{"language":"json"}}}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"f67d8847-63ce-48a5-bfc9-19498cff97c4","name":"See error message for details","originalRequest":{"url":{"path":["schema-service","v2","documents",":documentId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"documentId","description":"(Required) UUID of the document"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"name\": \"string\",\n \"priority\": 41,\n \"content\": {\n \"value\": \"\"\n },\n \"schema\": \"containers\",\n \"groupId\": \"43c97b25-4a10-45d0-99b7-d472eea2bb24\",\n \"audience\": {\n \"targetType\": {\n \"value\": \"\"\n },\n \"segments\": {\n \"value\": \"\"\n },\n \"query\": {\n \"value\": \"\"\n }\n },\n \"schedule\": {\n \"enabled\": {\n \"value\": \"\"\n },\n \"endDate\": {\n \"value\": \"\"\n },\n \"endType\": {\n \"value\": \"\"\n },\n \"parts\": {\n \"value\": \"\"\n },\n \"periodType\": {\n \"value\": \"\"\n },\n \"startDate\": {\n \"value\": \"\"\n },\n \"startType\": {\n \"value\": \"\"\n },\n \"timezone\": {\n \"value\": \"\"\n }\n },\n \"directoryId\": \"43190800-5a8f-b293-7c79-cdfb41f6fd08\"\n}","options":{"raw":{"language":"json"}}}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"058e4377-fe8b-4354-bb23-3c28038eb04e","name":"Get document by UUID","request":{"name":"Get document by UUID","description":{"content":"Retrieve a document and its metadata. The content isn't processed.\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User\n\n**API key permission required:** `SCHEMA_SERVICE_SCHEMA_CREATE`\n\n**User role permission required:** `assets_docs: create`\n","type":"text/plain"},"url":{"path":["schema-service","v2","documents",":documentId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"documentId","description":"(Required) UUID of the document"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"8dd78a06-8f96-4eb7-a2cc-c43d4e9c985d","name":"Details of the document (content isn't processed)","originalRequest":{"url":{"path":["schema-service","v2","documents",":documentId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"documentId","description":"(Required) UUID of the document"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"id\": \"959d4e04-1728-c2af-733d-bc9f8711baa6\",\n \"name\": \"string\",\n \"priority\": 63,\n \"status\": \"ACTIVE\",\n \"scheduled\": true,\n \"createdAt\": \"1969-07-28T08:17:04.658Z\",\n \"updatedAt\": \"1986-11-11T11:52:39.622Z\",\n \"author\": {\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"avatar\": {\n \"value\": \"\"\n }\n },\n \"content\": {\n \"value\": \"\"\n },\n \"audience\": {\n \"targetType\": {\n \"value\": \"\"\n },\n \"segments\": {\n \"value\": \"\"\n },\n \"query\": {\n \"value\": \"\"\n }\n },\n \"slug\": \"basket\",\n \"schema\": \"containers\",\n \"directory\": {\n \"value\": \"\"\n },\n \"group\": {\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"createdAt\": {\n \"value\": \"\"\n },\n \"deletedAt\": {\n \"value\": \"\"\n },\n \"nr\": {\n \"value\": \"\"\n }\n },\n \"deletedAt\": \"1968-02-20T12:05:01.801Z\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"1c3e1e41-103e-4762-883a-ca4a751af5df","name":"See error message for details","originalRequest":{"url":{"path":["schema-service","v2","documents",":documentId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"documentId","description":"(Required) UUID of the document"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"2e9baadc-0374-437e-b662-397181cf09d9","name":"Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc.","originalRequest":{"url":{"path":["schema-service","v2","documents",":documentId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"documentId","description":"(Required) UUID of the document"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"string\",\n \"error\": \"string\",\n \"message\": \"string\",\n \"status\": 6404\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"e4ffce48-875f-454b-b905-b0980b24e6e2","name":"Forbidden; insufficient permissions","originalRequest":{"url":{"path":["schema-service","v2","documents",":documentId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"documentId","description":"(Required) UUID of the document"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"string\",\n \"error\": \"string\",\n \"message\": \"string\",\n \"status\": 6404\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"b397843a-c917-464f-842a-ea86b088c744","name":"Resource not found","originalRequest":{"url":{"path":["schema-service","v2","documents",":documentId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"documentId","description":"(Required) UUID of the document"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"af7676e0-e043-46ea-98cc-8301e86c08f8","name":"See error message for details","originalRequest":{"url":{"path":["schema-service","v2","documents",":documentId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"documentId","description":"(Required) UUID of the document"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"810049bb-6426-4e7c-bf87-04702f4df20d","name":"Delete document","request":{"name":"Delete document","description":{"content":"Delete a document. This operation is irreversible.\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User\n\n**API key permission required:** `SCHEMA_SERVICE_SCHEMA_DELETE`\n\n**User role permission required:** `assets_docs: delete`\n","type":"text/plain"},"url":{"path":["schema-service","v2","documents",":documentId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"documentId","description":"(Required) UUID of the document"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"578612e6-c08a-4f2f-8441-bb8591777d44","name":"Success","originalRequest":{"url":{"path":["schema-service","v2","documents",":documentId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"documentId","description":"(Required) UUID of the document"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"status\": \"string\",\n \"body\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"f7d26311-46d3-4bdb-ae00-9ffa545cb2b8","name":"See error message for details","originalRequest":{"url":{"path":["schema-service","v2","documents",":documentId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"documentId","description":"(Required) UUID of the document"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"03a82d3e-caff-41f7-be2e-b7c22f53f83b","name":"Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc.","originalRequest":{"url":{"path":["schema-service","v2","documents",":documentId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"documentId","description":"(Required) UUID of the document"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"string\",\n \"error\": \"string\",\n \"message\": \"string\",\n \"status\": 6404\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"aac85ad1-59bf-4319-9008-1abf173e3db0","name":"Forbidden; insufficient permissions","originalRequest":{"url":{"path":["schema-service","v2","documents",":documentId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"documentId","description":"(Required) UUID of the document"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"string\",\n \"error\": \"string\",\n \"message\": \"string\",\n \"status\": 6404\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"47a8c3af-090b-4232-930f-754951441d9c","name":"Resource not found","originalRequest":{"url":{"path":["schema-service","v2","documents",":documentId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"documentId","description":"(Required) UUID of the document"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"ec45dc6f-fecd-4b52-bec4-14516418a31c","name":"See error message for details","originalRequest":{"url":{"path":["schema-service","v2","documents",":documentId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"documentId","description":"(Required) UUID of the document"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"fb955971-bf52-4719-80d5-7aa8f0cc1ae1","name":"Copy document","request":{"name":"Copy document","description":{"content":"Copy a document.The copy receives the DRAFT status, regardless of the status of the original document.\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User\n\n**API key permission required:** `SCHEMA_SERVICE_SCHEMA_CREATE`\n\n**User role permission required:** `assets_docs: create`\n","type":"text/plain"},"url":{"path":["schema-service","v2","documents",":documentId","copy"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"documentId","description":"(Required) UUID of the document"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"96d080b8-a55a-4f9e-a766-95dfffd7886f","name":"Data of the created copy","originalRequest":{"url":{"path":["schema-service","v2","documents",":documentId","copy"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"documentId","description":"(Required) UUID of the document"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"docId\": \"1ef68633-4bae-cc8a-64eb-dc167eaed4b5\",\n \"name\": \"string\",\n \"status\": \"DRAFT\",\n \"scheduled\": true,\n \"authorId\": 7895,\n \"directoryId\": \"92767e45-4c8b-7f49-ad28-dfe066b9cac7\",\n \"createdAt\": \"2023-12-27T20:17:40.943Z\",\n \"updatedAt\": \"1990-02-18T09:16:38.422Z\",\n \"deletedAt\": \"1997-04-25T19:44:58.062Z\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"868b0f02-f9fc-43e7-ae04-390566884d97","name":"See error message for details","originalRequest":{"url":{"path":["schema-service","v2","documents",":documentId","copy"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"documentId","description":"(Required) UUID of the document"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"2eec8e04-d22e-48c0-8628-5463c01f17b8","name":"Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc.","originalRequest":{"url":{"path":["schema-service","v2","documents",":documentId","copy"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"documentId","description":"(Required) UUID of the document"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"string\",\n \"error\": \"string\",\n \"message\": \"string\",\n \"status\": 6404\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"671a2c1a-541c-4c54-9ba2-6d50e365c24e","name":"Forbidden; insufficient permissions","originalRequest":{"url":{"path":["schema-service","v2","documents",":documentId","copy"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"documentId","description":"(Required) UUID of the document"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"string\",\n \"error\": \"string\",\n \"message\": \"string\",\n \"status\": 6404\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"f6e55faf-cc3c-4dec-8d61-dd78f42b54f8","name":"Resource not found","originalRequest":{"url":{"path":["schema-service","v2","documents",":documentId","copy"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"documentId","description":"(Required) UUID of the document"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"213961aa-422c-40fc-a6d3-28cfed079e4a","name":"See error message for details","originalRequest":{"url":{"path":["schema-service","v2","documents",":documentId","copy"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"documentId","description":"(Required) UUID of the document"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"cc9da744-a306-4f1a-90ed-0e40bce9e043","name":"Assign document to directory","request":{"name":"Assign document to directory","description":{"content":"Assign a document to a directory. A document can only belong to one directory and using this endpoint overwrites the current assignment.\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User\n\n**API key permission required:** `SCHEMA_SERVICE_SCHEMA_DELETE`\n\n**User role permission required:** `assets_docs: delete`\n","type":"text/plain"},"url":{"path":["schema-service","v2","documents",":documentId","directory",":directoryId","attach"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"documentId","description":"(Required) UUID of the document"},{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"directoryId","description":"(Required) UUID of the directory"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"454b5412-ab0e-4fe4-ae40-be5441e17731","name":"Document assigned to directory","originalRequest":{"url":{"path":["schema-service","v2","documents",":documentId","directory",":directoryId","attach"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"documentId","description":"(Required) UUID of the document"},{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"directoryId","description":"(Required) UUID of the directory"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"docId\": \"1ef68633-4bae-cc8a-64eb-dc167eaed4b5\",\n \"name\": \"string\",\n \"status\": \"DRAFT\",\n \"scheduled\": true,\n \"authorId\": 7895,\n \"directoryId\": \"92767e45-4c8b-7f49-ad28-dfe066b9cac7\",\n \"createdAt\": \"2023-12-27T20:17:40.943Z\",\n \"updatedAt\": \"1990-02-18T09:16:38.422Z\",\n \"deletedAt\": \"1997-04-25T19:44:58.062Z\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"0143a631-a444-4e44-96b9-ade4bb57bea4","name":"See error message for details","originalRequest":{"url":{"path":["schema-service","v2","documents",":documentId","directory",":directoryId","attach"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"documentId","description":"(Required) UUID of the document"},{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"directoryId","description":"(Required) UUID of the directory"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"d13fdcd2-7bd4-40b1-898c-783ff26755ec","name":"Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc.","originalRequest":{"url":{"path":["schema-service","v2","documents",":documentId","directory",":directoryId","attach"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"documentId","description":"(Required) UUID of the document"},{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"directoryId","description":"(Required) UUID of the directory"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"string\",\n \"error\": \"string\",\n \"message\": \"string\",\n \"status\": 6404\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"f653e279-4eea-4270-985c-434c0ee042b9","name":"Forbidden; insufficient permissions","originalRequest":{"url":{"path":["schema-service","v2","documents",":documentId","directory",":directoryId","attach"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"documentId","description":"(Required) UUID of the document"},{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"directoryId","description":"(Required) UUID of the directory"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"string\",\n \"error\": \"string\",\n \"message\": \"string\",\n \"status\": 6404\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"58f0a9e7-6b09-4087-8009-65fe0a35647a","name":"Resource not found","originalRequest":{"url":{"path":["schema-service","v2","documents",":documentId","directory",":directoryId","attach"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"documentId","description":"(Required) UUID of the document"},{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"directoryId","description":"(Required) UUID of the directory"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"3c8ff8da-0352-4ea8-98a0-b92c6c6d283d","name":"See error message for details","originalRequest":{"url":{"path":["schema-service","v2","documents",":documentId","directory",":directoryId","attach"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"documentId","description":"(Required) UUID of the document"},{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"directoryId","description":"(Required) UUID of the directory"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"0d92cfe7-c9bf-4215-8a6a-9eb2d0383fd2","name":"Rename document directory","request":{"name":"Rename document directory","description":{"content":"Update a document directory name.\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User\n\n**API key permission required:** `SCHEMA_SERVICE_SCHEMA_DELETE`\n\n**User role permission required:** `assets_docs: delete`\n","type":"text/plain"},"url":{"path":["schema-service","v2","documents","directory",":directoryId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"directoryId","description":"(Required) UUID of the directory"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"name\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"1a28d15c-5c58-412d-9bcf-f5fd129c85f7","name":"Directory renamed","originalRequest":{"url":{"path":["schema-service","v2","documents","directory",":directoryId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"directoryId","description":"(Required) UUID of the directory"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"name\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"id\": \"19596830-d5b3-7eb5-326f-a3a26498c1e7\",\n \"name\": \"string\",\n \"createdAt\": \"1978-12-12T03:23:33.448Z\",\n \"default\": false\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"863426fd-d3a5-4ead-90aa-0ade374d1666","name":"See error message for details","originalRequest":{"url":{"path":["schema-service","v2","documents","directory",":directoryId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"directoryId","description":"(Required) UUID of the directory"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"name\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"70331708-6882-4307-a53d-b67cc1af8f4c","name":"Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc.","originalRequest":{"url":{"path":["schema-service","v2","documents","directory",":directoryId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"directoryId","description":"(Required) UUID of the directory"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"name\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"string\",\n \"error\": \"string\",\n \"message\": \"string\",\n \"status\": 6404\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"62f99079-b6fe-4775-a504-d10a9caf367f","name":"Forbidden; insufficient permissions","originalRequest":{"url":{"path":["schema-service","v2","documents","directory",":directoryId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"directoryId","description":"(Required) UUID of the directory"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"name\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"string\",\n \"error\": \"string\",\n \"message\": \"string\",\n \"status\": 6404\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"fa83306a-9193-4d4d-808c-ccca11344d48","name":"Resource not found","originalRequest":{"url":{"path":["schema-service","v2","documents","directory",":directoryId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"directoryId","description":"(Required) UUID of the directory"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"name\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"cfeb5185-017b-4425-a0a1-b6e5bc7bc6ae","name":"See error message for details","originalRequest":{"url":{"path":["schema-service","v2","documents","directory",":directoryId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"directoryId","description":"(Required) UUID of the directory"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"name\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"3ee8c0e9-dce2-4ceb-b72c-2c4aa98d5ada","name":"Delete document directory","request":{"name":"Delete document directory","description":{"content":"Delete a directory. The contents are moved into the default directory.\n\n---\n\n**API consumer:** Synerise User\n\n**User role permission required:** `assets_docs: delete`\n","type":"text/plain"},"url":{"path":["schema-service","v2","documents","directory",":directoryId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"directoryId","description":"(Required) UUID of the directory"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"90a13feb-7beb-441b-b023-00366b246076","name":"Directory deleted","originalRequest":{"url":{"path":["schema-service","v2","documents","directory",":directoryId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"directoryId","description":"(Required) UUID of the directory"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"id\": \"19596830-d5b3-7eb5-326f-a3a26498c1e7\",\n \"name\": \"string\",\n \"createdAt\": \"1978-12-12T03:23:33.448Z\",\n \"default\": false\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"b526ce21-bfdb-411e-bbea-0fdb07577759","name":"See error message for details","originalRequest":{"url":{"path":["schema-service","v2","documents","directory",":directoryId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"directoryId","description":"(Required) UUID of the directory"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"473cec33-02d6-4388-aceb-5dfd9b036c1f","name":"Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc.","originalRequest":{"url":{"path":["schema-service","v2","documents","directory",":directoryId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"directoryId","description":"(Required) UUID of the directory"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"string\",\n \"error\": \"string\",\n \"message\": \"string\",\n \"status\": 6404\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"d04c2c2f-0963-4135-ad9d-16210dc96196","name":"Forbidden; insufficient permissions","originalRequest":{"url":{"path":["schema-service","v2","documents","directory",":directoryId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"directoryId","description":"(Required) UUID of the directory"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"string\",\n \"error\": \"string\",\n \"message\": \"string\",\n \"status\": 6404\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"4025267c-50d1-4813-851d-8305faadf10e","name":"Resource not found","originalRequest":{"url":{"path":["schema-service","v2","documents","directory",":directoryId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"directoryId","description":"(Required) UUID of the directory"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"b2dde2a8-00fe-4223-9a96-2acb6de4ce34","name":"See error message for details","originalRequest":{"url":{"path":["schema-service","v2","documents","directory",":directoryId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"directoryId","description":"(Required) UUID of the directory"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"744a2b6b-38aa-4cd5-a7f0-2cd96578eee9","name":"List document directories","request":{"name":"List document directories","description":{"content":"Returns a list of directories.\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `SCHEMA_SERVICE_SCHEMA_READ`\n\n**User role permission required:** `assets_docs: read`\n","type":"text/plain"},"url":{"path":["schema-service","v2","documents","directory"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"09bcde10-f501-4700-b190-dea5b7f2a675","name":"List of directories","originalRequest":{"url":{"path":["schema-service","v2","documents","directory"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"[\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n]","cookie":[],"_postman_previewlanguage":"json"},{"id":"0df604eb-50c5-44ee-8ff3-ecb22d0d7d6a","name":"See error message for details","originalRequest":{"url":{"path":["schema-service","v2","documents","directory"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"0a1f172f-6ac5-4bd9-95af-ca3cb41302ab","name":"Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc.","originalRequest":{"url":{"path":["schema-service","v2","documents","directory"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"string\",\n \"error\": \"string\",\n \"message\": \"string\",\n \"status\": 6404\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"825c56b8-668f-4aeb-b63d-929c962a241a","name":"Forbidden; insufficient permissions","originalRequest":{"url":{"path":["schema-service","v2","documents","directory"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"string\",\n \"error\": \"string\",\n \"message\": \"string\",\n \"status\": 6404\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"bede7c08-721b-4283-896e-b0b642bed2d9","name":"Resource not found","originalRequest":{"url":{"path":["schema-service","v2","documents","directory"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"ed8b5179-8736-41aa-b799-2587129364f3","name":"See error message for details","originalRequest":{"url":{"path":["schema-service","v2","documents","directory"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"cad51321-2097-4b99-8ba1-116c7fd14c00","name":"Add document directory","request":{"name":"Add document directory","description":{"content":"\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User\n\n**API key permission required:** `SCHEMA_SERVICE_SCHEMA_CREATE`\n\n**User role permission required:** `assets_docs: create`\n","type":"text/plain"},"url":{"path":["schema-service","v2","documents","directory"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"name\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"e1287853-9ab5-4d0e-807a-29b6ca83677f","name":"Directory created","originalRequest":{"url":{"path":["schema-service","v2","documents","directory"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"name\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"id\": \"19596830-d5b3-7eb5-326f-a3a26498c1e7\",\n \"name\": \"string\",\n \"createdAt\": \"1978-12-12T03:23:33.448Z\",\n \"default\": false\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"672d36d6-5cd3-4383-863b-c3071f4a641b","name":"See error message for details","originalRequest":{"url":{"path":["schema-service","v2","documents","directory"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"name\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"42b4f2a2-7e2d-4ac6-b1e9-185181087341","name":"Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc.","originalRequest":{"url":{"path":["schema-service","v2","documents","directory"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"name\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"string\",\n \"error\": \"string\",\n \"message\": \"string\",\n \"status\": 6404\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"2bd0abd3-8ad4-41cc-9c42-ee78ad41e800","name":"Forbidden; insufficient permissions","originalRequest":{"url":{"path":["schema-service","v2","documents","directory"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"name\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"string\",\n \"error\": \"string\",\n \"message\": \"string\",\n \"status\": 6404\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"929f7bc3-2ccd-4ed0-ac42-cbb3c16bf3a7","name":"Resource not found","originalRequest":{"url":{"path":["schema-service","v2","documents","directory"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"name\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"e408f2d4-671d-4b11-a1c7-d45b50c75843","name":"See error message for details","originalRequest":{"url":{"path":["schema-service","v2","documents","directory"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"name\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"8afe4034-dbec-4eb5-91fa-d220ed3ff932","name":"Delete document group","request":{"name":"Delete document group","description":{"content":"Delete a document group. The documents that were in this group are no longer assigned to any group.\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User\n\n**API key permission required:** `SCHEMA_SERVICE_SCHEMA_DELETE`\n\n**User role permission required:** `assets_docs: delete`\n","type":"text/plain"},"url":{"path":["schema-service","v2","groups",":groupId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"groupId","description":"(Required) "}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"70f3db41-8162-4b95-abcb-e67e78453856","name":"Success, details of the deleted group are returned in the response","originalRequest":{"url":{"path":["schema-service","v2","groups",":groupId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"groupId","description":"(Required) "}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"id\": \"43c97b25-4a10-45d0-99b7-d472eea2bb24\",\n \"name\": \"string\",\n \"createdAt\": \"1996-11-20T03:55:51.151Z\",\n \"deletedAt\": \"2026-08-17T18:19:24.475Z\",\n \"nr\": 8958\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"8183b7d4-1a97-47d2-8a45-fd82881d14df","name":"See error message for details","originalRequest":{"url":{"path":["schema-service","v2","groups",":groupId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"groupId","description":"(Required) "}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"9b54bb74-29e6-406a-b60a-d9ba6dabb60e","name":"Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc.","originalRequest":{"url":{"path":["schema-service","v2","groups",":groupId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"groupId","description":"(Required) "}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"string\",\n \"error\": \"string\",\n \"message\": \"string\",\n \"status\": 6404\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"c0880450-f34e-46de-8c24-b8f79b3ae46d","name":"Forbidden; insufficient permissions","originalRequest":{"url":{"path":["schema-service","v2","groups",":groupId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"groupId","description":"(Required) "}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"string\",\n \"error\": \"string\",\n \"message\": \"string\",\n \"status\": 6404\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"2e953629-58ac-4649-b210-6891388f44a6","name":"Resource not found","originalRequest":{"url":{"path":["schema-service","v2","groups",":groupId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"groupId","description":"(Required) "}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"1cb8af80-df59-4471-bf54-810287b5b9ec","name":"See error message for details","originalRequest":{"url":{"path":["schema-service","v2","groups",":groupId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"groupId","description":"(Required) "}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"676aa485-334e-4190-8af2-52c7359c308f","name":"Add group","request":{"name":"Add group","description":{"content":"Create a new document group.\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User\n\n**API key permission required:** `SCHEMA_SERVICE_SCHEMA_CREATE`\n\n**User role permission required:** `assets_docs: create`\n","type":"text/plain"},"url":{"path":["schema-service","v2","groups"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"name\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"8feb45a3-7e63-466a-8574-c84c26a3e1dc","name":"Created group","originalRequest":{"url":{"path":["schema-service","v2","groups"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"name\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"id\": \"43c97b25-4a10-45d0-99b7-d472eea2bb24\",\n \"name\": \"string\",\n \"createdAt\": \"1996-11-20T03:55:51.151Z\",\n \"deletedAt\": \"2026-08-17T18:19:24.475Z\",\n \"nr\": 8958\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"d0299943-7eec-4c01-b3dd-34eb0c1c4f5a","name":"See error message for details","originalRequest":{"url":{"path":["schema-service","v2","groups"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"name\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"ce889f48-c816-43df-9b34-887a0bc6d2fe","name":"Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc.","originalRequest":{"url":{"path":["schema-service","v2","groups"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"name\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"string\",\n \"error\": \"string\",\n \"message\": \"string\",\n \"status\": 6404\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"f59cb4d9-ec77-46ee-b8ec-80d3d553ea4a","name":"Forbidden; insufficient permissions","originalRequest":{"url":{"path":["schema-service","v2","groups"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"name\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"string\",\n \"error\": \"string\",\n \"message\": \"string\",\n \"status\": 6404\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"98364ff1-4169-496e-a9d9-ef6afe517491","name":"Resource not found","originalRequest":{"url":{"path":["schema-service","v2","groups"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"name\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"f254ea1a-086b-4814-aaba-36dfc86c3df9","name":"See error message for details","originalRequest":{"url":{"path":["schema-service","v2","groups"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"name\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"8929cc80-c363-48d6-858d-7b712a2dcee5","name":"List groups","request":{"name":"List groups","description":{"content":"Returns a list of groups.\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `SCHEMA_SERVICE_SCHEMA_CREATE`\n\n**User role permission required:** `assets_docs: create`\n","type":"text/plain"},"url":{"path":["schema-service","v2","groups"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"3627d512-1a86-4dd0-a4f2-5bc915a24427","name":"List of groups","originalRequest":{"url":{"path":["schema-service","v2","groups"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"[\n {\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"createdAt\": {\n \"value\": \"\"\n },\n \"deletedAt\": {\n \"value\": \"\"\n },\n \"nr\": {\n \"value\": \"\"\n }\n },\n {\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"createdAt\": {\n \"value\": \"\"\n },\n \"deletedAt\": {\n \"value\": \"\"\n },\n \"nr\": {\n \"value\": \"\"\n }\n }\n]","cookie":[],"_postman_previewlanguage":"json"},{"id":"e3fc0c40-596f-4d02-943c-07f489cf23cd","name":"See error message for details","originalRequest":{"url":{"path":["schema-service","v2","groups"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"fedcf5dc-f299-4355-b031-4df3c7edc6bb","name":"Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc.","originalRequest":{"url":{"path":["schema-service","v2","groups"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"string\",\n \"error\": \"string\",\n \"message\": \"string\",\n \"status\": 6404\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"9c545a1c-a2d0-46b0-afb6-6b9a110dd8d7","name":"Forbidden; insufficient permissions","originalRequest":{"url":{"path":["schema-service","v2","groups"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"string\",\n \"error\": \"string\",\n \"message\": \"string\",\n \"status\": 6404\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"481206cb-c952-44f5-a419-286c638249c3","name":"Resource not found","originalRequest":{"url":{"path":["schema-service","v2","groups"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"f27ac6d8-58e0-4441-994b-b5fdeab06c2c","name":"See error message for details","originalRequest":{"url":{"path":["schema-service","v2","groups"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"6b23f581-f80a-4613-9961-a4494a18b15c","name":"Finish document","request":{"name":"Finish document","description":{"content":"Finish a document.\n\nFinished documents are no longer displayed to recipients.\n\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User\n\n**API key permission required:** `SCHEMA_SERVICE_SCHEMA_CREATE`\n\n**User role permission required:** `assets_docs: create`\n","type":"text/plain"},"url":{"path":["schema-service","v2","documents",":documentId","status","finish"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"documentId","description":"(Required) UUID of the document"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"d774bbad-7566-44d7-a07c-d4389c982e93","name":"Success","originalRequest":{"url":{"path":["schema-service","v2","documents",":documentId","status","finish"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"documentId","description":"(Required) UUID of the document"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"status\": \"string\",\n \"body\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"67b0d8aa-29c0-4f55-8ec8-f6b90d3f8a00","name":"See error message for details","originalRequest":{"url":{"path":["schema-service","v2","documents",":documentId","status","finish"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"documentId","description":"(Required) UUID of the document"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"5a86adc4-2b77-4ae2-8db3-5e5c24963d12","name":"Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc.","originalRequest":{"url":{"path":["schema-service","v2","documents",":documentId","status","finish"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"documentId","description":"(Required) UUID of the document"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"string\",\n \"error\": \"string\",\n \"message\": \"string\",\n \"status\": 6404\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"67a957fc-8c15-44c7-8b46-667a701e7bee","name":"Forbidden; insufficient permissions","originalRequest":{"url":{"path":["schema-service","v2","documents",":documentId","status","finish"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"documentId","description":"(Required) UUID of the document"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"string\",\n \"error\": \"string\",\n \"message\": \"string\",\n \"status\": 6404\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"465a2335-e6e5-41ad-8a63-b829687e124e","name":"Resource not found","originalRequest":{"url":{"path":["schema-service","v2","documents",":documentId","status","finish"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"documentId","description":"(Required) UUID of the document"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"2fdd5449-036c-4e94-b12a-68d91fa6743b","name":"See error message for details","originalRequest":{"url":{"path":["schema-service","v2","documents",":documentId","status","finish"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"documentId","description":"(Required) UUID of the document"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"3080fea4-3176-478c-9ea5-cba11a537ada","name":"Activate document","request":{"name":"Activate document","description":{"content":"Activate a document. It can now be displayed to recipients.\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User\n\n**API key permission required:** `SCHEMA_SERVICE_SCHEMA_CREATE`\n\n**User role permission required:** `assets_docs: create`\n","type":"text/plain"},"url":{"path":["schema-service","v2","documents",":documentId","status","activate"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"documentId","description":"(Required) UUID of the document"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"257c9a51-9e50-409f-a495-6526539fc031","name":"Success","originalRequest":{"url":{"path":["schema-service","v2","documents",":documentId","status","activate"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"documentId","description":"(Required) UUID of the document"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"status\": \"string\",\n \"body\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"cb14fc99-19ab-4ed7-bd31-cd75f9665982","name":"See error message for details","originalRequest":{"url":{"path":["schema-service","v2","documents",":documentId","status","activate"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"documentId","description":"(Required) UUID of the document"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"215e97ac-21dc-4cd2-917a-7e9c3dcbd8eb","name":"Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc.","originalRequest":{"url":{"path":["schema-service","v2","documents",":documentId","status","activate"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"documentId","description":"(Required) UUID of the document"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"string\",\n \"error\": \"string\",\n \"message\": \"string\",\n \"status\": 6404\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"4e113362-0238-410d-af07-bb8738d73e39","name":"Forbidden; insufficient permissions","originalRequest":{"url":{"path":["schema-service","v2","documents",":documentId","status","activate"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"documentId","description":"(Required) UUID of the document"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"string\",\n \"error\": \"string\",\n \"message\": \"string\",\n \"status\": 6404\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"af80c81f-1ec2-409a-b5e9-09901ceb5a36","name":"Resource not found","originalRequest":{"url":{"path":["schema-service","v2","documents",":documentId","status","activate"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"documentId","description":"(Required) UUID of the document"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"62a44955-7c36-4bc0-8907-7a223a942a2f","name":"See error message for details","originalRequest":{"url":{"path":["schema-service","v2","documents",":documentId","status","activate"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"documentId","description":"(Required) UUID of the document"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"6e68e765-865a-41b7-8739-13e56e0d80c6","name":"Resume document","request":{"name":"Resume document","description":{"content":"Resume a document that was paused.\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User\n\n**API key permission required:** `SCHEMA_SERVICE_SCHEMA_CREATE`\n\n**User role permission required:** `assets_docs: create`\n","type":"text/plain"},"url":{"path":["schema-service","v2","documents",":documentId","status","resume"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"documentId","description":"(Required) UUID of the document"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"f23140d5-5d07-46a1-a4d6-6857075e4706","name":"Success","originalRequest":{"url":{"path":["schema-service","v2","documents",":documentId","status","resume"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"documentId","description":"(Required) UUID of the document"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"status\": \"string\",\n \"body\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"71a8f40c-1264-4905-9192-bbe302868932","name":"See error message for details","originalRequest":{"url":{"path":["schema-service","v2","documents",":documentId","status","resume"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"documentId","description":"(Required) UUID of the document"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"497a068e-ec89-4b00-85c9-d802bea5b8fa","name":"Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc.","originalRequest":{"url":{"path":["schema-service","v2","documents",":documentId","status","resume"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"documentId","description":"(Required) UUID of the document"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"string\",\n \"error\": \"string\",\n \"message\": \"string\",\n \"status\": 6404\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"3b884f5a-718b-4452-af65-b199864c11be","name":"Forbidden; insufficient permissions","originalRequest":{"url":{"path":["schema-service","v2","documents",":documentId","status","resume"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"documentId","description":"(Required) UUID of the document"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"string\",\n \"error\": \"string\",\n \"message\": \"string\",\n \"status\": 6404\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"2266c2c0-5e0d-4f30-abe4-68c9e321a7d4","name":"Resource not found","originalRequest":{"url":{"path":["schema-service","v2","documents",":documentId","status","resume"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"documentId","description":"(Required) UUID of the document"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"7d784c84-db75-49a1-adb7-6dc91d818d53","name":"See error message for details","originalRequest":{"url":{"path":["schema-service","v2","documents",":documentId","status","resume"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"documentId","description":"(Required) UUID of the document"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"398bc3ab-bec2-49ea-8b11-ef57f5d1cead","name":"Pause document","request":{"name":"Pause document","description":{"content":"Pause a document to temporarily stop displaying it to recipients\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User\n\n**API key permission required:** `SCHEMA_SERVICE_SCHEMA_CREATE`\n\n**User role permission required:** `assets_docs: create`\n","type":"text/plain"},"url":{"path":["schema-service","v2","documents",":documentId","status","pause"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"documentId","description":"(Required) UUID of the document"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"6f906405-0588-441f-a55f-fd7e061df8fa","name":"Success","originalRequest":{"url":{"path":["schema-service","v2","documents",":documentId","status","pause"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"documentId","description":"(Required) UUID of the document"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"status\": \"string\",\n \"body\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"22079865-1ce6-4f85-aaec-9a6035b7f90f","name":"See error message for details","originalRequest":{"url":{"path":["schema-service","v2","documents",":documentId","status","pause"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"documentId","description":"(Required) UUID of the document"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"0d4eb265-74ee-4eba-8fd0-40d303822d21","name":"Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc.","originalRequest":{"url":{"path":["schema-service","v2","documents",":documentId","status","pause"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"documentId","description":"(Required) UUID of the document"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"string\",\n \"error\": \"string\",\n \"message\": \"string\",\n \"status\": 6404\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"5563d8f3-c4d9-4c1c-ae8a-064d5c47501b","name":"Forbidden; insufficient permissions","originalRequest":{"url":{"path":["schema-service","v2","documents",":documentId","status","pause"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"documentId","description":"(Required) UUID of the document"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"string\",\n \"error\": \"string\",\n \"message\": \"string\",\n \"status\": 6404\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"d5cb798f-00f0-4481-beeb-d0e073edec96","name":"Resource not found","originalRequest":{"url":{"path":["schema-service","v2","documents",":documentId","status","pause"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"documentId","description":"(Required) UUID of the document"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"6cd878b0-c986-40a2-8bb2-221c638cc8cc","name":"See error message for details","originalRequest":{"url":{"path":["schema-service","v2","documents",":documentId","status","pause"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"documentId","description":"(Required) UUID of the document"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"c9b8d072-f8e2-4a33-98f8-57aca8822b9b","name":"Get schema types","request":{"name":"Get schema types","description":{"content":"Retrieve a list of all schema types in the workspace.\nSchema types can be used to inform your application about the type of\ncontent included in the document's body. \nIn the Synerise Web Application, they are called \"Type\".\n\n\n---\n\n**API consumer:** Synerise User\n\n**User role permission required:** `assets_docs: read`\n","type":"text/plain"},"url":{"path":["schema-service","schemaTypes"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"78afce79-84c1-48eb-abc7-5f72d38e9955","name":"List of schema types","originalRequest":{"url":{"path":["schema-service","schemaTypes"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"[\n \"string\",\n \"string\"\n]","cookie":[],"_postman_previewlanguage":"json"},{"id":"806fac6d-59dc-4a12-b731-fab17b7b8511","name":"See error message for details","originalRequest":{"url":{"path":["schema-service","schemaTypes"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"04c55757-210a-4eb8-a5bd-ac96aee74897","name":"Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc.","originalRequest":{"url":{"path":["schema-service","schemaTypes"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"string\",\n \"error\": \"string\",\n \"message\": \"string\",\n \"status\": 6404\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"f64593fd-3b52-4f24-9716-c19aa414b780","name":"Forbidden; insufficient permissions","originalRequest":{"url":{"path":["schema-service","schemaTypes"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"string\",\n \"error\": \"string\",\n \"message\": \"string\",\n \"status\": 6404\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"b0efd4e7-1c92-4013-86db-1bd6ddd5884b","name":"Resource not found","originalRequest":{"url":{"path":["schema-service","schemaTypes"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"ff2eaad7-5beb-4066-be37-df88b7de3ba8","name":"See error message for details","originalRequest":{"url":{"path":["schema-service","schemaTypes"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"9c734fe7-8689-49a0-a59e-962bad4749fb","name":"Delete schema types","request":{"name":"Delete schema types","description":{"content":"Delete one or more schema types. This operation is irreversible.\n\n---\n\n**API consumer:** Synerise User\n\n**User role permission required:** `assets_docs: delete`\n","type":"text/plain"},"url":{"path":["schema-service","schemaTypes"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"DELETE","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"[\n \"string\",\n \"string\"\n]","options":{"raw":{"language":"json"}}}},"response":[{"id":"9f8426dc-fc74-48c5-8f06-f92b8cf32978","name":"Deletion status","originalRequest":{"url":{"path":["schema-service","schemaTypes"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{"mode":"raw","raw":"[\n \"string\",\n \"string\"\n]","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"false","cookie":[],"_postman_previewlanguage":"json"},{"id":"5ba9c4f4-fbbe-4b5b-bea9-6bc6934a265e","name":"See error message for details","originalRequest":{"url":{"path":["schema-service","schemaTypes"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{"mode":"raw","raw":"[\n \"string\",\n \"string\"\n]","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"686919c2-0601-4fe7-8b93-ced25d8d85a4","name":"Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc.","originalRequest":{"url":{"path":["schema-service","schemaTypes"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{"mode":"raw","raw":"[\n \"string\",\n \"string\"\n]","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"string\",\n \"error\": \"string\",\n \"message\": \"string\",\n \"status\": 6404\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"1120519e-3915-4813-bf69-62102773d573","name":"Forbidden; insufficient permissions","originalRequest":{"url":{"path":["schema-service","schemaTypes"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{"mode":"raw","raw":"[\n \"string\",\n \"string\"\n]","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"string\",\n \"error\": \"string\",\n \"message\": \"string\",\n \"status\": 6404\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"8f23d0be-682b-49ef-be58-8a4978ae418e","name":"Resource not found","originalRequest":{"url":{"path":["schema-service","schemaTypes"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{"mode":"raw","raw":"[\n \"string\",\n \"string\"\n]","options":{"raw":{"language":"json"}}}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"d96ba796-e8f7-4ade-89f2-17bfbdabba07","name":"See error message for details","originalRequest":{"url":{"path":["schema-service","schemaTypes"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{"mode":"raw","raw":"[\n \"string\",\n \"string\"\n]","options":{"raw":{"language":"json"}}}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"098aeb64-56d9-4f88-aa02-24cfc244d440","name":"Add schema type","request":{"name":"Add schema type","description":{"content":"Create a new schema type. \nSchema types can be used to inform your application about the type of\ncontent included in the document's body. \nIn the Synerise Web Application, they are called \"Type\".\n\n\n---\n\n**API consumer:** Synerise User\n\n**User role permission required:** `assets_docs: create`\n","type":"text/plain"},"url":{"path":["schema-service","schemaTypes"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"string","options":{"raw":{"language":"json"}}}},"response":[{"id":"6d070396-3eb1-4b48-9f4f-f33a71d338b6","name":"Schema created","originalRequest":{"url":{"path":["schema-service","schemaTypes"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"string","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"\"string\"","cookie":[],"_postman_previewlanguage":"json"},{"id":"0e3fc48e-36f0-4b53-a9a8-544df4045ea9","name":"See error message for details","originalRequest":{"url":{"path":["schema-service","schemaTypes"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"string","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"50818bc9-cef6-4c97-9dbe-510f914f1a4a","name":"Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc.","originalRequest":{"url":{"path":["schema-service","schemaTypes"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"string","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"string\",\n \"error\": \"string\",\n \"message\": \"string\",\n \"status\": 6404\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"9e7f7ea7-e456-46cb-8e46-543513ac074c","name":"Forbidden; insufficient permissions","originalRequest":{"url":{"path":["schema-service","schemaTypes"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"string","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"string\",\n \"error\": \"string\",\n \"message\": \"string\",\n \"status\": 6404\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"df165ad0-01bd-47d7-a2f5-3492992751b0","name":"Resource not found","originalRequest":{"url":{"path":["schema-service","schemaTypes"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"string","options":{"raw":{"language":"json"}}}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"5943556d-062b-481f-ae1d-186d283e8000","name":"See error message for details","originalRequest":{"url":{"path":["schema-service","schemaTypes"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"string","options":{"raw":{"language":"json"}}}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1986-05-11T00:29:56.655Z\",\n \"errorCode\": \"string\",\n \"status\": 8282,\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}],"event":[]},{"id":"e19ab4ce-bdea-4b39-9a09-65635fbb9711","name":"Uploader","description":{"content":"","type":"text/plain"},"item":[{"id":"39108a91-9bc3-4fea-afd7-a45bf3e260ca","name":"Add files for dynamic attachments","request":{"name":"Add files for dynamic attachments","description":{"content":"Add base64 encoded files to the storage for use in [dynamic attachments](https://help.synerise.com/docs/automation/actions/send-email/#dynamic-attachments). You can send up to 5 files in one request. An `attachment.upload` event is generated when you use the endpoint.\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `UPLOADER_SERVICE_STORAGE_CREATE`\n\n**User role permission required:** `assets_explorer: create`\n","type":"text/plain"},"url":{"path":["uploader-service","clients","files","by",":identifierType"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"uuid","key":"identifierType","description":"(Required) Type of the profile identifier. The value is sent in `identifierValue` in the request body."}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"files\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"ttlInMinutes\": 8189.659987155501,\n \"identifierValue\": \"1234\",\n \"parameters\": {\n \"key_0\": 5872,\n \"key_1\": false\n }\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"ad56a725-8b93-4840-862a-435e5240e16e","name":"File or files uploaded successfully","originalRequest":{"url":{"path":["uploader-service","clients","files","by",":identifierType"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"uuid","key":"identifierType","description":"(Required) Type of the profile identifier. The value is sent in `identifierValue` in the request body."}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"files\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"ttlInMinutes\": 7073.345120406393,\n \"identifierValue\": \"1234\",\n \"parameters\": {\n \"key_0\": 1761,\n \"key_1\": 8620\n }\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"id\": \"1b9b46c0-d545-cea2-0b09-e8c73fefb351\",\n \"businessProfileId\": 7300.205097790945,\n \"clientId\": 1234,\n \"ttlInMinutes\": 1384.9136882676282,\n \"params\": {\n \"key_0\": \"string\"\n },\n \"createdAt\": \"1986-11-06T02:33:41.776Z\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"8d45025c-fdcf-493a-a9f0-5205c26ccc1f","name":"Upload file","request":{"name":"Upload file","description":{"content":"\nUpload a new file to Synerise.\n\nIMPORTANT: Due to technical limitations, the code examples on the right don't include the form data. If you use the examples, remember to add it.\n\nExample correct cURL request:\n
\ncurl --location 'https://api.synerise.com/uploader-service/storages/default/upload' \\\n--header 'Authorization: Bearer YOUR_TOKEN' \\\n--form 'uploads=@\"/Users/currentuser/Downloads/image.png\"'\n
\n\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `UPLOADER_SERVICE_STORAGE_CREATE`\n\n**User role permission required:** `assets_explorer: create`\n","type":"text/plain"},"url":{"path":["uploader-service","storages",":container","upload"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"default","key":"container","description":"(Required) Name of the container in which the file will be stored"}]},"header":[{"key":"Content-Type","value":"multipart/form-data"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"formdata","formdata":[{"key":"0","value":"f","type":"text","description":""},{"key":"1","value":"o","type":"text","description":""},{"key":"2","value":"r","type":"text","description":""},{"key":"3","value":"m","type":"text","description":""}]}},"response":[{"id":"c5ec8b6a-5a71-4b77-b177-ba14aa773cf9","name":"File description","originalRequest":{"url":{"path":["uploader-service","storages",":container","upload"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"default","key":"container","description":"(Required) Name of the container in which the file will be stored"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"formdata","formdata":[{"description":{"content":"","type":"text/plain"},"key":"0","value":"f","type":"text"},{"description":{"content":"","type":"text/plain"},"key":"1","value":"o","type":"text"},{"description":{"content":"","type":"text/plain"},"key":"2","value":"r","type":"text"},{"description":{"content":"","type":"text/plain"},"key":"3","value":"m","type":"text"}]}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"result\": {\n \"files\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"storageId\": \"string\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"d3194390-1153-4a4b-b689-96cb73318c1a","name":"List files from workspace","request":{"name":"List files from workspace","description":{"content":"Retrieve a list of all files in the Workspace.\n\n---\n\n**API consumer:** Synerise User\n\n**User role permission required:** `assets_explorer: read`\n","type":"text/plain"},"url":{"path":["uploader-service","storage-files","list"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"5d84f02d-a8fc-4090-934b-64682fc88fe3","name":"Files","originalRequest":{"url":{"path":["uploader-service","storage-files","list"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"[\n {\n \"author\": {\n \"value\": \"\"\n },\n \"canEdit\": {\n \"value\": \"\"\n },\n \"canRemove\": {\n \"value\": \"\"\n },\n \"created\": {\n \"value\": \"\"\n },\n \"filename\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n },\n \"uuid\": {\n \"value\": \"\"\n },\n \"isStarred\": {\n \"value\": \"\"\n },\n \"mimetype\": {\n \"value\": \"\"\n },\n \"path\": {\n \"value\": \"\"\n },\n \"size\": {\n \"value\": \"\"\n },\n \"storageId\": {\n \"value\": \"\"\n },\n \"updated\": {\n \"value\": \"\"\n },\n \"url\": {\n \"value\": \"\"\n },\n \"user_id\": {\n \"value\": \"\"\n }\n },\n {\n \"author\": {\n \"value\": \"\"\n },\n \"canEdit\": {\n \"value\": \"\"\n },\n \"canRemove\": {\n \"value\": \"\"\n },\n \"created\": {\n \"value\": \"\"\n },\n \"filename\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n },\n \"uuid\": {\n \"value\": \"\"\n },\n \"isStarred\": {\n \"value\": \"\"\n },\n \"mimetype\": {\n \"value\": \"\"\n },\n \"path\": {\n \"value\": \"\"\n },\n \"size\": {\n \"value\": \"\"\n },\n \"storageId\": {\n \"value\": \"\"\n },\n \"updated\": {\n \"value\": \"\"\n },\n \"url\": {\n \"value\": \"\"\n },\n \"user_id\": {\n \"value\": \"\"\n }\n }\n]","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"f93a4ced-5b64-44d2-8405-36092427731d","name":"List files from workspace","request":{"name":"List files from workspace","description":{"content":"Retrieve a list of all files in the Workspace.\n\n---\n\n**API consumer:** Synerise User\n\n**User role permission required:** `assets_explorer: read`\n","type":"text/plain"},"url":{"path":["uploader-service","v2","list"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"page","value":"0","description":"page number"},{"disabled":false,"key":"limit","value":"50","description":"number of elements in a page"},{"disabled":false,"key":"sortBy","value":"createdAt:asc","description":"field to sort by and order"},{"disabled":false,"key":"mediatype","value":"image/jpeg","description":"filter by media type"},{"disabled":false,"key":"extensions","value":"pdf,jpeg","description":"filter by extension files"},{"disabled":false,"key":"search","value":"string","description":"file id or substring of file name"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"c386b398-1cae-44c0-aad7-5f3ad461ee7c","name":"Files","originalRequest":{"url":{"path":["uploader-service","v2","list"],"host":["{{baseUrl}}"],"query":[{"key":"page","value":"0"},{"key":"limit","value":"50"},{"key":"sortBy","value":"createdAt:asc"},{"key":"mediatype","value":"image/jpeg"},{"key":"extensions","value":"pdf,jpeg"},{"key":"search","value":"string"}],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"meta\": {\n \"links\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"limit\": 5005,\n \"count\": 7762\n },\n \"data\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"c4d27db9-77bb-462d-9d15-6da3f3e33692","name":"Remove files","request":{"name":"Remove files","description":{"content":"Delete one or more files.\n\nIMPORTANT: Due to technical limitations, the code examples on the right don't include the form data. If you use the examples, remember to add it.\n\nExample correct cURL request:\n
\ncurl --location 'https://api.synerise.com/uploader-service/storage-files/delete-by-uuid' \\\n--header 'Authorization: Bearer YOUR_TOKEN' \\\n--form 'uuids=\"[\\\"0ac106beb55c401bac8bc8244e367512\\\",\\\"03dc506041e24c3cae284fd3f6611082\\\"]\"'\n
\n\n\n---\n\n**API consumer:** Synerise User\n\n**User role permission required:** `assets_explorer: delete`\n","type":"text/plain"},"url":{"path":["uploader-service","storage-files","delete-by-uuid"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"multipart/form-data"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"formdata","formdata":[{"key":"uuids","value":"string","type":"text","description":"(Required) "}]}},"response":[{"id":"28469d2e-1a04-49c3-9196-a5959d59a874","name":"Results of the operation","originalRequest":{"url":{"path":["uploader-service","storage-files","delete-by-uuid"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"formdata","formdata":[{"description":{"content":"(Required) ","type":"text/plain"},"key":"uuids","value":"string","type":"text"}]}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"0ac106beb55c401bac8bc8244e367512\": true,\n \"03dc506041e24c3cae284fd3f6611082\": true\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"645339d3-1722-4e5a-8151-1cff3a3ffc4a","name":"Add stars","request":{"name":"Add stars","description":{"content":"Add a star to one or more files. Stars are used to mark files as favorite and make them easier to find.\n\nIMPORTANT: Due to technical limitations, the code examples on the right don't include the form data. If you use the examples, remember to add it.\n\nExample correct cURL request:\n
\ncurl --location 'https://api.synerise.com/uploader-service/storage-files/add-star-by-uuid' \\\n--header 'Authorization: Bearer YOUR_TOKEN' \\\n--form 'uuids=\"[\\\"0ac106beb55c401bac8bc8244e367512\\\",\\\"03dc506041e24c3cae284fd3f6611082\\\"]\"'\n
\n\n\n---\n\n**API consumer:** Synerise User\n\n**User role permission required:** `assets_explorer: update`\n","type":"text/plain"},"url":{"path":["uploader-service","storage-files","add-star-by-uuid"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"multipart/form-data"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"formdata","formdata":[{"key":"uuids","value":"string","type":"text","description":"(Required) "}]}},"response":[{"id":"b4a839fb-b198-47ff-93ac-95661309e0e2","name":"Results of the operation","originalRequest":{"url":{"path":["uploader-service","storage-files","add-star-by-uuid"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"formdata","formdata":[{"description":{"content":"(Required) ","type":"text/plain"},"key":"uuids","value":"string","type":"text"}]}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"0ac106beb55c401bac8bc8244e367512\": false,\n \"03dc506041e24c3cae284fd3f6611082\": true\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"135e4889-e0ac-4d72-b2f6-8b72a12811f5","name":"Remove stars","request":{"name":"Remove stars","description":{"content":"Remove stars from one or more files.\n\nIMPORTANT: Due to technical limitations, the code examples on the right don't include the form data. If you use the examples, remember to add it.\n\nExample correct cURL request:\n
\ncurl --location 'https://api.synerise.com/uploader-service/storage-files/remove-star-by-uuid' \\\n--header 'Authorization: Bearer YOUR_TOKEN' \\\n--form 'uuids=\"[\\\"0ac106beb55c401bac8bc8244e367512\\\",\\\"03dc506041e24c3cae284fd3f6611082\\\"]\"'\n
\n\n\n---\n\n**API consumer:** Synerise User\n\n**User role permission required:** `assets_explorer: update`\n","type":"text/plain"},"url":{"path":["uploader-service","storage-files","remove-star-by-uuid"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"multipart/form-data"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"formdata","formdata":[{"key":"uuids","value":"string","type":"text","description":"(Required) "}]}},"response":[{"id":"74b28bc7-58e1-4340-9b89-2c590b168f17","name":"Results of the operation","originalRequest":{"url":{"path":["uploader-service","storage-files","remove-star-by-uuid"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"formdata","formdata":[{"description":{"content":"(Required) ","type":"text/plain"},"key":"uuids","value":"string","type":"text"}]}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"0ac106beb55c401bac8bc8244e367512\": false,\n \"03dc506041e24c3cae284fd3f6611082\": true\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}],"event":[]},{"id":"72d27869-20f8-492b-924a-d0c6a4abaab4","name":"Documents (legacy)","description":{"content":"","type":"text/plain"},"item":[{"id":"75308e42-0cf3-4577-822d-20a70fae5bf8","name":"Preview document","request":{"name":"Preview document","description":{"content":"Preview a document.\n\n---\n\n**API consumer:** Synerise User\n\n**User role permission required:** `assets_docs: update`\n","type":"text/plain"},"url":{"path":["schema-service","document","preview"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"content\": {},\n \"schema\": \"containers\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"f7eb7da1-773e-4216-afda-436227ad4a69","name":"JSON content of the document","originalRequest":{"url":{"path":["schema-service","document","preview"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"content\": {},\n \"schema\": \"containers\"\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"4f23e8c2-0ab6-449f-bcb7-969541631875","name":"Create document version","request":{"name":"Create document version","description":{"content":"Create a new version of a document. To modify an existing version of a document, see [Update document](#operation/documentUpdatePost).\n\n---\n\n**API consumer:** Synerise User\n\n**User role permission required:** `assets_docs: update`\n","type":"text/plain"},"url":{"path":["schema-service","document",":uuid"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"uuid","description":"(Required) Document UUID. The UUID is the same for all versions of a document."}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"*/*"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"content\": {},\n \"description\": \"string\",\n \"name\": \"string\",\n \"version\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"02aedd45-57c8-49b2-af65-d5d0aeec035f","name":"Document","originalRequest":{"url":{"path":["schema-service","document",":uuid"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"uuid","description":"(Required) Document UUID. The UUID is the same for all versions of a document."}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"*/*"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"content\": {},\n \"description\": \"string\",\n \"name\": \"string\",\n \"version\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"*/*"}],"body":"{\n \"author\": 4010,\n \"content\": {},\n \"createdAt\": \"1967-09-27T18:19:58.232Z\",\n \"description\": \"string\",\n \"id\": 1184,\n \"isActive\": true,\n \"name\": \"string\",\n \"published\": false,\n \"schema\": \"containers\",\n \"slug\": \"basket\",\n \"uuid\": \"f31da622-ede8-376f-6cb4-51a1d14d2e9a\",\n \"version\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"82a74d06-d6a8-4e8f-967d-010739987866","name":"Get raw document","request":{"name":"Get raw document","description":{"content":"Retrieve a single document in raw form (inserts are not processed).\n\n---\n\n**API consumer:** Synerise User\n\n**User role permission required:** `assets_docs: read`\n","type":"text/plain"},"url":{"path":["schema-service","document",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"5612","key":"id","description":"(Required) Document ID. Each version of a document has a unique ID."}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"25dcd9a6-eac5-4624-b106-9a07e940c12a","name":"Raw document","originalRequest":{"url":{"path":["schema-service","document",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"5612","key":"id","description":"(Required) Document ID. Each version of a document has a unique ID."}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"author\": 4010,\n \"content\": {},\n \"createdAt\": \"1967-09-27T18:19:58.232Z\",\n \"description\": \"string\",\n \"id\": 1184,\n \"isActive\": true,\n \"name\": \"string\",\n \"published\": false,\n \"schema\": \"containers\",\n \"slug\": \"basket\",\n \"uuid\": \"f31da622-ede8-376f-6cb4-51a1d14d2e9a\",\n \"version\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"fecca5bb-e09f-40a1-a480-32c0a3de72b2","name":"Update document","request":{"name":"Update document","description":{"content":"Update an existing version of a document. This endpoint does not create a new version. To create a new version, see [Create document version](#operation/documentVersionPost).\n\n---\n\n**API consumer:** Synerise User\n\n**User role permission required:** `assets_docs: update`\n","type":"text/plain"},"url":{"path":["schema-service","document",":uuid",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"uuid","description":"(Required) Document UUID. The UUID is the same for all versions of a document."},{"disabled":false,"type":"any","value":"5612","key":"id","description":"(Required) Document ID. Each version of a document has a unique ID."}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"content\": {},\n \"description\": \"string\",\n \"name\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"a49ada23-f635-4306-9a7f-3604283a742a","name":"Updated document","originalRequest":{"url":{"path":["schema-service","document",":uuid",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"uuid","description":"(Required) Document UUID. The UUID is the same for all versions of a document."},{"disabled":false,"type":"any","value":"5612","key":"id","description":"(Required) Document ID. Each version of a document has a unique ID."}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"content\": {},\n \"description\": \"string\",\n \"name\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"author\": 4010,\n \"content\": {},\n \"createdAt\": \"1967-09-27T18:19:58.232Z\",\n \"description\": \"string\",\n \"id\": 1184,\n \"isActive\": true,\n \"name\": \"string\",\n \"published\": false,\n \"schema\": \"containers\",\n \"slug\": \"basket\",\n \"uuid\": \"f31da622-ede8-376f-6cb4-51a1d14d2e9a\",\n \"version\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"bbc586ce-785f-47e6-b0a5-e6751e7c036d","name":"Generate processed document (only content)","request":{"name":"Generate processed document (only content)","description":{"content":"Retrieve a generated document, without any metadata in the response. Inserts are processed.\n\n---\n\n**API consumers:** Synerise User, Profile (Client), Anonymous Profile, Workspace (Business Profile)\n\n**API key permission required:** `SCHEMA_SERVICE_DOCUMENT_READ`\n\n**User role permission required:** `assets_docs: read`\n","type":"text/plain"},"url":{"path":["schema-service","v2","document","slug",":slug","content"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"cvtcb-kyq67m-i2-vca-1x-gr4vo","key":"slug","description":"(Required) Slug of the document"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"935bb52a-30da-4ab7-9f89-f6dccfa747a4","name":"Generated document","originalRequest":{"url":{"path":["schema-service","v2","document","slug",":slug","content"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"cvtcb-kyq67m-i2-vca-1x-gr4vo","key":"slug","description":"(Required) Slug of the document"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"content\": {}\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"20325c41-4078-4768-a0f9-86e4140dd099","name":"Generate processed document (only content)","request":{"name":"Generate processed document (only content)","description":{"content":"Retrieve a generated document, without any metadata in the response. Inserts are processed.\n\n---\n\n**API consumers:** Synerise User, Profile (Client), Anonymous Profile, Workspace (Business Profile)\n\n**API key permission required:** `SCHEMA_SERVICE_DOCUMENT_READ`\n\n**User role permission required:** `assets_docs: read`\n","type":"text/plain"},"url":{"path":["schema-service","document","slug",":slug","content"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"version","value":"string","description":"Document version. If not provided, defaults to the latest version."},{"disabled":false,"key":"page","value":"5612","description":"Page of items in the document"},{"disabled":false,"key":"limit","value":"5612","description":"Limit of items per page"}],"variable":[{"disabled":false,"type":"any","value":"string","key":"slug","description":"(Required) Document slug"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"key_0\": \"string\",\n \"key_1\": \"string\",\n \"key_2\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"957a42e8-2306-422e-aa46-a69359cf241b","name":"Generated document","originalRequest":{"url":{"path":["schema-service","document","slug",":slug","content"],"host":["{{baseUrl}}"],"query":[{"key":"version","value":"string"},{"key":"page","value":"5612"},{"key":"limit","value":"5612"}],"variable":[{"disabled":false,"type":"any","value":"string","key":"slug","description":"(Required) Document slug"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"key_0\": \"string\",\n \"key_1\": \"string\",\n \"key_2\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"content\": {}\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"4de6fec7-c459-4b84-a72c-d6609c662f73","name":"Generate processed document (only content)","request":{"name":"Generate processed document (only content)","description":{"content":"Retrieve a generated document, without any metadata in the response. Inserts are processed.\n\n---\n\n**API consumers:** Synerise User, Profile (Client), Anonymous Profile, Workspace (Business Profile)\n\n**API key permission required:** `SCHEMA_SERVICE_DOCUMENT_READ`\n\n**User role permission required:** `assets_docs: read`\n","type":"text/plain"},"url":{"path":["schema-service","document","slug",":slug","content"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"version","value":"string","description":"Document version. If not provided, defaults to the latest version."},{"disabled":false,"key":"page","value":"5612","description":"Page of items in the document"},{"disabled":false,"key":"limit","value":"5612","description":"Limit of items per page"}],"variable":[{"disabled":false,"type":"any","value":"string","key":"slug","description":"(Required) Document slug"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"69d5c4be-9fd7-49d2-b092-a5fefea869a9","name":"Generated document","originalRequest":{"url":{"path":["schema-service","document","slug",":slug","content"],"host":["{{baseUrl}}"],"query":[{"key":"version","value":"string"},{"key":"page","value":"5612"},{"key":"limit","value":"5612"}],"variable":[{"disabled":false,"type":"any","value":"string","key":"slug","description":"(Required) Document slug"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"content\": {}\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"9a68fd44-9110-4403-b1f2-44d62b6214bb","name":"Generate certification document with specific slug.","request":{"name":"Generate certification document with specific slug.","description":{"content":"Retrieve a certification document. Inserts are processed.\n\n---\n\n**API consumers:** Synerise User, Profile (Client)\n\n**User role permission required:** `assets_docs: read`\n","type":"text/plain"},"url":{"path":["schema-service","document","certification",":slug"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"version","value":"string","description":"Document version. If not provided, defaults to the latest version."},{"disabled":false,"key":"page","value":"5612","description":"Page of items in the document"},{"disabled":false,"key":"limit","value":"5612","description":"Limit of items per page"}],"variable":[{"disabled":false,"type":"any","value":"string","key":"slug","description":"(Required) Document slug"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"677c91b6-84e7-4449-9485-27c99cb7ab77","name":"Generated document","originalRequest":{"url":{"path":["schema-service","document","certification",":slug"],"host":["{{baseUrl}}"],"query":[{"key":"version","value":"string"},{"key":"page","value":"5612"},{"key":"limit","value":"5612"}],"variable":[{"disabled":false,"type":"any","value":"string","key":"slug","description":"(Required) Document slug"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"content\": {},\n \"schema\": \"containers\",\n \"slug\": \"basket\",\n \"uuid\": \"97c540fd-573b-d539-3bad-33ecde462fba\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"41f34cf7-c154-44db-8a6d-c62c897cdc18","name":"Generate processed document","request":{"name":"Generate processed document","description":{"content":"Retrieve a generated document. Inserts are processed.\n\n---\n\n**API consumers:** Synerise User, Profile (Client), Anonymous Profile\n\n**User role permission required:** `assets_docs: read`\n","type":"text/plain"},"url":{"path":["schema-service","document","slug",":slug"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"version","value":"string","description":"Document version. If not provided, defaults to the latest version."},{"disabled":false,"key":"page","value":"5612","description":"Page of items in the document"},{"disabled":false,"key":"limit","value":"5612","description":"Limit of items per page"}],"variable":[{"disabled":false,"type":"any","value":"string","key":"slug","description":"(Required) Document slug"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"f75f6b04-63fb-493a-be3d-5774b7659879","name":"Generated document","originalRequest":{"url":{"path":["schema-service","document","slug",":slug"],"host":["{{baseUrl}}"],"query":[{"key":"version","value":"string"},{"key":"page","value":"5612"},{"key":"limit","value":"5612"}],"variable":[{"disabled":false,"type":"any","value":"string","key":"slug","description":"(Required) Document slug"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"content\": {},\n \"schema\": \"containers\",\n \"slug\": \"basket\",\n \"uuid\": \"97c540fd-573b-d539-3bad-33ecde462fba\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"563cf585-235e-4ac7-81a0-65aedaa0ffc6","name":"Generate processed document","request":{"name":"Generate processed document","description":{"content":"Retrieve a generated document. Inserts are processed.\n\n---\n\n**API consumers:** Synerise User, Profile (Client), Anonymous Profile\n\n**User role permission required:** `assets_docs: read`\n","type":"text/plain"},"url":{"path":["schema-service","document","slug",":slug"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"version","value":"string","description":"Document version. If not provided, defaults to the latest version."},{"disabled":false,"key":"page","value":"5612","description":"Page of items in the document"},{"disabled":false,"key":"limit","value":"5612","description":"Limit of items per page"}],"variable":[{"disabled":false,"type":"any","value":"string","key":"slug","description":"(Required) Document slug"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"66144b32-a7d9-4a3c-8d6b-56b9aeae1ce8","name":"Generated document","originalRequest":{"url":{"path":["schema-service","document","slug",":slug"],"host":["{{baseUrl}}"],"query":[{"key":"version","value":"string"},{"key":"page","value":"5612"},{"key":"limit","value":"5612"}],"variable":[{"disabled":false,"type":"any","value":"string","key":"slug","description":"(Required) Document slug"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"content\": {},\n \"schema\": \"containers\",\n \"slug\": \"basket\",\n \"uuid\": \"97c540fd-573b-d539-3bad-33ecde462fba\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"4da13160-16d3-4bde-b992-ee319f572ea7","name":"Generate documents by schema","request":{"name":"Generate documents by schema","description":{"content":"Generate all documents assigned to a schema. The content is processed.\n\n---\n\n**API consumers:** Synerise User, Profile (Client), Anonymous Profile\n\n**User role permission required:** `assets_docs: read`\n","type":"text/plain"},"url":{"path":["schema-service","document","by-schema",":schema"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"version","value":"string","description":"Document version. If not defined, all document versions are generated."},{"disabled":false,"key":"page","value":"5612","description":"Page of items in the document"},{"disabled":false,"key":"limit","value":"5612","description":"Limit of items per page"}],"variable":[{"disabled":false,"type":"any","value":"string","key":"schema","description":"(Required) Schema name"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"89e53eae-4e36-499c-8a58-5964ed334d4c","name":"Generated documents","originalRequest":{"url":{"path":["schema-service","document","by-schema",":schema"],"host":["{{baseUrl}}"],"query":[{"key":"version","value":"string"},{"key":"page","value":"5612"},{"key":"limit","value":"5612"}],"variable":[{"disabled":false,"type":"any","value":"string","key":"schema","description":"(Required) Schema name"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"[\n {\n \"content\": {\n \"value\": \"\"\n },\n \"schema\": {\n \"value\": \"\"\n },\n \"slug\": {\n \"value\": \"\"\n },\n \"uuid\": \"660faa1e-5112-4e14-306a-f11d5dfc1345\"\n },\n {\n \"content\": {\n \"value\": \"\"\n },\n \"schema\": {\n \"value\": \"\"\n },\n \"slug\": {\n \"value\": \"\"\n },\n \"uuid\": \"e596bf82-7164-0c66-1cd3-d2ec5d47bbc9\"\n }\n]","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"3f44ccb7-5415-4054-bb32-62c66eede544","name":"Create document","request":{"name":"Create document","description":{"content":"Create a new document.\n\n---\n\n**API consumer:** Synerise User\n\n**User role permission required:** `assets_docs: create`\n","type":"text/plain"},"url":{"path":["schema-service","document"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"name\": \"string\",\n \"slug\": \"basket\",\n \"schema\": \"containers\",\n \"content\": {},\n \"version\": \"string\",\n \"description\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"7e2f60e8-eb02-4fac-903c-0e4d3b5362de","name":"Document data","originalRequest":{"url":{"path":["schema-service","document"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"name\": \"string\",\n \"slug\": \"basket\",\n \"schema\": \"containers\",\n \"content\": {},\n \"version\": \"string\",\n \"description\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"author\": 4010,\n \"content\": {},\n \"createdAt\": \"1967-09-27T18:19:58.232Z\",\n \"description\": \"string\",\n \"id\": 1184,\n \"isActive\": true,\n \"name\": \"string\",\n \"published\": false,\n \"schema\": \"containers\",\n \"slug\": \"basket\",\n \"uuid\": \"f31da622-ede8-376f-6cb4-51a1d14d2e9a\",\n \"version\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"e1337527-0be1-4f4d-9e48-678b5bd59233","name":"List documents","request":{"name":"List documents","description":{"content":"List all documents in the workspace. You can sort and filter the results. The content is raw.\n\n---\n\n**API consumer:** Synerise User\n\n**User role permission required:** `assets_docs: read`\n","type":"text/plain"},"url":{"path":["schema-service","document"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"search","value":"string","description":"Search term. The following fields are searched: `name`, `description`, `version`, `slug`."},{"disabled":false,"key":"sortBy","value":"name:asc","description":"Parameter to sort by"},{"disabled":false,"key":"limit","value":"string","description":"The maximum number of items to retrieve for pagination"},{"disabled":false,"key":"offset","value":"string","description":"Offset for pagination. The first item of the first page has the offset of `0`."}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"a1d86723-c29e-4767-809d-8e98c548b94d","name":"List of documents","originalRequest":{"url":{"path":["schema-service","document"],"host":["{{baseUrl}}"],"query":[{"key":"search","value":"string"},{"key":"sortBy","value":"name:asc"},{"key":"limit","value":"string"},{"key":"offset","value":"string"}],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"data\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"total\": 2055,\n \"offset\": 4011,\n \"limit\": 2522\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"593beadd-0373-4c57-bde7-8e4a09466bc1","name":"Delete documents","request":{"name":"Delete documents","description":{"content":"You can delete one or more documents. This operation is irreversible.\n\n---\n\n**API consumer:** Synerise User\n\n**User role permission required:** `assets_docs: delete`\n","type":"text/plain"},"url":{"path":["schema-service","document"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"DELETE","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"[\n \"string\",\n \"string\"\n]","options":{"raw":{"language":"json"}}}},"response":[{"id":"b1653322-623a-401c-bfba-563cd3440794","name":"Deletion status","originalRequest":{"url":{"path":["schema-service","document"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{"mode":"raw","raw":"[\n \"string\",\n \"string\"\n]","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"false","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"f25958fd-a2ed-4276-9f59-ab84d31fb620","name":"Get document versions","request":{"name":"Get document versions","description":{"content":"Retrieve all versions of a document. The content is raw.\n\n---\n\n**API consumer:** Synerise User\n\n**User role permission required:** `assets_docs: read`\n","type":"text/plain"},"url":{"path":["schema-service","document",":uuid","versions"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"uuid","description":"(Required) Document UUID. The UUID is the same for all versions of a document."}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"6745bfe0-bd08-4755-9193-80b90149441d","name":"List of document versions","originalRequest":{"url":{"path":["schema-service","document",":uuid","versions"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"uuid","description":"(Required) Document UUID. The UUID is the same for all versions of a document."}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"[\n {\n \"author\": {\n \"value\": \"\"\n },\n \"content\": {\n \"value\": \"\"\n },\n \"createdAt\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n },\n \"isActive\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"published\": {\n \"value\": \"\"\n },\n \"schema\": {\n \"value\": \"\"\n },\n \"slug\": {\n \"value\": \"\"\n },\n \"uuid\": {\n \"value\": \"\"\n },\n \"version\": {\n \"value\": \"\"\n }\n },\n {\n \"author\": {\n \"value\": \"\"\n },\n \"content\": {\n \"value\": \"\"\n },\n \"createdAt\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n },\n \"isActive\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"published\": {\n \"value\": \"\"\n },\n \"schema\": {\n \"value\": \"\"\n },\n \"slug\": {\n \"value\": \"\"\n },\n \"uuid\": {\n \"value\": \"\"\n },\n \"version\": {\n \"value\": \"\"\n }\n }\n]","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"7451f693-7e68-4aa3-a51b-b248a0485290","name":"Publish document","request":{"name":"Publish document","description":{"content":"Publish a document. You must provide a version in the request body.\n\n---\n\n**API consumer:** Synerise User\n\n**User role permission required:** `assets_docs: update`\n","type":"text/plain"},"url":{"path":["schema-service","document",":uuid","publish"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"uuid","description":"(Required) Document UUID. The UUID is the same for all versions of a document."}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"1.0.5","options":{"raw":{"language":"json"}}}},"response":[{"id":"967dd171-6870-47c1-b04b-753d5f428248","name":"Publishing status","originalRequest":{"url":{"path":["schema-service","document",":uuid","publish"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"uuid","description":"(Required) Document UUID. The UUID is the same for all versions of a document."}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"1.0.5","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"true","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"bf82c75c-eb41-4e99-8d23-89d53e935b57","name":"Check if slug is correct","request":{"name":"Check if slug is correct","description":{"content":"Check if the provided slug exists.\n\n---\n\n**API consumer:** Synerise User\n\n**User role permission required:** `assets_docs: read`\n","type":"text/plain"},"url":{"path":["schema-service","document","slug",":slug","check"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"slug","description":"(Required) Document slug"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"cea0c89e-3d71-48e1-833f-5003ee1beeea","name":"True or False","originalRequest":{"url":{"path":["schema-service","document","slug",":slug","check"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"slug","description":"(Required) Document slug"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"true","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}],"event":[]},{"id":"018e456f-c873-478c-82b8-9665560b427c","name":"Templates","description":{"content":"","type":"text/plain"},"item":[{"id":"72e31553-f7c5-46a1-993f-1ffe5693b740","name":"List templates","request":{"name":"List templates","description":{"content":"Returns all templates from a Workspace, with an option to filter by type.\n\n---\n\n**API consumer:** Synerise User\n\n**User role permission required:** `templates: read`\n","type":"text/plain"},"url":{"path":["template-backend","template"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"type","value":"SOCIAL_MEDIA","description":"The type of templates to return"},{"disabled":false,"key":"search","value":"string","description":"Searched phrase"},{"disabled":false,"key":"limit","value":"2646.974270446586"},{"disabled":false,"key":"offset","value":"2646.974270446586"},{"disabled":false,"key":"approved","value":"false","description":"When approval-service enabled it filters for approved templates"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"19f16876-3fa8-4eef-9f42-7b3798785ba9","name":"An array of templates","originalRequest":{"url":{"path":["template-backend","template"],"host":["{{baseUrl}}"],"query":[{"key":"type","value":"SOCIAL_MEDIA"},{"key":"search","value":"string"},{"key":"limit","value":"2646.974270446586"},{"key":"offset","value":"2646.974270446586"},{"key":"approved","value":"false"}],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"[\n {\n \"id\": {\n \"value\": \"\"\n },\n \"hashId\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"businessProfileId\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"subtype\": {\n \"value\": \"\"\n },\n \"contentType\": {\n \"value\": \"\"\n },\n \"createdAt\": {\n \"value\": \"\"\n },\n \"updatedAt\": {\n \"value\": \"\"\n },\n \"directory\": {\n \"value\": \"\"\n },\n \"thumbnailUrl\": {\n \"value\": \"\"\n },\n \"author\": {\n \"value\": \"\"\n },\n \"status\": {\n \"value\": \"\"\n },\n \"source\": {\n \"value\": \"\"\n }\n },\n {\n \"id\": {\n \"value\": \"\"\n },\n \"hashId\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"businessProfileId\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"subtype\": {\n \"value\": \"\"\n },\n \"contentType\": {\n \"value\": \"\"\n },\n \"createdAt\": {\n \"value\": \"\"\n },\n \"updatedAt\": {\n \"value\": \"\"\n },\n \"directory\": {\n \"value\": \"\"\n },\n \"thumbnailUrl\": {\n \"value\": \"\"\n },\n \"author\": {\n \"value\": \"\"\n },\n \"status\": {\n \"value\": \"\"\n },\n \"source\": {\n \"value\": \"\"\n }\n }\n]","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"1cf28209-8dbb-482e-b623-88cf50f57ce4","name":"Create template","request":{"name":"Create template","description":{"content":"Create a new template.\n\n---\n\n**API consumer:** Synerise User\n\n**User role permission required:** `templates: create`\n","type":"text/plain"},"url":{"path":["template-backend","template"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"content\": \"{\\\"json\\\":\\\"\\\",\\\"html\\\":\\\"

some text

\\\",\\\"css\\\":\\\"p {\\\\n font-weight: bold\\\\n}\\\",\\\"js\\\":\\\"console.log(\\\\\\\"test\\\\\\\")\\\",\\\"raw\\\":\\\"

some text

\\\",\\\"source\\\":2}\",\n \"directory\": \"e0326a2d-7697-4ae9-b490-31f97041adcb\",\n \"source\": 4361,\n \"name\": null,\n \"type\": \"EMAIL\",\n \"subtype\": \"BANNER\",\n \"contentType\": \"TEMPLATE\",\n \"includeSafeArea\": false,\n \"hidden\": false,\n \"temporal\": false\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"7ecf53d4-3776-46d4-943a-d770d6d77396","name":"Created template","originalRequest":{"url":{"path":["template-backend","template"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"content\": \"{\\\"json\\\":\\\"\\\",\\\"html\\\":\\\"

some text

\\\",\\\"css\\\":\\\"p {\\\\n font-weight: bold\\\\n}\\\",\\\"js\\\":\\\"console.log(\\\\\\\"test\\\\\\\")\\\",\\\"raw\\\":\\\"

some text

\\\",\\\"source\\\":2}\",\n \"directory\": \"e0326a2d-7697-4ae9-b490-31f97041adcb\",\n \"source\": 4361,\n \"name\": null,\n \"type\": \"EMAIL\",\n \"subtype\": \"BANNER\",\n \"contentType\": \"TEMPLATE\",\n \"includeSafeArea\": false,\n \"hidden\": false,\n \"temporal\": false\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"id\": 4723,\n \"hashId\": \"e0326a2d-7697-4ae9-b490-31f97041adcb\",\n \"businessProfileId\": 594,\n \"name\": null,\n \"templateContent\": \"{\\\"json\\\":\\\"\\\",\\\"html\\\":\\\"

some text

\\\",\\\"css\\\":\\\"p {\\\\n font-weight: bold\\\\n}\\\",\\\"js\\\":\\\"console.log(\\\\\\\"test\\\\\\\")\\\",\\\"raw\\\":\\\"

some text

\\\",\\\"source\\\":2}\",\n \"type\": \"EMAIL\",\n \"subtype\": \"BANNER\",\n \"thumbnailUrl\": \"https://foo.bar\",\n \"directory\": {\n \"value\": \"\"\n },\n \"createdAt\": \"2019-03-21T12:31:26Z\",\n \"updatedAt\": \"2019-03-21T12:31:26Z\",\n \"parsedData\": {\n \"links\": {\n \"value\": \"\"\n }\n },\n \"parsedContent\": \"string\",\n \"functionType\": \"Password Change\",\n \"author\": 123,\n \"status\": \"REJECTED\",\n \"source\": 8103,\n \"contentType\": \"TEMPLATE\",\n \"includeSafeArea\": false\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"7b212966-acf7-42ae-9684-e187e0f14b44","name":"Get template by UUID","request":{"name":"Get template by UUID","description":{"content":"Return the details of a template identified by its UUID.\n\n---\n\n**API consumer:** Synerise User\n\n**User role permission required:** `templates: read`\n","type":"text/plain"},"url":{"path":["template-backend","template",":templateUuid"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"e0326a2d-7697-4ae9-b490-31f97041adcb","key":"templateUuid","description":"(Required) Template UUID"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"6d005158-e14d-4eae-af39-0e64d00934f4","name":"Template details","originalRequest":{"url":{"path":["template-backend","template",":templateUuid"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"e0326a2d-7697-4ae9-b490-31f97041adcb","key":"templateUuid","description":"(Required) Template UUID"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"id\": 4723,\n \"hashId\": \"e0326a2d-7697-4ae9-b490-31f97041adcb\",\n \"businessProfileId\": 594,\n \"name\": null,\n \"templateContent\": \"{\\\"json\\\":\\\"\\\",\\\"html\\\":\\\"

some text

\\\",\\\"css\\\":\\\"p {\\\\n font-weight: bold\\\\n}\\\",\\\"js\\\":\\\"console.log(\\\\\\\"test\\\\\\\")\\\",\\\"raw\\\":\\\"

some text

\\\",\\\"source\\\":2}\",\n \"type\": \"EMAIL\",\n \"subtype\": \"BANNER\",\n \"thumbnailUrl\": \"https://foo.bar\",\n \"directory\": {\n \"value\": \"\"\n },\n \"createdAt\": \"2019-03-21T12:31:26Z\",\n \"updatedAt\": \"2019-03-21T12:31:26Z\",\n \"parsedData\": {\n \"links\": {\n \"value\": \"\"\n }\n },\n \"parsedContent\": \"string\",\n \"functionType\": \"Password Change\",\n \"author\": 123,\n \"status\": \"REJECTED\",\n \"source\": 8103,\n \"contentType\": \"TEMPLATE\",\n \"includeSafeArea\": false\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"5704066b-f719-4e47-aef8-ead6a930f4e9","name":"Patch a template","request":{"name":"Patch a template","description":{"content":"Change template content.\n\n---\n\n**API consumer:** Synerise User\n\n**User role permission required:** `templates: update`\n","type":"text/plain"},"url":{"path":["template-backend","template",":templateUuid"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"e0326a2d-7697-4ae9-b490-31f97041adcb","key":"templateUuid","description":"(Required) Template UUID"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PATCH","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"name\": null,\n \"content\": \"{\\\"json\\\":\\\"\\\",\\\"html\\\":\\\"

some text

\\\",\\\"css\\\":\\\"p {\\\\n font-weight: bold\\\\n}\\\",\\\"js\\\":\\\"console.log(\\\\\\\"test\\\\\\\")\\\",\\\"raw\\\":\\\"

some text

\\\",\\\"source\\\":2}\",\n \"includeSafeArea\": false\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"6bb83329-f49e-4da2-8ba2-7ad5412c3eec","name":"Template details","originalRequest":{"url":{"path":["template-backend","template",":templateUuid"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"e0326a2d-7697-4ae9-b490-31f97041adcb","key":"templateUuid","description":"(Required) Template UUID"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"{\n \"name\": null,\n \"content\": \"{\\\"json\\\":\\\"\\\",\\\"html\\\":\\\"

some text

\\\",\\\"css\\\":\\\"p {\\\\n font-weight: bold\\\\n}\\\",\\\"js\\\":\\\"console.log(\\\\\\\"test\\\\\\\")\\\",\\\"raw\\\":\\\"

some text

\\\",\\\"source\\\":2}\",\n \"includeSafeArea\": false\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"id\": 4723,\n \"hashId\": \"e0326a2d-7697-4ae9-b490-31f97041adcb\",\n \"businessProfileId\": 594,\n \"name\": null,\n \"templateContent\": \"{\\\"json\\\":\\\"\\\",\\\"html\\\":\\\"

some text

\\\",\\\"css\\\":\\\"p {\\\\n font-weight: bold\\\\n}\\\",\\\"js\\\":\\\"console.log(\\\\\\\"test\\\\\\\")\\\",\\\"raw\\\":\\\"

some text

\\\",\\\"source\\\":2}\",\n \"type\": \"EMAIL\",\n \"subtype\": \"BANNER\",\n \"thumbnailUrl\": \"https://foo.bar\",\n \"directory\": {\n \"value\": \"\"\n },\n \"createdAt\": \"2019-03-21T12:31:26Z\",\n \"updatedAt\": \"2019-03-21T12:31:26Z\",\n \"parsedData\": {\n \"links\": {\n \"value\": \"\"\n }\n },\n \"parsedContent\": \"string\",\n \"functionType\": \"Password Change\",\n \"author\": 123,\n \"status\": \"REJECTED\",\n \"source\": 8103,\n \"contentType\": \"TEMPLATE\",\n \"includeSafeArea\": false\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"73b87702-1a67-461e-a51f-3207735ec205","name":"Create functional template","request":{"name":"Create functional template","description":{"content":"This method is deprecated. It will be disabled on November 22, 2026.
Create a new functional template. Functional templates are used for cases not covered by the [Create template endpoint](#operation/create-template), such as a password change page.\n\n---\n\n**API consumer:** Synerise User\n\n**User role permission required:** `templates: create`\n","type":"text/plain"},"url":{"path":["template-backend","template","functional"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"directory\": \"e0326a2d-7697-4ae9-b490-31f97041adcb\",\n \"content\": \"

Content

\",\n \"functionType\": \"Password Change\",\n \"name\": \"name\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"3a7d3639-bbbd-4043-bc91-b271954c5f65","name":"Created template","originalRequest":{"url":{"path":["template-backend","template","functional"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"directory\": \"e0326a2d-7697-4ae9-b490-31f97041adcb\",\n \"content\": \"

Content

\",\n \"functionType\": \"Password Change\",\n \"name\": \"name\"\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"id\": 4230,\n \"hashId\": \"e0326a2d-7697-4ae9-b490-31f97041adcb\",\n \"businessProfileId\": 594,\n \"type\": \"EMAIL\",\n \"subtype\": \"BANNER\",\n \"functionType\": \"Password Change\",\n \"thumbnailUrl\": \"https://foo.bar\",\n \"createdAt\": \"2019-03-21T12:31:26Z\",\n \"createdBy\": 123\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"782b1f0a-d63c-4386-873a-7c1b16b6c119","name":"Move templates to another directory","request":{"name":"Move templates to another directory","description":{"content":"Move templates to another directory.\n\n---\n\n**API consumer:** Synerise User\n\n**User role permission required:** `templates: update`\n","type":"text/plain"},"url":{"path":["template-backend","template","move"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"templateHashIds\": [\n \"2ede34f8-1c27-4131-bfb1-5c88856882e1\",\n \"2ede34f8-1c27-4131-bfb1-5c88856882e1\"\n ],\n \"directoryHash\": \"2ede34f8-1c27-4131-bfb1-5c88856882e1\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"e4577fe5-9420-4b07-b44f-5b3212e72cf3","name":"Number of moved templates","originalRequest":{"url":{"path":["template-backend","template","move"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"templateHashIds\": [\n \"2ede34f8-1c27-4131-bfb1-5c88856882e1\",\n \"2ede34f8-1c27-4131-bfb1-5c88856882e1\"\n ],\n \"directoryHash\": \"2ede34f8-1c27-4131-bfb1-5c88856882e1\"\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"12","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"99258bc5-9223-4bad-9c77-4ff19eae185a","name":"Remove templates","request":{"name":"Remove templates","description":{"content":"Delete templates. This operation is irreversible.\n\n---\n\n**API consumer:** Synerise User\n\n**User role permission required:** `templates: delete`\n","type":"text/plain"},"url":{"path":["template-backend","template","remove"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"[\n \"e0326a2d-7697-4ae9-b490-31f97041adcb\",\n \"e0326a2d-7697-4ae9-b490-31f97041adcb\"\n]","options":{"raw":{"language":"json"}}}},"response":[{"id":"486ffafc-d878-47cc-be3e-6cb1140a1926","name":"Number of removed templates","originalRequest":{"url":{"path":["template-backend","template","remove"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"[\n \"e0326a2d-7697-4ae9-b490-31f97041adcb\",\n \"e0326a2d-7697-4ae9-b490-31f97041adcb\"\n]","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"12","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"565e3af6-7863-4245-9967-7de50d2c5318","name":"Get template by ID","request":{"name":"Get template by ID","description":{"content":"Retrieve a template identified by ID.\n\n---\n\n**API consumer:** Synerise User\n\n**User role permission required:** `templates: read`\n","type":"text/plain"},"url":{"path":["template-backend","template","getById",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"12","key":"id","description":"(Required) Template ID"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"ba3bd72d-fbed-4e56-ab25-dac145393a08","name":"Template details","originalRequest":{"url":{"path":["template-backend","template","getById",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"12","key":"id","description":"(Required) Template ID"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"id\": 4723,\n \"hashId\": \"e0326a2d-7697-4ae9-b490-31f97041adcb\",\n \"businessProfileId\": 594,\n \"name\": null,\n \"templateContent\": \"{\\\"json\\\":\\\"\\\",\\\"html\\\":\\\"

some text

\\\",\\\"css\\\":\\\"p {\\\\n font-weight: bold\\\\n}\\\",\\\"js\\\":\\\"console.log(\\\\\\\"test\\\\\\\")\\\",\\\"raw\\\":\\\"

some text

\\\",\\\"source\\\":2}\",\n \"type\": \"EMAIL\",\n \"subtype\": \"BANNER\",\n \"thumbnailUrl\": \"https://foo.bar\",\n \"directory\": {\n \"value\": \"\"\n },\n \"createdAt\": \"2019-03-21T12:31:26Z\",\n \"updatedAt\": \"2019-03-21T12:31:26Z\",\n \"parsedData\": {\n \"links\": {\n \"value\": \"\"\n }\n },\n \"parsedContent\": \"string\",\n \"functionType\": \"Password Change\",\n \"author\": 123,\n \"status\": \"REJECTED\",\n \"source\": 8103,\n \"contentType\": \"TEMPLATE\",\n \"includeSafeArea\": false\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"b947d71a-ea02-4ac8-8b2e-53d6f81aaf25","name":"Create template from ZIP","request":{"name":"Create template from ZIP","description":{"content":"Create new template from ZIP file.\n\n---\n\n**API consumer:** Synerise User\n\n**User role permission required:** `templates: create`\n","type":"text/plain"},"url":{"path":["template-backend","upload","zip"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"multipart/form-data"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"formdata","formdata":[{"key":"filename","type":"file","description":"(Required) ZIP file"}]}},"response":[{"id":"92da41cd-d30d-4505-b428-1d8a3b36a206","name":"Created template","originalRequest":{"url":{"path":["template-backend","upload","zip"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"formdata","formdata":[{"description":{"content":"(Required) ZIP file","type":"text/plain"},"key":"filename","type":"file"}]}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"html\": \"string\",\n \"css\": \"string\",\n \"date\": \"2019-03-21T12:31:26Z\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"b374942d-364b-4c30-b133-d1d004619840","name":"Create template from URL","request":{"name":"Create template from URL","description":{"content":"Create new template from URL.\n\n---\n\n**API consumer:** Synerise User\n\n**User role permission required:** `templates: create`\n","type":"text/plain"},"url":{"path":["template-backend","upload","url"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"url\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"f4353601-de6f-4093-a51a-fa79d07511e3","name":"Created template","originalRequest":{"url":{"path":["template-backend","upload","url"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"url\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}],"event":[]},{"id":"273bf431-5523-403f-95f3-81b729994596","name":"Template directories","description":{"content":"","type":"text/plain"},"item":[{"id":"b4358f61-ff52-47e1-bea0-4f1536933934","name":"Get directories","request":{"name":"Get directories","description":{"content":"Retrieve a list of all directories in the Workspace.\n\n---\n\n**API consumer:** Synerise User\n\n**User role permission required:** `templates: read`\n","type":"text/plain"},"url":{"path":["template-backend","directory"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"5ac9594c-e224-4c3a-8b05-a53fa4fe8e4a","name":"Directory list","originalRequest":{"url":{"path":["template-backend","directory"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"[\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n]","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"111ae369-99cd-4f24-8706-c02eb832742a","name":"Create directory","request":{"name":"Create directory","description":{"content":"Create a new directory for templates. A directory can store only one type of templates.\n\n---\n\n**API consumer:** Synerise User\n\n**User role permission required:** `templates: create`\n","type":"text/plain"},"url":{"path":["template-backend","directory"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"type\": \"EMAIL\",\n \"name\": \"string\",\n \"readOnly\": false,\n \"contentType\": \"TEMPLATE\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"2206beba-be11-4551-b5a7-798487592a28","name":"Created directory","originalRequest":{"url":{"path":["template-backend","directory"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"type\": \"EMAIL\",\n \"name\": \"string\",\n \"readOnly\": false,\n \"contentType\": \"TEMPLATE\"\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"hashId\": \"e0326a2d-7697-4ae9-b490-31f97041adcb\",\n \"name\": \"string\",\n \"readOnly\": true,\n \"createdAt\": \"2019-03-21T12:31:26Z\",\n \"default\": true,\n \"type\": \"EMAIL\",\n \"contentType\": \"TEMPLATE\",\n \"predefined\": true\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"8682556a-233f-4b6a-973c-36d7400c9bf4","name":"Get directories by type","request":{"name":"Get directories by type","description":{"content":"Retrieve a list of directories of a single type.\n\n---\n\n**API consumer:** Synerise User\n\n**User role permission required:** `templates: read`\n","type":"text/plain"},"url":{"path":["template-backend","directory","byType"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"type","value":"SOCIAL_MEDIA","description":"(Required) \nThe type of directories to return (directory types match the template types stored in them).\n\nDirectories with null type are always returned.\n"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"b01040bc-8007-4685-9702-5003f1af4706","name":"Directory list","originalRequest":{"url":{"path":["template-backend","directory","byType"],"host":["{{baseUrl}}"],"query":[{"key":"type","value":"SOCIAL_MEDIA"}],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"[\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n]","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"edbbc77d-8b52-45b5-9e33-f5ade1336032","name":"Rename directory","request":{"name":"Rename directory","description":{"content":"Rename a directory.\n\n---\n\n**API consumer:** Synerise User\n\n**User role permission required:** `templates: update`\n","type":"text/plain"},"url":{"path":["template-backend","directory",":directoryUUID"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"e0326a2d-7697-4ae9-b490-31f97041adcb","key":"directoryUUID","description":"(Required) Directory UUID"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PATCH","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"name\": null\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"0524ba1e-309f-473c-bbbb-3aa5f19e7bb6","name":"Directory details","originalRequest":{"url":{"path":["template-backend","directory",":directoryUUID"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"e0326a2d-7697-4ae9-b490-31f97041adcb","key":"directoryUUID","description":"(Required) Directory UUID"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"{\n \"name\": null\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"hashId\": \"e0326a2d-7697-4ae9-b490-31f97041adcb\",\n \"name\": \"string\",\n \"readOnly\": true,\n \"createdAt\": \"2019-03-21T12:31:26Z\",\n \"default\": true,\n \"type\": \"EMAIL\",\n \"contentType\": \"TEMPLATE\",\n \"predefined\": true\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"b27c5c2c-34b7-4c55-87c7-f6b14ed537ce","name":"Remove directory","request":{"name":"Remove directory","description":{"content":"Remove a directory. Only empty directories can be removed.\n\n---\n\n**API consumer:** Synerise User\n\n**User role permission required:** `templates: delete`\n","type":"text/plain"},"url":{"path":["template-backend","directory",":directoryUUID"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"e0326a2d-7697-4ae9-b490-31f97041adcb","key":"directoryUUID","description":"(Required) Directory UUID"}]},"method":"DELETE","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"bc3b6698-7052-4ac5-81e0-97360a5d025d","name":"Directory removed","originalRequest":{"url":{"path":["template-backend","directory",":directoryUUID"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"e0326a2d-7697-4ae9-b490-31f97041adcb","key":"directoryUUID","description":"(Required) Directory UUID"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"DELETE","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"d67ca5bd-6f69-4612-8f38-7aeeadfea028","name":"Directory is not empty","originalRequest":{"url":{"path":["template-backend","directory",":directoryUUID"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"e0326a2d-7697-4ae9-b490-31f97041adcb","key":"directoryUUID","description":"(Required) Directory UUID"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"DELETE","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}],"event":[]},{"id":"cc364171-2d5a-4e40-af76-2cd2e40e6c1f","name":"Workflows","description":{"content":"","type":"text/plain"},"item":[{"id":"5224bf42-d03e-4395-94bc-e1b4e99aac93","name":"Get list of workflows/diagrams","request":{"name":"Get list of workflows/diagrams","description":{"content":"Retrieve a paginated list of workflows.\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `AUTOMATON_BRAIN_DIAGRAM_LIST_READ`\n\n**User role permission required:** `automation_2_journeys: read`\n","type":"text/plain"},"url":{"path":["automation-brain","diagrams"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"page","value":"1","description":"The selected page"},{"disabled":false,"key":"limit","value":"10","description":"Number of items per page"},{"disabled":false,"key":"status","value":"All","description":"Filter workflows by status"},{"disabled":false,"key":"sort","value":"UpdatedTime","description":"Sort workflows by a property value"},{"disabled":false,"key":"sortBy","value":"createdTime:desc","description":"Sort workflows clause"},{"disabled":false,"key":"order","value":"Desc","description":"Sorting order"},{"disabled":false,"key":"search","value":"string","description":"A string to search for in workflow names and email addresses of authors. Workflows that don't match the search aren't returned at all."},{"disabled":false,"key":"directoryId","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","description":"UUID of the directory/catalogue/folder."},{"disabled":false,"key":"blockTypes","value":"string","description":"Comma-separated list of block type names (e.g. \"Email,EventTrigger\").\nIf provided, only workflows that contain a block of EVERY listed type\nare returned. The parameter may also be repeated.\n"},{"disabled":false,"key":"triggersOnEvent","value":"jw.QB","description":"Event name that triggers or filters the workflow. If provided, only\nworkflows containing an EventTrigger or EventFilter block configured\nfor this event are returned. Matched case-insensitively.\n"},{"disabled":false,"key":"generatesEvent","value":"jw.QB","description":"Event name generated by the workflow. If provided, only workflows\ncontaining a SendEvent block, or a Webhook block whose responseAction\nis set to this event, are returned. Matched case-insensitively.\n"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"01dc82fd-73fa-45aa-916b-1d4a4241fbd0","name":"A page of workflows","originalRequest":{"url":{"path":["automation-brain","diagrams"],"host":["{{baseUrl}}"],"query":[{"key":"page","value":"1"},{"key":"limit","value":"10"},{"key":"status","value":"All"},{"key":"sort","value":"UpdatedTime"},{"key":"sortBy","value":"createdTime:desc"},{"key":"order","value":"Desc"},{"key":"search","value":"string"},{"key":"directoryId","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750"},{"key":"blockTypes","value":"string"},{"key":"triggersOnEvent","value":"jw.QB"},{"key":"generatesEvent","value":"jw.QB"}],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"data\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"meta\": {\n \"limit\": {\n \"value\": \"\"\n },\n \"page\": {\n \"value\": \"\"\n },\n \"totalPages\": {\n \"value\": \"\"\n },\n \"totalCount\": {\n \"value\": \"\"\n }\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"fc65fc7f-43db-4500-9fc0-e6daa5ca2de9","name":"Bad request: input data missing or malformed","originalRequest":{"url":{"path":["automation-brain","diagrams"],"host":["{{baseUrl}}"],"query":[{"key":"page","value":"1"},{"key":"limit","value":"10"},{"key":"status","value":"All"},{"key":"sort","value":"UpdatedTime"},{"key":"sortBy","value":"createdTime:desc"},{"key":"order","value":"Desc"},{"key":"search","value":"string"},{"key":"directoryId","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750"},{"key":"blockTypes","value":"string"},{"key":"triggersOnEvent","value":"jw.QB"},{"key":"generatesEvent","value":"jw.QB"}],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\",\n \"status\": 2468,\n \"timestamp\": \"string\",\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"8f7f415b-866c-4318-abbc-5db0dcfacb8e","name":"Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc.","originalRequest":{"url":{"path":["automation-brain","diagrams"],"host":["{{baseUrl}}"],"query":[{"key":"page","value":"1"},{"key":"limit","value":"10"},{"key":"status","value":"All"},{"key":"sort","value":"UpdatedTime"},{"key":"sortBy","value":"createdTime:desc"},{"key":"order","value":"Desc"},{"key":"search","value":"string"},{"key":"directoryId","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750"},{"key":"blockTypes","value":"string"},{"key":"triggersOnEvent","value":"jw.QB"},{"key":"generatesEvent","value":"jw.QB"}],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\",\n \"status\": 2468,\n \"timestamp\": \"string\",\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"2df51a15-51be-41da-906c-9aa60d79a22a","name":"Forbidden; insufficient permissions","originalRequest":{"url":{"path":["automation-brain","diagrams"],"host":["{{baseUrl}}"],"query":[{"key":"page","value":"1"},{"key":"limit","value":"10"},{"key":"status","value":"All"},{"key":"sort","value":"UpdatedTime"},{"key":"sortBy","value":"createdTime:desc"},{"key":"order","value":"Desc"},{"key":"search","value":"string"},{"key":"directoryId","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750"},{"key":"blockTypes","value":"string"},{"key":"triggersOnEvent","value":"jw.QB"},{"key":"generatesEvent","value":"jw.QB"}],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\",\n \"status\": 2468,\n \"timestamp\": \"string\",\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"272f377c-6206-4906-9c61-d059d2d73715","name":"Resource not found","originalRequest":{"url":{"path":["automation-brain","diagrams"],"host":["{{baseUrl}}"],"query":[{"key":"page","value":"1"},{"key":"limit","value":"10"},{"key":"status","value":"All"},{"key":"sort","value":"UpdatedTime"},{"key":"sortBy","value":"createdTime:desc"},{"key":"order","value":"Desc"},{"key":"search","value":"string"},{"key":"directoryId","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750"},{"key":"blockTypes","value":"string"},{"key":"triggersOnEvent","value":"jw.QB"},{"key":"generatesEvent","value":"jw.QB"}],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\",\n \"status\": 2468,\n \"timestamp\": \"string\",\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"334315b3-2666-4934-9ab6-9bd18dd07336","name":"Get list of workflows","request":{"name":"Get list of workflows","description":{"content":"Retrieve a paginated list of workflows.\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `AUTOMATON_BRAIN_DIAGRAM_LIST_READ`\n\n**User role permission required:** `automation_2_journeys: read`\n","type":"text/plain"},"url":{"path":["automation-brain","v2","diagrams"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"page","value":"1","description":"The selected page"},{"disabled":false,"key":"limit","value":"50","description":"Number of items per page"},{"disabled":false,"key":"status","value":"All","description":"Filter workflows by status"},{"disabled":false,"key":"sort","value":"UpdatedTime","description":"Sort workflows by a property value"},{"disabled":false,"key":"sortBy","value":"createdTime:desc","description":"Sort workflows clause"},{"disabled":false,"key":"order","value":"Desc","description":"Sorting order"},{"disabled":false,"key":"search","value":"string","description":"A string to search for in workflow names and email addresses of authors. Workflows that don't match the search aren't returned at all."},{"disabled":false,"key":"directoryId","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","description":"UUID of the directory/catalogue/folder."},{"disabled":false,"key":"tags","value":"string"},{"disabled":false,"key":"blockTypes","value":"string","description":"Comma-separated list of block type names (e.g. \"Email,EventTrigger\").\nIf provided, only workflows that contain a block of EVERY listed type\nare returned. The parameter may also be repeated.\n"},{"disabled":false,"key":"triggersOnEvent","value":"jw.QB","description":"Event name that triggers or filters the workflow. If provided, only\nworkflows containing an EventTrigger or EventFilter block configured\nfor this event are returned. Matched case-insensitively.\n"},{"disabled":false,"key":"generatesEvent","value":"jw.QB","description":"Event name generated by the workflow. If provided, only workflows\ncontaining a SendEvent block, or a Webhook block whose responseAction\nis set to this event, are returned. Matched case-insensitively.\n"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"1929b59e-71ad-42c2-b654-4fe6b220bccc","name":"A page of workflows","originalRequest":{"url":{"path":["automation-brain","v2","diagrams"],"host":["{{baseUrl}}"],"query":[{"key":"page","value":"1"},{"key":"limit","value":"50"},{"key":"status","value":"All"},{"key":"sort","value":"UpdatedTime"},{"key":"sortBy","value":"createdTime:desc"},{"key":"order","value":"Desc"},{"key":"search","value":"string"},{"key":"directoryId","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750"},{"key":"tags","value":"string"},{"key":"blockTypes","value":"string"},{"key":"triggersOnEvent","value":"jw.QB"},{"key":"generatesEvent","value":"jw.QB"}],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"data\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"meta\": {\n \"limit\": {\n \"value\": \"\"\n },\n \"links\": {\n \"value\": \"\"\n }\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"2996564d-d5b8-4dda-9f18-01bd5cc7b236","name":"Bad request: input data missing or malformed","originalRequest":{"url":{"path":["automation-brain","v2","diagrams"],"host":["{{baseUrl}}"],"query":[{"key":"page","value":"1"},{"key":"limit","value":"50"},{"key":"status","value":"All"},{"key":"sort","value":"UpdatedTime"},{"key":"sortBy","value":"createdTime:desc"},{"key":"order","value":"Desc"},{"key":"search","value":"string"},{"key":"directoryId","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750"},{"key":"tags","value":"string"},{"key":"blockTypes","value":"string"},{"key":"triggersOnEvent","value":"jw.QB"},{"key":"generatesEvent","value":"jw.QB"}],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\",\n \"status\": 2468,\n \"timestamp\": \"string\",\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"fbc781c3-75a5-4c5c-8ade-627571bc0189","name":"Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc.","originalRequest":{"url":{"path":["automation-brain","v2","diagrams"],"host":["{{baseUrl}}"],"query":[{"key":"page","value":"1"},{"key":"limit","value":"50"},{"key":"status","value":"All"},{"key":"sort","value":"UpdatedTime"},{"key":"sortBy","value":"createdTime:desc"},{"key":"order","value":"Desc"},{"key":"search","value":"string"},{"key":"directoryId","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750"},{"key":"tags","value":"string"},{"key":"blockTypes","value":"string"},{"key":"triggersOnEvent","value":"jw.QB"},{"key":"generatesEvent","value":"jw.QB"}],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\",\n \"status\": 2468,\n \"timestamp\": \"string\",\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"3a5c3cff-c758-4910-8aa7-393c8d9711aa","name":"Forbidden; insufficient permissions","originalRequest":{"url":{"path":["automation-brain","v2","diagrams"],"host":["{{baseUrl}}"],"query":[{"key":"page","value":"1"},{"key":"limit","value":"50"},{"key":"status","value":"All"},{"key":"sort","value":"UpdatedTime"},{"key":"sortBy","value":"createdTime:desc"},{"key":"order","value":"Desc"},{"key":"search","value":"string"},{"key":"directoryId","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750"},{"key":"tags","value":"string"},{"key":"blockTypes","value":"string"},{"key":"triggersOnEvent","value":"jw.QB"},{"key":"generatesEvent","value":"jw.QB"}],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\",\n \"status\": 2468,\n \"timestamp\": \"string\",\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"73f63bbe-cfd7-4847-9c37-aa022bbf2a1d","name":"Resource not found","originalRequest":{"url":{"path":["automation-brain","v2","diagrams"],"host":["{{baseUrl}}"],"query":[{"key":"page","value":"1"},{"key":"limit","value":"50"},{"key":"status","value":"All"},{"key":"sort","value":"UpdatedTime"},{"key":"sortBy","value":"createdTime:desc"},{"key":"order","value":"Desc"},{"key":"search","value":"string"},{"key":"directoryId","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750"},{"key":"tags","value":"string"},{"key":"blockTypes","value":"string"},{"key":"triggersOnEvent","value":"jw.QB"},{"key":"generatesEvent","value":"jw.QB"}],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\",\n \"status\": 2468,\n \"timestamp\": \"string\",\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"6dcf00e8-0a7a-40b2-b11d-95f2a3304425","name":"Run/resume workflow","request":{"name":"Run/resume workflow","description":{"content":"Run a or resume workflow.\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `AUTOMATON_BRAIN_DIAGRAM_EXECUTE`\n\n**User role permission required:** `automation_2_journeys: execute`\n","type":"text/plain"},"url":{"path":["automation-brain","diagrams",":diagramId","run"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"diagramId","description":"(Required) UUID of the workflow/diagram"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"scheduleAction\": \"Off\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"6c3aee56-6ef0-4ee5-9654-5d1dc607ff20","name":"Workflow run/resumed or was already running","originalRequest":{"url":{"path":["automation-brain","diagrams",":diagramId","run"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"diagramId","description":"(Required) UUID of the workflow/diagram"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"text/plain"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"scheduleAction\": \"Off\"\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"OK","cookie":[],"_postman_previewlanguage":"text"},{"id":"77101327-6464-4fa0-b283-97c598014ae5","name":"See error message for details","originalRequest":{"url":{"path":["automation-brain","diagrams",":diagramId","run"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"diagramId","description":"(Required) UUID of the workflow/diagram"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"scheduleAction\": \"Off\"\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"errorCode\": \"string\",\n \"httpStatus\": 512,\n \"message\": \"string\",\n \"timestamp\": \"1953-11-20T10:43:04.810Z\",\n \"help\": \"string\",\n \"traceId\": \"string\",\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"source\": {\n \"pointer\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"details\": {\n \"activeDiagrams\": {\n \"value\": \"\"\n }\n },\n \"field\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"d9c780e7-8087-449d-84a2-a9236c060b3c","name":"Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc.","originalRequest":{"url":{"path":["automation-brain","diagrams",":diagramId","run"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"diagramId","description":"(Required) UUID of the workflow/diagram"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"scheduleAction\": \"Off\"\n}","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\",\n \"status\": 2468,\n \"timestamp\": \"string\",\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"7c5c11b9-6005-4bd0-8c41-d95245bf0e5a","name":"Forbidden; insufficient permissions","originalRequest":{"url":{"path":["automation-brain","diagrams",":diagramId","run"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"diagramId","description":"(Required) UUID of the workflow/diagram"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"scheduleAction\": \"Off\"\n}","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\",\n \"status\": 2468,\n \"timestamp\": \"string\",\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"07f2ea50-720d-4ff5-81e9-ebfe8d7c7c3c","name":"Resource not found","originalRequest":{"url":{"path":["automation-brain","diagrams",":diagramId","run"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"diagramId","description":"(Required) UUID of the workflow/diagram"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"scheduleAction\": \"Off\"\n}","options":{"raw":{"language":"json"}}}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\",\n \"status\": 2468,\n \"timestamp\": \"string\",\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"94ea65e2-f848-4288-bce3-ee5d8de178f6","name":"Pause workflow","request":{"name":"Pause workflow","description":{"content":"Pause a workflow.\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `AUTOMATON_BRAIN_DIAGRAM_EXECUTE`\n\n**User role permission required:** `automation_2_journeys: execute`\n","type":"text/plain"},"url":{"path":["automation-brain","diagrams",":diagramId","pause"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"diagramId","description":"(Required) UUID of the workflow/diagram"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"scheduleAction\": \"Off\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"91d482fb-1320-49b2-91f4-a0ee9b90ad79","name":"Diagram paused or was already paused","originalRequest":{"url":{"path":["automation-brain","diagrams",":diagramId","pause"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"diagramId","description":"(Required) UUID of the workflow/diagram"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"text/plain"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"scheduleAction\": \"Off\"\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"OK","cookie":[],"_postman_previewlanguage":"text"},{"id":"1bab267e-56f5-4d35-bac4-8c6991a70a9b","name":"See error message for details","originalRequest":{"url":{"path":["automation-brain","diagrams",":diagramId","pause"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"diagramId","description":"(Required) UUID of the workflow/diagram"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"scheduleAction\": \"Off\"\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"errorCode\": \"string\",\n \"httpStatus\": 512,\n \"message\": \"string\",\n \"timestamp\": \"1953-11-20T10:43:04.810Z\",\n \"help\": \"string\",\n \"traceId\": \"string\",\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"source\": {\n \"pointer\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"details\": {\n \"activeDiagrams\": {\n \"value\": \"\"\n }\n },\n \"field\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"90cce580-cad9-42cc-8395-dbc17b9ec483","name":"Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc.","originalRequest":{"url":{"path":["automation-brain","diagrams",":diagramId","pause"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"diagramId","description":"(Required) UUID of the workflow/diagram"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"scheduleAction\": \"Off\"\n}","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\",\n \"status\": 2468,\n \"timestamp\": \"string\",\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"741795fe-109e-4302-b92d-3e733ecc25b5","name":"Forbidden; insufficient permissions","originalRequest":{"url":{"path":["automation-brain","diagrams",":diagramId","pause"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"diagramId","description":"(Required) UUID of the workflow/diagram"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"scheduleAction\": \"Off\"\n}","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\",\n \"status\": 2468,\n \"timestamp\": \"string\",\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"65d1f6cf-4cd2-418d-9fb6-68025e4a7d4d","name":"Resource not found","originalRequest":{"url":{"path":["automation-brain","diagrams",":diagramId","pause"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"diagramId","description":"(Required) UUID of the workflow/diagram"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"scheduleAction\": \"Off\"\n}","options":{"raw":{"language":"json"}}}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\",\n \"status\": 2468,\n \"timestamp\": \"string\",\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"437d5677-51f2-4d7e-a19a-3241f0a74315","name":"Stop workflow","request":{"name":"Stop workflow","description":{"content":"Stop a workflow.\n\nWARNING: A stopped workflow can't be restarted.\n\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `AUTOMATON_BRAIN_DIAGRAM_EXECUTE`\n\n**User role permission required:** `automation_2_journeys: execute`\n","type":"text/plain"},"url":{"path":["automation-brain","diagrams",":diagramId","stop"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"diagramId","description":"(Required) UUID of the workflow/diagram"}]},"header":[{"key":"Accept","value":"text/plain"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"deb15a25-346e-49e4-985b-e25e7e712e63","name":"Workflow stopped or was already stopped","originalRequest":{"url":{"path":["automation-brain","diagrams",":diagramId","stop"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"diagramId","description":"(Required) UUID of the workflow/diagram"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"text/plain"}],"method":"POST","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"OK","cookie":[],"_postman_previewlanguage":"text"},{"id":"8f59c238-bcbe-44cf-a1e3-4875193478dc","name":"See error message for details","originalRequest":{"url":{"path":["automation-brain","diagrams",":diagramId","stop"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"diagramId","description":"(Required) UUID of the workflow/diagram"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"errorCode\": \"string\",\n \"httpStatus\": 512,\n \"message\": \"string\",\n \"timestamp\": \"1953-11-20T10:43:04.810Z\",\n \"help\": \"string\",\n \"traceId\": \"string\",\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"source\": {\n \"pointer\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"details\": {\n \"activeDiagrams\": {\n \"value\": \"\"\n }\n },\n \"field\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"66f196ce-0d5f-492e-83eb-195cb3b00ed2","name":"Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc.","originalRequest":{"url":{"path":["automation-brain","diagrams",":diagramId","stop"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"diagramId","description":"(Required) UUID of the workflow/diagram"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\",\n \"status\": 2468,\n \"timestamp\": \"string\",\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"c6f81822-779c-4b3c-9c4a-e0ea4a034312","name":"Forbidden; insufficient permissions","originalRequest":{"url":{"path":["automation-brain","diagrams",":diagramId","stop"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"diagramId","description":"(Required) UUID of the workflow/diagram"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\",\n \"status\": 2468,\n \"timestamp\": \"string\",\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"46b3ad10-3463-45f7-a6d0-e42cb8c167db","name":"Resource not found","originalRequest":{"url":{"path":["automation-brain","diagrams",":diagramId","stop"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"diagramId","description":"(Required) UUID of the workflow/diagram"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\",\n \"status\": 2468,\n \"timestamp\": \"string\",\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"b1cd4712-148b-48b3-bc80-38bccf5d0b0b","name":"Get workflow statistics with node details","request":{"name":"Get workflow statistics with node details","description":{"content":"Retrieve workflow execution statistics, including node statistics and metadata (name, type).\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `AUTOMATION_STATS_READ`\n\n**User role permission required:** `automation_2_journeys: read`\n","type":"text/plain"},"url":{"path":["automation-brain","diagrams",":diagramId","statistics"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"timePeriod","value":"previousDay","description":"Time period for the statistics"}],"variable":[{"disabled":false,"type":"any","value":"string","key":"diagramId","description":"(Required) UUID of the workflow/diagram"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"484465ec-6b99-43bb-b5c3-fbba3da7b8c0","name":"Diagram statistics with node info","originalRequest":{"url":{"path":["automation-brain","diagrams",":diagramId","statistics"],"host":["{{baseUrl}}"],"query":[{"key":"timePeriod","value":"previousDay"}],"variable":[{"disabled":false,"type":"any","value":"string","key":"diagramId","description":"(Required) UUID of the workflow/diagram"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"started\": 5013,\n \"finished\": 8155,\n \"inProgress\": 6384,\n \"blocks\": {\n \"key_0\": {\n \"value\": \"\"\n }\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"9acc9995-087d-4b75-a504-53aceddccc53","name":"See error message for details","originalRequest":{"url":{"path":["automation-brain","diagrams",":diagramId","statistics"],"host":["{{baseUrl}}"],"query":[{"key":"timePeriod","value":"previousDay"}],"variable":[{"disabled":false,"type":"any","value":"string","key":"diagramId","description":"(Required) UUID of the workflow/diagram"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"errorCode\": \"string\",\n \"httpStatus\": 512,\n \"message\": \"string\",\n \"timestamp\": \"1953-11-20T10:43:04.810Z\",\n \"help\": \"string\",\n \"traceId\": \"string\",\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"source\": {\n \"pointer\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"details\": {\n \"activeDiagrams\": {\n \"value\": \"\"\n }\n },\n \"field\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"e24811b3-919d-43fe-9233-7a2b5d2d737b","name":"Forbidden; insufficient permissions","originalRequest":{"url":{"path":["automation-brain","diagrams",":diagramId","statistics"],"host":["{{baseUrl}}"],"query":[{"key":"timePeriod","value":"previousDay"}],"variable":[{"disabled":false,"type":"any","value":"string","key":"diagramId","description":"(Required) UUID of the workflow/diagram"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\",\n \"status\": 2468,\n \"timestamp\": \"string\",\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"05bed646-3ae9-4ecb-aed0-1e2615a0c3e6","name":"Diagram not found","originalRequest":{"url":{"path":["automation-brain","diagrams",":diagramId","statistics"],"host":["{{baseUrl}}"],"query":[{"key":"timePeriod","value":"previousDay"}],"variable":[{"disabled":false,"type":"any","value":"string","key":"diagramId","description":"(Required) UUID of the workflow/diagram"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"GET","body":{}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"9ba37fa1-05fa-47bc-ac87-d17b48dba8e8","name":"Get node statistics","request":{"name":"Get node statistics","description":{"content":"Retrieve execution statistics for a single block enriched with block metadata (name, type).\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `AUTOMATION_STATS_READ`\n\n**User role permission required:** `automation_2_journeys: read`\n","type":"text/plain"},"url":{"path":["automation-brain","diagrams",":diagramId","blocks",":blockId","statistics"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"timePeriod","value":"previousDay","description":"Time period for statistics"}],"variable":[{"disabled":false,"type":"any","value":"string","key":"diagramId","description":"(Required) UUID of the workflow/diagram"},{"disabled":false,"type":"any","value":"string","key":"blockId","description":"(Required) UUID of the node"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"00ec47fb-8a5f-4310-ae46-87068ee0fc0d","name":"Block statistics with block info","originalRequest":{"url":{"path":["automation-brain","diagrams",":diagramId","blocks",":blockId","statistics"],"host":["{{baseUrl}}"],"query":[{"key":"timePeriod","value":"previousDay"}],"variable":[{"disabled":false,"type":"any","value":"string","key":"diagramId","description":"(Required) UUID of the workflow/diagram"},{"disabled":false,"type":"any","value":"string","key":"blockId","description":"(Required) UUID of the node"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"type\": \"EventTrigger\",\n \"entered\": 8099,\n \"name\": \"string\",\n \"executed\": 926\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"44219e2e-ee8a-4f9e-a3a9-14f44b8b38fc","name":"See error message for details","originalRequest":{"url":{"path":["automation-brain","diagrams",":diagramId","blocks",":blockId","statistics"],"host":["{{baseUrl}}"],"query":[{"key":"timePeriod","value":"previousDay"}],"variable":[{"disabled":false,"type":"any","value":"string","key":"diagramId","description":"(Required) UUID of the workflow/diagram"},{"disabled":false,"type":"any","value":"string","key":"blockId","description":"(Required) UUID of the node"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"errorCode\": \"string\",\n \"httpStatus\": 512,\n \"message\": \"string\",\n \"timestamp\": \"1953-11-20T10:43:04.810Z\",\n \"help\": \"string\",\n \"traceId\": \"string\",\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"source\": {\n \"pointer\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"details\": {\n \"activeDiagrams\": {\n \"value\": \"\"\n }\n },\n \"field\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"1426c845-0865-477a-bf52-ba1bf382b989","name":"Forbidden; insufficient permissions","originalRequest":{"url":{"path":["automation-brain","diagrams",":diagramId","blocks",":blockId","statistics"],"host":["{{baseUrl}}"],"query":[{"key":"timePeriod","value":"previousDay"}],"variable":[{"disabled":false,"type":"any","value":"string","key":"diagramId","description":"(Required) UUID of the workflow/diagram"},{"disabled":false,"type":"any","value":"string","key":"blockId","description":"(Required) UUID of the node"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\",\n \"status\": 2468,\n \"timestamp\": \"string\",\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"e4b7f344-dbf4-4cf1-913b-95bcee93e33f","name":"Diagram or block not found","originalRequest":{"url":{"path":["automation-brain","diagrams",":diagramId","blocks",":blockId","statistics"],"host":["{{baseUrl}}"],"query":[{"key":"timePeriod","value":"previousDay"}],"variable":[{"disabled":false,"type":"any","value":"string","key":"diagramId","description":"(Required) UUID of the workflow/diagram"},{"disabled":false,"type":"any","value":"string","key":"blockId","description":"(Required) UUID of the node"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"GET","body":{}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}],"event":[]},{"id":"c154d624-01b0-4dc3-b83d-f17826d0871b","name":"Workflow schedules","description":{"content":"","type":"text/plain"},"item":[{"id":"a4c4eba6-a3c0-49d7-848e-bb1520cf0fae","name":"Set schedule rules for workflow","request":{"name":"Set schedule rules for workflow","description":{"content":"Set schedule rules for a workflow. This lets you activate, pause, or stop a workflow according to a plan. \n\nAfter the schedule is set, it must be activated to take effect (see the `POST /automation-brain/diagrams/{diagramId}/schedule-on` method). \n\n**The backend doesn't validate the logic of the schedule**. You must ensure it's well-built (rules make logical sense) and complies with the structure of the workflow (such as trigger node time rules). See [\"Workflow Scheduler > Important\" in the Synerise Hub](https://hub.synerise.com/docs/automation/workflow-scheduler#important).\n\nThe contents of this request overwrite an existing schedule.\n\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `AUTOMATON_BRAIN_DIAGRAM_SCHEDULE_UPDATE`\n\n**User role permission required:** `automation_2_journeys: update`\n","type":"text/plain"},"url":{"path":["automation-brain","diagrams",":diagramId","schedule"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"diagramId","description":"(Required) UUID of the workflow/diagram"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"timezone\": \"Europe/Paris\",\n \"rules\": [\n {\n \"actionType\": {\n \"value\": \"\"\n },\n \"repeatModel\": {\n \"value\": \"\"\n },\n \"ruleId\": {\n \"value\": \"\"\n }\n },\n {\n \"actionType\": {\n \"value\": \"\"\n },\n \"repeatModel\": {\n \"value\": \"\"\n },\n \"ruleId\": {\n \"value\": \"\"\n }\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"badb1f7a-3085-4d62-8dc3-44e83f24e6db","name":"Schedule saved","originalRequest":{"url":{"path":["automation-brain","diagrams",":diagramId","schedule"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"diagramId","description":"(Required) UUID of the workflow/diagram"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"timezone\": \"Europe/Paris\",\n \"rules\": [\n {\n \"actionType\": {\n \"value\": \"\"\n },\n \"repeatModel\": {\n \"value\": \"\"\n },\n \"ruleId\": {\n \"value\": \"\"\n }\n },\n {\n \"actionType\": {\n \"value\": \"\"\n },\n \"repeatModel\": {\n \"value\": \"\"\n },\n \"ruleId\": {\n \"value\": \"\"\n }\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"active\": false,\n \"timezone\": \"Europe/Paris\",\n \"rules\": [\n {\n \"ruleId\": {\n \"value\": \"\"\n },\n \"actionType\": {\n \"value\": \"\"\n },\n \"repeatModel\": {\n \"value\": \"\"\n },\n \"listingAuthor\": {\n \"value\": \"\"\n },\n \"createdAt\": {\n \"value\": \"\"\n }\n },\n {\n \"ruleId\": {\n \"value\": \"\"\n },\n \"actionType\": {\n \"value\": \"\"\n },\n \"repeatModel\": {\n \"value\": \"\"\n },\n \"listingAuthor\": {\n \"value\": \"\"\n },\n \"createdAt\": {\n \"value\": \"\"\n }\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"9b0601dd-c97e-420d-be0b-75e65dca0919","name":"See error message for details","originalRequest":{"url":{"path":["automation-brain","diagrams",":diagramId","schedule"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"diagramId","description":"(Required) UUID of the workflow/diagram"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"text/plain"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"timezone\": \"Europe/Paris\",\n \"rules\": [\n {\n \"actionType\": {\n \"value\": \"\"\n },\n \"repeatModel\": {\n \"value\": \"\"\n },\n \"ruleId\": {\n \"value\": \"\"\n }\n },\n {\n \"actionType\": {\n \"value\": \"\"\n },\n \"repeatModel\": {\n \"value\": \"\"\n },\n \"ruleId\": {\n \"value\": \"\"\n }\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"string","cookie":[],"_postman_previewlanguage":"text"},{"id":"834063da-2963-48f4-b127-bf125617e1c1","name":"Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc.","originalRequest":{"url":{"path":["automation-brain","diagrams",":diagramId","schedule"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"diagramId","description":"(Required) UUID of the workflow/diagram"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"timezone\": \"Europe/Paris\",\n \"rules\": [\n {\n \"actionType\": {\n \"value\": \"\"\n },\n \"repeatModel\": {\n \"value\": \"\"\n },\n \"ruleId\": {\n \"value\": \"\"\n }\n },\n {\n \"actionType\": {\n \"value\": \"\"\n },\n \"repeatModel\": {\n \"value\": \"\"\n },\n \"ruleId\": {\n \"value\": \"\"\n }\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\",\n \"status\": 2468,\n \"timestamp\": \"string\",\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"45adb9ab-ff39-4c92-af8c-f944942e1b3f","name":"Forbidden; insufficient permissions","originalRequest":{"url":{"path":["automation-brain","diagrams",":diagramId","schedule"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"diagramId","description":"(Required) UUID of the workflow/diagram"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"timezone\": \"Europe/Paris\",\n \"rules\": [\n {\n \"actionType\": {\n \"value\": \"\"\n },\n \"repeatModel\": {\n \"value\": \"\"\n },\n \"ruleId\": {\n \"value\": \"\"\n }\n },\n {\n \"actionType\": {\n \"value\": \"\"\n },\n \"repeatModel\": {\n \"value\": \"\"\n },\n \"ruleId\": {\n \"value\": \"\"\n }\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\",\n \"status\": 2468,\n \"timestamp\": \"string\",\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"bbde2ed1-1698-4dce-b3ea-a10fd96cf8c6","name":"Resource not found","originalRequest":{"url":{"path":["automation-brain","diagrams",":diagramId","schedule"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"diagramId","description":"(Required) UUID of the workflow/diagram"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"timezone\": \"Europe/Paris\",\n \"rules\": [\n {\n \"actionType\": {\n \"value\": \"\"\n },\n \"repeatModel\": {\n \"value\": \"\"\n },\n \"ruleId\": {\n \"value\": \"\"\n }\n },\n {\n \"actionType\": {\n \"value\": \"\"\n },\n \"repeatModel\": {\n \"value\": \"\"\n },\n \"ruleId\": {\n \"value\": \"\"\n }\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\",\n \"status\": 2468,\n \"timestamp\": \"string\",\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"61d8b77d-9703-4594-abb8-68858526b75e","name":"Get workflow schedule","request":{"name":"Get workflow schedule","description":{"content":"Get all schedule rules of a workflow.\n\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `AUTOMATON_BRAIN_DIAGRAM_SCHEDULE_READ`\n\n**User role permission required:** `automation_2_journeys: read`\n","type":"text/plain"},"url":{"path":["automation-brain","diagrams",":diagramId","schedule"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"diagramId","description":"(Required) UUID of the workflow/diagram"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"b494ef0d-4296-41d3-ab83-b7273f4994fc","name":"Schedule rules","originalRequest":{"url":{"path":["automation-brain","diagrams",":diagramId","schedule"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"diagramId","description":"(Required) UUID of the workflow/diagram"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"active\": true,\n \"timezone\": \"Europe/Paris\",\n \"rules\": [\n {\n \"ruleId\": {\n \"value\": \"\"\n },\n \"actionType\": {\n \"value\": \"\"\n },\n \"repeatModel\": {\n \"value\": \"\"\n },\n \"listingAuthor\": {\n \"value\": \"\"\n },\n \"createdAt\": {\n \"value\": \"\"\n }\n },\n {\n \"ruleId\": {\n \"value\": \"\"\n },\n \"actionType\": {\n \"value\": \"\"\n },\n \"repeatModel\": {\n \"value\": \"\"\n },\n \"listingAuthor\": {\n \"value\": \"\"\n },\n \"createdAt\": {\n \"value\": \"\"\n }\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"73db5a0f-003c-434c-a6bf-fb46fff143c9","name":"See error message for details","originalRequest":{"url":{"path":["automation-brain","diagrams",":diagramId","schedule"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"diagramId","description":"(Required) UUID of the workflow/diagram"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"text/plain"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"string","cookie":[],"_postman_previewlanguage":"text"},{"id":"bc158984-d53c-4c3d-9658-9d2bdf8b18f7","name":"Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc.","originalRequest":{"url":{"path":["automation-brain","diagrams",":diagramId","schedule"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"diagramId","description":"(Required) UUID of the workflow/diagram"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\",\n \"status\": 2468,\n \"timestamp\": \"string\",\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"2de5cb18-b185-4c27-9567-da938b94085b","name":"Forbidden; insufficient permissions","originalRequest":{"url":{"path":["automation-brain","diagrams",":diagramId","schedule"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"diagramId","description":"(Required) UUID of the workflow/diagram"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\",\n \"status\": 2468,\n \"timestamp\": \"string\",\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"9a5d44eb-5315-4875-9b20-5a71c60a7131","name":"Resource not found","originalRequest":{"url":{"path":["automation-brain","diagrams",":diagramId","schedule"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"diagramId","description":"(Required) UUID of the workflow/diagram"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\",\n \"status\": 2468,\n \"timestamp\": \"string\",\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"e01414ed-119a-4ec8-bd39-d8bf8abacc5d","name":"Enable schedule for workflow","request":{"name":"Enable schedule for workflow","description":{"content":"Enable schedule for a workflow. The schedule must first be set with `POST /automation-brain/diagrams/{diagramId}/schedule`\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `AUTOMATON_BRAIN_DIAGRAM_EXECUTE`\n\n**User role permission required:** `automation_2_journeys: execute`\n","type":"text/plain"},"url":{"path":["automation-brain","diagrams",":diagramId","schedule-on"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"diagramId","description":"(Required) UUID of the workflow/diagram"}]},"header":[{"key":"Accept","value":"text/plain"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"4d74dee9-04be-4817-818f-5e3bd2cf341a","name":"Workflow scheduled or was already scheduled","originalRequest":{"url":{"path":["automation-brain","diagrams",":diagramId","schedule-on"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"diagramId","description":"(Required) UUID of the workflow/diagram"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"text/plain"}],"method":"POST","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"OK","cookie":[],"_postman_previewlanguage":"text"},{"id":"c65b9bbe-70a5-4a66-9778-dd4429323476","name":"See error message for details","originalRequest":{"url":{"path":["automation-brain","diagrams",":diagramId","schedule-on"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"diagramId","description":"(Required) UUID of the workflow/diagram"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"errorCode\": \"string\",\n \"httpStatus\": 512,\n \"message\": \"string\",\n \"timestamp\": \"1953-11-20T10:43:04.810Z\",\n \"help\": \"string\",\n \"traceId\": \"string\",\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"source\": {\n \"pointer\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"details\": {\n \"activeDiagrams\": {\n \"value\": \"\"\n }\n },\n \"field\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"e510608b-bcd4-46eb-bea0-1c4aac4e841c","name":"Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc.","originalRequest":{"url":{"path":["automation-brain","diagrams",":diagramId","schedule-on"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"diagramId","description":"(Required) UUID of the workflow/diagram"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\",\n \"status\": 2468,\n \"timestamp\": \"string\",\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"351f1a15-f71a-4c77-b478-1b19ed0a5a6a","name":"Forbidden; insufficient permissions","originalRequest":{"url":{"path":["automation-brain","diagrams",":diagramId","schedule-on"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"diagramId","description":"(Required) UUID of the workflow/diagram"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\",\n \"status\": 2468,\n \"timestamp\": \"string\",\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"62218e78-7b57-46d2-9a94-6c09ac4d4740","name":"Resource not found","originalRequest":{"url":{"path":["automation-brain","diagrams",":diagramId","schedule-on"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"diagramId","description":"(Required) UUID of the workflow/diagram"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\",\n \"status\": 2468,\n \"timestamp\": \"string\",\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"366a94eb-1f67-4a4a-8ff3-1ff9756a20b3","name":"Disable schedule for workflow","request":{"name":"Disable schedule for workflow","description":{"content":"Disable schedule for a workflow.\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `AUTOMATON_BRAIN_DIAGRAM_EXECUTE`\n\n**User role permission required:** `automation_2_journeys: execute`\n","type":"text/plain"},"url":{"path":["automation-brain","diagrams",":diagramId","schedule-off"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"diagramId","description":"(Required) UUID of the workflow/diagram"}]},"header":[{"key":"Accept","value":"text/plain"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"c7ea771b-b038-4505-9139-50af5eedf265","name":"Workflow unscheduled or was already unscheduled","originalRequest":{"url":{"path":["automation-brain","diagrams",":diagramId","schedule-off"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"diagramId","description":"(Required) UUID of the workflow/diagram"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"text/plain"}],"method":"POST","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"OK","cookie":[],"_postman_previewlanguage":"text"},{"id":"6ff33aa7-7eda-4717-b9cc-ac8e0b1b7a25","name":"See error message for details","originalRequest":{"url":{"path":["automation-brain","diagrams",":diagramId","schedule-off"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"diagramId","description":"(Required) UUID of the workflow/diagram"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"errorCode\": \"string\",\n \"httpStatus\": 512,\n \"message\": \"string\",\n \"timestamp\": \"1953-11-20T10:43:04.810Z\",\n \"help\": \"string\",\n \"traceId\": \"string\",\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"source\": {\n \"pointer\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"details\": {\n \"activeDiagrams\": {\n \"value\": \"\"\n }\n },\n \"field\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"1e457a40-0af6-4fe9-a35c-420a8f069a0e","name":"Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc.","originalRequest":{"url":{"path":["automation-brain","diagrams",":diagramId","schedule-off"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"diagramId","description":"(Required) UUID of the workflow/diagram"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\",\n \"status\": 2468,\n \"timestamp\": \"string\",\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"2c0014ee-84f3-4e53-ac82-aed620c89c7c","name":"Forbidden; insufficient permissions","originalRequest":{"url":{"path":["automation-brain","diagrams",":diagramId","schedule-off"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"diagramId","description":"(Required) UUID of the workflow/diagram"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\",\n \"status\": 2468,\n \"timestamp\": \"string\",\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"981231df-83a7-417b-8242-3cc9b6d9fc50","name":"Resource not found","originalRequest":{"url":{"path":["automation-brain","diagrams",":diagramId","schedule-off"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"string","key":"diagramId","description":"(Required) UUID of the workflow/diagram"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\",\n \"status\": 2468,\n \"timestamp\": \"string\",\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"ebddfa19-0fe3-45a8-9c3f-8bf8ffab2dae","name":"Get schedule execution events","request":{"name":"Get schedule execution events","description":{"content":"Get events (rule executions) that were already processed for the workflow. You can limit the list to a time range defined by `start` and `end`.\n\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `AUTOMATON_BRAIN_DIAGRAM_SCHEDULE_READ`\n\n**User role permission required:** `automation_2_journeys: read`\n","type":"text/plain"},"url":{"path":["automation-brain","diagrams",":diagramId","schedule-executed-events"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"start","value":"2008-02-12T03:58:30.166Z","description":"(Required) Start date"},{"disabled":false,"key":"end","value":"2008-02-12T03:58:30.166Z","description":"End date"}],"variable":[{"disabled":false,"type":"any","value":"string","key":"diagramId","description":"(Required) UUID of the workflow/diagram"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"df20b149-fb52-4822-9552-28a5c0d21447","name":"Executed schedule events","originalRequest":{"url":{"path":["automation-brain","diagrams",":diagramId","schedule-executed-events"],"host":["{{baseUrl}}"],"query":[{"key":"start","value":"2008-02-12T03:58:30.166Z"},{"key":"end","value":"2008-02-12T03:58:30.166Z"}],"variable":[{"disabled":false,"type":"any","value":"string","key":"diagramId","description":"(Required) UUID of the workflow/diagram"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"hasMore\": true,\n \"events\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"be98a4c0-9ca7-448d-b08d-eff906fc5c52","name":"See error message for details","originalRequest":{"url":{"path":["automation-brain","diagrams",":diagramId","schedule-executed-events"],"host":["{{baseUrl}}"],"query":[{"key":"start","value":"2008-02-12T03:58:30.166Z"},{"key":"end","value":"2008-02-12T03:58:30.166Z"}],"variable":[{"disabled":false,"type":"any","value":"string","key":"diagramId","description":"(Required) UUID of the workflow/diagram"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"errorCode\": \"string\",\n \"httpStatus\": 512,\n \"message\": \"string\",\n \"timestamp\": \"1953-11-20T10:43:04.810Z\",\n \"help\": \"string\",\n \"traceId\": \"string\",\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"source\": {\n \"pointer\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"details\": {\n \"activeDiagrams\": {\n \"value\": \"\"\n }\n },\n \"field\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"a0c9e78a-0ee6-49f9-9a4b-c3f00ed6cdbf","name":"Forbidden; insufficient permissions","originalRequest":{"url":{"path":["automation-brain","diagrams",":diagramId","schedule-executed-events"],"host":["{{baseUrl}}"],"query":[{"key":"start","value":"2008-02-12T03:58:30.166Z"},{"key":"end","value":"2008-02-12T03:58:30.166Z"}],"variable":[{"disabled":false,"type":"any","value":"string","key":"diagramId","description":"(Required) UUID of the workflow/diagram"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\",\n \"status\": 2468,\n \"timestamp\": \"string\",\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"c25f5f55-4d3b-4b3c-9658-4e3ab1204f2a","name":"Get upcoming schedule events","request":{"name":"Get upcoming schedule events","description":{"content":"Get a list of upcoming events (rule executions) caused by a schedule. You can limit the list to a time range defined by `start` and `end`.\n\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `AUTOMATON_BRAIN_DIAGRAM_SCHEDULE_READ`\n\n**User role permission required:** `automation_2_journeys: read`\n","type":"text/plain"},"url":{"path":["automation-brain","diagrams",":diagramId","schedule-upcoming-events"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"start","value":"2008-02-12T03:58:30.166Z","description":"Start date"},{"disabled":false,"key":"end","value":"2008-02-12T03:58:30.166Z","description":"End date"}],"variable":[{"disabled":false,"type":"any","value":"string","key":"diagramId","description":"(Required) UUID of the workflow/diagram"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"f32418fe-bfaa-485b-be45-f6b841e8b9ec","name":"Upcoming schedule events","originalRequest":{"url":{"path":["automation-brain","diagrams",":diagramId","schedule-upcoming-events"],"host":["{{baseUrl}}"],"query":[{"key":"start","value":"2008-02-12T03:58:30.166Z"},{"key":"end","value":"2008-02-12T03:58:30.166Z"}],"variable":[{"disabled":false,"type":"any","value":"string","key":"diagramId","description":"(Required) UUID of the workflow/diagram"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"hasMore\": true,\n \"events\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"5c3e9413-0dd8-4d22-b1ea-0575c429d9e6","name":"See error message for details","originalRequest":{"url":{"path":["automation-brain","diagrams",":diagramId","schedule-upcoming-events"],"host":["{{baseUrl}}"],"query":[{"key":"start","value":"2008-02-12T03:58:30.166Z"},{"key":"end","value":"2008-02-12T03:58:30.166Z"}],"variable":[{"disabled":false,"type":"any","value":"string","key":"diagramId","description":"(Required) UUID of the workflow/diagram"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"errorCode\": \"string\",\n \"httpStatus\": 512,\n \"message\": \"string\",\n \"timestamp\": \"1953-11-20T10:43:04.810Z\",\n \"help\": \"string\",\n \"traceId\": \"string\",\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"source\": {\n \"pointer\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"details\": {\n \"activeDiagrams\": {\n \"value\": \"\"\n }\n },\n \"field\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"545946bd-b785-42ac-a762-c2c588fea7f9","name":"Forbidden; insufficient permissions","originalRequest":{"url":{"path":["automation-brain","diagrams",":diagramId","schedule-upcoming-events"],"host":["{{baseUrl}}"],"query":[{"key":"start","value":"2008-02-12T03:58:30.166Z"},{"key":"end","value":"2008-02-12T03:58:30.166Z"}],"variable":[{"disabled":false,"type":"any","value":"string","key":"diagramId","description":"(Required) UUID of the workflow/diagram"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\",\n \"status\": 2468,\n \"timestamp\": \"string\",\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"e5362fdb-ac34-48b2-978c-860414233941","name":"Get upcoming workflow status changes","request":{"name":"Get upcoming workflow status changes","description":{"content":"Get upcoming status changes for a workflow. You can limit the list to a time range defined by `start` and `end`.\n\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `AUTOMATON_BRAIN_DIAGRAM_SCHEDULE_READ`\n\n**User role permission required:** `automation_2_journeys: read`\n","type":"text/plain"},"url":{"path":["automation-brain","diagrams",":diagramId","upcoming-status-changes"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"initialStatus","value":"string","description":"Initial status used if diagramId is not present (default: Pending)"},{"disabled":false,"key":"start","value":"2008-02-12T03:58:30.166Z","description":"Start date"},{"disabled":false,"key":"end","value":"2008-02-12T03:58:30.166Z","description":"End date"}],"variable":[{"disabled":false,"type":"any","value":"string","key":"diagramId","description":"(Required) UUID of the workflow/diagram"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"7aa2483e-5159-458e-af1f-2130eda56f34","name":"Upcoming status changes","originalRequest":{"url":{"path":["automation-brain","diagrams",":diagramId","upcoming-status-changes"],"host":["{{baseUrl}}"],"query":[{"key":"initialStatus","value":"string"},{"key":"start","value":"2008-02-12T03:58:30.166Z"},{"key":"end","value":"2008-02-12T03:58:30.166Z"}],"variable":[{"disabled":false,"type":"any","value":"string","key":"diagramId","description":"(Required) UUID of the workflow/diagram"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"hasMore\": true,\n \"events\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"88ddab9a-a89c-4224-adc5-4a1f72c2ee1d","name":"See error message for details","originalRequest":{"url":{"path":["automation-brain","diagrams",":diagramId","upcoming-status-changes"],"host":["{{baseUrl}}"],"query":[{"key":"initialStatus","value":"string"},{"key":"start","value":"2008-02-12T03:58:30.166Z"},{"key":"end","value":"2008-02-12T03:58:30.166Z"}],"variable":[{"disabled":false,"type":"any","value":"string","key":"diagramId","description":"(Required) UUID of the workflow/diagram"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"errorCode\": \"string\",\n \"httpStatus\": 512,\n \"message\": \"string\",\n \"timestamp\": \"1953-11-20T10:43:04.810Z\",\n \"help\": \"string\",\n \"traceId\": \"string\",\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"source\": {\n \"pointer\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"details\": {\n \"activeDiagrams\": {\n \"value\": \"\"\n }\n },\n \"field\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"0c024474-6aa9-4514-9042-091da54bd003","name":"Forbidden; insufficient permissions","originalRequest":{"url":{"path":["automation-brain","diagrams",":diagramId","upcoming-status-changes"],"host":["{{baseUrl}}"],"query":[{"key":"initialStatus","value":"string"},{"key":"start","value":"2008-02-12T03:58:30.166Z"},{"key":"end","value":"2008-02-12T03:58:30.166Z"}],"variable":[{"disabled":false,"type":"any","value":"string","key":"diagramId","description":"(Required) UUID of the workflow/diagram"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\",\n \"status\": 2468,\n \"timestamp\": \"string\",\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}],"event":[]},{"id":"9f893574-98ae-4461-866b-870f1717b448","name":"Control Center","description":{"content":"","type":"text/plain"},"item":[{"id":"78c9cb9c-25ed-471b-8c31-3032fadbc714","name":"Count workflows by trigger type","request":{"name":"Count workflows by trigger type","description":{"content":"Returns the count of active workflows grouped by trigger node type for the current workspace.\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `AUTOMATON_BRAIN_DIAGRAM_LIST_READ`\n\n**User role permission required:** `automation_2_journeys: read`\n","type":"text/plain"},"url":{"path":["automation-brain","dashboard","diagrams","count-by-trigger-type"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"9dc36e7a-d86c-4601-ac50-8e50dddd4fc4","name":"Workflow counts by trigger type","originalRequest":{"url":{"path":["automation-brain","dashboard","diagrams","count-by-trigger-type"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"counts\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"total\": 55\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"f06e59b9-3af9-4b16-a6b5-decaa6eec2b8","name":"See error message for details","originalRequest":{"url":{"path":["automation-brain","dashboard","diagrams","count-by-trigger-type"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"errorCode\": \"string\",\n \"httpStatus\": 8281,\n \"message\": \"string\",\n \"timestamp\": \"2011-03-18T22:11:05.427Z\",\n \"help\": \"string\",\n \"traceId\": \"string\",\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"source\": {\n \"pointer\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"details\": {\n \"activeDiagrams\": {\n \"value\": \"\"\n },\n \"key_0\": {\n \"value\": \"\"\n }\n },\n \"field\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"9b94c408-9125-44da-92be-c2b90d32ba06","name":"Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc.","originalRequest":{"url":{"path":["automation-brain","dashboard","diagrams","count-by-trigger-type"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\",\n \"status\": 2468,\n \"timestamp\": \"string\",\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"f7a8f5e6-c37c-481f-b6af-3b6b0402d7b6","name":"Forbidden; insufficient permissions","originalRequest":{"url":{"path":["automation-brain","dashboard","diagrams","count-by-trigger-type"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\",\n \"status\": 2468,\n \"timestamp\": \"string\",\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"e37e45aa-63a5-4cec-ac20-2bcd8ebf979a","name":"Count workflows by status","request":{"name":"Count workflows by status","description":{"content":"Returns the count of workflows grouped by status for the current workspace.\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `AUTOMATON_BRAIN_DIAGRAM_LIST_READ`\n\n**User role permission required:** `automation_2_journeys: read`\n","type":"text/plain"},"url":{"path":["automation-brain","dashboard","diagrams","count-by-status"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"c60e9ca1-a96c-4d4a-a12a-5e2a1652bd14","name":"Workflow counts by status","originalRequest":{"url":{"path":["automation-brain","dashboard","diagrams","count-by-status"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"counts\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"total\": 70\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"749f5715-88f5-4639-8a3d-45d55f1d0828","name":"See error message for details","originalRequest":{"url":{"path":["automation-brain","dashboard","diagrams","count-by-status"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"errorCode\": \"string\",\n \"httpStatus\": 512,\n \"message\": \"string\",\n \"timestamp\": \"1953-11-20T10:43:04.810Z\",\n \"help\": \"string\",\n \"traceId\": \"string\",\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"source\": {\n \"pointer\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"details\": {\n \"activeDiagrams\": {\n \"value\": \"\"\n }\n },\n \"field\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"b990ab2c-c2a4-4511-affb-14683597f6af","name":"Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc.","originalRequest":{"url":{"path":["automation-brain","dashboard","diagrams","count-by-status"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\",\n \"status\": 2468,\n \"timestamp\": \"string\",\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"fd861f6a-7c74-43a0-b4e8-c85e5f39dadb","name":"Forbidden; insufficient permissions","originalRequest":{"url":{"path":["automation-brain","dashboard","diagrams","count-by-status"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\",\n \"status\": 2468,\n \"timestamp\": \"string\",\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"7cef4004-3a76-4440-aea6-141c03fff97a","name":"Get most used workflows","request":{"name":"Get most used workflows","description":{"content":"Returns a paginated list of workflows ordered by the number of data points (events) generated by those workflows.\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `AUTOMATON_BRAIN_DIAGRAM_LIST_READ`\n\n**User role permission required:** `automation_2_journeys: read`\n","type":"text/plain"},"url":{"path":["automation-brain","dashboard","diagrams","most-used"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"page","value":"1","description":"The selected page"},{"disabled":false,"key":"limit","value":"10","description":"Number of items per page"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"cc2e0706-e3aa-4f9e-8695-c292ea4a5d7f","name":"A page of most used workflows","originalRequest":{"url":{"path":["automation-brain","dashboard","diagrams","most-used"],"host":["{{baseUrl}}"],"query":[{"key":"page","value":"1"},{"key":"limit","value":"10"}],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"data\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"meta\": {\n \"limit\": {\n \"value\": \"\"\n },\n \"links\": {\n \"value\": \"\"\n }\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"9b485978-af19-404c-a8ac-a59bfbab7ef0","name":"See error message for details","originalRequest":{"url":{"path":["automation-brain","dashboard","diagrams","most-used"],"host":["{{baseUrl}}"],"query":[{"key":"page","value":"1"},{"key":"limit","value":"10"}],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"errorCode\": \"string\",\n \"httpStatus\": 512,\n \"message\": \"string\",\n \"timestamp\": \"1953-11-20T10:43:04.810Z\",\n \"help\": \"string\",\n \"traceId\": \"string\",\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"source\": {\n \"pointer\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"details\": {\n \"activeDiagrams\": {\n \"value\": \"\"\n }\n },\n \"field\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"1f782ae9-e7bf-4d99-8e91-576936b9d901","name":"Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc.","originalRequest":{"url":{"path":["automation-brain","dashboard","diagrams","most-used"],"host":["{{baseUrl}}"],"query":[{"key":"page","value":"1"},{"key":"limit","value":"10"}],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\",\n \"status\": 2468,\n \"timestamp\": \"string\",\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"b8964b89-4dfd-46b0-8950-67bf03a58852","name":"Forbidden; insufficient permissions","originalRequest":{"url":{"path":["automation-brain","dashboard","diagrams","most-used"],"host":["{{baseUrl}}"],"query":[{"key":"page","value":"1"},{"key":"limit","value":"10"}],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\",\n \"status\": 2468,\n \"timestamp\": \"string\",\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"fb73f215-eafa-4afd-a000-93451ad598ba","name":"Get most triggered workflows","request":{"name":"Get most triggered workflows","description":{"content":"Returns a paginated list of workflows ordered by the number of triggered paths.\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `AUTOMATON_BRAIN_DIAGRAM_LIST_READ`\n\n**User role permission required:** `automation_2_journeys: read`\n","type":"text/plain"},"url":{"path":["automation-brain","dashboard","diagrams","most-triggered"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"page","value":"1","description":"The selected page"},{"disabled":false,"key":"limit","value":"10","description":"Number of items per page"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"48517f24-1dcf-4d91-923a-a243a9137905","name":"A page of most triggered workflows","originalRequest":{"url":{"path":["automation-brain","dashboard","diagrams","most-triggered"],"host":["{{baseUrl}}"],"query":[{"key":"page","value":"1"},{"key":"limit","value":"10"}],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"data\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"meta\": {\n \"limit\": {\n \"value\": \"\"\n },\n \"links\": {\n \"value\": \"\"\n }\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"e835665b-8f52-4630-b9a1-cc10f51df824","name":"See error message for details","originalRequest":{"url":{"path":["automation-brain","dashboard","diagrams","most-triggered"],"host":["{{baseUrl}}"],"query":[{"key":"page","value":"1"},{"key":"limit","value":"10"}],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"errorCode\": \"string\",\n \"httpStatus\": 512,\n \"message\": \"string\",\n \"timestamp\": \"1953-11-20T10:43:04.810Z\",\n \"help\": \"string\",\n \"traceId\": \"string\",\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"source\": {\n \"pointer\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"details\": {\n \"activeDiagrams\": {\n \"value\": \"\"\n }\n },\n \"field\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"679c1ba7-18bc-4cec-9cb4-a783fccb04b0","name":"Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc.","originalRequest":{"url":{"path":["automation-brain","dashboard","diagrams","most-triggered"],"host":["{{baseUrl}}"],"query":[{"key":"page","value":"1"},{"key":"limit","value":"10"}],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\",\n \"status\": 2468,\n \"timestamp\": \"string\",\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"79a31e4f-dccb-4d27-97a4-ff02bc5a9908","name":"Forbidden; insufficient permissions","originalRequest":{"url":{"path":["automation-brain","dashboard","diagrams","most-triggered"],"host":["{{baseUrl}}"],"query":[{"key":"page","value":"1"},{"key":"limit","value":"10"}],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\",\n \"status\": 2468,\n \"timestamp\": \"string\",\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"e2fa9102-4280-43c5-a401-edc374e060a0","name":"Get workflows with paths in progress","request":{"name":"Get workflows with paths in progress","description":{"content":"Returns a paginated list of workflows ordered by the number of paths currently in progress.\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `AUTOMATON_BRAIN_DIAGRAM_LIST_READ`\n\n**User role permission required:** `automation_2_journeys: read`\n","type":"text/plain"},"url":{"path":["automation-brain","dashboard","diagrams","in-progress"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"page","value":"1","description":"The selected page"},{"disabled":false,"key":"limit","value":"10","description":"Number of items per page"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"d9dc8b6c-40dc-4ed8-870d-0a088a1a730a","name":"A page of workflows with paths in progress","originalRequest":{"url":{"path":["automation-brain","dashboard","diagrams","in-progress"],"host":["{{baseUrl}}"],"query":[{"key":"page","value":"1"},{"key":"limit","value":"10"}],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"data\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"meta\": {\n \"limit\": {\n \"value\": \"\"\n },\n \"links\": {\n \"value\": \"\"\n }\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"9bcdfd26-e1ee-4e2a-90ea-2af1c22b08a4","name":"See error message for details","originalRequest":{"url":{"path":["automation-brain","dashboard","diagrams","in-progress"],"host":["{{baseUrl}}"],"query":[{"key":"page","value":"1"},{"key":"limit","value":"10"}],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"errorCode\": \"string\",\n \"httpStatus\": 512,\n \"message\": \"string\",\n \"timestamp\": \"1953-11-20T10:43:04.810Z\",\n \"help\": \"string\",\n \"traceId\": \"string\",\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"source\": {\n \"pointer\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"details\": {\n \"activeDiagrams\": {\n \"value\": \"\"\n }\n },\n \"field\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"e6ef3174-0324-40e8-abc8-e163c2e86a0b","name":"Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc.","originalRequest":{"url":{"path":["automation-brain","dashboard","diagrams","in-progress"],"host":["{{baseUrl}}"],"query":[{"key":"page","value":"1"},{"key":"limit","value":"10"}],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\",\n \"status\": 2468,\n \"timestamp\": \"string\",\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"40069741-7703-4b17-9290-f98f425f985d","name":"Forbidden; insufficient permissions","originalRequest":{"url":{"path":["automation-brain","dashboard","diagrams","in-progress"],"host":["{{baseUrl}}"],"query":[{"key":"page","value":"1"},{"key":"limit","value":"10"}],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\",\n \"status\": 2468,\n \"timestamp\": \"string\",\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"d6c444de-a4a5-4148-bae0-8bcd3e54378e","name":"Get upcoming status changes","request":{"name":"Get upcoming status changes","description":{"content":"Returns a paginated list of upcoming workflow status changes (resumes, pauses, and stops).\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `AUTOMATON_BRAIN_DIAGRAM_LIST_READ`\n\n**User role permission required:** `automation_2_journeys: read`\n","type":"text/plain"},"url":{"path":["automation-brain","dashboard","upcoming-status-changes"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"page","value":"1","description":"The selected page"},{"disabled":false,"key":"limit","value":"10","description":"Number of items per page"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"8da5a647-a297-4f7d-88f6-58e0ff212440","name":"A page of upcoming status changes","originalRequest":{"url":{"path":["automation-brain","dashboard","upcoming-status-changes"],"host":["{{baseUrl}}"],"query":[{"key":"page","value":"1"},{"key":"limit","value":"10"}],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"data\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"meta\": {\n \"limit\": {\n \"value\": \"\"\n },\n \"links\": {\n \"value\": \"\"\n }\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"2085a419-6d0a-4b5c-bf65-6c13ecc68a0b","name":"See error message for details","originalRequest":{"url":{"path":["automation-brain","dashboard","upcoming-status-changes"],"host":["{{baseUrl}}"],"query":[{"key":"page","value":"1"},{"key":"limit","value":"10"}],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"errorCode\": \"string\",\n \"httpStatus\": 512,\n \"message\": \"string\",\n \"timestamp\": \"1953-11-20T10:43:04.810Z\",\n \"help\": \"string\",\n \"traceId\": \"string\",\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"source\": {\n \"pointer\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"details\": {\n \"activeDiagrams\": {\n \"value\": \"\"\n }\n },\n \"field\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"30a82ca4-4a42-4b5e-a263-7f1ad2f21965","name":"Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc.","originalRequest":{"url":{"path":["automation-brain","dashboard","upcoming-status-changes"],"host":["{{baseUrl}}"],"query":[{"key":"page","value":"1"},{"key":"limit","value":"10"}],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\",\n \"status\": 2468,\n \"timestamp\": \"string\",\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"a8a12b91-1413-49bf-ba02-d2a658f12897","name":"Forbidden; insufficient permissions","originalRequest":{"url":{"path":["automation-brain","dashboard","upcoming-status-changes"],"host":["{{baseUrl}}"],"query":[{"key":"page","value":"1"},{"key":"limit","value":"10"}],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\",\n \"status\": 2468,\n \"timestamp\": \"string\",\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"ea375d3d-47fa-4f27-876e-d721af00974e","name":"Get upcoming trigger events","request":{"name":"Get upcoming trigger events","description":{"content":"Returns a paginated list of upcoming trigger events for workflows with active scheduled triggers.\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `AUTOMATON_BRAIN_DIAGRAM_LIST_READ`\n\n**User role permission required:** `automation_2_journeys: read`\n","type":"text/plain"},"url":{"path":["automation-brain","dashboard","upcoming-triggers"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"page","value":"1","description":"The selected page"},{"disabled":false,"key":"limit","value":"10","description":"Number of items per page"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"7bee2846-dc81-4a4a-ba3b-1afdd37f4952","name":"A page of upcoming trigger events","originalRequest":{"url":{"path":["automation-brain","dashboard","upcoming-triggers"],"host":["{{baseUrl}}"],"query":[{"key":"page","value":"1"},{"key":"limit","value":"10"}],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"data\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"meta\": {\n \"limit\": {\n \"value\": \"\"\n },\n \"links\": {\n \"value\": \"\"\n }\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"87393b7d-a955-494f-a12c-1994d5206537","name":"See error message for details","originalRequest":{"url":{"path":["automation-brain","dashboard","upcoming-triggers"],"host":["{{baseUrl}}"],"query":[{"key":"page","value":"1"},{"key":"limit","value":"10"}],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"errorCode\": \"string\",\n \"httpStatus\": 512,\n \"message\": \"string\",\n \"timestamp\": \"1953-11-20T10:43:04.810Z\",\n \"help\": \"string\",\n \"traceId\": \"string\",\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"source\": {\n \"pointer\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"details\": {\n \"activeDiagrams\": {\n \"value\": \"\"\n }\n },\n \"field\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"17dc102e-826c-46e3-b1a0-f63aa0dd0be3","name":"Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc.","originalRequest":{"url":{"path":["automation-brain","dashboard","upcoming-triggers"],"host":["{{baseUrl}}"],"query":[{"key":"page","value":"1"},{"key":"limit","value":"10"}],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\",\n \"status\": 2468,\n \"timestamp\": \"string\",\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"f60089e8-6bcc-4d36-8967-dc8a9cd26fda","name":"Forbidden; insufficient permissions","originalRequest":{"url":{"path":["automation-brain","dashboard","upcoming-triggers"],"host":["{{baseUrl}}"],"query":[{"key":"page","value":"1"},{"key":"limit","value":"10"}],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\",\n \"status\": 2468,\n \"timestamp\": \"string\",\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"8dfae850-8446-4d5a-b500-f95e70e127df","name":"Get workflows with issues","request":{"name":"Get workflows with issues","description":{"content":"Returns a paginated list of workflows that have encountered failures, ordered by failure count.\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `AUTOMATON_BRAIN_DIAGRAM_LIST_READ`\n\n**User role permission required:** `automation_2_journeys: read`\n","type":"text/plain"},"url":{"path":["automation-brain","dashboard","diagrams","with-issues"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"timePeriod","value":"24h","description":"Time period for statistics"},{"disabled":false,"key":"context","value":"Client","description":"AutomationContext for which workflows should be returned"},{"disabled":false,"key":"page","value":"1","description":"The selected page"},{"disabled":false,"key":"limit","value":"10","description":"Number of items per page"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"191ecb12-819f-4481-939d-9638f22cf5e3","name":"A page of workflows with issues","originalRequest":{"url":{"path":["automation-brain","dashboard","diagrams","with-issues"],"host":["{{baseUrl}}"],"query":[{"key":"timePeriod","value":"24h"},{"key":"context","value":"Client"},{"key":"page","value":"1"},{"key":"limit","value":"10"}],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"data\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"meta\": {\n \"limit\": {\n \"value\": \"\"\n },\n \"links\": {\n \"value\": \"\"\n }\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"8b1a1468-5401-4461-ae38-648c61ba6e5a","name":"See error message for details","originalRequest":{"url":{"path":["automation-brain","dashboard","diagrams","with-issues"],"host":["{{baseUrl}}"],"query":[{"key":"timePeriod","value":"24h"},{"key":"context","value":"Client"},{"key":"page","value":"1"},{"key":"limit","value":"10"}],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"errorCode\": \"string\",\n \"httpStatus\": 512,\n \"message\": \"string\",\n \"timestamp\": \"1953-11-20T10:43:04.810Z\",\n \"help\": \"string\",\n \"traceId\": \"string\",\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"source\": {\n \"pointer\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"details\": {\n \"activeDiagrams\": {\n \"value\": \"\"\n }\n },\n \"field\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"b1f8080f-b689-4624-af94-63612a8f6ac9","name":"Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc.","originalRequest":{"url":{"path":["automation-brain","dashboard","diagrams","with-issues"],"host":["{{baseUrl}}"],"query":[{"key":"timePeriod","value":"24h"},{"key":"context","value":"Client"},{"key":"page","value":"1"},{"key":"limit","value":"10"}],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\",\n \"status\": 2468,\n \"timestamp\": \"string\",\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"1b0da6dc-112b-4dfe-8769-23d56f1d5aa6","name":"Forbidden; insufficient permissions","originalRequest":{"url":{"path":["automation-brain","dashboard","diagrams","with-issues"],"host":["{{baseUrl}}"],"query":[{"key":"timePeriod","value":"24h"},{"key":"context","value":"Client"},{"key":"page","value":"1"},{"key":"limit","value":"10"}],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\",\n \"status\": 2468,\n \"timestamp\": \"string\",\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"d5641a6e-df44-48d8-9122-4b9b8b41c307","name":"Get workflows with failing jobs","request":{"name":"Get workflows with failing jobs","description":{"content":"Returns a paginated list of workflows that had failing jobs in the given time period. Counts are per job, so a journey with several failed blocks counts each of them. Results are ordered worst-first (failedCount descending, then warningCount descending).\n\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `AUTOMATON_BRAIN_DIAGRAM_LIST_READ`\n\n**User role permission required:** `automation_2_journeys: read`\n","type":"text/plain"},"url":{"path":["automation-brain","dashboard","diagrams","failing-jobs"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"timePeriod","value":"24h","description":"Time period for statistics"},{"disabled":false,"key":"page","value":"1","description":"The selected page"},{"disabled":false,"key":"limit","value":"10","description":"Number of items per page"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"d5602fb3-7aec-4592-a08f-7820172d0cca","name":"A page of workflows with failing jobs","originalRequest":{"url":{"path":["automation-brain","dashboard","diagrams","failing-jobs"],"host":["{{baseUrl}}"],"query":[{"key":"timePeriod","value":"24h"},{"key":"page","value":"1"},{"key":"limit","value":"10"}],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"data\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"meta\": {\n \"limit\": {\n \"value\": \"\"\n },\n \"links\": {\n \"value\": \"\"\n }\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"74bba619-ba3e-49a8-83bf-d66ab07b665c","name":"See error message for details","originalRequest":{"url":{"path":["automation-brain","dashboard","diagrams","failing-jobs"],"host":["{{baseUrl}}"],"query":[{"key":"timePeriod","value":"24h"},{"key":"page","value":"1"},{"key":"limit","value":"10"}],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"errorCode\": \"string\",\n \"httpStatus\": 512,\n \"message\": \"string\",\n \"timestamp\": \"1953-11-20T10:43:04.810Z\",\n \"help\": \"string\",\n \"traceId\": \"string\",\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"source\": {\n \"pointer\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"details\": {\n \"activeDiagrams\": {\n \"value\": \"\"\n }\n },\n \"field\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"5cb4b79b-259f-4bd3-9820-22af24b6ce3f","name":"Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc.","originalRequest":{"url":{"path":["automation-brain","dashboard","diagrams","failing-jobs"],"host":["{{baseUrl}}"],"query":[{"key":"timePeriod","value":"24h"},{"key":"page","value":"1"},{"key":"limit","value":"10"}],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\",\n \"status\": 2468,\n \"timestamp\": \"string\",\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"58e0f784-a998-40fb-a4b2-b80f2983d6f8","name":"Forbidden; insufficient permissions","originalRequest":{"url":{"path":["automation-brain","dashboard","diagrams","failing-jobs"],"host":["{{baseUrl}}"],"query":[{"key":"timePeriod","value":"24h"},{"key":"page","value":"1"},{"key":"limit","value":"10"}],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\",\n \"status\": 2468,\n \"timestamp\": \"string\",\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}],"event":[]},{"id":"c49ae40c-7157-4744-b6a2-d703c6ebe008","name":"Data Processing Job Logs","description":{"content":"","type":"text/plain"},"item":[{"id":"7b850efc-97e9-4bdc-a194-13c5b7ec2355","name":"Get last log with stages","request":{"name":"Get last log with stages","description":{"content":"\nRetrieve the status of a workflow's last run and its stages.\n\nThe workflow must contain at least one of the following nodes:\n- Any Data Transformation node\n- Any node that pulls data into a workflow (for example local file, SFTP, Azure Blob Storage)\n- Any node that pushes data out of the workflow (for example SFTP, Pub/Sub)\n- Any node that imports data into Synerise\n\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `MORPH_JOBS_READ`\n\n**User role permission required:** `automation_2_journeys: read`\n","type":"text/plain"},"url":{"path":["morph","logs","automation",":automationWorkflowId","last-run","with-stages"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"limit","value":"500","description":"The maximum number of log lines in each stage"}],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"automationWorkflowId","description":"(Required) `diagramId` of the workflow to fetch last job from"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"0f46fba6-57a8-418c-adc6-0743970b60eb","name":"Information about last data transformation journey status","originalRequest":{"url":{"path":["morph","logs","automation",":automationWorkflowId","last-run","with-stages"],"host":["{{baseUrl}}"],"query":[{"key":"limit","value":"500"}],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"automationWorkflowId","description":"(Required) `diagramId` of the workflow to fetch last job from"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"startTime\": \"2023-09-05T14:07:44.264Z\",\n \"pipelineResponse\": {\n \"importData\": {\n \"value\": \"\"\n },\n \"transformData\": {\n \"value\": \"\"\n },\n \"exportData\": {\n \"value\": \"\"\n }\n },\n \"overallRunStatus\": \"Pending\",\n \"runId\": \"eb9072e7-254e-5081-5a9c-f4b703a23c86\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"24902238-d3e3-431a-8512-5aec22791932","name":"Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc.","originalRequest":{"url":{"path":["morph","logs","automation",":automationWorkflowId","last-run","with-stages"],"host":["{{baseUrl}}"],"query":[{"key":"limit","value":"500"}],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"automationWorkflowId","description":"(Required) `diagramId` of the workflow to fetch last job from"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\",\n \"status\": 4768,\n \"timestamp\": \"string\",\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"48802929-ecd8-4bb1-8218-69b4f3f38641","name":"Forbidden; insufficient permissions","originalRequest":{"url":{"path":["morph","logs","automation",":automationWorkflowId","last-run","with-stages"],"host":["{{baseUrl}}"],"query":[{"key":"limit","value":"500"}],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"automationWorkflowId","description":"(Required) `diagramId` of the workflow to fetch last job from"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\",\n \"status\": 4768,\n \"timestamp\": \"string\",\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"5d6132cc-0524-42f6-9404-bd83ea783d3f","name":"- workflow doesn't exist; \n- no journeys exist for a workflow; \n- workflow doesn't contain any of the required nodes (returns a \"no journeys found\" error)\n","originalRequest":{"url":{"path":["morph","logs","automation",":automationWorkflowId","last-run","with-stages"],"host":["{{baseUrl}}"],"query":[{"key":"limit","value":"500"}],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"automationWorkflowId","description":"(Required) `diagramId` of the workflow to fetch last job from"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"Not found\",\n \"status\": 404,\n \"timestamp\": \"2023-09-06T11:54:08.564Z\",\n \"message\": \"No journeys for diagram fe7e3a80-91bb-433a-94cf-744253cc442c found\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}],"event":[]},{"id":"c73f9b1a-04b9-4c19-8987-5c6bfc1420b5","name":"Consumption","description":{"content":"","type":"text/plain"},"item":[{"id":"e2e13f0a-4df2-4f5b-a898-129fca6bdeff","name":"Get consumption metric with new data points","request":{"name":"Get consumption metric with new data points","description":{"content":"Retrieve the number of new events (events added to the database on a particular day), listed by day. You can limit the metric to particular workspaces and event types (actions).\n\n---\n\n**API consumers:** Synerise User, Organization\n","type":"text/plain"},"url":{"path":["business-profile-service","organizations","usage","stats","newDataPoints"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"from\": \"2025-05-29\",\n \"to\": \"2025-05-30\",\n \"actions\": [\n \"page.visit\",\n \"page.visit\"\n ],\n \"bpGuids\": [\n \"34eea35e-3ac4-44f4-95b5-fd00a3b45eff\",\n \"34eea35e-3ac4-44f4-95b5-fd00a3b45eff\"\n ]\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"12ea0d17-0523-4fef-b005-a90049512475","name":"Statistics of new events for the specified date range","originalRequest":{"url":{"path":["business-profile-service","organizations","usage","stats","newDataPoints"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"from\": \"2025-05-29\",\n \"to\": \"2025-05-30\",\n \"actions\": [\n \"page.visit\",\n \"page.visit\"\n ],\n \"bpGuids\": [\n \"34eea35e-3ac4-44f4-95b5-fd00a3b45eff\",\n \"34eea35e-3ac4-44f4-95b5-fd00a3b45eff\"\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"[\n {\n \"dailyUsageStatistics\": {\n \"value\": \"\"\n },\n \"eventsTotal\": {\n \"value\": \"\"\n },\n \"totalAll\": {\n \"value\": \"\"\n },\n \"totalOther\": {\n \"value\": \"\"\n },\n \"totalWeight\": {\n \"value\": \"\"\n },\n \"averageWeight\": {\n \"value\": \"\"\n }\n },\n {\n \"dailyUsageStatistics\": {\n \"value\": \"\"\n },\n \"eventsTotal\": {\n \"value\": \"\"\n },\n \"totalAll\": {\n \"value\": \"\"\n },\n \"totalOther\": {\n \"value\": \"\"\n },\n \"totalWeight\": {\n \"value\": \"\"\n },\n \"averageWeight\": {\n \"value\": \"\"\n }\n }\n]","cookie":[],"_postman_previewlanguage":"json"},{"id":"be12e9ca-f2c9-4200-86e7-cadf66d33509","name":"Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc.","originalRequest":{"url":{"path":["business-profile-service","organizations","usage","stats","newDataPoints"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"from\": \"2025-05-29\",\n \"to\": \"2025-05-30\",\n \"actions\": [\n \"page.visit\",\n \"page.visit\"\n ],\n \"bpGuids\": [\n \"34eea35e-3ac4-44f4-95b5-fd00a3b45eff\",\n \"34eea35e-3ac4-44f4-95b5-fd00a3b45eff\"\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"status\": 6534,\n \"error\": \"string\",\n \"message\": \"string\",\n \"timestamp\": \"1948-12-15T13:36:47.872Z\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"2aae3a85-9d21-4118-b02f-eb458ec61ce6","name":"Unauthorized: insufficient permissions.","originalRequest":{"url":{"path":["business-profile-service","organizations","usage","stats","newDataPoints"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"from\": \"2025-05-29\",\n \"to\": \"2025-05-30\",\n \"actions\": [\n \"page.visit\",\n \"page.visit\"\n ],\n \"bpGuids\": [\n \"34eea35e-3ac4-44f4-95b5-fd00a3b45eff\",\n \"34eea35e-3ac4-44f4-95b5-fd00a3b45eff\"\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"status\": 6534,\n \"error\": \"string\",\n \"message\": \"string\",\n \"timestamp\": \"1948-12-15T13:36:47.872Z\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"54b6e740-e4a6-4ca7-819d-763461a67501","name":"Request failed. See response for details.","originalRequest":{"url":{"path":["business-profile-service","organizations","usage","stats","newDataPoints"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"from\": \"2025-05-29\",\n \"to\": \"2025-05-30\",\n \"actions\": [\n \"page.visit\",\n \"page.visit\"\n ],\n \"bpGuids\": [\n \"34eea35e-3ac4-44f4-95b5-fd00a3b45eff\",\n \"34eea35e-3ac4-44f4-95b5-fd00a3b45eff\"\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"message\": \"string\",\n \"timestamp\": \"1977-04-05T04:12:13.040Z\",\n \"httpStatus\": 2887,\n \"errorCode\": \"string\",\n \"traceId\": \"string\",\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"c8891607-8b05-4695-b6cf-04621cc2d404","name":"Get consumption metric with retention data points","request":{"name":"Get consumption metric with retention data points","description":{"content":"Retrieve the number of events kept in the database, listed by day. This includes events saved in the past, which currently exist in the database according to their retention period. \n\nYou can limit the metric to particular workspaces and event types (actions).\n\n\n---\n\n**API consumers:** Synerise User, Organization\n","type":"text/plain"},"url":{"path":["business-profile-service","organizations","usage","stats","retentionDataPoints"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"from\": \"2025-05-29\",\n \"to\": \"2025-05-30\",\n \"actions\": [\n \"page.visit\",\n \"page.visit\"\n ],\n \"bpGuids\": [\n \"34eea35e-3ac4-44f4-95b5-fd00a3b45eff\",\n \"34eea35e-3ac4-44f4-95b5-fd00a3b45eff\"\n ]\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"33f0e291-6e97-4462-931f-79693c90d502","name":"Statistics of retention events for the specified date range","originalRequest":{"url":{"path":["business-profile-service","organizations","usage","stats","retentionDataPoints"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"from\": \"2025-05-29\",\n \"to\": \"2025-05-30\",\n \"actions\": [\n \"page.visit\",\n \"page.visit\"\n ],\n \"bpGuids\": [\n \"34eea35e-3ac4-44f4-95b5-fd00a3b45eff\",\n \"34eea35e-3ac4-44f4-95b5-fd00a3b45eff\"\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"dailyUsageStatistics\": {\n \"day\": {\n \"value\": \"\"\n },\n \"events\": {\n \"value\": \"\"\n },\n \"other\": {\n \"value\": \"\"\n },\n \"total\": {\n \"value\": \"\"\n },\n \"totalWeight\": {\n \"value\": \"\"\n },\n \"weights\": {\n \"value\": \"\"\n }\n },\n \"eventsAverage\": {\n \"key_0\": 1390\n },\n \"averageAll\": 8364,\n \"averageOther\": 7028\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"3f16f19a-2dae-4b89-8bce-3beda8701442","name":"Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc.","originalRequest":{"url":{"path":["business-profile-service","organizations","usage","stats","retentionDataPoints"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"from\": \"2025-05-29\",\n \"to\": \"2025-05-30\",\n \"actions\": [\n \"page.visit\",\n \"page.visit\"\n ],\n \"bpGuids\": [\n \"34eea35e-3ac4-44f4-95b5-fd00a3b45eff\",\n \"34eea35e-3ac4-44f4-95b5-fd00a3b45eff\"\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"status\": 6534,\n \"error\": \"string\",\n \"message\": \"string\",\n \"timestamp\": \"1948-12-15T13:36:47.872Z\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"90fa3913-031e-42b7-938d-87b03d49351a","name":"Unauthorized: insufficient permissions.","originalRequest":{"url":{"path":["business-profile-service","organizations","usage","stats","retentionDataPoints"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"from\": \"2025-05-29\",\n \"to\": \"2025-05-30\",\n \"actions\": [\n \"page.visit\",\n \"page.visit\"\n ],\n \"bpGuids\": [\n \"34eea35e-3ac4-44f4-95b5-fd00a3b45eff\",\n \"34eea35e-3ac4-44f4-95b5-fd00a3b45eff\"\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"status\": 6534,\n \"error\": \"string\",\n \"message\": \"string\",\n \"timestamp\": \"1948-12-15T13:36:47.872Z\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"ad58c459-27cb-4f3f-9ed6-485414f4fecd","name":"Request failed. See response for details.","originalRequest":{"url":{"path":["business-profile-service","organizations","usage","stats","retentionDataPoints"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"from\": \"2025-05-29\",\n \"to\": \"2025-05-30\",\n \"actions\": [\n \"page.visit\",\n \"page.visit\"\n ],\n \"bpGuids\": [\n \"34eea35e-3ac4-44f4-95b5-fd00a3b45eff\",\n \"34eea35e-3ac4-44f4-95b5-fd00a3b45eff\"\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"message\": \"string\",\n \"timestamp\": \"1987-03-31T18:14:07.183Z\",\n \"httpStatus\": 7242,\n \"errorCode\": \"string\",\n \"traceId\": \"string\",\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}],"event":[]},{"id":"8d66a2f2-a193-4688-b496-96bdb41ff115","name":"Organization workspaces","description":{"content":"","type":"text/plain"},"item":[{"id":"8c8d4eb0-1e7e-4b09-9d80-b794201725cb","name":"Get universal list of organization workspaces","request":{"name":"Get universal list of organization workspaces","description":{"content":"Retrieve a universal list of workspaces available to the user.\n\n---\n\n**API consumer:** Synerise User\n","type":"text/plain"},"url":{"path":["business-profile-service","business-profiles"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"page","value":"1","description":"Page to retrieve"},{"disabled":false,"key":"limit","value":"20","description":"Limit of items per page"},{"disabled":false,"key":"favorite","value":"true"},{"disabled":false,"key":"search","value":"","description":"String to search for"},{"disabled":false,"key":"sortBy","value":"CREATED:ASC"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":null},"response":[{"id":"106186a4-6517-4cf7-b099-da684e263209","name":"OK","originalRequest":{"url":{"path":["business-profile-service","business-profiles"],"host":["{{baseUrl}}"],"query":[{"key":"page","value":"1"},{"key":"limit","value":"20"},{"key":"favorite","value":"true"},{"key":"search","value":""},{"key":"sortBy","value":"CREATED:ASC"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"data\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"meta\": {\n \"count\": {\n \"value\": \"\"\n },\n \"limit\": {\n \"value\": \"\"\n },\n \"links\": {\n \"value\": \"\"\n }\n }\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"1c5b9d13-61c2-4b34-ae7b-de35dbb48c23","name":"Get all workspaces from organization","request":{"name":"Get all workspaces from organization","description":{"content":"Retrieve a list of all workspaces in an organization.\n\n---\n\n**API consumers:** Synerise User, Organization\n","type":"text/plain"},"url":{"path":["business-profile-service","organizations","workspaces"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":null},"response":[{"id":"4eb834bf-1cb2-4391-bb15-fecb6e4a6801","name":"List of workspaces","originalRequest":{"url":{"path":["business-profile-service","organizations","workspaces"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"organizationGuid\": \"1f7682d9-5b74-d04e-2ba3-94e3a58d4594\",\n \"workspaces\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"6f53b407-99f3-4a59-a4c2-2eaa5823c1c8","name":"Get universal list of organization workspaces with profile identifiers","request":{"name":"Get universal list of organization workspaces with profile identifiers","description":{"content":"Retrieve a universal list of workspaces in context of the current user; with profile identifiers used in each workspace.\n\n---\n\n**API consumer:** Synerise User\n","type":"text/plain"},"url":{"path":["business-profile-service","organizations","business-profiles","with-identifiers"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"page","value":"1","description":"Page to retrieve"},{"disabled":false,"key":"limit","value":"20","description":"Limit of items per page"},{"disabled":false,"key":"businessProfileGroupId","value":"string","description":"Workspace group to filter by."},{"disabled":false,"key":"sortBy","value":"NAME:ASC"},{"disabled":false,"key":"search","value":"string"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":null},"response":[{"id":"32ebdd5c-03e4-4bc6-a8c5-2857a0c5e198","name":"OK","originalRequest":{"url":{"path":["business-profile-service","organizations","business-profiles","with-identifiers"],"host":["{{baseUrl}}"],"query":[{"key":"page","value":"1"},{"key":"limit","value":"20"},{"key":"businessProfileGroupId","value":"string"},{"key":"sortBy","value":"NAME:ASC"},{"key":"search","value":"string"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"data\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"meta\": {\n \"count\": {\n \"value\": \"\"\n },\n \"limit\": {\n \"value\": \"\"\n },\n \"links\": {\n \"value\": \"\"\n }\n }\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}],"event":[]},{"id":"3a0f7490-5615-408e-b7fe-3b596b8e034e","name":"Analytics: Funnels","description":{"content":"","type":"text/plain"},"item":[{"id":"aa127ce2-76a0-4ff1-a34a-cc9eb1125a5a","name":"Preview funnel calculation","request":{"name":"Preview funnel calculation","description":{"content":"Preview the results of a funnel. This request doesn't save the funnel.\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `ANALYTICS_BACKEND_FUNNEL_READ`\n\n**User role permission required:** `analytics: read`\n","type":"text/plain"},"url":{"path":["analytics","analytics","v2","funnels","preview"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"analysis\": {\n \"description\": {\n \"value\": \"\"\n },\n \"filter\": {\n \"value\": \"\"\n },\n \"funnel\": {\n \"value\": \"\"\n },\n \"title\": {\n \"value\": \"\"\n }\n },\n \"inlineAnalytics\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"99bce0ad-59fa-48a8-88a2-1b2c9422fb98","name":"Preview of the results","originalRequest":{"url":{"path":["analytics","analytics","v2","funnels","preview"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"analysis\": {\n \"description\": {\n \"value\": \"\"\n },\n \"filter\": {\n \"value\": \"\"\n },\n \"funnel\": {\n \"value\": \"\"\n },\n \"title\": {\n \"value\": \"\"\n }\n },\n \"inlineAnalytics\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"calculationResult\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"metadata\": {\n \"source\": {\n \"value\": \"\"\n }\n },\n \"timeBetweenSteps\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"9149c62e-63cd-4e0a-b361-df4c63575fee","name":"See error message for details","originalRequest":{"url":{"path":["analytics","analytics","v2","funnels","preview"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"analysis\": {\n \"description\": {\n \"value\": \"\"\n },\n \"filter\": {\n \"value\": \"\"\n },\n \"funnel\": {\n \"value\": \"\"\n },\n \"title\": {\n \"value\": \"\"\n }\n },\n \"inlineAnalytics\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"source\": {\n \"pointer\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"timestamp\": {\n \"value\": \"\"\n },\n \"errorCode\": {\n \"value\": \"\"\n },\n \"httpStatus\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"traceId\": {\n \"value\": \"\"\n },\n \"help\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"54a5c2f7-4d48-49f1-9467-e9c7d29c7159","name":"See error message for details","originalRequest":{"url":{"path":["analytics","analytics","v2","funnels","preview"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"analysis\": {\n \"description\": {\n \"value\": \"\"\n },\n \"filter\": {\n \"value\": \"\"\n },\n \"funnel\": {\n \"value\": \"\"\n },\n \"title\": {\n \"value\": \"\"\n }\n },\n \"inlineAnalytics\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"source\": {\n \"pointer\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"timestamp\": {\n \"value\": \"\"\n },\n \"errorCode\": {\n \"value\": \"\"\n },\n \"httpStatus\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"traceId\": {\n \"value\": \"\"\n },\n \"help\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"f495ddd3-b393-4f71-a859-7cb6d61614fb","name":"Recalculate funnel with parameter override","request":{"name":"Recalculate funnel with parameter override","description":{"content":"Recalculate a funnel with new parameters and/or variable (dynamic key) values.\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `ANALYTICS_BACKEND_FUNNEL_READ`\n\n**User role permission required:** `analytics: read`\n","type":"text/plain"},"url":{"path":["analytics","analytics","v2","funnels",":AnalysisId","recalculate","override"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"AnalysisId","description":"(Required) UUID of the analysis"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json;charset=UTF-8"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"title\": \"string\",\n \"dateFilter\": {\n \"value\": \"\"\n },\n \"aggregateDataBy\": {\n \"type\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"filter\": {\n \"matching\": {\n \"value\": \"\"\n },\n \"expressions\": {\n \"value\": \"\"\n },\n \"expression\": {\n \"value\": \"\"\n },\n \"groupBy\": {\n \"value\": \"\"\n }\n },\n \"variables\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"overrideNested\": false\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"51e22ac5-9776-448b-a94f-68f66c8e5200","name":"Funnel results","originalRequest":{"url":{"path":["analytics","analytics","v2","funnels",":AnalysisId","recalculate","override"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"AnalysisId","description":"(Required) UUID of the analysis"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json;charset=UTF-8"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"title\": \"string\",\n \"dateFilter\": {\n \"value\": \"\"\n },\n \"aggregateDataBy\": {\n \"type\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"filter\": {\n \"matching\": {\n \"value\": \"\"\n },\n \"expressions\": {\n \"value\": \"\"\n },\n \"expression\": {\n \"value\": \"\"\n },\n \"groupBy\": {\n \"value\": \"\"\n }\n },\n \"variables\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"overrideNested\": false\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json;charset=UTF-8"}],"body":"{\n \"calculationResult\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"metadata\": {\n \"source\": {\n \"value\": \"\"\n }\n },\n \"timeBetweenSteps\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"1ba70f56-18c5-478e-9b39-94587c711ce4","name":"See error message for details","originalRequest":{"url":{"path":["analytics","analytics","v2","funnels",":AnalysisId","recalculate","override"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"AnalysisId","description":"(Required) UUID of the analysis"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"title\": \"string\",\n \"dateFilter\": {\n \"value\": \"\"\n },\n \"aggregateDataBy\": {\n \"type\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"filter\": {\n \"matching\": {\n \"value\": \"\"\n },\n \"expressions\": {\n \"value\": \"\"\n },\n \"expression\": {\n \"value\": \"\"\n },\n \"groupBy\": {\n \"value\": \"\"\n }\n },\n \"variables\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"overrideNested\": false\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"source\": {\n \"pointer\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"timestamp\": {\n \"value\": \"\"\n },\n \"errorCode\": {\n \"value\": \"\"\n },\n \"httpStatus\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"traceId\": {\n \"value\": \"\"\n },\n \"help\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"0c52e4c7-438b-4936-a1d3-f3bb8c78e1cf","name":"See error message for details","originalRequest":{"url":{"path":["analytics","analytics","v2","funnels",":AnalysisId","recalculate","override"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"AnalysisId","description":"(Required) UUID of the analysis"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"title\": \"string\",\n \"dateFilter\": {\n \"value\": \"\"\n },\n \"aggregateDataBy\": {\n \"type\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"filter\": {\n \"matching\": {\n \"value\": \"\"\n },\n \"expressions\": {\n \"value\": \"\"\n },\n \"expression\": {\n \"value\": \"\"\n },\n \"groupBy\": {\n \"value\": \"\"\n }\n },\n \"variables\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"overrideNested\": false\n}","options":{"raw":{"language":"json"}}}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"source\": {\n \"pointer\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"timestamp\": {\n \"value\": \"\"\n },\n \"errorCode\": {\n \"value\": \"\"\n },\n \"httpStatus\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"traceId\": {\n \"value\": \"\"\n },\n \"help\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"f1550d62-b572-48c9-98e6-588a3c2f1f03","name":"List funnels","request":{"name":"List funnels","description":{"content":"Returns a paginated list of funnels.\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `ANALYTICS_BACKEND_FUNNELS_LIST_READ`\n\n**User role permission required:** `analytics: read`\n","type":"text/plain"},"url":{"path":["analytics",":Namespace","funnels"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"page","value":"1","description":"The number of the page to retrieve"},{"disabled":false,"key":"limit","value":"50","description":"Limit of items per page"},{"disabled":false,"key":"search","value":"string","description":"A string to search for in analyses' titles"},{"disabled":false,"key":"sortBy","value":"name:asc","description":"You can sort the results. The sorting direction is selected by adding `asc` or `desc`, for example `sortBy=name:desc`.\n"},{"disabled":false,"key":"directoryId","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","description":"Unique ID of the directory to retrieve analyses from"},{"disabled":false,"key":"ids","value":"string","description":"Comma-separated list of IDs (in UUID format) to filter results through"}],"variable":[{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"7da2b015-123a-43be-9ce7-d6194b533193","name":"List of funnels","originalRequest":{"url":{"path":["analytics",":Namespace","funnels"],"host":["{{baseUrl}}"],"query":[{"key":"page","value":"1"},{"key":"limit","value":"50"},{"key":"search","value":"string"},{"key":"sortBy","value":"name:asc"},{"key":"directoryId","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750"},{"key":"ids","value":"string"}],"variable":[{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"data\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"meta\": {\n \"links\": {\n \"value\": \"\"\n },\n \"limit\": {\n \"value\": \"\"\n },\n \"count\": {\n \"value\": \"\"\n }\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"23199d9e-5c3b-491f-a97e-b05210b15f8d","name":"See error message for details","originalRequest":{"url":{"path":["analytics",":Namespace","funnels"],"host":["{{baseUrl}}"],"query":[{"key":"page","value":"1"},{"key":"limit","value":"50"},{"key":"search","value":"string"},{"key":"sortBy","value":"name:asc"},{"key":"directoryId","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750"},{"key":"ids","value":"string"}],"variable":[{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"source\": {\n \"pointer\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"timestamp\": {\n \"value\": \"\"\n },\n \"errorCode\": {\n \"value\": \"\"\n },\n \"httpStatus\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"traceId\": {\n \"value\": \"\"\n },\n \"help\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"3faf6156-74e5-472a-ae23-148d2228f133","name":"See error message for details","originalRequest":{"url":{"path":["analytics",":Namespace","funnels"],"host":["{{baseUrl}}"],"query":[{"key":"page","value":"1"},{"key":"limit","value":"50"},{"key":"search","value":"string"},{"key":"sortBy","value":"name:asc"},{"key":"directoryId","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750"},{"key":"ids","value":"string"}],"variable":[{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"source\": {\n \"pointer\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"timestamp\": {\n \"value\": \"\"\n },\n \"errorCode\": {\n \"value\": \"\"\n },\n \"httpStatus\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"traceId\": {\n \"value\": \"\"\n },\n \"help\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"0c521406-cb8b-46c0-a3d5-b5fa50694a86","name":"Create a funnel","request":{"name":"Create a funnel","description":{"content":"Create a funnel.\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permissions required (at least one):** `ANALYTICS_BACKEND_FUNNELS_CREATE`, `ANALYTICS_BACKEND_FUNNEL_CREATE`\n\n**User role permission required:** `analytics: create`\n","type":"text/plain"},"url":{"path":["analytics",":Namespace","funnels"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"analysis\": {\n \"description\": {\n \"value\": \"\"\n },\n \"filter\": {\n \"value\": \"\"\n },\n \"funnel\": {\n \"value\": \"\"\n },\n \"title\": {\n \"value\": \"\"\n }\n },\n \"inlineAnalytics\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"33c91a15-047d-47c5-81ee-81b03b61d94f","name":"Funnel created","originalRequest":{"url":{"path":["analytics",":Namespace","funnels"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"analysis\": {\n \"description\": {\n \"value\": \"\"\n },\n \"filter\": {\n \"value\": \"\"\n },\n \"funnel\": {\n \"value\": \"\"\n },\n \"title\": {\n \"value\": \"\"\n }\n },\n \"inlineAnalytics\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"Created","code":201,"header":[{"key":"Content-Type","value":"application/json"}],"body":"\"28a5c751-4a7f-54ba-224d-a3d44a2ba528\"","cookie":[],"_postman_previewlanguage":"json"},{"id":"3a7aed88-d2de-4f82-b803-6d8f955505d7","name":"See error message for details","originalRequest":{"url":{"path":["analytics",":Namespace","funnels"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"analysis\": {\n \"description\": {\n \"value\": \"\"\n },\n \"filter\": {\n \"value\": \"\"\n },\n \"funnel\": {\n \"value\": \"\"\n },\n \"title\": {\n \"value\": \"\"\n }\n },\n \"inlineAnalytics\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"source\": {\n \"pointer\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"timestamp\": {\n \"value\": \"\"\n },\n \"errorCode\": {\n \"value\": \"\"\n },\n \"httpStatus\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"traceId\": {\n \"value\": \"\"\n },\n \"help\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"3c4a4322-6866-4fd9-b8d9-1a4d2d7ea676","name":"See error message for details","originalRequest":{"url":{"path":["analytics",":Namespace","funnels"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"analysis\": {\n \"description\": {\n \"value\": \"\"\n },\n \"filter\": {\n \"value\": \"\"\n },\n \"funnel\": {\n \"value\": \"\"\n },\n \"title\": {\n \"value\": \"\"\n }\n },\n \"inlineAnalytics\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"source\": {\n \"pointer\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"timestamp\": {\n \"value\": \"\"\n },\n \"errorCode\": {\n \"value\": \"\"\n },\n \"httpStatus\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"traceId\": {\n \"value\": \"\"\n },\n \"help\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"be42a166-e64f-4508-a08a-8048c78ceed6","name":"Get funnel details","request":{"name":"Get funnel details","description":{"content":"Retrieve the definition of a single funnel\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permissions required (at least one):** `ANALYTICS_BACKEND_FUNNELS_READ`, `ANALYTICS_BACKEND_FUNNEL_READ`\n\n**User role permission required:** `analytics: read`\n","type":"text/plain"},"url":{"path":["analytics",":Namespace","funnels",":AnalysisId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."},{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"AnalysisId","description":"(Required) UUID of the analysis"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"d8a94c65-fb4c-4594-a418-effdd3f7507d","name":"Details of the funnel","originalRequest":{"url":{"path":["analytics",":Namespace","funnels",":AnalysisId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."},{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"AnalysisId","description":"(Required) UUID of the analysis"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"id\": \"5370bf3c-2dfa-4e89-98ff-07100cffee6c\",\n \"businessProfileId\": 48,\n \"name\": \"string\",\n \"description\": \"string\",\n \"author\": 3398,\n \"modifier\": 1973,\n \"updatedAt\": \"1949-02-18T10:08:18.754Z\",\n \"createdAt\": \"1990-09-16T00:15:42.171Z\",\n \"usedAt\": \"1956-10-09T06:59:12.869Z\",\n \"analysis\": {\n \"description\": {\n \"value\": \"\"\n },\n \"filter\": {\n \"value\": \"\"\n },\n \"funnel\": {\n \"value\": \"\"\n },\n \"title\": {\n \"value\": \"\"\n }\n },\n \"isPredefinedAnalytic\": false,\n \"isDynamicAnalytic\": false,\n \"isDeleted\": true,\n \"namespace\": \"string\",\n \"directoryId\": \"8d864d7a-a71f-3dc4-5cde-0bb6bdecf494\",\n \"inlineAnalytics\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"022d14ff-271f-49cf-a69b-af5b54780336","name":"See error message for details","originalRequest":{"url":{"path":["analytics",":Namespace","funnels",":AnalysisId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."},{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"AnalysisId","description":"(Required) UUID of the analysis"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"source\": {\n \"pointer\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"timestamp\": {\n \"value\": \"\"\n },\n \"errorCode\": {\n \"value\": \"\"\n },\n \"httpStatus\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"traceId\": {\n \"value\": \"\"\n },\n \"help\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"30044fdc-c30d-4bdc-95f0-cf28e434a642","name":"See error message for details","originalRequest":{"url":{"path":["analytics",":Namespace","funnels",":AnalysisId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."},{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"AnalysisId","description":"(Required) UUID of the analysis"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"source\": {\n \"pointer\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"timestamp\": {\n \"value\": \"\"\n },\n \"errorCode\": {\n \"value\": \"\"\n },\n \"httpStatus\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"traceId\": {\n \"value\": \"\"\n },\n \"help\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"aae69cf7-22bb-4657-ab76-058b4a677bee","name":"Update funnel","request":{"name":"Update funnel","description":{"content":"Update a funnel definition\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permissions required (at least one):** `ANALYTICS_BACKEND_FUNNELS_UPDATE`, `ANALYTICS_BACKEND_FUNNEL_UPDATE`\n\n**User role permission required:** `analytics: update`\n","type":"text/plain"},"url":{"path":["analytics",":Namespace","funnels",":AnalysisId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."},{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"AnalysisId","description":"(Required) UUID of the analysis"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PUT","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"analysis\": {\n \"description\": {\n \"value\": \"\"\n },\n \"filter\": {\n \"value\": \"\"\n },\n \"funnel\": {\n \"value\": \"\"\n },\n \"title\": {\n \"value\": \"\"\n }\n },\n \"inlineAnalytics\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"2cf3d3ce-75fa-4171-8e07-a0e3718236ed","name":"Funnel updated","originalRequest":{"url":{"path":["analytics",":Namespace","funnels",":AnalysisId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."},{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"AnalysisId","description":"(Required) UUID of the analysis"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"PUT","body":{"mode":"raw","raw":"{\n \"analysis\": {\n \"description\": {\n \"value\": \"\"\n },\n \"filter\": {\n \"value\": \"\"\n },\n \"funnel\": {\n \"value\": \"\"\n },\n \"title\": {\n \"value\": \"\"\n }\n },\n \"inlineAnalytics\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"11ece783-d94b-4dac-99af-78e3e8afa926","name":"See error message for details","originalRequest":{"url":{"path":["analytics",":Namespace","funnels",":AnalysisId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."},{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"AnalysisId","description":"(Required) UUID of the analysis"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"{\n \"analysis\": {\n \"description\": {\n \"value\": \"\"\n },\n \"filter\": {\n \"value\": \"\"\n },\n \"funnel\": {\n \"value\": \"\"\n },\n \"title\": {\n \"value\": \"\"\n }\n },\n \"inlineAnalytics\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"source\": {\n \"pointer\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"timestamp\": {\n \"value\": \"\"\n },\n \"errorCode\": {\n \"value\": \"\"\n },\n \"httpStatus\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"traceId\": {\n \"value\": \"\"\n },\n \"help\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"227f3b42-2e9f-47db-b47c-c2f04a4a631e","name":"See error message for details","originalRequest":{"url":{"path":["analytics",":Namespace","funnels",":AnalysisId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."},{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"AnalysisId","description":"(Required) UUID of the analysis"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"{\n \"analysis\": {\n \"description\": {\n \"value\": \"\"\n },\n \"filter\": {\n \"value\": \"\"\n },\n \"funnel\": {\n \"value\": \"\"\n },\n \"title\": {\n \"value\": \"\"\n }\n },\n \"inlineAnalytics\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"source\": {\n \"pointer\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"timestamp\": {\n \"value\": \"\"\n },\n \"errorCode\": {\n \"value\": \"\"\n },\n \"httpStatus\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"traceId\": {\n \"value\": \"\"\n },\n \"help\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"ee01f8f3-2e56-457f-87a5-ecdc3c0b11e9","name":"Delete funnel","request":{"name":"Delete funnel","description":{"content":"Delete a funnel.\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permissions required (at least one):** `ANALYTICS_BACKEND_FUNNELS_DELETE`, `ANALYTICS_BACKEND_FUNNEL_DELETE`\n\n**User role permission required:** `analytics: delete`\n","type":"text/plain"},"url":{"path":["analytics",":Namespace","funnels",":AnalysisId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."},{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"AnalysisId","description":"(Required) UUID of the analysis"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"a3106238-b7e3-48ca-8c56-3e9055854ea6","name":"Funnel deleted","originalRequest":{"url":{"path":["analytics",":Namespace","funnels",":AnalysisId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."},{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"AnalysisId","description":"(Required) UUID of the analysis"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"DELETE","body":{}},"status":"No Content","code":204,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"0fdfbc51-01ec-4f35-b808-0c265d19f060","name":"See error message for details","originalRequest":{"url":{"path":["analytics",":Namespace","funnels",":AnalysisId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."},{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"AnalysisId","description":"(Required) UUID of the analysis"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"source\": {\n \"pointer\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"timestamp\": {\n \"value\": \"\"\n },\n \"errorCode\": {\n \"value\": \"\"\n },\n \"httpStatus\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"traceId\": {\n \"value\": \"\"\n },\n \"help\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"fbee6044-634f-46f0-9ea4-411fe6641198","name":"See error message for details","originalRequest":{"url":{"path":["analytics",":Namespace","funnels",":AnalysisId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."},{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"AnalysisId","description":"(Required) UUID of the analysis"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"source\": {\n \"pointer\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"timestamp\": {\n \"value\": \"\"\n },\n \"errorCode\": {\n \"value\": \"\"\n },\n \"httpStatus\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"traceId\": {\n \"value\": \"\"\n },\n \"help\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}],"event":[]},{"id":"7f91f2d9-65a8-4cd2-8d54-8f4bb6bcc006","name":"Analytics: Histograms","description":{"content":"","type":"text/plain"},"item":[{"id":"4507a751-3bec-4742-bf2d-92473f757f85","name":"List histograms","request":{"name":"List histograms","description":{"content":"Returns a paginated list of histograms.\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `ANALYTICS_BACKEND_HISTOGRAMS_LIST_READ`\n\n**User role permission required:** `analytics: read`\n","type":"text/plain"},"url":{"path":["analytics",":Namespace","histograms"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"page","value":"1","description":"The number of the page to retrieve"},{"disabled":false,"key":"limit","value":"50","description":"Limit of items per page"},{"disabled":false,"key":"search","value":"string","description":"A string to search for in analyses' titles"},{"disabled":false,"key":"sortBy","value":"name:asc","description":"You can sort the results. The sorting direction is selected by adding `asc` or `desc`, for example `sortBy=name:desc`.\n"},{"disabled":false,"key":"directoryId","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","description":"Unique ID of the directory to retrieve analyses from"},{"disabled":false,"key":"ids","value":"string","description":"Comma-separated list of IDs (in UUID format) to filter results through"}],"variable":[{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"c6e71ffc-6861-4d57-815c-4140c1bb6671","name":"List of histograms","originalRequest":{"url":{"path":["analytics",":Namespace","histograms"],"host":["{{baseUrl}}"],"query":[{"key":"page","value":"1"},{"key":"limit","value":"50"},{"key":"search","value":"string"},{"key":"sortBy","value":"name:asc"},{"key":"directoryId","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750"},{"key":"ids","value":"string"}],"variable":[{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"data\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"meta\": {\n \"links\": {\n \"value\": \"\"\n },\n \"limit\": {\n \"value\": \"\"\n },\n \"count\": {\n \"value\": \"\"\n }\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"3602cdd7-0563-4d54-80a8-e016d7708793","name":"See error message for details","originalRequest":{"url":{"path":["analytics",":Namespace","histograms"],"host":["{{baseUrl}}"],"query":[{"key":"page","value":"1"},{"key":"limit","value":"50"},{"key":"search","value":"string"},{"key":"sortBy","value":"name:asc"},{"key":"directoryId","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750"},{"key":"ids","value":"string"}],"variable":[{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"source\": {\n \"pointer\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"timestamp\": {\n \"value\": \"\"\n },\n \"errorCode\": {\n \"value\": \"\"\n },\n \"httpStatus\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"traceId\": {\n \"value\": \"\"\n },\n \"help\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"a69ec9e6-1d12-4280-8ea0-1426b74edb43","name":"See error message for details","originalRequest":{"url":{"path":["analytics",":Namespace","histograms"],"host":["{{baseUrl}}"],"query":[{"key":"page","value":"1"},{"key":"limit","value":"50"},{"key":"search","value":"string"},{"key":"sortBy","value":"name:asc"},{"key":"directoryId","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750"},{"key":"ids","value":"string"}],"variable":[{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"source\": {\n \"pointer\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"timestamp\": {\n \"value\": \"\"\n },\n \"errorCode\": {\n \"value\": \"\"\n },\n \"httpStatus\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"traceId\": {\n \"value\": \"\"\n },\n \"help\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"ba34b04d-b507-4d04-a544-0db2b19f3300","name":"Create histogram","request":{"name":"Create histogram","description":{"content":"\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permissions required (at least one):** `ANALYTICS_BACKEND_HISTOGRAMS_CREATE`, `ANALYTICS_BACKEND_HISTOGRAM_CREATE`\n\n**User role permission required:** `analytics: create`\n","type":"text/plain"},"url":{"path":["analytics",":Namespace","histograms"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"analysis\": {\n \"description\": {\n \"value\": \"\"\n },\n \"histogram\": {\n \"value\": \"\"\n },\n \"title\": {\n \"value\": \"\"\n }\n },\n \"inlineAnalytics\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"64d33730-4d2b-46da-b37e-956fb7617f37","name":"Histogram created","originalRequest":{"url":{"path":["analytics",":Namespace","histograms"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"analysis\": {\n \"description\": {\n \"value\": \"\"\n },\n \"histogram\": {\n \"value\": \"\"\n },\n \"title\": {\n \"value\": \"\"\n }\n },\n \"inlineAnalytics\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"\"28a5c751-4a7f-54ba-224d-a3d44a2ba528\"","cookie":[],"_postman_previewlanguage":"json"},{"id":"a336a30a-55ff-4a95-9b27-fcc9e8c225ee","name":"See error message for details","originalRequest":{"url":{"path":["analytics",":Namespace","histograms"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"analysis\": {\n \"description\": {\n \"value\": \"\"\n },\n \"histogram\": {\n \"value\": \"\"\n },\n \"title\": {\n \"value\": \"\"\n }\n },\n \"inlineAnalytics\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"source\": {\n \"pointer\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"timestamp\": {\n \"value\": \"\"\n },\n \"errorCode\": {\n \"value\": \"\"\n },\n \"httpStatus\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"traceId\": {\n \"value\": \"\"\n },\n \"help\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"7bfedd4c-27fb-42c4-8a7c-95ec851efce3","name":"See error message for details","originalRequest":{"url":{"path":["analytics",":Namespace","histograms"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"analysis\": {\n \"description\": {\n \"value\": \"\"\n },\n \"histogram\": {\n \"value\": \"\"\n },\n \"title\": {\n \"value\": \"\"\n }\n },\n \"inlineAnalytics\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"source\": {\n \"pointer\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"timestamp\": {\n \"value\": \"\"\n },\n \"errorCode\": {\n \"value\": \"\"\n },\n \"httpStatus\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"traceId\": {\n \"value\": \"\"\n },\n \"help\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"73d24429-535a-4ea2-8611-78b11d441a90","name":"Get histogram details","request":{"name":"Get histogram details","description":{"content":"Retrieve the details of an existing histogram definition\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permissions required (at least one):** `ANALYTICS_BACKEND_HISTOGRAMS_READ`, `ANALYTICS_BACKEND_HISTOGRAM_READ`\n\n**User role permission required:** `analytics: read`\n","type":"text/plain"},"url":{"path":["analytics",":Namespace","histograms",":AnalysisId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."},{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"AnalysisId","description":"(Required) UUID of the analysis"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"2433db31-c9b4-4c80-935f-6ea8f45bfcd3","name":"Histogram analysis details","originalRequest":{"url":{"path":["analytics",":Namespace","histograms",":AnalysisId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."},{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"AnalysisId","description":"(Required) UUID of the analysis"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"id\": \"5370bf3c-2dfa-4e89-98ff-07100cffee6c\",\n \"businessProfileId\": 48,\n \"name\": \"string\",\n \"author\": 2794,\n \"modifier\": 7511,\n \"updatedAt\": \"2017-09-07T16:08:33.673Z\",\n \"createdAt\": \"2024-01-08T09:28:30.595Z\",\n \"usedAt\": \"1966-12-13T12:20:20.727Z\",\n \"analysis\": {\n \"description\": {\n \"value\": \"\"\n },\n \"histogram\": {\n \"value\": \"\"\n },\n \"title\": {\n \"value\": \"\"\n }\n },\n \"isPredefinedAnalytic\": true,\n \"isDynamicAnalytic\": true,\n \"isDeleted\": false,\n \"namespace\": \"string\",\n \"directoryId\": \"dae9005e-3e52-a3c7-ed89-50e364950fc0\",\n \"inlineAnalytics\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"325550f9-2d2b-4bc5-9437-2a0f62f019ac","name":"See error message for details","originalRequest":{"url":{"path":["analytics",":Namespace","histograms",":AnalysisId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."},{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"AnalysisId","description":"(Required) UUID of the analysis"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"source\": {\n \"pointer\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"timestamp\": {\n \"value\": \"\"\n },\n \"errorCode\": {\n \"value\": \"\"\n },\n \"httpStatus\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"traceId\": {\n \"value\": \"\"\n },\n \"help\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"d03ce002-cc84-4c19-8e99-e6076399454c","name":"See error message for details","originalRequest":{"url":{"path":["analytics",":Namespace","histograms",":AnalysisId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."},{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"AnalysisId","description":"(Required) UUID of the analysis"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"source\": {\n \"pointer\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"timestamp\": {\n \"value\": \"\"\n },\n \"errorCode\": {\n \"value\": \"\"\n },\n \"httpStatus\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"traceId\": {\n \"value\": \"\"\n },\n \"help\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"2137ed8c-298d-4197-94e1-31fca5c78c68","name":"Update histogram analysis","request":{"name":"Update histogram analysis","description":{"content":"Update an existing histogram analysis\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permissions required (at least one):** `ANALYTICS_BACKEND_HISTOGRAMS_UPDATE`, `ANALYTICS_BACKEND_HISTOGRAM_UPDATE`\n\n**User role permission required:** `analytics: update`\n","type":"text/plain"},"url":{"path":["analytics",":Namespace","histograms",":AnalysisId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."},{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"AnalysisId","description":"(Required) UUID of the analysis"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PUT","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"analysis\": {\n \"description\": {\n \"value\": \"\"\n },\n \"histogram\": {\n \"value\": \"\"\n },\n \"title\": {\n \"value\": \"\"\n }\n },\n \"inlineAnalytics\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"4ae8af1d-eaa9-44ca-920b-03dbd2ccf44b","name":"Histogram updated","originalRequest":{"url":{"path":["analytics",":Namespace","histograms",":AnalysisId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."},{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"AnalysisId","description":"(Required) UUID of the analysis"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"PUT","body":{"mode":"raw","raw":"{\n \"analysis\": {\n \"description\": {\n \"value\": \"\"\n },\n \"histogram\": {\n \"value\": \"\"\n },\n \"title\": {\n \"value\": \"\"\n }\n },\n \"inlineAnalytics\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"e03fc155-d9f7-49d1-8dc1-173b1494a738","name":"See error message for details","originalRequest":{"url":{"path":["analytics",":Namespace","histograms",":AnalysisId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."},{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"AnalysisId","description":"(Required) UUID of the analysis"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"{\n \"analysis\": {\n \"description\": {\n \"value\": \"\"\n },\n \"histogram\": {\n \"value\": \"\"\n },\n \"title\": {\n \"value\": \"\"\n }\n },\n \"inlineAnalytics\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"source\": {\n \"pointer\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"timestamp\": {\n \"value\": \"\"\n },\n \"errorCode\": {\n \"value\": \"\"\n },\n \"httpStatus\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"traceId\": {\n \"value\": \"\"\n },\n \"help\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"3fca225d-823e-49e7-8a83-9a2b90bc6763","name":"See error message for details","originalRequest":{"url":{"path":["analytics",":Namespace","histograms",":AnalysisId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."},{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"AnalysisId","description":"(Required) UUID of the analysis"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"{\n \"analysis\": {\n \"description\": {\n \"value\": \"\"\n },\n \"histogram\": {\n \"value\": \"\"\n },\n \"title\": {\n \"value\": \"\"\n }\n },\n \"inlineAnalytics\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"source\": {\n \"pointer\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"timestamp\": {\n \"value\": \"\"\n },\n \"errorCode\": {\n \"value\": \"\"\n },\n \"httpStatus\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"traceId\": {\n \"value\": \"\"\n },\n \"help\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"f658f8c8-7443-45d2-9f9a-a8d9012d7cd8","name":"Delete histogram","request":{"name":"Delete histogram","description":{"content":"\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permissions required (at least one):** `ANALYTICS_BACKEND_HISTOGRAMS_DELETE`, `ANALYTICS_BACKEND_HISTOGRAM_DELETE`\n\n**User role permission required:** `analytics: delete`\n","type":"text/plain"},"url":{"path":["analytics",":Namespace","histograms",":AnalysisId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."},{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"AnalysisId","description":"(Required) UUID of the analysis"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"eab8f16b-49d2-4343-ab46-914cb88a2183","name":"Histogram deleted","originalRequest":{"url":{"path":["analytics",":Namespace","histograms",":AnalysisId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."},{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"AnalysisId","description":"(Required) UUID of the analysis"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"DELETE","body":{}},"status":"No Content","code":204,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"b1af0c40-bc23-42bd-8976-8f0f499e7e66","name":"See error message for details","originalRequest":{"url":{"path":["analytics",":Namespace","histograms",":AnalysisId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."},{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"AnalysisId","description":"(Required) UUID of the analysis"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"source\": {\n \"pointer\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"timestamp\": {\n \"value\": \"\"\n },\n \"errorCode\": {\n \"value\": \"\"\n },\n \"httpStatus\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"traceId\": {\n \"value\": \"\"\n },\n \"help\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"a574e847-3f76-4346-a527-857bf5020093","name":"See error message for details","originalRequest":{"url":{"path":["analytics",":Namespace","histograms",":AnalysisId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."},{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"AnalysisId","description":"(Required) UUID of the analysis"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"source\": {\n \"pointer\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"timestamp\": {\n \"value\": \"\"\n },\n \"errorCode\": {\n \"value\": \"\"\n },\n \"httpStatus\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"traceId\": {\n \"value\": \"\"\n },\n \"help\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"1582f1d8-5cbc-4bfd-aada-8276b1ebb448","name":"Calculate histogram with parameter override","request":{"name":"Calculate histogram with parameter override","description":{"content":"Calculate a histogram with new parameters and/or variable (dynamic key) values.\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `ANALYTICS_BACKEND_HISTOGRAM_READ`\n\n**User role permission required:** `analytics: read`\n","type":"text/plain"},"url":{"path":["analytics","analytics","v2","metrics","histograms",":AnalysisId","recalculate","override"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"AnalysisId","description":"(Required) UUID of the analysis"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"title\": \"string\",\n \"dateFilter\": {\n \"value\": \"\"\n },\n \"aggregateDataBy\": {\n \"type\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"filter\": {\n \"matching\": {\n \"value\": \"\"\n },\n \"expressions\": {\n \"value\": \"\"\n },\n \"expression\": {\n \"value\": \"\"\n },\n \"groupBy\": {\n \"value\": \"\"\n }\n },\n \"variables\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"overrideNested\": false\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"23eb7125-de14-40b2-bb8d-773ccc85e38d","name":"Histogram override calculation result","originalRequest":{"url":{"path":["analytics","analytics","v2","metrics","histograms",":AnalysisId","recalculate","override"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"AnalysisId","description":"(Required) UUID of the analysis"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"title\": \"string\",\n \"dateFilter\": {\n \"value\": \"\"\n },\n \"aggregateDataBy\": {\n \"type\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"filter\": {\n \"matching\": {\n \"value\": \"\"\n },\n \"expressions\": {\n \"value\": \"\"\n },\n \"expression\": {\n \"value\": \"\"\n },\n \"groupBy\": {\n \"value\": \"\"\n }\n },\n \"variables\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"overrideNested\": false\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"items\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"legends\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"metadata\": {\n \"dateFilter\": {\n \"value\": \"\"\n },\n \"period\": {\n \"value\": \"\"\n }\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"78e812c8-b9d9-445c-b192-357337bca427","name":"See error message for details","originalRequest":{"url":{"path":["analytics","analytics","v2","metrics","histograms",":AnalysisId","recalculate","override"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"AnalysisId","description":"(Required) UUID of the analysis"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"title\": \"string\",\n \"dateFilter\": {\n \"value\": \"\"\n },\n \"aggregateDataBy\": {\n \"type\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"filter\": {\n \"matching\": {\n \"value\": \"\"\n },\n \"expressions\": {\n \"value\": \"\"\n },\n \"expression\": {\n \"value\": \"\"\n },\n \"groupBy\": {\n \"value\": \"\"\n }\n },\n \"variables\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"overrideNested\": false\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"source\": {\n \"pointer\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"timestamp\": {\n \"value\": \"\"\n },\n \"errorCode\": {\n \"value\": \"\"\n },\n \"httpStatus\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"traceId\": {\n \"value\": \"\"\n },\n \"help\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"749be867-81b7-49a6-8767-a923243ebc6a","name":"See error message for details","originalRequest":{"url":{"path":["analytics","analytics","v2","metrics","histograms",":AnalysisId","recalculate","override"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"AnalysisId","description":"(Required) UUID of the analysis"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"title\": \"string\",\n \"dateFilter\": {\n \"value\": \"\"\n },\n \"aggregateDataBy\": {\n \"type\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"filter\": {\n \"matching\": {\n \"value\": \"\"\n },\n \"expressions\": {\n \"value\": \"\"\n },\n \"expression\": {\n \"value\": \"\"\n },\n \"groupBy\": {\n \"value\": \"\"\n }\n },\n \"variables\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"overrideNested\": false\n}","options":{"raw":{"language":"json"}}}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"source\": {\n \"pointer\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"timestamp\": {\n \"value\": \"\"\n },\n \"errorCode\": {\n \"value\": \"\"\n },\n \"httpStatus\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"traceId\": {\n \"value\": \"\"\n },\n \"help\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"c5ff35a5-5482-4f9e-bd22-d3c366e183c8","name":"Preview histogram","request":{"name":"Preview histogram","description":{"content":"Preview the results of a histogram. This request doesn't save the histogram.\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `ANALYTICS_BACKEND_HISTOGRAM_READ`\n\n**User role permission required:** `analytics: read`\n","type":"text/plain"},"url":{"path":["analytics","analytics","v2","metrics","histograms","preview"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"analysis\": {\n \"description\": {\n \"value\": \"\"\n },\n \"histogram\": {\n \"value\": \"\"\n },\n \"title\": {\n \"value\": \"\"\n }\n },\n \"inlineAnalytics\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"331f398d-7c0d-4eb6-bd08-4d8da8c8a766","name":"Histogram preview calculation result","originalRequest":{"url":{"path":["analytics","analytics","v2","metrics","histograms","preview"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"analysis\": {\n \"description\": {\n \"value\": \"\"\n },\n \"histogram\": {\n \"value\": \"\"\n },\n \"title\": {\n \"value\": \"\"\n }\n },\n \"inlineAnalytics\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"items\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"legends\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"metadata\": {\n \"dateFilter\": {\n \"value\": \"\"\n },\n \"period\": {\n \"value\": \"\"\n }\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"d7d12731-e4c4-4585-ae63-76ed9a8edef2","name":"See error message for details","originalRequest":{"url":{"path":["analytics","analytics","v2","metrics","histograms","preview"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"analysis\": {\n \"description\": {\n \"value\": \"\"\n },\n \"histogram\": {\n \"value\": \"\"\n },\n \"title\": {\n \"value\": \"\"\n }\n },\n \"inlineAnalytics\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"source\": {\n \"pointer\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"timestamp\": {\n \"value\": \"\"\n },\n \"errorCode\": {\n \"value\": \"\"\n },\n \"httpStatus\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"traceId\": {\n \"value\": \"\"\n },\n \"help\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"5567be4c-e8d7-4a62-be95-181581a9ca35","name":"See error message for details","originalRequest":{"url":{"path":["analytics","analytics","v2","metrics","histograms","preview"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"analysis\": {\n \"description\": {\n \"value\": \"\"\n },\n \"histogram\": {\n \"value\": \"\"\n },\n \"title\": {\n \"value\": \"\"\n }\n },\n \"inlineAnalytics\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"source\": {\n \"pointer\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"timestamp\": {\n \"value\": \"\"\n },\n \"errorCode\": {\n \"value\": \"\"\n },\n \"httpStatus\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"traceId\": {\n \"value\": \"\"\n },\n \"help\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}],"event":[]},{"id":"f5a43861-1c49-4a00-bd32-9b426bd2e2d5","name":"Analytics: Metrics","description":{"content":"","type":"text/plain"},"item":[{"id":"d4161091-d785-4e07-8684-f15acf6b8f64","name":"List metrics","request":{"name":"List metrics","description":{"content":"Returns a paginated list of metrics.\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `ANALYTICS_BACKEND_METRICS_LIST_READ`\n\n**User role permission required:** `analytics: read`\n","type":"text/plain"},"url":{"path":["analytics",":Namespace","metrics"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"page","value":"1","description":"The number of the page to retrieve"},{"disabled":false,"key":"limit","value":"50","description":"Limit of items per page"},{"disabled":false,"key":"search","value":"string","description":"A string to search for in analyses' titles"},{"disabled":false,"key":"sortBy","value":"name:asc","description":"You can sort the results. The sorting direction is selected by adding `asc` or `desc`, for example `sortBy=name:desc`.\n"},{"disabled":false,"key":"directoryId","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","description":"Unique ID of the directory to retrieve analyses from"},{"disabled":false,"key":"ids","value":"string","description":"Comma-separated list of IDs (in UUID format) to filter results through"},{"disabled":false,"key":"isHistogramMetric","value":"true","description":"Filter metrics by whether they are histogram metrics."},{"disabled":false,"key":"isReportMetric","value":"true","description":"Filter metrics by whether they are report metrics."}],"variable":[{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"ab41ade3-8434-4e3a-983d-a434d4bb389e","name":"List of metrics","originalRequest":{"url":{"path":["analytics",":Namespace","metrics"],"host":["{{baseUrl}}"],"query":[{"key":"page","value":"1"},{"key":"limit","value":"50"},{"key":"search","value":"string"},{"key":"sortBy","value":"name:asc"},{"key":"directoryId","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750"},{"key":"ids","value":"string"},{"key":"isHistogramMetric","value":"true"},{"key":"isReportMetric","value":"true"}],"variable":[{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"data\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"meta\": {\n \"links\": {\n \"value\": \"\"\n },\n \"limit\": {\n \"value\": \"\"\n },\n \"count\": {\n \"value\": \"\"\n }\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"d3be1684-440d-4adf-bb22-263d207c13e2","name":"See error message for details","originalRequest":{"url":{"path":["analytics",":Namespace","metrics"],"host":["{{baseUrl}}"],"query":[{"key":"page","value":"1"},{"key":"limit","value":"50"},{"key":"search","value":"string"},{"key":"sortBy","value":"name:asc"},{"key":"directoryId","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750"},{"key":"ids","value":"string"},{"key":"isHistogramMetric","value":"true"},{"key":"isReportMetric","value":"true"}],"variable":[{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"source\": {\n \"pointer\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"timestamp\": {\n \"value\": \"\"\n },\n \"errorCode\": {\n \"value\": \"\"\n },\n \"httpStatus\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"traceId\": {\n \"value\": \"\"\n },\n \"help\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"aa85fb18-3e0b-4336-887d-5ad3100301a9","name":"See error message for details","originalRequest":{"url":{"path":["analytics",":Namespace","metrics"],"host":["{{baseUrl}}"],"query":[{"key":"page","value":"1"},{"key":"limit","value":"50"},{"key":"search","value":"string"},{"key":"sortBy","value":"name:asc"},{"key":"directoryId","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750"},{"key":"ids","value":"string"},{"key":"isHistogramMetric","value":"true"},{"key":"isReportMetric","value":"true"}],"variable":[{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"source\": {\n \"pointer\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"timestamp\": {\n \"value\": \"\"\n },\n \"errorCode\": {\n \"value\": \"\"\n },\n \"httpStatus\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"traceId\": {\n \"value\": \"\"\n },\n \"help\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"04f31f87-72d7-45e5-a4da-ef0767533bbd","name":"Create metric analysis","request":{"name":"Create metric analysis","description":{"content":"\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permissions required (at least one):** `ANALYTICS_BACKEND_METRICS_CREATE`, `ANALYTICS_BACKEND_METRIC_CREATE`\n\n**User role permission required:** `analytics: create`\n","type":"text/plain"},"url":{"path":["analytics",":Namespace","metrics"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"analysis\": {\n \"id\": {\n \"value\": \"\"\n },\n \"title\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n },\n \"format\": {\n \"value\": \"\"\n },\n \"comparison\": {\n \"value\": \"\"\n },\n \"metricType\": {\n \"value\": \"\"\n },\n \"expression\": {\n \"value\": \"\"\n },\n \"isVisibleForClientProfile\": {\n \"value\": \"\"\n },\n \"allowNull\": {\n \"value\": \"\"\n },\n \"grouping\": {\n \"value\": \"\"\n }\n },\n \"inlineAnalytics\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"a4ac6136-419b-435f-85e7-2d3eaf3a723c","name":"ID of the created analysis","originalRequest":{"url":{"path":["analytics",":Namespace","metrics"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"analysis\": {\n \"id\": {\n \"value\": \"\"\n },\n \"title\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n },\n \"format\": {\n \"value\": \"\"\n },\n \"comparison\": {\n \"value\": \"\"\n },\n \"metricType\": {\n \"value\": \"\"\n },\n \"expression\": {\n \"value\": \"\"\n },\n \"isVisibleForClientProfile\": {\n \"value\": \"\"\n },\n \"allowNull\": {\n \"value\": \"\"\n },\n \"grouping\": {\n \"value\": \"\"\n }\n },\n \"inlineAnalytics\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"\"28a5c751-4a7f-54ba-224d-a3d44a2ba528\"","cookie":[],"_postman_previewlanguage":"json"},{"id":"2d613a09-3ec2-4647-87ac-6b76e1b43021","name":"See error message for details","originalRequest":{"url":{"path":["analytics",":Namespace","metrics"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"analysis\": {\n \"id\": {\n \"value\": \"\"\n },\n \"title\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n },\n \"format\": {\n \"value\": \"\"\n },\n \"comparison\": {\n \"value\": \"\"\n },\n \"metricType\": {\n \"value\": \"\"\n },\n \"expression\": {\n \"value\": \"\"\n },\n \"isVisibleForClientProfile\": {\n \"value\": \"\"\n },\n \"allowNull\": {\n \"value\": \"\"\n },\n \"grouping\": {\n \"value\": \"\"\n }\n },\n \"inlineAnalytics\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"source\": {\n \"pointer\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"timestamp\": {\n \"value\": \"\"\n },\n \"errorCode\": {\n \"value\": \"\"\n },\n \"httpStatus\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"traceId\": {\n \"value\": \"\"\n },\n \"help\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"41b27ef4-be7f-40ec-8ea2-425fce84614a","name":"See error message for details","originalRequest":{"url":{"path":["analytics",":Namespace","metrics"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"analysis\": {\n \"id\": {\n \"value\": \"\"\n },\n \"title\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n },\n \"format\": {\n \"value\": \"\"\n },\n \"comparison\": {\n \"value\": \"\"\n },\n \"metricType\": {\n \"value\": \"\"\n },\n \"expression\": {\n \"value\": \"\"\n },\n \"isVisibleForClientProfile\": {\n \"value\": \"\"\n },\n \"allowNull\": {\n \"value\": \"\"\n },\n \"grouping\": {\n \"value\": \"\"\n }\n },\n \"inlineAnalytics\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"source\": {\n \"pointer\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"timestamp\": {\n \"value\": \"\"\n },\n \"errorCode\": {\n \"value\": \"\"\n },\n \"httpStatus\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"traceId\": {\n \"value\": \"\"\n },\n \"help\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"dc5acf6a-01da-4eef-a93b-672bc532455f","name":"Get metric details","request":{"name":"Get metric details","description":{"content":"Retrieve the details of a metric definition.\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permissions required (at least one):** `ANALYTICS_BACKEND_METRICS_READ`, `ANALYTICS_BACKEND_METRIC_READ`\n\n**User role permission required:** `analytics: read`\n","type":"text/plain"},"url":{"path":["analytics",":Namespace","metrics",":AnalysisId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"AnalysisId","description":"(Required) UUID of the analysis"},{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"f66c6006-ef31-4d0d-85ca-e1e09dcf4e23","name":"Metric details","originalRequest":{"url":{"path":["analytics",":Namespace","metrics",":AnalysisId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"AnalysisId","description":"(Required) UUID of the analysis"},{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"id\": \"5370bf3c-2dfa-4e89-98ff-07100cffee6c\",\n \"name\": \"string\",\n \"author\": 6589,\n \"modifier\": 2391,\n \"updatedAt\": \"2005-09-10T04:55:12.719Z\",\n \"createdAt\": \"1976-06-09T13:22:07.589Z\",\n \"usedAt\": \"1992-10-20T11:40:04.563Z\",\n \"analysis\": {\n \"id\": {\n \"value\": \"\"\n },\n \"title\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n },\n \"format\": {\n \"value\": \"\"\n },\n \"comparison\": {\n \"value\": \"\"\n },\n \"metricType\": {\n \"value\": \"\"\n },\n \"expression\": {\n \"value\": \"\"\n },\n \"isVisibleForClientProfile\": {\n \"value\": \"\"\n },\n \"allowNull\": {\n \"value\": \"\"\n },\n \"grouping\": {\n \"value\": \"\"\n }\n },\n \"isPredefinedAnalytic\": true,\n \"isDynamicAnalytic\": false,\n \"isMetricHistogram\": false,\n \"isDeleted\": true,\n \"namespace\": \"string\",\n \"directoryId\": \"d39e04f7-35d9-6575-61af-3062a01fc44e\",\n \"inlineAnalytics\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"fb6737a7-19b0-4884-8ddb-3b460636481b","name":"See error message for details","originalRequest":{"url":{"path":["analytics",":Namespace","metrics",":AnalysisId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"AnalysisId","description":"(Required) UUID of the analysis"},{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"source\": {\n \"pointer\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"timestamp\": {\n \"value\": \"\"\n },\n \"errorCode\": {\n \"value\": \"\"\n },\n \"httpStatus\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"traceId\": {\n \"value\": \"\"\n },\n \"help\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"ae301632-2bb5-49c9-8670-3a67e6e55b5d","name":"See error message for details","originalRequest":{"url":{"path":["analytics",":Namespace","metrics",":AnalysisId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"AnalysisId","description":"(Required) UUID of the analysis"},{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"source\": {\n \"pointer\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"timestamp\": {\n \"value\": \"\"\n },\n \"errorCode\": {\n \"value\": \"\"\n },\n \"httpStatus\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"traceId\": {\n \"value\": \"\"\n },\n \"help\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"9f6908f6-040a-45dd-a24e-3c5b24ff4ef6","name":"Update metric","request":{"name":"Update metric","description":{"content":"Update an existing metric definition.\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permissions required (at least one):** `ANALYTICS_BACKEND_METRICS_UPDATE`, `ANALYTICS_BACKEND_METRIC_UPDATE`\n\n**User role permission required:** `analytics: update`\n","type":"text/plain"},"url":{"path":["analytics",":Namespace","metrics",":AnalysisId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"AnalysisId","description":"(Required) UUID of the analysis"},{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PUT","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"analysis\": {\n \"id\": {\n \"value\": \"\"\n },\n \"title\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n },\n \"format\": {\n \"value\": \"\"\n },\n \"comparison\": {\n \"value\": \"\"\n },\n \"metricType\": {\n \"value\": \"\"\n },\n \"expression\": {\n \"value\": \"\"\n },\n \"isVisibleForClientProfile\": {\n \"value\": \"\"\n },\n \"allowNull\": {\n \"value\": \"\"\n },\n \"grouping\": {\n \"value\": \"\"\n }\n },\n \"inlineAnalytics\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"acbe44d4-fb7c-49bf-964d-a99fe1a3ee99","name":"Metric details","originalRequest":{"url":{"path":["analytics",":Namespace","metrics",":AnalysisId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"AnalysisId","description":"(Required) UUID of the analysis"},{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"{\n \"analysis\": {\n \"id\": {\n \"value\": \"\"\n },\n \"title\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n },\n \"format\": {\n \"value\": \"\"\n },\n \"comparison\": {\n \"value\": \"\"\n },\n \"metricType\": {\n \"value\": \"\"\n },\n \"expression\": {\n \"value\": \"\"\n },\n \"isVisibleForClientProfile\": {\n \"value\": \"\"\n },\n \"allowNull\": {\n \"value\": \"\"\n },\n \"grouping\": {\n \"value\": \"\"\n }\n },\n \"inlineAnalytics\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"id\": \"5370bf3c-2dfa-4e89-98ff-07100cffee6c\",\n \"name\": \"string\",\n \"author\": 6589,\n \"modifier\": 2391,\n \"updatedAt\": \"2005-09-10T04:55:12.719Z\",\n \"createdAt\": \"1976-06-09T13:22:07.589Z\",\n \"usedAt\": \"1992-10-20T11:40:04.563Z\",\n \"analysis\": {\n \"id\": {\n \"value\": \"\"\n },\n \"title\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n },\n \"format\": {\n \"value\": \"\"\n },\n \"comparison\": {\n \"value\": \"\"\n },\n \"metricType\": {\n \"value\": \"\"\n },\n \"expression\": {\n \"value\": \"\"\n },\n \"isVisibleForClientProfile\": {\n \"value\": \"\"\n },\n \"allowNull\": {\n \"value\": \"\"\n },\n \"grouping\": {\n \"value\": \"\"\n }\n },\n \"isPredefinedAnalytic\": true,\n \"isDynamicAnalytic\": false,\n \"isMetricHistogram\": false,\n \"isDeleted\": true,\n \"namespace\": \"string\",\n \"directoryId\": \"d39e04f7-35d9-6575-61af-3062a01fc44e\",\n \"inlineAnalytics\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"87b3aa06-15ab-4a13-a9e9-94c4ebaab71b","name":"See error message for details","originalRequest":{"url":{"path":["analytics",":Namespace","metrics",":AnalysisId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"AnalysisId","description":"(Required) UUID of the analysis"},{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"{\n \"analysis\": {\n \"id\": {\n \"value\": \"\"\n },\n \"title\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n },\n \"format\": {\n \"value\": \"\"\n },\n \"comparison\": {\n \"value\": \"\"\n },\n \"metricType\": {\n \"value\": \"\"\n },\n \"expression\": {\n \"value\": \"\"\n },\n \"isVisibleForClientProfile\": {\n \"value\": \"\"\n },\n \"allowNull\": {\n \"value\": \"\"\n },\n \"grouping\": {\n \"value\": \"\"\n }\n },\n \"inlineAnalytics\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"source\": {\n \"pointer\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"timestamp\": {\n \"value\": \"\"\n },\n \"errorCode\": {\n \"value\": \"\"\n },\n \"httpStatus\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"traceId\": {\n \"value\": \"\"\n },\n \"help\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"0c3d25fb-c937-4d8b-ac3b-f44e73ff3956","name":"See error message for details","originalRequest":{"url":{"path":["analytics",":Namespace","metrics",":AnalysisId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"AnalysisId","description":"(Required) UUID of the analysis"},{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"{\n \"analysis\": {\n \"id\": {\n \"value\": \"\"\n },\n \"title\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n },\n \"format\": {\n \"value\": \"\"\n },\n \"comparison\": {\n \"value\": \"\"\n },\n \"metricType\": {\n \"value\": \"\"\n },\n \"expression\": {\n \"value\": \"\"\n },\n \"isVisibleForClientProfile\": {\n \"value\": \"\"\n },\n \"allowNull\": {\n \"value\": \"\"\n },\n \"grouping\": {\n \"value\": \"\"\n }\n },\n \"inlineAnalytics\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"source\": {\n \"pointer\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"timestamp\": {\n \"value\": \"\"\n },\n \"errorCode\": {\n \"value\": \"\"\n },\n \"httpStatus\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"traceId\": {\n \"value\": \"\"\n },\n \"help\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"5fb4fcd6-8102-4623-8a7c-26bb98c3bd31","name":"Delete metric analysis","request":{"name":"Delete metric analysis","description":{"content":"\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permissions required (at least one):** `ANALYTICS_BACKEND_METRICS_DELETE`, `ANALYTICS_BACKEND_METRIC_DELETE`\n\n**User role permission required:** `analytics: delete`\n","type":"text/plain"},"url":{"path":["analytics",":Namespace","metrics",":AnalysisId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"AnalysisId","description":"(Required) UUID of the analysis"},{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"291f5b8d-228f-41be-9ea3-cbb0a5c57be3","name":"Metric deleted","originalRequest":{"url":{"path":["analytics",":Namespace","metrics",":AnalysisId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"AnalysisId","description":"(Required) UUID of the analysis"},{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"DELETE","body":{}},"status":"No Content","code":204,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"54c3556b-9397-4755-90e3-ab575715294f","name":"See error message for details","originalRequest":{"url":{"path":["analytics",":Namespace","metrics",":AnalysisId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"AnalysisId","description":"(Required) UUID of the analysis"},{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"source\": {\n \"pointer\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"timestamp\": {\n \"value\": \"\"\n },\n \"errorCode\": {\n \"value\": \"\"\n },\n \"httpStatus\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"traceId\": {\n \"value\": \"\"\n },\n \"help\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"8f8c379c-1f51-4e5c-972f-10cd37426d83","name":"See error message for details","originalRequest":{"url":{"path":["analytics",":Namespace","metrics",":AnalysisId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"AnalysisId","description":"(Required) UUID of the analysis"},{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"source\": {\n \"pointer\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"timestamp\": {\n \"value\": \"\"\n },\n \"errorCode\": {\n \"value\": \"\"\n },\n \"httpStatus\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"traceId\": {\n \"value\": \"\"\n },\n \"help\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"778bb75e-605c-44c7-9136-ee66e2b008a3","name":"Preview metric","request":{"name":"Preview metric","description":{"content":"Get the results of a metric. This request doesn't save the metric to the database.\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `ANALYTICS_BACKEND_METRIC_READ`\n\n**User role permission required:** `analytics: read`\n","type":"text/plain"},"url":{"path":["analytics","analytics","v3","metrics","preview"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"analysis\": {\n \"id\": {\n \"value\": \"\"\n },\n \"title\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n },\n \"format\": {\n \"value\": \"\"\n },\n \"comparison\": {\n \"value\": \"\"\n },\n \"metricType\": {\n \"value\": \"\"\n },\n \"expression\": {\n \"value\": \"\"\n },\n \"isVisibleForClientProfile\": {\n \"value\": \"\"\n },\n \"allowNull\": {\n \"value\": \"\"\n },\n \"grouping\": {\n \"value\": \"\"\n }\n },\n \"inlineAnalytics\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"b07ce489-f70c-4f80-97d2-19b7b0924e47","name":"Metric preview result","originalRequest":{"url":{"path":["analytics","analytics","v3","metrics","preview"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"analysis\": {\n \"id\": {\n \"value\": \"\"\n },\n \"title\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n },\n \"format\": {\n \"value\": \"\"\n },\n \"comparison\": {\n \"value\": \"\"\n },\n \"metricType\": {\n \"value\": \"\"\n },\n \"expression\": {\n \"value\": \"\"\n },\n \"isVisibleForClientProfile\": {\n \"value\": \"\"\n },\n \"allowNull\": {\n \"value\": \"\"\n },\n \"grouping\": {\n \"value\": \"\"\n }\n },\n \"inlineAnalytics\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"metricData\": {\n \"description\": {\n \"value\": \"\"\n },\n \"format\": {\n \"value\": \"\"\n },\n \"initialDateFilter\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n },\n \"result\": 4023.769632453131\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"9fd704f6-37bb-4375-b42a-eb22694723cd","name":"See error message for details","originalRequest":{"url":{"path":["analytics","analytics","v3","metrics","preview"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"analysis\": {\n \"id\": {\n \"value\": \"\"\n },\n \"title\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n },\n \"format\": {\n \"value\": \"\"\n },\n \"comparison\": {\n \"value\": \"\"\n },\n \"metricType\": {\n \"value\": \"\"\n },\n \"expression\": {\n \"value\": \"\"\n },\n \"isVisibleForClientProfile\": {\n \"value\": \"\"\n },\n \"allowNull\": {\n \"value\": \"\"\n },\n \"grouping\": {\n \"value\": \"\"\n }\n },\n \"inlineAnalytics\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"source\": {\n \"pointer\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"timestamp\": {\n \"value\": \"\"\n },\n \"errorCode\": {\n \"value\": \"\"\n },\n \"httpStatus\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"traceId\": {\n \"value\": \"\"\n },\n \"help\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"77223257-2ccf-4a03-9996-b499f32e5401","name":"See error message for details","originalRequest":{"url":{"path":["analytics","analytics","v3","metrics","preview"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"analysis\": {\n \"id\": {\n \"value\": \"\"\n },\n \"title\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n },\n \"format\": {\n \"value\": \"\"\n },\n \"comparison\": {\n \"value\": \"\"\n },\n \"metricType\": {\n \"value\": \"\"\n },\n \"expression\": {\n \"value\": \"\"\n },\n \"isVisibleForClientProfile\": {\n \"value\": \"\"\n },\n \"allowNull\": {\n \"value\": \"\"\n },\n \"grouping\": {\n \"value\": \"\"\n }\n },\n \"inlineAnalytics\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"source\": {\n \"pointer\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"timestamp\": {\n \"value\": \"\"\n },\n \"errorCode\": {\n \"value\": \"\"\n },\n \"httpStatus\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"traceId\": {\n \"value\": \"\"\n },\n \"help\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"ff66d154-5044-41df-a094-78ebdb5fc9d4","name":"Calculate metric with parameter override","request":{"name":"Calculate metric with parameter override","description":{"content":"Recalculate a metric with new parameters and/or variable (dynamic key) values.\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `ANALYTICS_BACKEND_METRIC_READ`\n\n**User role permission required:** `analytics: read`\n","type":"text/plain"},"url":{"path":["analytics","analytics","v3","metrics",":AnalysisId","recalculate","override"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"AnalysisId","description":"(Required) UUID of the analysis"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"title\": \"string\",\n \"dateFilter\": {\n \"value\": \"\"\n },\n \"aggregateDataBy\": {\n \"type\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"filter\": {\n \"matching\": {\n \"value\": \"\"\n },\n \"expressions\": {\n \"value\": \"\"\n },\n \"expression\": {\n \"value\": \"\"\n },\n \"groupBy\": {\n \"value\": \"\"\n }\n },\n \"variables\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"overrideNested\": false\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"0047d296-4076-4224-a3ef-52236a7c23be","name":"Metric calculation result","originalRequest":{"url":{"path":["analytics","analytics","v3","metrics",":AnalysisId","recalculate","override"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"AnalysisId","description":"(Required) UUID of the analysis"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"title\": \"string\",\n \"dateFilter\": {\n \"value\": \"\"\n },\n \"aggregateDataBy\": {\n \"type\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"filter\": {\n \"matching\": {\n \"value\": \"\"\n },\n \"expressions\": {\n \"value\": \"\"\n },\n \"expression\": {\n \"value\": \"\"\n },\n \"groupBy\": {\n \"value\": \"\"\n }\n },\n \"variables\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"overrideNested\": false\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"metricData\": {\n \"description\": {\n \"value\": \"\"\n },\n \"format\": {\n \"value\": \"\"\n },\n \"initialDateFilter\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n },\n \"result\": 4023.769632453131\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"870aaf11-eb13-4dd5-950b-7cfb92d1ac63","name":"See error message for details","originalRequest":{"url":{"path":["analytics","analytics","v3","metrics",":AnalysisId","recalculate","override"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"AnalysisId","description":"(Required) UUID of the analysis"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"title\": \"string\",\n \"dateFilter\": {\n \"value\": \"\"\n },\n \"aggregateDataBy\": {\n \"type\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"filter\": {\n \"matching\": {\n \"value\": \"\"\n },\n \"expressions\": {\n \"value\": \"\"\n },\n \"expression\": {\n \"value\": \"\"\n },\n \"groupBy\": {\n \"value\": \"\"\n }\n },\n \"variables\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"overrideNested\": false\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"source\": {\n \"pointer\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"timestamp\": {\n \"value\": \"\"\n },\n \"errorCode\": {\n \"value\": \"\"\n },\n \"httpStatus\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"traceId\": {\n \"value\": \"\"\n },\n \"help\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"901da512-9c2b-4282-90b5-f575e3d815d1","name":"See error message for details","originalRequest":{"url":{"path":["analytics","analytics","v3","metrics",":AnalysisId","recalculate","override"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"AnalysisId","description":"(Required) UUID of the analysis"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"title\": \"string\",\n \"dateFilter\": {\n \"value\": \"\"\n },\n \"aggregateDataBy\": {\n \"type\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"filter\": {\n \"matching\": {\n \"value\": \"\"\n },\n \"expressions\": {\n \"value\": \"\"\n },\n \"expression\": {\n \"value\": \"\"\n },\n \"groupBy\": {\n \"value\": \"\"\n }\n },\n \"variables\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"overrideNested\": false\n}","options":{"raw":{"language":"json"}}}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"source\": {\n \"pointer\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"timestamp\": {\n \"value\": \"\"\n },\n \"errorCode\": {\n \"value\": \"\"\n },\n \"httpStatus\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"traceId\": {\n \"value\": \"\"\n },\n \"help\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"d6d5da7e-34b4-4dbc-a623-d315ef4ad8ce","name":"Calculate metric","request":{"name":"Calculate metric","description":{"content":"Calculate a metric that was created earlier.\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `ANALYTICS_BACKEND_METRIC_READ`\n\n**User role permission required:** `analytics: read`\n","type":"text/plain"},"url":{"path":["analytics","analytics","v3","metrics",":AnalysisId","recalculate"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"AnalysisId","description":"(Required) UUID of the analysis"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"350ed97e-4dea-4a98-8374-4e40425a6ce3","name":"Metric calculation result","originalRequest":{"url":{"path":["analytics","analytics","v3","metrics",":AnalysisId","recalculate"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"AnalysisId","description":"(Required) UUID of the analysis"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"metricData\": {\n \"description\": {\n \"value\": \"\"\n },\n \"format\": {\n \"value\": \"\"\n },\n \"initialDateFilter\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n },\n \"result\": 4023.769632453131\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"b72bc089-9f5e-45b5-837c-57415322af2a","name":"See error message for details","originalRequest":{"url":{"path":["analytics","analytics","v3","metrics",":AnalysisId","recalculate"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"AnalysisId","description":"(Required) UUID of the analysis"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"source\": {\n \"pointer\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"timestamp\": {\n \"value\": \"\"\n },\n \"errorCode\": {\n \"value\": \"\"\n },\n \"httpStatus\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"traceId\": {\n \"value\": \"\"\n },\n \"help\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"417ac023-c041-4116-bb64-7b2f1d1a7071","name":"See error message for details","originalRequest":{"url":{"path":["analytics","analytics","v3","metrics",":AnalysisId","recalculate"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"AnalysisId","description":"(Required) UUID of the analysis"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"source\": {\n \"pointer\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"timestamp\": {\n \"value\": \"\"\n },\n \"errorCode\": {\n \"value\": \"\"\n },\n \"httpStatus\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"traceId\": {\n \"value\": \"\"\n },\n \"help\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"8305f1c0-2800-41a6-9e41-db50fe3e4967","name":"Calculate dynamic metric","request":{"name":"Calculate dynamic metric","description":{"content":"Calculate a metric that includes variables (dynamic keys).\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `ANALYTICS_BACKEND_METRIC_READ`\n\n**User role permission required:** `analytics: read`\n","type":"text/plain"},"url":{"path":["analytics","analytics","v3","metrics",":AnalysisId","dynamic","value"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"AnalysisId","description":"(Required) UUID of the analysis"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"variables\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"1960b561-2c31-4b8c-a4d2-d55a3d95b11a","name":"Metric calculation result","originalRequest":{"url":{"path":["analytics","analytics","v3","metrics",":AnalysisId","dynamic","value"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"AnalysisId","description":"(Required) UUID of the analysis"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"variables\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"metricData\": {\n \"description\": {\n \"value\": \"\"\n },\n \"format\": {\n \"value\": \"\"\n },\n \"initialDateFilter\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n },\n \"result\": 4023.769632453131\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"2de7478e-17bb-42e0-bada-6e6afeda2e81","name":"See error message for details","originalRequest":{"url":{"path":["analytics","analytics","v3","metrics",":AnalysisId","dynamic","value"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"AnalysisId","description":"(Required) UUID of the analysis"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"variables\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"source\": {\n \"pointer\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"timestamp\": {\n \"value\": \"\"\n },\n \"errorCode\": {\n \"value\": \"\"\n },\n \"httpStatus\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"traceId\": {\n \"value\": \"\"\n },\n \"help\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"012ce115-6c61-4002-bcad-6ebfd7a200a9","name":"See error message for details","originalRequest":{"url":{"path":["analytics","analytics","v3","metrics",":AnalysisId","dynamic","value"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"AnalysisId","description":"(Required) UUID of the analysis"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"variables\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"source\": {\n \"pointer\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"timestamp\": {\n \"value\": \"\"\n },\n \"errorCode\": {\n \"value\": \"\"\n },\n \"httpStatus\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"traceId\": {\n \"value\": \"\"\n },\n \"help\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"a86e0dde-c754-4c24-9dab-b9e4b2b9fffe","name":"Get metrics usable in histograms","request":{"name":"Get metrics usable in histograms","description":{"content":"Retrieve a list of metrics that can be used in histograms.\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `ANALYTICS_BACKEND_METRIC_HISTOGRAM_READ`\n\n**User role permission required:** `analytics: read`\n","type":"text/plain"},"url":{"path":["analytics","analytics","v3","metrics","histogram-metrics"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json;charset=UTF-8"}],"method":"GET","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"9e0e4a41-dfbd-456e-b6eb-46fc8c92cb26","name":"List of metrics","originalRequest":{"url":{"path":["analytics","analytics","v3","metrics","histogram-metrics"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json;charset=UTF-8"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json;charset=UTF-8"}],"body":"[\n {\n \"createdAt\": {\n \"value\": \"\"\n },\n \"isNumber\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"hashId\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n },\n \"action\": {\n \"value\": \"\"\n },\n \"eventName\": {\n \"value\": \"\"\n },\n \"actionId\": {\n \"value\": \"\"\n },\n \"isDynamicAnalytic\": {\n \"value\": \"\"\n },\n \"variables\": {\n \"value\": \"\"\n },\n \"isMetricHistogram\": {\n \"value\": \"\"\n }\n },\n {\n \"createdAt\": {\n \"value\": \"\"\n },\n \"isNumber\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"hashId\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n },\n \"action\": {\n \"value\": \"\"\n },\n \"eventName\": {\n \"value\": \"\"\n },\n \"actionId\": {\n \"value\": \"\"\n },\n \"isDynamicAnalytic\": {\n \"value\": \"\"\n },\n \"variables\": {\n \"value\": \"\"\n },\n \"isMetricHistogram\": {\n \"value\": \"\"\n }\n }\n]","cookie":[],"_postman_previewlanguage":"json"},{"id":"74c774dc-0632-4a8a-9cf9-992c0735aa93","name":"See error message for details","originalRequest":{"url":{"path":["analytics","analytics","v3","metrics","histogram-metrics"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"source\": {\n \"pointer\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"timestamp\": {\n \"value\": \"\"\n },\n \"errorCode\": {\n \"value\": \"\"\n },\n \"httpStatus\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"traceId\": {\n \"value\": \"\"\n },\n \"help\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"1998ad05-725d-455f-a60b-cfb5c5fde163","name":"See error message for details","originalRequest":{"url":{"path":["analytics","analytics","v3","metrics","histogram-metrics"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"source\": {\n \"pointer\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"timestamp\": {\n \"value\": \"\"\n },\n \"errorCode\": {\n \"value\": \"\"\n },\n \"httpStatus\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"traceId\": {\n \"value\": \"\"\n },\n \"help\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}],"event":[]},{"id":"15318a15-2f87-4940-bbbe-4ded5186b4aa","name":"AI: Metrics","description":{"content":"","type":"text/plain"},"item":[{"id":"e0e59014-258e-45a2-92e3-c4133af068f6","name":"Check available metrics (recommendations)","request":{"name":"Check available metrics (recommendations)","description":{"content":"Returns metrics available for the Workspace. The metrics can be used when defining boostMetric and sortMetric query parameters in recommendations and in metric-based recommendations.\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User\n\n**API key permission required:** `METRICS_RECOMMENDATIONS_READ`\n\n**User role permission required:** `campaigns_recommendations: read`\n","type":"text/plain"},"url":{"path":["metrics","v2","available"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"bc578c86-5319-4447-a33a-48187a71ffc7","name":"Available metrics","originalRequest":{"url":{"path":["metrics","v2","available"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"[\n {\n \"id\": \"string\",\n \"description\": \"string\"\n },\n {\n \"id\": \"string\",\n \"description\": \"string\"\n }\n]","cookie":[],"_postman_previewlanguage":"json"},{"id":"86521e34-64bc-4b2f-aa3c-2d6ea1ccba08","name":"An error occurred","originalRequest":{"url":{"path":["metrics","v2","available"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1963-08-12T14:54:43.321Z\",\n \"status\": 2878,\n \"message\": \"string\",\n \"error\": \"string\",\n \"path\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"3dd27e0b-a850-44d5-9919-1431066a0482","name":"Retrieve IDs of available metrics (recommendations)","request":{"name":"Retrieve IDs of available metrics (recommendations)","description":{"content":"Returns IDs of metrics that are available for the Workspace. The metrics can be used when defining boostMetric and sortMetric query parameters in recommendations and in metric-based recommendations.\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User\n\n**API key permission required:** `METRICS_RECOMMENDATIONS_READ`\n\n**User role permission required:** `campaigns_recommendations: read`\n","type":"text/plain"},"url":{"path":["metrics","v2","available-ids"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"bc23d87f-19de-4ade-9112-ecc58443099f","name":"IDs of available metrics","originalRequest":{"url":{"path":["metrics","v2","available-ids"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"[\n \"string\",\n \"string\"\n]","cookie":[],"_postman_previewlanguage":"json"},{"id":"f79413a0-6232-4630-981b-793784f973ec","name":"An error occurred","originalRequest":{"url":{"path":["metrics","v2","available-ids"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"timestamp\": \"1963-08-12T14:54:43.321Z\",\n \"status\": 2878,\n \"message\": \"string\",\n \"error\": \"string\",\n \"path\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}],"event":[]},{"id":"ddc9618d-2849-40b4-9512-7e8f3d79bcda","name":"Analytics: Reports","description":{"content":"","type":"text/plain"},"item":[{"id":"cbdf3abd-b219-49bd-8d61-a235779858c8","name":"Calculate report with override","request":{"name":"Calculate report with override","description":{"content":"Calculate a report with new parameters and/or variables (dynamic keys)\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `ANALYTICS_BACKEND_REPORT_READ`\n\n**User role permission required:** `analytics: read`\n","type":"text/plain"},"url":{"path":["analytics","analytics","v4","reports",":AnalysisId","recalculate","override"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"AnalysisId","description":"(Required) UUID of the analysis"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"title\": \"string\",\n \"dateFilter\": {\n \"value\": \"\"\n },\n \"aggregateDataBy\": {\n \"type\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"filter\": {\n \"matching\": {\n \"value\": \"\"\n },\n \"expressions\": {\n \"value\": \"\"\n },\n \"expression\": {\n \"value\": \"\"\n },\n \"groupBy\": {\n \"value\": \"\"\n }\n },\n \"variables\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"overrideNested\": false\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"50038f25-3ffd-4049-86fd-9511108bad92","name":"Report calculation result","originalRequest":{"url":{"path":["analytics","analytics","v4","reports",":AnalysisId","recalculate","override"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"AnalysisId","description":"(Required) UUID of the analysis"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"title\": \"string\",\n \"dateFilter\": {\n \"value\": \"\"\n },\n \"aggregateDataBy\": {\n \"type\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"filter\": {\n \"matching\": {\n \"value\": \"\"\n },\n \"expressions\": {\n \"value\": \"\"\n },\n \"expression\": {\n \"value\": \"\"\n },\n \"groupBy\": {\n \"value\": \"\"\n }\n },\n \"variables\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"overrideNested\": false\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"data\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"bc7abecc-7580-483e-8eee-6df47afd0bc3","name":"See error message for details","originalRequest":{"url":{"path":["analytics","analytics","v4","reports",":AnalysisId","recalculate","override"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"AnalysisId","description":"(Required) UUID of the analysis"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"title\": \"string\",\n \"dateFilter\": {\n \"value\": \"\"\n },\n \"aggregateDataBy\": {\n \"type\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"filter\": {\n \"matching\": {\n \"value\": \"\"\n },\n \"expressions\": {\n \"value\": \"\"\n },\n \"expression\": {\n \"value\": \"\"\n },\n \"groupBy\": {\n \"value\": \"\"\n }\n },\n \"variables\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"overrideNested\": false\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"source\": {\n \"pointer\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"timestamp\": {\n \"value\": \"\"\n },\n \"errorCode\": {\n \"value\": \"\"\n },\n \"httpStatus\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"traceId\": {\n \"value\": \"\"\n },\n \"help\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"09538cb9-d5cf-47c4-88a9-d103fd44065c","name":"See error message for details","originalRequest":{"url":{"path":["analytics","analytics","v4","reports",":AnalysisId","recalculate","override"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"AnalysisId","description":"(Required) UUID of the analysis"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"title\": \"string\",\n \"dateFilter\": {\n \"value\": \"\"\n },\n \"aggregateDataBy\": {\n \"type\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"filter\": {\n \"matching\": {\n \"value\": \"\"\n },\n \"expressions\": {\n \"value\": \"\"\n },\n \"expression\": {\n \"value\": \"\"\n },\n \"groupBy\": {\n \"value\": \"\"\n }\n },\n \"variables\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"overrideNested\": false\n}","options":{"raw":{"language":"json"}}}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"source\": {\n \"pointer\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"timestamp\": {\n \"value\": \"\"\n },\n \"errorCode\": {\n \"value\": \"\"\n },\n \"httpStatus\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"traceId\": {\n \"value\": \"\"\n },\n \"help\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"5f2aee0f-d743-468c-a6f1-0de9b73bf606","name":"Recalculate report","request":{"name":"Recalculate report","description":{"content":"Retrieve the results of a previously-created report.\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `ANALYTICS_BACKEND_REPORT_READ`\n\n**User role permission required:** `analytics: read`\n","type":"text/plain"},"url":{"path":["analytics","analytics","v4","reports",":AnalysisId","recalculate"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"AnalysisId","description":"(Required) UUID of the analysis"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"a0a0ca5a-808a-46e9-9a37-eac1c6d322c9","name":"Report calculation result","originalRequest":{"url":{"path":["analytics","analytics","v4","reports",":AnalysisId","recalculate"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"AnalysisId","description":"(Required) UUID of the analysis"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"data\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"90b883e2-a14a-48f6-8524-c4c9f6a5c43b","name":"See error message for details","originalRequest":{"url":{"path":["analytics","analytics","v4","reports",":AnalysisId","recalculate"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"AnalysisId","description":"(Required) UUID of the analysis"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"source\": {\n \"pointer\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"timestamp\": {\n \"value\": \"\"\n },\n \"errorCode\": {\n \"value\": \"\"\n },\n \"httpStatus\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"traceId\": {\n \"value\": \"\"\n },\n \"help\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"b937b96f-a07d-4338-ac75-02d76e93d6fa","name":"See error message for details","originalRequest":{"url":{"path":["analytics","analytics","v4","reports",":AnalysisId","recalculate"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"AnalysisId","description":"(Required) UUID of the analysis"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"source\": {\n \"pointer\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"timestamp\": {\n \"value\": \"\"\n },\n \"errorCode\": {\n \"value\": \"\"\n },\n \"httpStatus\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"traceId\": {\n \"value\": \"\"\n },\n \"help\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"f91ac87c-f3a1-4294-9dd4-c30c7a4f21ce","name":"Preview report","request":{"name":"Preview report","description":{"content":"Retrieve the results of a report. This request doesn't save the report.\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `ANALYTICS_BACKEND_REPORT_READ`\n\n**User role permission required:** `analytics: read`\n","type":"text/plain"},"url":{"path":["analytics","analytics","v4","reports","preview"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"analysis\": {\n \"title\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n },\n \"reportMetrics\": {\n \"value\": \"\"\n },\n \"filter\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n }\n },\n \"allowNull\": true,\n \"inlineAnalytics\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"e2278d46-5fbc-4fe4-967d-6e577c61ff4d","name":"Report calculation result","originalRequest":{"url":{"path":["analytics","analytics","v4","reports","preview"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"analysis\": {\n \"title\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n },\n \"reportMetrics\": {\n \"value\": \"\"\n },\n \"filter\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n }\n },\n \"allowNull\": true,\n \"inlineAnalytics\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"data\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"5dade580-aaf4-4951-bc3f-67f0ff243855","name":"See error message for details","originalRequest":{"url":{"path":["analytics","analytics","v4","reports","preview"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"analysis\": {\n \"title\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n },\n \"reportMetrics\": {\n \"value\": \"\"\n },\n \"filter\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n }\n },\n \"allowNull\": true,\n \"inlineAnalytics\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"source\": {\n \"pointer\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"timestamp\": {\n \"value\": \"\"\n },\n \"errorCode\": {\n \"value\": \"\"\n },\n \"httpStatus\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"traceId\": {\n \"value\": \"\"\n },\n \"help\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"5c6111ea-d00d-4b9c-a1f3-20100c1f758c","name":"See error message for details","originalRequest":{"url":{"path":["analytics","analytics","v4","reports","preview"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"analysis\": {\n \"title\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n },\n \"reportMetrics\": {\n \"value\": \"\"\n },\n \"filter\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n }\n },\n \"allowNull\": true,\n \"inlineAnalytics\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"source\": {\n \"pointer\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"timestamp\": {\n \"value\": \"\"\n },\n \"errorCode\": {\n \"value\": \"\"\n },\n \"httpStatus\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"traceId\": {\n \"value\": \"\"\n },\n \"help\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"a000990c-9f8c-4a73-8f26-591a7127d16a","name":"Preview report as CSV","request":{"name":"Preview report as CSV","description":{"content":"Retrieve the results of a report as CSV. This request doesn't save the report.\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `ANALYTICS_BACKEND_REPORT_READ`\n\n**User role permission required:** `analytics: read`\n","type":"text/plain"},"url":{"path":["analytics","analytics","v4","reports","preview-csv"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/csv"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"analysis\": {\n \"title\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n },\n \"reportMetrics\": {\n \"value\": \"\"\n },\n \"filter\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n }\n },\n \"allowNull\": true,\n \"inlineAnalytics\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"d6c78662-a81e-42c7-8cfd-df4e9dcd0863","name":"CSV data","originalRequest":{"url":{"path":["analytics","analytics","v4","reports","preview-csv"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"text/csv"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"analysis\": {\n \"title\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n },\n \"reportMetrics\": {\n \"value\": \"\"\n },\n \"filter\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n }\n },\n \"allowNull\": true,\n \"inlineAnalytics\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"text/csv"}],"body":"string","cookie":[],"_postman_previewlanguage":"text"},{"id":"bb696aea-0cd2-4242-8472-472db0c3d285","name":"See error message for details","originalRequest":{"url":{"path":["analytics","analytics","v4","reports","preview-csv"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"analysis\": {\n \"title\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n },\n \"reportMetrics\": {\n \"value\": \"\"\n },\n \"filter\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n }\n },\n \"allowNull\": true,\n \"inlineAnalytics\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"source\": {\n \"pointer\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"timestamp\": {\n \"value\": \"\"\n },\n \"errorCode\": {\n \"value\": \"\"\n },\n \"httpStatus\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"traceId\": {\n \"value\": \"\"\n },\n \"help\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"86b36254-5dcb-41b1-a59a-1fe6eb41431b","name":"See error message for details","originalRequest":{"url":{"path":["analytics","analytics","v4","reports","preview-csv"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"analysis\": {\n \"title\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n },\n \"reportMetrics\": {\n \"value\": \"\"\n },\n \"filter\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n }\n },\n \"allowNull\": true,\n \"inlineAnalytics\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"source\": {\n \"pointer\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"timestamp\": {\n \"value\": \"\"\n },\n \"errorCode\": {\n \"value\": \"\"\n },\n \"httpStatus\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"traceId\": {\n \"value\": \"\"\n },\n \"help\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"4e0007ab-9044-4b18-b8c4-f916977a52a5","name":"List reports","request":{"name":"List reports","description":{"content":"Returns a paginated list of reports.\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `ANALYTICS_BACKEND_REPORTS_LIST_READ`\n\n**User role permission required:** `analytics: read`\n","type":"text/plain"},"url":{"path":["analytics",":Namespace","reports"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"page","value":"1","description":"The number of the page to retrieve"},{"disabled":false,"key":"limit","value":"50","description":"Limit of items per page"},{"disabled":false,"key":"search","value":"string","description":"A string to search for in analyses' titles"},{"disabled":false,"key":"sortBy","value":"name:asc","description":"You can sort the results. The sorting direction is selected by adding `asc` or `desc`, for example `sortBy=name:desc`.\n"},{"disabled":false,"key":"directoryId","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","description":"Unique ID of the directory to retrieve analyses from"},{"disabled":false,"key":"ids","value":"string","description":"Comma-separated list of IDs (in UUID format) to filter results through"},{"disabled":false,"key":"isMultiMetric","value":"true","description":"Filter reports by whether they have more than one metric."}],"variable":[{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"c0c6ae4a-bc6c-4980-bb21-da2b71d1a2c3","name":"List of reports","originalRequest":{"url":{"path":["analytics",":Namespace","reports"],"host":["{{baseUrl}}"],"query":[{"key":"page","value":"1"},{"key":"limit","value":"50"},{"key":"search","value":"string"},{"key":"sortBy","value":"name:asc"},{"key":"directoryId","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750"},{"key":"ids","value":"string"},{"key":"isMultiMetric","value":"true"}],"variable":[{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"data\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"meta\": {\n \"links\": {\n \"value\": \"\"\n },\n \"limit\": {\n \"value\": \"\"\n },\n \"count\": {\n \"value\": \"\"\n }\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"1d8397e8-2c09-49dc-b5f0-34007cbc7718","name":"See error message for details","originalRequest":{"url":{"path":["analytics",":Namespace","reports"],"host":["{{baseUrl}}"],"query":[{"key":"page","value":"1"},{"key":"limit","value":"50"},{"key":"search","value":"string"},{"key":"sortBy","value":"name:asc"},{"key":"directoryId","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750"},{"key":"ids","value":"string"},{"key":"isMultiMetric","value":"true"}],"variable":[{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"source\": {\n \"pointer\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"timestamp\": {\n \"value\": \"\"\n },\n \"errorCode\": {\n \"value\": \"\"\n },\n \"httpStatus\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"traceId\": {\n \"value\": \"\"\n },\n \"help\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"db67c63a-8d1d-4a85-926f-08b9a831b737","name":"See error message for details","originalRequest":{"url":{"path":["analytics",":Namespace","reports"],"host":["{{baseUrl}}"],"query":[{"key":"page","value":"1"},{"key":"limit","value":"50"},{"key":"search","value":"string"},{"key":"sortBy","value":"name:asc"},{"key":"directoryId","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750"},{"key":"ids","value":"string"},{"key":"isMultiMetric","value":"true"}],"variable":[{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"source\": {\n \"pointer\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"timestamp\": {\n \"value\": \"\"\n },\n \"errorCode\": {\n \"value\": \"\"\n },\n \"httpStatus\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"traceId\": {\n \"value\": \"\"\n },\n \"help\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"7643053b-9dfa-4af9-9d2d-7c432eea2482","name":"Create report analysis","request":{"name":"Create report analysis","description":{"content":"\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permissions required (at least one):** `ANALYTICS_BACKEND_REPORTS_CREATE`, `ANALYTICS_BACKEND_REPORT_CREATE`\n\n**User role permission required:** `analytics: create`\n","type":"text/plain"},"url":{"path":["analytics",":Namespace","reports"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"analysis\": {\n \"title\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n },\n \"reportMetrics\": {\n \"value\": \"\"\n },\n \"filter\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n }\n },\n \"allowNull\": true,\n \"inlineAnalytics\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"58e5d031-0772-487e-bf60-9fdae0eac645","name":"ID of the created report","originalRequest":{"url":{"path":["analytics",":Namespace","reports"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"analysis\": {\n \"title\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n },\n \"reportMetrics\": {\n \"value\": \"\"\n },\n \"filter\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n }\n },\n \"allowNull\": true,\n \"inlineAnalytics\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"\"28a5c751-4a7f-54ba-224d-a3d44a2ba528\"","cookie":[],"_postman_previewlanguage":"json"},{"id":"3853e471-44ab-45ee-a3aa-06a31214525d","name":"See error message for details","originalRequest":{"url":{"path":["analytics",":Namespace","reports"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"analysis\": {\n \"title\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n },\n \"reportMetrics\": {\n \"value\": \"\"\n },\n \"filter\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n }\n },\n \"allowNull\": true,\n \"inlineAnalytics\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"source\": {\n \"pointer\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"timestamp\": {\n \"value\": \"\"\n },\n \"errorCode\": {\n \"value\": \"\"\n },\n \"httpStatus\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"traceId\": {\n \"value\": \"\"\n },\n \"help\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"3790417e-b811-41c0-aa5d-8ab0cfca082a","name":"See error message for details","originalRequest":{"url":{"path":["analytics",":Namespace","reports"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"analysis\": {\n \"title\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n },\n \"reportMetrics\": {\n \"value\": \"\"\n },\n \"filter\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n }\n },\n \"allowNull\": true,\n \"inlineAnalytics\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"source\": {\n \"pointer\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"timestamp\": {\n \"value\": \"\"\n },\n \"errorCode\": {\n \"value\": \"\"\n },\n \"httpStatus\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"traceId\": {\n \"value\": \"\"\n },\n \"help\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"903c9390-724c-407c-936e-420b048db40c","name":"Get report analysis details","request":{"name":"Get report analysis details","description":{"content":"\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permissions required (at least one):** `ANALYTICS_BACKEND_REPORTS_READ`, `ANALYTICS_BACKEND_REPORT_READ`\n\n**User role permission required:** `analytics: read`\n","type":"text/plain"},"url":{"path":["analytics",":Namespace","reports",":AnalysisId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."},{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"AnalysisId","description":"(Required) UUID of the analysis"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"eb27129a-5221-4679-a509-b6c3dcb9e2ed","name":"Get report analysis details","originalRequest":{"url":{"path":["analytics",":Namespace","reports",":AnalysisId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."},{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"AnalysisId","description":"(Required) UUID of the analysis"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"id\": \"5370bf3c-2dfa-4e89-98ff-07100cffee6c\",\n \"businessProfileId\": 48,\n \"name\": \"string\",\n \"description\": \"string\",\n \"author\": 3576,\n \"modifier\": 4436,\n \"updatedAt\": \"2003-01-29T06:57:15.587Z\",\n \"createdAt\": \"1959-11-08T03:38:55.703Z\",\n \"usedAt\": \"1976-07-28T18:17:35.336Z\",\n \"analysis\": {\n \"title\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n },\n \"reportMetrics\": {\n \"value\": \"\"\n },\n \"filter\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n }\n },\n \"isPredefinedAnalytic\": false,\n \"isDynamicAnalytic\": false,\n \"allowNull\": true,\n \"isDeleted\": true,\n \"namespace\": \"string\",\n \"directoryId\": \"a3e1a549-c211-e838-4058-9654d95e763f\",\n \"inlineAnalytics\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"20077e0a-3f72-47cc-8f53-523cf34a0bd9","name":"See error message for details","originalRequest":{"url":{"path":["analytics",":Namespace","reports",":AnalysisId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."},{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"AnalysisId","description":"(Required) UUID of the analysis"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"source\": {\n \"pointer\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"timestamp\": {\n \"value\": \"\"\n },\n \"errorCode\": {\n \"value\": \"\"\n },\n \"httpStatus\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"traceId\": {\n \"value\": \"\"\n },\n \"help\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"1d3eb40f-f0e3-447a-8bdc-87064abe4676","name":"See error message for details","originalRequest":{"url":{"path":["analytics",":Namespace","reports",":AnalysisId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."},{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"AnalysisId","description":"(Required) UUID of the analysis"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"source\": {\n \"pointer\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"timestamp\": {\n \"value\": \"\"\n },\n \"errorCode\": {\n \"value\": \"\"\n },\n \"httpStatus\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"traceId\": {\n \"value\": \"\"\n },\n \"help\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"e3d6d32d-d89d-48e9-b04c-17721f2df5dc","name":"Update report analysis","request":{"name":"Update report analysis","description":{"content":"\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permissions required (at least one):** `ANALYTICS_BACKEND_REPORTS_UPDATE`, `ANALYTICS_BACKEND_REPORT_UPDATE`\n\n**User role permission required:** `analytics: update`\n","type":"text/plain"},"url":{"path":["analytics",":Namespace","reports",":AnalysisId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"AnalysisId","description":"(Required) UUID of the analysis"},{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PUT","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"analysis\": {\n \"title\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n },\n \"reportMetrics\": {\n \"value\": \"\"\n },\n \"filter\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n }\n },\n \"allowNull\": true,\n \"inlineAnalytics\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"99d358d4-3621-48f6-b6d0-1e1bac0e79dc","name":"Report analysis updated","originalRequest":{"url":{"path":["analytics",":Namespace","reports",":AnalysisId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"AnalysisId","description":"(Required) UUID of the analysis"},{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"PUT","body":{"mode":"raw","raw":"{\n \"analysis\": {\n \"title\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n },\n \"reportMetrics\": {\n \"value\": \"\"\n },\n \"filter\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n }\n },\n \"allowNull\": true,\n \"inlineAnalytics\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"88a1521a-0957-49c4-9c52-96a795297f5c","name":"See error message for details","originalRequest":{"url":{"path":["analytics",":Namespace","reports",":AnalysisId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"AnalysisId","description":"(Required) UUID of the analysis"},{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"{\n \"analysis\": {\n \"title\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n },\n \"reportMetrics\": {\n \"value\": \"\"\n },\n \"filter\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n }\n },\n \"allowNull\": true,\n \"inlineAnalytics\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"source\": {\n \"pointer\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"timestamp\": {\n \"value\": \"\"\n },\n \"errorCode\": {\n \"value\": \"\"\n },\n \"httpStatus\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"traceId\": {\n \"value\": \"\"\n },\n \"help\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"09c6870f-2fd5-4e79-bcb3-9ecd8e04d644","name":"See error message for details","originalRequest":{"url":{"path":["analytics",":Namespace","reports",":AnalysisId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"AnalysisId","description":"(Required) UUID of the analysis"},{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"{\n \"analysis\": {\n \"title\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n },\n \"reportMetrics\": {\n \"value\": \"\"\n },\n \"filter\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n }\n },\n \"allowNull\": true,\n \"inlineAnalytics\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"source\": {\n \"pointer\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"timestamp\": {\n \"value\": \"\"\n },\n \"errorCode\": {\n \"value\": \"\"\n },\n \"httpStatus\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"traceId\": {\n \"value\": \"\"\n },\n \"help\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"0ff70599-4daa-4f15-85c4-ed1fae3c7fc8","name":"Delete report analysis","request":{"name":"Delete report analysis","description":{"content":"\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permissions required (at least one):** `ANALYTICS_BACKEND_REPORTS_DELETE`, `ANALYTICS_BACKEND_REPORT_DELETE`\n\n**User role permission required:** `analytics: delete`\n","type":"text/plain"},"url":{"path":["analytics",":Namespace","reports",":AnalysisId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"AnalysisId","description":"(Required) UUID of the analysis"},{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"290ebf03-a902-42d3-b5db-33abadfe7c1a","name":"Report analysis deleted","originalRequest":{"url":{"path":["analytics",":Namespace","reports",":AnalysisId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"AnalysisId","description":"(Required) UUID of the analysis"},{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"DELETE","body":{}},"status":"No Content","code":204,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"47dc376d-7b5b-478f-acc0-b065b5bd90bb","name":"See error message for details","originalRequest":{"url":{"path":["analytics",":Namespace","reports",":AnalysisId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"AnalysisId","description":"(Required) UUID of the analysis"},{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"source\": {\n \"pointer\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"timestamp\": {\n \"value\": \"\"\n },\n \"errorCode\": {\n \"value\": \"\"\n },\n \"httpStatus\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"traceId\": {\n \"value\": \"\"\n },\n \"help\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"7d320e15-5335-4441-bf95-bd791bd762b5","name":"See error message for details","originalRequest":{"url":{"path":["analytics",":Namespace","reports",":AnalysisId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"AnalysisId","description":"(Required) UUID of the analysis"},{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"source\": {\n \"pointer\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"timestamp\": {\n \"value\": \"\"\n },\n \"errorCode\": {\n \"value\": \"\"\n },\n \"httpStatus\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"traceId\": {\n \"value\": \"\"\n },\n \"help\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}],"event":[]},{"id":"b4729d51-1206-4f32-bd60-9cde978176b8","name":"Analytics: Sankeys","description":{"content":"","type":"text/plain"},"item":[{"id":"ef2ca16c-743d-461f-90a3-2b8fa096d31b","name":"Preview Sankey analysis","request":{"name":"Preview Sankey analysis","description":{"content":"Preview the results of a Sankey analysis. This request doesn't save the analysis.\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `ANALYTICS_BACKEND_SANKEY_READ`\n\n**User role permission required:** `analytics: read`\n","type":"text/plain"},"url":{"path":["analytics","analytics","v2","sankeys","preview"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json;charset=UTF-8"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"analysis\": {\n \"id\": {\n \"value\": \"\"\n },\n \"title\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n },\n \"sourceEvent\": {\n \"value\": \"\"\n },\n \"reverseOrder\": {\n \"value\": \"\"\n },\n \"numberOfSteps\": {\n \"value\": \"\"\n },\n \"numberOfPaths\": {\n \"value\": \"\"\n },\n \"drillDown\": {\n \"value\": \"\"\n },\n \"drillDownCount\": {\n \"value\": \"\"\n },\n \"dateFilter\": {\n \"value\": \"\"\n },\n \"filter\": {\n \"value\": \"\"\n },\n \"eventFilters\": {\n \"value\": \"\"\n },\n \"excludeEvents\": {\n \"value\": \"\"\n },\n \"firstOccurrenceOnly\": {\n \"value\": \"\"\n }\n },\n \"inlineAnalytics\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"f86085f6-01e8-4d34-8bf2-9fb805adf4f0","name":"Calculation results","originalRequest":{"url":{"path":["analytics","analytics","v2","sankeys","preview"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json;charset=UTF-8"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"analysis\": {\n \"id\": {\n \"value\": \"\"\n },\n \"title\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n },\n \"sourceEvent\": {\n \"value\": \"\"\n },\n \"reverseOrder\": {\n \"value\": \"\"\n },\n \"numberOfSteps\": {\n \"value\": \"\"\n },\n \"numberOfPaths\": {\n \"value\": \"\"\n },\n \"drillDown\": {\n \"value\": \"\"\n },\n \"drillDownCount\": {\n \"value\": \"\"\n },\n \"dateFilter\": {\n \"value\": \"\"\n },\n \"filter\": {\n \"value\": \"\"\n },\n \"eventFilters\": {\n \"value\": \"\"\n },\n \"excludeEvents\": {\n \"value\": \"\"\n },\n \"firstOccurrenceOnly\": {\n \"value\": \"\"\n }\n },\n \"inlineAnalytics\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json;charset=UTF-8"}],"body":"{\n \"results\": [\n [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"de55789b-0301-4c2c-9b01-338afaf0bad2","name":"See error message for details","originalRequest":{"url":{"path":["analytics","analytics","v2","sankeys","preview"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"analysis\": {\n \"id\": {\n \"value\": \"\"\n },\n \"title\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n },\n \"sourceEvent\": {\n \"value\": \"\"\n },\n \"reverseOrder\": {\n \"value\": \"\"\n },\n \"numberOfSteps\": {\n \"value\": \"\"\n },\n \"numberOfPaths\": {\n \"value\": \"\"\n },\n \"drillDown\": {\n \"value\": \"\"\n },\n \"drillDownCount\": {\n \"value\": \"\"\n },\n \"dateFilter\": {\n \"value\": \"\"\n },\n \"filter\": {\n \"value\": \"\"\n },\n \"eventFilters\": {\n \"value\": \"\"\n },\n \"excludeEvents\": {\n \"value\": \"\"\n },\n \"firstOccurrenceOnly\": {\n \"value\": \"\"\n }\n },\n \"inlineAnalytics\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"source\": {\n \"pointer\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"timestamp\": {\n \"value\": \"\"\n },\n \"errorCode\": {\n \"value\": \"\"\n },\n \"httpStatus\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"traceId\": {\n \"value\": \"\"\n },\n \"help\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"b9d1c4ae-79c6-4415-8e34-d2f730daef14","name":"See error message for details","originalRequest":{"url":{"path":["analytics","analytics","v2","sankeys","preview"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"analysis\": {\n \"id\": {\n \"value\": \"\"\n },\n \"title\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n },\n \"sourceEvent\": {\n \"value\": \"\"\n },\n \"reverseOrder\": {\n \"value\": \"\"\n },\n \"numberOfSteps\": {\n \"value\": \"\"\n },\n \"numberOfPaths\": {\n \"value\": \"\"\n },\n \"drillDown\": {\n \"value\": \"\"\n },\n \"drillDownCount\": {\n \"value\": \"\"\n },\n \"dateFilter\": {\n \"value\": \"\"\n },\n \"filter\": {\n \"value\": \"\"\n },\n \"eventFilters\": {\n \"value\": \"\"\n },\n \"excludeEvents\": {\n \"value\": \"\"\n },\n \"firstOccurrenceOnly\": {\n \"value\": \"\"\n }\n },\n \"inlineAnalytics\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"source\": {\n \"pointer\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"timestamp\": {\n \"value\": \"\"\n },\n \"errorCode\": {\n \"value\": \"\"\n },\n \"httpStatus\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"traceId\": {\n \"value\": \"\"\n },\n \"help\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"71cd9b50-4f51-40eb-8315-ee68f4026f62","name":"List Sankeys","request":{"name":"List Sankeys","description":{"content":"Returns a paginated list of Sankey analyses.\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `ANALYTICS_BACKEND_SANKEYS_LIST_READ`\n\n**User role permission required:** `analytics: read`\n","type":"text/plain"},"url":{"path":["analytics",":Namespace","sankeys"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"page","value":"1","description":"The number of the page to retrieve"},{"disabled":false,"key":"limit","value":"50","description":"Limit of items per page"},{"disabled":false,"key":"search","value":"string","description":"A string to search for in analyses' titles"},{"disabled":false,"key":"sortBy","value":"name:asc","description":"You can sort the results. The sorting direction is selected by adding `asc` or `desc`, for example `sortBy=name:desc`.\n"},{"disabled":false,"key":"directoryId","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","description":"Unique ID of the directory to retrieve analyses from"},{"disabled":false,"key":"ids","value":"string","description":"Comma-separated list of IDs (in UUID format) to filter results through"}],"variable":[{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"e3492044-12ae-4fb9-ac41-50fd4d42c0b8","name":"List of sankeys","originalRequest":{"url":{"path":["analytics",":Namespace","sankeys"],"host":["{{baseUrl}}"],"query":[{"key":"page","value":"1"},{"key":"limit","value":"50"},{"key":"search","value":"string"},{"key":"sortBy","value":"name:asc"},{"key":"directoryId","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750"},{"key":"ids","value":"string"}],"variable":[{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"data\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"meta\": {\n \"links\": {\n \"value\": \"\"\n },\n \"limit\": {\n \"value\": \"\"\n },\n \"count\": {\n \"value\": \"\"\n }\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"c8b28b80-aa67-4271-aedd-0599d0ea34da","name":"See error message for details","originalRequest":{"url":{"path":["analytics",":Namespace","sankeys"],"host":["{{baseUrl}}"],"query":[{"key":"page","value":"1"},{"key":"limit","value":"50"},{"key":"search","value":"string"},{"key":"sortBy","value":"name:asc"},{"key":"directoryId","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750"},{"key":"ids","value":"string"}],"variable":[{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"source\": {\n \"pointer\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"timestamp\": {\n \"value\": \"\"\n },\n \"errorCode\": {\n \"value\": \"\"\n },\n \"httpStatus\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"traceId\": {\n \"value\": \"\"\n },\n \"help\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"d2a61984-bb96-437f-a471-19676a6e6462","name":"See error message for details","originalRequest":{"url":{"path":["analytics",":Namespace","sankeys"],"host":["{{baseUrl}}"],"query":[{"key":"page","value":"1"},{"key":"limit","value":"50"},{"key":"search","value":"string"},{"key":"sortBy","value":"name:asc"},{"key":"directoryId","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750"},{"key":"ids","value":"string"}],"variable":[{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"source\": {\n \"pointer\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"timestamp\": {\n \"value\": \"\"\n },\n \"errorCode\": {\n \"value\": \"\"\n },\n \"httpStatus\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"traceId\": {\n \"value\": \"\"\n },\n \"help\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"9e504e7a-e2ec-49fc-aa51-7312ef93c0d7","name":"Create Sankey analysis","request":{"name":"Create Sankey analysis","description":{"content":"Create sankey analysis\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permissions required (at least one):** `ANALYTICS_BACKEND_SANKEYS_CREATE`, `ANALYTICS_BACKEND_SANKEY_CREATE`\n\n**User role permission required:** `analytics: create`\n","type":"text/plain"},"url":{"path":["analytics",":Namespace","sankeys"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"analysis\": {\n \"id\": {\n \"value\": \"\"\n },\n \"title\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n },\n \"sourceEvent\": {\n \"value\": \"\"\n },\n \"reverseOrder\": {\n \"value\": \"\"\n },\n \"numberOfSteps\": {\n \"value\": \"\"\n },\n \"numberOfPaths\": {\n \"value\": \"\"\n },\n \"drillDown\": {\n \"value\": \"\"\n },\n \"drillDownCount\": {\n \"value\": \"\"\n },\n \"dateFilter\": {\n \"value\": \"\"\n },\n \"filter\": {\n \"value\": \"\"\n },\n \"eventFilters\": {\n \"value\": \"\"\n },\n \"excludeEvents\": {\n \"value\": \"\"\n },\n \"firstOccurrenceOnly\": {\n \"value\": \"\"\n }\n },\n \"inlineAnalytics\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"8f0a3002-ee6d-4400-ac54-b8bfe5e5d007","name":"ID of the created analysis","originalRequest":{"url":{"path":["analytics",":Namespace","sankeys"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"analysis\": {\n \"id\": {\n \"value\": \"\"\n },\n \"title\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n },\n \"sourceEvent\": {\n \"value\": \"\"\n },\n \"reverseOrder\": {\n \"value\": \"\"\n },\n \"numberOfSteps\": {\n \"value\": \"\"\n },\n \"numberOfPaths\": {\n \"value\": \"\"\n },\n \"drillDown\": {\n \"value\": \"\"\n },\n \"drillDownCount\": {\n \"value\": \"\"\n },\n \"dateFilter\": {\n \"value\": \"\"\n },\n \"filter\": {\n \"value\": \"\"\n },\n \"eventFilters\": {\n \"value\": \"\"\n },\n \"excludeEvents\": {\n \"value\": \"\"\n },\n \"firstOccurrenceOnly\": {\n \"value\": \"\"\n }\n },\n \"inlineAnalytics\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"\"28a5c751-4a7f-54ba-224d-a3d44a2ba528\"","cookie":[],"_postman_previewlanguage":"json"},{"id":"8869de43-310a-4697-a7fe-cf5b694852b6","name":"See error message for details","originalRequest":{"url":{"path":["analytics",":Namespace","sankeys"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"analysis\": {\n \"id\": {\n \"value\": \"\"\n },\n \"title\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n },\n \"sourceEvent\": {\n \"value\": \"\"\n },\n \"reverseOrder\": {\n \"value\": \"\"\n },\n \"numberOfSteps\": {\n \"value\": \"\"\n },\n \"numberOfPaths\": {\n \"value\": \"\"\n },\n \"drillDown\": {\n \"value\": \"\"\n },\n \"drillDownCount\": {\n \"value\": \"\"\n },\n \"dateFilter\": {\n \"value\": \"\"\n },\n \"filter\": {\n \"value\": \"\"\n },\n \"eventFilters\": {\n \"value\": \"\"\n },\n \"excludeEvents\": {\n \"value\": \"\"\n },\n \"firstOccurrenceOnly\": {\n \"value\": \"\"\n }\n },\n \"inlineAnalytics\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"source\": {\n \"pointer\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"timestamp\": {\n \"value\": \"\"\n },\n \"errorCode\": {\n \"value\": \"\"\n },\n \"httpStatus\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"traceId\": {\n \"value\": \"\"\n },\n \"help\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"8c14f7ee-f5c2-4b88-a437-e1cabedbc692","name":"See error message for details","originalRequest":{"url":{"path":["analytics",":Namespace","sankeys"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"analysis\": {\n \"id\": {\n \"value\": \"\"\n },\n \"title\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n },\n \"sourceEvent\": {\n \"value\": \"\"\n },\n \"reverseOrder\": {\n \"value\": \"\"\n },\n \"numberOfSteps\": {\n \"value\": \"\"\n },\n \"numberOfPaths\": {\n \"value\": \"\"\n },\n \"drillDown\": {\n \"value\": \"\"\n },\n \"drillDownCount\": {\n \"value\": \"\"\n },\n \"dateFilter\": {\n \"value\": \"\"\n },\n \"filter\": {\n \"value\": \"\"\n },\n \"eventFilters\": {\n \"value\": \"\"\n },\n \"excludeEvents\": {\n \"value\": \"\"\n },\n \"firstOccurrenceOnly\": {\n \"value\": \"\"\n }\n },\n \"inlineAnalytics\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"source\": {\n \"pointer\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"timestamp\": {\n \"value\": \"\"\n },\n \"errorCode\": {\n \"value\": \"\"\n },\n \"httpStatus\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"traceId\": {\n \"value\": \"\"\n },\n \"help\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"65329614-777f-4b4e-8f4a-0f205114cc3b","name":"Get Sankey details","request":{"name":"Get Sankey details","description":{"content":"Retrieve the details of a Sankey analysis\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `ANALYTICS_BACKEND_SANKEYS_LIST_READ`\n\n**User role permission required:** `analytics: read`\n","type":"text/plain"},"url":{"path":["analytics",":Namespace","sankeys",":AnalysisId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."},{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"AnalysisId","description":"(Required) UUID of the analysis"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"04b93102-3ccf-49e9-91b2-3608091ea5e9","name":"Sankey analysis details","originalRequest":{"url":{"path":["analytics",":Namespace","sankeys",":AnalysisId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."},{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"AnalysisId","description":"(Required) UUID of the analysis"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"id\": \"5370bf3c-2dfa-4e89-98ff-07100cffee6c\",\n \"businessProfileId\": 48,\n \"name\": \"string\",\n \"description\": \"string\",\n \"author\": 3591,\n \"modifier\": 8690,\n \"updatedAt\": \"1988-05-29T00:22:29.645Z\",\n \"createdAt\": \"1959-06-28T16:55:26.595Z\",\n \"usedAt\": \"2016-06-30T08:02:49.858Z\",\n \"analysis\": {\n \"id\": {\n \"value\": \"\"\n },\n \"title\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n },\n \"sourceEvent\": {\n \"value\": \"\"\n },\n \"reverseOrder\": {\n \"value\": \"\"\n },\n \"numberOfSteps\": {\n \"value\": \"\"\n },\n \"numberOfPaths\": {\n \"value\": \"\"\n },\n \"drillDown\": {\n \"value\": \"\"\n },\n \"drillDownCount\": {\n \"value\": \"\"\n },\n \"dateFilter\": {\n \"value\": \"\"\n },\n \"filter\": {\n \"value\": \"\"\n },\n \"eventFilters\": {\n \"value\": \"\"\n },\n \"excludeEvents\": {\n \"value\": \"\"\n },\n \"firstOccurrenceOnly\": {\n \"value\": \"\"\n }\n },\n \"isPredefinedAnalytic\": false,\n \"isDynamicAnalytic\": true,\n \"isDeleted\": true,\n \"namespace\": \"string\",\n \"directoryId\": \"79df5fe3-d7e9-b11c-b8a7-6d6ca523318c\",\n \"inlineAnalytics\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"3f2ff015-e7cc-42ad-8c9b-b810d913f760","name":"See error message for details","originalRequest":{"url":{"path":["analytics",":Namespace","sankeys",":AnalysisId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."},{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"AnalysisId","description":"(Required) UUID of the analysis"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"source\": {\n \"pointer\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"timestamp\": {\n \"value\": \"\"\n },\n \"errorCode\": {\n \"value\": \"\"\n },\n \"httpStatus\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"traceId\": {\n \"value\": \"\"\n },\n \"help\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"2745607d-17dc-41c2-b6c5-4d97952d41cc","name":"See error message for details","originalRequest":{"url":{"path":["analytics",":Namespace","sankeys",":AnalysisId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."},{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"AnalysisId","description":"(Required) UUID of the analysis"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"source\": {\n \"pointer\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"timestamp\": {\n \"value\": \"\"\n },\n \"errorCode\": {\n \"value\": \"\"\n },\n \"httpStatus\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"traceId\": {\n \"value\": \"\"\n },\n \"help\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"0fb91d8b-e7c4-4c48-8e9a-2b8b039c040b","name":"Update Sankey","request":{"name":"Update Sankey","description":{"content":"Update an existing Sankey analysis\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permissions required (at least one):** `ANALYTICS_BACKEND_SANKEYS_UPDATE`, `ANALYTICS_BACKEND_SANKEY_UPDATE`\n\n**User role permission required:** `analytics: update`\n","type":"text/plain"},"url":{"path":["analytics",":Namespace","sankeys",":AnalysisId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."},{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"AnalysisId","description":"(Required) UUID of the analysis"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PUT","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"analysis\": {\n \"id\": {\n \"value\": \"\"\n },\n \"title\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n },\n \"sourceEvent\": {\n \"value\": \"\"\n },\n \"reverseOrder\": {\n \"value\": \"\"\n },\n \"numberOfSteps\": {\n \"value\": \"\"\n },\n \"numberOfPaths\": {\n \"value\": \"\"\n },\n \"drillDown\": {\n \"value\": \"\"\n },\n \"drillDownCount\": {\n \"value\": \"\"\n },\n \"dateFilter\": {\n \"value\": \"\"\n },\n \"filter\": {\n \"value\": \"\"\n },\n \"eventFilters\": {\n \"value\": \"\"\n },\n \"excludeEvents\": {\n \"value\": \"\"\n },\n \"firstOccurrenceOnly\": {\n \"value\": \"\"\n }\n },\n \"inlineAnalytics\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"0dd60fb3-35f1-483b-acfa-f0e1819c67dd","name":"Analysis updated","originalRequest":{"url":{"path":["analytics",":Namespace","sankeys",":AnalysisId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."},{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"AnalysisId","description":"(Required) UUID of the analysis"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"PUT","body":{"mode":"raw","raw":"{\n \"analysis\": {\n \"id\": {\n \"value\": \"\"\n },\n \"title\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n },\n \"sourceEvent\": {\n \"value\": \"\"\n },\n \"reverseOrder\": {\n \"value\": \"\"\n },\n \"numberOfSteps\": {\n \"value\": \"\"\n },\n \"numberOfPaths\": {\n \"value\": \"\"\n },\n \"drillDown\": {\n \"value\": \"\"\n },\n \"drillDownCount\": {\n \"value\": \"\"\n },\n \"dateFilter\": {\n \"value\": \"\"\n },\n \"filter\": {\n \"value\": \"\"\n },\n \"eventFilters\": {\n \"value\": \"\"\n },\n \"excludeEvents\": {\n \"value\": \"\"\n },\n \"firstOccurrenceOnly\": {\n \"value\": \"\"\n }\n },\n \"inlineAnalytics\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"53706a20-a396-4176-a5c1-32cbf8232ff5","name":"See error message for details","originalRequest":{"url":{"path":["analytics",":Namespace","sankeys",":AnalysisId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."},{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"AnalysisId","description":"(Required) UUID of the analysis"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"{\n \"analysis\": {\n \"id\": {\n \"value\": \"\"\n },\n \"title\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n },\n \"sourceEvent\": {\n \"value\": \"\"\n },\n \"reverseOrder\": {\n \"value\": \"\"\n },\n \"numberOfSteps\": {\n \"value\": \"\"\n },\n \"numberOfPaths\": {\n \"value\": \"\"\n },\n \"drillDown\": {\n \"value\": \"\"\n },\n \"drillDownCount\": {\n \"value\": \"\"\n },\n \"dateFilter\": {\n \"value\": \"\"\n },\n \"filter\": {\n \"value\": \"\"\n },\n \"eventFilters\": {\n \"value\": \"\"\n },\n \"excludeEvents\": {\n \"value\": \"\"\n },\n \"firstOccurrenceOnly\": {\n \"value\": \"\"\n }\n },\n \"inlineAnalytics\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"source\": {\n \"pointer\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"timestamp\": {\n \"value\": \"\"\n },\n \"errorCode\": {\n \"value\": \"\"\n },\n \"httpStatus\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"traceId\": {\n \"value\": \"\"\n },\n \"help\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"2b3fecdf-facd-47bf-a498-48c015f6fd95","name":"See error message for details","originalRequest":{"url":{"path":["analytics",":Namespace","sankeys",":AnalysisId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."},{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"AnalysisId","description":"(Required) UUID of the analysis"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"{\n \"analysis\": {\n \"id\": {\n \"value\": \"\"\n },\n \"title\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n },\n \"sourceEvent\": {\n \"value\": \"\"\n },\n \"reverseOrder\": {\n \"value\": \"\"\n },\n \"numberOfSteps\": {\n \"value\": \"\"\n },\n \"numberOfPaths\": {\n \"value\": \"\"\n },\n \"drillDown\": {\n \"value\": \"\"\n },\n \"drillDownCount\": {\n \"value\": \"\"\n },\n \"dateFilter\": {\n \"value\": \"\"\n },\n \"filter\": {\n \"value\": \"\"\n },\n \"eventFilters\": {\n \"value\": \"\"\n },\n \"excludeEvents\": {\n \"value\": \"\"\n },\n \"firstOccurrenceOnly\": {\n \"value\": \"\"\n }\n },\n \"inlineAnalytics\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"source\": {\n \"pointer\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"timestamp\": {\n \"value\": \"\"\n },\n \"errorCode\": {\n \"value\": \"\"\n },\n \"httpStatus\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"traceId\": {\n \"value\": \"\"\n },\n \"help\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"e5ce1170-32c7-4db1-94f8-47b1f746b8d5","name":"Delete Sankey","request":{"name":"Delete Sankey","description":{"content":"Delete a Sankey analysis\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permissions required (at least one):** `ANALYTICS_BACKEND_SANKEYS_DELETE`, `ANALYTICS_BACKEND_SANKEY_DELETE`\n\n**User role permission required:** `analytics: delete`\n","type":"text/plain"},"url":{"path":["analytics",":Namespace","sankeys",":AnalysisId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."},{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"AnalysisId","description":"(Required) UUID of the analysis"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"2bcf4b32-1f46-4a8a-b021-3ad030c3af2f","name":"Deleted sankeys analysis","originalRequest":{"url":{"path":["analytics",":Namespace","sankeys",":AnalysisId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."},{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"AnalysisId","description":"(Required) UUID of the analysis"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"DELETE","body":{}},"status":"No Content","code":204,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"61a676b3-d085-4990-be9a-6e67998711fb","name":"See error message for details","originalRequest":{"url":{"path":["analytics",":Namespace","sankeys",":AnalysisId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."},{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"AnalysisId","description":"(Required) UUID of the analysis"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"source\": {\n \"pointer\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"timestamp\": {\n \"value\": \"\"\n },\n \"errorCode\": {\n \"value\": \"\"\n },\n \"httpStatus\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"traceId\": {\n \"value\": \"\"\n },\n \"help\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"05762456-f7b5-4a8d-9afb-397c78eb8f0e","name":"See error message for details","originalRequest":{"url":{"path":["analytics",":Namespace","sankeys",":AnalysisId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."},{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"AnalysisId","description":"(Required) UUID of the analysis"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"source\": {\n \"pointer\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"timestamp\": {\n \"value\": \"\"\n },\n \"errorCode\": {\n \"value\": \"\"\n },\n \"httpStatus\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"traceId\": {\n \"value\": \"\"\n },\n \"help\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}],"event":[]},{"id":"c0b6ad8a-039e-469d-8653-107b443df9d2","name":"Analytics: Segmentations","description":{"content":"","type":"text/plain"},"item":[{"id":"75c0504b-6010-4dae-aad1-7faa46be5966","name":"Calculate dynamic segmentation","request":{"name":"Calculate dynamic segmentation","description":{"content":"Calculate a segmentation that includes variables (dynamic keys).\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `ANALYTICS_BACKEND_SEGMENTATION_READ`\n\n**User role permission required:** `analytics: read`\n","type":"text/plain"},"url":{"path":["analytics","analytics","v2","segmentations",":AnalysisId","dynamic","value"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"AnalysisId","description":"(Required) UUID of the analysis"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"variables\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"a05c1509-3562-4848-85f7-09e5c1708999","name":"Segmentation calculation results","originalRequest":{"url":{"path":["analytics","analytics","v2","segmentations",":AnalysisId","dynamic","value"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"AnalysisId","description":"(Required) UUID of the analysis"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"variables\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"calculationResults\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"totalContacts\": 2049,\n \"excludedContacts\": 2138,\n \"metadata\": {\n \"source\": {\n \"value\": \"\"\n }\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"fb6b0157-414d-44d4-aec2-fa37d0bf3cb6","name":"See error message for details","originalRequest":{"url":{"path":["analytics","analytics","v2","segmentations",":AnalysisId","dynamic","value"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"AnalysisId","description":"(Required) UUID of the analysis"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"variables\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"source\": {\n \"pointer\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"timestamp\": {\n \"value\": \"\"\n },\n \"errorCode\": {\n \"value\": \"\"\n },\n \"httpStatus\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"traceId\": {\n \"value\": \"\"\n },\n \"help\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"4e54eb73-6d70-4ddf-bcc1-1b311974178c","name":"See error message for details","originalRequest":{"url":{"path":["analytics","analytics","v2","segmentations",":AnalysisId","dynamic","value"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"AnalysisId","description":"(Required) UUID of the analysis"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"variables\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"source\": {\n \"pointer\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"timestamp\": {\n \"value\": \"\"\n },\n \"errorCode\": {\n \"value\": \"\"\n },\n \"httpStatus\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"traceId\": {\n \"value\": \"\"\n },\n \"help\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"c414a7a2-94d2-4a7f-b246-4a4a56f223d8","name":"Preview segmentation","request":{"name":"Preview segmentation","description":{"content":"Preview the results of a segmentation, with information about the results of each segment. This request does not save the analysis.\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `ANALYTICS_BACKEND_SEGMENTATION_READ`\n\n**User role permission required:** `analytics: read`\n","type":"text/plain"},"url":{"path":["analytics","analytics","v2","segmentations","preview"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"analysis\": {\n \"title\": {\n \"value\": \"\"\n },\n \"segments\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n },\n \"unique\": {\n \"value\": \"\"\n }\n },\n \"allowNull\": true,\n \"inlineAnalytics\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"a1eab650-8abf-410c-8c9e-32f1bef27c71","name":"Calculation result","originalRequest":{"url":{"path":["analytics","analytics","v2","segmentations","preview"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"analysis\": {\n \"title\": {\n \"value\": \"\"\n },\n \"segments\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n },\n \"unique\": {\n \"value\": \"\"\n }\n },\n \"allowNull\": true,\n \"inlineAnalytics\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"calculationResults\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"totalContacts\": 6015,\n \"excludedContacts\": 99,\n \"metadata\": {\n \"source\": {\n \"value\": \"\"\n }\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"ae4b69df-1fab-4cda-89bf-18ab375649cb","name":"See error message for details","originalRequest":{"url":{"path":["analytics","analytics","v2","segmentations","preview"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"analysis\": {\n \"title\": {\n \"value\": \"\"\n },\n \"segments\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n },\n \"unique\": {\n \"value\": \"\"\n }\n },\n \"allowNull\": true,\n \"inlineAnalytics\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"source\": {\n \"pointer\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"timestamp\": {\n \"value\": \"\"\n },\n \"errorCode\": {\n \"value\": \"\"\n },\n \"httpStatus\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"traceId\": {\n \"value\": \"\"\n },\n \"help\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"5aeb682b-5def-46d3-ac83-25c5b8218af1","name":"See error message for details","originalRequest":{"url":{"path":["analytics","analytics","v2","segmentations","preview"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"analysis\": {\n \"title\": {\n \"value\": \"\"\n },\n \"segments\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n },\n \"unique\": {\n \"value\": \"\"\n }\n },\n \"allowNull\": true,\n \"inlineAnalytics\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"source\": {\n \"pointer\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"timestamp\": {\n \"value\": \"\"\n },\n \"errorCode\": {\n \"value\": \"\"\n },\n \"httpStatus\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"traceId\": {\n \"value\": \"\"\n },\n \"help\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"3417f08e-9195-48ed-867d-eb75a5d17c6f","name":"Preview profiles in segmentation","request":{"name":"Preview profiles in segmentation","description":{"content":"Calculate a segmentation and get a list of profiles in each segment. This request doesn't save the segmentation in the database.\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `ANALYTICS_BACKEND_SEGMENTATION_READ`\n\n**User role permission required:** `analytics: read`\n","type":"text/plain"},"url":{"path":["analytics","analytics","v2","segmentations","preview","clients"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"analysis\": {\n \"title\": {\n \"value\": \"\"\n },\n \"segments\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n },\n \"unique\": {\n \"value\": \"\"\n }\n },\n \"allowNull\": true,\n \"inlineAnalytics\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"5255aabb-273c-41a6-b98c-bbe7c8caa19e","name":"Array of segments","originalRequest":{"url":{"path":["analytics","analytics","v2","segmentations","preview","clients"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"analysis\": {\n \"title\": {\n \"value\": \"\"\n },\n \"segments\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n },\n \"unique\": {\n \"value\": \"\"\n }\n },\n \"allowNull\": true,\n \"inlineAnalytics\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"[\n [\n 3487.727754263015,\n 885.3533950500903\n ],\n [\n 4399.812239991074,\n 9563.298885134063\n ]\n]","cookie":[],"_postman_previewlanguage":"json"},{"id":"aed51b35-7693-4d04-a6ca-9a974cd73fa0","name":"See error message for details","originalRequest":{"url":{"path":["analytics","analytics","v2","segmentations","preview","clients"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"analysis\": {\n \"title\": {\n \"value\": \"\"\n },\n \"segments\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n },\n \"unique\": {\n \"value\": \"\"\n }\n },\n \"allowNull\": true,\n \"inlineAnalytics\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"source\": {\n \"pointer\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"timestamp\": {\n \"value\": \"\"\n },\n \"errorCode\": {\n \"value\": \"\"\n },\n \"httpStatus\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"traceId\": {\n \"value\": \"\"\n },\n \"help\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"5489ecf8-c6ea-4d04-afda-7e3024d209b8","name":"See error message for details","originalRequest":{"url":{"path":["analytics","analytics","v2","segmentations","preview","clients"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"analysis\": {\n \"title\": {\n \"value\": \"\"\n },\n \"segments\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n },\n \"unique\": {\n \"value\": \"\"\n }\n },\n \"allowNull\": true,\n \"inlineAnalytics\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"source\": {\n \"pointer\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"timestamp\": {\n \"value\": \"\"\n },\n \"errorCode\": {\n \"value\": \"\"\n },\n \"httpStatus\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"traceId\": {\n \"value\": \"\"\n },\n \"help\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"1830436e-dce8-484a-971f-2f565766e8e6","name":"Get first matching segmentation for profile from provided list","request":{"name":"Get first matching segmentation for profile from provided list","description":{"content":"Check a number of segmentations and return the first one that matches the selected profile. Note that `segmentations` is a list of objects to check, and each object can also refer to multiple segmentations.\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permissions required (at least one):** `ANALYTICS_BACKEND_SEGMENTATIONS_READ`, `ANALYTICS_BACKEND_SEGMENTATION_READ`\n\n**User role permission required:** `analytics: read`\n","type":"text/plain"},"url":{"path":["analytics","profiles","segmentations","firstMatch","by",":IdentifierType"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"uuid","key":"IdentifierType","description":"(Required) Profile identifier type"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"identifierValue\": \"string\",\n \"segmentations\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"68fa349d-92b4-4b40-b67c-a823df90da43","name":"Identifier (`id` from the request body) of the matched entry","originalRequest":{"url":{"path":["analytics","profiles","segmentations","firstMatch","by",":IdentifierType"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"uuid","key":"IdentifierType","description":"(Required) Profile identifier type"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"identifierValue\": \"string\",\n \"segmentations\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"\"bd022385-3a2f-bb0f-98d8-83b0332d5750\"","cookie":[],"_postman_previewlanguage":"json"},{"id":"7c183ecd-2c13-49da-80d6-62821ca076f1","name":"See error message for details","originalRequest":{"url":{"path":["analytics","profiles","segmentations","firstMatch","by",":IdentifierType"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"uuid","key":"IdentifierType","description":"(Required) Profile identifier type"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"identifierValue\": \"string\",\n \"segmentations\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"source\": {\n \"pointer\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"timestamp\": {\n \"value\": \"\"\n },\n \"errorCode\": {\n \"value\": \"\"\n },\n \"httpStatus\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"traceId\": {\n \"value\": \"\"\n },\n \"help\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"83abdbf4-10bf-4a8b-8b12-692bfa50d7ff","name":"See error message for details","originalRequest":{"url":{"path":["analytics","profiles","segmentations","firstMatch","by",":IdentifierType"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"uuid","key":"IdentifierType","description":"(Required) Profile identifier type"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"identifierValue\": \"string\",\n \"segmentations\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"source\": {\n \"pointer\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"timestamp\": {\n \"value\": \"\"\n },\n \"errorCode\": {\n \"value\": \"\"\n },\n \"httpStatus\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"traceId\": {\n \"value\": \"\"\n },\n \"help\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"61552c89-a14e-4607-b890-9e18574ebf2f","name":"List segmentations","request":{"name":"List segmentations","description":{"content":"Returns a paginated list of segmentations.\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `ANALYTICS_BACKEND_SEGMENTATIONS_LIST_READ`\n\n**User role permission required:** `analytics: read`\n","type":"text/plain"},"url":{"path":["analytics",":Namespace","segmentations"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"page","value":"1","description":"The number of the page to retrieve"},{"disabled":false,"key":"limit","value":"50","description":"Limit of items per page"},{"disabled":false,"key":"search","value":"string","description":"A string to search for in analyses' titles"},{"disabled":false,"key":"sortBy","value":"name:asc","description":"You can sort the results. The sorting direction is selected by adding `asc` or `desc`, for example `sortBy=name:desc`.\n"},{"disabled":false,"key":"directoryId","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","description":"Unique ID of the directory to retrieve analyses from"},{"disabled":false,"key":"ids","value":"string","description":"Comma-separated list of IDs (in UUID format) to filter results through"},{"disabled":false,"key":"shareType","value":"INTERNAL","description":"Type of sharing process"}],"variable":[{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"84d2160d-8b14-48c0-83a0-0e189ad361a5","name":"List of segmentations","originalRequest":{"url":{"path":["analytics",":Namespace","segmentations"],"host":["{{baseUrl}}"],"query":[{"key":"page","value":"1"},{"key":"limit","value":"50"},{"key":"search","value":"string"},{"key":"sortBy","value":"name:asc"},{"key":"directoryId","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750"},{"key":"ids","value":"string"},{"key":"shareType","value":"INTERNAL"}],"variable":[{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"data\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"meta\": {\n \"links\": {\n \"value\": \"\"\n },\n \"limit\": {\n \"value\": \"\"\n },\n \"count\": {\n \"value\": \"\"\n }\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"5e086d89-db1e-4b7b-91dc-a285d4abc219","name":"See error message for details","originalRequest":{"url":{"path":["analytics",":Namespace","segmentations"],"host":["{{baseUrl}}"],"query":[{"key":"page","value":"1"},{"key":"limit","value":"50"},{"key":"search","value":"string"},{"key":"sortBy","value":"name:asc"},{"key":"directoryId","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750"},{"key":"ids","value":"string"},{"key":"shareType","value":"INTERNAL"}],"variable":[{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"source\": {\n \"pointer\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"timestamp\": {\n \"value\": \"\"\n },\n \"errorCode\": {\n \"value\": \"\"\n },\n \"httpStatus\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"traceId\": {\n \"value\": \"\"\n },\n \"help\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"f1259014-690a-45a4-b69d-b477e4cc8483","name":"See error message for details","originalRequest":{"url":{"path":["analytics",":Namespace","segmentations"],"host":["{{baseUrl}}"],"query":[{"key":"page","value":"1"},{"key":"limit","value":"50"},{"key":"search","value":"string"},{"key":"sortBy","value":"name:asc"},{"key":"directoryId","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750"},{"key":"ids","value":"string"},{"key":"shareType","value":"INTERNAL"}],"variable":[{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"source\": {\n \"pointer\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"timestamp\": {\n \"value\": \"\"\n },\n \"errorCode\": {\n \"value\": \"\"\n },\n \"httpStatus\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"traceId\": {\n \"value\": \"\"\n },\n \"help\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"ff966774-d77c-43cd-9d9c-2cd9770170a9","name":"Create segmentation","request":{"name":"Create segmentation","description":{"content":"Create a new segmentation\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permissions required (at least one):** `ANALYTICS_BACKEND_SEGMENTATIONS_CREATE`, `ANALYTICS_BACKEND_SEGMENTATION_CREATE`\n\n**User role permission required:** `analytics: create`\n","type":"text/plain"},"url":{"path":["analytics",":Namespace","segmentations"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"analysis\": {\n \"title\": {\n \"value\": \"\"\n },\n \"segments\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n },\n \"unique\": {\n \"value\": \"\"\n }\n },\n \"isVisibleForClientProfile\": true,\n \"inlineAnalytics\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"2f8c1edc-88e3-4254-acb8-0960bd1d7c2d","name":"ID of the created segmentation","originalRequest":{"url":{"path":["analytics",":Namespace","segmentations"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"analysis\": {\n \"title\": {\n \"value\": \"\"\n },\n \"segments\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n },\n \"unique\": {\n \"value\": \"\"\n }\n },\n \"isVisibleForClientProfile\": true,\n \"inlineAnalytics\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"\"28a5c751-4a7f-54ba-224d-a3d44a2ba528\"","cookie":[],"_postman_previewlanguage":"json"},{"id":"e70aac1d-e327-4c42-833d-bd41972b4684","name":"See error message for details","originalRequest":{"url":{"path":["analytics",":Namespace","segmentations"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"analysis\": {\n \"title\": {\n \"value\": \"\"\n },\n \"segments\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n },\n \"unique\": {\n \"value\": \"\"\n }\n },\n \"isVisibleForClientProfile\": true,\n \"inlineAnalytics\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"source\": {\n \"pointer\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"timestamp\": {\n \"value\": \"\"\n },\n \"errorCode\": {\n \"value\": \"\"\n },\n \"httpStatus\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"traceId\": {\n \"value\": \"\"\n },\n \"help\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"d67c85da-2769-4634-bafa-53c5a3e13777","name":"See error message for details","originalRequest":{"url":{"path":["analytics",":Namespace","segmentations"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"analysis\": {\n \"title\": {\n \"value\": \"\"\n },\n \"segments\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n },\n \"unique\": {\n \"value\": \"\"\n }\n },\n \"isVisibleForClientProfile\": true,\n \"inlineAnalytics\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"source\": {\n \"pointer\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"timestamp\": {\n \"value\": \"\"\n },\n \"errorCode\": {\n \"value\": \"\"\n },\n \"httpStatus\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"traceId\": {\n \"value\": \"\"\n },\n \"help\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"b4520389-109a-46a3-9272-ea734f1c0da9","name":"Get segmentation details","request":{"name":"Get segmentation details","description":{"content":"Retrieve the details of a segmentation analysis\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permissions required (at least one):** `ANALYTICS_BACKEND_SEGMENTATIONS_READ`, `ANALYTICS_BACKEND_SEGMENTATION_READ`\n\n**User role permission required:** `analytics: read`\n","type":"text/plain"},"url":{"path":["analytics",":Namespace","segmentations",":AnalysisId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"AnalysisId","description":"(Required) UUID of the analysis"},{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"edf0587f-a0d0-407a-9816-85d2da83f934","name":"Segmentation details","originalRequest":{"url":{"path":["analytics",":Namespace","segmentations",":AnalysisId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"AnalysisId","description":"(Required) UUID of the analysis"},{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"id\": \"5370bf3c-2dfa-4e89-98ff-07100cffee6c\",\n \"businessProfileId\": 48,\n \"name\": \"string\",\n \"description\": \"string\",\n \"author\": 2070,\n \"modifier\": 9397,\n \"updatedAt\": \"1997-02-15T12:15:49.696Z\",\n \"createdAt\": \"1973-02-10T00:15:36.533Z\",\n \"usedAt\": \"2021-02-08T10:42:30.610Z\",\n \"analysis\": {\n \"title\": {\n \"value\": \"\"\n },\n \"segments\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n },\n \"unique\": {\n \"value\": \"\"\n }\n },\n \"isPredefinedAnalytic\": false,\n \"isVisibleForClientProfile\": false,\n \"isDynamicAnalytic\": true,\n \"isDeleted\": true,\n \"namespace\": \"string\",\n \"directoryId\": \"cb3bd157-a908-3425-d6f0-5a0083a4ee53\",\n \"sharing\": {\n \"process\": {\n \"value\": \"\"\n },\n \"attribute\": {\n \"value\": \"\"\n }\n },\n \"inlineAnalytics\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"1c7890e5-627a-48f8-9125-d99f85e31a68","name":"See error message for details","originalRequest":{"url":{"path":["analytics",":Namespace","segmentations",":AnalysisId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"AnalysisId","description":"(Required) UUID of the analysis"},{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"source\": {\n \"pointer\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"timestamp\": {\n \"value\": \"\"\n },\n \"errorCode\": {\n \"value\": \"\"\n },\n \"httpStatus\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"traceId\": {\n \"value\": \"\"\n },\n \"help\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"76cb5b73-8b74-4b5a-b07c-a17246cd9a15","name":"See error message for details","originalRequest":{"url":{"path":["analytics",":Namespace","segmentations",":AnalysisId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"AnalysisId","description":"(Required) UUID of the analysis"},{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"source\": {\n \"pointer\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"timestamp\": {\n \"value\": \"\"\n },\n \"errorCode\": {\n \"value\": \"\"\n },\n \"httpStatus\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"traceId\": {\n \"value\": \"\"\n },\n \"help\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"c605a7e4-acfe-453b-8589-1ee9037a7512","name":"Update segmentation","request":{"name":"Update segmentation","description":{"content":"Update an existing segmentation analysis.\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permissions required (at least one):** `ANALYTICS_BACKEND_SEGMENTATIONS_UPDATE`, `ANALYTICS_BACKEND_SEGMENTATION_UPDATE`\n\n**User role permission required:** `analytics: update`\n","type":"text/plain"},"url":{"path":["analytics",":Namespace","segmentations",":AnalysisId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"AnalysisId","description":"(Required) UUID of the analysis"},{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PUT","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"analysis\": {\n \"title\": {\n \"value\": \"\"\n },\n \"segments\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n },\n \"unique\": {\n \"value\": \"\"\n }\n },\n \"isVisibleForClientProfile\": true,\n \"inlineAnalytics\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"94dbdfe8-3cea-442e-83da-279293687405","name":"Segmentation updated","originalRequest":{"url":{"path":["analytics",":Namespace","segmentations",":AnalysisId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"AnalysisId","description":"(Required) UUID of the analysis"},{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"PUT","body":{"mode":"raw","raw":"{\n \"analysis\": {\n \"title\": {\n \"value\": \"\"\n },\n \"segments\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n },\n \"unique\": {\n \"value\": \"\"\n }\n },\n \"isVisibleForClientProfile\": true,\n \"inlineAnalytics\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"605bda23-8cbb-4617-b430-49275355502f","name":"See error message for details","originalRequest":{"url":{"path":["analytics",":Namespace","segmentations",":AnalysisId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"AnalysisId","description":"(Required) UUID of the analysis"},{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"{\n \"analysis\": {\n \"title\": {\n \"value\": \"\"\n },\n \"segments\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n },\n \"unique\": {\n \"value\": \"\"\n }\n },\n \"isVisibleForClientProfile\": true,\n \"inlineAnalytics\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"source\": {\n \"pointer\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"timestamp\": {\n \"value\": \"\"\n },\n \"errorCode\": {\n \"value\": \"\"\n },\n \"httpStatus\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"traceId\": {\n \"value\": \"\"\n },\n \"help\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"17c4aac2-cb65-4a09-97ad-e35734f25493","name":"See error message for details","originalRequest":{"url":{"path":["analytics",":Namespace","segmentations",":AnalysisId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"AnalysisId","description":"(Required) UUID of the analysis"},{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"{\n \"analysis\": {\n \"title\": {\n \"value\": \"\"\n },\n \"segments\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n },\n \"unique\": {\n \"value\": \"\"\n }\n },\n \"isVisibleForClientProfile\": true,\n \"inlineAnalytics\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"source\": {\n \"pointer\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"timestamp\": {\n \"value\": \"\"\n },\n \"errorCode\": {\n \"value\": \"\"\n },\n \"httpStatus\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"traceId\": {\n \"value\": \"\"\n },\n \"help\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"986fe000-8045-4ded-b309-62e892f0d897","name":"Delete segmentation","request":{"name":"Delete segmentation","description":{"content":"\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permissions required (at least one):** `ANALYTICS_BACKEND_SEGMENTATIONS_DELETE`, `ANALYTICS_BACKEND_SEGMENTATION_DELETE`\n\n**User role permission required:** `analytics: delete`\n","type":"text/plain"},"url":{"path":["analytics",":Namespace","segmentations",":AnalysisId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"AnalysisId","description":"(Required) UUID of the analysis"},{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"1ed296ad-caa9-4a72-bd70-f71067c9efc7","name":"Deleted segmentation analysis","originalRequest":{"url":{"path":["analytics",":Namespace","segmentations",":AnalysisId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"AnalysisId","description":"(Required) UUID of the analysis"},{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"DELETE","body":{}},"status":"No Content","code":204,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"9e425be2-55e7-4ced-8082-bddc49f4fc81","name":"See error message for details","originalRequest":{"url":{"path":["analytics",":Namespace","segmentations",":AnalysisId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"AnalysisId","description":"(Required) UUID of the analysis"},{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"source\": {\n \"pointer\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"timestamp\": {\n \"value\": \"\"\n },\n \"errorCode\": {\n \"value\": \"\"\n },\n \"httpStatus\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"traceId\": {\n \"value\": \"\"\n },\n \"help\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"ee1a7b6f-ef26-47f7-83cc-dfc71a919b1b","name":"See error message for details","originalRequest":{"url":{"path":["analytics",":Namespace","segmentations",":AnalysisId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"AnalysisId","description":"(Required) UUID of the analysis"},{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"source\": {\n \"pointer\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"timestamp\": {\n \"value\": \"\"\n },\n \"errorCode\": {\n \"value\": \"\"\n },\n \"httpStatus\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"traceId\": {\n \"value\": \"\"\n },\n \"help\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"69ec996c-cb58-4e0a-a5a0-e8555eda196d","name":"Get segmentations for profile card","request":{"name":"Get segmentations for profile card","description":{"content":"Retrieve segmentations to display on a profile's card in the Profiles module (`\"isVisibleForClientProfile\": true`) in the [segmentation config](https://developers.synerise.com/AnalyticsSuite/AnalyticsSuite.html#operation/addSegmentationPOST_v2)).\n\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `ANALYTICS_BACKEND_SEGMENTATIONS_FOR_CLIENT_READ`\n\n**User role permission required (at least one):** `analytics: read`, `client_analytics_preview: read`\n","type":"text/plain"},"url":{"path":["analytics",":Namespace","segmentations","visible-for-client","by",":IdentifierType"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."},{"disabled":false,"type":"any","value":"uuid","key":"IdentifierType","description":"(Required) Profile identifier type"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"identifierValue\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"4d216aa9-5013-491c-97ee-c7281eddcba3","name":"List of checked segmentations configured as visible on the profile card","originalRequest":{"url":{"path":["analytics",":Namespace","segmentations","visible-for-client","by",":IdentifierType"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."},{"disabled":false,"type":"any","value":"uuid","key":"IdentifierType","description":"(Required) Profile identifier type"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"identifierValue\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"[\n {\n \"analyticId\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"result\": {\n \"value\": \"\"\n }\n },\n {\n \"analyticId\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"result\": {\n \"value\": \"\"\n }\n }\n]","cookie":[],"_postman_previewlanguage":"json"},{"id":"76de9d52-f812-4b07-983d-4ed78dcfb331","name":"See error message for details","originalRequest":{"url":{"path":["analytics",":Namespace","segmentations","visible-for-client","by",":IdentifierType"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."},{"disabled":false,"type":"any","value":"uuid","key":"IdentifierType","description":"(Required) Profile identifier type"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"identifierValue\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"source\": {\n \"pointer\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"timestamp\": {\n \"value\": \"\"\n },\n \"errorCode\": {\n \"value\": \"\"\n },\n \"httpStatus\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"traceId\": {\n \"value\": \"\"\n },\n \"help\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"7f88a2ad-625a-4365-9f00-5b246712978a","name":"See error message for details","originalRequest":{"url":{"path":["analytics",":Namespace","segmentations","visible-for-client","by",":IdentifierType"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."},{"disabled":false,"type":"any","value":"uuid","key":"IdentifierType","description":"(Required) Profile identifier type"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"identifierValue\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"source\": {\n \"pointer\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"timestamp\": {\n \"value\": \"\"\n },\n \"errorCode\": {\n \"value\": \"\"\n },\n \"httpStatus\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"traceId\": {\n \"value\": \"\"\n },\n \"help\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"39157279-9337-4a20-8e83-735fe561e6b6","name":"Check if profile in segmentations","request":{"name":"Check if profile in segmentations","description":{"content":"Check if a profile is in a number of segmentations.\n\n**IMPORTANT**: This endpoint is limited to:\n- 10 segmentations per request\n- 500 requests per second\n- 10 requests per second per profile\n\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `ANALYTICS_BACKEND_SEGMENTATIONS_LIST_READ`\n\n**User role permission required:** `analytics: read`\n","type":"text/plain"},"url":{"path":["analytics",":Namespace","segmentations","check","by",":IdentifierType"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"uuid","key":"IdentifierType","description":"(Required) Profile identifier type"},{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"identifierValue\": \"string\",\n \"segmentationIds\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"3ac7f1d8-9553-4a27-9c51-636f09ed39cc","name":"Check results","originalRequest":{"url":{"path":["analytics",":Namespace","segmentations","check","by",":IdentifierType"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"uuid","key":"IdentifierType","description":"(Required) Profile identifier type"},{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"identifierValue\": \"string\",\n \"segmentationIds\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"[\n {\n \"related\": {\n \"value\": \"\"\n },\n \"segmentationId\": {\n \"value\": \"\"\n }\n },\n {\n \"related\": {\n \"value\": \"\"\n },\n \"segmentationId\": {\n \"value\": \"\"\n }\n }\n]","cookie":[],"_postman_previewlanguage":"json"},{"id":"b6a454d6-9472-478d-8217-9144612ba3aa","name":"See error message for details","originalRequest":{"url":{"path":["analytics",":Namespace","segmentations","check","by",":IdentifierType"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"uuid","key":"IdentifierType","description":"(Required) Profile identifier type"},{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"identifierValue\": \"string\",\n \"segmentationIds\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"source\": {\n \"pointer\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"timestamp\": {\n \"value\": \"\"\n },\n \"errorCode\": {\n \"value\": \"\"\n },\n \"httpStatus\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"traceId\": {\n \"value\": \"\"\n },\n \"help\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"62e8ea29-3529-4d3b-b717-1b7b4a8d9259","name":"See error message for details","originalRequest":{"url":{"path":["analytics",":Namespace","segmentations","check","by",":IdentifierType"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"uuid","key":"IdentifierType","description":"(Required) Profile identifier type"},{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"identifierValue\": \"string\",\n \"segmentationIds\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"source\": {\n \"pointer\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"timestamp\": {\n \"value\": \"\"\n },\n \"errorCode\": {\n \"value\": \"\"\n },\n \"httpStatus\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"traceId\": {\n \"value\": \"\"\n },\n \"help\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}],"event":[]},{"id":"53d91176-2b44-4553-93ed-e3e598e32669","name":"Analytics: Trends","description":{"content":"","type":"text/plain"},"item":[{"id":"3f12615d-deed-4ce3-8681-c125cc43a4f1","name":"List trends","request":{"name":"List trends","description":{"content":"Returns a paginated list of trends.\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `ANALYTICS_BACKEND_TRENDS_LIST_READ`\n\n**User role permission required:** `analytics: read`\n","type":"text/plain"},"url":{"path":["analytics",":Namespace","trends"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"page","value":"1","description":"The number of the page to retrieve"},{"disabled":false,"key":"limit","value":"50","description":"Limit of items per page"},{"disabled":false,"key":"search","value":"string","description":"A string to search for in analyses' titles"},{"disabled":false,"key":"sortBy","value":"name:asc","description":"You can sort the results. The sorting direction is selected by adding `asc` or `desc`, for example `sortBy=name:desc`.\n"},{"disabled":false,"key":"directoryId","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","description":"Unique ID of the directory to retrieve analyses from"},{"disabled":false,"key":"ids","value":"string","description":"Comma-separated list of IDs (in UUID format) to filter results through"}],"variable":[{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"1f30864e-e7ec-4dc1-a6cb-eb380875cea8","name":"List of trends","originalRequest":{"url":{"path":["analytics",":Namespace","trends"],"host":["{{baseUrl}}"],"query":[{"key":"page","value":"1"},{"key":"limit","value":"50"},{"key":"search","value":"string"},{"key":"sortBy","value":"name:asc"},{"key":"directoryId","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750"},{"key":"ids","value":"string"}],"variable":[{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"data\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"meta\": {\n \"links\": {\n \"value\": \"\"\n },\n \"limit\": {\n \"value\": \"\"\n },\n \"count\": {\n \"value\": \"\"\n }\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"702d2da5-729b-4972-b9c7-e888c6aba82b","name":"See error message for details","originalRequest":{"url":{"path":["analytics",":Namespace","trends"],"host":["{{baseUrl}}"],"query":[{"key":"page","value":"1"},{"key":"limit","value":"50"},{"key":"search","value":"string"},{"key":"sortBy","value":"name:asc"},{"key":"directoryId","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750"},{"key":"ids","value":"string"}],"variable":[{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"source\": {\n \"pointer\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"timestamp\": {\n \"value\": \"\"\n },\n \"errorCode\": {\n \"value\": \"\"\n },\n \"httpStatus\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"traceId\": {\n \"value\": \"\"\n },\n \"help\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"d2bb1e67-2048-4cff-a4ea-d5a0efd70bc5","name":"See error message for details","originalRequest":{"url":{"path":["analytics",":Namespace","trends"],"host":["{{baseUrl}}"],"query":[{"key":"page","value":"1"},{"key":"limit","value":"50"},{"key":"search","value":"string"},{"key":"sortBy","value":"name:asc"},{"key":"directoryId","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750"},{"key":"ids","value":"string"}],"variable":[{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"source\": {\n \"pointer\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"timestamp\": {\n \"value\": \"\"\n },\n \"errorCode\": {\n \"value\": \"\"\n },\n \"httpStatus\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"traceId\": {\n \"value\": \"\"\n },\n \"help\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"0f1fe0d8-f947-49db-96d7-33eb1ea7d17f","name":"Create a trend","request":{"name":"Create a trend","description":{"content":"Create a trend.\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `ANALYTICS_BACKEND_TRENDS_CREATE`\n\n**User role permission required:** `analytics_trends: create`\n","type":"text/plain"},"url":{"path":["analytics",":Namespace","trends"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"analysis\": {\n \"filter\": {\n \"value\": \"\"\n },\n \"title\": {\n \"value\": \"\"\n },\n \"trend\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n }\n },\n \"inlineAnalytics\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"dce96433-1e78-43fa-a881-eb15f4f080f9","name":"Trend created","originalRequest":{"url":{"path":["analytics",":Namespace","trends"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"analysis\": {\n \"filter\": {\n \"value\": \"\"\n },\n \"title\": {\n \"value\": \"\"\n },\n \"trend\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n }\n },\n \"inlineAnalytics\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"\"28a5c751-4a7f-54ba-224d-a3d44a2ba528\"","cookie":[],"_postman_previewlanguage":"json"},{"id":"80f23f6d-dd2e-4bb9-879a-10b5a53d6652","name":"See error message for details","originalRequest":{"url":{"path":["analytics",":Namespace","trends"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"analysis\": {\n \"filter\": {\n \"value\": \"\"\n },\n \"title\": {\n \"value\": \"\"\n },\n \"trend\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n }\n },\n \"inlineAnalytics\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"source\": {\n \"pointer\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"timestamp\": {\n \"value\": \"\"\n },\n \"errorCode\": {\n \"value\": \"\"\n },\n \"httpStatus\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"traceId\": {\n \"value\": \"\"\n },\n \"help\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"cfca8a01-7fcc-4d3c-a8b3-997a01fdfbae","name":"See error message for details","originalRequest":{"url":{"path":["analytics",":Namespace","trends"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"analysis\": {\n \"filter\": {\n \"value\": \"\"\n },\n \"title\": {\n \"value\": \"\"\n },\n \"trend\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n }\n },\n \"inlineAnalytics\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"source\": {\n \"pointer\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"timestamp\": {\n \"value\": \"\"\n },\n \"errorCode\": {\n \"value\": \"\"\n },\n \"httpStatus\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"traceId\": {\n \"value\": \"\"\n },\n \"help\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"dbd5b0b4-7a43-4124-a737-e2938ac8038d","name":"Get trend details","request":{"name":"Get trend details","description":{"content":"Retrieve the definition of a single trend\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permissions required (at least one):** `ANALYTICS_BACKEND_TRENDS_READ`, `ANALYTICS_BACKEND_TREND_READ`\n\n**User role permission required:** `analytics_trends: read`\n","type":"text/plain"},"url":{"path":["analytics",":Namespace","trends",":AnalysisId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."},{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"AnalysisId","description":"(Required) UUID of the analysis"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"4b1b8779-df09-49f3-b74f-eddf590297fe","name":"Details of a trend","originalRequest":{"url":{"path":["analytics",":Namespace","trends",":AnalysisId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."},{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"AnalysisId","description":"(Required) UUID of the analysis"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"id\": \"5370bf3c-2dfa-4e89-98ff-07100cffee6c\",\n \"businessProfileId\": 48,\n \"name\": \"string\",\n \"description\": \"string\",\n \"author\": 6123,\n \"modifier\": 9277,\n \"updatedAt\": \"1985-10-25T00:34:03.359Z\",\n \"createdAt\": \"1963-12-07T04:39:24.973Z\",\n \"usedAt\": \"2025-02-24T09:37:50.611Z\",\n \"analysis\": {\n \"filter\": {\n \"value\": \"\"\n },\n \"title\": {\n \"value\": \"\"\n },\n \"trend\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n }\n },\n \"isPredefinedAnalytic\": true,\n \"isDynamicAnalytic\": false,\n \"isDeleted\": false,\n \"namespace\": \"string\",\n \"directoryId\": \"8e61b080-cf03-b6e9-b30e-1e476c69ed36\",\n \"inlineAnalytics\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"6b229b2a-a475-428e-9e49-2412dfcb4d44","name":"See error message for details","originalRequest":{"url":{"path":["analytics",":Namespace","trends",":AnalysisId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."},{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"AnalysisId","description":"(Required) UUID of the analysis"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"source\": {\n \"pointer\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"timestamp\": {\n \"value\": \"\"\n },\n \"errorCode\": {\n \"value\": \"\"\n },\n \"httpStatus\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"traceId\": {\n \"value\": \"\"\n },\n \"help\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"062a83a0-276f-4610-8bf2-26ede003f888","name":"See error message for details","originalRequest":{"url":{"path":["analytics",":Namespace","trends",":AnalysisId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."},{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"AnalysisId","description":"(Required) UUID of the analysis"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"source\": {\n \"pointer\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"timestamp\": {\n \"value\": \"\"\n },\n \"errorCode\": {\n \"value\": \"\"\n },\n \"httpStatus\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"traceId\": {\n \"value\": \"\"\n },\n \"help\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"47091660-d1dc-4781-a26a-eef0a9c465e6","name":"Update trend","request":{"name":"Update trend","description":{"content":"Update an existing trend\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permissions required (at least one):** `ANALYTICS_BACKEND_TRENDS_UPDATE`, `ANALYTICS_BACKEND_TREND_UPDATE`\n\n**User role permission required:** `analytics_trends: update`\n","type":"text/plain"},"url":{"path":["analytics",":Namespace","trends",":AnalysisId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."},{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"AnalysisId","description":"(Required) UUID of the analysis"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PUT","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"analysis\": {\n \"filter\": {\n \"value\": \"\"\n },\n \"title\": {\n \"value\": \"\"\n },\n \"trend\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n }\n },\n \"inlineAnalytics\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"14fe01b5-5cac-4d9c-acc4-ea3bcd74c96d","name":"Trend updated","originalRequest":{"url":{"path":["analytics",":Namespace","trends",":AnalysisId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."},{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"AnalysisId","description":"(Required) UUID of the analysis"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"PUT","body":{"mode":"raw","raw":"{\n \"analysis\": {\n \"filter\": {\n \"value\": \"\"\n },\n \"title\": {\n \"value\": \"\"\n },\n \"trend\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n }\n },\n \"inlineAnalytics\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"43ac5332-92b3-4518-af58-5de25cf9cdab","name":"See error message for details","originalRequest":{"url":{"path":["analytics",":Namespace","trends",":AnalysisId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."},{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"AnalysisId","description":"(Required) UUID of the analysis"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"{\n \"analysis\": {\n \"filter\": {\n \"value\": \"\"\n },\n \"title\": {\n \"value\": \"\"\n },\n \"trend\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n }\n },\n \"inlineAnalytics\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"source\": {\n \"pointer\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"timestamp\": {\n \"value\": \"\"\n },\n \"errorCode\": {\n \"value\": \"\"\n },\n \"httpStatus\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"traceId\": {\n \"value\": \"\"\n },\n \"help\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"eeb019ff-0a84-4c7a-bfac-44ce57649cfd","name":"See error message for details","originalRequest":{"url":{"path":["analytics",":Namespace","trends",":AnalysisId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."},{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"AnalysisId","description":"(Required) UUID of the analysis"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"{\n \"analysis\": {\n \"filter\": {\n \"value\": \"\"\n },\n \"title\": {\n \"value\": \"\"\n },\n \"trend\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n }\n },\n \"inlineAnalytics\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"source\": {\n \"pointer\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"timestamp\": {\n \"value\": \"\"\n },\n \"errorCode\": {\n \"value\": \"\"\n },\n \"httpStatus\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"traceId\": {\n \"value\": \"\"\n },\n \"help\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"4f29f803-429a-4447-a1d1-a4b67fda9be5","name":"Delete trend","request":{"name":"Delete trend","description":{"content":"Delete a trend.\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permissions required (at least one):** `ANALYTICS_BACKEND_TRENDS_DELETE`, `ANALYTICS_BACKEND_TREND_DELETE`\n\n**User role permission required:** `analytics_trends: delete`\n","type":"text/plain"},"url":{"path":["analytics",":Namespace","trends",":AnalysisId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."},{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"AnalysisId","description":"(Required) UUID of the analysis"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"9260cf7c-0c0b-475a-8506-0fde06b9bb48","name":"Trend deleted","originalRequest":{"url":{"path":["analytics",":Namespace","trends",":AnalysisId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."},{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"AnalysisId","description":"(Required) UUID of the analysis"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"DELETE","body":{}},"status":"No Content","code":204,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"5460168d-68d7-4eef-be37-c76ef568beed","name":"See error message for details","originalRequest":{"url":{"path":["analytics",":Namespace","trends",":AnalysisId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."},{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"AnalysisId","description":"(Required) UUID of the analysis"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"source\": {\n \"pointer\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"timestamp\": {\n \"value\": \"\"\n },\n \"errorCode\": {\n \"value\": \"\"\n },\n \"httpStatus\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"traceId\": {\n \"value\": \"\"\n },\n \"help\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"e5f03ea5-f2cc-4fc1-9369-c561b3ca6ec5","name":"See error message for details","originalRequest":{"url":{"path":["analytics",":Namespace","trends",":AnalysisId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"profiles","key":"Namespace","description":"(Required) Namespace. Currently, only `profiles` is available."},{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"AnalysisId","description":"(Required) UUID of the analysis"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"source\": {\n \"pointer\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"timestamp\": {\n \"value\": \"\"\n },\n \"errorCode\": {\n \"value\": \"\"\n },\n \"httpStatus\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"traceId\": {\n \"value\": \"\"\n },\n \"help\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"91f49b7a-2c2f-47a2-abc9-c0986dc69eee","name":"Calculate trend with parameter override","request":{"name":"Calculate trend with parameter override","description":{"content":"Recalculate a trend with new parameters and/or variable (dynamic key) values.\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `ANALYTICS_BACKEND_TREND_READ`\n\n**User role permission required:** `analytics: read`\n","type":"text/plain"},"url":{"path":["analytics","analytics","v2","trends",":AnalysisId","recalculate","override"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"AnalysisId","description":"(Required) UUID of the analysis"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"title\": \"string\",\n \"dateFilter\": {\n \"value\": \"\"\n },\n \"aggregateDataBy\": {\n \"type\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"filter\": {\n \"matching\": {\n \"value\": \"\"\n },\n \"expressions\": {\n \"value\": \"\"\n },\n \"expression\": {\n \"value\": \"\"\n },\n \"groupBy\": {\n \"value\": \"\"\n }\n },\n \"variables\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"overrideNested\": false\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"0f968324-3484-4e49-9318-aaa3ba26bd95","name":"Trend calculation result","originalRequest":{"url":{"path":["analytics","analytics","v2","trends",":AnalysisId","recalculate","override"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"AnalysisId","description":"(Required) UUID of the analysis"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"title\": \"string\",\n \"dateFilter\": {\n \"value\": \"\"\n },\n \"aggregateDataBy\": {\n \"type\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"filter\": {\n \"matching\": {\n \"value\": \"\"\n },\n \"expressions\": {\n \"value\": \"\"\n },\n \"expression\": {\n \"value\": \"\"\n },\n \"groupBy\": {\n \"value\": \"\"\n }\n },\n \"variables\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"overrideNested\": false\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"name\": \"string\",\n \"metadata\": {\n \"aggregateDataBy\": {\n \"value\": \"\"\n },\n \"dateFilter\": {\n \"value\": \"\"\n }\n },\n \"items\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"legends\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"077f022a-e9f8-4a23-a865-8754a59b6679","name":"See error message for details","originalRequest":{"url":{"path":["analytics","analytics","v2","trends",":AnalysisId","recalculate","override"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"AnalysisId","description":"(Required) UUID of the analysis"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"title\": \"string\",\n \"dateFilter\": {\n \"value\": \"\"\n },\n \"aggregateDataBy\": {\n \"type\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"filter\": {\n \"matching\": {\n \"value\": \"\"\n },\n \"expressions\": {\n \"value\": \"\"\n },\n \"expression\": {\n \"value\": \"\"\n },\n \"groupBy\": {\n \"value\": \"\"\n }\n },\n \"variables\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"overrideNested\": false\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"source\": {\n \"pointer\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"timestamp\": {\n \"value\": \"\"\n },\n \"errorCode\": {\n \"value\": \"\"\n },\n \"httpStatus\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"traceId\": {\n \"value\": \"\"\n },\n \"help\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"efaf0eeb-f823-429b-8210-47bb3183651c","name":"See error message for details","originalRequest":{"url":{"path":["analytics","analytics","v2","trends",":AnalysisId","recalculate","override"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"AnalysisId","description":"(Required) UUID of the analysis"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"title\": \"string\",\n \"dateFilter\": {\n \"value\": \"\"\n },\n \"aggregateDataBy\": {\n \"type\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"filter\": {\n \"matching\": {\n \"value\": \"\"\n },\n \"expressions\": {\n \"value\": \"\"\n },\n \"expression\": {\n \"value\": \"\"\n },\n \"groupBy\": {\n \"value\": \"\"\n }\n },\n \"variables\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"overrideNested\": false\n}","options":{"raw":{"language":"json"}}}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"source\": {\n \"pointer\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"timestamp\": {\n \"value\": \"\"\n },\n \"errorCode\": {\n \"value\": \"\"\n },\n \"httpStatus\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"traceId\": {\n \"value\": \"\"\n },\n \"help\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"b2748712-f2da-47b6-9e75-2cc3ab8b6d87","name":"Preview trend calculation","request":{"name":"Preview trend calculation","description":{"content":"\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `ANALYTICS_BACKEND_TREND_READ`\n\n**User role permission required:** `analytics: read`\n","type":"text/plain"},"url":{"path":["analytics","analytics","v2","trends","preview"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"analysis\": {\n \"analysis\": {\n \"value\": \"\"\n },\n \"tags\": {\n \"value\": \"\"\n }\n },\n \"inlineAnalytics\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"f0728571-efde-47ad-94ce-a25893a211ed","name":"Calculation result","originalRequest":{"url":{"path":["analytics","analytics","v2","trends","preview"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"analysis\": {\n \"analysis\": {\n \"value\": \"\"\n },\n \"tags\": {\n \"value\": \"\"\n }\n },\n \"inlineAnalytics\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"name\": \"string\",\n \"metadata\": {\n \"aggregateDataBy\": {\n \"value\": \"\"\n },\n \"dateFilter\": {\n \"value\": \"\"\n }\n },\n \"items\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"legends\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"495361a3-c5a2-4985-a19f-027c500da739","name":"See error message for details","originalRequest":{"url":{"path":["analytics","analytics","v2","trends","preview"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"analysis\": {\n \"analysis\": {\n \"value\": \"\"\n },\n \"tags\": {\n \"value\": \"\"\n }\n },\n \"inlineAnalytics\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"source\": {\n \"pointer\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"timestamp\": {\n \"value\": \"\"\n },\n \"errorCode\": {\n \"value\": \"\"\n },\n \"httpStatus\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"traceId\": {\n \"value\": \"\"\n },\n \"help\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"778ed180-c29e-45e0-9835-9f0579b0f949","name":"See error message for details","originalRequest":{"url":{"path":["analytics","analytics","v2","trends","preview"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"analysis\": {\n \"analysis\": {\n \"value\": \"\"\n },\n \"tags\": {\n \"value\": \"\"\n }\n },\n \"inlineAnalytics\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"source\": {\n \"pointer\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"timestamp\": {\n \"value\": \"\"\n },\n \"errorCode\": {\n \"value\": \"\"\n },\n \"httpStatus\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"traceId\": {\n \"value\": \"\"\n },\n \"help\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}],"event":[]},{"id":"824f556c-e81c-489d-b790-b04aa0510f03","name":"Analytics: Management","description":{"content":"","type":"text/plain"},"item":[{"id":"c97dd1fa-1910-4fb6-8a2f-ac188d8eab4d","name":"Delete multiple analyses","request":{"name":"Delete multiple analyses","description":{"content":"Deletes many analytics in a single request\n\n---\n\n**API consumer:** Synerise User\n\n**User role permission required:** `analytics: delete`\n","type":"text/plain"},"url":{"path":["analytics","analytics","batch-delete"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"aggregateIds\": [\n \"be57b54d-a9a6-2b69-e647-15141ef52d15\",\n \"e2ff967e-591c-a786-6ab3-50c2f73408bd\"\n ],\n \"expressionIds\": [\n \"8cbb45b3-11c4-00a4-e7e0-4b7ca4fb5175\",\n \"f43055b9-264c-f8d7-9c4f-bfe1f77829d6\"\n ],\n \"funnelIds\": [\n \"35afa61e-21c0-4734-56c1-9acaacaa83bc\",\n \"d5be72e0-6054-aae9-658a-d8d7ffc54833\"\n ],\n \"histogramIds\": [\n \"96575fc7-de6a-4dd6-c87c-e574abc9093c\",\n \"5625c02e-2c44-dcfa-1054-6eaabeb56620\"\n ],\n \"metricIds\": [\n \"54e755c3-6492-9a24-fc7c-ccf61a942099\",\n \"f2262a6c-04b6-1bd3-cd9e-414cedb11acc\"\n ],\n \"reportIds\": [\n \"a56e1639-96b0-d43f-9639-e8dfefc8b819\",\n \"5af127bc-d3e1-c48a-5675-960088f121c3\"\n ],\n \"sankeyIds\": [\n \"ebf3d713-afe2-7477-0641-6823725cf5f1\",\n \"d207c9f9-9db3-2587-eb1f-65c3304b9700\"\n ],\n \"segmentationIds\": [\n \"547b4a68-3b76-4685-ca96-232a2e7d91d0\",\n \"7cabc6e2-5e1e-1e1d-4008-14faa897ef80\"\n ],\n \"trendIds\": [\n \"6058f4b0-42e7-71f8-0fdd-43b0999fea58\",\n \"663e2d4c-b6f3-cae0-4bd8-d08de4c3e787\"\n ]\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"36f0d1fa-c249-44c7-b49c-f0e85349f96b","name":"Analytics deleted","originalRequest":{"url":{"path":["analytics","analytics","batch-delete"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"POST","body":{"mode":"raw","raw":"{\n \"aggregateIds\": [\n \"be57b54d-a9a6-2b69-e647-15141ef52d15\",\n \"e2ff967e-591c-a786-6ab3-50c2f73408bd\"\n ],\n \"expressionIds\": [\n \"8cbb45b3-11c4-00a4-e7e0-4b7ca4fb5175\",\n \"f43055b9-264c-f8d7-9c4f-bfe1f77829d6\"\n ],\n \"funnelIds\": [\n \"35afa61e-21c0-4734-56c1-9acaacaa83bc\",\n \"d5be72e0-6054-aae9-658a-d8d7ffc54833\"\n ],\n \"histogramIds\": [\n \"96575fc7-de6a-4dd6-c87c-e574abc9093c\",\n \"5625c02e-2c44-dcfa-1054-6eaabeb56620\"\n ],\n \"metricIds\": [\n \"54e755c3-6492-9a24-fc7c-ccf61a942099\",\n \"f2262a6c-04b6-1bd3-cd9e-414cedb11acc\"\n ],\n \"reportIds\": [\n \"a56e1639-96b0-d43f-9639-e8dfefc8b819\",\n \"5af127bc-d3e1-c48a-5675-960088f121c3\"\n ],\n \"sankeyIds\": [\n \"ebf3d713-afe2-7477-0641-6823725cf5f1\",\n \"d207c9f9-9db3-2587-eb1f-65c3304b9700\"\n ],\n \"segmentationIds\": [\n \"547b4a68-3b76-4685-ca96-232a2e7d91d0\",\n \"7cabc6e2-5e1e-1e1d-4008-14faa897ef80\"\n ],\n \"trendIds\": [\n \"6058f4b0-42e7-71f8-0fdd-43b0999fea58\",\n \"663e2d4c-b6f3-cae0-4bd8-d08de4c3e787\"\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"No Content","code":204,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"5b2b34d3-295e-4546-ac09-69dccf7bd5b3","name":"See error message for details","originalRequest":{"url":{"path":["analytics","analytics","batch-delete"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"aggregateIds\": [\n \"be57b54d-a9a6-2b69-e647-15141ef52d15\",\n \"e2ff967e-591c-a786-6ab3-50c2f73408bd\"\n ],\n \"expressionIds\": [\n \"8cbb45b3-11c4-00a4-e7e0-4b7ca4fb5175\",\n \"f43055b9-264c-f8d7-9c4f-bfe1f77829d6\"\n ],\n \"funnelIds\": [\n \"35afa61e-21c0-4734-56c1-9acaacaa83bc\",\n \"d5be72e0-6054-aae9-658a-d8d7ffc54833\"\n ],\n \"histogramIds\": [\n \"96575fc7-de6a-4dd6-c87c-e574abc9093c\",\n \"5625c02e-2c44-dcfa-1054-6eaabeb56620\"\n ],\n \"metricIds\": [\n \"54e755c3-6492-9a24-fc7c-ccf61a942099\",\n \"f2262a6c-04b6-1bd3-cd9e-414cedb11acc\"\n ],\n \"reportIds\": [\n \"a56e1639-96b0-d43f-9639-e8dfefc8b819\",\n \"5af127bc-d3e1-c48a-5675-960088f121c3\"\n ],\n \"sankeyIds\": [\n \"ebf3d713-afe2-7477-0641-6823725cf5f1\",\n \"d207c9f9-9db3-2587-eb1f-65c3304b9700\"\n ],\n \"segmentationIds\": [\n \"547b4a68-3b76-4685-ca96-232a2e7d91d0\",\n \"7cabc6e2-5e1e-1e1d-4008-14faa897ef80\"\n ],\n \"trendIds\": [\n \"6058f4b0-42e7-71f8-0fdd-43b0999fea58\",\n \"663e2d4c-b6f3-cae0-4bd8-d08de4c3e787\"\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"source\": {\n \"pointer\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"timestamp\": {\n \"value\": \"\"\n },\n \"errorCode\": {\n \"value\": \"\"\n },\n \"httpStatus\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"traceId\": {\n \"value\": \"\"\n },\n \"help\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"8f4fe1e0-ab8a-4cc3-98b2-133f4d7f6e1d","name":"See error message for details","originalRequest":{"url":{"path":["analytics","analytics","batch-delete"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"aggregateIds\": [\n \"be57b54d-a9a6-2b69-e647-15141ef52d15\",\n \"e2ff967e-591c-a786-6ab3-50c2f73408bd\"\n ],\n \"expressionIds\": [\n \"8cbb45b3-11c4-00a4-e7e0-4b7ca4fb5175\",\n \"f43055b9-264c-f8d7-9c4f-bfe1f77829d6\"\n ],\n \"funnelIds\": [\n \"35afa61e-21c0-4734-56c1-9acaacaa83bc\",\n \"d5be72e0-6054-aae9-658a-d8d7ffc54833\"\n ],\n \"histogramIds\": [\n \"96575fc7-de6a-4dd6-c87c-e574abc9093c\",\n \"5625c02e-2c44-dcfa-1054-6eaabeb56620\"\n ],\n \"metricIds\": [\n \"54e755c3-6492-9a24-fc7c-ccf61a942099\",\n \"f2262a6c-04b6-1bd3-cd9e-414cedb11acc\"\n ],\n \"reportIds\": [\n \"a56e1639-96b0-d43f-9639-e8dfefc8b819\",\n \"5af127bc-d3e1-c48a-5675-960088f121c3\"\n ],\n \"sankeyIds\": [\n \"ebf3d713-afe2-7477-0641-6823725cf5f1\",\n \"d207c9f9-9db3-2587-eb1f-65c3304b9700\"\n ],\n \"segmentationIds\": [\n \"547b4a68-3b76-4685-ca96-232a2e7d91d0\",\n \"7cabc6e2-5e1e-1e1d-4008-14faa897ef80\"\n ],\n \"trendIds\": [\n \"6058f4b0-42e7-71f8-0fdd-43b0999fea58\",\n \"663e2d4c-b6f3-cae0-4bd8-d08de4c3e787\"\n ]\n}","options":{"raw":{"language":"json"}}}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"source\": {\n \"pointer\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"timestamp\": {\n \"value\": \"\"\n },\n \"errorCode\": {\n \"value\": \"\"\n },\n \"httpStatus\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"traceId\": {\n \"value\": \"\"\n },\n \"help\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"4d8ad5e3-5e76-402d-9732-e31173d7f7dd","name":"List directories","request":{"name":"List directories","description":{"content":"Returns a list of directories for a given analytic type.\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `ANALYTICS_DESCRIPTION_ANALYTICS_READ`\n\n**User role permission required:** `analytics: read`\n","type":"text/plain"},"url":{"path":["analytics","directories"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"analyticType","value":"SANKEY","description":"(Required) Type of object"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"0d0f48dc-54b9-4d85-9b28-fbf6dc9881e5","name":"List of directories","originalRequest":{"url":{"path":["analytics","directories"],"host":["{{baseUrl}}"],"query":[{"key":"analyticType","value":"SANKEY"}],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"[\n {\n \"createdAt\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n },\n \"isDefault\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"objectType\": {\n \"value\": \"\"\n },\n \"updatedAt\": {\n \"value\": \"\"\n },\n \"businessProfileId\": {\n \"value\": \"\"\n }\n },\n {\n \"createdAt\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n },\n \"isDefault\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"objectType\": {\n \"value\": \"\"\n },\n \"updatedAt\": {\n \"value\": \"\"\n },\n \"businessProfileId\": {\n \"value\": \"\"\n }\n }\n]","cookie":[],"_postman_previewlanguage":"json"},{"id":"60db9edb-0c80-4661-a6ea-41e232c9759c","name":"See error message for details","originalRequest":{"url":{"path":["analytics","directories"],"host":["{{baseUrl}}"],"query":[{"key":"analyticType","value":"SANKEY"}],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"source\": {\n \"pointer\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"timestamp\": {\n \"value\": \"\"\n },\n \"errorCode\": {\n \"value\": \"\"\n },\n \"httpStatus\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"traceId\": {\n \"value\": \"\"\n },\n \"help\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"4efdfb47-9aa8-467b-803d-7b958d87c69a","name":"See error message for details","originalRequest":{"url":{"path":["analytics","directories"],"host":["{{baseUrl}}"],"query":[{"key":"analyticType","value":"SANKEY"}],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"source\": {\n \"pointer\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"timestamp\": {\n \"value\": \"\"\n },\n \"errorCode\": {\n \"value\": \"\"\n },\n \"httpStatus\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"traceId\": {\n \"value\": \"\"\n },\n \"help\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"9c4dcb7f-fe86-4103-8605-7befb12356ab","name":"Create directory","request":{"name":"Create directory","description":{"content":"Creates a new directory\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `ANALYTICS_DESCRIPTION_ANALYTICS_CREATE`\n\n**User role permission required:** `analytics: create`\n","type":"text/plain"},"url":{"path":["analytics","directories"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"analyticType\": \"REPORT\",\n \"name\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"177967be-ecdc-4459-90d4-f3433d5e385e","name":"ID of the created directory","originalRequest":{"url":{"path":["analytics","directories"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"analyticType\": \"REPORT\",\n \"name\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Created","code":201,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"id\": \"3b624e29-f9e4-861d-85a4-56da039e4956\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"6d5e7b79-82bb-4f08-9981-7bc33d87df3b","name":"See error message for details","originalRequest":{"url":{"path":["analytics","directories"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"analyticType\": \"REPORT\",\n \"name\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"source\": {\n \"pointer\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"timestamp\": {\n \"value\": \"\"\n },\n \"errorCode\": {\n \"value\": \"\"\n },\n \"httpStatus\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"traceId\": {\n \"value\": \"\"\n },\n \"help\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"4d675220-5b36-428c-a7e8-d718f4775a7b","name":"See error message for details","originalRequest":{"url":{"path":["analytics","directories"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"analyticType\": \"REPORT\",\n \"name\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"source\": {\n \"pointer\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"timestamp\": {\n \"value\": \"\"\n },\n \"errorCode\": {\n \"value\": \"\"\n },\n \"httpStatus\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"traceId\": {\n \"value\": \"\"\n },\n \"help\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"2b24b110-1bf8-4608-9bb2-52875e95b4a1","name":"Delete directory","request":{"name":"Delete directory","description":{"content":"Deletes a directory. If the directory contains any analyses, they are moved to the default directory.\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `ANALYTICS_DESCRIPTION_ANALYTICS_DELETE`\n\n**User role permission required:** `analytics: delete`\n","type":"text/plain"},"url":{"path":["analytics","directories",":DirectoryId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"DirectoryId","description":"(Required) ID of a directory"}]},"method":"DELETE","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"2e8ee723-4a1d-4301-adbb-c6a5424cbca0","name":"Directory deleted","originalRequest":{"url":{"path":["analytics","directories",":DirectoryId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"DirectoryId","description":"(Required) ID of a directory"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"DELETE","body":{}},"status":"No Content","code":204,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"6f0af1e2-d4c5-441e-8744-f50a3930d9be","name":"Rename directory","request":{"name":"Rename directory","description":{"content":"Renames a directory\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `ANALYTICS_DESCRIPTION_ANALYTICS_UPDATE`\n\n**User role permission required:** `analytics: update`\n","type":"text/plain"},"url":{"path":["analytics","directories",":DirectoryId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"DirectoryId","description":"(Required) ID of a directory"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PATCH","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"newName\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"6e241359-7e04-4848-b8f0-ce7fed921757","name":"Directory renamed","originalRequest":{"url":{"path":["analytics","directories",":DirectoryId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"DirectoryId","description":"(Required) ID of a directory"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"PATCH","body":{"mode":"raw","raw":"{\n \"newName\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"No Content","code":204,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"8383cb6c-2623-4959-81ac-2da43a3a6ad5","name":"See error message for details","originalRequest":{"url":{"path":["analytics","directories",":DirectoryId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"DirectoryId","description":"(Required) ID of a directory"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"{\n \"newName\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"source\": {\n \"pointer\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"timestamp\": {\n \"value\": \"\"\n },\n \"errorCode\": {\n \"value\": \"\"\n },\n \"httpStatus\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"traceId\": {\n \"value\": \"\"\n },\n \"help\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"50141401-3f54-4bb6-8a0d-661bb2799b22","name":"See error message for details","originalRequest":{"url":{"path":["analytics","directories",":DirectoryId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"DirectoryId","description":"(Required) ID of a directory"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"{\n \"newName\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"source\": {\n \"pointer\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"timestamp\": {\n \"value\": \"\"\n },\n \"errorCode\": {\n \"value\": \"\"\n },\n \"httpStatus\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"traceId\": {\n \"value\": \"\"\n },\n \"help\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"9d0e58af-d3d7-40b9-9baf-b7a2bb8dfe27","name":"Change Directory","request":{"name":"Change Directory","description":{"content":"Moves an analysis to another directory\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `ANALYTICS_DESCRIPTION_ANALYTICS_UPDATE`\n\n**User role permission required:** `analytics: update`\n","type":"text/plain"},"url":{"path":["analytics","directories","change",":AnalysisId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"AnalysisId","description":"(Required) UUID of the analysis"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PATCH","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"analyticType\": \"METRIC\",\n \"newDir\": \"38c543c5-9211-23dc-9b94-ea3ca2a082b1\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"14fa91e7-5d1d-4d6c-bbf4-4ed877d70cea","name":"Analysis moved","originalRequest":{"url":{"path":["analytics","directories","change",":AnalysisId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"AnalysisId","description":"(Required) UUID of the analysis"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"PATCH","body":{"mode":"raw","raw":"{\n \"analyticType\": \"METRIC\",\n \"newDir\": \"38c543c5-9211-23dc-9b94-ea3ca2a082b1\"\n}","options":{"raw":{"language":"json"}}}},"status":"No Content","code":204,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"9bf5dc7a-f181-435c-a0c5-b0955accb6e0","name":"See error message for details","originalRequest":{"url":{"path":["analytics","directories","change",":AnalysisId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"AnalysisId","description":"(Required) UUID of the analysis"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"{\n \"analyticType\": \"METRIC\",\n \"newDir\": \"38c543c5-9211-23dc-9b94-ea3ca2a082b1\"\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"source\": {\n \"pointer\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"timestamp\": {\n \"value\": \"\"\n },\n \"errorCode\": {\n \"value\": \"\"\n },\n \"httpStatus\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"traceId\": {\n \"value\": \"\"\n },\n \"help\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"624c700b-3352-4eb2-9317-60b8056d3c9e","name":"See error message for details","originalRequest":{"url":{"path":["analytics","directories","change",":AnalysisId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"AnalysisId","description":"(Required) UUID of the analysis"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"{\n \"analyticType\": \"METRIC\",\n \"newDir\": \"38c543c5-9211-23dc-9b94-ea3ca2a082b1\"\n}","options":{"raw":{"language":"json"}}}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"source\": {\n \"pointer\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"timestamp\": {\n \"value\": \"\"\n },\n \"errorCode\": {\n \"value\": \"\"\n },\n \"httpStatus\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"traceId\": {\n \"value\": \"\"\n },\n \"help\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}],"event":[]},{"id":"0a9130e3-de5d-4cc0-97fe-e20464b65db0","name":"Brickworks: Schemas","description":{"content":"","type":"text/plain"},"item":[{"id":"54cabdad-4da3-493c-8bad-c4dfa3b18d1f","name":"Get schemas","request":{"name":"Get schemas","description":{"content":"Retrieve a list of schemas. You can paginate the results, filter by schema type, and search for a phrase in schema names.\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `BRICKWORKS_SCHEMAS_READ`\n\n**User role permission required:** `assets_brickworks: read`\n","type":"text/plain"},"url":{"path":["brickworks","v1","schemas"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"limit","value":"50","description":"Limit of items per page"},{"disabled":false,"key":"page","value":"1","description":"The number of the page to retrieve"},{"disabled":false,"key":"search","value":"string","description":"A string to search for in:\n- `id`\n- `appId`\n- `displayName`\n- `description`\n"},{"disabled":false,"key":"sortBy","value":"updatedAt:asc","description":"You can change the default sorting. The sorting direction is selected by adding `asc` or `desc`, for example `sortBy=createdAt:desc`.\n\nYou can sort by:\n - `appId` \n - `displayName`\n - `createdAt`\n - `updatedAt`\n"},{"disabled":false,"key":"schemaTypes","value":"SIMPLE","description":"Comma-separated list of schema types to filter the results. By default, all types are retrieved."}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"23b5b9ff-1fed-402d-bdb5-79f259fc8d50","name":"Schema objects","originalRequest":{"url":{"path":["brickworks","v1","schemas"],"host":["{{baseUrl}}"],"query":[{"key":"limit","value":"50"},{"key":"page","value":"1"},{"key":"search","value":"string"},{"key":"sortBy","value":"updatedAt:asc"},{"key":"schemaTypes","value":"SIMPLE"}],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"meta\": {\n \"links\": {\n \"value\": \"\"\n },\n \"limit\": {\n \"value\": \"\"\n },\n \"count\": {\n \"value\": \"\"\n }\n },\n \"data\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"3a0571c7-7abe-4826-8ca7-6cba350e073d","name":"Incorrect request (malformed JSON, wrong parameters, etc.). See error message for details.","originalRequest":{"url":{"path":["brickworks","v1","schemas"],"host":["{{baseUrl}}"],"query":[{"key":"limit","value":"50"},{"key":"page","value":"1"},{"key":"search","value":"string"},{"key":"sortBy","value":"updatedAt:asc"},{"key":"schemaTypes","value":"SIMPLE"}],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"httpStatus\": 8176,\n \"errorCode\": \"string\",\n \"timestamp\": \"2009-08-02T10:31:15.071Z\",\n \"message\": \"string\",\n \"traceId\": \"string\",\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"source\": {\n \"pointer\": \"string\",\n \"value\": \"string\"\n },\n \"details\": {\n \"key_0\": {}\n },\n \"field\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"7888de47-60dd-4af5-bac8-67ebc95b3359","name":"Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc. See error message for details.","originalRequest":{"url":{"path":["brickworks","v1","schemas"],"host":["{{baseUrl}}"],"query":[{"key":"limit","value":"50"},{"key":"page","value":"1"},{"key":"search","value":"string"},{"key":"sortBy","value":"updatedAt:asc"},{"key":"schemaTypes","value":"SIMPLE"}],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\",\n \"status\": 647,\n \"timestamp\": \"string\",\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"c0bf087a-97a8-4018-a943-75707eea1677","name":"Forbidden; insufficient permissions. See error message for details.","originalRequest":{"url":{"path":["brickworks","v1","schemas"],"host":["{{baseUrl}}"],"query":[{"key":"limit","value":"50"},{"key":"page","value":"1"},{"key":"search","value":"string"},{"key":"sortBy","value":"updatedAt:asc"},{"key":"schemaTypes","value":"SIMPLE"}],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\",\n \"status\": 647,\n \"timestamp\": \"string\",\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"c4c6c00e-ae2c-4963-92bb-880849dee183","name":"Resource not found. See error message for details.","originalRequest":{"url":{"path":["brickworks","v1","schemas"],"host":["{{baseUrl}}"],"query":[{"key":"limit","value":"50"},{"key":"page","value":"1"},{"key":"search","value":"string"},{"key":"sortBy","value":"updatedAt:asc"},{"key":"schemaTypes","value":"SIMPLE"}],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"httpStatus\": 8176,\n \"errorCode\": \"string\",\n \"timestamp\": \"2009-08-02T10:31:15.071Z\",\n \"message\": \"string\",\n \"traceId\": \"string\",\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"source\": {\n \"pointer\": \"string\",\n \"value\": \"string\"\n },\n \"details\": {\n \"key_0\": {}\n },\n \"field\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"28b3953b-d4a9-41e9-bb28-e31f2294aa2e","name":"The request could not be completed due to a conflict with the current state of the resource. See error message for details.","originalRequest":{"url":{"path":["brickworks","v1","schemas"],"host":["{{baseUrl}}"],"query":[{"key":"limit","value":"50"},{"key":"page","value":"1"},{"key":"search","value":"string"},{"key":"sortBy","value":"updatedAt:asc"},{"key":"schemaTypes","value":"SIMPLE"}],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Conflict","code":409,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"httpStatus\": 8176,\n \"errorCode\": \"string\",\n \"timestamp\": \"2009-08-02T10:31:15.071Z\",\n \"message\": \"string\",\n \"traceId\": \"string\",\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"source\": {\n \"pointer\": \"string\",\n \"value\": \"string\"\n },\n \"details\": {\n \"key_0\": {}\n },\n \"field\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"951a0b79-4b33-4eaa-90b5-00ade1182d62","name":"The request was well-formed but could not be processed due to semantic or domain-related constraints. See error message for details.","originalRequest":{"url":{"path":["brickworks","v1","schemas"],"host":["{{baseUrl}}"],"query":[{"key":"limit","value":"50"},{"key":"page","value":"1"},{"key":"search","value":"string"},{"key":"sortBy","value":"updatedAt:asc"},{"key":"schemaTypes","value":"SIMPLE"}],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"httpStatus\": 8176,\n \"errorCode\": \"string\",\n \"timestamp\": \"2009-08-02T10:31:15.071Z\",\n \"message\": \"string\",\n \"traceId\": \"string\",\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"source\": {\n \"pointer\": \"string\",\n \"value\": \"string\"\n },\n \"details\": {\n \"key_0\": {}\n },\n \"field\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"4c035547-0a75-49e7-91e2-d034c3441cf4","name":"See error message for details.","originalRequest":{"url":{"path":["brickworks","v1","schemas"],"host":["{{baseUrl}}"],"query":[{"key":"limit","value":"50"},{"key":"page","value":"1"},{"key":"search","value":"string"},{"key":"sortBy","value":"updatedAt:asc"},{"key":"schemaTypes","value":"SIMPLE"}],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"httpStatus\": 8176,\n \"errorCode\": \"string\",\n \"timestamp\": \"2009-08-02T10:31:15.071Z\",\n \"message\": \"string\",\n \"traceId\": \"string\",\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"source\": {\n \"pointer\": \"string\",\n \"value\": \"string\"\n },\n \"details\": {\n \"key_0\": {}\n },\n \"field\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"0da6253d-f13b-42db-aa28-10779741e85d","name":"Create schema","request":{"name":"Create schema","description":{"content":"Create a new schema\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `BRICKWORKS_SCHEMAS_CREATE`\n\n**User role permission required:** `assets_brickworks: create`\n","type":"text/plain"},"url":{"path":["brickworks","v1","schemas"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"appId\": \"string\",\n \"displayName\": \"string\",\n \"description\": \"string\",\n \"fields\": {\n \"type\": {\n \"value\": \"\"\n },\n \"properties\": {\n \"value\": \"\"\n },\n \"required\": {\n \"value\": \"\"\n },\n \"allOf\": {\n \"value\": \"\"\n },\n \"additionalProperties\": {\n \"value\": \"\"\n }\n },\n \"displayConfiguration\": {\n \"ordering\": {\n \"value\": \"\"\n },\n \"metadata\": {\n \"value\": \"\"\n }\n },\n \"audience\": {\n \"targetType\": {\n \"value\": \"\"\n },\n \"segments\": {\n \"value\": \"\"\n },\n \"query\": {\n \"value\": \"\"\n }\n },\n \"schemaType\": \"SIMPLE\",\n \"lambdaId\": \"1b31c91a-2844-50e5-aca1-481b1f0470ae\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"102b488b-8a1c-47dd-a7dc-a6d9f6da67b6","name":"Details of the created schema","originalRequest":{"url":{"path":["brickworks","v1","schemas"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"appId\": \"string\",\n \"displayName\": \"string\",\n \"description\": \"string\",\n \"fields\": {\n \"type\": {\n \"value\": \"\"\n },\n \"properties\": {\n \"value\": \"\"\n },\n \"required\": {\n \"value\": \"\"\n },\n \"allOf\": {\n \"value\": \"\"\n },\n \"additionalProperties\": {\n \"value\": \"\"\n }\n },\n \"displayConfiguration\": {\n \"ordering\": {\n \"value\": \"\"\n },\n \"metadata\": {\n \"value\": \"\"\n }\n },\n \"audience\": {\n \"targetType\": {\n \"value\": \"\"\n },\n \"segments\": {\n \"value\": \"\"\n },\n \"query\": {\n \"value\": \"\"\n }\n },\n \"schemaType\": \"SIMPLE\",\n \"lambdaId\": \"1b31c91a-2844-50e5-aca1-481b1f0470ae\"\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"id\": \"e0003a57-c0cd-df94-8ab3-36f242acc3da\",\n \"appId\": \"string\",\n \"displayName\": \"string\",\n \"createdBy\": 8094,\n \"updatedBy\": 8573,\n \"createdAt\": \"1978-08-21T23:50:46.578Z\",\n \"updatedAt\": \"1952-01-21T10:34:06.095Z\",\n \"audience\": {\n \"targetType\": {\n \"value\": \"\"\n },\n \"segments\": {\n \"value\": \"\"\n },\n \"query\": {\n \"value\": \"\"\n }\n },\n \"description\": \"string\",\n \"fields\": {\n \"type\": {\n \"value\": \"\"\n },\n \"properties\": {\n \"value\": \"\"\n },\n \"required\": {\n \"value\": \"\"\n },\n \"allOf\": {\n \"value\": \"\"\n },\n \"additionalProperties\": {\n \"value\": \"\"\n }\n },\n \"displayConfiguration\": {\n \"ordering\": {\n \"value\": \"\"\n },\n \"metadata\": {\n \"value\": \"\"\n }\n },\n \"publishedBy\": 3986,\n \"deletedBy\": 6461,\n \"publishedAt\": \"2025-11-05T08:36:12.488Z\",\n \"deletedAt\": \"1951-01-06T14:11:30.677Z\",\n \"version\": 9925,\n \"schemaType\": \"SINGLETON\",\n \"fieldContextConfig\": {\n \"fields\": {\n \"value\": \"\"\n }\n },\n \"lambdaId\": \"dfdd5b3b-9a84-49e4-49d7-d730d1b0c1fc\",\n \"personalizationId\": \"165c3bf8-1faa-58f3-2892-847416d19e28\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"9a912d1a-de5c-466e-a458-e312aacdfcd3","name":"Incorrect request (malformed JSON, wrong parameters, etc.). See error message for details.","originalRequest":{"url":{"path":["brickworks","v1","schemas"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"appId\": \"string\",\n \"displayName\": \"string\",\n \"description\": \"string\",\n \"fields\": {\n \"type\": {\n \"value\": \"\"\n },\n \"properties\": {\n \"value\": \"\"\n },\n \"required\": {\n \"value\": \"\"\n },\n \"allOf\": {\n \"value\": \"\"\n },\n \"additionalProperties\": {\n \"value\": \"\"\n }\n },\n \"displayConfiguration\": {\n \"ordering\": {\n \"value\": \"\"\n },\n \"metadata\": {\n \"value\": \"\"\n }\n },\n \"audience\": {\n \"targetType\": {\n \"value\": \"\"\n },\n \"segments\": {\n \"value\": \"\"\n },\n \"query\": {\n \"value\": \"\"\n }\n },\n \"schemaType\": \"SIMPLE\",\n \"lambdaId\": \"1b31c91a-2844-50e5-aca1-481b1f0470ae\"\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"httpStatus\": 8176,\n \"errorCode\": \"string\",\n \"timestamp\": \"2009-08-02T10:31:15.071Z\",\n \"message\": \"string\",\n \"traceId\": \"string\",\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"source\": {\n \"pointer\": \"string\",\n \"value\": \"string\"\n },\n \"details\": {\n \"key_0\": {}\n },\n \"field\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"a2fbbf66-4c9d-484b-9185-271c9666336d","name":"Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc. See error message for details.","originalRequest":{"url":{"path":["brickworks","v1","schemas"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"appId\": \"string\",\n \"displayName\": \"string\",\n \"description\": \"string\",\n \"fields\": {\n \"type\": {\n \"value\": \"\"\n },\n \"properties\": {\n \"value\": \"\"\n },\n \"required\": {\n \"value\": \"\"\n },\n \"allOf\": {\n \"value\": \"\"\n },\n \"additionalProperties\": {\n \"value\": \"\"\n }\n },\n \"displayConfiguration\": {\n \"ordering\": {\n \"value\": \"\"\n },\n \"metadata\": {\n \"value\": \"\"\n }\n },\n \"audience\": {\n \"targetType\": {\n \"value\": \"\"\n },\n \"segments\": {\n \"value\": \"\"\n },\n \"query\": {\n \"value\": \"\"\n }\n },\n \"schemaType\": \"SIMPLE\",\n \"lambdaId\": \"1b31c91a-2844-50e5-aca1-481b1f0470ae\"\n}","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\",\n \"status\": 647,\n \"timestamp\": \"string\",\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"7ccd1d6c-8976-4eaa-a299-f2a3dda364ea","name":"Forbidden; insufficient permissions. See error message for details.","originalRequest":{"url":{"path":["brickworks","v1","schemas"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"appId\": \"string\",\n \"displayName\": \"string\",\n \"description\": \"string\",\n \"fields\": {\n \"type\": {\n \"value\": \"\"\n },\n \"properties\": {\n \"value\": \"\"\n },\n \"required\": {\n \"value\": \"\"\n },\n \"allOf\": {\n \"value\": \"\"\n },\n \"additionalProperties\": {\n \"value\": \"\"\n }\n },\n \"displayConfiguration\": {\n \"ordering\": {\n \"value\": \"\"\n },\n \"metadata\": {\n \"value\": \"\"\n }\n },\n \"audience\": {\n \"targetType\": {\n \"value\": \"\"\n },\n \"segments\": {\n \"value\": \"\"\n },\n \"query\": {\n \"value\": \"\"\n }\n },\n \"schemaType\": \"SIMPLE\",\n \"lambdaId\": \"1b31c91a-2844-50e5-aca1-481b1f0470ae\"\n}","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\",\n \"status\": 647,\n \"timestamp\": \"string\",\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"d139d6ea-8f4e-437d-a58a-374b17f3a973","name":"Resource not found. See error message for details.","originalRequest":{"url":{"path":["brickworks","v1","schemas"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"appId\": \"string\",\n \"displayName\": \"string\",\n \"description\": \"string\",\n \"fields\": {\n \"type\": {\n \"value\": \"\"\n },\n \"properties\": {\n \"value\": \"\"\n },\n \"required\": {\n \"value\": \"\"\n },\n \"allOf\": {\n \"value\": \"\"\n },\n \"additionalProperties\": {\n \"value\": \"\"\n }\n },\n \"displayConfiguration\": {\n \"ordering\": {\n \"value\": \"\"\n },\n \"metadata\": {\n \"value\": \"\"\n }\n },\n \"audience\": {\n \"targetType\": {\n \"value\": \"\"\n },\n \"segments\": {\n \"value\": \"\"\n },\n \"query\": {\n \"value\": \"\"\n }\n },\n \"schemaType\": \"SIMPLE\",\n \"lambdaId\": \"1b31c91a-2844-50e5-aca1-481b1f0470ae\"\n}","options":{"raw":{"language":"json"}}}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"httpStatus\": 8176,\n \"errorCode\": \"string\",\n \"timestamp\": \"2009-08-02T10:31:15.071Z\",\n \"message\": \"string\",\n \"traceId\": \"string\",\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"source\": {\n \"pointer\": \"string\",\n \"value\": \"string\"\n },\n \"details\": {\n \"key_0\": {}\n },\n \"field\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"7cf977dc-fe76-4494-91cc-ff7441ea28b6","name":"The request could not be completed due to a conflict with the current state of the resource. See error message for details.","originalRequest":{"url":{"path":["brickworks","v1","schemas"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"appId\": \"string\",\n \"displayName\": \"string\",\n \"description\": \"string\",\n \"fields\": {\n \"type\": {\n \"value\": \"\"\n },\n \"properties\": {\n \"value\": \"\"\n },\n \"required\": {\n \"value\": \"\"\n },\n \"allOf\": {\n \"value\": \"\"\n },\n \"additionalProperties\": {\n \"value\": \"\"\n }\n },\n \"displayConfiguration\": {\n \"ordering\": {\n \"value\": \"\"\n },\n \"metadata\": {\n \"value\": \"\"\n }\n },\n \"audience\": {\n \"targetType\": {\n \"value\": \"\"\n },\n \"segments\": {\n \"value\": \"\"\n },\n \"query\": {\n \"value\": \"\"\n }\n },\n \"schemaType\": \"SIMPLE\",\n \"lambdaId\": \"1b31c91a-2844-50e5-aca1-481b1f0470ae\"\n}","options":{"raw":{"language":"json"}}}},"status":"Conflict","code":409,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"httpStatus\": 8176,\n \"errorCode\": \"string\",\n \"timestamp\": \"2009-08-02T10:31:15.071Z\",\n \"message\": \"string\",\n \"traceId\": \"string\",\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"source\": {\n \"pointer\": \"string\",\n \"value\": \"string\"\n },\n \"details\": {\n \"key_0\": {}\n },\n \"field\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"3924233c-9db7-4671-ac0d-2fd9c2f6d04c","name":"The request was well-formed but could not be processed due to semantic or domain-related constraints. See error message for details.","originalRequest":{"url":{"path":["brickworks","v1","schemas"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"appId\": \"string\",\n \"displayName\": \"string\",\n \"description\": \"string\",\n \"fields\": {\n \"type\": {\n \"value\": \"\"\n },\n \"properties\": {\n \"value\": \"\"\n },\n \"required\": {\n \"value\": \"\"\n },\n \"allOf\": {\n \"value\": \"\"\n },\n \"additionalProperties\": {\n \"value\": \"\"\n }\n },\n \"displayConfiguration\": {\n \"ordering\": {\n \"value\": \"\"\n },\n \"metadata\": {\n \"value\": \"\"\n }\n },\n \"audience\": {\n \"targetType\": {\n \"value\": \"\"\n },\n \"segments\": {\n \"value\": \"\"\n },\n \"query\": {\n \"value\": \"\"\n }\n },\n \"schemaType\": \"SIMPLE\",\n \"lambdaId\": \"1b31c91a-2844-50e5-aca1-481b1f0470ae\"\n}","options":{"raw":{"language":"json"}}}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"httpStatus\": 8176,\n \"errorCode\": \"string\",\n \"timestamp\": \"2009-08-02T10:31:15.071Z\",\n \"message\": \"string\",\n \"traceId\": \"string\",\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"source\": {\n \"pointer\": \"string\",\n \"value\": \"string\"\n },\n \"details\": {\n \"key_0\": {}\n },\n \"field\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"8da76b26-11d3-48f0-a218-0096f7ca5d21","name":"See error message for details.","originalRequest":{"url":{"path":["brickworks","v1","schemas"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"appId\": \"string\",\n \"displayName\": \"string\",\n \"description\": \"string\",\n \"fields\": {\n \"type\": {\n \"value\": \"\"\n },\n \"properties\": {\n \"value\": \"\"\n },\n \"required\": {\n \"value\": \"\"\n },\n \"allOf\": {\n \"value\": \"\"\n },\n \"additionalProperties\": {\n \"value\": \"\"\n }\n },\n \"displayConfiguration\": {\n \"ordering\": {\n \"value\": \"\"\n },\n \"metadata\": {\n \"value\": \"\"\n }\n },\n \"audience\": {\n \"targetType\": {\n \"value\": \"\"\n },\n \"segments\": {\n \"value\": \"\"\n },\n \"query\": {\n \"value\": \"\"\n }\n },\n \"schemaType\": \"SIMPLE\",\n \"lambdaId\": \"1b31c91a-2844-50e5-aca1-481b1f0470ae\"\n}","options":{"raw":{"language":"json"}}}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"httpStatus\": 8176,\n \"errorCode\": \"string\",\n \"timestamp\": \"2009-08-02T10:31:15.071Z\",\n \"message\": \"string\",\n \"traceId\": \"string\",\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"source\": {\n \"pointer\": \"string\",\n \"value\": \"string\"\n },\n \"details\": {\n \"key_0\": {}\n },\n \"field\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"53573f25-eaed-4e02-87de-bb057771bf0d","name":"Get schema","request":{"name":"Get schema","description":{"content":"Retrieve the details of a schema.\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `BRICKWORKS_SCHEMAS_READ`\n\n**User role permission required:** `assets_brickworks: read`\n","type":"text/plain"},"url":{"path":["brickworks","v1","schemas",":SchemaIdentifier"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"44e5411f-17ee-ab70-9112-0c776aafa909","key":"SchemaIdentifier","description":"(Required) Schema identifier - can be a UUID (SchemaId) or a human-readable string (Schema AppId/API name, 3-25 characters)"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"6cf86da0-375e-492b-8533-270118fae3a1","name":"Details of the schema","originalRequest":{"url":{"path":["brickworks","v1","schemas",":SchemaIdentifier"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"44e5411f-17ee-ab70-9112-0c776aafa909","key":"SchemaIdentifier","description":"(Required) Schema identifier - can be a UUID (SchemaId) or a human-readable string (Schema AppId/API name, 3-25 characters)"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"id\": \"e0003a57-c0cd-df94-8ab3-36f242acc3da\",\n \"appId\": \"string\",\n \"displayName\": \"string\",\n \"createdBy\": 8094,\n \"updatedBy\": 8573,\n \"createdAt\": \"1978-08-21T23:50:46.578Z\",\n \"updatedAt\": \"1952-01-21T10:34:06.095Z\",\n \"audience\": {\n \"targetType\": {\n \"value\": \"\"\n },\n \"segments\": {\n \"value\": \"\"\n },\n \"query\": {\n \"value\": \"\"\n }\n },\n \"description\": \"string\",\n \"fields\": {\n \"type\": {\n \"value\": \"\"\n },\n \"properties\": {\n \"value\": \"\"\n },\n \"required\": {\n \"value\": \"\"\n },\n \"allOf\": {\n \"value\": \"\"\n },\n \"additionalProperties\": {\n \"value\": \"\"\n }\n },\n \"displayConfiguration\": {\n \"ordering\": {\n \"value\": \"\"\n },\n \"metadata\": {\n \"value\": \"\"\n }\n },\n \"publishedBy\": 3986,\n \"deletedBy\": 6461,\n \"publishedAt\": \"2025-11-05T08:36:12.488Z\",\n \"deletedAt\": \"1951-01-06T14:11:30.677Z\",\n \"version\": 9925,\n \"schemaType\": \"SINGLETON\",\n \"fieldContextConfig\": {\n \"fields\": {\n \"value\": \"\"\n }\n },\n \"lambdaId\": \"dfdd5b3b-9a84-49e4-49d7-d730d1b0c1fc\",\n \"personalizationId\": \"165c3bf8-1faa-58f3-2892-847416d19e28\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"9d43a21d-f944-4497-bcfd-a17053f052f1","name":"Incorrect request (malformed JSON, wrong parameters, etc.). See error message for details.","originalRequest":{"url":{"path":["brickworks","v1","schemas",":SchemaIdentifier"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"44e5411f-17ee-ab70-9112-0c776aafa909","key":"SchemaIdentifier","description":"(Required) Schema identifier - can be a UUID (SchemaId) or a human-readable string (Schema AppId/API name, 3-25 characters)"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"httpStatus\": 8176,\n \"errorCode\": \"string\",\n \"timestamp\": \"2009-08-02T10:31:15.071Z\",\n \"message\": \"string\",\n \"traceId\": \"string\",\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"source\": {\n \"pointer\": \"string\",\n \"value\": \"string\"\n },\n \"details\": {\n \"key_0\": {}\n },\n \"field\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"1660e942-57e8-4c89-8d9a-50b75ced6df6","name":"Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc. See error message for details.","originalRequest":{"url":{"path":["brickworks","v1","schemas",":SchemaIdentifier"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"44e5411f-17ee-ab70-9112-0c776aafa909","key":"SchemaIdentifier","description":"(Required) Schema identifier - can be a UUID (SchemaId) or a human-readable string (Schema AppId/API name, 3-25 characters)"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\",\n \"status\": 647,\n \"timestamp\": \"string\",\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"ab0881db-fccf-4e1a-b5d1-ba867b01c89c","name":"Forbidden; insufficient permissions. See error message for details.","originalRequest":{"url":{"path":["brickworks","v1","schemas",":SchemaIdentifier"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"44e5411f-17ee-ab70-9112-0c776aafa909","key":"SchemaIdentifier","description":"(Required) Schema identifier - can be a UUID (SchemaId) or a human-readable string (Schema AppId/API name, 3-25 characters)"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\",\n \"status\": 647,\n \"timestamp\": \"string\",\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"f752be7b-9e07-44c7-a339-c6683d83157f","name":"Resource not found. See error message for details.","originalRequest":{"url":{"path":["brickworks","v1","schemas",":SchemaIdentifier"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"44e5411f-17ee-ab70-9112-0c776aafa909","key":"SchemaIdentifier","description":"(Required) Schema identifier - can be a UUID (SchemaId) or a human-readable string (Schema AppId/API name, 3-25 characters)"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"httpStatus\": 8176,\n \"errorCode\": \"string\",\n \"timestamp\": \"2009-08-02T10:31:15.071Z\",\n \"message\": \"string\",\n \"traceId\": \"string\",\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"source\": {\n \"pointer\": \"string\",\n \"value\": \"string\"\n },\n \"details\": {\n \"key_0\": {}\n },\n \"field\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"aecd7ae8-558c-4b55-9c10-cf37d5153870","name":"The request could not be completed due to a conflict with the current state of the resource. See error message for details.","originalRequest":{"url":{"path":["brickworks","v1","schemas",":SchemaIdentifier"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"44e5411f-17ee-ab70-9112-0c776aafa909","key":"SchemaIdentifier","description":"(Required) Schema identifier - can be a UUID (SchemaId) or a human-readable string (Schema AppId/API name, 3-25 characters)"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Conflict","code":409,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"httpStatus\": 8176,\n \"errorCode\": \"string\",\n \"timestamp\": \"2009-08-02T10:31:15.071Z\",\n \"message\": \"string\",\n \"traceId\": \"string\",\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"source\": {\n \"pointer\": \"string\",\n \"value\": \"string\"\n },\n \"details\": {\n \"key_0\": {}\n },\n \"field\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"f063ac8a-ac03-44fe-b0b6-be43dbc06663","name":"The request was well-formed but could not be processed due to semantic or domain-related constraints. See error message for details.","originalRequest":{"url":{"path":["brickworks","v1","schemas",":SchemaIdentifier"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"44e5411f-17ee-ab70-9112-0c776aafa909","key":"SchemaIdentifier","description":"(Required) Schema identifier - can be a UUID (SchemaId) or a human-readable string (Schema AppId/API name, 3-25 characters)"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"httpStatus\": 8176,\n \"errorCode\": \"string\",\n \"timestamp\": \"2009-08-02T10:31:15.071Z\",\n \"message\": \"string\",\n \"traceId\": \"string\",\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"source\": {\n \"pointer\": \"string\",\n \"value\": \"string\"\n },\n \"details\": {\n \"key_0\": {}\n },\n \"field\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"d6d9c0ab-2c2e-44b5-a0ef-f7fe56bdec01","name":"See error message for details.","originalRequest":{"url":{"path":["brickworks","v1","schemas",":SchemaIdentifier"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"44e5411f-17ee-ab70-9112-0c776aafa909","key":"SchemaIdentifier","description":"(Required) Schema identifier - can be a UUID (SchemaId) or a human-readable string (Schema AppId/API name, 3-25 characters)"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"httpStatus\": 8176,\n \"errorCode\": \"string\",\n \"timestamp\": \"2009-08-02T10:31:15.071Z\",\n \"message\": \"string\",\n \"traceId\": \"string\",\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"source\": {\n \"pointer\": \"string\",\n \"value\": \"string\"\n },\n \"details\": {\n \"key_0\": {}\n },\n \"field\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"98bdada1-af6c-41c8-97c7-c24c5452e22b","name":"Update schema","request":{"name":"Update schema","description":{"content":"Update a schema.\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `BRICKWORKS_SCHEMAS_UPDATE`\n\n**User role permission required:** `assets_brickworks: update`\n","type":"text/plain"},"url":{"path":["brickworks","v1","schemas",":SchemaIdentifier"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"44e5411f-17ee-ab70-9112-0c776aafa909","key":"SchemaIdentifier","description":"(Required) Schema identifier - can be a UUID (SchemaId) or a human-readable string (Schema AppId/API name, 3-25 characters)"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PUT","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"displayName\": \"string\",\n \"description\": \"string\",\n \"fields\": {\n \"type\": {\n \"value\": \"\"\n },\n \"properties\": {\n \"value\": \"\"\n },\n \"required\": {\n \"value\": \"\"\n },\n \"allOf\": {\n \"value\": \"\"\n },\n \"additionalProperties\": {\n \"value\": \"\"\n }\n },\n \"displayConfiguration\": {\n \"ordering\": {\n \"value\": \"\"\n },\n \"metadata\": {\n \"value\": \"\"\n }\n },\n \"audience\": {\n \"targetType\": {\n \"value\": \"\"\n },\n \"segments\": {\n \"value\": \"\"\n },\n \"query\": {\n \"value\": \"\"\n }\n },\n \"lambdaId\": \"6e840b4e-9fe5-719e-9146-4382eae9a8b8\",\n \"personalizationId\": \"267cb7b8-750c-3ea3-f457-03770d5fffed\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"4fa6cb0b-0b9b-4622-9c9e-55a47c2d7920","name":"Schema updated","originalRequest":{"url":{"path":["brickworks","v1","schemas",":SchemaIdentifier"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"44e5411f-17ee-ab70-9112-0c776aafa909","key":"SchemaIdentifier","description":"(Required) Schema identifier - can be a UUID (SchemaId) or a human-readable string (Schema AppId/API name, 3-25 characters)"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"{\n \"displayName\": \"string\",\n \"description\": \"string\",\n \"fields\": {\n \"type\": {\n \"value\": \"\"\n },\n \"properties\": {\n \"value\": \"\"\n },\n \"required\": {\n \"value\": \"\"\n },\n \"allOf\": {\n \"value\": \"\"\n },\n \"additionalProperties\": {\n \"value\": \"\"\n }\n },\n \"displayConfiguration\": {\n \"ordering\": {\n \"value\": \"\"\n },\n \"metadata\": {\n \"value\": \"\"\n }\n },\n \"audience\": {\n \"targetType\": {\n \"value\": \"\"\n },\n \"segments\": {\n \"value\": \"\"\n },\n \"query\": {\n \"value\": \"\"\n }\n },\n \"lambdaId\": \"6e840b4e-9fe5-719e-9146-4382eae9a8b8\",\n \"personalizationId\": \"267cb7b8-750c-3ea3-f457-03770d5fffed\"\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"id\": \"e0003a57-c0cd-df94-8ab3-36f242acc3da\",\n \"appId\": \"string\",\n \"displayName\": \"string\",\n \"createdBy\": 8094,\n \"updatedBy\": 8573,\n \"createdAt\": \"1978-08-21T23:50:46.578Z\",\n \"updatedAt\": \"1952-01-21T10:34:06.095Z\",\n \"audience\": {\n \"targetType\": {\n \"value\": \"\"\n },\n \"segments\": {\n \"value\": \"\"\n },\n \"query\": {\n \"value\": \"\"\n }\n },\n \"description\": \"string\",\n \"fields\": {\n \"type\": {\n \"value\": \"\"\n },\n \"properties\": {\n \"value\": \"\"\n },\n \"required\": {\n \"value\": \"\"\n },\n \"allOf\": {\n \"value\": \"\"\n },\n \"additionalProperties\": {\n \"value\": \"\"\n }\n },\n \"displayConfiguration\": {\n \"ordering\": {\n \"value\": \"\"\n },\n \"metadata\": {\n \"value\": \"\"\n }\n },\n \"publishedBy\": 3986,\n \"deletedBy\": 6461,\n \"publishedAt\": \"2025-11-05T08:36:12.488Z\",\n \"deletedAt\": \"1951-01-06T14:11:30.677Z\",\n \"version\": 9925,\n \"schemaType\": \"SINGLETON\",\n \"fieldContextConfig\": {\n \"fields\": {\n \"value\": \"\"\n }\n },\n \"lambdaId\": \"dfdd5b3b-9a84-49e4-49d7-d730d1b0c1fc\",\n \"personalizationId\": \"165c3bf8-1faa-58f3-2892-847416d19e28\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"4341050b-bd35-4acf-b969-371f9ad9833a","name":"Incorrect request (malformed JSON, wrong parameters, etc.). See error message for details.","originalRequest":{"url":{"path":["brickworks","v1","schemas",":SchemaIdentifier"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"44e5411f-17ee-ab70-9112-0c776aafa909","key":"SchemaIdentifier","description":"(Required) Schema identifier - can be a UUID (SchemaId) or a human-readable string (Schema AppId/API name, 3-25 characters)"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"{\n \"displayName\": \"string\",\n \"description\": \"string\",\n \"fields\": {\n \"type\": {\n \"value\": \"\"\n },\n \"properties\": {\n \"value\": \"\"\n },\n \"required\": {\n \"value\": \"\"\n },\n \"allOf\": {\n \"value\": \"\"\n },\n \"additionalProperties\": {\n \"value\": \"\"\n }\n },\n \"displayConfiguration\": {\n \"ordering\": {\n \"value\": \"\"\n },\n \"metadata\": {\n \"value\": \"\"\n }\n },\n \"audience\": {\n \"targetType\": {\n \"value\": \"\"\n },\n \"segments\": {\n \"value\": \"\"\n },\n \"query\": {\n \"value\": \"\"\n }\n },\n \"lambdaId\": \"6e840b4e-9fe5-719e-9146-4382eae9a8b8\",\n \"personalizationId\": \"267cb7b8-750c-3ea3-f457-03770d5fffed\"\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"httpStatus\": 8176,\n \"errorCode\": \"string\",\n \"timestamp\": \"2009-08-02T10:31:15.071Z\",\n \"message\": \"string\",\n \"traceId\": \"string\",\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"source\": {\n \"pointer\": \"string\",\n \"value\": \"string\"\n },\n \"details\": {\n \"key_0\": {}\n },\n \"field\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"0daf3d23-ad7e-45a8-9cc4-b3b0610a7dd3","name":"Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc. See error message for details.","originalRequest":{"url":{"path":["brickworks","v1","schemas",":SchemaIdentifier"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"44e5411f-17ee-ab70-9112-0c776aafa909","key":"SchemaIdentifier","description":"(Required) Schema identifier - can be a UUID (SchemaId) or a human-readable string (Schema AppId/API name, 3-25 characters)"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"{\n \"displayName\": \"string\",\n \"description\": \"string\",\n \"fields\": {\n \"type\": {\n \"value\": \"\"\n },\n \"properties\": {\n \"value\": \"\"\n },\n \"required\": {\n \"value\": \"\"\n },\n \"allOf\": {\n \"value\": \"\"\n },\n \"additionalProperties\": {\n \"value\": \"\"\n }\n },\n \"displayConfiguration\": {\n \"ordering\": {\n \"value\": \"\"\n },\n \"metadata\": {\n \"value\": \"\"\n }\n },\n \"audience\": {\n \"targetType\": {\n \"value\": \"\"\n },\n \"segments\": {\n \"value\": \"\"\n },\n \"query\": {\n \"value\": \"\"\n }\n },\n \"lambdaId\": \"6e840b4e-9fe5-719e-9146-4382eae9a8b8\",\n \"personalizationId\": \"267cb7b8-750c-3ea3-f457-03770d5fffed\"\n}","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\",\n \"status\": 647,\n \"timestamp\": \"string\",\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"e48eb912-1e13-4bee-903f-f4b1b15dde77","name":"Forbidden; insufficient permissions. See error message for details.","originalRequest":{"url":{"path":["brickworks","v1","schemas",":SchemaIdentifier"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"44e5411f-17ee-ab70-9112-0c776aafa909","key":"SchemaIdentifier","description":"(Required) Schema identifier - can be a UUID (SchemaId) or a human-readable string (Schema AppId/API name, 3-25 characters)"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"{\n \"displayName\": \"string\",\n \"description\": \"string\",\n \"fields\": {\n \"type\": {\n \"value\": \"\"\n },\n \"properties\": {\n \"value\": \"\"\n },\n \"required\": {\n \"value\": \"\"\n },\n \"allOf\": {\n \"value\": \"\"\n },\n \"additionalProperties\": {\n \"value\": \"\"\n }\n },\n \"displayConfiguration\": {\n \"ordering\": {\n \"value\": \"\"\n },\n \"metadata\": {\n \"value\": \"\"\n }\n },\n \"audience\": {\n \"targetType\": {\n \"value\": \"\"\n },\n \"segments\": {\n \"value\": \"\"\n },\n \"query\": {\n \"value\": \"\"\n }\n },\n \"lambdaId\": \"6e840b4e-9fe5-719e-9146-4382eae9a8b8\",\n \"personalizationId\": \"267cb7b8-750c-3ea3-f457-03770d5fffed\"\n}","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\",\n \"status\": 647,\n \"timestamp\": \"string\",\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"a3678801-4b77-4345-80de-da7e0ad80c69","name":"Resource not found. See error message for details.","originalRequest":{"url":{"path":["brickworks","v1","schemas",":SchemaIdentifier"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"44e5411f-17ee-ab70-9112-0c776aafa909","key":"SchemaIdentifier","description":"(Required) Schema identifier - can be a UUID (SchemaId) or a human-readable string (Schema AppId/API name, 3-25 characters)"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"{\n \"displayName\": \"string\",\n \"description\": \"string\",\n \"fields\": {\n \"type\": {\n \"value\": \"\"\n },\n \"properties\": {\n \"value\": \"\"\n },\n \"required\": {\n \"value\": \"\"\n },\n \"allOf\": {\n \"value\": \"\"\n },\n \"additionalProperties\": {\n \"value\": \"\"\n }\n },\n \"displayConfiguration\": {\n \"ordering\": {\n \"value\": \"\"\n },\n \"metadata\": {\n \"value\": \"\"\n }\n },\n \"audience\": {\n \"targetType\": {\n \"value\": \"\"\n },\n \"segments\": {\n \"value\": \"\"\n },\n \"query\": {\n \"value\": \"\"\n }\n },\n \"lambdaId\": \"6e840b4e-9fe5-719e-9146-4382eae9a8b8\",\n \"personalizationId\": \"267cb7b8-750c-3ea3-f457-03770d5fffed\"\n}","options":{"raw":{"language":"json"}}}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"httpStatus\": 8176,\n \"errorCode\": \"string\",\n \"timestamp\": \"2009-08-02T10:31:15.071Z\",\n \"message\": \"string\",\n \"traceId\": \"string\",\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"source\": {\n \"pointer\": \"string\",\n \"value\": \"string\"\n },\n \"details\": {\n \"key_0\": {}\n },\n \"field\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"579ea78e-b6fe-42e4-a956-5a4167df90de","name":"The request could not be completed due to a conflict with the current state of the resource. See error message for details.","originalRequest":{"url":{"path":["brickworks","v1","schemas",":SchemaIdentifier"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"44e5411f-17ee-ab70-9112-0c776aafa909","key":"SchemaIdentifier","description":"(Required) Schema identifier - can be a UUID (SchemaId) or a human-readable string (Schema AppId/API name, 3-25 characters)"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"{\n \"displayName\": \"string\",\n \"description\": \"string\",\n \"fields\": {\n \"type\": {\n \"value\": \"\"\n },\n \"properties\": {\n \"value\": \"\"\n },\n \"required\": {\n \"value\": \"\"\n },\n \"allOf\": {\n \"value\": \"\"\n },\n \"additionalProperties\": {\n \"value\": \"\"\n }\n },\n \"displayConfiguration\": {\n \"ordering\": {\n \"value\": \"\"\n },\n \"metadata\": {\n \"value\": \"\"\n }\n },\n \"audience\": {\n \"targetType\": {\n \"value\": \"\"\n },\n \"segments\": {\n \"value\": \"\"\n },\n \"query\": {\n \"value\": \"\"\n }\n },\n \"lambdaId\": \"6e840b4e-9fe5-719e-9146-4382eae9a8b8\",\n \"personalizationId\": \"267cb7b8-750c-3ea3-f457-03770d5fffed\"\n}","options":{"raw":{"language":"json"}}}},"status":"Conflict","code":409,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"httpStatus\": 8176,\n \"errorCode\": \"string\",\n \"timestamp\": \"2009-08-02T10:31:15.071Z\",\n \"message\": \"string\",\n \"traceId\": \"string\",\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"source\": {\n \"pointer\": \"string\",\n \"value\": \"string\"\n },\n \"details\": {\n \"key_0\": {}\n },\n \"field\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"8bed3c3c-580d-409e-9954-75a2517278ad","name":"The request was well-formed but could not be processed due to semantic or domain-related constraints. See error message for details.","originalRequest":{"url":{"path":["brickworks","v1","schemas",":SchemaIdentifier"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"44e5411f-17ee-ab70-9112-0c776aafa909","key":"SchemaIdentifier","description":"(Required) Schema identifier - can be a UUID (SchemaId) or a human-readable string (Schema AppId/API name, 3-25 characters)"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"{\n \"displayName\": \"string\",\n \"description\": \"string\",\n \"fields\": {\n \"type\": {\n \"value\": \"\"\n },\n \"properties\": {\n \"value\": \"\"\n },\n \"required\": {\n \"value\": \"\"\n },\n \"allOf\": {\n \"value\": \"\"\n },\n \"additionalProperties\": {\n \"value\": \"\"\n }\n },\n \"displayConfiguration\": {\n \"ordering\": {\n \"value\": \"\"\n },\n \"metadata\": {\n \"value\": \"\"\n }\n },\n \"audience\": {\n \"targetType\": {\n \"value\": \"\"\n },\n \"segments\": {\n \"value\": \"\"\n },\n \"query\": {\n \"value\": \"\"\n }\n },\n \"lambdaId\": \"6e840b4e-9fe5-719e-9146-4382eae9a8b8\",\n \"personalizationId\": \"267cb7b8-750c-3ea3-f457-03770d5fffed\"\n}","options":{"raw":{"language":"json"}}}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"httpStatus\": 8176,\n \"errorCode\": \"string\",\n \"timestamp\": \"2009-08-02T10:31:15.071Z\",\n \"message\": \"string\",\n \"traceId\": \"string\",\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"source\": {\n \"pointer\": \"string\",\n \"value\": \"string\"\n },\n \"details\": {\n \"key_0\": {}\n },\n \"field\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"f38be217-56e5-4caa-bca2-e70c2c9dc977","name":"See error message for details.","originalRequest":{"url":{"path":["brickworks","v1","schemas",":SchemaIdentifier"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"44e5411f-17ee-ab70-9112-0c776aafa909","key":"SchemaIdentifier","description":"(Required) Schema identifier - can be a UUID (SchemaId) or a human-readable string (Schema AppId/API name, 3-25 characters)"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"{\n \"displayName\": \"string\",\n \"description\": \"string\",\n \"fields\": {\n \"type\": {\n \"value\": \"\"\n },\n \"properties\": {\n \"value\": \"\"\n },\n \"required\": {\n \"value\": \"\"\n },\n \"allOf\": {\n \"value\": \"\"\n },\n \"additionalProperties\": {\n \"value\": \"\"\n }\n },\n \"displayConfiguration\": {\n \"ordering\": {\n \"value\": \"\"\n },\n \"metadata\": {\n \"value\": \"\"\n }\n },\n \"audience\": {\n \"targetType\": {\n \"value\": \"\"\n },\n \"segments\": {\n \"value\": \"\"\n },\n \"query\": {\n \"value\": \"\"\n }\n },\n \"lambdaId\": \"6e840b4e-9fe5-719e-9146-4382eae9a8b8\",\n \"personalizationId\": \"267cb7b8-750c-3ea3-f457-03770d5fffed\"\n}","options":{"raw":{"language":"json"}}}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"httpStatus\": 8176,\n \"errorCode\": \"string\",\n \"timestamp\": \"2009-08-02T10:31:15.071Z\",\n \"message\": \"string\",\n \"traceId\": \"string\",\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"source\": {\n \"pointer\": \"string\",\n \"value\": \"string\"\n },\n \"details\": {\n \"key_0\": {}\n },\n \"field\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"461bd99d-b76e-49a5-aca6-64ef20e2fbce","name":"Delete schema","request":{"name":"Delete schema","description":{"content":"Delete a schema.\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `BRICKWORKS_SCHEMAS_DELETE`\n\n**User role permission required:** `assets_brickworks: delete`\n","type":"text/plain"},"url":{"path":["brickworks","v1","schemas",":SchemaIdentifier"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"44e5411f-17ee-ab70-9112-0c776aafa909","key":"SchemaIdentifier","description":"(Required) Schema identifier - can be a UUID (SchemaId) or a human-readable string (Schema AppId/API name, 3-25 characters)"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"ef4dcd4d-f5f9-4496-9d02-4ddf47397ab6","name":"Schema deleted","originalRequest":{"url":{"path":["brickworks","v1","schemas",":SchemaIdentifier"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"44e5411f-17ee-ab70-9112-0c776aafa909","key":"SchemaIdentifier","description":"(Required) Schema identifier - can be a UUID (SchemaId) or a human-readable string (Schema AppId/API name, 3-25 characters)"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"DELETE","body":{}},"status":"No Content","code":204,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"8b00f3b1-9320-4b92-95d7-15e8a1ad4267","name":"Incorrect request (malformed JSON, wrong parameters, etc.). See error message for details.","originalRequest":{"url":{"path":["brickworks","v1","schemas",":SchemaIdentifier"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"44e5411f-17ee-ab70-9112-0c776aafa909","key":"SchemaIdentifier","description":"(Required) Schema identifier - can be a UUID (SchemaId) or a human-readable string (Schema AppId/API name, 3-25 characters)"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"httpStatus\": 8176,\n \"errorCode\": \"string\",\n \"timestamp\": \"2009-08-02T10:31:15.071Z\",\n \"message\": \"string\",\n \"traceId\": \"string\",\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"source\": {\n \"pointer\": \"string\",\n \"value\": \"string\"\n },\n \"details\": {\n \"key_0\": {}\n },\n \"field\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"75d6f084-af6d-4794-8fc0-066dcbd2bab1","name":"Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc. See error message for details.","originalRequest":{"url":{"path":["brickworks","v1","schemas",":SchemaIdentifier"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"44e5411f-17ee-ab70-9112-0c776aafa909","key":"SchemaIdentifier","description":"(Required) Schema identifier - can be a UUID (SchemaId) or a human-readable string (Schema AppId/API name, 3-25 characters)"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\",\n \"status\": 647,\n \"timestamp\": \"string\",\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"126edcf7-ebf3-433b-a978-f78449537662","name":"Forbidden; insufficient permissions. See error message for details.","originalRequest":{"url":{"path":["brickworks","v1","schemas",":SchemaIdentifier"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"44e5411f-17ee-ab70-9112-0c776aafa909","key":"SchemaIdentifier","description":"(Required) Schema identifier - can be a UUID (SchemaId) or a human-readable string (Schema AppId/API name, 3-25 characters)"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\",\n \"status\": 647,\n \"timestamp\": \"string\",\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"648fb0f4-ea80-47d3-8c8a-1f6933b52d80","name":"Resource not found. See error message for details.","originalRequest":{"url":{"path":["brickworks","v1","schemas",":SchemaIdentifier"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"44e5411f-17ee-ab70-9112-0c776aafa909","key":"SchemaIdentifier","description":"(Required) Schema identifier - can be a UUID (SchemaId) or a human-readable string (Schema AppId/API name, 3-25 characters)"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"httpStatus\": 8176,\n \"errorCode\": \"string\",\n \"timestamp\": \"2009-08-02T10:31:15.071Z\",\n \"message\": \"string\",\n \"traceId\": \"string\",\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"source\": {\n \"pointer\": \"string\",\n \"value\": \"string\"\n },\n \"details\": {\n \"key_0\": {}\n },\n \"field\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"87acd9b4-0447-46c5-a83a-50e951481f83","name":"The request could not be completed due to a conflict with the current state of the resource. See error message for details.","originalRequest":{"url":{"path":["brickworks","v1","schemas",":SchemaIdentifier"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"44e5411f-17ee-ab70-9112-0c776aafa909","key":"SchemaIdentifier","description":"(Required) Schema identifier - can be a UUID (SchemaId) or a human-readable string (Schema AppId/API name, 3-25 characters)"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{}},"status":"Conflict","code":409,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"httpStatus\": 8176,\n \"errorCode\": \"string\",\n \"timestamp\": \"2009-08-02T10:31:15.071Z\",\n \"message\": \"string\",\n \"traceId\": \"string\",\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"source\": {\n \"pointer\": \"string\",\n \"value\": \"string\"\n },\n \"details\": {\n \"key_0\": {}\n },\n \"field\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"4d4d239a-5bb5-4514-b448-b566d93d912c","name":"The request was well-formed but could not be processed due to semantic or domain-related constraints. See error message for details.","originalRequest":{"url":{"path":["brickworks","v1","schemas",":SchemaIdentifier"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"44e5411f-17ee-ab70-9112-0c776aafa909","key":"SchemaIdentifier","description":"(Required) Schema identifier - can be a UUID (SchemaId) or a human-readable string (Schema AppId/API name, 3-25 characters)"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"httpStatus\": 8176,\n \"errorCode\": \"string\",\n \"timestamp\": \"2009-08-02T10:31:15.071Z\",\n \"message\": \"string\",\n \"traceId\": \"string\",\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"source\": {\n \"pointer\": \"string\",\n \"value\": \"string\"\n },\n \"details\": {\n \"key_0\": {}\n },\n \"field\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"54d8ecba-0274-4edc-8f9b-7af56b976ea4","name":"See error message for details.","originalRequest":{"url":{"path":["brickworks","v1","schemas",":SchemaIdentifier"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"44e5411f-17ee-ab70-9112-0c776aafa909","key":"SchemaIdentifier","description":"(Required) Schema identifier - can be a UUID (SchemaId) or a human-readable string (Schema AppId/API name, 3-25 characters)"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"httpStatus\": 8176,\n \"errorCode\": \"string\",\n \"timestamp\": \"2009-08-02T10:31:15.071Z\",\n \"message\": \"string\",\n \"traceId\": \"string\",\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"source\": {\n \"pointer\": \"string\",\n \"value\": \"string\"\n },\n \"details\": {\n \"key_0\": {}\n },\n \"field\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}],"event":[]},{"id":"f5268e56-60dc-49e5-a3e9-6316bd1bd562","name":"Brickworks: Records","description":{"content":"","type":"text/plain"},"item":[{"id":"a84ff0b1-0055-4494-a586-73b2ab746d68","name":"Get records from schema","request":{"name":"Get records from schema","description":{"content":"Retrieve records from a schema. You can paginate, sort, and refine the results. By default, the records are sorted by status (published > scheduled > draft > unpublished) and then by last update time.\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `BRICKWORKS_RECORDS_READ`\n\n**User role permission required:** `assets_brickworks: read`\n","type":"text/plain"},"url":{"path":["brickworks","v1","schemas",":SchemaIdentifier","records"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"limit","value":"50","description":"Limit of items per page"},{"disabled":false,"key":"page","value":"1","description":"The number of the page to retrieve"},{"disabled":false,"key":"filters","value":"string"},{"disabled":false,"key":"search","value":"string","description":"A string to search for in the values of searchable fields. \nIf `filter` is used, this parameter is ignored.\n"},{"disabled":false,"key":"sortBy","value":"__updatedAt:asc","description":"You can change the default sorting. The sorting direction is selected by adding `asc` or `desc`, for example `sortBy=__createdAt:desc`.\n\nSystem parameters are prefixed with `__` to avoid name collisions with fields you add to the schema. \n\nYou can sort by:\n - `__id`\n - `__createdAt`\n - `__updatedAt`\n"},{"disabled":false,"key":"ids","value":"string","description":"Comma-separated list of IDs (in UUID format) to filter results through"},{"disabled":false,"key":"statuses","value":"DRAFT","description":"Comma-separated list of record statuses to filter the results."},{"disabled":false,"key":"slugs","value":"string","description":"Comma-separated list of slugs to filter results through"},{"disabled":false,"key":"fields","value":"string","description":"A comma-separated list of fields to retrieve. If not defined, all fields are included in the response."},{"disabled":false,"key":"fields","value":"string","description":"A comma-separated list of fields to retrieve. If not defined, all fields are included in the response."}],"variable":[{"disabled":false,"type":"any","value":"44e5411f-17ee-ab70-9112-0c776aafa909","key":"SchemaIdentifier","description":"(Required) Schema identifier - can be a UUID (SchemaId) or a human-readable string (Schema AppId/API name, 3-25 characters)"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"a48c29d2-c7d5-4960-bf1c-3a046014be76","name":"A page of records","originalRequest":{"url":{"path":["brickworks","v1","schemas",":SchemaIdentifier","records"],"host":["{{baseUrl}}"],"query":[{"key":"limit","value":"50"},{"key":"page","value":"1"},{"key":"filters","value":"string"},{"key":"search","value":"string"},{"key":"sortBy","value":"__updatedAt:asc"},{"key":"ids","value":"string"},{"key":"statuses","value":"DRAFT"},{"key":"slugs","value":"string"},{"key":"fields","value":"string"},{"key":"fields","value":"string"}],"variable":[{"disabled":false,"type":"any","value":"44e5411f-17ee-ab70-9112-0c776aafa909","key":"SchemaIdentifier","description":"(Required) Schema identifier - can be a UUID (SchemaId) or a human-readable string (Schema AppId/API name, 3-25 characters)"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"meta\": {\n \"links\": {\n \"value\": \"\"\n },\n \"limit\": {\n \"value\": \"\"\n },\n \"count\": {\n \"value\": \"\"\n }\n },\n \"data\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"90b48a59-edb7-4584-b936-5c21b607e520","name":"Incorrect request (malformed JSON, wrong parameters, etc.). See error message for details.","originalRequest":{"url":{"path":["brickworks","v1","schemas",":SchemaIdentifier","records"],"host":["{{baseUrl}}"],"query":[{"key":"limit","value":"50"},{"key":"page","value":"1"},{"key":"filters","value":"string"},{"key":"search","value":"string"},{"key":"sortBy","value":"__updatedAt:asc"},{"key":"ids","value":"string"},{"key":"statuses","value":"DRAFT"},{"key":"slugs","value":"string"},{"key":"fields","value":"string"},{"key":"fields","value":"string"}],"variable":[{"disabled":false,"type":"any","value":"44e5411f-17ee-ab70-9112-0c776aafa909","key":"SchemaIdentifier","description":"(Required) Schema identifier - can be a UUID (SchemaId) or a human-readable string (Schema AppId/API name, 3-25 characters)"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"httpStatus\": 8176,\n \"errorCode\": \"string\",\n \"timestamp\": \"2009-08-02T10:31:15.071Z\",\n \"message\": \"string\",\n \"traceId\": \"string\",\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"source\": {\n \"pointer\": \"string\",\n \"value\": \"string\"\n },\n \"details\": {\n \"key_0\": {}\n },\n \"field\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"f53a9628-9871-477a-a3d8-8d0848382d23","name":"Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc. See error message for details.","originalRequest":{"url":{"path":["brickworks","v1","schemas",":SchemaIdentifier","records"],"host":["{{baseUrl}}"],"query":[{"key":"limit","value":"50"},{"key":"page","value":"1"},{"key":"filters","value":"string"},{"key":"search","value":"string"},{"key":"sortBy","value":"__updatedAt:asc"},{"key":"ids","value":"string"},{"key":"statuses","value":"DRAFT"},{"key":"slugs","value":"string"},{"key":"fields","value":"string"},{"key":"fields","value":"string"}],"variable":[{"disabled":false,"type":"any","value":"44e5411f-17ee-ab70-9112-0c776aafa909","key":"SchemaIdentifier","description":"(Required) Schema identifier - can be a UUID (SchemaId) or a human-readable string (Schema AppId/API name, 3-25 characters)"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\",\n \"status\": 647,\n \"timestamp\": \"string\",\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"f36f2806-32d2-4c4d-a301-1f7c7c3fc2e2","name":"Forbidden; insufficient permissions. See error message for details.","originalRequest":{"url":{"path":["brickworks","v1","schemas",":SchemaIdentifier","records"],"host":["{{baseUrl}}"],"query":[{"key":"limit","value":"50"},{"key":"page","value":"1"},{"key":"filters","value":"string"},{"key":"search","value":"string"},{"key":"sortBy","value":"__updatedAt:asc"},{"key":"ids","value":"string"},{"key":"statuses","value":"DRAFT"},{"key":"slugs","value":"string"},{"key":"fields","value":"string"},{"key":"fields","value":"string"}],"variable":[{"disabled":false,"type":"any","value":"44e5411f-17ee-ab70-9112-0c776aafa909","key":"SchemaIdentifier","description":"(Required) Schema identifier - can be a UUID (SchemaId) or a human-readable string (Schema AppId/API name, 3-25 characters)"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\",\n \"status\": 647,\n \"timestamp\": \"string\",\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"054bb830-942b-4532-8548-5c8f18916b72","name":"Resource not found. See error message for details.","originalRequest":{"url":{"path":["brickworks","v1","schemas",":SchemaIdentifier","records"],"host":["{{baseUrl}}"],"query":[{"key":"limit","value":"50"},{"key":"page","value":"1"},{"key":"filters","value":"string"},{"key":"search","value":"string"},{"key":"sortBy","value":"__updatedAt:asc"},{"key":"ids","value":"string"},{"key":"statuses","value":"DRAFT"},{"key":"slugs","value":"string"},{"key":"fields","value":"string"},{"key":"fields","value":"string"}],"variable":[{"disabled":false,"type":"any","value":"44e5411f-17ee-ab70-9112-0c776aafa909","key":"SchemaIdentifier","description":"(Required) Schema identifier - can be a UUID (SchemaId) or a human-readable string (Schema AppId/API name, 3-25 characters)"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"httpStatus\": 8176,\n \"errorCode\": \"string\",\n \"timestamp\": \"2009-08-02T10:31:15.071Z\",\n \"message\": \"string\",\n \"traceId\": \"string\",\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"source\": {\n \"pointer\": \"string\",\n \"value\": \"string\"\n },\n \"details\": {\n \"key_0\": {}\n },\n \"field\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"ed1da3c6-5025-4fbb-a183-e9b472dcc94c","name":"The request could not be completed due to a conflict with the current state of the resource. See error message for details.","originalRequest":{"url":{"path":["brickworks","v1","schemas",":SchemaIdentifier","records"],"host":["{{baseUrl}}"],"query":[{"key":"limit","value":"50"},{"key":"page","value":"1"},{"key":"filters","value":"string"},{"key":"search","value":"string"},{"key":"sortBy","value":"__updatedAt:asc"},{"key":"ids","value":"string"},{"key":"statuses","value":"DRAFT"},{"key":"slugs","value":"string"},{"key":"fields","value":"string"},{"key":"fields","value":"string"}],"variable":[{"disabled":false,"type":"any","value":"44e5411f-17ee-ab70-9112-0c776aafa909","key":"SchemaIdentifier","description":"(Required) Schema identifier - can be a UUID (SchemaId) or a human-readable string (Schema AppId/API name, 3-25 characters)"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Conflict","code":409,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"httpStatus\": 8176,\n \"errorCode\": \"string\",\n \"timestamp\": \"2009-08-02T10:31:15.071Z\",\n \"message\": \"string\",\n \"traceId\": \"string\",\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"source\": {\n \"pointer\": \"string\",\n \"value\": \"string\"\n },\n \"details\": {\n \"key_0\": {}\n },\n \"field\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"984ab638-53f0-4e2a-a817-95b1671a8f97","name":"The request was well-formed but could not be processed due to semantic or domain-related constraints. See error message for details.","originalRequest":{"url":{"path":["brickworks","v1","schemas",":SchemaIdentifier","records"],"host":["{{baseUrl}}"],"query":[{"key":"limit","value":"50"},{"key":"page","value":"1"},{"key":"filters","value":"string"},{"key":"search","value":"string"},{"key":"sortBy","value":"__updatedAt:asc"},{"key":"ids","value":"string"},{"key":"statuses","value":"DRAFT"},{"key":"slugs","value":"string"},{"key":"fields","value":"string"},{"key":"fields","value":"string"}],"variable":[{"disabled":false,"type":"any","value":"44e5411f-17ee-ab70-9112-0c776aafa909","key":"SchemaIdentifier","description":"(Required) Schema identifier - can be a UUID (SchemaId) or a human-readable string (Schema AppId/API name, 3-25 characters)"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"httpStatus\": 8176,\n \"errorCode\": \"string\",\n \"timestamp\": \"2009-08-02T10:31:15.071Z\",\n \"message\": \"string\",\n \"traceId\": \"string\",\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"source\": {\n \"pointer\": \"string\",\n \"value\": \"string\"\n },\n \"details\": {\n \"key_0\": {}\n },\n \"field\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"39d13f57-b590-4f0a-848b-5c7c1ea4da50","name":"See error message for details.","originalRequest":{"url":{"path":["brickworks","v1","schemas",":SchemaIdentifier","records"],"host":["{{baseUrl}}"],"query":[{"key":"limit","value":"50"},{"key":"page","value":"1"},{"key":"filters","value":"string"},{"key":"search","value":"string"},{"key":"sortBy","value":"__updatedAt:asc"},{"key":"ids","value":"string"},{"key":"statuses","value":"DRAFT"},{"key":"slugs","value":"string"},{"key":"fields","value":"string"},{"key":"fields","value":"string"}],"variable":[{"disabled":false,"type":"any","value":"44e5411f-17ee-ab70-9112-0c776aafa909","key":"SchemaIdentifier","description":"(Required) Schema identifier - can be a UUID (SchemaId) or a human-readable string (Schema AppId/API name, 3-25 characters)"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"httpStatus\": 8176,\n \"errorCode\": \"string\",\n \"timestamp\": \"2009-08-02T10:31:15.071Z\",\n \"message\": \"string\",\n \"traceId\": \"string\",\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"source\": {\n \"pointer\": \"string\",\n \"value\": \"string\"\n },\n \"details\": {\n \"key_0\": {}\n },\n \"field\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"bd497fc8-45ee-4bce-a736-db5b90c742a6","name":"Add record to schema","request":{"name":"Add record to schema","description":{"content":"Add a record to a schema\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `BRICKWORKS_RECORDS_CREATE`\n\n**User role permission required:** `assets_brickworks: create`\n","type":"text/plain"},"url":{"path":["brickworks","v1","schemas",":SchemaIdentifier","records"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"44e5411f-17ee-ab70-9112-0c776aafa909","key":"SchemaIdentifier","description":"(Required) Schema identifier - can be a UUID (SchemaId) or a human-readable string (Schema AppId/API name, 3-25 characters)"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"values\": {\n \"stringField\": \"example string\",\n \"numberField\": 123.45,\n \"integerField\": 42,\n \"booleanField\": true,\n \"dateField\": \"2024-01-15\",\n \"dateTimeField\": \"2024-01-15T10:30:00Z\",\n \"uuidField\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"arrayField\": [\n \"item1\",\n \"item2\"\n ],\n \"objectField\": {\n \"key\": \"value\"\n },\n \"profileAttribute\": {\n \"attributeName\": \"email\"\n },\n \"catalog\": {\n \"itemKey\": \"SKU123\"\n },\n \"recommendation\": {\n \"params\": {\n \"itemId\": \"item-123\"\n }\n }\n },\n \"slug\": \"oOTQQC\",\n \"status\": \"PUBLISHED\",\n \"actionOnSchedule\": \"PUBLISH\",\n \"schedule\": {\n \"timezone\": {\n \"value\": \"\"\n },\n \"startType\": {\n \"value\": \"\"\n },\n \"startDate\": {\n \"value\": \"\"\n },\n \"endType\": {\n \"value\": \"\"\n },\n \"enabled\": {\n \"value\": \"\"\n },\n \"endDate\": {\n \"value\": \"\"\n },\n \"periodType\": {\n \"value\": \"\"\n },\n \"parts\": {\n \"value\": \"\"\n }\n },\n \"name\": \"string\",\n \"personalizationId\": \"fff995ae-4e26-5786-fe9d-9bcc1d027562\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"9cb22a56-85ba-4358-bc11-01cf765e7a88","name":"Record data","originalRequest":{"url":{"path":["brickworks","v1","schemas",":SchemaIdentifier","records"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"44e5411f-17ee-ab70-9112-0c776aafa909","key":"SchemaIdentifier","description":"(Required) Schema identifier - can be a UUID (SchemaId) or a human-readable string (Schema AppId/API name, 3-25 characters)"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"values\": {\n \"stringField\": \"example string\",\n \"numberField\": 123.45,\n \"integerField\": 42,\n \"booleanField\": true,\n \"dateField\": \"2024-01-15\",\n \"dateTimeField\": \"2024-01-15T10:30:00Z\",\n \"uuidField\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"arrayField\": [\n \"item1\",\n \"item2\"\n ],\n \"objectField\": {\n \"key\": \"value\"\n },\n \"profileAttribute\": {\n \"attributeName\": \"email\"\n },\n \"catalog\": {\n \"itemKey\": \"SKU123\"\n },\n \"recommendation\": {\n \"params\": {\n \"itemId\": \"item-123\"\n }\n }\n },\n \"slug\": \"oOTQQC\",\n \"status\": \"PUBLISHED\",\n \"actionOnSchedule\": \"PUBLISH\",\n \"schedule\": {\n \"timezone\": {\n \"value\": \"\"\n },\n \"startType\": {\n \"value\": \"\"\n },\n \"startDate\": {\n \"value\": \"\"\n },\n \"endType\": {\n \"value\": \"\"\n },\n \"enabled\": {\n \"value\": \"\"\n },\n \"endDate\": {\n \"value\": \"\"\n },\n \"periodType\": {\n \"value\": \"\"\n },\n \"parts\": {\n \"value\": \"\"\n }\n },\n \"name\": \"string\",\n \"personalizationId\": \"fff995ae-4e26-5786-fe9d-9bcc1d027562\"\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"schemaId\": {\n \"value\": \"\"\n },\n \"values\": {\n \"value\": \"\"\n },\n \"createdBy\": {\n \"value\": \"\"\n },\n \"updatedBy\": {\n \"value\": \"\"\n },\n \"createdAt\": {\n \"value\": \"\"\n },\n \"updatedAt\": {\n \"value\": \"\"\n },\n \"status\": {\n \"value\": \"\"\n },\n \"recordVersion\": {\n \"value\": \"\"\n },\n \"publishedBy\": {\n \"value\": \"\"\n },\n \"deletedBy\": {\n \"value\": \"\"\n },\n \"publishedAt\": {\n \"value\": \"\"\n },\n \"deletedAt\": {\n \"value\": \"\"\n },\n \"slug\": {\n \"value\": \"\"\n },\n \"schemaVersion\": 7838,\n \"schedule\": {\n \"value\": \"\"\n },\n \"personalizationId\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"5c8e056a-3af0-4d30-8ec1-8b52bad9ea5e","name":"Incorrect request (malformed JSON, wrong parameters, etc.). See error message for details.","originalRequest":{"url":{"path":["brickworks","v1","schemas",":SchemaIdentifier","records"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"44e5411f-17ee-ab70-9112-0c776aafa909","key":"SchemaIdentifier","description":"(Required) Schema identifier - can be a UUID (SchemaId) or a human-readable string (Schema AppId/API name, 3-25 characters)"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"values\": {\n \"stringField\": \"example string\",\n \"numberField\": 123.45,\n \"integerField\": 42,\n \"booleanField\": true,\n \"dateField\": \"2024-01-15\",\n \"dateTimeField\": \"2024-01-15T10:30:00Z\",\n \"uuidField\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"arrayField\": [\n \"item1\",\n \"item2\"\n ],\n \"objectField\": {\n \"key\": \"value\"\n },\n \"profileAttribute\": {\n \"attributeName\": \"email\"\n },\n \"catalog\": {\n \"itemKey\": \"SKU123\"\n },\n \"recommendation\": {\n \"params\": {\n \"itemId\": \"item-123\"\n }\n }\n },\n \"slug\": \"oOTQQC\",\n \"status\": \"PUBLISHED\",\n \"actionOnSchedule\": \"PUBLISH\",\n \"schedule\": {\n \"timezone\": {\n \"value\": \"\"\n },\n \"startType\": {\n \"value\": \"\"\n },\n \"startDate\": {\n \"value\": \"\"\n },\n \"endType\": {\n \"value\": \"\"\n },\n \"enabled\": {\n \"value\": \"\"\n },\n \"endDate\": {\n \"value\": \"\"\n },\n \"periodType\": {\n \"value\": \"\"\n },\n \"parts\": {\n \"value\": \"\"\n }\n },\n \"name\": \"string\",\n \"personalizationId\": \"fff995ae-4e26-5786-fe9d-9bcc1d027562\"\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"httpStatus\": 8176,\n \"errorCode\": \"string\",\n \"timestamp\": \"2009-08-02T10:31:15.071Z\",\n \"message\": \"string\",\n \"traceId\": \"string\",\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"source\": {\n \"pointer\": \"string\",\n \"value\": \"string\"\n },\n \"details\": {\n \"key_0\": {}\n },\n \"field\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"ae657a8d-2455-4439-b38f-f5031507b8ac","name":"Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc. See error message for details.","originalRequest":{"url":{"path":["brickworks","v1","schemas",":SchemaIdentifier","records"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"44e5411f-17ee-ab70-9112-0c776aafa909","key":"SchemaIdentifier","description":"(Required) Schema identifier - can be a UUID (SchemaId) or a human-readable string (Schema AppId/API name, 3-25 characters)"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"values\": {\n \"stringField\": \"example string\",\n \"numberField\": 123.45,\n \"integerField\": 42,\n \"booleanField\": true,\n \"dateField\": \"2024-01-15\",\n \"dateTimeField\": \"2024-01-15T10:30:00Z\",\n \"uuidField\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"arrayField\": [\n \"item1\",\n \"item2\"\n ],\n \"objectField\": {\n \"key\": \"value\"\n },\n \"profileAttribute\": {\n \"attributeName\": \"email\"\n },\n \"catalog\": {\n \"itemKey\": \"SKU123\"\n },\n \"recommendation\": {\n \"params\": {\n \"itemId\": \"item-123\"\n }\n }\n },\n \"slug\": \"oOTQQC\",\n \"status\": \"PUBLISHED\",\n \"actionOnSchedule\": \"PUBLISH\",\n \"schedule\": {\n \"timezone\": {\n \"value\": \"\"\n },\n \"startType\": {\n \"value\": \"\"\n },\n \"startDate\": {\n \"value\": \"\"\n },\n \"endType\": {\n \"value\": \"\"\n },\n \"enabled\": {\n \"value\": \"\"\n },\n \"endDate\": {\n \"value\": \"\"\n },\n \"periodType\": {\n \"value\": \"\"\n },\n \"parts\": {\n \"value\": \"\"\n }\n },\n \"name\": \"string\",\n \"personalizationId\": \"fff995ae-4e26-5786-fe9d-9bcc1d027562\"\n}","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\",\n \"status\": 647,\n \"timestamp\": \"string\",\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"5ead3ac4-0046-438f-9ac1-9452d73e65d9","name":"Forbidden; insufficient permissions. See error message for details.","originalRequest":{"url":{"path":["brickworks","v1","schemas",":SchemaIdentifier","records"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"44e5411f-17ee-ab70-9112-0c776aafa909","key":"SchemaIdentifier","description":"(Required) Schema identifier - can be a UUID (SchemaId) or a human-readable string (Schema AppId/API name, 3-25 characters)"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"values\": {\n \"stringField\": \"example string\",\n \"numberField\": 123.45,\n \"integerField\": 42,\n \"booleanField\": true,\n \"dateField\": \"2024-01-15\",\n \"dateTimeField\": \"2024-01-15T10:30:00Z\",\n \"uuidField\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"arrayField\": [\n \"item1\",\n \"item2\"\n ],\n \"objectField\": {\n \"key\": \"value\"\n },\n \"profileAttribute\": {\n \"attributeName\": \"email\"\n },\n \"catalog\": {\n \"itemKey\": \"SKU123\"\n },\n \"recommendation\": {\n \"params\": {\n \"itemId\": \"item-123\"\n }\n }\n },\n \"slug\": \"oOTQQC\",\n \"status\": \"PUBLISHED\",\n \"actionOnSchedule\": \"PUBLISH\",\n \"schedule\": {\n \"timezone\": {\n \"value\": \"\"\n },\n \"startType\": {\n \"value\": \"\"\n },\n \"startDate\": {\n \"value\": \"\"\n },\n \"endType\": {\n \"value\": \"\"\n },\n \"enabled\": {\n \"value\": \"\"\n },\n \"endDate\": {\n \"value\": \"\"\n },\n \"periodType\": {\n \"value\": \"\"\n },\n \"parts\": {\n \"value\": \"\"\n }\n },\n \"name\": \"string\",\n \"personalizationId\": \"fff995ae-4e26-5786-fe9d-9bcc1d027562\"\n}","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\",\n \"status\": 647,\n \"timestamp\": \"string\",\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"dde5c161-b17e-47ce-83ae-cc5d1911f0d3","name":"Resource not found. See error message for details.","originalRequest":{"url":{"path":["brickworks","v1","schemas",":SchemaIdentifier","records"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"44e5411f-17ee-ab70-9112-0c776aafa909","key":"SchemaIdentifier","description":"(Required) Schema identifier - can be a UUID (SchemaId) or a human-readable string (Schema AppId/API name, 3-25 characters)"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"values\": {\n \"stringField\": \"example string\",\n \"numberField\": 123.45,\n \"integerField\": 42,\n \"booleanField\": true,\n \"dateField\": \"2024-01-15\",\n \"dateTimeField\": \"2024-01-15T10:30:00Z\",\n \"uuidField\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"arrayField\": [\n \"item1\",\n \"item2\"\n ],\n \"objectField\": {\n \"key\": \"value\"\n },\n \"profileAttribute\": {\n \"attributeName\": \"email\"\n },\n \"catalog\": {\n \"itemKey\": \"SKU123\"\n },\n \"recommendation\": {\n \"params\": {\n \"itemId\": \"item-123\"\n }\n }\n },\n \"slug\": \"oOTQQC\",\n \"status\": \"PUBLISHED\",\n \"actionOnSchedule\": \"PUBLISH\",\n \"schedule\": {\n \"timezone\": {\n \"value\": \"\"\n },\n \"startType\": {\n \"value\": \"\"\n },\n \"startDate\": {\n \"value\": \"\"\n },\n \"endType\": {\n \"value\": \"\"\n },\n \"enabled\": {\n \"value\": \"\"\n },\n \"endDate\": {\n \"value\": \"\"\n },\n \"periodType\": {\n \"value\": \"\"\n },\n \"parts\": {\n \"value\": \"\"\n }\n },\n \"name\": \"string\",\n \"personalizationId\": \"fff995ae-4e26-5786-fe9d-9bcc1d027562\"\n}","options":{"raw":{"language":"json"}}}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"httpStatus\": 8176,\n \"errorCode\": \"string\",\n \"timestamp\": \"2009-08-02T10:31:15.071Z\",\n \"message\": \"string\",\n \"traceId\": \"string\",\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"source\": {\n \"pointer\": \"string\",\n \"value\": \"string\"\n },\n \"details\": {\n \"key_0\": {}\n },\n \"field\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"ef8d53ac-5c62-4ce7-9af2-97d1a5e98fa5","name":"The request could not be completed due to a conflict with the current state of the resource. See error message for details.","originalRequest":{"url":{"path":["brickworks","v1","schemas",":SchemaIdentifier","records"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"44e5411f-17ee-ab70-9112-0c776aafa909","key":"SchemaIdentifier","description":"(Required) Schema identifier - can be a UUID (SchemaId) or a human-readable string (Schema AppId/API name, 3-25 characters)"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"values\": {\n \"stringField\": \"example string\",\n \"numberField\": 123.45,\n \"integerField\": 42,\n \"booleanField\": true,\n \"dateField\": \"2024-01-15\",\n \"dateTimeField\": \"2024-01-15T10:30:00Z\",\n \"uuidField\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"arrayField\": [\n \"item1\",\n \"item2\"\n ],\n \"objectField\": {\n \"key\": \"value\"\n },\n \"profileAttribute\": {\n \"attributeName\": \"email\"\n },\n \"catalog\": {\n \"itemKey\": \"SKU123\"\n },\n \"recommendation\": {\n \"params\": {\n \"itemId\": \"item-123\"\n }\n }\n },\n \"slug\": \"oOTQQC\",\n \"status\": \"PUBLISHED\",\n \"actionOnSchedule\": \"PUBLISH\",\n \"schedule\": {\n \"timezone\": {\n \"value\": \"\"\n },\n \"startType\": {\n \"value\": \"\"\n },\n \"startDate\": {\n \"value\": \"\"\n },\n \"endType\": {\n \"value\": \"\"\n },\n \"enabled\": {\n \"value\": \"\"\n },\n \"endDate\": {\n \"value\": \"\"\n },\n \"periodType\": {\n \"value\": \"\"\n },\n \"parts\": {\n \"value\": \"\"\n }\n },\n \"name\": \"string\",\n \"personalizationId\": \"fff995ae-4e26-5786-fe9d-9bcc1d027562\"\n}","options":{"raw":{"language":"json"}}}},"status":"Conflict","code":409,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"httpStatus\": 8176,\n \"errorCode\": \"string\",\n \"timestamp\": \"2009-08-02T10:31:15.071Z\",\n \"message\": \"string\",\n \"traceId\": \"string\",\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"source\": {\n \"pointer\": \"string\",\n \"value\": \"string\"\n },\n \"details\": {\n \"key_0\": {}\n },\n \"field\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"6f666bcd-b46c-4444-ac36-9af9439881aa","name":"The request was well-formed but could not be processed due to semantic or domain-related constraints. See error message for details.","originalRequest":{"url":{"path":["brickworks","v1","schemas",":SchemaIdentifier","records"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"44e5411f-17ee-ab70-9112-0c776aafa909","key":"SchemaIdentifier","description":"(Required) Schema identifier - can be a UUID (SchemaId) or a human-readable string (Schema AppId/API name, 3-25 characters)"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"values\": {\n \"stringField\": \"example string\",\n \"numberField\": 123.45,\n \"integerField\": 42,\n \"booleanField\": true,\n \"dateField\": \"2024-01-15\",\n \"dateTimeField\": \"2024-01-15T10:30:00Z\",\n \"uuidField\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"arrayField\": [\n \"item1\",\n \"item2\"\n ],\n \"objectField\": {\n \"key\": \"value\"\n },\n \"profileAttribute\": {\n \"attributeName\": \"email\"\n },\n \"catalog\": {\n \"itemKey\": \"SKU123\"\n },\n \"recommendation\": {\n \"params\": {\n \"itemId\": \"item-123\"\n }\n }\n },\n \"slug\": \"oOTQQC\",\n \"status\": \"PUBLISHED\",\n \"actionOnSchedule\": \"PUBLISH\",\n \"schedule\": {\n \"timezone\": {\n \"value\": \"\"\n },\n \"startType\": {\n \"value\": \"\"\n },\n \"startDate\": {\n \"value\": \"\"\n },\n \"endType\": {\n \"value\": \"\"\n },\n \"enabled\": {\n \"value\": \"\"\n },\n \"endDate\": {\n \"value\": \"\"\n },\n \"periodType\": {\n \"value\": \"\"\n },\n \"parts\": {\n \"value\": \"\"\n }\n },\n \"name\": \"string\",\n \"personalizationId\": \"fff995ae-4e26-5786-fe9d-9bcc1d027562\"\n}","options":{"raw":{"language":"json"}}}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"httpStatus\": 8176,\n \"errorCode\": \"string\",\n \"timestamp\": \"2009-08-02T10:31:15.071Z\",\n \"message\": \"string\",\n \"traceId\": \"string\",\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"source\": {\n \"pointer\": \"string\",\n \"value\": \"string\"\n },\n \"details\": {\n \"key_0\": {}\n },\n \"field\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"a51ed5c4-25c1-4f35-b968-0a924dd34244","name":"See error message for details.","originalRequest":{"url":{"path":["brickworks","v1","schemas",":SchemaIdentifier","records"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"44e5411f-17ee-ab70-9112-0c776aafa909","key":"SchemaIdentifier","description":"(Required) Schema identifier - can be a UUID (SchemaId) or a human-readable string (Schema AppId/API name, 3-25 characters)"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"values\": {\n \"stringField\": \"example string\",\n \"numberField\": 123.45,\n \"integerField\": 42,\n \"booleanField\": true,\n \"dateField\": \"2024-01-15\",\n \"dateTimeField\": \"2024-01-15T10:30:00Z\",\n \"uuidField\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"arrayField\": [\n \"item1\",\n \"item2\"\n ],\n \"objectField\": {\n \"key\": \"value\"\n },\n \"profileAttribute\": {\n \"attributeName\": \"email\"\n },\n \"catalog\": {\n \"itemKey\": \"SKU123\"\n },\n \"recommendation\": {\n \"params\": {\n \"itemId\": \"item-123\"\n }\n }\n },\n \"slug\": \"oOTQQC\",\n \"status\": \"PUBLISHED\",\n \"actionOnSchedule\": \"PUBLISH\",\n \"schedule\": {\n \"timezone\": {\n \"value\": \"\"\n },\n \"startType\": {\n \"value\": \"\"\n },\n \"startDate\": {\n \"value\": \"\"\n },\n \"endType\": {\n \"value\": \"\"\n },\n \"enabled\": {\n \"value\": \"\"\n },\n \"endDate\": {\n \"value\": \"\"\n },\n \"periodType\": {\n \"value\": \"\"\n },\n \"parts\": {\n \"value\": \"\"\n }\n },\n \"name\": \"string\",\n \"personalizationId\": \"fff995ae-4e26-5786-fe9d-9bcc1d027562\"\n}","options":{"raw":{"language":"json"}}}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"httpStatus\": 8176,\n \"errorCode\": \"string\",\n \"timestamp\": \"2009-08-02T10:31:15.071Z\",\n \"message\": \"string\",\n \"traceId\": \"string\",\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"source\": {\n \"pointer\": \"string\",\n \"value\": \"string\"\n },\n \"details\": {\n \"key_0\": {}\n },\n \"field\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"0952372f-b46a-462d-af65-e7d4f61ea1b4","name":"Get record","request":{"name":"Get record","description":{"content":"Retrieve a record. You can select the fields that you want to include in the response.\n\nIf the record has multiple versions in different publishing states, the first available version is returned according to publishing status priority:\n - PUBLISHED\n - DRAFT\n - SCHEDULED\n - UNPUBLISHED\nYou can use the `statuses` parameter to limit the lookup.\n\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `BRICKWORKS_RECORDS_READ`\n\n**User role permission required:** `assets_brickworks: read`\n","type":"text/plain"},"url":{"path":["brickworks","v1","schemas",":SchemaIdentifier","records",":RecordIdentifier"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"fields","value":"string","description":"A comma-separated list of fields to retrieve. If not defined, all fields are included in the response."},{"disabled":false,"key":"fields","value":"string","description":"A comma-separated list of fields to retrieve. If not defined, all fields are included in the response."},{"disabled":false,"key":"statuses","value":"DRAFT","description":"Comma-separated list of record statuses to filter the results."}],"variable":[{"disabled":false,"type":"any","value":"44e5411f-17ee-ab70-9112-0c776aafa909","key":"SchemaIdentifier","description":"(Required) Schema identifier - can be a UUID (SchemaId) or a human-readable string (Schema AppId/API name, 3-25 characters)"},{"disabled":false,"type":"any","value":"10cc476e-4cea-1124-9ba2-805e59214048","key":"RecordIdentifier","description":"(Required) Record identifier - can be a UUID (RecordId) or a human-readable slug (RecordSlug, 6-40 characters)"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"49a55ac8-d5e1-44b2-a91b-af7fe6477fc9","name":"Details of the record","originalRequest":{"url":{"path":["brickworks","v1","schemas",":SchemaIdentifier","records",":RecordIdentifier"],"host":["{{baseUrl}}"],"query":[{"key":"fields","value":"string"},{"key":"fields","value":"string"},{"key":"statuses","value":"DRAFT"}],"variable":[{"disabled":false,"type":"any","value":"44e5411f-17ee-ab70-9112-0c776aafa909","key":"SchemaIdentifier","description":"(Required) Schema identifier - can be a UUID (SchemaId) or a human-readable string (Schema AppId/API name, 3-25 characters)"},{"disabled":false,"type":"any","value":"10cc476e-4cea-1124-9ba2-805e59214048","key":"RecordIdentifier","description":"(Required) Record identifier - can be a UUID (RecordId) or a human-readable slug (RecordSlug, 6-40 characters)"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"schemaId\": {\n \"value\": \"\"\n },\n \"values\": {\n \"value\": \"\"\n },\n \"createdBy\": {\n \"value\": \"\"\n },\n \"updatedBy\": {\n \"value\": \"\"\n },\n \"createdAt\": {\n \"value\": \"\"\n },\n \"updatedAt\": {\n \"value\": \"\"\n },\n \"status\": {\n \"value\": \"\"\n },\n \"recordVersion\": {\n \"value\": \"\"\n },\n \"publishedBy\": {\n \"value\": \"\"\n },\n \"deletedBy\": {\n \"value\": \"\"\n },\n \"publishedAt\": {\n \"value\": \"\"\n },\n \"deletedAt\": {\n \"value\": \"\"\n },\n \"slug\": {\n \"value\": \"\"\n },\n \"schemaVersion\": 7838,\n \"schedule\": {\n \"value\": \"\"\n },\n \"personalizationId\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"6decc55f-e7d0-4b1b-96fb-a33d924e8d73","name":"Incorrect request (malformed JSON, wrong parameters, etc.). See error message for details.","originalRequest":{"url":{"path":["brickworks","v1","schemas",":SchemaIdentifier","records",":RecordIdentifier"],"host":["{{baseUrl}}"],"query":[{"key":"fields","value":"string"},{"key":"fields","value":"string"},{"key":"statuses","value":"DRAFT"}],"variable":[{"disabled":false,"type":"any","value":"44e5411f-17ee-ab70-9112-0c776aafa909","key":"SchemaIdentifier","description":"(Required) Schema identifier - can be a UUID (SchemaId) or a human-readable string (Schema AppId/API name, 3-25 characters)"},{"disabled":false,"type":"any","value":"10cc476e-4cea-1124-9ba2-805e59214048","key":"RecordIdentifier","description":"(Required) Record identifier - can be a UUID (RecordId) or a human-readable slug (RecordSlug, 6-40 characters)"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"httpStatus\": 8176,\n \"errorCode\": \"string\",\n \"timestamp\": \"2009-08-02T10:31:15.071Z\",\n \"message\": \"string\",\n \"traceId\": \"string\",\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"source\": {\n \"pointer\": \"string\",\n \"value\": \"string\"\n },\n \"details\": {\n \"key_0\": {}\n },\n \"field\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"c182c502-2ca1-425f-b327-04b4cffb4d9c","name":"Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc. See error message for details.","originalRequest":{"url":{"path":["brickworks","v1","schemas",":SchemaIdentifier","records",":RecordIdentifier"],"host":["{{baseUrl}}"],"query":[{"key":"fields","value":"string"},{"key":"fields","value":"string"},{"key":"statuses","value":"DRAFT"}],"variable":[{"disabled":false,"type":"any","value":"44e5411f-17ee-ab70-9112-0c776aafa909","key":"SchemaIdentifier","description":"(Required) Schema identifier - can be a UUID (SchemaId) or a human-readable string (Schema AppId/API name, 3-25 characters)"},{"disabled":false,"type":"any","value":"10cc476e-4cea-1124-9ba2-805e59214048","key":"RecordIdentifier","description":"(Required) Record identifier - can be a UUID (RecordId) or a human-readable slug (RecordSlug, 6-40 characters)"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\",\n \"status\": 647,\n \"timestamp\": \"string\",\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"3705584b-eaee-4de4-9082-f6f8529c4b11","name":"Forbidden; insufficient permissions. See error message for details.","originalRequest":{"url":{"path":["brickworks","v1","schemas",":SchemaIdentifier","records",":RecordIdentifier"],"host":["{{baseUrl}}"],"query":[{"key":"fields","value":"string"},{"key":"fields","value":"string"},{"key":"statuses","value":"DRAFT"}],"variable":[{"disabled":false,"type":"any","value":"44e5411f-17ee-ab70-9112-0c776aafa909","key":"SchemaIdentifier","description":"(Required) Schema identifier - can be a UUID (SchemaId) or a human-readable string (Schema AppId/API name, 3-25 characters)"},{"disabled":false,"type":"any","value":"10cc476e-4cea-1124-9ba2-805e59214048","key":"RecordIdentifier","description":"(Required) Record identifier - can be a UUID (RecordId) or a human-readable slug (RecordSlug, 6-40 characters)"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\",\n \"status\": 647,\n \"timestamp\": \"string\",\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"6c7fdff2-a6dd-43e6-869e-518aaec371af","name":"Resource not found. See error message for details.","originalRequest":{"url":{"path":["brickworks","v1","schemas",":SchemaIdentifier","records",":RecordIdentifier"],"host":["{{baseUrl}}"],"query":[{"key":"fields","value":"string"},{"key":"fields","value":"string"},{"key":"statuses","value":"DRAFT"}],"variable":[{"disabled":false,"type":"any","value":"44e5411f-17ee-ab70-9112-0c776aafa909","key":"SchemaIdentifier","description":"(Required) Schema identifier - can be a UUID (SchemaId) or a human-readable string (Schema AppId/API name, 3-25 characters)"},{"disabled":false,"type":"any","value":"10cc476e-4cea-1124-9ba2-805e59214048","key":"RecordIdentifier","description":"(Required) Record identifier - can be a UUID (RecordId) or a human-readable slug (RecordSlug, 6-40 characters)"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"httpStatus\": 8176,\n \"errorCode\": \"string\",\n \"timestamp\": \"2009-08-02T10:31:15.071Z\",\n \"message\": \"string\",\n \"traceId\": \"string\",\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"source\": {\n \"pointer\": \"string\",\n \"value\": \"string\"\n },\n \"details\": {\n \"key_0\": {}\n },\n \"field\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"96fd1208-65fd-4c5e-afd7-d87f33d71d23","name":"The request could not be completed due to a conflict with the current state of the resource. See error message for details.","originalRequest":{"url":{"path":["brickworks","v1","schemas",":SchemaIdentifier","records",":RecordIdentifier"],"host":["{{baseUrl}}"],"query":[{"key":"fields","value":"string"},{"key":"fields","value":"string"},{"key":"statuses","value":"DRAFT"}],"variable":[{"disabled":false,"type":"any","value":"44e5411f-17ee-ab70-9112-0c776aafa909","key":"SchemaIdentifier","description":"(Required) Schema identifier - can be a UUID (SchemaId) or a human-readable string (Schema AppId/API name, 3-25 characters)"},{"disabled":false,"type":"any","value":"10cc476e-4cea-1124-9ba2-805e59214048","key":"RecordIdentifier","description":"(Required) Record identifier - can be a UUID (RecordId) or a human-readable slug (RecordSlug, 6-40 characters)"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Conflict","code":409,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"httpStatus\": 8176,\n \"errorCode\": \"string\",\n \"timestamp\": \"2009-08-02T10:31:15.071Z\",\n \"message\": \"string\",\n \"traceId\": \"string\",\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"source\": {\n \"pointer\": \"string\",\n \"value\": \"string\"\n },\n \"details\": {\n \"key_0\": {}\n },\n \"field\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"0727268b-98f6-4066-aa67-5694a438c100","name":"The request was well-formed but could not be processed due to semantic or domain-related constraints. See error message for details.","originalRequest":{"url":{"path":["brickworks","v1","schemas",":SchemaIdentifier","records",":RecordIdentifier"],"host":["{{baseUrl}}"],"query":[{"key":"fields","value":"string"},{"key":"fields","value":"string"},{"key":"statuses","value":"DRAFT"}],"variable":[{"disabled":false,"type":"any","value":"44e5411f-17ee-ab70-9112-0c776aafa909","key":"SchemaIdentifier","description":"(Required) Schema identifier - can be a UUID (SchemaId) or a human-readable string (Schema AppId/API name, 3-25 characters)"},{"disabled":false,"type":"any","value":"10cc476e-4cea-1124-9ba2-805e59214048","key":"RecordIdentifier","description":"(Required) Record identifier - can be a UUID (RecordId) or a human-readable slug (RecordSlug, 6-40 characters)"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"httpStatus\": 8176,\n \"errorCode\": \"string\",\n \"timestamp\": \"2009-08-02T10:31:15.071Z\",\n \"message\": \"string\",\n \"traceId\": \"string\",\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"source\": {\n \"pointer\": \"string\",\n \"value\": \"string\"\n },\n \"details\": {\n \"key_0\": {}\n },\n \"field\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"d4e33b98-6a0a-4082-bdda-6924cc6cc312","name":"See error message for details.","originalRequest":{"url":{"path":["brickworks","v1","schemas",":SchemaIdentifier","records",":RecordIdentifier"],"host":["{{baseUrl}}"],"query":[{"key":"fields","value":"string"},{"key":"fields","value":"string"},{"key":"statuses","value":"DRAFT"}],"variable":[{"disabled":false,"type":"any","value":"44e5411f-17ee-ab70-9112-0c776aafa909","key":"SchemaIdentifier","description":"(Required) Schema identifier - can be a UUID (SchemaId) or a human-readable string (Schema AppId/API name, 3-25 characters)"},{"disabled":false,"type":"any","value":"10cc476e-4cea-1124-9ba2-805e59214048","key":"RecordIdentifier","description":"(Required) Record identifier - can be a UUID (RecordId) or a human-readable slug (RecordSlug, 6-40 characters)"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"httpStatus\": 8176,\n \"errorCode\": \"string\",\n \"timestamp\": \"2009-08-02T10:31:15.071Z\",\n \"message\": \"string\",\n \"traceId\": \"string\",\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"source\": {\n \"pointer\": \"string\",\n \"value\": \"string\"\n },\n \"details\": {\n \"key_0\": {}\n },\n \"field\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"528461f7-2d0c-47e6-96c9-c5c65593465b","name":"Update record","request":{"name":"Update record","description":{"content":"Update a record.\n\nIn a versioned schema, you can't directly edit a published record. To make changes, update the status to DRAFT (you can include the other changes that you want to make). This creates a new version of the record (without modifying the currently published version), which you can edit and publish.\n\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `BRICKWORKS_RECORDS_UPDATE`\n\n**User role permission required:** `assets_brickworks: update`\n","type":"text/plain"},"url":{"path":["brickworks","v1","schemas",":SchemaIdentifier","records",":RecordIdentifier"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"44e5411f-17ee-ab70-9112-0c776aafa909","key":"SchemaIdentifier","description":"(Required) Schema identifier - can be a UUID (SchemaId) or a human-readable string (Schema AppId/API name, 3-25 characters)"},{"disabled":false,"type":"any","value":"10cc476e-4cea-1124-9ba2-805e59214048","key":"RecordIdentifier","description":"(Required) Record identifier - can be a UUID (RecordId) or a human-readable slug (RecordSlug, 6-40 characters)"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PUT","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"status\": \"SCHEDULED\",\n \"values\": {\n \"stringField\": \"example string\",\n \"numberField\": 123.45,\n \"integerField\": 42,\n \"booleanField\": true,\n \"dateField\": \"2024-01-15\",\n \"dateTimeField\": \"2024-01-15T10:30:00Z\",\n \"uuidField\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"arrayField\": [\n \"item1\",\n \"item2\"\n ],\n \"objectField\": {\n \"key\": \"value\"\n },\n \"profileAttribute\": {\n \"attributeName\": \"email\"\n },\n \"catalog\": {\n \"itemKey\": \"SKU123\"\n },\n \"recommendation\": {\n \"params\": {\n \"itemId\": \"item-123\"\n }\n }\n },\n \"actionOnSchedule\": \"PUBLISH\",\n \"schedule\": {\n \"timezone\": {\n \"value\": \"\"\n },\n \"startType\": {\n \"value\": \"\"\n },\n \"startDate\": {\n \"value\": \"\"\n },\n \"endType\": {\n \"value\": \"\"\n },\n \"enabled\": {\n \"value\": \"\"\n },\n \"endDate\": {\n \"value\": \"\"\n },\n \"periodType\": {\n \"value\": \"\"\n },\n \"parts\": {\n \"value\": \"\"\n }\n },\n \"slug\": \"_XJaoEO6\",\n \"lastUpdatedAt\": \"2021-08-07T02:07:28.053Z\",\n \"name\": \"stri\",\n \"fromState\": \"PUBLISHED\",\n \"personalizationId\": \"d8577b16-9220-9608-8dd8-34ed7c0e3ef7\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"10e4d676-9cf4-4cd1-884f-6f168f4238eb","name":"Details of the updated record","originalRequest":{"url":{"path":["brickworks","v1","schemas",":SchemaIdentifier","records",":RecordIdentifier"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"44e5411f-17ee-ab70-9112-0c776aafa909","key":"SchemaIdentifier","description":"(Required) Schema identifier - can be a UUID (SchemaId) or a human-readable string (Schema AppId/API name, 3-25 characters)"},{"disabled":false,"type":"any","value":"10cc476e-4cea-1124-9ba2-805e59214048","key":"RecordIdentifier","description":"(Required) Record identifier - can be a UUID (RecordId) or a human-readable slug (RecordSlug, 6-40 characters)"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"{\n \"status\": \"SCHEDULED\",\n \"values\": {\n \"stringField\": \"example string\",\n \"numberField\": 123.45,\n \"integerField\": 42,\n \"booleanField\": true,\n \"dateField\": \"2024-01-15\",\n \"dateTimeField\": \"2024-01-15T10:30:00Z\",\n \"uuidField\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"arrayField\": [\n \"item1\",\n \"item2\"\n ],\n \"objectField\": {\n \"key\": \"value\"\n },\n \"profileAttribute\": {\n \"attributeName\": \"email\"\n },\n \"catalog\": {\n \"itemKey\": \"SKU123\"\n },\n \"recommendation\": {\n \"params\": {\n \"itemId\": \"item-123\"\n }\n }\n },\n \"actionOnSchedule\": \"PUBLISH\",\n \"schedule\": {\n \"timezone\": {\n \"value\": \"\"\n },\n \"startType\": {\n \"value\": \"\"\n },\n \"startDate\": {\n \"value\": \"\"\n },\n \"endType\": {\n \"value\": \"\"\n },\n \"enabled\": {\n \"value\": \"\"\n },\n \"endDate\": {\n \"value\": \"\"\n },\n \"periodType\": {\n \"value\": \"\"\n },\n \"parts\": {\n \"value\": \"\"\n }\n },\n \"slug\": \"_XJaoEO6\",\n \"lastUpdatedAt\": \"2021-08-07T02:07:28.053Z\",\n \"name\": \"stri\",\n \"fromState\": \"PUBLISHED\",\n \"personalizationId\": \"d8577b16-9220-9608-8dd8-34ed7c0e3ef7\"\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"schemaId\": {\n \"value\": \"\"\n },\n \"values\": {\n \"value\": \"\"\n },\n \"createdBy\": {\n \"value\": \"\"\n },\n \"updatedBy\": {\n \"value\": \"\"\n },\n \"createdAt\": {\n \"value\": \"\"\n },\n \"updatedAt\": {\n \"value\": \"\"\n },\n \"status\": {\n \"value\": \"\"\n },\n \"recordVersion\": {\n \"value\": \"\"\n },\n \"publishedBy\": {\n \"value\": \"\"\n },\n \"deletedBy\": {\n \"value\": \"\"\n },\n \"publishedAt\": {\n \"value\": \"\"\n },\n \"deletedAt\": {\n \"value\": \"\"\n },\n \"slug\": {\n \"value\": \"\"\n },\n \"schemaVersion\": 7838,\n \"schedule\": {\n \"value\": \"\"\n },\n \"personalizationId\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"16bf6665-a131-4c15-aca2-2d4fc73b5b48","name":"Incorrect request (malformed JSON, wrong parameters, etc.). See error message for details.","originalRequest":{"url":{"path":["brickworks","v1","schemas",":SchemaIdentifier","records",":RecordIdentifier"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"44e5411f-17ee-ab70-9112-0c776aafa909","key":"SchemaIdentifier","description":"(Required) Schema identifier - can be a UUID (SchemaId) or a human-readable string (Schema AppId/API name, 3-25 characters)"},{"disabled":false,"type":"any","value":"10cc476e-4cea-1124-9ba2-805e59214048","key":"RecordIdentifier","description":"(Required) Record identifier - can be a UUID (RecordId) or a human-readable slug (RecordSlug, 6-40 characters)"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"{\n \"status\": \"SCHEDULED\",\n \"values\": {\n \"stringField\": \"example string\",\n \"numberField\": 123.45,\n \"integerField\": 42,\n \"booleanField\": true,\n \"dateField\": \"2024-01-15\",\n \"dateTimeField\": \"2024-01-15T10:30:00Z\",\n \"uuidField\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"arrayField\": [\n \"item1\",\n \"item2\"\n ],\n \"objectField\": {\n \"key\": \"value\"\n },\n \"profileAttribute\": {\n \"attributeName\": \"email\"\n },\n \"catalog\": {\n \"itemKey\": \"SKU123\"\n },\n \"recommendation\": {\n \"params\": {\n \"itemId\": \"item-123\"\n }\n }\n },\n \"actionOnSchedule\": \"PUBLISH\",\n \"schedule\": {\n \"timezone\": {\n \"value\": \"\"\n },\n \"startType\": {\n \"value\": \"\"\n },\n \"startDate\": {\n \"value\": \"\"\n },\n \"endType\": {\n \"value\": \"\"\n },\n \"enabled\": {\n \"value\": \"\"\n },\n \"endDate\": {\n \"value\": \"\"\n },\n \"periodType\": {\n \"value\": \"\"\n },\n \"parts\": {\n \"value\": \"\"\n }\n },\n \"slug\": \"_XJaoEO6\",\n \"lastUpdatedAt\": \"2021-08-07T02:07:28.053Z\",\n \"name\": \"stri\",\n \"fromState\": \"PUBLISHED\",\n \"personalizationId\": \"d8577b16-9220-9608-8dd8-34ed7c0e3ef7\"\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"httpStatus\": 8176,\n \"errorCode\": \"string\",\n \"timestamp\": \"2009-08-02T10:31:15.071Z\",\n \"message\": \"string\",\n \"traceId\": \"string\",\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"source\": {\n \"pointer\": \"string\",\n \"value\": \"string\"\n },\n \"details\": {\n \"key_0\": {}\n },\n \"field\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"86e77bed-29f3-42e8-aa15-b0918e2b1113","name":"Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc. See error message for details.","originalRequest":{"url":{"path":["brickworks","v1","schemas",":SchemaIdentifier","records",":RecordIdentifier"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"44e5411f-17ee-ab70-9112-0c776aafa909","key":"SchemaIdentifier","description":"(Required) Schema identifier - can be a UUID (SchemaId) or a human-readable string (Schema AppId/API name, 3-25 characters)"},{"disabled":false,"type":"any","value":"10cc476e-4cea-1124-9ba2-805e59214048","key":"RecordIdentifier","description":"(Required) Record identifier - can be a UUID (RecordId) or a human-readable slug (RecordSlug, 6-40 characters)"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"{\n \"status\": \"SCHEDULED\",\n \"values\": {\n \"stringField\": \"example string\",\n \"numberField\": 123.45,\n \"integerField\": 42,\n \"booleanField\": true,\n \"dateField\": \"2024-01-15\",\n \"dateTimeField\": \"2024-01-15T10:30:00Z\",\n \"uuidField\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"arrayField\": [\n \"item1\",\n \"item2\"\n ],\n \"objectField\": {\n \"key\": \"value\"\n },\n \"profileAttribute\": {\n \"attributeName\": \"email\"\n },\n \"catalog\": {\n \"itemKey\": \"SKU123\"\n },\n \"recommendation\": {\n \"params\": {\n \"itemId\": \"item-123\"\n }\n }\n },\n \"actionOnSchedule\": \"PUBLISH\",\n \"schedule\": {\n \"timezone\": {\n \"value\": \"\"\n },\n \"startType\": {\n \"value\": \"\"\n },\n \"startDate\": {\n \"value\": \"\"\n },\n \"endType\": {\n \"value\": \"\"\n },\n \"enabled\": {\n \"value\": \"\"\n },\n \"endDate\": {\n \"value\": \"\"\n },\n \"periodType\": {\n \"value\": \"\"\n },\n \"parts\": {\n \"value\": \"\"\n }\n },\n \"slug\": \"_XJaoEO6\",\n \"lastUpdatedAt\": \"2021-08-07T02:07:28.053Z\",\n \"name\": \"stri\",\n \"fromState\": \"PUBLISHED\",\n \"personalizationId\": \"d8577b16-9220-9608-8dd8-34ed7c0e3ef7\"\n}","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\",\n \"status\": 647,\n \"timestamp\": \"string\",\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"f7f8d477-10e1-48dc-92f3-634d78bae3ac","name":"Forbidden; insufficient permissions. See error message for details.","originalRequest":{"url":{"path":["brickworks","v1","schemas",":SchemaIdentifier","records",":RecordIdentifier"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"44e5411f-17ee-ab70-9112-0c776aafa909","key":"SchemaIdentifier","description":"(Required) Schema identifier - can be a UUID (SchemaId) or a human-readable string (Schema AppId/API name, 3-25 characters)"},{"disabled":false,"type":"any","value":"10cc476e-4cea-1124-9ba2-805e59214048","key":"RecordIdentifier","description":"(Required) Record identifier - can be a UUID (RecordId) or a human-readable slug (RecordSlug, 6-40 characters)"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"{\n \"status\": \"SCHEDULED\",\n \"values\": {\n \"stringField\": \"example string\",\n \"numberField\": 123.45,\n \"integerField\": 42,\n \"booleanField\": true,\n \"dateField\": \"2024-01-15\",\n \"dateTimeField\": \"2024-01-15T10:30:00Z\",\n \"uuidField\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"arrayField\": [\n \"item1\",\n \"item2\"\n ],\n \"objectField\": {\n \"key\": \"value\"\n },\n \"profileAttribute\": {\n \"attributeName\": \"email\"\n },\n \"catalog\": {\n \"itemKey\": \"SKU123\"\n },\n \"recommendation\": {\n \"params\": {\n \"itemId\": \"item-123\"\n }\n }\n },\n \"actionOnSchedule\": \"PUBLISH\",\n \"schedule\": {\n \"timezone\": {\n \"value\": \"\"\n },\n \"startType\": {\n \"value\": \"\"\n },\n \"startDate\": {\n \"value\": \"\"\n },\n \"endType\": {\n \"value\": \"\"\n },\n \"enabled\": {\n \"value\": \"\"\n },\n \"endDate\": {\n \"value\": \"\"\n },\n \"periodType\": {\n \"value\": \"\"\n },\n \"parts\": {\n \"value\": \"\"\n }\n },\n \"slug\": \"_XJaoEO6\",\n \"lastUpdatedAt\": \"2021-08-07T02:07:28.053Z\",\n \"name\": \"stri\",\n \"fromState\": \"PUBLISHED\",\n \"personalizationId\": \"d8577b16-9220-9608-8dd8-34ed7c0e3ef7\"\n}","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\",\n \"status\": 647,\n \"timestamp\": \"string\",\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"c1a7aebd-988b-48e9-9239-1207ecbfd14c","name":"Resource not found. See error message for details.","originalRequest":{"url":{"path":["brickworks","v1","schemas",":SchemaIdentifier","records",":RecordIdentifier"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"44e5411f-17ee-ab70-9112-0c776aafa909","key":"SchemaIdentifier","description":"(Required) Schema identifier - can be a UUID (SchemaId) or a human-readable string (Schema AppId/API name, 3-25 characters)"},{"disabled":false,"type":"any","value":"10cc476e-4cea-1124-9ba2-805e59214048","key":"RecordIdentifier","description":"(Required) Record identifier - can be a UUID (RecordId) or a human-readable slug (RecordSlug, 6-40 characters)"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"{\n \"status\": \"SCHEDULED\",\n \"values\": {\n \"stringField\": \"example string\",\n \"numberField\": 123.45,\n \"integerField\": 42,\n \"booleanField\": true,\n \"dateField\": \"2024-01-15\",\n \"dateTimeField\": \"2024-01-15T10:30:00Z\",\n \"uuidField\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"arrayField\": [\n \"item1\",\n \"item2\"\n ],\n \"objectField\": {\n \"key\": \"value\"\n },\n \"profileAttribute\": {\n \"attributeName\": \"email\"\n },\n \"catalog\": {\n \"itemKey\": \"SKU123\"\n },\n \"recommendation\": {\n \"params\": {\n \"itemId\": \"item-123\"\n }\n }\n },\n \"actionOnSchedule\": \"PUBLISH\",\n \"schedule\": {\n \"timezone\": {\n \"value\": \"\"\n },\n \"startType\": {\n \"value\": \"\"\n },\n \"startDate\": {\n \"value\": \"\"\n },\n \"endType\": {\n \"value\": \"\"\n },\n \"enabled\": {\n \"value\": \"\"\n },\n \"endDate\": {\n \"value\": \"\"\n },\n \"periodType\": {\n \"value\": \"\"\n },\n \"parts\": {\n \"value\": \"\"\n }\n },\n \"slug\": \"_XJaoEO6\",\n \"lastUpdatedAt\": \"2021-08-07T02:07:28.053Z\",\n \"name\": \"stri\",\n \"fromState\": \"PUBLISHED\",\n \"personalizationId\": \"d8577b16-9220-9608-8dd8-34ed7c0e3ef7\"\n}","options":{"raw":{"language":"json"}}}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"httpStatus\": 8176,\n \"errorCode\": \"string\",\n \"timestamp\": \"2009-08-02T10:31:15.071Z\",\n \"message\": \"string\",\n \"traceId\": \"string\",\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"source\": {\n \"pointer\": \"string\",\n \"value\": \"string\"\n },\n \"details\": {\n \"key_0\": {}\n },\n \"field\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"b0cc6b4f-b4f4-4ad1-8152-4fe307d63966","name":"The request could not be completed due to a conflict with the current state of the resource. See error message for details.","originalRequest":{"url":{"path":["brickworks","v1","schemas",":SchemaIdentifier","records",":RecordIdentifier"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"44e5411f-17ee-ab70-9112-0c776aafa909","key":"SchemaIdentifier","description":"(Required) Schema identifier - can be a UUID (SchemaId) or a human-readable string (Schema AppId/API name, 3-25 characters)"},{"disabled":false,"type":"any","value":"10cc476e-4cea-1124-9ba2-805e59214048","key":"RecordIdentifier","description":"(Required) Record identifier - can be a UUID (RecordId) or a human-readable slug (RecordSlug, 6-40 characters)"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"{\n \"status\": \"SCHEDULED\",\n \"values\": {\n \"stringField\": \"example string\",\n \"numberField\": 123.45,\n \"integerField\": 42,\n \"booleanField\": true,\n \"dateField\": \"2024-01-15\",\n \"dateTimeField\": \"2024-01-15T10:30:00Z\",\n \"uuidField\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"arrayField\": [\n \"item1\",\n \"item2\"\n ],\n \"objectField\": {\n \"key\": \"value\"\n },\n \"profileAttribute\": {\n \"attributeName\": \"email\"\n },\n \"catalog\": {\n \"itemKey\": \"SKU123\"\n },\n \"recommendation\": {\n \"params\": {\n \"itemId\": \"item-123\"\n }\n }\n },\n \"actionOnSchedule\": \"PUBLISH\",\n \"schedule\": {\n \"timezone\": {\n \"value\": \"\"\n },\n \"startType\": {\n \"value\": \"\"\n },\n \"startDate\": {\n \"value\": \"\"\n },\n \"endType\": {\n \"value\": \"\"\n },\n \"enabled\": {\n \"value\": \"\"\n },\n \"endDate\": {\n \"value\": \"\"\n },\n \"periodType\": {\n \"value\": \"\"\n },\n \"parts\": {\n \"value\": \"\"\n }\n },\n \"slug\": \"_XJaoEO6\",\n \"lastUpdatedAt\": \"2021-08-07T02:07:28.053Z\",\n \"name\": \"stri\",\n \"fromState\": \"PUBLISHED\",\n \"personalizationId\": \"d8577b16-9220-9608-8dd8-34ed7c0e3ef7\"\n}","options":{"raw":{"language":"json"}}}},"status":"Conflict","code":409,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"httpStatus\": 8176,\n \"errorCode\": \"string\",\n \"timestamp\": \"2009-08-02T10:31:15.071Z\",\n \"message\": \"string\",\n \"traceId\": \"string\",\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"source\": {\n \"pointer\": \"string\",\n \"value\": \"string\"\n },\n \"details\": {\n \"key_0\": {}\n },\n \"field\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"3845b004-8c02-4cc9-a02e-ad3d2e197081","name":"The request was well-formed but could not be processed due to semantic or domain-related constraints. See error message for details.","originalRequest":{"url":{"path":["brickworks","v1","schemas",":SchemaIdentifier","records",":RecordIdentifier"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"44e5411f-17ee-ab70-9112-0c776aafa909","key":"SchemaIdentifier","description":"(Required) Schema identifier - can be a UUID (SchemaId) or a human-readable string (Schema AppId/API name, 3-25 characters)"},{"disabled":false,"type":"any","value":"10cc476e-4cea-1124-9ba2-805e59214048","key":"RecordIdentifier","description":"(Required) Record identifier - can be a UUID (RecordId) or a human-readable slug (RecordSlug, 6-40 characters)"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"{\n \"status\": \"SCHEDULED\",\n \"values\": {\n \"stringField\": \"example string\",\n \"numberField\": 123.45,\n \"integerField\": 42,\n \"booleanField\": true,\n \"dateField\": \"2024-01-15\",\n \"dateTimeField\": \"2024-01-15T10:30:00Z\",\n \"uuidField\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"arrayField\": [\n \"item1\",\n \"item2\"\n ],\n \"objectField\": {\n \"key\": \"value\"\n },\n \"profileAttribute\": {\n \"attributeName\": \"email\"\n },\n \"catalog\": {\n \"itemKey\": \"SKU123\"\n },\n \"recommendation\": {\n \"params\": {\n \"itemId\": \"item-123\"\n }\n }\n },\n \"actionOnSchedule\": \"PUBLISH\",\n \"schedule\": {\n \"timezone\": {\n \"value\": \"\"\n },\n \"startType\": {\n \"value\": \"\"\n },\n \"startDate\": {\n \"value\": \"\"\n },\n \"endType\": {\n \"value\": \"\"\n },\n \"enabled\": {\n \"value\": \"\"\n },\n \"endDate\": {\n \"value\": \"\"\n },\n \"periodType\": {\n \"value\": \"\"\n },\n \"parts\": {\n \"value\": \"\"\n }\n },\n \"slug\": \"_XJaoEO6\",\n \"lastUpdatedAt\": \"2021-08-07T02:07:28.053Z\",\n \"name\": \"stri\",\n \"fromState\": \"PUBLISHED\",\n \"personalizationId\": \"d8577b16-9220-9608-8dd8-34ed7c0e3ef7\"\n}","options":{"raw":{"language":"json"}}}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"httpStatus\": 8176,\n \"errorCode\": \"string\",\n \"timestamp\": \"2009-08-02T10:31:15.071Z\",\n \"message\": \"string\",\n \"traceId\": \"string\",\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"source\": {\n \"pointer\": \"string\",\n \"value\": \"string\"\n },\n \"details\": {\n \"key_0\": {}\n },\n \"field\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"ee00bba1-7bd3-4af5-9106-05cdcbdfadb3","name":"See error message for details.","originalRequest":{"url":{"path":["brickworks","v1","schemas",":SchemaIdentifier","records",":RecordIdentifier"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"44e5411f-17ee-ab70-9112-0c776aafa909","key":"SchemaIdentifier","description":"(Required) Schema identifier - can be a UUID (SchemaId) or a human-readable string (Schema AppId/API name, 3-25 characters)"},{"disabled":false,"type":"any","value":"10cc476e-4cea-1124-9ba2-805e59214048","key":"RecordIdentifier","description":"(Required) Record identifier - can be a UUID (RecordId) or a human-readable slug (RecordSlug, 6-40 characters)"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"{\n \"status\": \"SCHEDULED\",\n \"values\": {\n \"stringField\": \"example string\",\n \"numberField\": 123.45,\n \"integerField\": 42,\n \"booleanField\": true,\n \"dateField\": \"2024-01-15\",\n \"dateTimeField\": \"2024-01-15T10:30:00Z\",\n \"uuidField\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"arrayField\": [\n \"item1\",\n \"item2\"\n ],\n \"objectField\": {\n \"key\": \"value\"\n },\n \"profileAttribute\": {\n \"attributeName\": \"email\"\n },\n \"catalog\": {\n \"itemKey\": \"SKU123\"\n },\n \"recommendation\": {\n \"params\": {\n \"itemId\": \"item-123\"\n }\n }\n },\n \"actionOnSchedule\": \"PUBLISH\",\n \"schedule\": {\n \"timezone\": {\n \"value\": \"\"\n },\n \"startType\": {\n \"value\": \"\"\n },\n \"startDate\": {\n \"value\": \"\"\n },\n \"endType\": {\n \"value\": \"\"\n },\n \"enabled\": {\n \"value\": \"\"\n },\n \"endDate\": {\n \"value\": \"\"\n },\n \"periodType\": {\n \"value\": \"\"\n },\n \"parts\": {\n \"value\": \"\"\n }\n },\n \"slug\": \"_XJaoEO6\",\n \"lastUpdatedAt\": \"2021-08-07T02:07:28.053Z\",\n \"name\": \"stri\",\n \"fromState\": \"PUBLISHED\",\n \"personalizationId\": \"d8577b16-9220-9608-8dd8-34ed7c0e3ef7\"\n}","options":{"raw":{"language":"json"}}}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"httpStatus\": 8176,\n \"errorCode\": \"string\",\n \"timestamp\": \"2009-08-02T10:31:15.071Z\",\n \"message\": \"string\",\n \"traceId\": \"string\",\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"source\": {\n \"pointer\": \"string\",\n \"value\": \"string\"\n },\n \"details\": {\n \"key_0\": {}\n },\n \"field\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"97ecc7cf-e656-4f8d-ab94-3398c5878a42","name":"Delete record","request":{"name":"Delete record","description":{"content":"Delete a record **permanently**. If you want to unpublish a record instead, send an update request to change the status to `UNPUBLISHED`\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `BRICKWORKS_RECORDS_DELETE`\n\n**User role permission required:** `assets_brickworks: delete`\n","type":"text/plain"},"url":{"path":["brickworks","v1","schemas",":SchemaIdentifier","records",":RecordIdentifier"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"44e5411f-17ee-ab70-9112-0c776aafa909","key":"SchemaIdentifier","description":"(Required) Schema identifier - can be a UUID (SchemaId) or a human-readable string (Schema AppId/API name, 3-25 characters)"},{"disabled":false,"type":"any","value":"10cc476e-4cea-1124-9ba2-805e59214048","key":"RecordIdentifier","description":"(Required) Record identifier - can be a UUID (RecordId) or a human-readable slug (RecordSlug, 6-40 characters)"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"89220fb6-532d-4d17-ba93-1d0c2266d45d","name":"Record deleted","originalRequest":{"url":{"path":["brickworks","v1","schemas",":SchemaIdentifier","records",":RecordIdentifier"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"44e5411f-17ee-ab70-9112-0c776aafa909","key":"SchemaIdentifier","description":"(Required) Schema identifier - can be a UUID (SchemaId) or a human-readable string (Schema AppId/API name, 3-25 characters)"},{"disabled":false,"type":"any","value":"10cc476e-4cea-1124-9ba2-805e59214048","key":"RecordIdentifier","description":"(Required) Record identifier - can be a UUID (RecordId) or a human-readable slug (RecordSlug, 6-40 characters)"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"DELETE","body":{}},"status":"No Content","code":204,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"fac8e854-c8e4-4297-83e0-f5b9663546fb","name":"Incorrect request (malformed JSON, wrong parameters, etc.). See error message for details.","originalRequest":{"url":{"path":["brickworks","v1","schemas",":SchemaIdentifier","records",":RecordIdentifier"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"44e5411f-17ee-ab70-9112-0c776aafa909","key":"SchemaIdentifier","description":"(Required) Schema identifier - can be a UUID (SchemaId) or a human-readable string (Schema AppId/API name, 3-25 characters)"},{"disabled":false,"type":"any","value":"10cc476e-4cea-1124-9ba2-805e59214048","key":"RecordIdentifier","description":"(Required) Record identifier - can be a UUID (RecordId) or a human-readable slug (RecordSlug, 6-40 characters)"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"httpStatus\": 8176,\n \"errorCode\": \"string\",\n \"timestamp\": \"2009-08-02T10:31:15.071Z\",\n \"message\": \"string\",\n \"traceId\": \"string\",\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"source\": {\n \"pointer\": \"string\",\n \"value\": \"string\"\n },\n \"details\": {\n \"key_0\": {}\n },\n \"field\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"2f92244e-01f1-4f9c-b9ad-eb0513ebc635","name":"Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc. See error message for details.","originalRequest":{"url":{"path":["brickworks","v1","schemas",":SchemaIdentifier","records",":RecordIdentifier"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"44e5411f-17ee-ab70-9112-0c776aafa909","key":"SchemaIdentifier","description":"(Required) Schema identifier - can be a UUID (SchemaId) or a human-readable string (Schema AppId/API name, 3-25 characters)"},{"disabled":false,"type":"any","value":"10cc476e-4cea-1124-9ba2-805e59214048","key":"RecordIdentifier","description":"(Required) Record identifier - can be a UUID (RecordId) or a human-readable slug (RecordSlug, 6-40 characters)"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\",\n \"status\": 647,\n \"timestamp\": \"string\",\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"7f6de549-865c-4685-a0d9-0ca001cc7436","name":"Forbidden; insufficient permissions. See error message for details.","originalRequest":{"url":{"path":["brickworks","v1","schemas",":SchemaIdentifier","records",":RecordIdentifier"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"44e5411f-17ee-ab70-9112-0c776aafa909","key":"SchemaIdentifier","description":"(Required) Schema identifier - can be a UUID (SchemaId) or a human-readable string (Schema AppId/API name, 3-25 characters)"},{"disabled":false,"type":"any","value":"10cc476e-4cea-1124-9ba2-805e59214048","key":"RecordIdentifier","description":"(Required) Record identifier - can be a UUID (RecordId) or a human-readable slug (RecordSlug, 6-40 characters)"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\",\n \"status\": 647,\n \"timestamp\": \"string\",\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"2fa98e40-c381-4059-a6ed-c75ddaa9bc4d","name":"Resource not found. See error message for details.","originalRequest":{"url":{"path":["brickworks","v1","schemas",":SchemaIdentifier","records",":RecordIdentifier"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"44e5411f-17ee-ab70-9112-0c776aafa909","key":"SchemaIdentifier","description":"(Required) Schema identifier - can be a UUID (SchemaId) or a human-readable string (Schema AppId/API name, 3-25 characters)"},{"disabled":false,"type":"any","value":"10cc476e-4cea-1124-9ba2-805e59214048","key":"RecordIdentifier","description":"(Required) Record identifier - can be a UUID (RecordId) or a human-readable slug (RecordSlug, 6-40 characters)"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"httpStatus\": 8176,\n \"errorCode\": \"string\",\n \"timestamp\": \"2009-08-02T10:31:15.071Z\",\n \"message\": \"string\",\n \"traceId\": \"string\",\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"source\": {\n \"pointer\": \"string\",\n \"value\": \"string\"\n },\n \"details\": {\n \"key_0\": {}\n },\n \"field\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"1760774e-405b-4b32-9c07-4fe6b22ca70f","name":"The request could not be completed due to a conflict with the current state of the resource. See error message for details.","originalRequest":{"url":{"path":["brickworks","v1","schemas",":SchemaIdentifier","records",":RecordIdentifier"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"44e5411f-17ee-ab70-9112-0c776aafa909","key":"SchemaIdentifier","description":"(Required) Schema identifier - can be a UUID (SchemaId) or a human-readable string (Schema AppId/API name, 3-25 characters)"},{"disabled":false,"type":"any","value":"10cc476e-4cea-1124-9ba2-805e59214048","key":"RecordIdentifier","description":"(Required) Record identifier - can be a UUID (RecordId) or a human-readable slug (RecordSlug, 6-40 characters)"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{}},"status":"Conflict","code":409,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"httpStatus\": 8176,\n \"errorCode\": \"string\",\n \"timestamp\": \"2009-08-02T10:31:15.071Z\",\n \"message\": \"string\",\n \"traceId\": \"string\",\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"source\": {\n \"pointer\": \"string\",\n \"value\": \"string\"\n },\n \"details\": {\n \"key_0\": {}\n },\n \"field\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"955e9009-3647-4f8b-95cc-7717485ea8fd","name":"The request was well-formed but could not be processed due to semantic or domain-related constraints. See error message for details.","originalRequest":{"url":{"path":["brickworks","v1","schemas",":SchemaIdentifier","records",":RecordIdentifier"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"44e5411f-17ee-ab70-9112-0c776aafa909","key":"SchemaIdentifier","description":"(Required) Schema identifier - can be a UUID (SchemaId) or a human-readable string (Schema AppId/API name, 3-25 characters)"},{"disabled":false,"type":"any","value":"10cc476e-4cea-1124-9ba2-805e59214048","key":"RecordIdentifier","description":"(Required) Record identifier - can be a UUID (RecordId) or a human-readable slug (RecordSlug, 6-40 characters)"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"httpStatus\": 8176,\n \"errorCode\": \"string\",\n \"timestamp\": \"2009-08-02T10:31:15.071Z\",\n \"message\": \"string\",\n \"traceId\": \"string\",\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"source\": {\n \"pointer\": \"string\",\n \"value\": \"string\"\n },\n \"details\": {\n \"key_0\": {}\n },\n \"field\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"f2d325bd-82cd-426f-a8a4-b1ddad5e0629","name":"See error message for details.","originalRequest":{"url":{"path":["brickworks","v1","schemas",":SchemaIdentifier","records",":RecordIdentifier"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"44e5411f-17ee-ab70-9112-0c776aafa909","key":"SchemaIdentifier","description":"(Required) Schema identifier - can be a UUID (SchemaId) or a human-readable string (Schema AppId/API name, 3-25 characters)"},{"disabled":false,"type":"any","value":"10cc476e-4cea-1124-9ba2-805e59214048","key":"RecordIdentifier","description":"(Required) Record identifier - can be a UUID (RecordId) or a human-readable slug (RecordSlug, 6-40 characters)"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"httpStatus\": 8176,\n \"errorCode\": \"string\",\n \"timestamp\": \"2009-08-02T10:31:15.071Z\",\n \"message\": \"string\",\n \"traceId\": \"string\",\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"source\": {\n \"pointer\": \"string\",\n \"value\": \"string\"\n },\n \"details\": {\n \"key_0\": {}\n },\n \"field\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"a86d8dfb-dab1-405c-a8fb-f0caf441cbfa","name":"Preview object (as workspace)","request":{"name":"Preview object (as workspace)","description":{"content":"Preview an object by sending field values. \n\nWhen generating a preview, fields are only generated when you send their value or they have a default value. Values saved in the record are not used in the preview.\n\nSome data is cached:\n- profile data (even if the profile is updated)\n- responses from external sources \nFor details, see the [User Guide](https://hub.synerise.com/docs/assets/brickworks/limits).\n\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `BRICKWORKS_RECORDS_READ`\n\n**User role permission required:** `assets_brickworks: read`\n","type":"text/plain"},"url":{"path":["brickworks","v1","schemas","records","preview","by",":IdentifierType"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"uuid","key":"IdentifierType","description":"(Required) Profile identifier type"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"identifierValue\": \"string\",\n \"schema\": {\n \"schemaType\": {\n \"value\": \"\"\n },\n \"fields\": {\n \"value\": \"\"\n },\n \"audience\": {\n \"value\": \"\"\n },\n \"lambdaId\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n },\n \"personalizationId\": {\n \"value\": \"\"\n }\n },\n \"context\": {\n \"key_0\": {\n \"value\": \"\"\n }\n },\n \"fieldContext\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n }\n },\n \"values\": {\n \"key_0\": {\n \"value\": \"\"\n }\n }\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"e9b678f2-1c9a-47e6-886c-c5bd72c28fc4","name":"Generated JSON","originalRequest":{"url":{"path":["brickworks","v1","schemas","records","preview","by",":IdentifierType"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"uuid","key":"IdentifierType","description":"(Required) Profile identifier type"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"identifierValue\": \"string\",\n \"schema\": {\n \"schemaType\": {\n \"value\": \"\"\n },\n \"fields\": {\n \"value\": \"\"\n },\n \"audience\": {\n \"value\": \"\"\n },\n \"lambdaId\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n },\n \"personalizationId\": {\n \"value\": \"\"\n }\n },\n \"context\": {\n \"key_0\": {\n \"value\": \"\"\n }\n },\n \"fieldContext\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n }\n },\n \"values\": {\n \"key_0\": {\n \"value\": \"\"\n }\n }\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"__slug\": \"_FfZQsAFUiqE\",\n \"__recordVersion\": 6297.904677900221,\n \"__publishedAt\": \"2005-10-15T07:08:23.444Z\",\n \"__updatedAt\": \"2011-12-07T19:44:19.865Z\",\n \"__schemaId\": \"991a2dc7-901a-8b05-c4fd-b3bcfe802d95\",\n \"__id\": \"5b643d0b-4d41-1d3c-a780-3b01db5d0f08\",\n \"__schemaVersion\": 1105,\n \"__createdAt\": \"2010-04-28T10:27:21.207Z\",\n \"__matchedAudience\": false,\n \"__unmatchedAudienceRelations\": [\n \"string\",\n \"string\"\n ],\n \"__personalizationVariants\": [\n \"string\",\n \"string\"\n ],\n \"__personalizationSegments\": {\n \"key_0\": true,\n \"key_1\": true\n },\n \"__logs\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"91c2af97-a54c-4492-85a2-529a0287d755","name":"Incorrect request (malformed JSON, wrong parameters, etc.). See error message for details.","originalRequest":{"url":{"path":["brickworks","v1","schemas","records","preview","by",":IdentifierType"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"uuid","key":"IdentifierType","description":"(Required) Profile identifier type"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"identifierValue\": \"string\",\n \"schema\": {\n \"schemaType\": {\n \"value\": \"\"\n },\n \"fields\": {\n \"value\": \"\"\n },\n \"audience\": {\n \"value\": \"\"\n },\n \"lambdaId\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n },\n \"personalizationId\": {\n \"value\": \"\"\n }\n },\n \"context\": {\n \"key_0\": {\n \"value\": \"\"\n }\n },\n \"fieldContext\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n }\n },\n \"values\": {\n \"key_0\": {\n \"value\": \"\"\n }\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"httpStatus\": 8176,\n \"errorCode\": \"string\",\n \"timestamp\": \"2009-08-02T10:31:15.071Z\",\n \"message\": \"string\",\n \"traceId\": \"string\",\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"source\": {\n \"pointer\": \"string\",\n \"value\": \"string\"\n },\n \"details\": {\n \"key_0\": {}\n },\n \"field\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"dbd80116-493c-4b55-b832-a28a76315d9d","name":"Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc. See error message for details.","originalRequest":{"url":{"path":["brickworks","v1","schemas","records","preview","by",":IdentifierType"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"uuid","key":"IdentifierType","description":"(Required) Profile identifier type"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"identifierValue\": \"string\",\n \"schema\": {\n \"schemaType\": {\n \"value\": \"\"\n },\n \"fields\": {\n \"value\": \"\"\n },\n \"audience\": {\n \"value\": \"\"\n },\n \"lambdaId\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n },\n \"personalizationId\": {\n \"value\": \"\"\n }\n },\n \"context\": {\n \"key_0\": {\n \"value\": \"\"\n }\n },\n \"fieldContext\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n }\n },\n \"values\": {\n \"key_0\": {\n \"value\": \"\"\n }\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\",\n \"status\": 647,\n \"timestamp\": \"string\",\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"205a49eb-52c5-4e1b-8084-170d32f62378","name":"Forbidden; insufficient permissions. See error message for details.","originalRequest":{"url":{"path":["brickworks","v1","schemas","records","preview","by",":IdentifierType"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"uuid","key":"IdentifierType","description":"(Required) Profile identifier type"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"identifierValue\": \"string\",\n \"schema\": {\n \"schemaType\": {\n \"value\": \"\"\n },\n \"fields\": {\n \"value\": \"\"\n },\n \"audience\": {\n \"value\": \"\"\n },\n \"lambdaId\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n },\n \"personalizationId\": {\n \"value\": \"\"\n }\n },\n \"context\": {\n \"key_0\": {\n \"value\": \"\"\n }\n },\n \"fieldContext\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n }\n },\n \"values\": {\n \"key_0\": {\n \"value\": \"\"\n }\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\",\n \"status\": 647,\n \"timestamp\": \"string\",\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"3ca10472-ed3c-4be2-b7a7-4ac888d35e87","name":"Resource not found. See error message for details.","originalRequest":{"url":{"path":["brickworks","v1","schemas","records","preview","by",":IdentifierType"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"uuid","key":"IdentifierType","description":"(Required) Profile identifier type"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"identifierValue\": \"string\",\n \"schema\": {\n \"schemaType\": {\n \"value\": \"\"\n },\n \"fields\": {\n \"value\": \"\"\n },\n \"audience\": {\n \"value\": \"\"\n },\n \"lambdaId\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n },\n \"personalizationId\": {\n \"value\": \"\"\n }\n },\n \"context\": {\n \"key_0\": {\n \"value\": \"\"\n }\n },\n \"fieldContext\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n }\n },\n \"values\": {\n \"key_0\": {\n \"value\": \"\"\n }\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"httpStatus\": 8176,\n \"errorCode\": \"string\",\n \"timestamp\": \"2009-08-02T10:31:15.071Z\",\n \"message\": \"string\",\n \"traceId\": \"string\",\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"source\": {\n \"pointer\": \"string\",\n \"value\": \"string\"\n },\n \"details\": {\n \"key_0\": {}\n },\n \"field\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"b365c516-330d-4900-bf26-2b7a85bb6b44","name":"The request could not be completed due to a conflict with the current state of the resource. See error message for details.","originalRequest":{"url":{"path":["brickworks","v1","schemas","records","preview","by",":IdentifierType"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"uuid","key":"IdentifierType","description":"(Required) Profile identifier type"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"identifierValue\": \"string\",\n \"schema\": {\n \"schemaType\": {\n \"value\": \"\"\n },\n \"fields\": {\n \"value\": \"\"\n },\n \"audience\": {\n \"value\": \"\"\n },\n \"lambdaId\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n },\n \"personalizationId\": {\n \"value\": \"\"\n }\n },\n \"context\": {\n \"key_0\": {\n \"value\": \"\"\n }\n },\n \"fieldContext\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n }\n },\n \"values\": {\n \"key_0\": {\n \"value\": \"\"\n }\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Conflict","code":409,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"httpStatus\": 8176,\n \"errorCode\": \"string\",\n \"timestamp\": \"2009-08-02T10:31:15.071Z\",\n \"message\": \"string\",\n \"traceId\": \"string\",\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"source\": {\n \"pointer\": \"string\",\n \"value\": \"string\"\n },\n \"details\": {\n \"key_0\": {}\n },\n \"field\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"63ad7fe6-cd90-4f39-9b54-ab729002699d","name":"The request was well-formed but could not be processed due to semantic or domain-related constraints. See error message for details.","originalRequest":{"url":{"path":["brickworks","v1","schemas","records","preview","by",":IdentifierType"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"uuid","key":"IdentifierType","description":"(Required) Profile identifier type"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"identifierValue\": \"string\",\n \"schema\": {\n \"schemaType\": {\n \"value\": \"\"\n },\n \"fields\": {\n \"value\": \"\"\n },\n \"audience\": {\n \"value\": \"\"\n },\n \"lambdaId\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n },\n \"personalizationId\": {\n \"value\": \"\"\n }\n },\n \"context\": {\n \"key_0\": {\n \"value\": \"\"\n }\n },\n \"fieldContext\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n }\n },\n \"values\": {\n \"key_0\": {\n \"value\": \"\"\n }\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"httpStatus\": 8176,\n \"errorCode\": \"string\",\n \"timestamp\": \"2009-08-02T10:31:15.071Z\",\n \"message\": \"string\",\n \"traceId\": \"string\",\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"source\": {\n \"pointer\": \"string\",\n \"value\": \"string\"\n },\n \"details\": {\n \"key_0\": {}\n },\n \"field\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"f675a8b5-faef-45ab-b35f-e12dc8c6851b","name":"See error message for details.","originalRequest":{"url":{"path":["brickworks","v1","schemas","records","preview","by",":IdentifierType"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"uuid","key":"IdentifierType","description":"(Required) Profile identifier type"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"identifierValue\": \"string\",\n \"schema\": {\n \"schemaType\": {\n \"value\": \"\"\n },\n \"fields\": {\n \"value\": \"\"\n },\n \"audience\": {\n \"value\": \"\"\n },\n \"lambdaId\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n },\n \"personalizationId\": {\n \"value\": \"\"\n }\n },\n \"context\": {\n \"key_0\": {\n \"value\": \"\"\n }\n },\n \"fieldContext\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n }\n },\n \"values\": {\n \"key_0\": {\n \"value\": \"\"\n }\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"httpStatus\": 8176,\n \"errorCode\": \"string\",\n \"timestamp\": \"2009-08-02T10:31:15.071Z\",\n \"message\": \"string\",\n \"traceId\": \"string\",\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"source\": {\n \"pointer\": \"string\",\n \"value\": \"string\"\n },\n \"details\": {\n \"key_0\": {}\n },\n \"field\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"d9afeecb-40c2-4c76-9057-3e391dcd25a6","name":"Preview object (as any consumer)","request":{"name":"Preview object (as any consumer)","description":{"content":"Preview an object by sending field values. \n\nWhen generating a preview, fields are only generated when you send their value or they have a default value. Values saved in the record are not used in the preview.\n\nSome data is cached:\n- profile data (even if the profile is updated)\n- responses from external sources \nFor details, see the [User Guide](https://hub.synerise.com/docs/assets/brickworks/limits).\n\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile), Profile (Client), Anonymous Profile\n\n**API key permission required:** `BRICKWORKS_RECORDS_READ`\n\n**User role permission required:** `assets_brickworks: read`\n","type":"text/plain"},"url":{"path":["brickworks","v1","schemas","records","preview"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"schema\": {\n \"schemaType\": {\n \"value\": \"\"\n },\n \"fields\": {\n \"value\": \"\"\n },\n \"audience\": {\n \"value\": \"\"\n },\n \"lambdaId\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n },\n \"personalizationId\": {\n \"value\": \"\"\n }\n },\n \"context\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n }\n },\n \"fieldContext\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n },\n \"key_2\": {\n \"value\": \"\"\n }\n },\n \"values\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n }\n }\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"69cf9124-e298-4d87-ba3e-3ef16e8f0a04","name":"Generated JSON","originalRequest":{"url":{"path":["brickworks","v1","schemas","records","preview"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"schema\": {\n \"schemaType\": {\n \"value\": \"\"\n },\n \"fields\": {\n \"value\": \"\"\n },\n \"audience\": {\n \"value\": \"\"\n },\n \"lambdaId\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n },\n \"personalizationId\": {\n \"value\": \"\"\n }\n },\n \"context\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n }\n },\n \"fieldContext\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n },\n \"key_2\": {\n \"value\": \"\"\n }\n },\n \"values\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n }\n }\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"__slug\": \"_FfZQsAFUiqE\",\n \"__recordVersion\": 6297.904677900221,\n \"__publishedAt\": \"2005-10-15T07:08:23.444Z\",\n \"__updatedAt\": \"2011-12-07T19:44:19.865Z\",\n \"__schemaId\": \"991a2dc7-901a-8b05-c4fd-b3bcfe802d95\",\n \"__id\": \"5b643d0b-4d41-1d3c-a780-3b01db5d0f08\",\n \"__schemaVersion\": 1105,\n \"__createdAt\": \"2010-04-28T10:27:21.207Z\",\n \"__matchedAudience\": false,\n \"__unmatchedAudienceRelations\": [\n \"string\",\n \"string\"\n ],\n \"__personalizationVariants\": [\n \"string\",\n \"string\"\n ],\n \"__personalizationSegments\": {\n \"key_0\": true,\n \"key_1\": true\n },\n \"__logs\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"2ee36792-6402-44a1-b39c-4f85f46f95f1","name":"Incorrect request (malformed JSON, wrong parameters, etc.). See error message for details.","originalRequest":{"url":{"path":["brickworks","v1","schemas","records","preview"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"schema\": {\n \"schemaType\": {\n \"value\": \"\"\n },\n \"fields\": {\n \"value\": \"\"\n },\n \"audience\": {\n \"value\": \"\"\n },\n \"lambdaId\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n },\n \"personalizationId\": {\n \"value\": \"\"\n }\n },\n \"context\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n }\n },\n \"fieldContext\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n },\n \"key_2\": {\n \"value\": \"\"\n }\n },\n \"values\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n }\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"httpStatus\": 8176,\n \"errorCode\": \"string\",\n \"timestamp\": \"2009-08-02T10:31:15.071Z\",\n \"message\": \"string\",\n \"traceId\": \"string\",\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"source\": {\n \"pointer\": \"string\",\n \"value\": \"string\"\n },\n \"details\": {\n \"key_0\": {}\n },\n \"field\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"94e5605b-1efa-4f9b-b712-ae94837a24b7","name":"Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc. See error message for details.","originalRequest":{"url":{"path":["brickworks","v1","schemas","records","preview"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"schema\": {\n \"schemaType\": {\n \"value\": \"\"\n },\n \"fields\": {\n \"value\": \"\"\n },\n \"audience\": {\n \"value\": \"\"\n },\n \"lambdaId\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n },\n \"personalizationId\": {\n \"value\": \"\"\n }\n },\n \"context\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n }\n },\n \"fieldContext\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n },\n \"key_2\": {\n \"value\": \"\"\n }\n },\n \"values\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n }\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\",\n \"status\": 647,\n \"timestamp\": \"string\",\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"ad20eb17-41a3-4a16-94c7-bff6f8370c06","name":"Forbidden; insufficient permissions. See error message for details.","originalRequest":{"url":{"path":["brickworks","v1","schemas","records","preview"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"schema\": {\n \"schemaType\": {\n \"value\": \"\"\n },\n \"fields\": {\n \"value\": \"\"\n },\n \"audience\": {\n \"value\": \"\"\n },\n \"lambdaId\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n },\n \"personalizationId\": {\n \"value\": \"\"\n }\n },\n \"context\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n }\n },\n \"fieldContext\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n },\n \"key_2\": {\n \"value\": \"\"\n }\n },\n \"values\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n }\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\",\n \"status\": 647,\n \"timestamp\": \"string\",\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"e14d31d6-9345-477f-8394-474f47503a5b","name":"Resource not found. See error message for details.","originalRequest":{"url":{"path":["brickworks","v1","schemas","records","preview"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"schema\": {\n \"schemaType\": {\n \"value\": \"\"\n },\n \"fields\": {\n \"value\": \"\"\n },\n \"audience\": {\n \"value\": \"\"\n },\n \"lambdaId\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n },\n \"personalizationId\": {\n \"value\": \"\"\n }\n },\n \"context\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n }\n },\n \"fieldContext\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n },\n \"key_2\": {\n \"value\": \"\"\n }\n },\n \"values\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n }\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"httpStatus\": 8176,\n \"errorCode\": \"string\",\n \"timestamp\": \"2009-08-02T10:31:15.071Z\",\n \"message\": \"string\",\n \"traceId\": \"string\",\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"source\": {\n \"pointer\": \"string\",\n \"value\": \"string\"\n },\n \"details\": {\n \"key_0\": {}\n },\n \"field\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"6b229b34-1d4c-4544-beab-8ef78e44ba5f","name":"The request could not be completed due to a conflict with the current state of the resource. See error message for details.","originalRequest":{"url":{"path":["brickworks","v1","schemas","records","preview"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"schema\": {\n \"schemaType\": {\n \"value\": \"\"\n },\n \"fields\": {\n \"value\": \"\"\n },\n \"audience\": {\n \"value\": \"\"\n },\n \"lambdaId\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n },\n \"personalizationId\": {\n \"value\": \"\"\n }\n },\n \"context\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n }\n },\n \"fieldContext\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n },\n \"key_2\": {\n \"value\": \"\"\n }\n },\n \"values\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n }\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Conflict","code":409,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"httpStatus\": 8176,\n \"errorCode\": \"string\",\n \"timestamp\": \"2009-08-02T10:31:15.071Z\",\n \"message\": \"string\",\n \"traceId\": \"string\",\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"source\": {\n \"pointer\": \"string\",\n \"value\": \"string\"\n },\n \"details\": {\n \"key_0\": {}\n },\n \"field\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"12af6c1a-2add-4932-9e39-9b7f67556462","name":"The request was well-formed but could not be processed due to semantic or domain-related constraints. See error message for details.","originalRequest":{"url":{"path":["brickworks","v1","schemas","records","preview"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"schema\": {\n \"schemaType\": {\n \"value\": \"\"\n },\n \"fields\": {\n \"value\": \"\"\n },\n \"audience\": {\n \"value\": \"\"\n },\n \"lambdaId\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n },\n \"personalizationId\": {\n \"value\": \"\"\n }\n },\n \"context\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n }\n },\n \"fieldContext\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n },\n \"key_2\": {\n \"value\": \"\"\n }\n },\n \"values\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n }\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"httpStatus\": 8176,\n \"errorCode\": \"string\",\n \"timestamp\": \"2009-08-02T10:31:15.071Z\",\n \"message\": \"string\",\n \"traceId\": \"string\",\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"source\": {\n \"pointer\": \"string\",\n \"value\": \"string\"\n },\n \"details\": {\n \"key_0\": {}\n },\n \"field\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"b69adda1-d7c6-44b5-998c-4daf3ec05bfa","name":"See error message for details.","originalRequest":{"url":{"path":["brickworks","v1","schemas","records","preview"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"schema\": {\n \"schemaType\": {\n \"value\": \"\"\n },\n \"fields\": {\n \"value\": \"\"\n },\n \"audience\": {\n \"value\": \"\"\n },\n \"lambdaId\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n },\n \"personalizationId\": {\n \"value\": \"\"\n }\n },\n \"context\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n }\n },\n \"fieldContext\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n },\n \"key_2\": {\n \"value\": \"\"\n }\n },\n \"values\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n }\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"httpStatus\": 8176,\n \"errorCode\": \"string\",\n \"timestamp\": \"2009-08-02T10:31:15.071Z\",\n \"message\": \"string\",\n \"traceId\": \"string\",\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"source\": {\n \"pointer\": \"string\",\n \"value\": \"string\"\n },\n \"details\": {\n \"key_0\": {}\n },\n \"field\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"d431641d-e9dc-4276-92a3-0dc119fff688","name":"Duplicate record","request":{"name":"Duplicate record","description":{"content":"Create a copy of a record. The name of the copy is `{recordName} - copy`\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `BRICKWORKS_RECORDS_CREATE`\n\n**User role permission required:** `assets_brickworks: create`\n","type":"text/plain"},"url":{"path":["brickworks","v1","schemas",":SchemaIdentifier","records",":RecordIdentifier","duplicate"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"44e5411f-17ee-ab70-9112-0c776aafa909","key":"SchemaIdentifier","description":"(Required) Schema identifier - can be a UUID (SchemaId) or a human-readable string (Schema AppId/API name, 3-25 characters)"},{"disabled":false,"type":"any","value":"10cc476e-4cea-1124-9ba2-805e59214048","key":"RecordIdentifier","description":"(Required) Record identifier - can be a UUID (RecordId) or a human-readable slug (RecordSlug, 6-40 characters)"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"3a3d55b1-51df-4db1-8ba3-5070ef546201","name":"Data of the created record","originalRequest":{"url":{"path":["brickworks","v1","schemas",":SchemaIdentifier","records",":RecordIdentifier","duplicate"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"44e5411f-17ee-ab70-9112-0c776aafa909","key":"SchemaIdentifier","description":"(Required) Schema identifier - can be a UUID (SchemaId) or a human-readable string (Schema AppId/API name, 3-25 characters)"},{"disabled":false,"type":"any","value":"10cc476e-4cea-1124-9ba2-805e59214048","key":"RecordIdentifier","description":"(Required) Record identifier - can be a UUID (RecordId) or a human-readable slug (RecordSlug, 6-40 characters)"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"schemaId\": {\n \"value\": \"\"\n },\n \"values\": {\n \"value\": \"\"\n },\n \"createdBy\": {\n \"value\": \"\"\n },\n \"updatedBy\": {\n \"value\": \"\"\n },\n \"createdAt\": {\n \"value\": \"\"\n },\n \"updatedAt\": {\n \"value\": \"\"\n },\n \"status\": {\n \"value\": \"\"\n },\n \"recordVersion\": {\n \"value\": \"\"\n },\n \"publishedBy\": {\n \"value\": \"\"\n },\n \"deletedBy\": {\n \"value\": \"\"\n },\n \"publishedAt\": {\n \"value\": \"\"\n },\n \"deletedAt\": {\n \"value\": \"\"\n },\n \"slug\": {\n \"value\": \"\"\n },\n \"schemaVersion\": 7838,\n \"schedule\": {\n \"value\": \"\"\n },\n \"personalizationId\": {\n \"value\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"ec873103-e86d-4077-8631-ee5204a2bb82","name":"Incorrect request (malformed JSON, wrong parameters, etc.). See error message for details.","originalRequest":{"url":{"path":["brickworks","v1","schemas",":SchemaIdentifier","records",":RecordIdentifier","duplicate"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"44e5411f-17ee-ab70-9112-0c776aafa909","key":"SchemaIdentifier","description":"(Required) Schema identifier - can be a UUID (SchemaId) or a human-readable string (Schema AppId/API name, 3-25 characters)"},{"disabled":false,"type":"any","value":"10cc476e-4cea-1124-9ba2-805e59214048","key":"RecordIdentifier","description":"(Required) Record identifier - can be a UUID (RecordId) or a human-readable slug (RecordSlug, 6-40 characters)"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"httpStatus\": 8176,\n \"errorCode\": \"string\",\n \"timestamp\": \"2009-08-02T10:31:15.071Z\",\n \"message\": \"string\",\n \"traceId\": \"string\",\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"source\": {\n \"pointer\": \"string\",\n \"value\": \"string\"\n },\n \"details\": {\n \"key_0\": {}\n },\n \"field\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"9e97f78f-3ab9-443b-8d41-eb808dcc12a8","name":"Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc. See error message for details.","originalRequest":{"url":{"path":["brickworks","v1","schemas",":SchemaIdentifier","records",":RecordIdentifier","duplicate"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"44e5411f-17ee-ab70-9112-0c776aafa909","key":"SchemaIdentifier","description":"(Required) Schema identifier - can be a UUID (SchemaId) or a human-readable string (Schema AppId/API name, 3-25 characters)"},{"disabled":false,"type":"any","value":"10cc476e-4cea-1124-9ba2-805e59214048","key":"RecordIdentifier","description":"(Required) Record identifier - can be a UUID (RecordId) or a human-readable slug (RecordSlug, 6-40 characters)"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\",\n \"status\": 647,\n \"timestamp\": \"string\",\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"367c9f43-826d-4b76-ad2b-1a29c55d88e5","name":"Forbidden; insufficient permissions. See error message for details.","originalRequest":{"url":{"path":["brickworks","v1","schemas",":SchemaIdentifier","records",":RecordIdentifier","duplicate"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"44e5411f-17ee-ab70-9112-0c776aafa909","key":"SchemaIdentifier","description":"(Required) Schema identifier - can be a UUID (SchemaId) or a human-readable string (Schema AppId/API name, 3-25 characters)"},{"disabled":false,"type":"any","value":"10cc476e-4cea-1124-9ba2-805e59214048","key":"RecordIdentifier","description":"(Required) Record identifier - can be a UUID (RecordId) or a human-readable slug (RecordSlug, 6-40 characters)"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\",\n \"status\": 647,\n \"timestamp\": \"string\",\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"0445597f-c4df-42a1-b5a6-274d2dde76cd","name":"Resource not found. See error message for details.","originalRequest":{"url":{"path":["brickworks","v1","schemas",":SchemaIdentifier","records",":RecordIdentifier","duplicate"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"44e5411f-17ee-ab70-9112-0c776aafa909","key":"SchemaIdentifier","description":"(Required) Schema identifier - can be a UUID (SchemaId) or a human-readable string (Schema AppId/API name, 3-25 characters)"},{"disabled":false,"type":"any","value":"10cc476e-4cea-1124-9ba2-805e59214048","key":"RecordIdentifier","description":"(Required) Record identifier - can be a UUID (RecordId) or a human-readable slug (RecordSlug, 6-40 characters)"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"httpStatus\": 8176,\n \"errorCode\": \"string\",\n \"timestamp\": \"2009-08-02T10:31:15.071Z\",\n \"message\": \"string\",\n \"traceId\": \"string\",\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"source\": {\n \"pointer\": \"string\",\n \"value\": \"string\"\n },\n \"details\": {\n \"key_0\": {}\n },\n \"field\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"5f9e0abf-e3b3-4179-9e41-b41f93a9bc77","name":"The request could not be completed due to a conflict with the current state of the resource. See error message for details.","originalRequest":{"url":{"path":["brickworks","v1","schemas",":SchemaIdentifier","records",":RecordIdentifier","duplicate"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"44e5411f-17ee-ab70-9112-0c776aafa909","key":"SchemaIdentifier","description":"(Required) Schema identifier - can be a UUID (SchemaId) or a human-readable string (Schema AppId/API name, 3-25 characters)"},{"disabled":false,"type":"any","value":"10cc476e-4cea-1124-9ba2-805e59214048","key":"RecordIdentifier","description":"(Required) Record identifier - can be a UUID (RecordId) or a human-readable slug (RecordSlug, 6-40 characters)"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"Conflict","code":409,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"httpStatus\": 8176,\n \"errorCode\": \"string\",\n \"timestamp\": \"2009-08-02T10:31:15.071Z\",\n \"message\": \"string\",\n \"traceId\": \"string\",\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"source\": {\n \"pointer\": \"string\",\n \"value\": \"string\"\n },\n \"details\": {\n \"key_0\": {}\n },\n \"field\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"22bf3f52-2aa1-4de7-9ffa-d490e86fd0b4","name":"The request was well-formed but could not be processed due to semantic or domain-related constraints. See error message for details.","originalRequest":{"url":{"path":["brickworks","v1","schemas",":SchemaIdentifier","records",":RecordIdentifier","duplicate"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"44e5411f-17ee-ab70-9112-0c776aafa909","key":"SchemaIdentifier","description":"(Required) Schema identifier - can be a UUID (SchemaId) or a human-readable string (Schema AppId/API name, 3-25 characters)"},{"disabled":false,"type":"any","value":"10cc476e-4cea-1124-9ba2-805e59214048","key":"RecordIdentifier","description":"(Required) Record identifier - can be a UUID (RecordId) or a human-readable slug (RecordSlug, 6-40 characters)"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"httpStatus\": 8176,\n \"errorCode\": \"string\",\n \"timestamp\": \"2009-08-02T10:31:15.071Z\",\n \"message\": \"string\",\n \"traceId\": \"string\",\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"source\": {\n \"pointer\": \"string\",\n \"value\": \"string\"\n },\n \"details\": {\n \"key_0\": {}\n },\n \"field\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"0126f564-45a5-45ad-ae10-21a4d6f77788","name":"See error message for details.","originalRequest":{"url":{"path":["brickworks","v1","schemas",":SchemaIdentifier","records",":RecordIdentifier","duplicate"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"44e5411f-17ee-ab70-9112-0c776aafa909","key":"SchemaIdentifier","description":"(Required) Schema identifier - can be a UUID (SchemaId) or a human-readable string (Schema AppId/API name, 3-25 characters)"},{"disabled":false,"type":"any","value":"10cc476e-4cea-1124-9ba2-805e59214048","key":"RecordIdentifier","description":"(Required) Record identifier - can be a UUID (RecordId) or a human-readable slug (RecordSlug, 6-40 characters)"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"httpStatus\": 8176,\n \"errorCode\": \"string\",\n \"timestamp\": \"2009-08-02T10:31:15.071Z\",\n \"message\": \"string\",\n \"traceId\": \"string\",\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"source\": {\n \"pointer\": \"string\",\n \"value\": \"string\"\n },\n \"details\": {\n \"key_0\": {}\n },\n \"field\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"67ea073c-b630-4d5e-88f3-866ec1f56a78","name":"Batch create or update records (async)","request":{"name":"Batch create or update records (async)","description":{"content":"This endpoint can only be used for simple schemas.\n\n- If a record included in this request already exists, it's entirely overwritten by the content from the request (including the slug - if the slug isn't sent, it's removed).\n- Provide the current identifier value (if your request changes the identifier, provide the one from before the change).\n- The record must conform with the schema.\n\nAsynchronous requests are processed according to the time they reach the service. \nThis means that requests to synchronous endpoints may overwrite asynchronous operations which were sent earlier and queued due to high traffic.\n\nIn some edge cases, changing a record may fail further in the backend, even when this endpoint returns no errors. In such cases, contact Support.\n\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `BRICKWORKS_RECORDS_CREATE`\n\n**User role permission required:** `assets_brickworks: create`\n","type":"text/plain"},"url":{"path":["brickworks","v1","async","schemas",":SchemaIdentifier","records"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"44e5411f-17ee-ab70-9112-0c776aafa909","key":"SchemaIdentifier","description":"(Required) Schema identifier - can be a UUID (SchemaId) or a human-readable string (Schema AppId/API name, 3-25 characters)"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"[\n {\n \"identifier\": {\n \"value\": \"\"\n },\n \"values\": {\n \"value\": \"\"\n },\n \"slug\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n },\n {\n \"identifier\": {\n \"value\": \"\"\n },\n \"values\": {\n \"value\": \"\"\n },\n \"slug\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n }\n]","options":{"raw":{"language":"json"}}}},"response":[{"id":"a019b84e-514d-48bf-aedc-c9ce8cdd4769","name":"Operation added to queue","originalRequest":{"url":{"path":["brickworks","v1","async","schemas",":SchemaIdentifier","records"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"44e5411f-17ee-ab70-9112-0c776aafa909","key":"SchemaIdentifier","description":"(Required) Schema identifier - can be a UUID (SchemaId) or a human-readable string (Schema AppId/API name, 3-25 characters)"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"POST","body":{"mode":"raw","raw":"[\n {\n \"identifier\": {\n \"value\": \"\"\n },\n \"values\": {\n \"value\": \"\"\n },\n \"slug\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n },\n {\n \"identifier\": {\n \"value\": \"\"\n },\n \"values\": {\n \"value\": \"\"\n },\n \"slug\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n }\n]","options":{"raw":{"language":"json"}}}},"status":"Created","code":201,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"1dee932d-ad62-4da0-853f-87fb429a9f34","name":"Some operations failed","originalRequest":{"url":{"path":["brickworks","v1","async","schemas",":SchemaIdentifier","records"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"44e5411f-17ee-ab70-9112-0c776aafa909","key":"SchemaIdentifier","description":"(Required) Schema identifier - can be a UUID (SchemaId) or a human-readable string (Schema AppId/API name, 3-25 characters)"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"[\n {\n \"identifier\": {\n \"value\": \"\"\n },\n \"values\": {\n \"value\": \"\"\n },\n \"slug\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n },\n {\n \"identifier\": {\n \"value\": \"\"\n },\n \"values\": {\n \"value\": \"\"\n },\n \"slug\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n }\n]","options":{"raw":{"language":"json"}}}},"status":"Multi-Status (WebDAV) (RFC 4918)","code":207,"header":[{"key":"Content-Type","value":"application/json"}],"body":"[\n {\n \"identifier\": {\n \"name\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n },\n {\n \"identifier\": {\n \"name\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n }\n]","cookie":[],"_postman_previewlanguage":"json"},{"id":"6b2239e4-dc00-4c4d-9966-c1355245753a","name":"Incorrect request (malformed JSON, wrong parameters, etc.). See error message for details.","originalRequest":{"url":{"path":["brickworks","v1","async","schemas",":SchemaIdentifier","records"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"44e5411f-17ee-ab70-9112-0c776aafa909","key":"SchemaIdentifier","description":"(Required) Schema identifier - can be a UUID (SchemaId) or a human-readable string (Schema AppId/API name, 3-25 characters)"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"[\n {\n \"identifier\": {\n \"value\": \"\"\n },\n \"values\": {\n \"value\": \"\"\n },\n \"slug\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n },\n {\n \"identifier\": {\n \"value\": \"\"\n },\n \"values\": {\n \"value\": \"\"\n },\n \"slug\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n }\n]","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"httpStatus\": 8176,\n \"errorCode\": \"string\",\n \"timestamp\": \"2009-08-02T10:31:15.071Z\",\n \"message\": \"string\",\n \"traceId\": \"string\",\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"source\": {\n \"pointer\": \"string\",\n \"value\": \"string\"\n },\n \"details\": {\n \"key_0\": {}\n },\n \"field\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"857d1a66-8814-4233-aabb-eb39b61ed0d7","name":"Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc. See error message for details.","originalRequest":{"url":{"path":["brickworks","v1","async","schemas",":SchemaIdentifier","records"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"44e5411f-17ee-ab70-9112-0c776aafa909","key":"SchemaIdentifier","description":"(Required) Schema identifier - can be a UUID (SchemaId) or a human-readable string (Schema AppId/API name, 3-25 characters)"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"[\n {\n \"identifier\": {\n \"value\": \"\"\n },\n \"values\": {\n \"value\": \"\"\n },\n \"slug\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n },\n {\n \"identifier\": {\n \"value\": \"\"\n },\n \"values\": {\n \"value\": \"\"\n },\n \"slug\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n }\n]","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\",\n \"status\": 647,\n \"timestamp\": \"string\",\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"3b723626-9e4a-453c-94e1-4c97e12315e0","name":"Forbidden; insufficient permissions. See error message for details.","originalRequest":{"url":{"path":["brickworks","v1","async","schemas",":SchemaIdentifier","records"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"44e5411f-17ee-ab70-9112-0c776aafa909","key":"SchemaIdentifier","description":"(Required) Schema identifier - can be a UUID (SchemaId) or a human-readable string (Schema AppId/API name, 3-25 characters)"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"[\n {\n \"identifier\": {\n \"value\": \"\"\n },\n \"values\": {\n \"value\": \"\"\n },\n \"slug\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n },\n {\n \"identifier\": {\n \"value\": \"\"\n },\n \"values\": {\n \"value\": \"\"\n },\n \"slug\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n }\n]","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\",\n \"status\": 647,\n \"timestamp\": \"string\",\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"158528e3-2443-416d-ad2e-015ec724dfde","name":"Resource not found. See error message for details.","originalRequest":{"url":{"path":["brickworks","v1","async","schemas",":SchemaIdentifier","records"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"44e5411f-17ee-ab70-9112-0c776aafa909","key":"SchemaIdentifier","description":"(Required) Schema identifier - can be a UUID (SchemaId) or a human-readable string (Schema AppId/API name, 3-25 characters)"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"[\n {\n \"identifier\": {\n \"value\": \"\"\n },\n \"values\": {\n \"value\": \"\"\n },\n \"slug\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n },\n {\n \"identifier\": {\n \"value\": \"\"\n },\n \"values\": {\n \"value\": \"\"\n },\n \"slug\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n }\n]","options":{"raw":{"language":"json"}}}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"httpStatus\": 8176,\n \"errorCode\": \"string\",\n \"timestamp\": \"2009-08-02T10:31:15.071Z\",\n \"message\": \"string\",\n \"traceId\": \"string\",\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"source\": {\n \"pointer\": \"string\",\n \"value\": \"string\"\n },\n \"details\": {\n \"key_0\": {}\n },\n \"field\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"4ca66c30-b214-4a9a-bec1-1840617c5faf","name":"The request could not be completed due to a conflict with the current state of the resource. See error message for details.","originalRequest":{"url":{"path":["brickworks","v1","async","schemas",":SchemaIdentifier","records"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"44e5411f-17ee-ab70-9112-0c776aafa909","key":"SchemaIdentifier","description":"(Required) Schema identifier - can be a UUID (SchemaId) or a human-readable string (Schema AppId/API name, 3-25 characters)"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"[\n {\n \"identifier\": {\n \"value\": \"\"\n },\n \"values\": {\n \"value\": \"\"\n },\n \"slug\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n },\n {\n \"identifier\": {\n \"value\": \"\"\n },\n \"values\": {\n \"value\": \"\"\n },\n \"slug\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n }\n]","options":{"raw":{"language":"json"}}}},"status":"Conflict","code":409,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"httpStatus\": 8176,\n \"errorCode\": \"string\",\n \"timestamp\": \"2009-08-02T10:31:15.071Z\",\n \"message\": \"string\",\n \"traceId\": \"string\",\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"source\": {\n \"pointer\": \"string\",\n \"value\": \"string\"\n },\n \"details\": {\n \"key_0\": {}\n },\n \"field\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"8468684c-4f77-4765-9450-6633e57fcc03","name":"The request was well-formed but could not be processed due to semantic or domain-related constraints. See error message for details.","originalRequest":{"url":{"path":["brickworks","v1","async","schemas",":SchemaIdentifier","records"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"44e5411f-17ee-ab70-9112-0c776aafa909","key":"SchemaIdentifier","description":"(Required) Schema identifier - can be a UUID (SchemaId) or a human-readable string (Schema AppId/API name, 3-25 characters)"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"[\n {\n \"identifier\": {\n \"value\": \"\"\n },\n \"values\": {\n \"value\": \"\"\n },\n \"slug\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n },\n {\n \"identifier\": {\n \"value\": \"\"\n },\n \"values\": {\n \"value\": \"\"\n },\n \"slug\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n }\n]","options":{"raw":{"language":"json"}}}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"httpStatus\": 8176,\n \"errorCode\": \"string\",\n \"timestamp\": \"2009-08-02T10:31:15.071Z\",\n \"message\": \"string\",\n \"traceId\": \"string\",\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"source\": {\n \"pointer\": \"string\",\n \"value\": \"string\"\n },\n \"details\": {\n \"key_0\": {}\n },\n \"field\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"6be6277a-e6e6-482e-8f97-a669428194c9","name":"See error message for details.","originalRequest":{"url":{"path":["brickworks","v1","async","schemas",":SchemaIdentifier","records"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"44e5411f-17ee-ab70-9112-0c776aafa909","key":"SchemaIdentifier","description":"(Required) Schema identifier - can be a UUID (SchemaId) or a human-readable string (Schema AppId/API name, 3-25 characters)"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"[\n {\n \"identifier\": {\n \"value\": \"\"\n },\n \"values\": {\n \"value\": \"\"\n },\n \"slug\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n },\n {\n \"identifier\": {\n \"value\": \"\"\n },\n \"values\": {\n \"value\": \"\"\n },\n \"slug\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n }\n]","options":{"raw":{"language":"json"}}}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"httpStatus\": 8176,\n \"errorCode\": \"string\",\n \"timestamp\": \"2009-08-02T10:31:15.071Z\",\n \"message\": \"string\",\n \"traceId\": \"string\",\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"source\": {\n \"pointer\": \"string\",\n \"value\": \"string\"\n },\n \"details\": {\n \"key_0\": {}\n },\n \"field\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"642f0399-9a94-42b4-b780-2cc1852fc892","name":"Batch create or partially update record (async)","request":{"name":"Batch create or partially update record (async)","description":{"content":"This endpoint can only be used for simple schemas.\n\nAsynchronous requests are processed according to the time they reach the service. \nThis means that requests to synchronous endpoints may overwrite asynchronous operations which were sent earlier and queued due to high traffic.\n\nIn some edge cases, changing a record may fail further in the backend, even when this endpoint returns no errors. In such cases, contact Support.\n\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `BRICKWORKS_RECORDS_CREATE`\n\n**User role permission required:** `assets_brickworks: create`\n","type":"text/plain"},"url":{"path":["brickworks","v1","async","schemas",":SchemaIdentifier","records"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"44e5411f-17ee-ab70-9112-0c776aafa909","key":"SchemaIdentifier","description":"(Required) Schema identifier - can be a UUID (SchemaId) or a human-readable string (Schema AppId/API name, 3-25 characters)"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PATCH","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"[\n {\n \"identifier\": {\n \"value\": \"\"\n },\n \"values\": {\n \"value\": \"\"\n },\n \"slug\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n },\n {\n \"identifier\": {\n \"value\": \"\"\n },\n \"values\": {\n \"value\": \"\"\n },\n \"slug\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n }\n]","options":{"raw":{"language":"json"}}}},"response":[{"id":"a41475a1-cb3b-4d5a-a17e-5e75d080481d","name":"Operation added to queue","originalRequest":{"url":{"path":["brickworks","v1","async","schemas",":SchemaIdentifier","records"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"44e5411f-17ee-ab70-9112-0c776aafa909","key":"SchemaIdentifier","description":"(Required) Schema identifier - can be a UUID (SchemaId) or a human-readable string (Schema AppId/API name, 3-25 characters)"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"PATCH","body":{"mode":"raw","raw":"[\n {\n \"identifier\": {\n \"value\": \"\"\n },\n \"values\": {\n \"value\": \"\"\n },\n \"slug\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n },\n {\n \"identifier\": {\n \"value\": \"\"\n },\n \"values\": {\n \"value\": \"\"\n },\n \"slug\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n }\n]","options":{"raw":{"language":"json"}}}},"status":"Created","code":201,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"a8ab7cf6-e636-427e-acae-beee3183db85","name":"Some operations failed","originalRequest":{"url":{"path":["brickworks","v1","async","schemas",":SchemaIdentifier","records"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"44e5411f-17ee-ab70-9112-0c776aafa909","key":"SchemaIdentifier","description":"(Required) Schema identifier - can be a UUID (SchemaId) or a human-readable string (Schema AppId/API name, 3-25 characters)"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"[\n {\n \"identifier\": {\n \"value\": \"\"\n },\n \"values\": {\n \"value\": \"\"\n },\n \"slug\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n },\n {\n \"identifier\": {\n \"value\": \"\"\n },\n \"values\": {\n \"value\": \"\"\n },\n \"slug\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n }\n]","options":{"raw":{"language":"json"}}}},"status":"Multi-Status (WebDAV) (RFC 4918)","code":207,"header":[{"key":"Content-Type","value":"application/json"}],"body":"[\n {\n \"identifier\": {\n \"name\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n },\n {\n \"identifier\": {\n \"name\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n }\n]","cookie":[],"_postman_previewlanguage":"json"},{"id":"0dfbb53f-b8c3-491b-8bfc-9f386f1840a1","name":"Incorrect request (malformed JSON, wrong parameters, etc.). See error message for details.","originalRequest":{"url":{"path":["brickworks","v1","async","schemas",":SchemaIdentifier","records"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"44e5411f-17ee-ab70-9112-0c776aafa909","key":"SchemaIdentifier","description":"(Required) Schema identifier - can be a UUID (SchemaId) or a human-readable string (Schema AppId/API name, 3-25 characters)"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"[\n {\n \"identifier\": {\n \"value\": \"\"\n },\n \"values\": {\n \"value\": \"\"\n },\n \"slug\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n },\n {\n \"identifier\": {\n \"value\": \"\"\n },\n \"values\": {\n \"value\": \"\"\n },\n \"slug\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n }\n]","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"httpStatus\": 8176,\n \"errorCode\": \"string\",\n \"timestamp\": \"2009-08-02T10:31:15.071Z\",\n \"message\": \"string\",\n \"traceId\": \"string\",\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"source\": {\n \"pointer\": \"string\",\n \"value\": \"string\"\n },\n \"details\": {\n \"key_0\": {}\n },\n \"field\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"aaff9cb8-3493-4601-8790-8a03c409bb92","name":"Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc. See error message for details.","originalRequest":{"url":{"path":["brickworks","v1","async","schemas",":SchemaIdentifier","records"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"44e5411f-17ee-ab70-9112-0c776aafa909","key":"SchemaIdentifier","description":"(Required) Schema identifier - can be a UUID (SchemaId) or a human-readable string (Schema AppId/API name, 3-25 characters)"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"[\n {\n \"identifier\": {\n \"value\": \"\"\n },\n \"values\": {\n \"value\": \"\"\n },\n \"slug\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n },\n {\n \"identifier\": {\n \"value\": \"\"\n },\n \"values\": {\n \"value\": \"\"\n },\n \"slug\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n }\n]","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\",\n \"status\": 647,\n \"timestamp\": \"string\",\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"4fb03719-43d1-4f1c-b061-fabfd849c31e","name":"Forbidden; insufficient permissions. See error message for details.","originalRequest":{"url":{"path":["brickworks","v1","async","schemas",":SchemaIdentifier","records"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"44e5411f-17ee-ab70-9112-0c776aafa909","key":"SchemaIdentifier","description":"(Required) Schema identifier - can be a UUID (SchemaId) or a human-readable string (Schema AppId/API name, 3-25 characters)"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"[\n {\n \"identifier\": {\n \"value\": \"\"\n },\n \"values\": {\n \"value\": \"\"\n },\n \"slug\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n },\n {\n \"identifier\": {\n \"value\": \"\"\n },\n \"values\": {\n \"value\": \"\"\n },\n \"slug\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n }\n]","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\",\n \"status\": 647,\n \"timestamp\": \"string\",\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"10b818aa-a059-4600-a0c4-8b072ba7fde0","name":"Resource not found. See error message for details.","originalRequest":{"url":{"path":["brickworks","v1","async","schemas",":SchemaIdentifier","records"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"44e5411f-17ee-ab70-9112-0c776aafa909","key":"SchemaIdentifier","description":"(Required) Schema identifier - can be a UUID (SchemaId) or a human-readable string (Schema AppId/API name, 3-25 characters)"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"[\n {\n \"identifier\": {\n \"value\": \"\"\n },\n \"values\": {\n \"value\": \"\"\n },\n \"slug\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n },\n {\n \"identifier\": {\n \"value\": \"\"\n },\n \"values\": {\n \"value\": \"\"\n },\n \"slug\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n }\n]","options":{"raw":{"language":"json"}}}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"httpStatus\": 8176,\n \"errorCode\": \"string\",\n \"timestamp\": \"2009-08-02T10:31:15.071Z\",\n \"message\": \"string\",\n \"traceId\": \"string\",\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"source\": {\n \"pointer\": \"string\",\n \"value\": \"string\"\n },\n \"details\": {\n \"key_0\": {}\n },\n \"field\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"b74c767c-78dc-4375-93f1-0405461115aa","name":"The request could not be completed due to a conflict with the current state of the resource. See error message for details.","originalRequest":{"url":{"path":["brickworks","v1","async","schemas",":SchemaIdentifier","records"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"44e5411f-17ee-ab70-9112-0c776aafa909","key":"SchemaIdentifier","description":"(Required) Schema identifier - can be a UUID (SchemaId) or a human-readable string (Schema AppId/API name, 3-25 characters)"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"[\n {\n \"identifier\": {\n \"value\": \"\"\n },\n \"values\": {\n \"value\": \"\"\n },\n \"slug\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n },\n {\n \"identifier\": {\n \"value\": \"\"\n },\n \"values\": {\n \"value\": \"\"\n },\n \"slug\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n }\n]","options":{"raw":{"language":"json"}}}},"status":"Conflict","code":409,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"httpStatus\": 8176,\n \"errorCode\": \"string\",\n \"timestamp\": \"2009-08-02T10:31:15.071Z\",\n \"message\": \"string\",\n \"traceId\": \"string\",\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"source\": {\n \"pointer\": \"string\",\n \"value\": \"string\"\n },\n \"details\": {\n \"key_0\": {}\n },\n \"field\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"562d87bb-31f7-42e4-a364-9a4a0ae36a6e","name":"The request was well-formed but could not be processed due to semantic or domain-related constraints. See error message for details.","originalRequest":{"url":{"path":["brickworks","v1","async","schemas",":SchemaIdentifier","records"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"44e5411f-17ee-ab70-9112-0c776aafa909","key":"SchemaIdentifier","description":"(Required) Schema identifier - can be a UUID (SchemaId) or a human-readable string (Schema AppId/API name, 3-25 characters)"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"[\n {\n \"identifier\": {\n \"value\": \"\"\n },\n \"values\": {\n \"value\": \"\"\n },\n \"slug\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n },\n {\n \"identifier\": {\n \"value\": \"\"\n },\n \"values\": {\n \"value\": \"\"\n },\n \"slug\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n }\n]","options":{"raw":{"language":"json"}}}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"httpStatus\": 8176,\n \"errorCode\": \"string\",\n \"timestamp\": \"2009-08-02T10:31:15.071Z\",\n \"message\": \"string\",\n \"traceId\": \"string\",\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"source\": {\n \"pointer\": \"string\",\n \"value\": \"string\"\n },\n \"details\": {\n \"key_0\": {}\n },\n \"field\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"77d6c4d1-9172-4c96-a380-5474911a3374","name":"See error message for details.","originalRequest":{"url":{"path":["brickworks","v1","async","schemas",":SchemaIdentifier","records"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"44e5411f-17ee-ab70-9112-0c776aafa909","key":"SchemaIdentifier","description":"(Required) Schema identifier - can be a UUID (SchemaId) or a human-readable string (Schema AppId/API name, 3-25 characters)"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"[\n {\n \"identifier\": {\n \"value\": \"\"\n },\n \"values\": {\n \"value\": \"\"\n },\n \"slug\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n },\n {\n \"identifier\": {\n \"value\": \"\"\n },\n \"values\": {\n \"value\": \"\"\n },\n \"slug\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n }\n]","options":{"raw":{"language":"json"}}}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"httpStatus\": 8176,\n \"errorCode\": \"string\",\n \"timestamp\": \"2009-08-02T10:31:15.071Z\",\n \"message\": \"string\",\n \"traceId\": \"string\",\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"source\": {\n \"pointer\": \"string\",\n \"value\": \"string\"\n },\n \"details\": {\n \"key_0\": {}\n },\n \"field\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"12aef550-d777-406b-966f-0731581a04a1","name":"Create or update record (async)","request":{"name":"Create or update record (async)","description":{"content":"This endpoint can only be used for simple schemas.\n\n- If a record included in this request already exists, it's entirely overwritten by the content from the request (including the slug - if the slug isn't sent, it's removed).\n- Provide the current identifier value (if your request changes the identifier, provide the one from before the change).\n- The record must conform with the schema.\n\nAsynchronous requests are processed according to the time they reach the service. \nThis means that requests to synchronous endpoints may overwrite asynchronous operations which were sent earlier and queued due to high traffic.\n\nIn some edge cases, changing a record may fail further in the backend, even when this endpoint returns no errors. In such cases, contact Support.\n\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `BRICKWORKS_RECORDS_CREATE`\n\n**User role permission required:** `assets_brickworks: create`\n","type":"text/plain"},"url":{"path":["brickworks","v1","async","schemas",":SchemaIdentifier","record"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"44e5411f-17ee-ab70-9112-0c776aafa909","key":"SchemaIdentifier","description":"(Required) Schema identifier - can be a UUID (SchemaId) or a human-readable string (Schema AppId/API name, 3-25 characters)"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"identifier\": {\n \"name\": \"string\",\n \"value\": {\n \"value\": \"\"\n }\n },\n \"values\": {\n \"stringField\": \"example string\",\n \"numberField\": 123.45,\n \"integerField\": 42,\n \"booleanField\": true,\n \"dateField\": \"2024-01-15\",\n \"dateTimeField\": \"2024-01-15T10:30:00Z\",\n \"uuidField\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"arrayField\": [\n \"item1\",\n \"item2\"\n ],\n \"objectField\": {\n \"key\": \"value\"\n },\n \"profileAttribute\": {\n \"attributeName\": \"email\"\n },\n \"catalog\": {\n \"itemKey\": \"SKU123\"\n },\n \"recommendation\": {\n \"params\": {\n \"itemId\": \"item-123\"\n }\n }\n },\n \"slug\": \"_jO6_jO6\",\n \"name\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"0543fcd3-685c-4ab4-ad6c-cfd6916766d7","name":"Operation added to queue","originalRequest":{"url":{"path":["brickworks","v1","async","schemas",":SchemaIdentifier","record"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"44e5411f-17ee-ab70-9112-0c776aafa909","key":"SchemaIdentifier","description":"(Required) Schema identifier - can be a UUID (SchemaId) or a human-readable string (Schema AppId/API name, 3-25 characters)"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"POST","body":{"mode":"raw","raw":"{\n \"identifier\": {\n \"name\": \"string\",\n \"value\": {\n \"value\": \"\"\n }\n },\n \"values\": {\n \"stringField\": \"example string\",\n \"numberField\": 123.45,\n \"integerField\": 42,\n \"booleanField\": true,\n \"dateField\": \"2024-01-15\",\n \"dateTimeField\": \"2024-01-15T10:30:00Z\",\n \"uuidField\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"arrayField\": [\n \"item1\",\n \"item2\"\n ],\n \"objectField\": {\n \"key\": \"value\"\n },\n \"profileAttribute\": {\n \"attributeName\": \"email\"\n },\n \"catalog\": {\n \"itemKey\": \"SKU123\"\n },\n \"recommendation\": {\n \"params\": {\n \"itemId\": \"item-123\"\n }\n }\n },\n \"slug\": \"_jO6_jO6\",\n \"name\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Created","code":201,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"dea104af-ed4a-4946-8e7e-cce896360a53","name":"Incorrect request (malformed JSON, wrong parameters, etc.). See error message for details.","originalRequest":{"url":{"path":["brickworks","v1","async","schemas",":SchemaIdentifier","record"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"44e5411f-17ee-ab70-9112-0c776aafa909","key":"SchemaIdentifier","description":"(Required) Schema identifier - can be a UUID (SchemaId) or a human-readable string (Schema AppId/API name, 3-25 characters)"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"identifier\": {\n \"name\": \"string\",\n \"value\": {\n \"value\": \"\"\n }\n },\n \"values\": {\n \"stringField\": \"example string\",\n \"numberField\": 123.45,\n \"integerField\": 42,\n \"booleanField\": true,\n \"dateField\": \"2024-01-15\",\n \"dateTimeField\": \"2024-01-15T10:30:00Z\",\n \"uuidField\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"arrayField\": [\n \"item1\",\n \"item2\"\n ],\n \"objectField\": {\n \"key\": \"value\"\n },\n \"profileAttribute\": {\n \"attributeName\": \"email\"\n },\n \"catalog\": {\n \"itemKey\": \"SKU123\"\n },\n \"recommendation\": {\n \"params\": {\n \"itemId\": \"item-123\"\n }\n }\n },\n \"slug\": \"_jO6_jO6\",\n \"name\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"httpStatus\": 8176,\n \"errorCode\": \"string\",\n \"timestamp\": \"2009-08-02T10:31:15.071Z\",\n \"message\": \"string\",\n \"traceId\": \"string\",\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"source\": {\n \"pointer\": \"string\",\n \"value\": \"string\"\n },\n \"details\": {\n \"key_0\": {}\n },\n \"field\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"829180e3-2112-48ac-a066-80ca29be7980","name":"Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc. See error message for details.","originalRequest":{"url":{"path":["brickworks","v1","async","schemas",":SchemaIdentifier","record"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"44e5411f-17ee-ab70-9112-0c776aafa909","key":"SchemaIdentifier","description":"(Required) Schema identifier - can be a UUID (SchemaId) or a human-readable string (Schema AppId/API name, 3-25 characters)"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"identifier\": {\n \"name\": \"string\",\n \"value\": {\n \"value\": \"\"\n }\n },\n \"values\": {\n \"stringField\": \"example string\",\n \"numberField\": 123.45,\n \"integerField\": 42,\n \"booleanField\": true,\n \"dateField\": \"2024-01-15\",\n \"dateTimeField\": \"2024-01-15T10:30:00Z\",\n \"uuidField\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"arrayField\": [\n \"item1\",\n \"item2\"\n ],\n \"objectField\": {\n \"key\": \"value\"\n },\n \"profileAttribute\": {\n \"attributeName\": \"email\"\n },\n \"catalog\": {\n \"itemKey\": \"SKU123\"\n },\n \"recommendation\": {\n \"params\": {\n \"itemId\": \"item-123\"\n }\n }\n },\n \"slug\": \"_jO6_jO6\",\n \"name\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\",\n \"status\": 647,\n \"timestamp\": \"string\",\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"9e77a913-326e-4f83-a3f6-7ba78efa20ae","name":"Forbidden; insufficient permissions. See error message for details.","originalRequest":{"url":{"path":["brickworks","v1","async","schemas",":SchemaIdentifier","record"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"44e5411f-17ee-ab70-9112-0c776aafa909","key":"SchemaIdentifier","description":"(Required) Schema identifier - can be a UUID (SchemaId) or a human-readable string (Schema AppId/API name, 3-25 characters)"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"identifier\": {\n \"name\": \"string\",\n \"value\": {\n \"value\": \"\"\n }\n },\n \"values\": {\n \"stringField\": \"example string\",\n \"numberField\": 123.45,\n \"integerField\": 42,\n \"booleanField\": true,\n \"dateField\": \"2024-01-15\",\n \"dateTimeField\": \"2024-01-15T10:30:00Z\",\n \"uuidField\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"arrayField\": [\n \"item1\",\n \"item2\"\n ],\n \"objectField\": {\n \"key\": \"value\"\n },\n \"profileAttribute\": {\n \"attributeName\": \"email\"\n },\n \"catalog\": {\n \"itemKey\": \"SKU123\"\n },\n \"recommendation\": {\n \"params\": {\n \"itemId\": \"item-123\"\n }\n }\n },\n \"slug\": \"_jO6_jO6\",\n \"name\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\",\n \"status\": 647,\n \"timestamp\": \"string\",\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"3050632b-bbe9-43b9-9f2a-be7c24818bbf","name":"Resource not found. See error message for details.","originalRequest":{"url":{"path":["brickworks","v1","async","schemas",":SchemaIdentifier","record"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"44e5411f-17ee-ab70-9112-0c776aafa909","key":"SchemaIdentifier","description":"(Required) Schema identifier - can be a UUID (SchemaId) or a human-readable string (Schema AppId/API name, 3-25 characters)"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"identifier\": {\n \"name\": \"string\",\n \"value\": {\n \"value\": \"\"\n }\n },\n \"values\": {\n \"stringField\": \"example string\",\n \"numberField\": 123.45,\n \"integerField\": 42,\n \"booleanField\": true,\n \"dateField\": \"2024-01-15\",\n \"dateTimeField\": \"2024-01-15T10:30:00Z\",\n \"uuidField\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"arrayField\": [\n \"item1\",\n \"item2\"\n ],\n \"objectField\": {\n \"key\": \"value\"\n },\n \"profileAttribute\": {\n \"attributeName\": \"email\"\n },\n \"catalog\": {\n \"itemKey\": \"SKU123\"\n },\n \"recommendation\": {\n \"params\": {\n \"itemId\": \"item-123\"\n }\n }\n },\n \"slug\": \"_jO6_jO6\",\n \"name\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"httpStatus\": 8176,\n \"errorCode\": \"string\",\n \"timestamp\": \"2009-08-02T10:31:15.071Z\",\n \"message\": \"string\",\n \"traceId\": \"string\",\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"source\": {\n \"pointer\": \"string\",\n \"value\": \"string\"\n },\n \"details\": {\n \"key_0\": {}\n },\n \"field\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"4a228449-2ee7-46e1-9d00-e6c1cd6dfecb","name":"The request could not be completed due to a conflict with the current state of the resource. See error message for details.","originalRequest":{"url":{"path":["brickworks","v1","async","schemas",":SchemaIdentifier","record"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"44e5411f-17ee-ab70-9112-0c776aafa909","key":"SchemaIdentifier","description":"(Required) Schema identifier - can be a UUID (SchemaId) or a human-readable string (Schema AppId/API name, 3-25 characters)"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"identifier\": {\n \"name\": \"string\",\n \"value\": {\n \"value\": \"\"\n }\n },\n \"values\": {\n \"stringField\": \"example string\",\n \"numberField\": 123.45,\n \"integerField\": 42,\n \"booleanField\": true,\n \"dateField\": \"2024-01-15\",\n \"dateTimeField\": \"2024-01-15T10:30:00Z\",\n \"uuidField\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"arrayField\": [\n \"item1\",\n \"item2\"\n ],\n \"objectField\": {\n \"key\": \"value\"\n },\n \"profileAttribute\": {\n \"attributeName\": \"email\"\n },\n \"catalog\": {\n \"itemKey\": \"SKU123\"\n },\n \"recommendation\": {\n \"params\": {\n \"itemId\": \"item-123\"\n }\n }\n },\n \"slug\": \"_jO6_jO6\",\n \"name\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Conflict","code":409,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"httpStatus\": 8176,\n \"errorCode\": \"string\",\n \"timestamp\": \"2009-08-02T10:31:15.071Z\",\n \"message\": \"string\",\n \"traceId\": \"string\",\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"source\": {\n \"pointer\": \"string\",\n \"value\": \"string\"\n },\n \"details\": {\n \"key_0\": {}\n },\n \"field\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"2dc93022-4095-4c01-8131-64662596bbe5","name":"The request was well-formed but could not be processed due to semantic or domain-related constraints. See error message for details.","originalRequest":{"url":{"path":["brickworks","v1","async","schemas",":SchemaIdentifier","record"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"44e5411f-17ee-ab70-9112-0c776aafa909","key":"SchemaIdentifier","description":"(Required) Schema identifier - can be a UUID (SchemaId) or a human-readable string (Schema AppId/API name, 3-25 characters)"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"identifier\": {\n \"name\": \"string\",\n \"value\": {\n \"value\": \"\"\n }\n },\n \"values\": {\n \"stringField\": \"example string\",\n \"numberField\": 123.45,\n \"integerField\": 42,\n \"booleanField\": true,\n \"dateField\": \"2024-01-15\",\n \"dateTimeField\": \"2024-01-15T10:30:00Z\",\n \"uuidField\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"arrayField\": [\n \"item1\",\n \"item2\"\n ],\n \"objectField\": {\n \"key\": \"value\"\n },\n \"profileAttribute\": {\n \"attributeName\": \"email\"\n },\n \"catalog\": {\n \"itemKey\": \"SKU123\"\n },\n \"recommendation\": {\n \"params\": {\n \"itemId\": \"item-123\"\n }\n }\n },\n \"slug\": \"_jO6_jO6\",\n \"name\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"httpStatus\": 8176,\n \"errorCode\": \"string\",\n \"timestamp\": \"2009-08-02T10:31:15.071Z\",\n \"message\": \"string\",\n \"traceId\": \"string\",\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"source\": {\n \"pointer\": \"string\",\n \"value\": \"string\"\n },\n \"details\": {\n \"key_0\": {}\n },\n \"field\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"22dc3e20-a556-4aee-bc52-01a0c1710082","name":"See error message for details.","originalRequest":{"url":{"path":["brickworks","v1","async","schemas",":SchemaIdentifier","record"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"44e5411f-17ee-ab70-9112-0c776aafa909","key":"SchemaIdentifier","description":"(Required) Schema identifier - can be a UUID (SchemaId) or a human-readable string (Schema AppId/API name, 3-25 characters)"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"identifier\": {\n \"name\": \"string\",\n \"value\": {\n \"value\": \"\"\n }\n },\n \"values\": {\n \"stringField\": \"example string\",\n \"numberField\": 123.45,\n \"integerField\": 42,\n \"booleanField\": true,\n \"dateField\": \"2024-01-15\",\n \"dateTimeField\": \"2024-01-15T10:30:00Z\",\n \"uuidField\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"arrayField\": [\n \"item1\",\n \"item2\"\n ],\n \"objectField\": {\n \"key\": \"value\"\n },\n \"profileAttribute\": {\n \"attributeName\": \"email\"\n },\n \"catalog\": {\n \"itemKey\": \"SKU123\"\n },\n \"recommendation\": {\n \"params\": {\n \"itemId\": \"item-123\"\n }\n }\n },\n \"slug\": \"_jO6_jO6\",\n \"name\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"httpStatus\": 8176,\n \"errorCode\": \"string\",\n \"timestamp\": \"2009-08-02T10:31:15.071Z\",\n \"message\": \"string\",\n \"traceId\": \"string\",\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"source\": {\n \"pointer\": \"string\",\n \"value\": \"string\"\n },\n \"details\": {\n \"key_0\": {}\n },\n \"field\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"c9113102-b4de-4fe7-a5cc-c11d4e120244","name":"Create or partially update record (async)","request":{"name":"Create or partially update record (async)","description":{"content":"This endpoint can only be used for simple schemas.\n\n- You can use this endpoint to update a record by sending only the fields which you want to change. Other fields are not affected.\n- This endpoint doesn't validate the data against field-specific settings, such as limits on character count or regex in a string field.\n\nAsynchronous requests are processed according to the time they reach the service. \nThis means that requests to synchronous endpoints may overwrite asynchronous operations which were sent earlier and queued due to high traffic.\n\nIn some edge cases, changing a record may fail further in the backend, even when this endpoint returns no errors. In such cases, contact Support.\n\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `BRICKWORKS_RECORDS_CREATE`\n\n**User role permission required:** `assets_brickworks: create`\n","type":"text/plain"},"url":{"path":["brickworks","v1","async","schemas",":SchemaIdentifier","record"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"44e5411f-17ee-ab70-9112-0c776aafa909","key":"SchemaIdentifier","description":"(Required) Schema identifier - can be a UUID (SchemaId) or a human-readable string (Schema AppId/API name, 3-25 characters)"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PATCH","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"identifier\": {\n \"name\": \"string\",\n \"value\": {\n \"value\": \"\"\n }\n },\n \"values\": {\n \"stringField\": \"example string\",\n \"numberField\": 123.45,\n \"integerField\": 42,\n \"booleanField\": true,\n \"dateField\": \"2024-01-15\",\n \"dateTimeField\": \"2024-01-15T10:30:00Z\",\n \"uuidField\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"arrayField\": [\n \"item1\",\n \"item2\"\n ],\n \"objectField\": {\n \"key\": \"value\"\n },\n \"profileAttribute\": {\n \"attributeName\": \"email\"\n },\n \"catalog\": {\n \"itemKey\": \"SKU123\"\n },\n \"recommendation\": {\n \"params\": {\n \"itemId\": \"item-123\"\n }\n }\n },\n \"slug\": \"_jO6_jO6\",\n \"name\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"c1b6b48d-9521-4a9a-b686-868c52fa57d4","name":"Operation added to queue","originalRequest":{"url":{"path":["brickworks","v1","async","schemas",":SchemaIdentifier","record"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"44e5411f-17ee-ab70-9112-0c776aafa909","key":"SchemaIdentifier","description":"(Required) Schema identifier - can be a UUID (SchemaId) or a human-readable string (Schema AppId/API name, 3-25 characters)"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"PATCH","body":{"mode":"raw","raw":"{\n \"identifier\": {\n \"name\": \"string\",\n \"value\": {\n \"value\": \"\"\n }\n },\n \"values\": {\n \"stringField\": \"example string\",\n \"numberField\": 123.45,\n \"integerField\": 42,\n \"booleanField\": true,\n \"dateField\": \"2024-01-15\",\n \"dateTimeField\": \"2024-01-15T10:30:00Z\",\n \"uuidField\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"arrayField\": [\n \"item1\",\n \"item2\"\n ],\n \"objectField\": {\n \"key\": \"value\"\n },\n \"profileAttribute\": {\n \"attributeName\": \"email\"\n },\n \"catalog\": {\n \"itemKey\": \"SKU123\"\n },\n \"recommendation\": {\n \"params\": {\n \"itemId\": \"item-123\"\n }\n }\n },\n \"slug\": \"_jO6_jO6\",\n \"name\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Created","code":201,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"80080d20-b55b-4084-919e-eea52704b88d","name":"Incorrect request (malformed JSON, wrong parameters, etc.). See error message for details.","originalRequest":{"url":{"path":["brickworks","v1","async","schemas",":SchemaIdentifier","record"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"44e5411f-17ee-ab70-9112-0c776aafa909","key":"SchemaIdentifier","description":"(Required) Schema identifier - can be a UUID (SchemaId) or a human-readable string (Schema AppId/API name, 3-25 characters)"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"{\n \"identifier\": {\n \"name\": \"string\",\n \"value\": {\n \"value\": \"\"\n }\n },\n \"values\": {\n \"stringField\": \"example string\",\n \"numberField\": 123.45,\n \"integerField\": 42,\n \"booleanField\": true,\n \"dateField\": \"2024-01-15\",\n \"dateTimeField\": \"2024-01-15T10:30:00Z\",\n \"uuidField\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"arrayField\": [\n \"item1\",\n \"item2\"\n ],\n \"objectField\": {\n \"key\": \"value\"\n },\n \"profileAttribute\": {\n \"attributeName\": \"email\"\n },\n \"catalog\": {\n \"itemKey\": \"SKU123\"\n },\n \"recommendation\": {\n \"params\": {\n \"itemId\": \"item-123\"\n }\n }\n },\n \"slug\": \"_jO6_jO6\",\n \"name\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"httpStatus\": 8176,\n \"errorCode\": \"string\",\n \"timestamp\": \"2009-08-02T10:31:15.071Z\",\n \"message\": \"string\",\n \"traceId\": \"string\",\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"source\": {\n \"pointer\": \"string\",\n \"value\": \"string\"\n },\n \"details\": {\n \"key_0\": {}\n },\n \"field\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"622e49f9-e72a-4c23-927d-f9df3722a63f","name":"Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc. See error message for details.","originalRequest":{"url":{"path":["brickworks","v1","async","schemas",":SchemaIdentifier","record"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"44e5411f-17ee-ab70-9112-0c776aafa909","key":"SchemaIdentifier","description":"(Required) Schema identifier - can be a UUID (SchemaId) or a human-readable string (Schema AppId/API name, 3-25 characters)"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"{\n \"identifier\": {\n \"name\": \"string\",\n \"value\": {\n \"value\": \"\"\n }\n },\n \"values\": {\n \"stringField\": \"example string\",\n \"numberField\": 123.45,\n \"integerField\": 42,\n \"booleanField\": true,\n \"dateField\": \"2024-01-15\",\n \"dateTimeField\": \"2024-01-15T10:30:00Z\",\n \"uuidField\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"arrayField\": [\n \"item1\",\n \"item2\"\n ],\n \"objectField\": {\n \"key\": \"value\"\n },\n \"profileAttribute\": {\n \"attributeName\": \"email\"\n },\n \"catalog\": {\n \"itemKey\": \"SKU123\"\n },\n \"recommendation\": {\n \"params\": {\n \"itemId\": \"item-123\"\n }\n }\n },\n \"slug\": \"_jO6_jO6\",\n \"name\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\",\n \"status\": 647,\n \"timestamp\": \"string\",\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"f57f8c29-5444-4c90-b1fb-f5322e4e7019","name":"Forbidden; insufficient permissions. See error message for details.","originalRequest":{"url":{"path":["brickworks","v1","async","schemas",":SchemaIdentifier","record"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"44e5411f-17ee-ab70-9112-0c776aafa909","key":"SchemaIdentifier","description":"(Required) Schema identifier - can be a UUID (SchemaId) or a human-readable string (Schema AppId/API name, 3-25 characters)"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"{\n \"identifier\": {\n \"name\": \"string\",\n \"value\": {\n \"value\": \"\"\n }\n },\n \"values\": {\n \"stringField\": \"example string\",\n \"numberField\": 123.45,\n \"integerField\": 42,\n \"booleanField\": true,\n \"dateField\": \"2024-01-15\",\n \"dateTimeField\": \"2024-01-15T10:30:00Z\",\n \"uuidField\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"arrayField\": [\n \"item1\",\n \"item2\"\n ],\n \"objectField\": {\n \"key\": \"value\"\n },\n \"profileAttribute\": {\n \"attributeName\": \"email\"\n },\n \"catalog\": {\n \"itemKey\": \"SKU123\"\n },\n \"recommendation\": {\n \"params\": {\n \"itemId\": \"item-123\"\n }\n }\n },\n \"slug\": \"_jO6_jO6\",\n \"name\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\",\n \"status\": 647,\n \"timestamp\": \"string\",\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"09aa405f-779a-42f7-beb3-bbd58db5ea2a","name":"Resource not found. See error message for details.","originalRequest":{"url":{"path":["brickworks","v1","async","schemas",":SchemaIdentifier","record"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"44e5411f-17ee-ab70-9112-0c776aafa909","key":"SchemaIdentifier","description":"(Required) Schema identifier - can be a UUID (SchemaId) or a human-readable string (Schema AppId/API name, 3-25 characters)"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"{\n \"identifier\": {\n \"name\": \"string\",\n \"value\": {\n \"value\": \"\"\n }\n },\n \"values\": {\n \"stringField\": \"example string\",\n \"numberField\": 123.45,\n \"integerField\": 42,\n \"booleanField\": true,\n \"dateField\": \"2024-01-15\",\n \"dateTimeField\": \"2024-01-15T10:30:00Z\",\n \"uuidField\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"arrayField\": [\n \"item1\",\n \"item2\"\n ],\n \"objectField\": {\n \"key\": \"value\"\n },\n \"profileAttribute\": {\n \"attributeName\": \"email\"\n },\n \"catalog\": {\n \"itemKey\": \"SKU123\"\n },\n \"recommendation\": {\n \"params\": {\n \"itemId\": \"item-123\"\n }\n }\n },\n \"slug\": \"_jO6_jO6\",\n \"name\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"httpStatus\": 8176,\n \"errorCode\": \"string\",\n \"timestamp\": \"2009-08-02T10:31:15.071Z\",\n \"message\": \"string\",\n \"traceId\": \"string\",\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"source\": {\n \"pointer\": \"string\",\n \"value\": \"string\"\n },\n \"details\": {\n \"key_0\": {}\n },\n \"field\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"ea44d311-26a1-4882-bf8e-15ea95601cbb","name":"The request could not be completed due to a conflict with the current state of the resource. See error message for details.","originalRequest":{"url":{"path":["brickworks","v1","async","schemas",":SchemaIdentifier","record"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"44e5411f-17ee-ab70-9112-0c776aafa909","key":"SchemaIdentifier","description":"(Required) Schema identifier - can be a UUID (SchemaId) or a human-readable string (Schema AppId/API name, 3-25 characters)"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"{\n \"identifier\": {\n \"name\": \"string\",\n \"value\": {\n \"value\": \"\"\n }\n },\n \"values\": {\n \"stringField\": \"example string\",\n \"numberField\": 123.45,\n \"integerField\": 42,\n \"booleanField\": true,\n \"dateField\": \"2024-01-15\",\n \"dateTimeField\": \"2024-01-15T10:30:00Z\",\n \"uuidField\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"arrayField\": [\n \"item1\",\n \"item2\"\n ],\n \"objectField\": {\n \"key\": \"value\"\n },\n \"profileAttribute\": {\n \"attributeName\": \"email\"\n },\n \"catalog\": {\n \"itemKey\": \"SKU123\"\n },\n \"recommendation\": {\n \"params\": {\n \"itemId\": \"item-123\"\n }\n }\n },\n \"slug\": \"_jO6_jO6\",\n \"name\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Conflict","code":409,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"httpStatus\": 8176,\n \"errorCode\": \"string\",\n \"timestamp\": \"2009-08-02T10:31:15.071Z\",\n \"message\": \"string\",\n \"traceId\": \"string\",\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"source\": {\n \"pointer\": \"string\",\n \"value\": \"string\"\n },\n \"details\": {\n \"key_0\": {}\n },\n \"field\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"c074c279-a3ef-40cf-ae32-629e97736620","name":"The request was well-formed but could not be processed due to semantic or domain-related constraints. See error message for details.","originalRequest":{"url":{"path":["brickworks","v1","async","schemas",":SchemaIdentifier","record"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"44e5411f-17ee-ab70-9112-0c776aafa909","key":"SchemaIdentifier","description":"(Required) Schema identifier - can be a UUID (SchemaId) or a human-readable string (Schema AppId/API name, 3-25 characters)"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"{\n \"identifier\": {\n \"name\": \"string\",\n \"value\": {\n \"value\": \"\"\n }\n },\n \"values\": {\n \"stringField\": \"example string\",\n \"numberField\": 123.45,\n \"integerField\": 42,\n \"booleanField\": true,\n \"dateField\": \"2024-01-15\",\n \"dateTimeField\": \"2024-01-15T10:30:00Z\",\n \"uuidField\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"arrayField\": [\n \"item1\",\n \"item2\"\n ],\n \"objectField\": {\n \"key\": \"value\"\n },\n \"profileAttribute\": {\n \"attributeName\": \"email\"\n },\n \"catalog\": {\n \"itemKey\": \"SKU123\"\n },\n \"recommendation\": {\n \"params\": {\n \"itemId\": \"item-123\"\n }\n }\n },\n \"slug\": \"_jO6_jO6\",\n \"name\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"httpStatus\": 8176,\n \"errorCode\": \"string\",\n \"timestamp\": \"2009-08-02T10:31:15.071Z\",\n \"message\": \"string\",\n \"traceId\": \"string\",\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"source\": {\n \"pointer\": \"string\",\n \"value\": \"string\"\n },\n \"details\": {\n \"key_0\": {}\n },\n \"field\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"e2d68333-9f1f-421b-b0c6-44d48a496388","name":"See error message for details.","originalRequest":{"url":{"path":["brickworks","v1","async","schemas",":SchemaIdentifier","record"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"44e5411f-17ee-ab70-9112-0c776aafa909","key":"SchemaIdentifier","description":"(Required) Schema identifier - can be a UUID (SchemaId) or a human-readable string (Schema AppId/API name, 3-25 characters)"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"{\n \"identifier\": {\n \"name\": \"string\",\n \"value\": {\n \"value\": \"\"\n }\n },\n \"values\": {\n \"stringField\": \"example string\",\n \"numberField\": 123.45,\n \"integerField\": 42,\n \"booleanField\": true,\n \"dateField\": \"2024-01-15\",\n \"dateTimeField\": \"2024-01-15T10:30:00Z\",\n \"uuidField\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"arrayField\": [\n \"item1\",\n \"item2\"\n ],\n \"objectField\": {\n \"key\": \"value\"\n },\n \"profileAttribute\": {\n \"attributeName\": \"email\"\n },\n \"catalog\": {\n \"itemKey\": \"SKU123\"\n },\n \"recommendation\": {\n \"params\": {\n \"itemId\": \"item-123\"\n }\n }\n },\n \"slug\": \"_jO6_jO6\",\n \"name\": \"string\"\n}","options":{"raw":{"language":"json"}}}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"httpStatus\": 8176,\n \"errorCode\": \"string\",\n \"timestamp\": \"2009-08-02T10:31:15.071Z\",\n \"message\": \"string\",\n \"traceId\": \"string\",\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"source\": {\n \"pointer\": \"string\",\n \"value\": \"string\"\n },\n \"details\": {\n \"key_0\": {}\n },\n \"field\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}],"event":[]},{"id":"3507c9e5-fc92-41f2-9bbe-ec5ef60282dc","name":"Brickworks: Content generation","description":{"content":"","type":"text/plain"},"item":[{"id":"60fc9c3f-5d81-43ab-9446-04ce90168b3d","name":"Generate object from a record (as workspace)","request":{"name":"Generate object from a record (as workspace)","description":{"content":"Generate content from the latest **published version of a record** by processing Jinjava inserts and requests to external sources. Profile data (if needed, for example for Jinjava) is retrieved automatically from the profile declared in the request.\n\nThe system looks for values to generate in the following order:\n\n 1. Values in the `fieldContext` object (used by recommendations and relations).\n 1. Values saved in the record.\n 2. Values from the `default` object in the schema. \n This is available for all field types. \n 3. Default values nested in the `properties` of a field in the schema. \n This is available for some complex field types. \n\n\nThe content is always generated according to the latest version of a schema:\n - If fields were deleted from the schema, but they still exist in the record, they are ignored.\n - If fields were added to the schema and they don't exist in the record, their default values are added. If there are no default values, the fields are ignored.\n\nSome data is cached:\n- profile data (even if the profile is updated)\n- responses from external sources \nFor details, see the [User Guide](https://hub.synerise.com/docs/assets/brickworks/limits).\n\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `BRICKWORKS_RECORDS_READ`\n\n**User role permission required:** `assets_brickworks: read`\n","type":"text/plain"},"url":{"path":["brickworks","v1","schemas",":SchemaIdentifier","records",":RecordIdentifier","generate","by",":IdentifierType"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"44e5411f-17ee-ab70-9112-0c776aafa909","key":"SchemaIdentifier","description":"(Required) Schema identifier - can be a UUID (SchemaId) or a human-readable string (Schema AppId/API name, 3-25 characters)"},{"disabled":false,"type":"any","value":"10cc476e-4cea-1124-9ba2-805e59214048","key":"RecordIdentifier","description":"(Required) Record identifier - can be a UUID (RecordId) or a human-readable slug (RecordSlug, 6-40 characters)"},{"disabled":false,"type":"any","value":"uuid","key":"IdentifierType","description":"(Required) Profile identifier type"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"identifierValue\": \"string\",\n \"context\": {\n \"key_0\": {\n \"value\": \"\"\n }\n },\n \"fieldContext\": {\n \"key_0\": {\n \"value\": \"\"\n }\n }\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"0b0effeb-5568-4a9d-aa4a-bfbe7ee21d41","name":"Processed content of a record","originalRequest":{"url":{"path":["brickworks","v1","schemas",":SchemaIdentifier","records",":RecordIdentifier","generate","by",":IdentifierType"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"44e5411f-17ee-ab70-9112-0c776aafa909","key":"SchemaIdentifier","description":"(Required) Schema identifier - can be a UUID (SchemaId) or a human-readable string (Schema AppId/API name, 3-25 characters)"},{"disabled":false,"type":"any","value":"10cc476e-4cea-1124-9ba2-805e59214048","key":"RecordIdentifier","description":"(Required) Record identifier - can be a UUID (RecordId) or a human-readable slug (RecordSlug, 6-40 characters)"},{"disabled":false,"type":"any","value":"uuid","key":"IdentifierType","description":"(Required) Profile identifier type"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"identifierValue\": \"string\",\n \"context\": {\n \"key_0\": {\n \"value\": \"\"\n }\n },\n \"fieldContext\": {\n \"key_0\": {\n \"value\": \"\"\n }\n }\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"__slug\": \"my-record-slug\",\n \"__recordVersion\": 1,\n \"__publishedAt\": \"2024-01-15T10:30:00Z\",\n \"__updatedAt\": \"2024-01-15T10:30:00Z\",\n \"__schemaId\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"__id\": \"550e8400-e29b-41d4-a716-446655440001\",\n \"__schemaVersion\": 1,\n \"__createdAt\": \"2024-01-15T10:30:00Z\",\n \"customStringField\": \"string value\",\n \"customNumberField\": 123.45,\n \"customBooleanField\": true,\n \"customDateField\": \"2024-01-15\",\n \"customArrayField\": [\n \"item1\",\n \"item2\"\n ],\n \"customObjectField\": {\n \"nestedKey\": \"nestedValue\"\n },\n \"__matchedAudience\": true,\n \"__unmatchedAudienceRelations\": [\n \"deniedRefField\"\n ],\n \"__personalizationVariants\": [\n \".refField.variant_a\"\n ],\n \"__personalizationSegments\": {\n \"550e8400-e29b-41d4-a716-446655440002\": true,\n \"550e8400-e29b-41d4-a716-446655440003\": false\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"a7525fe5-2f36-4a97-8e51-9d5fbdb96e68","name":"Incorrect request (malformed JSON, wrong parameters, etc.). See error message for details.","originalRequest":{"url":{"path":["brickworks","v1","schemas",":SchemaIdentifier","records",":RecordIdentifier","generate","by",":IdentifierType"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"44e5411f-17ee-ab70-9112-0c776aafa909","key":"SchemaIdentifier","description":"(Required) Schema identifier - can be a UUID (SchemaId) or a human-readable string (Schema AppId/API name, 3-25 characters)"},{"disabled":false,"type":"any","value":"10cc476e-4cea-1124-9ba2-805e59214048","key":"RecordIdentifier","description":"(Required) Record identifier - can be a UUID (RecordId) or a human-readable slug (RecordSlug, 6-40 characters)"},{"disabled":false,"type":"any","value":"uuid","key":"IdentifierType","description":"(Required) Profile identifier type"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"identifierValue\": \"string\",\n \"context\": {\n \"key_0\": {\n \"value\": \"\"\n }\n },\n \"fieldContext\": {\n \"key_0\": {\n \"value\": \"\"\n }\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"httpStatus\": 8176,\n \"errorCode\": \"string\",\n \"timestamp\": \"2009-08-02T10:31:15.071Z\",\n \"message\": \"string\",\n \"traceId\": \"string\",\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"source\": {\n \"pointer\": \"string\",\n \"value\": \"string\"\n },\n \"details\": {\n \"key_0\": {}\n },\n \"field\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"72a561fd-c825-4bd8-9edd-4017549d1a28","name":"Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc. See error message for details.","originalRequest":{"url":{"path":["brickworks","v1","schemas",":SchemaIdentifier","records",":RecordIdentifier","generate","by",":IdentifierType"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"44e5411f-17ee-ab70-9112-0c776aafa909","key":"SchemaIdentifier","description":"(Required) Schema identifier - can be a UUID (SchemaId) or a human-readable string (Schema AppId/API name, 3-25 characters)"},{"disabled":false,"type":"any","value":"10cc476e-4cea-1124-9ba2-805e59214048","key":"RecordIdentifier","description":"(Required) Record identifier - can be a UUID (RecordId) or a human-readable slug (RecordSlug, 6-40 characters)"},{"disabled":false,"type":"any","value":"uuid","key":"IdentifierType","description":"(Required) Profile identifier type"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"identifierValue\": \"string\",\n \"context\": {\n \"key_0\": {\n \"value\": \"\"\n }\n },\n \"fieldContext\": {\n \"key_0\": {\n \"value\": \"\"\n }\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\",\n \"status\": 647,\n \"timestamp\": \"string\",\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"833dcf2d-85df-4e3d-afe7-411c1cf2c3c7","name":"Forbidden; insufficient permissions. See error message for details.","originalRequest":{"url":{"path":["brickworks","v1","schemas",":SchemaIdentifier","records",":RecordIdentifier","generate","by",":IdentifierType"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"44e5411f-17ee-ab70-9112-0c776aafa909","key":"SchemaIdentifier","description":"(Required) Schema identifier - can be a UUID (SchemaId) or a human-readable string (Schema AppId/API name, 3-25 characters)"},{"disabled":false,"type":"any","value":"10cc476e-4cea-1124-9ba2-805e59214048","key":"RecordIdentifier","description":"(Required) Record identifier - can be a UUID (RecordId) or a human-readable slug (RecordSlug, 6-40 characters)"},{"disabled":false,"type":"any","value":"uuid","key":"IdentifierType","description":"(Required) Profile identifier type"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"identifierValue\": \"string\",\n \"context\": {\n \"key_0\": {\n \"value\": \"\"\n }\n },\n \"fieldContext\": {\n \"key_0\": {\n \"value\": \"\"\n }\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\",\n \"status\": 647,\n \"timestamp\": \"string\",\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"0774a21c-3eee-49d4-906b-5235cbd221dc","name":"Resource not found. See error message for details.","originalRequest":{"url":{"path":["brickworks","v1","schemas",":SchemaIdentifier","records",":RecordIdentifier","generate","by",":IdentifierType"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"44e5411f-17ee-ab70-9112-0c776aafa909","key":"SchemaIdentifier","description":"(Required) Schema identifier - can be a UUID (SchemaId) or a human-readable string (Schema AppId/API name, 3-25 characters)"},{"disabled":false,"type":"any","value":"10cc476e-4cea-1124-9ba2-805e59214048","key":"RecordIdentifier","description":"(Required) Record identifier - can be a UUID (RecordId) or a human-readable slug (RecordSlug, 6-40 characters)"},{"disabled":false,"type":"any","value":"uuid","key":"IdentifierType","description":"(Required) Profile identifier type"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"identifierValue\": \"string\",\n \"context\": {\n \"key_0\": {\n \"value\": \"\"\n }\n },\n \"fieldContext\": {\n \"key_0\": {\n \"value\": \"\"\n }\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"httpStatus\": 8176,\n \"errorCode\": \"string\",\n \"timestamp\": \"2009-08-02T10:31:15.071Z\",\n \"message\": \"string\",\n \"traceId\": \"string\",\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"source\": {\n \"pointer\": \"string\",\n \"value\": \"string\"\n },\n \"details\": {\n \"key_0\": {}\n },\n \"field\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"080ea3fa-b444-4bd1-9499-3c861c4a5df4","name":"The request could not be completed due to a conflict with the current state of the resource. See error message for details.","originalRequest":{"url":{"path":["brickworks","v1","schemas",":SchemaIdentifier","records",":RecordIdentifier","generate","by",":IdentifierType"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"44e5411f-17ee-ab70-9112-0c776aafa909","key":"SchemaIdentifier","description":"(Required) Schema identifier - can be a UUID (SchemaId) or a human-readable string (Schema AppId/API name, 3-25 characters)"},{"disabled":false,"type":"any","value":"10cc476e-4cea-1124-9ba2-805e59214048","key":"RecordIdentifier","description":"(Required) Record identifier - can be a UUID (RecordId) or a human-readable slug (RecordSlug, 6-40 characters)"},{"disabled":false,"type":"any","value":"uuid","key":"IdentifierType","description":"(Required) Profile identifier type"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"identifierValue\": \"string\",\n \"context\": {\n \"key_0\": {\n \"value\": \"\"\n }\n },\n \"fieldContext\": {\n \"key_0\": {\n \"value\": \"\"\n }\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Conflict","code":409,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"httpStatus\": 8176,\n \"errorCode\": \"string\",\n \"timestamp\": \"2009-08-02T10:31:15.071Z\",\n \"message\": \"string\",\n \"traceId\": \"string\",\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"source\": {\n \"pointer\": \"string\",\n \"value\": \"string\"\n },\n \"details\": {\n \"key_0\": {}\n },\n \"field\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"a5622187-9243-4d53-b814-19e180f02873","name":"The request was well-formed but could not be processed due to semantic or domain-related constraints. See error message for details.","originalRequest":{"url":{"path":["brickworks","v1","schemas",":SchemaIdentifier","records",":RecordIdentifier","generate","by",":IdentifierType"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"44e5411f-17ee-ab70-9112-0c776aafa909","key":"SchemaIdentifier","description":"(Required) Schema identifier - can be a UUID (SchemaId) or a human-readable string (Schema AppId/API name, 3-25 characters)"},{"disabled":false,"type":"any","value":"10cc476e-4cea-1124-9ba2-805e59214048","key":"RecordIdentifier","description":"(Required) Record identifier - can be a UUID (RecordId) or a human-readable slug (RecordSlug, 6-40 characters)"},{"disabled":false,"type":"any","value":"uuid","key":"IdentifierType","description":"(Required) Profile identifier type"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"identifierValue\": \"string\",\n \"context\": {\n \"key_0\": {\n \"value\": \"\"\n }\n },\n \"fieldContext\": {\n \"key_0\": {\n \"value\": \"\"\n }\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"httpStatus\": 8176,\n \"errorCode\": \"string\",\n \"timestamp\": \"2009-08-02T10:31:15.071Z\",\n \"message\": \"string\",\n \"traceId\": \"string\",\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"source\": {\n \"pointer\": \"string\",\n \"value\": \"string\"\n },\n \"details\": {\n \"key_0\": {}\n },\n \"field\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"f596e71c-1c25-4a20-9de9-d638fdd3f9bd","name":"See error message for details.","originalRequest":{"url":{"path":["brickworks","v1","schemas",":SchemaIdentifier","records",":RecordIdentifier","generate","by",":IdentifierType"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"44e5411f-17ee-ab70-9112-0c776aafa909","key":"SchemaIdentifier","description":"(Required) Schema identifier - can be a UUID (SchemaId) or a human-readable string (Schema AppId/API name, 3-25 characters)"},{"disabled":false,"type":"any","value":"10cc476e-4cea-1124-9ba2-805e59214048","key":"RecordIdentifier","description":"(Required) Record identifier - can be a UUID (RecordId) or a human-readable slug (RecordSlug, 6-40 characters)"},{"disabled":false,"type":"any","value":"uuid","key":"IdentifierType","description":"(Required) Profile identifier type"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"identifierValue\": \"string\",\n \"context\": {\n \"key_0\": {\n \"value\": \"\"\n }\n },\n \"fieldContext\": {\n \"key_0\": {\n \"value\": \"\"\n }\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"httpStatus\": 8176,\n \"errorCode\": \"string\",\n \"timestamp\": \"2009-08-02T10:31:15.071Z\",\n \"message\": \"string\",\n \"traceId\": \"string\",\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"source\": {\n \"pointer\": \"string\",\n \"value\": \"string\"\n },\n \"details\": {\n \"key_0\": {}\n },\n \"field\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"45addeef-6c7a-4c84-b520-ff57cd2e5dc5","name":"Generate object from a record (as any consumer)","request":{"name":"Generate object from a record (as any consumer)","description":{"content":"Generate content from the latest **published version of a record** by processing Jinjava inserts and requests to external sources. \nIf the request is authorized by a profile, the profile data is automatically retrieve for fields which need it (for example, in Jinjava inserts).\n\nThe system looks for values to generate in the following order:\n\n 1. Values in the `fieldContext` object (used by recommendations and relations).\n 1. Values saved in the record.\n 2. Values from the `default` object in the schema. \n This is available for all field types. \n 3. Default values nested in the `properties` of a field in the schema. \n This is available for some complex field types. \n\n\nThe content is always generated according to the latest version of a schema:\n - If fields were deleted from the schema, but they still exist in the record, they are ignored.\n - If fields were added to the schema and they don't exist in the record, their default values are added. If there are no default values, the fields are ignored.\n\nSome data is cached:\n- profile data (even if the profile is updated)\n- responses from external sources \nFor details, see the [User Guide](https://hub.synerise.com/docs/assets/brickworks/limits).\n\n\n---\n\n**API consumers:** Profile (Client), Anonymous Profile, Workspace (Business Profile), Synerise User\n\n**API key permission required:** `BRICKWORKS_RECORDS_READ`\n\n**User role permission required:** `assets_brickworks: read`\n","type":"text/plain"},"url":{"path":["brickworks","v1","schemas",":SchemaIdentifier","records",":RecordIdentifier","generate"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"44e5411f-17ee-ab70-9112-0c776aafa909","key":"SchemaIdentifier","description":"(Required) Schema identifier - can be a UUID (SchemaId) or a human-readable string (Schema AppId/API name, 3-25 characters)"},{"disabled":false,"type":"any","value":"10cc476e-4cea-1124-9ba2-805e59214048","key":"RecordIdentifier","description":"(Required) Record identifier - can be a UUID (RecordId) or a human-readable slug (RecordSlug, 6-40 characters)"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"context\": {\n \"key_0\": {\n \"value\": \"\"\n }\n },\n \"fieldContext\": {\n \"key_0\": {\n \"value\": \"\"\n }\n }\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"2dfc9225-cacf-4802-8954-87a15c778d31","name":"Processed content of a record","originalRequest":{"url":{"path":["brickworks","v1","schemas",":SchemaIdentifier","records",":RecordIdentifier","generate"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"44e5411f-17ee-ab70-9112-0c776aafa909","key":"SchemaIdentifier","description":"(Required) Schema identifier - can be a UUID (SchemaId) or a human-readable string (Schema AppId/API name, 3-25 characters)"},{"disabled":false,"type":"any","value":"10cc476e-4cea-1124-9ba2-805e59214048","key":"RecordIdentifier","description":"(Required) Record identifier - can be a UUID (RecordId) or a human-readable slug (RecordSlug, 6-40 characters)"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"context\": {\n \"key_0\": {\n \"value\": \"\"\n }\n },\n \"fieldContext\": {\n \"key_0\": {\n \"value\": \"\"\n }\n }\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"__slug\": \"_FfZQsAFUiqE\",\n \"__recordVersion\": 6297.904677900221,\n \"__publishedAt\": \"2005-10-15T07:08:23.444Z\",\n \"__updatedAt\": \"2011-12-07T19:44:19.865Z\",\n \"__schemaId\": \"991a2dc7-901a-8b05-c4fd-b3bcfe802d95\",\n \"__id\": \"5b643d0b-4d41-1d3c-a780-3b01db5d0f08\",\n \"__schemaVersion\": 1105,\n \"__createdAt\": \"2010-04-28T10:27:21.207Z\",\n \"__matchedAudience\": false,\n \"__unmatchedAudienceRelations\": [\n \"string\",\n \"string\"\n ],\n \"__personalizationVariants\": [\n \"string\",\n \"string\"\n ],\n \"__personalizationSegments\": {\n \"key_0\": true,\n \"key_1\": true\n },\n \"__logs\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"71526494-7310-458a-8fdd-c6469ecc4d92","name":"Incorrect request (malformed JSON, wrong parameters, etc.). See error message for details.","originalRequest":{"url":{"path":["brickworks","v1","schemas",":SchemaIdentifier","records",":RecordIdentifier","generate"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"44e5411f-17ee-ab70-9112-0c776aafa909","key":"SchemaIdentifier","description":"(Required) Schema identifier - can be a UUID (SchemaId) or a human-readable string (Schema AppId/API name, 3-25 characters)"},{"disabled":false,"type":"any","value":"10cc476e-4cea-1124-9ba2-805e59214048","key":"RecordIdentifier","description":"(Required) Record identifier - can be a UUID (RecordId) or a human-readable slug (RecordSlug, 6-40 characters)"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"context\": {\n \"key_0\": {\n \"value\": \"\"\n }\n },\n \"fieldContext\": {\n \"key_0\": {\n \"value\": \"\"\n }\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"httpStatus\": 8176,\n \"errorCode\": \"string\",\n \"timestamp\": \"2009-08-02T10:31:15.071Z\",\n \"message\": \"string\",\n \"traceId\": \"string\",\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"source\": {\n \"pointer\": \"string\",\n \"value\": \"string\"\n },\n \"details\": {\n \"key_0\": {}\n },\n \"field\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"5606a8ef-35a2-436e-9e43-df69060702d5","name":"Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc. See error message for details.","originalRequest":{"url":{"path":["brickworks","v1","schemas",":SchemaIdentifier","records",":RecordIdentifier","generate"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"44e5411f-17ee-ab70-9112-0c776aafa909","key":"SchemaIdentifier","description":"(Required) Schema identifier - can be a UUID (SchemaId) or a human-readable string (Schema AppId/API name, 3-25 characters)"},{"disabled":false,"type":"any","value":"10cc476e-4cea-1124-9ba2-805e59214048","key":"RecordIdentifier","description":"(Required) Record identifier - can be a UUID (RecordId) or a human-readable slug (RecordSlug, 6-40 characters)"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"context\": {\n \"key_0\": {\n \"value\": \"\"\n }\n },\n \"fieldContext\": {\n \"key_0\": {\n \"value\": \"\"\n }\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\",\n \"status\": 647,\n \"timestamp\": \"string\",\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"2ed7f98c-193c-4fdb-a05d-4b5e87027306","name":"Forbidden; insufficient permissions. See error message for details.","originalRequest":{"url":{"path":["brickworks","v1","schemas",":SchemaIdentifier","records",":RecordIdentifier","generate"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"44e5411f-17ee-ab70-9112-0c776aafa909","key":"SchemaIdentifier","description":"(Required) Schema identifier - can be a UUID (SchemaId) or a human-readable string (Schema AppId/API name, 3-25 characters)"},{"disabled":false,"type":"any","value":"10cc476e-4cea-1124-9ba2-805e59214048","key":"RecordIdentifier","description":"(Required) Record identifier - can be a UUID (RecordId) or a human-readable slug (RecordSlug, 6-40 characters)"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"context\": {\n \"key_0\": {\n \"value\": \"\"\n }\n },\n \"fieldContext\": {\n \"key_0\": {\n \"value\": \"\"\n }\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\",\n \"status\": 647,\n \"timestamp\": \"string\",\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"923dbca0-f3bc-400a-b9df-7081b84d414b","name":"Resource not found. See error message for details.","originalRequest":{"url":{"path":["brickworks","v1","schemas",":SchemaIdentifier","records",":RecordIdentifier","generate"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"44e5411f-17ee-ab70-9112-0c776aafa909","key":"SchemaIdentifier","description":"(Required) Schema identifier - can be a UUID (SchemaId) or a human-readable string (Schema AppId/API name, 3-25 characters)"},{"disabled":false,"type":"any","value":"10cc476e-4cea-1124-9ba2-805e59214048","key":"RecordIdentifier","description":"(Required) Record identifier - can be a UUID (RecordId) or a human-readable slug (RecordSlug, 6-40 characters)"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"context\": {\n \"key_0\": {\n \"value\": \"\"\n }\n },\n \"fieldContext\": {\n \"key_0\": {\n \"value\": \"\"\n }\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"httpStatus\": 8176,\n \"errorCode\": \"string\",\n \"timestamp\": \"2009-08-02T10:31:15.071Z\",\n \"message\": \"string\",\n \"traceId\": \"string\",\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"source\": {\n \"pointer\": \"string\",\n \"value\": \"string\"\n },\n \"details\": {\n \"key_0\": {}\n },\n \"field\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"cb0bed9d-462b-441f-9267-bf4bfd37c976","name":"The request could not be completed due to a conflict with the current state of the resource. See error message for details.","originalRequest":{"url":{"path":["brickworks","v1","schemas",":SchemaIdentifier","records",":RecordIdentifier","generate"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"44e5411f-17ee-ab70-9112-0c776aafa909","key":"SchemaIdentifier","description":"(Required) Schema identifier - can be a UUID (SchemaId) or a human-readable string (Schema AppId/API name, 3-25 characters)"},{"disabled":false,"type":"any","value":"10cc476e-4cea-1124-9ba2-805e59214048","key":"RecordIdentifier","description":"(Required) Record identifier - can be a UUID (RecordId) or a human-readable slug (RecordSlug, 6-40 characters)"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"context\": {\n \"key_0\": {\n \"value\": \"\"\n }\n },\n \"fieldContext\": {\n \"key_0\": {\n \"value\": \"\"\n }\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Conflict","code":409,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"httpStatus\": 8176,\n \"errorCode\": \"string\",\n \"timestamp\": \"2009-08-02T10:31:15.071Z\",\n \"message\": \"string\",\n \"traceId\": \"string\",\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"source\": {\n \"pointer\": \"string\",\n \"value\": \"string\"\n },\n \"details\": {\n \"key_0\": {}\n },\n \"field\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"90b7c179-fa51-4e99-a42f-6abfe117f5bb","name":"The request was well-formed but could not be processed due to semantic or domain-related constraints. See error message for details.","originalRequest":{"url":{"path":["brickworks","v1","schemas",":SchemaIdentifier","records",":RecordIdentifier","generate"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"44e5411f-17ee-ab70-9112-0c776aafa909","key":"SchemaIdentifier","description":"(Required) Schema identifier - can be a UUID (SchemaId) or a human-readable string (Schema AppId/API name, 3-25 characters)"},{"disabled":false,"type":"any","value":"10cc476e-4cea-1124-9ba2-805e59214048","key":"RecordIdentifier","description":"(Required) Record identifier - can be a UUID (RecordId) or a human-readable slug (RecordSlug, 6-40 characters)"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"context\": {\n \"key_0\": {\n \"value\": \"\"\n }\n },\n \"fieldContext\": {\n \"key_0\": {\n \"value\": \"\"\n }\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"httpStatus\": 8176,\n \"errorCode\": \"string\",\n \"timestamp\": \"2009-08-02T10:31:15.071Z\",\n \"message\": \"string\",\n \"traceId\": \"string\",\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"source\": {\n \"pointer\": \"string\",\n \"value\": \"string\"\n },\n \"details\": {\n \"key_0\": {}\n },\n \"field\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"c98f356c-464c-4e7b-b029-5ed811d18abe","name":"See error message for details.","originalRequest":{"url":{"path":["brickworks","v1","schemas",":SchemaIdentifier","records",":RecordIdentifier","generate"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"44e5411f-17ee-ab70-9112-0c776aafa909","key":"SchemaIdentifier","description":"(Required) Schema identifier - can be a UUID (SchemaId) or a human-readable string (Schema AppId/API name, 3-25 characters)"},{"disabled":false,"type":"any","value":"10cc476e-4cea-1124-9ba2-805e59214048","key":"RecordIdentifier","description":"(Required) Record identifier - can be a UUID (RecordId) or a human-readable slug (RecordSlug, 6-40 characters)"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"context\": {\n \"key_0\": {\n \"value\": \"\"\n }\n },\n \"fieldContext\": {\n \"key_0\": {\n \"value\": \"\"\n }\n }\n}","options":{"raw":{"language":"json"}}}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"httpStatus\": 8176,\n \"errorCode\": \"string\",\n \"timestamp\": \"2009-08-02T10:31:15.071Z\",\n \"message\": \"string\",\n \"traceId\": \"string\",\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"source\": {\n \"pointer\": \"string\",\n \"value\": \"string\"\n },\n \"details\": {\n \"key_0\": {}\n },\n \"field\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}],"event":[]},{"id":"ba1ff852-fbdc-47c9-a6e7-923a6a1fe383","name":"Brickworks: External sources","description":{"content":"","type":"text/plain"},"item":[{"id":"60832d9e-b340-4782-b991-5c93c75c9298","name":"Create external source","request":{"name":"Create external source","description":{"content":"Create an external data source definition. External sources can be used as a special schema field to retrieve data from a given URL when generating an object from a record.\n\nBefore starting, make sure you have a [connection](https://hub.synerise.com/docs/settings/tool/connections/) which you can use in the external source definition.\n\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `BRICKWORKS_EXTERNALSOURCES_CREATE`\n\n**User role permission required:** `assets_brickworks: create`\n","type":"text/plain"},"url":{"path":["brickworks","v1","external-sources"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"name\": \"string\",\n \"properties\": {\n \"sourceType\": {\n \"value\": \"\"\n },\n \"url\": {\n \"value\": \"\"\n },\n \"method\": {\n \"value\": \"\"\n },\n \"headers\": {\n \"value\": \"\"\n },\n \"params\": {\n \"value\": \"\"\n },\n \"authType\": {\n \"value\": \"\"\n },\n \"authId\": {\n \"value\": \"\"\n },\n \"body\": {\n \"value\": \"\"\n },\n \"bodySchema\": {\n \"value\": \"\"\n }\n },\n \"description\": \"string\",\n \"ttl\": 2003.971659615339\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"9b4097f3-b266-48bb-9665-6f37541bd104","name":"External Data Source created","originalRequest":{"url":{"path":["brickworks","v1","external-sources"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"name\": \"string\",\n \"properties\": {\n \"sourceType\": {\n \"value\": \"\"\n },\n \"url\": {\n \"value\": \"\"\n },\n \"method\": {\n \"value\": \"\"\n },\n \"headers\": {\n \"value\": \"\"\n },\n \"params\": {\n \"value\": \"\"\n },\n \"authType\": {\n \"value\": \"\"\n },\n \"authId\": {\n \"value\": \"\"\n },\n \"body\": {\n \"value\": \"\"\n },\n \"bodySchema\": {\n \"value\": \"\"\n }\n },\n \"description\": \"string\",\n \"ttl\": 2003.971659615339\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"id\": \"4eb88c17-054b-a650-ce5f-7731219cba79\",\n \"name\": \"string\",\n \"properties\": {\n \"sourceType\": {\n \"value\": \"\"\n },\n \"url\": {\n \"value\": \"\"\n },\n \"method\": {\n \"value\": \"\"\n },\n \"headers\": {\n \"value\": \"\"\n },\n \"params\": {\n \"value\": \"\"\n },\n \"authType\": {\n \"value\": \"\"\n },\n \"authId\": {\n \"value\": \"\"\n },\n \"body\": {\n \"value\": \"\"\n },\n \"bodySchema\": {\n \"value\": \"\"\n }\n },\n \"createdBy\": 7402,\n \"createdAt\": \"1966-07-08T19:39:38.991Z\",\n \"updatedAt\": \"1962-11-18T05:22:16.813Z\",\n \"description\": \"string\",\n \"updatedBy\": 750,\n \"ttl\": 5526.728210075868\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"fff66955-4ff8-4dbe-8028-5e35f042dbc6","name":"Incorrect request (malformed JSON, wrong parameters, etc.). See error message for details.","originalRequest":{"url":{"path":["brickworks","v1","external-sources"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"name\": \"string\",\n \"properties\": {\n \"sourceType\": {\n \"value\": \"\"\n },\n \"url\": {\n \"value\": \"\"\n },\n \"method\": {\n \"value\": \"\"\n },\n \"headers\": {\n \"value\": \"\"\n },\n \"params\": {\n \"value\": \"\"\n },\n \"authType\": {\n \"value\": \"\"\n },\n \"authId\": {\n \"value\": \"\"\n },\n \"body\": {\n \"value\": \"\"\n },\n \"bodySchema\": {\n \"value\": \"\"\n }\n },\n \"description\": \"string\",\n \"ttl\": 2003.971659615339\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"httpStatus\": 8176,\n \"errorCode\": \"string\",\n \"timestamp\": \"2009-08-02T10:31:15.071Z\",\n \"message\": \"string\",\n \"traceId\": \"string\",\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"source\": {\n \"pointer\": \"string\",\n \"value\": \"string\"\n },\n \"details\": {\n \"key_0\": {}\n },\n \"field\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"f6a41f6d-f8a7-4868-a349-89e99606cfda","name":"Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc. See error message for details.","originalRequest":{"url":{"path":["brickworks","v1","external-sources"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"name\": \"string\",\n \"properties\": {\n \"sourceType\": {\n \"value\": \"\"\n },\n \"url\": {\n \"value\": \"\"\n },\n \"method\": {\n \"value\": \"\"\n },\n \"headers\": {\n \"value\": \"\"\n },\n \"params\": {\n \"value\": \"\"\n },\n \"authType\": {\n \"value\": \"\"\n },\n \"authId\": {\n \"value\": \"\"\n },\n \"body\": {\n \"value\": \"\"\n },\n \"bodySchema\": {\n \"value\": \"\"\n }\n },\n \"description\": \"string\",\n \"ttl\": 2003.971659615339\n}","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\",\n \"status\": 647,\n \"timestamp\": \"string\",\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"1f153e91-1c20-46b6-8eaa-bdf7436ed52b","name":"Forbidden; insufficient permissions. See error message for details.","originalRequest":{"url":{"path":["brickworks","v1","external-sources"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"name\": \"string\",\n \"properties\": {\n \"sourceType\": {\n \"value\": \"\"\n },\n \"url\": {\n \"value\": \"\"\n },\n \"method\": {\n \"value\": \"\"\n },\n \"headers\": {\n \"value\": \"\"\n },\n \"params\": {\n \"value\": \"\"\n },\n \"authType\": {\n \"value\": \"\"\n },\n \"authId\": {\n \"value\": \"\"\n },\n \"body\": {\n \"value\": \"\"\n },\n \"bodySchema\": {\n \"value\": \"\"\n }\n },\n \"description\": \"string\",\n \"ttl\": 2003.971659615339\n}","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\",\n \"status\": 647,\n \"timestamp\": \"string\",\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"072ad6bf-3b2d-4107-abf4-be9616ee908a","name":"Resource not found. See error message for details.","originalRequest":{"url":{"path":["brickworks","v1","external-sources"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"name\": \"string\",\n \"properties\": {\n \"sourceType\": {\n \"value\": \"\"\n },\n \"url\": {\n \"value\": \"\"\n },\n \"method\": {\n \"value\": \"\"\n },\n \"headers\": {\n \"value\": \"\"\n },\n \"params\": {\n \"value\": \"\"\n },\n \"authType\": {\n \"value\": \"\"\n },\n \"authId\": {\n \"value\": \"\"\n },\n \"body\": {\n \"value\": \"\"\n },\n \"bodySchema\": {\n \"value\": \"\"\n }\n },\n \"description\": \"string\",\n \"ttl\": 2003.971659615339\n}","options":{"raw":{"language":"json"}}}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"httpStatus\": 8176,\n \"errorCode\": \"string\",\n \"timestamp\": \"2009-08-02T10:31:15.071Z\",\n \"message\": \"string\",\n \"traceId\": \"string\",\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"source\": {\n \"pointer\": \"string\",\n \"value\": \"string\"\n },\n \"details\": {\n \"key_0\": {}\n },\n \"field\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"57245797-9ec8-4b30-b7ea-da923f70ac0c","name":"The request could not be completed due to a conflict with the current state of the resource. See error message for details.","originalRequest":{"url":{"path":["brickworks","v1","external-sources"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"name\": \"string\",\n \"properties\": {\n \"sourceType\": {\n \"value\": \"\"\n },\n \"url\": {\n \"value\": \"\"\n },\n \"method\": {\n \"value\": \"\"\n },\n \"headers\": {\n \"value\": \"\"\n },\n \"params\": {\n \"value\": \"\"\n },\n \"authType\": {\n \"value\": \"\"\n },\n \"authId\": {\n \"value\": \"\"\n },\n \"body\": {\n \"value\": \"\"\n },\n \"bodySchema\": {\n \"value\": \"\"\n }\n },\n \"description\": \"string\",\n \"ttl\": 2003.971659615339\n}","options":{"raw":{"language":"json"}}}},"status":"Conflict","code":409,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"httpStatus\": 8176,\n \"errorCode\": \"string\",\n \"timestamp\": \"2009-08-02T10:31:15.071Z\",\n \"message\": \"string\",\n \"traceId\": \"string\",\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"source\": {\n \"pointer\": \"string\",\n \"value\": \"string\"\n },\n \"details\": {\n \"key_0\": {}\n },\n \"field\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"7b52897c-8d79-42ac-805f-ed6a6f9f434c","name":"The request was well-formed but could not be processed due to semantic or domain-related constraints. See error message for details.","originalRequest":{"url":{"path":["brickworks","v1","external-sources"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"name\": \"string\",\n \"properties\": {\n \"sourceType\": {\n \"value\": \"\"\n },\n \"url\": {\n \"value\": \"\"\n },\n \"method\": {\n \"value\": \"\"\n },\n \"headers\": {\n \"value\": \"\"\n },\n \"params\": {\n \"value\": \"\"\n },\n \"authType\": {\n \"value\": \"\"\n },\n \"authId\": {\n \"value\": \"\"\n },\n \"body\": {\n \"value\": \"\"\n },\n \"bodySchema\": {\n \"value\": \"\"\n }\n },\n \"description\": \"string\",\n \"ttl\": 2003.971659615339\n}","options":{"raw":{"language":"json"}}}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"httpStatus\": 8176,\n \"errorCode\": \"string\",\n \"timestamp\": \"2009-08-02T10:31:15.071Z\",\n \"message\": \"string\",\n \"traceId\": \"string\",\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"source\": {\n \"pointer\": \"string\",\n \"value\": \"string\"\n },\n \"details\": {\n \"key_0\": {}\n },\n \"field\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"6ca09894-8483-4169-9db6-bb4bf9d3ee0a","name":"See error message for details.","originalRequest":{"url":{"path":["brickworks","v1","external-sources"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"name\": \"string\",\n \"properties\": {\n \"sourceType\": {\n \"value\": \"\"\n },\n \"url\": {\n \"value\": \"\"\n },\n \"method\": {\n \"value\": \"\"\n },\n \"headers\": {\n \"value\": \"\"\n },\n \"params\": {\n \"value\": \"\"\n },\n \"authType\": {\n \"value\": \"\"\n },\n \"authId\": {\n \"value\": \"\"\n },\n \"body\": {\n \"value\": \"\"\n },\n \"bodySchema\": {\n \"value\": \"\"\n }\n },\n \"description\": \"string\",\n \"ttl\": 2003.971659615339\n}","options":{"raw":{"language":"json"}}}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"httpStatus\": 8176,\n \"errorCode\": \"string\",\n \"timestamp\": \"2009-08-02T10:31:15.071Z\",\n \"message\": \"string\",\n \"traceId\": \"string\",\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"source\": {\n \"pointer\": \"string\",\n \"value\": \"string\"\n },\n \"details\": {\n \"key_0\": {}\n },\n \"field\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"c890b4c5-2e52-4d8c-bff6-45c279566f2e","name":"List external sources","request":{"name":"List external sources","description":{"content":"Retrieve a list of external data sources. You can sort and paginate the results.\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `BRICKWORKS_EXTERNALSOURCES_READ`\n\n**User role permission required:** `assets_brickworks: read`\n","type":"text/plain"},"url":{"path":["brickworks","v1","external-sources"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"limit","value":"50","description":"Limit of items per page"},{"disabled":false,"key":"page","value":"1","description":"The number of the page to retrieve"},{"disabled":false,"key":"search","value":"string","description":"A string to search for in:\n- `id`\n- `appId`\n- `displayName`\n- `description`\n"},{"disabled":false,"key":"sortBy","value":"createdAt:asc|desc","description":"You can sort by:\n- `createdAt`\n- `updatedAt`\n- `name`\n"},{"disabled":false,"key":"method","value":"post","description":"You can filter the results by source http method.\n"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"ccfa6012-5028-44fa-8631-e9807d1ba806","name":"A page of external data sources","originalRequest":{"url":{"path":["brickworks","v1","external-sources"],"host":["{{baseUrl}}"],"query":[{"key":"limit","value":"50"},{"key":"page","value":"1"},{"key":"search","value":"string"},{"key":"sortBy","value":"createdAt:asc|desc"},{"key":"method","value":"post"}],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"meta\": {\n \"links\": {\n \"value\": \"\"\n },\n \"limit\": {\n \"value\": \"\"\n },\n \"count\": {\n \"value\": \"\"\n }\n },\n \"data\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"0d07609f-c498-43d6-aba6-4403e0a68c33","name":"Incorrect request (malformed JSON, wrong parameters, etc.). See error message for details.","originalRequest":{"url":{"path":["brickworks","v1","external-sources"],"host":["{{baseUrl}}"],"query":[{"key":"limit","value":"50"},{"key":"page","value":"1"},{"key":"search","value":"string"},{"key":"sortBy","value":"createdAt:asc|desc"},{"key":"method","value":"post"}],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"httpStatus\": 8176,\n \"errorCode\": \"string\",\n \"timestamp\": \"2009-08-02T10:31:15.071Z\",\n \"message\": \"string\",\n \"traceId\": \"string\",\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"source\": {\n \"pointer\": \"string\",\n \"value\": \"string\"\n },\n \"details\": {\n \"key_0\": {}\n },\n \"field\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"44e64267-1cb2-47f9-90c8-e00b75af41f6","name":"Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc. See error message for details.","originalRequest":{"url":{"path":["brickworks","v1","external-sources"],"host":["{{baseUrl}}"],"query":[{"key":"limit","value":"50"},{"key":"page","value":"1"},{"key":"search","value":"string"},{"key":"sortBy","value":"createdAt:asc|desc"},{"key":"method","value":"post"}],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\",\n \"status\": 647,\n \"timestamp\": \"string\",\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"e9ee6bae-fb74-470b-b717-2e56670e571e","name":"Forbidden; insufficient permissions. See error message for details.","originalRequest":{"url":{"path":["brickworks","v1","external-sources"],"host":["{{baseUrl}}"],"query":[{"key":"limit","value":"50"},{"key":"page","value":"1"},{"key":"search","value":"string"},{"key":"sortBy","value":"createdAt:asc|desc"},{"key":"method","value":"post"}],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\",\n \"status\": 647,\n \"timestamp\": \"string\",\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"ceb0de37-ae51-4bf8-885d-42cb10c201bd","name":"Resource not found. See error message for details.","originalRequest":{"url":{"path":["brickworks","v1","external-sources"],"host":["{{baseUrl}}"],"query":[{"key":"limit","value":"50"},{"key":"page","value":"1"},{"key":"search","value":"string"},{"key":"sortBy","value":"createdAt:asc|desc"},{"key":"method","value":"post"}],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"httpStatus\": 8176,\n \"errorCode\": \"string\",\n \"timestamp\": \"2009-08-02T10:31:15.071Z\",\n \"message\": \"string\",\n \"traceId\": \"string\",\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"source\": {\n \"pointer\": \"string\",\n \"value\": \"string\"\n },\n \"details\": {\n \"key_0\": {}\n },\n \"field\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"a123eee0-c9b0-4514-a528-7b67ff2dd875","name":"The request could not be completed due to a conflict with the current state of the resource. See error message for details.","originalRequest":{"url":{"path":["brickworks","v1","external-sources"],"host":["{{baseUrl}}"],"query":[{"key":"limit","value":"50"},{"key":"page","value":"1"},{"key":"search","value":"string"},{"key":"sortBy","value":"createdAt:asc|desc"},{"key":"method","value":"post"}],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Conflict","code":409,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"httpStatus\": 8176,\n \"errorCode\": \"string\",\n \"timestamp\": \"2009-08-02T10:31:15.071Z\",\n \"message\": \"string\",\n \"traceId\": \"string\",\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"source\": {\n \"pointer\": \"string\",\n \"value\": \"string\"\n },\n \"details\": {\n \"key_0\": {}\n },\n \"field\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"9038cc81-569c-4ad0-b1d1-f4bfdcccc723","name":"The request was well-formed but could not be processed due to semantic or domain-related constraints. See error message for details.","originalRequest":{"url":{"path":["brickworks","v1","external-sources"],"host":["{{baseUrl}}"],"query":[{"key":"limit","value":"50"},{"key":"page","value":"1"},{"key":"search","value":"string"},{"key":"sortBy","value":"createdAt:asc|desc"},{"key":"method","value":"post"}],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"httpStatus\": 8176,\n \"errorCode\": \"string\",\n \"timestamp\": \"2009-08-02T10:31:15.071Z\",\n \"message\": \"string\",\n \"traceId\": \"string\",\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"source\": {\n \"pointer\": \"string\",\n \"value\": \"string\"\n },\n \"details\": {\n \"key_0\": {}\n },\n \"field\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"d8ba761b-4648-4d78-805a-327bbf6f9c32","name":"See error message for details.","originalRequest":{"url":{"path":["brickworks","v1","external-sources"],"host":["{{baseUrl}}"],"query":[{"key":"limit","value":"50"},{"key":"page","value":"1"},{"key":"search","value":"string"},{"key":"sortBy","value":"createdAt:asc|desc"},{"key":"method","value":"post"}],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"httpStatus\": 8176,\n \"errorCode\": \"string\",\n \"timestamp\": \"2009-08-02T10:31:15.071Z\",\n \"message\": \"string\",\n \"traceId\": \"string\",\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"source\": {\n \"pointer\": \"string\",\n \"value\": \"string\"\n },\n \"details\": {\n \"key_0\": {}\n },\n \"field\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"d975ffa1-82a7-4291-ae47-96727d757a0f","name":"Get External Source","request":{"name":"Get External Source","description":{"content":"Retrieve the details of an external data source.\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `BRICKWORKS_EXTERNALSOURCES_READ`\n\n**User role permission required:** `assets_brickworks: read`\n","type":"text/plain"},"url":{"path":["brickworks","v1","external-sources",":ExternalDataSourceId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"ExternalDataSourceId","description":"(Required) External source ID"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"755e0309-a46d-4c43-8873-51212d47a8aa","name":"Details of the external source","originalRequest":{"url":{"path":["brickworks","v1","external-sources",":ExternalDataSourceId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"ExternalDataSourceId","description":"(Required) External source ID"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"id\": \"4eb88c17-054b-a650-ce5f-7731219cba79\",\n \"name\": \"string\",\n \"properties\": {\n \"sourceType\": {\n \"value\": \"\"\n },\n \"url\": {\n \"value\": \"\"\n },\n \"method\": {\n \"value\": \"\"\n },\n \"headers\": {\n \"value\": \"\"\n },\n \"params\": {\n \"value\": \"\"\n },\n \"authType\": {\n \"value\": \"\"\n },\n \"authId\": {\n \"value\": \"\"\n },\n \"body\": {\n \"value\": \"\"\n },\n \"bodySchema\": {\n \"value\": \"\"\n }\n },\n \"createdBy\": 7402,\n \"createdAt\": \"1966-07-08T19:39:38.991Z\",\n \"updatedAt\": \"1962-11-18T05:22:16.813Z\",\n \"description\": \"string\",\n \"updatedBy\": 750,\n \"ttl\": 5526.728210075868\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"3fa9f582-4bdf-4661-ae6a-0890c4a67a1b","name":"Incorrect request (malformed JSON, wrong parameters, etc.). See error message for details.","originalRequest":{"url":{"path":["brickworks","v1","external-sources",":ExternalDataSourceId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"ExternalDataSourceId","description":"(Required) External source ID"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"httpStatus\": 8176,\n \"errorCode\": \"string\",\n \"timestamp\": \"2009-08-02T10:31:15.071Z\",\n \"message\": \"string\",\n \"traceId\": \"string\",\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"source\": {\n \"pointer\": \"string\",\n \"value\": \"string\"\n },\n \"details\": {\n \"key_0\": {}\n },\n \"field\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"59d731e3-ca65-4abe-abec-f978fbf25894","name":"Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc. See error message for details.","originalRequest":{"url":{"path":["brickworks","v1","external-sources",":ExternalDataSourceId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"ExternalDataSourceId","description":"(Required) External source ID"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\",\n \"status\": 647,\n \"timestamp\": \"string\",\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"0e19c321-1f7d-42eb-86fb-1eceedf46a24","name":"Forbidden; insufficient permissions. See error message for details.","originalRequest":{"url":{"path":["brickworks","v1","external-sources",":ExternalDataSourceId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"ExternalDataSourceId","description":"(Required) External source ID"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\",\n \"status\": 647,\n \"timestamp\": \"string\",\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"fc9ddad2-7c32-47e4-941e-fb5dae8d3b64","name":"Resource not found. See error message for details.","originalRequest":{"url":{"path":["brickworks","v1","external-sources",":ExternalDataSourceId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"ExternalDataSourceId","description":"(Required) External source ID"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"httpStatus\": 8176,\n \"errorCode\": \"string\",\n \"timestamp\": \"2009-08-02T10:31:15.071Z\",\n \"message\": \"string\",\n \"traceId\": \"string\",\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"source\": {\n \"pointer\": \"string\",\n \"value\": \"string\"\n },\n \"details\": {\n \"key_0\": {}\n },\n \"field\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"ac98a0ed-e761-42e9-bc60-5920130d0c1f","name":"The request could not be completed due to a conflict with the current state of the resource. See error message for details.","originalRequest":{"url":{"path":["brickworks","v1","external-sources",":ExternalDataSourceId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"ExternalDataSourceId","description":"(Required) External source ID"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Conflict","code":409,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"httpStatus\": 8176,\n \"errorCode\": \"string\",\n \"timestamp\": \"2009-08-02T10:31:15.071Z\",\n \"message\": \"string\",\n \"traceId\": \"string\",\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"source\": {\n \"pointer\": \"string\",\n \"value\": \"string\"\n },\n \"details\": {\n \"key_0\": {}\n },\n \"field\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"12c12071-5e8e-40dd-9374-43ee8f8d9655","name":"The request was well-formed but could not be processed due to semantic or domain-related constraints. See error message for details.","originalRequest":{"url":{"path":["brickworks","v1","external-sources",":ExternalDataSourceId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"ExternalDataSourceId","description":"(Required) External source ID"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"httpStatus\": 8176,\n \"errorCode\": \"string\",\n \"timestamp\": \"2009-08-02T10:31:15.071Z\",\n \"message\": \"string\",\n \"traceId\": \"string\",\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"source\": {\n \"pointer\": \"string\",\n \"value\": \"string\"\n },\n \"details\": {\n \"key_0\": {}\n },\n \"field\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"4f4047e2-dded-4ceb-ac9e-873ce30ab18d","name":"See error message for details.","originalRequest":{"url":{"path":["brickworks","v1","external-sources",":ExternalDataSourceId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"ExternalDataSourceId","description":"(Required) External source ID"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"httpStatus\": 8176,\n \"errorCode\": \"string\",\n \"timestamp\": \"2009-08-02T10:31:15.071Z\",\n \"message\": \"string\",\n \"traceId\": \"string\",\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"source\": {\n \"pointer\": \"string\",\n \"value\": \"string\"\n },\n \"details\": {\n \"key_0\": {}\n },\n \"field\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"bfe71a66-1f11-47a2-a999-9e94b9b0566e","name":"Update External Source","request":{"name":"Update External Source","description":{"content":"Update an external data source definition.\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `BRICKWORKS_EXTERNALSOURCES_UPDATE`\n\n**User role permission required:** `assets_brickworks: update`\n","type":"text/plain"},"url":{"path":["brickworks","v1","external-sources",":ExternalDataSourceId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"ExternalDataSourceId","description":"(Required) External source ID"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PUT","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]},"body":{"mode":"raw","raw":"{\n \"name\": \"string\",\n \"description\": \"string\",\n \"properties\": {\n \"sourceType\": {\n \"value\": \"\"\n },\n \"url\": {\n \"value\": \"\"\n },\n \"method\": {\n \"value\": \"\"\n },\n \"headers\": {\n \"value\": \"\"\n },\n \"params\": {\n \"value\": \"\"\n },\n \"authType\": {\n \"value\": \"\"\n },\n \"authId\": {\n \"value\": \"\"\n },\n \"body\": {\n \"value\": \"\"\n },\n \"bodySchema\": {\n \"value\": \"\"\n }\n },\n \"ttl\": 8406.361844875504\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"b212d286-0562-49e2-8755-b4da1cb69823","name":"External Source updated","originalRequest":{"url":{"path":["brickworks","v1","external-sources",":ExternalDataSourceId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"ExternalDataSourceId","description":"(Required) External source ID"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"{\n \"name\": \"string\",\n \"description\": \"string\",\n \"properties\": {\n \"sourceType\": {\n \"value\": \"\"\n },\n \"url\": {\n \"value\": \"\"\n },\n \"method\": {\n \"value\": \"\"\n },\n \"headers\": {\n \"value\": \"\"\n },\n \"params\": {\n \"value\": \"\"\n },\n \"authType\": {\n \"value\": \"\"\n },\n \"authId\": {\n \"value\": \"\"\n },\n \"body\": {\n \"value\": \"\"\n },\n \"bodySchema\": {\n \"value\": \"\"\n }\n },\n \"ttl\": 8406.361844875504\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"id\": \"4eb88c17-054b-a650-ce5f-7731219cba79\",\n \"name\": \"string\",\n \"properties\": {\n \"sourceType\": {\n \"value\": \"\"\n },\n \"url\": {\n \"value\": \"\"\n },\n \"method\": {\n \"value\": \"\"\n },\n \"headers\": {\n \"value\": \"\"\n },\n \"params\": {\n \"value\": \"\"\n },\n \"authType\": {\n \"value\": \"\"\n },\n \"authId\": {\n \"value\": \"\"\n },\n \"body\": {\n \"value\": \"\"\n },\n \"bodySchema\": {\n \"value\": \"\"\n }\n },\n \"createdBy\": 7402,\n \"createdAt\": \"1966-07-08T19:39:38.991Z\",\n \"updatedAt\": \"1962-11-18T05:22:16.813Z\",\n \"description\": \"string\",\n \"updatedBy\": 750,\n \"ttl\": 5526.728210075868\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"cfc3c749-41c9-4d3c-b6d8-6d6875bfa796","name":"Incorrect request (malformed JSON, wrong parameters, etc.). See error message for details.","originalRequest":{"url":{"path":["brickworks","v1","external-sources",":ExternalDataSourceId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"ExternalDataSourceId","description":"(Required) External source ID"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"{\n \"name\": \"string\",\n \"description\": \"string\",\n \"properties\": {\n \"sourceType\": {\n \"value\": \"\"\n },\n \"url\": {\n \"value\": \"\"\n },\n \"method\": {\n \"value\": \"\"\n },\n \"headers\": {\n \"value\": \"\"\n },\n \"params\": {\n \"value\": \"\"\n },\n \"authType\": {\n \"value\": \"\"\n },\n \"authId\": {\n \"value\": \"\"\n },\n \"body\": {\n \"value\": \"\"\n },\n \"bodySchema\": {\n \"value\": \"\"\n }\n },\n \"ttl\": 8406.361844875504\n}","options":{"raw":{"language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"httpStatus\": 8176,\n \"errorCode\": \"string\",\n \"timestamp\": \"2009-08-02T10:31:15.071Z\",\n \"message\": \"string\",\n \"traceId\": \"string\",\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"source\": {\n \"pointer\": \"string\",\n \"value\": \"string\"\n },\n \"details\": {\n \"key_0\": {}\n },\n \"field\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"62ac05e0-99d5-41ff-b364-5e25a321a138","name":"Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc. See error message for details.","originalRequest":{"url":{"path":["brickworks","v1","external-sources",":ExternalDataSourceId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"ExternalDataSourceId","description":"(Required) External source ID"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"{\n \"name\": \"string\",\n \"description\": \"string\",\n \"properties\": {\n \"sourceType\": {\n \"value\": \"\"\n },\n \"url\": {\n \"value\": \"\"\n },\n \"method\": {\n \"value\": \"\"\n },\n \"headers\": {\n \"value\": \"\"\n },\n \"params\": {\n \"value\": \"\"\n },\n \"authType\": {\n \"value\": \"\"\n },\n \"authId\": {\n \"value\": \"\"\n },\n \"body\": {\n \"value\": \"\"\n },\n \"bodySchema\": {\n \"value\": \"\"\n }\n },\n \"ttl\": 8406.361844875504\n}","options":{"raw":{"language":"json"}}}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\",\n \"status\": 647,\n \"timestamp\": \"string\",\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"1bd66ccc-691c-4f12-bf25-f20f9a7ee329","name":"Forbidden; insufficient permissions. See error message for details.","originalRequest":{"url":{"path":["brickworks","v1","external-sources",":ExternalDataSourceId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"ExternalDataSourceId","description":"(Required) External source ID"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"{\n \"name\": \"string\",\n \"description\": \"string\",\n \"properties\": {\n \"sourceType\": {\n \"value\": \"\"\n },\n \"url\": {\n \"value\": \"\"\n },\n \"method\": {\n \"value\": \"\"\n },\n \"headers\": {\n \"value\": \"\"\n },\n \"params\": {\n \"value\": \"\"\n },\n \"authType\": {\n \"value\": \"\"\n },\n \"authId\": {\n \"value\": \"\"\n },\n \"body\": {\n \"value\": \"\"\n },\n \"bodySchema\": {\n \"value\": \"\"\n }\n },\n \"ttl\": 8406.361844875504\n}","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\",\n \"status\": 647,\n \"timestamp\": \"string\",\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"182fdb5b-92a0-4e58-845f-e36c7cba84df","name":"Resource not found. See error message for details.","originalRequest":{"url":{"path":["brickworks","v1","external-sources",":ExternalDataSourceId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"ExternalDataSourceId","description":"(Required) External source ID"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"{\n \"name\": \"string\",\n \"description\": \"string\",\n \"properties\": {\n \"sourceType\": {\n \"value\": \"\"\n },\n \"url\": {\n \"value\": \"\"\n },\n \"method\": {\n \"value\": \"\"\n },\n \"headers\": {\n \"value\": \"\"\n },\n \"params\": {\n \"value\": \"\"\n },\n \"authType\": {\n \"value\": \"\"\n },\n \"authId\": {\n \"value\": \"\"\n },\n \"body\": {\n \"value\": \"\"\n },\n \"bodySchema\": {\n \"value\": \"\"\n }\n },\n \"ttl\": 8406.361844875504\n}","options":{"raw":{"language":"json"}}}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"httpStatus\": 8176,\n \"errorCode\": \"string\",\n \"timestamp\": \"2009-08-02T10:31:15.071Z\",\n \"message\": \"string\",\n \"traceId\": \"string\",\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"source\": {\n \"pointer\": \"string\",\n \"value\": \"string\"\n },\n \"details\": {\n \"key_0\": {}\n },\n \"field\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"ee8666c4-6692-4f7c-956d-698c9aa2d8c3","name":"The request could not be completed due to a conflict with the current state of the resource. See error message for details.","originalRequest":{"url":{"path":["brickworks","v1","external-sources",":ExternalDataSourceId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"ExternalDataSourceId","description":"(Required) External source ID"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"{\n \"name\": \"string\",\n \"description\": \"string\",\n \"properties\": {\n \"sourceType\": {\n \"value\": \"\"\n },\n \"url\": {\n \"value\": \"\"\n },\n \"method\": {\n \"value\": \"\"\n },\n \"headers\": {\n \"value\": \"\"\n },\n \"params\": {\n \"value\": \"\"\n },\n \"authType\": {\n \"value\": \"\"\n },\n \"authId\": {\n \"value\": \"\"\n },\n \"body\": {\n \"value\": \"\"\n },\n \"bodySchema\": {\n \"value\": \"\"\n }\n },\n \"ttl\": 8406.361844875504\n}","options":{"raw":{"language":"json"}}}},"status":"Conflict","code":409,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"httpStatus\": 8176,\n \"errorCode\": \"string\",\n \"timestamp\": \"2009-08-02T10:31:15.071Z\",\n \"message\": \"string\",\n \"traceId\": \"string\",\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"source\": {\n \"pointer\": \"string\",\n \"value\": \"string\"\n },\n \"details\": {\n \"key_0\": {}\n },\n \"field\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"3c8a9703-c518-4c60-9006-7d0db751d6d2","name":"The request was well-formed but could not be processed due to semantic or domain-related constraints. See error message for details.","originalRequest":{"url":{"path":["brickworks","v1","external-sources",":ExternalDataSourceId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"ExternalDataSourceId","description":"(Required) External source ID"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"{\n \"name\": \"string\",\n \"description\": \"string\",\n \"properties\": {\n \"sourceType\": {\n \"value\": \"\"\n },\n \"url\": {\n \"value\": \"\"\n },\n \"method\": {\n \"value\": \"\"\n },\n \"headers\": {\n \"value\": \"\"\n },\n \"params\": {\n \"value\": \"\"\n },\n \"authType\": {\n \"value\": \"\"\n },\n \"authId\": {\n \"value\": \"\"\n },\n \"body\": {\n \"value\": \"\"\n },\n \"bodySchema\": {\n \"value\": \"\"\n }\n },\n \"ttl\": 8406.361844875504\n}","options":{"raw":{"language":"json"}}}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"httpStatus\": 8176,\n \"errorCode\": \"string\",\n \"timestamp\": \"2009-08-02T10:31:15.071Z\",\n \"message\": \"string\",\n \"traceId\": \"string\",\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"source\": {\n \"pointer\": \"string\",\n \"value\": \"string\"\n },\n \"details\": {\n \"key_0\": {}\n },\n \"field\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"1e4c2ff8-800b-4834-b0d4-9051d342cf3f","name":"See error message for details.","originalRequest":{"url":{"path":["brickworks","v1","external-sources",":ExternalDataSourceId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"ExternalDataSourceId","description":"(Required) External source ID"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"{\n \"name\": \"string\",\n \"description\": \"string\",\n \"properties\": {\n \"sourceType\": {\n \"value\": \"\"\n },\n \"url\": {\n \"value\": \"\"\n },\n \"method\": {\n \"value\": \"\"\n },\n \"headers\": {\n \"value\": \"\"\n },\n \"params\": {\n \"value\": \"\"\n },\n \"authType\": {\n \"value\": \"\"\n },\n \"authId\": {\n \"value\": \"\"\n },\n \"body\": {\n \"value\": \"\"\n },\n \"bodySchema\": {\n \"value\": \"\"\n }\n },\n \"ttl\": 8406.361844875504\n}","options":{"raw":{"language":"json"}}}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"httpStatus\": 8176,\n \"errorCode\": \"string\",\n \"timestamp\": \"2009-08-02T10:31:15.071Z\",\n \"message\": \"string\",\n \"traceId\": \"string\",\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"source\": {\n \"pointer\": \"string\",\n \"value\": \"string\"\n },\n \"details\": {\n \"key_0\": {}\n },\n \"field\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"1ac241af-7e78-462f-8501-239b3605b3c9","name":"Delete external source","request":{"name":"Delete external source","description":{"content":"Permanently delete an external data source definition.\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `BRICKWORKS_EXTERNALSOURCES_DELETE`\n\n**User role permission required:** `assets_brickworks: delete`\n","type":"text/plain"},"url":{"path":["brickworks","v1","external-sources",":ExternalDataSourceId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"ExternalDataSourceId","description":"(Required) External source ID"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"d2969ebb-9ed7-4e49-a140-e6b229567e55","name":"No content","originalRequest":{"url":{"path":["brickworks","v1","external-sources",":ExternalDataSourceId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"ExternalDataSourceId","description":"(Required) External source ID"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "}],"method":"DELETE","body":{}},"status":"No Content","code":204,"header":[{"key":"Content-Type","value":"text/plain"}],"body":"","cookie":[],"_postman_previewlanguage":"text"},{"id":"4af8fcff-3a86-4409-8724-7c6217c0d258","name":"Incorrect request (malformed JSON, wrong parameters, etc.). See error message for details.","originalRequest":{"url":{"path":["brickworks","v1","external-sources",":ExternalDataSourceId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"ExternalDataSourceId","description":"(Required) External source ID"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"httpStatus\": 8176,\n \"errorCode\": \"string\",\n \"timestamp\": \"2009-08-02T10:31:15.071Z\",\n \"message\": \"string\",\n \"traceId\": \"string\",\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"source\": {\n \"pointer\": \"string\",\n \"value\": \"string\"\n },\n \"details\": {\n \"key_0\": {}\n },\n \"field\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"a017e912-671c-4b92-b3c8-550075789d29","name":"Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc. See error message for details.","originalRequest":{"url":{"path":["brickworks","v1","external-sources",":ExternalDataSourceId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"ExternalDataSourceId","description":"(Required) External source ID"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\",\n \"status\": 647,\n \"timestamp\": \"string\",\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"8baa25af-3ba5-4ec2-89f9-38f6e94b14a5","name":"Forbidden; insufficient permissions. See error message for details.","originalRequest":{"url":{"path":["brickworks","v1","external-sources",":ExternalDataSourceId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"ExternalDataSourceId","description":"(Required) External source ID"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\",\n \"status\": 647,\n \"timestamp\": \"string\",\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"2f831413-a0c5-47c7-a3d1-0628d7497ff5","name":"Resource not found. See error message for details.","originalRequest":{"url":{"path":["brickworks","v1","external-sources",":ExternalDataSourceId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"ExternalDataSourceId","description":"(Required) External source ID"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"httpStatus\": 8176,\n \"errorCode\": \"string\",\n \"timestamp\": \"2009-08-02T10:31:15.071Z\",\n \"message\": \"string\",\n \"traceId\": \"string\",\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"source\": {\n \"pointer\": \"string\",\n \"value\": \"string\"\n },\n \"details\": {\n \"key_0\": {}\n },\n \"field\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"600cbf85-e9a0-41e6-842d-aa904cc290b1","name":"The request could not be completed due to a conflict with the current state of the resource. See error message for details.","originalRequest":{"url":{"path":["brickworks","v1","external-sources",":ExternalDataSourceId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"ExternalDataSourceId","description":"(Required) External source ID"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{}},"status":"Conflict","code":409,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"httpStatus\": 8176,\n \"errorCode\": \"string\",\n \"timestamp\": \"2009-08-02T10:31:15.071Z\",\n \"message\": \"string\",\n \"traceId\": \"string\",\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"source\": {\n \"pointer\": \"string\",\n \"value\": \"string\"\n },\n \"details\": {\n \"key_0\": {}\n },\n \"field\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"b07c09c9-64de-4586-86e8-1c1d4e93b3e1","name":"The request was well-formed but could not be processed due to semantic or domain-related constraints. See error message for details.","originalRequest":{"url":{"path":["brickworks","v1","external-sources",":ExternalDataSourceId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"ExternalDataSourceId","description":"(Required) External source ID"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"httpStatus\": 8176,\n \"errorCode\": \"string\",\n \"timestamp\": \"2009-08-02T10:31:15.071Z\",\n \"message\": \"string\",\n \"traceId\": \"string\",\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"source\": {\n \"pointer\": \"string\",\n \"value\": \"string\"\n },\n \"details\": {\n \"key_0\": {}\n },\n \"field\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"68501ea3-6cf3-47b1-a1a1-cf7ad85c3d8e","name":"See error message for details.","originalRequest":{"url":{"path":["brickworks","v1","external-sources",":ExternalDataSourceId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"bd022385-3a2f-bb0f-98d8-83b0332d5750","key":"ExternalDataSourceId","description":"(Required) External source ID"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"httpStatus\": 8176,\n \"errorCode\": \"string\",\n \"timestamp\": \"2009-08-02T10:31:15.071Z\",\n \"message\": \"string\",\n \"traceId\": \"string\",\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"source\": {\n \"pointer\": \"string\",\n \"value\": \"string\"\n },\n \"details\": {\n \"key_0\": {}\n },\n \"field\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}],"event":[]},{"id":"9d3875ae-9ebf-47de-ba32-3fd51a4fb4a6","name":"Brickworks: Record versions","description":{"content":"","type":"text/plain"},"item":[{"id":"dfb28c4c-27df-41de-96a1-2a7c65353f08","name":"Get record versions","request":{"name":"Get record versions","description":{"content":"Retrieve all versions of a record. You can paginate, sort, and refine the results. By default, the versions are sorted from newest to oldest.\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `BRICKWORKS_RECORDS_READ`\n\n**User role permission required:** `assets_brickworks: read`\n","type":"text/plain"},"url":{"path":["brickworks","v1","schemas",":SchemaIdentifier","records",":RecordIdentifier","versions"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"limit","value":"50","description":"Limit of items per page"},{"disabled":false,"key":"page","value":"1","description":"The number of the page to retrieve"},{"disabled":false,"key":"filters","value":"string"},{"disabled":false,"key":"sortBy","value":"updatedAt:asc","description":"You can change the default sorting. The sorting direction is selected by adding `asc` or `desc`, for example `sortBy=createdAt:desc`.\n\nYou can sort by:\n - `appId` \n - `displayName`\n - `createdAt`\n - `updatedAt`\n"},{"disabled":false,"key":"statuses","value":"DRAFT","description":"Comma-separated list of record statuses to filter the results."}],"variable":[{"disabled":false,"type":"any","value":"44e5411f-17ee-ab70-9112-0c776aafa909","key":"SchemaIdentifier","description":"(Required) Schema identifier - can be a UUID (SchemaId) or a human-readable string (Schema AppId/API name, 3-25 characters)"},{"disabled":false,"type":"any","value":"10cc476e-4cea-1124-9ba2-805e59214048","key":"RecordIdentifier","description":"(Required) Record identifier - can be a UUID (RecordId) or a human-readable slug (RecordSlug, 6-40 characters)"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"b04e8dc2-8905-46bb-8d23-37480dc58d1d","name":"A page of record versions","originalRequest":{"url":{"path":["brickworks","v1","schemas",":SchemaIdentifier","records",":RecordIdentifier","versions"],"host":["{{baseUrl}}"],"query":[{"key":"limit","value":"50"},{"key":"page","value":"1"},{"key":"filters","value":"string"},{"key":"sortBy","value":"updatedAt:asc"},{"key":"statuses","value":"DRAFT"}],"variable":[{"disabled":false,"type":"any","value":"44e5411f-17ee-ab70-9112-0c776aafa909","key":"SchemaIdentifier","description":"(Required) Schema identifier - can be a UUID (SchemaId) or a human-readable string (Schema AppId/API name, 3-25 characters)"},{"disabled":false,"type":"any","value":"10cc476e-4cea-1124-9ba2-805e59214048","key":"RecordIdentifier","description":"(Required) Record identifier - can be a UUID (RecordId) or a human-readable slug (RecordSlug, 6-40 characters)"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"meta\": {\n \"links\": {\n \"value\": \"\"\n },\n \"limit\": {\n \"value\": \"\"\n },\n \"count\": {\n \"value\": \"\"\n }\n },\n \"data\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"6356eb17-2ac4-4de5-b0d0-c967f2ee7d8e","name":"Incorrect request (malformed JSON, wrong parameters, etc.). See error message for details.","originalRequest":{"url":{"path":["brickworks","v1","schemas",":SchemaIdentifier","records",":RecordIdentifier","versions"],"host":["{{baseUrl}}"],"query":[{"key":"limit","value":"50"},{"key":"page","value":"1"},{"key":"filters","value":"string"},{"key":"sortBy","value":"updatedAt:asc"},{"key":"statuses","value":"DRAFT"}],"variable":[{"disabled":false,"type":"any","value":"44e5411f-17ee-ab70-9112-0c776aafa909","key":"SchemaIdentifier","description":"(Required) Schema identifier - can be a UUID (SchemaId) or a human-readable string (Schema AppId/API name, 3-25 characters)"},{"disabled":false,"type":"any","value":"10cc476e-4cea-1124-9ba2-805e59214048","key":"RecordIdentifier","description":"(Required) Record identifier - can be a UUID (RecordId) or a human-readable slug (RecordSlug, 6-40 characters)"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"httpStatus\": 7590,\n \"errorCode\": \"string\",\n \"timestamp\": \"1972-11-25T19:55:40.117Z\",\n \"message\": \"string\",\n \"traceId\": \"string\",\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"source\": {\n \"pointer\": \"string\",\n \"value\": \"string\"\n },\n \"details\": {\n \"key_0\": {}\n },\n \"field\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"1b0c13e3-8884-4677-bfb6-656e19acd900","name":"Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc. See error message for details.","originalRequest":{"url":{"path":["brickworks","v1","schemas",":SchemaIdentifier","records",":RecordIdentifier","versions"],"host":["{{baseUrl}}"],"query":[{"key":"limit","value":"50"},{"key":"page","value":"1"},{"key":"filters","value":"string"},{"key":"sortBy","value":"updatedAt:asc"},{"key":"statuses","value":"DRAFT"}],"variable":[{"disabled":false,"type":"any","value":"44e5411f-17ee-ab70-9112-0c776aafa909","key":"SchemaIdentifier","description":"(Required) Schema identifier - can be a UUID (SchemaId) or a human-readable string (Schema AppId/API name, 3-25 characters)"},{"disabled":false,"type":"any","value":"10cc476e-4cea-1124-9ba2-805e59214048","key":"RecordIdentifier","description":"(Required) Record identifier - can be a UUID (RecordId) or a human-readable slug (RecordSlug, 6-40 characters)"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\",\n \"status\": 647,\n \"timestamp\": \"string\",\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"cd741195-b7f4-4b38-b5ac-51707d55f961","name":"Forbidden; insufficient permissions. See error message for details.","originalRequest":{"url":{"path":["brickworks","v1","schemas",":SchemaIdentifier","records",":RecordIdentifier","versions"],"host":["{{baseUrl}}"],"query":[{"key":"limit","value":"50"},{"key":"page","value":"1"},{"key":"filters","value":"string"},{"key":"sortBy","value":"updatedAt:asc"},{"key":"statuses","value":"DRAFT"}],"variable":[{"disabled":false,"type":"any","value":"44e5411f-17ee-ab70-9112-0c776aafa909","key":"SchemaIdentifier","description":"(Required) Schema identifier - can be a UUID (SchemaId) or a human-readable string (Schema AppId/API name, 3-25 characters)"},{"disabled":false,"type":"any","value":"10cc476e-4cea-1124-9ba2-805e59214048","key":"RecordIdentifier","description":"(Required) Record identifier - can be a UUID (RecordId) or a human-readable slug (RecordSlug, 6-40 characters)"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\",\n \"status\": 647,\n \"timestamp\": \"string\",\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"be7bfc4d-df89-45eb-9887-d1a891f1fd7f","name":"Resource not found. See error message for details.","originalRequest":{"url":{"path":["brickworks","v1","schemas",":SchemaIdentifier","records",":RecordIdentifier","versions"],"host":["{{baseUrl}}"],"query":[{"key":"limit","value":"50"},{"key":"page","value":"1"},{"key":"filters","value":"string"},{"key":"sortBy","value":"updatedAt:asc"},{"key":"statuses","value":"DRAFT"}],"variable":[{"disabled":false,"type":"any","value":"44e5411f-17ee-ab70-9112-0c776aafa909","key":"SchemaIdentifier","description":"(Required) Schema identifier - can be a UUID (SchemaId) or a human-readable string (Schema AppId/API name, 3-25 characters)"},{"disabled":false,"type":"any","value":"10cc476e-4cea-1124-9ba2-805e59214048","key":"RecordIdentifier","description":"(Required) Record identifier - can be a UUID (RecordId) or a human-readable slug (RecordSlug, 6-40 characters)"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"httpStatus\": 8176,\n \"errorCode\": \"string\",\n \"timestamp\": \"2009-08-02T10:31:15.071Z\",\n \"message\": \"string\",\n \"traceId\": \"string\",\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"source\": {\n \"pointer\": \"string\",\n \"value\": \"string\"\n },\n \"details\": {\n \"key_0\": {}\n },\n \"field\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"badba8c3-fb50-4837-be4d-5d9417119719","name":"The request could not be completed due to a conflict with the current state of the resource. See error message for details.","originalRequest":{"url":{"path":["brickworks","v1","schemas",":SchemaIdentifier","records",":RecordIdentifier","versions"],"host":["{{baseUrl}}"],"query":[{"key":"limit","value":"50"},{"key":"page","value":"1"},{"key":"filters","value":"string"},{"key":"sortBy","value":"updatedAt:asc"},{"key":"statuses","value":"DRAFT"}],"variable":[{"disabled":false,"type":"any","value":"44e5411f-17ee-ab70-9112-0c776aafa909","key":"SchemaIdentifier","description":"(Required) Schema identifier - can be a UUID (SchemaId) or a human-readable string (Schema AppId/API name, 3-25 characters)"},{"disabled":false,"type":"any","value":"10cc476e-4cea-1124-9ba2-805e59214048","key":"RecordIdentifier","description":"(Required) Record identifier - can be a UUID (RecordId) or a human-readable slug (RecordSlug, 6-40 characters)"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Conflict","code":409,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"httpStatus\": 8176,\n \"errorCode\": \"string\",\n \"timestamp\": \"2009-08-02T10:31:15.071Z\",\n \"message\": \"string\",\n \"traceId\": \"string\",\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"source\": {\n \"pointer\": \"string\",\n \"value\": \"string\"\n },\n \"details\": {\n \"key_0\": {}\n },\n \"field\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"c750bae2-f2fa-4d0d-865c-384a45726d49","name":"The request was well-formed but could not be processed due to semantic or domain-related constraints. See error message for details.","originalRequest":{"url":{"path":["brickworks","v1","schemas",":SchemaIdentifier","records",":RecordIdentifier","versions"],"host":["{{baseUrl}}"],"query":[{"key":"limit","value":"50"},{"key":"page","value":"1"},{"key":"filters","value":"string"},{"key":"sortBy","value":"updatedAt:asc"},{"key":"statuses","value":"DRAFT"}],"variable":[{"disabled":false,"type":"any","value":"44e5411f-17ee-ab70-9112-0c776aafa909","key":"SchemaIdentifier","description":"(Required) Schema identifier - can be a UUID (SchemaId) or a human-readable string (Schema AppId/API name, 3-25 characters)"},{"disabled":false,"type":"any","value":"10cc476e-4cea-1124-9ba2-805e59214048","key":"RecordIdentifier","description":"(Required) Record identifier - can be a UUID (RecordId) or a human-readable slug (RecordSlug, 6-40 characters)"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"httpStatus\": 8176,\n \"errorCode\": \"string\",\n \"timestamp\": \"2009-08-02T10:31:15.071Z\",\n \"message\": \"string\",\n \"traceId\": \"string\",\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"source\": {\n \"pointer\": \"string\",\n \"value\": \"string\"\n },\n \"details\": {\n \"key_0\": {}\n },\n \"field\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"d649d09e-5b13-431a-b99d-e5dadb395842","name":"See error message for details.","originalRequest":{"url":{"path":["brickworks","v1","schemas",":SchemaIdentifier","records",":RecordIdentifier","versions"],"host":["{{baseUrl}}"],"query":[{"key":"limit","value":"50"},{"key":"page","value":"1"},{"key":"filters","value":"string"},{"key":"sortBy","value":"updatedAt:asc"},{"key":"statuses","value":"DRAFT"}],"variable":[{"disabled":false,"type":"any","value":"44e5411f-17ee-ab70-9112-0c776aafa909","key":"SchemaIdentifier","description":"(Required) Schema identifier - can be a UUID (SchemaId) or a human-readable string (Schema AppId/API name, 3-25 characters)"},{"disabled":false,"type":"any","value":"10cc476e-4cea-1124-9ba2-805e59214048","key":"RecordIdentifier","description":"(Required) Record identifier - can be a UUID (RecordId) or a human-readable slug (RecordSlug, 6-40 characters)"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"httpStatus\": 8176,\n \"errorCode\": \"string\",\n \"timestamp\": \"2009-08-02T10:31:15.071Z\",\n \"message\": \"string\",\n \"traceId\": \"string\",\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"source\": {\n \"pointer\": \"string\",\n \"value\": \"string\"\n },\n \"details\": {\n \"key_0\": {}\n },\n \"field\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"4d891b8f-c034-4a40-9291-786ce050f23c","name":"Get record version","request":{"name":"Get record version","description":{"content":"Retrieve the details of a record version. The version can be identified by either a UUID (RecordVersionId) or a version number (integer).\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `BRICKWORKS_RECORDS_READ`\n\n**User role permission required:** `assets_brickworks: read`\n","type":"text/plain"},"url":{"path":["brickworks","v1","schemas",":SchemaIdentifier","records",":RecordIdentifier","versions",":RecordVersionIdentifier"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"44e5411f-17ee-ab70-9112-0c776aafa909","key":"SchemaIdentifier","description":"(Required) Schema identifier - can be a UUID (SchemaId) or a human-readable string (Schema AppId/API name, 3-25 characters)"},{"disabled":false,"type":"any","value":"10cc476e-4cea-1124-9ba2-805e59214048","key":"RecordIdentifier","description":"(Required) Record identifier - can be a UUID (RecordId) or a human-readable slug (RecordSlug, 6-40 characters)"},{"disabled":false,"type":"any","value":"8f246b2c-e35a-9434-0a54-4ba14f9b8e5a","key":"RecordVersionIdentifier","description":"(Required) Record version identifier - can be a UUID (RecordVersionId) or a version number (integer)"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"bearer","bearer":[{"key":"token","value":"{{bearerToken}}"}]}},"response":[{"id":"a3e721f0-f148-4b98-8992-a15cc0cb3d20","name":"Record version object","originalRequest":{"url":{"path":["brickworks","v1","schemas",":SchemaIdentifier","records",":RecordIdentifier","versions",":RecordVersionIdentifier"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"44e5411f-17ee-ab70-9112-0c776aafa909","key":"SchemaIdentifier","description":"(Required) Schema identifier - can be a UUID (SchemaId) or a human-readable string (Schema AppId/API name, 3-25 characters)"},{"disabled":false,"type":"any","value":"10cc476e-4cea-1124-9ba2-805e59214048","key":"RecordIdentifier","description":"(Required) Record identifier - can be a UUID (RecordId) or a human-readable slug (RecordSlug, 6-40 characters)"},{"disabled":false,"type":"any","value":"8f246b2c-e35a-9434-0a54-4ba14f9b8e5a","key":"RecordVersionIdentifier","description":"(Required) Record version identifier - can be a UUID (RecordVersionId) or a version number (integer)"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"versionId\": \"0cd1ba10-2349-8a92-a012-21793166300c\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"5d4c8325-5db5-4b3a-86e4-748dbe11aecf","name":"Incorrect request (malformed JSON, wrong parameters, etc.). See error message for details.","originalRequest":{"url":{"path":["brickworks","v1","schemas",":SchemaIdentifier","records",":RecordIdentifier","versions",":RecordVersionIdentifier"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"44e5411f-17ee-ab70-9112-0c776aafa909","key":"SchemaIdentifier","description":"(Required) Schema identifier - can be a UUID (SchemaId) or a human-readable string (Schema AppId/API name, 3-25 characters)"},{"disabled":false,"type":"any","value":"10cc476e-4cea-1124-9ba2-805e59214048","key":"RecordIdentifier","description":"(Required) Record identifier - can be a UUID (RecordId) or a human-readable slug (RecordSlug, 6-40 characters)"},{"disabled":false,"type":"any","value":"8f246b2c-e35a-9434-0a54-4ba14f9b8e5a","key":"RecordVersionIdentifier","description":"(Required) Record version identifier - can be a UUID (RecordVersionId) or a version number (integer)"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"httpStatus\": 8176,\n \"errorCode\": \"string\",\n \"timestamp\": \"2009-08-02T10:31:15.071Z\",\n \"message\": \"string\",\n \"traceId\": \"string\",\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"source\": {\n \"pointer\": \"string\",\n \"value\": \"string\"\n },\n \"details\": {\n \"key_0\": {}\n },\n \"field\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"2c2a4c4e-4abf-4f1b-b07c-cc7089a8f4ce","name":"Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc. See error message for details.","originalRequest":{"url":{"path":["brickworks","v1","schemas",":SchemaIdentifier","records",":RecordIdentifier","versions",":RecordVersionIdentifier"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"44e5411f-17ee-ab70-9112-0c776aafa909","key":"SchemaIdentifier","description":"(Required) Schema identifier - can be a UUID (SchemaId) or a human-readable string (Schema AppId/API name, 3-25 characters)"},{"disabled":false,"type":"any","value":"10cc476e-4cea-1124-9ba2-805e59214048","key":"RecordIdentifier","description":"(Required) Record identifier - can be a UUID (RecordId) or a human-readable slug (RecordSlug, 6-40 characters)"},{"disabled":false,"type":"any","value":"8f246b2c-e35a-9434-0a54-4ba14f9b8e5a","key":"RecordVersionIdentifier","description":"(Required) Record version identifier - can be a UUID (RecordVersionId) or a version number (integer)"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\",\n \"status\": 647,\n \"timestamp\": \"string\",\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"5534d071-bada-4bcb-914e-38af28a02716","name":"Forbidden; insufficient permissions. See error message for details.","originalRequest":{"url":{"path":["brickworks","v1","schemas",":SchemaIdentifier","records",":RecordIdentifier","versions",":RecordVersionIdentifier"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"44e5411f-17ee-ab70-9112-0c776aafa909","key":"SchemaIdentifier","description":"(Required) Schema identifier - can be a UUID (SchemaId) or a human-readable string (Schema AppId/API name, 3-25 characters)"},{"disabled":false,"type":"any","value":"10cc476e-4cea-1124-9ba2-805e59214048","key":"RecordIdentifier","description":"(Required) Record identifier - can be a UUID (RecordId) or a human-readable slug (RecordSlug, 6-40 characters)"},{"disabled":false,"type":"any","value":"8f246b2c-e35a-9434-0a54-4ba14f9b8e5a","key":"RecordVersionIdentifier","description":"(Required) Record version identifier - can be a UUID (RecordVersionId) or a version number (integer)"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"string\",\n \"status\": 647,\n \"timestamp\": \"string\",\n \"message\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"ec23a93d-5535-4a91-acea-bdf304a08254","name":"Resource not found. See error message for details.","originalRequest":{"url":{"path":["brickworks","v1","schemas",":SchemaIdentifier","records",":RecordIdentifier","versions",":RecordVersionIdentifier"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"44e5411f-17ee-ab70-9112-0c776aafa909","key":"SchemaIdentifier","description":"(Required) Schema identifier - can be a UUID (SchemaId) or a human-readable string (Schema AppId/API name, 3-25 characters)"},{"disabled":false,"type":"any","value":"10cc476e-4cea-1124-9ba2-805e59214048","key":"RecordIdentifier","description":"(Required) Record identifier - can be a UUID (RecordId) or a human-readable slug (RecordSlug, 6-40 characters)"},{"disabled":false,"type":"any","value":"8f246b2c-e35a-9434-0a54-4ba14f9b8e5a","key":"RecordVersionIdentifier","description":"(Required) Record version identifier - can be a UUID (RecordVersionId) or a version number (integer)"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"httpStatus\": 8176,\n \"errorCode\": \"string\",\n \"timestamp\": \"2009-08-02T10:31:15.071Z\",\n \"message\": \"string\",\n \"traceId\": \"string\",\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"source\": {\n \"pointer\": \"string\",\n \"value\": \"string\"\n },\n \"details\": {\n \"key_0\": {}\n },\n \"field\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"b5f63ae6-cbb2-47fa-982f-c81dff7cfa31","name":"The request could not be completed due to a conflict with the current state of the resource. See error message for details.","originalRequest":{"url":{"path":["brickworks","v1","schemas",":SchemaIdentifier","records",":RecordIdentifier","versions",":RecordVersionIdentifier"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"44e5411f-17ee-ab70-9112-0c776aafa909","key":"SchemaIdentifier","description":"(Required) Schema identifier - can be a UUID (SchemaId) or a human-readable string (Schema AppId/API name, 3-25 characters)"},{"disabled":false,"type":"any","value":"10cc476e-4cea-1124-9ba2-805e59214048","key":"RecordIdentifier","description":"(Required) Record identifier - can be a UUID (RecordId) or a human-readable slug (RecordSlug, 6-40 characters)"},{"disabled":false,"type":"any","value":"8f246b2c-e35a-9434-0a54-4ba14f9b8e5a","key":"RecordVersionIdentifier","description":"(Required) Record version identifier - can be a UUID (RecordVersionId) or a version number (integer)"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Conflict","code":409,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"httpStatus\": 8176,\n \"errorCode\": \"string\",\n \"timestamp\": \"2009-08-02T10:31:15.071Z\",\n \"message\": \"string\",\n \"traceId\": \"string\",\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"source\": {\n \"pointer\": \"string\",\n \"value\": \"string\"\n },\n \"details\": {\n \"key_0\": {}\n },\n \"field\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"77d8fd44-8191-4659-9e6c-08d4d38847a6","name":"The request was well-formed but could not be processed due to semantic or domain-related constraints. See error message for details.","originalRequest":{"url":{"path":["brickworks","v1","schemas",":SchemaIdentifier","records",":RecordIdentifier","versions",":RecordVersionIdentifier"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"44e5411f-17ee-ab70-9112-0c776aafa909","key":"SchemaIdentifier","description":"(Required) Schema identifier - can be a UUID (SchemaId) or a human-readable string (Schema AppId/API name, 3-25 characters)"},{"disabled":false,"type":"any","value":"10cc476e-4cea-1124-9ba2-805e59214048","key":"RecordIdentifier","description":"(Required) Record identifier - can be a UUID (RecordId) or a human-readable slug (RecordSlug, 6-40 characters)"},{"disabled":false,"type":"any","value":"8f246b2c-e35a-9434-0a54-4ba14f9b8e5a","key":"RecordVersionIdentifier","description":"(Required) Record version identifier - can be a UUID (RecordVersionId) or a version number (integer)"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"httpStatus\": 8176,\n \"errorCode\": \"string\",\n \"timestamp\": \"2009-08-02T10:31:15.071Z\",\n \"message\": \"string\",\n \"traceId\": \"string\",\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"source\": {\n \"pointer\": \"string\",\n \"value\": \"string\"\n },\n \"details\": {\n \"key_0\": {}\n },\n \"field\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"a712167c-e7c9-4f89-a090-0a30ea717197","name":"See error message for details.","originalRequest":{"url":{"path":["brickworks","v1","schemas",":SchemaIdentifier","records",":RecordIdentifier","versions",":RecordVersionIdentifier"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"44e5411f-17ee-ab70-9112-0c776aafa909","key":"SchemaIdentifier","description":"(Required) Schema identifier - can be a UUID (SchemaId) or a human-readable string (Schema AppId/API name, 3-25 characters)"},{"disabled":false,"type":"any","value":"10cc476e-4cea-1124-9ba2-805e59214048","key":"RecordIdentifier","description":"(Required) Record identifier - can be a UUID (RecordId) or a human-readable slug (RecordSlug, 6-40 characters)"},{"disabled":false,"type":"any","value":"8f246b2c-e35a-9434-0a54-4ba14f9b8e5a","key":"RecordVersionIdentifier","description":"(Required) Record version identifier - can be a UUID (RecordVersionId) or a version number (integer)"}]},"header":[{"description":{"content":"Added as a part of security scheme: bearer","type":"text/plain"},"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"httpStatus\": 8176,\n \"errorCode\": \"string\",\n \"timestamp\": \"2009-08-02T10:31:15.071Z\",\n \"message\": \"string\",\n \"traceId\": \"string\",\n \"errors\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"source\": {\n \"pointer\": \"string\",\n \"value\": \"string\"\n },\n \"details\": {\n \"key_0\": {}\n },\n \"field\": \"string\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}],"event":[]}],"event":[],"variable":[{"type":"string","value":"https://api.synerise.com","key":"baseUrl"}],"info":{"_postman_id":"e139236d-eb20-47b3-8cfc-e47350b2fb5b","name":"Synerise Public API","schema":"https://schema.getpostman.com/json/collection/v2.1.0/collection.json","description":{"content":"","type":"text/plain"}}}