Import User and Account traits with the API

Our API now allows you to identify your users into the UserVoice system quickly and efficiently. Using our simple REST API you can import up to 1000 of your users in a single request. You can import all your users once, and then periodically sync them to our system using this API. If you're already tracking users using our widget SDK you should be familiar with the format, except it now allows multiple identities at once.

You can send a POST request to https://youraccount.uservoice.com/api/v2/admin/bulk_identify and include a body like:

{
  "identities": [
    {
      "account": {
        "created_at": 1364406966,
        "id": 200,
        "ltv": 1495,
        "monthly_rate": 9.99,
        "name": "Acme, Co.",
        "plan": "Enhanced"
      },
      "created_at": 1364406966,
      "email": "john.doe@example.com",
      "id": 123,
      "name": "John Doe",
      "type": "Owner"
    },
    {
      "account": {
        "created_at": 1364406146,
        "id": 201,
        "ltv": 56.0078,
        "monthly_rate": 9.99,
        "plan": "Enhanced"
      },
      "created_at": 1364406966,
      "email": "jane.doe@example.com",
      "id": 124,
      "name": "Jane Doe",
      "type": "Admin"
    },
  ]
}
See this document for more details on how to form the API request: https://developer.uservoice.com/docs/api/v2/reference/#/identity_0

Upon success, the server will return:
{
  "status": "queued"
}
This indicates the request was successful, and the identities are queued for processing into our system. 

NOTE: Traits passed will take 2 minutes to update in the UserVoice admin. In the case of the User Satisfaction report, the newest traits will only show after a new rating has been given.

Frequently Asked Questions


1. Can I use this API identify endpoint in conjunction the Javascript SDK? 
  • Yes. This API endpoint is exactly as if you had identified the users with the widget, except it can be done in bulk and doesn't require the widget.
2. In the dashboard, we show XX identified users in the last 30 days. If you identify users with the API call, would they count in the dashboard? 
  • No, they are not marked as active so won't appear there until they actually do some activity.
3. If I identify the user, but the user has not created a profile (so has not signed into our system), can you find that user via search?
  • No. It's exactly like before they just don't have to use the widget to pass us the info anymore.

Feedback and Knowledge Base