Use the User Hub Bulk APIs to import your end users' data into Helpshift, and export current end user data from Helpshift.
\nTo use this Postman collection, you will need to know your Helpshift domain and the API key, which is available on the admin dashboard under Settings -> APIs.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"14405739","collectionId":"b2c8b408-09ca-4678-b3fd-5b1b742bf792","publishedId":"2sAYkKGwzQ","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2025-03-25T03:59:10.000Z"},"item":[{"name":"Create Bulk Action Task","event":[{"listen":"test","script":{"exec":["pm.test(\"Successful POST request\", function () {"," pm.expect(pm.response.code).to.be.oneOf([201]);","});","if (pm.response.code != 201) {"," return;","}","","var jsonData = pm.response.json();","// if the bulk task was created, save the task-id for future requests","pm.environment.set(\"task_id\", jsonData.task_id);","console.log(\"Setting task_id to \" + jsonData.task_id);"],"type":"text/javascript","packages":{},"id":"47a8b43d-6758-49c3-b283-01f1e33cc342"}}],"id":"35a739dd-d1b1-4589-845c-def4304c7eda","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"action","value":"create_core_profiles","type":"text"},{"key":"payload","value":"[{\"identities\":[{\"uid\":\"uid-1\"}],\"last_country\":\"India\",\"last_city\":\"Pune\"},{\"identities\":[{\"uid\":\"uid-2\"}],\"last_country\":\"Pakistan\",\"last_city\":\"Karachi\"},{\"identities\":[{\"uid\":\"uid-3\"}],\"last_country\":\"Sri Lanka\",\"last_city\":\"Colombo\"}]","type":"text"}]},"url":"https://api.helpshift.com/v2/{{domain}}/identity/bulk_actions","description":"Create a new Bulk Import task to import end user data into Helpshift, or export end user data from Helpshift.
\nThe following task types are supported -
\ncreate_core_profiles - Create new core profiles (domain level profiles corresponding to an end user)
\nupdate_core_profiles - Update existing core profiles
\nupdate_app_profiles - Update existing app profiles (end user profiles for a specific app)
\nget_core_profiles - Export existing core profiles as JSON
\nget_app_profiles - Export existing app profiles as JSON
\nThe payload for each task type varies, and consists of an array of individual requests for the given task type. See https://developers.helpshift.com/rest-api/user-hub-bulk-apis/ for details.
\nThe response will contain the Task ID, which can be used to query for task status, and fetch the results (or errors, if any) once the task is completed.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api-key}}"}]},"isInherited":true,"source":{"_postman_id":"b2c8b408-09ca-4678-b3fd-5b1b742bf792","id":"b2c8b408-09ca-4678-b3fd-5b1b742bf792","name":"User Hub Bulk APIs","type":"collection"}},"urlObject":{"path":["identity","bulk_actions"],"host":["https://api.helpshift.com/v2/{{domain}}"],"query":[],"variable":[]}},"response":[{"id":"d920c8ab-b8a5-40f7-886c-e36f3f01c68d","name":"Create Bulk Action Task","originalRequest":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"action","value":"create_core_profiles","type":"text"},{"key":"payload","value":"[{\"identities\":[{\"uid\":\"uid-1\"}],\"last_country\":\"India\",\"last_city\":\"Pune\"},{\"identities\":[{\"uid\":\"uid-2\"}],\"last_country\":\"Pakistan\",\"last_city\":\"Karachi\"},{\"identities\":[{\"uid\":\"uid-3\"}],\"last_country\":\"Sri Lanka\",\"last_city\":\"Colombo\"}]","type":"text"}]},"url":"https://api.helpshift.com/v2/domain/identity/bulk_actions"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.27.0"},{"key":"Date","value":"Mon, 24 Mar 2025 05:00:48 GMT"},{"key":"Content-Type","value":"application/json;charset=utf-8"},{"key":"Content-Length","value":"46"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Headers","value":"Accept,Authorization,Content-Type,Keep-Alive,Origin,User-Agent,X-Requested-With,X-Hs-Access-Token"},{"key":"Access-Control-Max-Age","value":"86400"},{"key":"X-Rate-Limit-Remaining","value":"59"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"x-hs-request-id","value":"deffcb5b-f630-4c5f-8e6f-606daebdc7a7"},{"key":"X-Rate-Limit-Reset","value":"1742792447182"},{"key":"X-Rate-Limit-Limit","value":"60"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, PUT, DELETE, OPTIONS"}],"cookie":[],"responseTime":null,"body":"{\n \"task_id\": 2537897885211136,\n \"state\": \"created\"\n}"}],"_postman_id":"35a739dd-d1b1-4589-845c-def4304c7eda"},{"name":"Get Task Status","id":"9ddfac59-dca9-4c0b-af48-f503e5940a81","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.helpshift.com/v2/{{domain}}/identity/bulk_actions/{{task_id}}","description":"Get the current status of a previoiusly created Bulk Action task.
\nThe response will contain the current state of the task, which can be one of -
\ncreated - task has been created, but not picked for execution yet
\nqueued - task has been validated, and queued for processing
\nprocessing - the task is currentl;y being processed
\ncompleted - the task has finished, either successfully, or with errors
\nThe response will also contain a progress percentage, and two boolean flags -
\nerrors - when true, the task result had one or more errors
\nresults - when true, the task results are available for download
\nGet the results of the given bulk action task.
\nThe API response will be a compressed file containing JSON data. The format of the JSON data will vary based on the task type.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api-key}}"}]},"isInherited":true,"source":{"_postman_id":"b2c8b408-09ca-4678-b3fd-5b1b742bf792","id":"b2c8b408-09ca-4678-b3fd-5b1b742bf792","name":"User Hub Bulk APIs","type":"collection"}},"urlObject":{"path":["identity","bulk_actions","{{task_id}}","results"],"host":["https://api.helpshift.com/v2/{{domain}}"],"query":[],"variable":[]}},"response":[{"id":"e5caa7ec-ca63-4d2c-8a5f-ff2c94bdab3c","name":"Get Task Results","originalRequest":{"method":"GET","header":[],"url":"https://api.helpshift.com/v2/domain/identity/bulk_actions//results"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"Get details of any errors encountered while processing the given bulk action task.
\nThe API response will be a compressed file containing JSON data. The format of the JSON data will vary based on the task type. If there were no errors, the file will be empty.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api-key}}"}]},"isInherited":true,"source":{"_postman_id":"b2c8b408-09ca-4678-b3fd-5b1b742bf792","id":"b2c8b408-09ca-4678-b3fd-5b1b742bf792","name":"User Hub Bulk APIs","type":"collection"}},"urlObject":{"path":["identity","bulk_actions","{{task_id}}","errors"],"host":["https://api.helpshift.com/v2/{{domain}}"],"query":[],"variable":[]}},"response":[{"id":"2438cb5b-fda8-4d06-9ba1-58d732b5698a","name":"Get Task Errors","originalRequest":{"method":"GET","header":[],"url":"https://api.helpshift.com/v2/domain/identity/bulk_actions//errors"},"code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"