User Hub Bulk APIs

Use the User Hub Bulk APIs to import your end users' data into Helpshift, and export current end user data from Helpshift.

To 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.

AUTHORIZATIONBearer Token

Token

POSTCreate Bulk Action Task

https://api.helpshift.com/v2/{{domain}}/identity/bulk_actions

Create a new Bulk Import task to import end user data into Helpshift, or export end user data from Helpshift.

The following task types are supported -

create_core_profiles - Create new core profiles (domain level profiles corresponding to an end user)

update_core_profiles - Update existing core profiles

update_app_profiles - Update existing app profiles (end user profiles for a specific app)

get_core_profiles - Export existing core profiles as JSON

get_app_profiles - Export existing app profiles as JSON

The 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.

The 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.

AUTHORIZATIONBearer Token

This request is using Bearer Token from collectionUser Hub Bulk APIs

Bodyurlencoded

action

create_core_profiles

payload

[{"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"}]

Example Request

curl

curl --location 'https://api.helpshift.com/v2/domain/identity/bulk_actions' \
--data-urlencode 'action=create_core_profiles' \
--data-urlencode 'payload=[{"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"}]'

201 Created

Example Response

json

{
  "task_id": 2537897885211136,
  "state": "created"
}

Server

nginx/1.27.0

Date

Mon, 24 Mar 2025 05:00:48 GMT

Content-Type

application/json;charset=utf-8

Content-Length

Connection

keep-alive

Access-Control-Allow-Headers

Accept,Authorization,Content-Type,Keep-Alive,Origin,User-Agent,X-Requested-With,X-Hs-Access-Token

Access-Control-Max-Age

86400

X-Rate-Limit-Remaining

Access-Control-Allow-Credentials

true

x-hs-request-id

deffcb5b-f630-4c5f-8e6f-606daebdc7a7

X-Rate-Limit-Reset

1742792447182

X-Rate-Limit-Limit

Access-Control-Allow-Methods

GET, POST, PUT, DELETE, OPTIONS

GETGet Task Status

https://api.helpshift.com/v2/{{domain}}/identity/bulk_actions/{{task_id}}

Get the current status of a previoiusly created Bulk Action task.

The response will contain the current state of the task, which can be one of -

created - task has been created, but not picked for execution yet

queued - task has been validated, and queued for processing

processing - the task is currentl;y being processed

completed - the task has finished, either successfully, or with errors

The response will also contain a progress percentage, and two boolean flags -

errors - when true, the task result had one or more errors

results - when true, the task results are available for download

AUTHORIZATIONBearer Token

This request is using Bearer Token from collectionUser Hub Bulk APIs

Example Request

curl

curl --location 'https://api.helpshift.com/v2/domain/identity/bulk_actions/'

200 OK

Example Response

json

{
  "state": "created",
  "progress_percentage": 0,
  "errors": false,
  "results": false
}

Server

nginx/1.27.0

Date

Mon, 24 Mar 2025 05:00:57 GMT

Content-Type

application/json;charset=utf-8

Content-Length

Connection

keep-alive

Access-Control-Allow-Headers

Accept,Authorization,Content-Type,Keep-Alive,Origin,User-Agent,X-Requested-With,X-Hs-Access-Token

Access-Control-Max-Age

86400

X-Rate-Limit-Remaining

Access-Control-Allow-Credentials

true

x-hs-request-id

9bd3a975-fb7c-4487-9eb4-ed1de4cbc430

X-Rate-Limit-Reset

1742792507462

X-Rate-Limit-Limit

Access-Control-Allow-Methods

GET, POST, PUT, DELETE, OPTIONS

GETGet Task Results

https://api.helpshift.com/v2/{{domain}}/identity/bulk_actions/{{task_id}}/results

Get the results of the given bulk action task.

The API response will be a compressed file containing JSON data. The format of the JSON data will vary based on the task type.

AUTHORIZATIONBearer Token

This request is using Bearer Token from collectionUser Hub Bulk APIs

Example Request

curl

curl --location 'https://api.helpshift.com/v2/domain/identity/bulk_actions//results'

200 OK

Example Response

Text

<zip file containing results of bulk actions>

No response headers

This request doesn't return any response headers

GETGet Task Errors

https://api.helpshift.com/v2/{{domain}}/identity/bulk_actions/{{task_id}}/errors

Get details of any errors encountered while processing the given bulk action task.

The 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.

AUTHORIZATIONBearer Token

This request is using Bearer Token from collectionUser Hub Bulk APIs

Example Request

curl

curl --location 'https://api.helpshift.com/v2/domain/identity/bulk_actions//errors'

Example Response

Text

<zip file containing errors encountered during bulk action processing>

No response headers

This request doesn't return any response headers