Skip to content

Latest commit

 

History

History
110 lines (89 loc) · 5.71 KB

IdentityApi.md

File metadata and controls

110 lines (89 loc) · 5.71 KB
Raw

UserVoiceSdk.Api.IdentityApi

Method HTTP request Description
BulkIdentify POST /admin/bulk_identify # Add or update traits for a batch of users.

BulkIdentify

void BulkIdentify (List identities, string identitiesIId = null, string identitiesIEmail = null, string identitiesIName = null, long? identitiesICreatedAt = null, string identitiesIType = null, string identitiesIAccountId = null, string identitiesIAccountName = null, long? identitiesIAccountCreatedAt = null, double? identitiesIAccountMonthlyRate = null, double? identitiesIAccountLtv = null, string identitiesIAccountPlan = null)

Add or update traits for a batch of users.

Example

using System;
using System.Diagnostics;
using UserVoiceSdk.Api;
using UserVoiceSdk.Client;
using UserVoiceSdk.Models;

namespace Example
{
    public class BulkIdentifyExample
    {
        private string ApiKey = "some_key";
        private string ApiSecret = "some_secret";
        private string Subdomain = "sub";
        private string Domain = "uservoice.com";

		// Credentials for authenticating as a user
		private string Username = "[email protected]";
		private string Password = "Somepassword1234!";

        public void main()
        {
            var client = new ApiClient(subdomain: Subdomain,
									   clientId: ApiKey,
									   domain: Domain,
									   clientSecret: ApiSecret);

			// Authentication takes place on request when a token is not available
			// However, you can explicitly login using the functions below
			//client.Login(ApiKey, ApiSecret);
			//client.LoginAsUser(ApiKey, Username, Password);

            var identities = new List<string>(); // List<string> | Each element with index i has these fields:
            var identitiesIId = identitiesIId_example;  // string | external identifier for this user (optional) 
            var identitiesIEmail = identitiesIEmail_example;  // string | required to match a user in the UserVoice database (optional) 
            var identitiesIName = identitiesIName_example;  // string | user’s real name (optional) 
            var identitiesICreatedAt = 789;  // long? | unix timestamp for the date the user signed up (optional) 
            var identitiesIType = identitiesIType_example;  // string | used for segmenting users by type (optional) 
            var identitiesIAccountId = identitiesIAccountId_example;  // string | external identifier for this user’s account (optional) 
            var identitiesIAccountName = identitiesIAccountName_example;  // string | account name (optional) 
            var identitiesIAccountCreatedAt = 789;  // long? | unix timestamp for the date the account was created (optional) 
            var identitiesIAccountMonthlyRate = 1.2;  // double? | decimal; monthly rate of the account (optional) 
            var identitiesIAccountLtv = 1.2;  // double? | decimal; lifetime value of the account (optional) 
            var identitiesIAccountPlan = identitiesIAccountPlan_example;  // string | plan name for the account (optional) 

            try
            {
                // # Add or update traits for a batch of users.
                client.Identity.BulkIdentify(identities, identitiesIId, identitiesIEmail, identitiesIName, identitiesICreatedAt, identitiesIType, identitiesIAccountId, identitiesIAccountName, identitiesIAccountCreatedAt, identitiesIAccountMonthlyRate, identitiesIAccountLtv, identitiesIAccountPlan);
            }
            catch (RateLimitException rle)
            {
                Debug.Print(string.Format("Rate limit exceeded. Limit: {0}, Remaining: {1}, Reset: {2}", client.RateLimiting.Limit, client.RateLimiting.Remaining, client.RateLimiting.Reset));
                Debug.Print(string.Format("Reset in {0} seconds. Reset at {1} UTC", client.RateLimiting.ResetIn(), client.RateLimiting.ResetAt()));
            }
            catch (ApiException e)
            {
                Debug.Print("Exception when calling IdentityApi.BulkIdentify: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
identities List Each element with index i has these fields:
identitiesIId string external identifier for this user [optional]
identitiesIEmail string required to match a user in the UserVoice database [optional]
identitiesIName string user’s real name [optional]
identitiesICreatedAt long? unix timestamp for the date the user signed up [optional]
identitiesIType string used for segmenting users by type [optional]
identitiesIAccountId string external identifier for this user’s account [optional]
identitiesIAccountName string account name [optional]
identitiesIAccountCreatedAt long? unix timestamp for the date the account was created [optional]
identitiesIAccountMonthlyRate double? decimal; monthly rate of the account [optional]
identitiesIAccountLtv double? decimal; lifetime value of the account [optional]
identitiesIAccountPlan string plan name for the account [optional]

Return type

void (empty response body)

Authorization

oauth2_password, oauth2_client_credentials

HTTP request headers

  • Content-Type: application/x-www-form-urlencoded
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]