Customers

Provides methods for working with customer objects and data.

Upgrade Customer

Upgrades an existing Customer, including placing them in the Sponsor tree.

This takes the same payload as "Update Customer".

This call goes through the hook "Associates.Enrollment.UpdateAssociateBaseType", in the Client Extension. You can influence the actions this performs by implementing this hook in the Extension. This call only upgrades from Customer (type 2) to Distributor (type 1). Upgrading otherwise will require additional work in the hook. This was decided, because an upgrade contains specific data requirements by client.

This call performs the exact work of the Update call, except that it:

Logs the change to the CRM_AssociateTypeChanges table

Note: This call requires an update to all of the Customer's information. Therefore, if a field is omitted or remains blank, the update will clear out the existing information. If only a partial update is desired, please use the PATCH Update Customer API call.

Try it

Request

Request URL

https://dsapi-stage.directscale.com/v1/customers/upgrade/{customerId}

Request parameters

customerId

int

Disco internal ID representing customer to upgrade

Request headers

Content-Type (optional)

string

Media type of the body sent to the API.
Ocp-Apim-Subscription-Key

string

Subscription key which provides access to this API. Found in your Profile.

Request body

Required Fields (based on customerType):

BirthDate (1)
- Get Customer
CustomerType (1, 2, 3)
- Get Customer
DefaultShippingAddress (1)
- street1
- PostalCode
- City
- CountryCode
EmailAddress (1, 2, 3)
- Get Customer
FirstName (1, 2, 3)
- Get Customer
LastName (1, 2, 3)
- Get Customer
Password (1, 2)
PrimaryAddress (1, 2, 3)
- street1
- Region
- CountryCode
SponsorId (1, 2, 3)
- Get Customer
TaxId (1)
- Get Customer
TermsAccepted (1)
Username (1, 2, 3)
- Get Customer

Uniqueness Required:

BackOfficeId
EmailAddress
TaxId
Username
WebAlias

NOTE: Unique variables can be validated with our Validate API calls.

Note: Many of the property's behaviors can be changed by the implementation of the commission plan to allow the property to be optional or have different uniqueness characteristics. Please contact your support representative for specific details.

{
  "BackOfficeId": "TestBackOfficeId01",
  "BirthDate": "1973-05-12T00:00:00Z",
  "CompanyName": "Test Company Name Inc.",
  "CustomerStatus": 1,
  "CustomerType": 1,
  "DefaultShippingAddress": {
    "Street1": "250 South 400 West",
    "Street2": "Suite #225",
    "PostalCode": "84042",
    "City": "Lindon",
    "Region": "UT",
    "CountryCode": "US"
  },
  "EmailAddress": "directScaleTest@testing.directscale.com",
  "ExternalReferenceId": "EXT1234567890",
  "FirstName": "Ryan",
  "LanguageCode": "en",
  "LastName": "Testing",
  "Password": "PasswordHere1",
  "PrimaryAddress": {
    "Street1": "250 South 400 West",
    "Street2": "Suite #225",
    "PostalCode": "84042",
    "City": "Lindon",
    "Region": "UT",
    "CountryCode": "US"
  },
  "PrimaryPhone": "+1 801 555-1111",
  "SecondaryPhone": "+1 801 555-2222",
  "SendEmails": true,
  "SignUpDate": "1988-01-01T00:00:00Z",
  "SponsorId": 2,
  "TaxExempt": false,
  "TaxExemptId": "TAX-TEST-0000",
  "TaxId": "TAX-TEST-1111",
  "TermsAccepted": true,
  "TextPhone": "+1 801 555-1111",
  "Username": "TestUsername01",
  "WebAlias": "TestWebAlias",
  "AssociateCustom": {
    "Field1": "CustomField Content",
    "Field2": "Available through Field10"
  }
}

{
  "BirthDate": "1973-05-12T00:00:00Z",
  "CustomerType": 1,
  "DefaultShippingAddress": {
    "Street1": "250 South 400 West",
    "PostalCode": "84042",
    "City": "Lindon",
    "CountryCode": "US"
  },
  "EmailAddress": "yodaminch@testing.directscale.com",
  "FirstName": "Minch",
  "LastName": "Yoda",
  "Password": "Password123!",
  "PrimaryAddress": {
    "Street1": "250 South 400 West",
    "Region": "UT",
    "CountryCode": "US"
  },
  "SponsorId": 2,
  "TaxExempt": false,
  "TaxId": "TAX-TEST-3333",
  "TermsAccepted": true,
  "Username": "YodaIAm"
}

{
  "CustomerType": 2,
  "EmailAddress": "darthsidious66@testing.directscale.com",
  "FirstName": "Sheev",
  "LastName": "Palpatine",
  "Password": "Password123!",
  "PrimaryAddress": {
    "Street1": "250 South 400 West",
    "Region": "UT",
    "CountryCode": "US"
  },
  "SponsorId": 2,
  "Username": "Emperor Palpatine"
}

{
  "CustomerType": 3,
  "EmailAddress": "bobafett@testing.directscale.com",
  "FirstName": "Boba",
  "LastName": "Fett",
  "PrimaryAddress": {
    "Street1": "250 South 400 West",
    "Region": "UT",
    "CountryCode": "US"
  },
  "SponsorId": 2
}

Responses

201 Created

Signifies that the Customer was upgraded successfully.

500 Internal Server Error

Something went wrong... Here are some possible reasons for this error:

Is the model being sent to the API incorrect?
Did you forget a required field?
Is the API marked as deprecated, and the date has expired?

If the answer is "No" to all of these questions, DirectScale could be experiencing technical difficulties. Please contact your DirectScale representative if the issue persists.

Code samples

@ECHO OFF

curl -v -X PUT "https://dsapi-stage.directscale.com/v1/customers/upgrade/{customerId}"
-H "Content-Type: application/json (full)"
-H "Ocp-Apim-Subscription-Key: {subscription key}"

--data-ascii "{body}"

using System;
using System.Net.Http.Headers;
using System.Text;
using System.Net.Http;
using System.Web;

namespace CSHttpClientSample
{
    static class Program
    {
        static void Main()
        {
            MakeRequest();
            Console.WriteLine("Hit ENTER to exit...");
            Console.ReadLine();
        }
        
        static async void MakeRequest()
        {
            var client = new HttpClient();
            var queryString = HttpUtility.ParseQueryString(string.Empty);

            // Request headers
            client.DefaultRequestHeaders.Add("Ocp-Apim-Subscription-Key", "{subscription key}");

            var uri = "https://dsapi-stage.directscale.com/v1/customers/upgrade/{customerId}?" + queryString;

            HttpResponseMessage response;

            // Request body
            byte[] byteData = Encoding.UTF8.GetBytes("{body}");

            using (var content = new ByteArrayContent(byteData))
            {
                content.Headers.ContentType = new MediaTypeHeaderValue("< your content type, i.e. application/json >");
                response = await client.PutAsync(uri, content);
            }
        }
    }
}

// // This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
import java.net.URI;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.utils.URIBuilder;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;

public class JavaSample 
{
    public static void main(String[] args) 
    {
        HttpClient httpclient = HttpClients.createDefault();

        try
        {
            URIBuilder builder = new URIBuilder("https://dsapi-stage.directscale.com/v1/customers/upgrade/{customerId}");


            URI uri = builder.build();
            HttpPut request = new HttpPut(uri);
            request.setHeader("Content-Type", "application/json (full)");
            request.setHeader("Ocp-Apim-Subscription-Key", "{subscription key}");


            // Request body
            StringEntity reqEntity = new StringEntity("{body}");
            request.setEntity(reqEntity);

            HttpResponse response = httpclient.execute(request);
            HttpEntity entity = response.getEntity();

            if (entity != null) 
            {
                System.out.println(EntityUtils.toString(entity));
            }
        }
        catch (Exception e)
        {
            System.out.println(e.getMessage());
        }
    }
}

<!DOCTYPE html>
<html>
<head>
    <title>JSSample</title>
    <script src="http://ajax.googleapis.com/ajax/libs/jquery/1.9.0/jquery.min.js"></script>
</head>
<body>

<script type="text/javascript">
    $(function() {
        var params = {
            // Request parameters
        };
      
        $.ajax({
            url: "https://dsapi-stage.directscale.com/v1/customers/upgrade/{customerId}?" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
                xhrObj.setRequestHeader("Content-Type","application/json (full)");
                xhrObj.setRequestHeader("Ocp-Apim-Subscription-Key","{subscription key}");
            },
            type: "PUT",
            // Request body
            data: "{body}",
        })
        .done(function(data) {
            alert("success");
        })
        .fail(function() {
            alert("error");
        });
    });
</script>
</body>
</html>

#import <Foundation/Foundation.h>

int main(int argc, const char * argv[])
{
    NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];
    
    NSString* path = @"https://dsapi-stage.directscale.com/v1/customers/upgrade/{customerId}";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                      ];
    
    NSString* string = [array componentsJoinedByString:@"&"];
    path = [path stringByAppendingFormat:@"?%@", string];

    NSLog(@"%@", path);

    NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
    [_request setHTTPMethod:@"PUT"];
    // Request headers
    [_request setValue:@"application/json (full)" forHTTPHeaderField:@"Content-Type"];
    [_request setValue:@"{subscription key}" forHTTPHeaderField:@"Ocp-Apim-Subscription-Key"];
    // Request body
    [_request setHTTPBody:[@"{body}" dataUsingEncoding:NSUTF8StringEncoding]];
    
    NSURLResponse *response = nil;
    NSError *error = nil;
    NSData* _connectionData = [NSURLConnection sendSynchronousRequest:_request returningResponse:&response error:&error];

    if (nil != error)
    {
        NSLog(@"Error: %@", error);
    }
    else
    {
        NSError* error = nil;
        NSMutableDictionary* json = nil;
        NSString* dataString = [[NSString alloc] initWithData:_connectionData encoding:NSUTF8StringEncoding];
        NSLog(@"%@", dataString);
        
        if (nil != _connectionData)
        {
            json = [NSJSONSerialization JSONObjectWithData:_connectionData options:NSJSONReadingMutableContainers error:&error];
        }
        
        if (error || !json)
        {
            NSLog(@"Could not parse loaded json with error:%@", error);
        }
        
        NSLog(@"%@", json);
        _connectionData = nil;
    }
    
    [pool drain];

    return 0;
}

<?php
// This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
require_once 'HTTP/Request2.php';

$request = new Http_Request2('https://dsapi-stage.directscale.com/v1/customers/upgrade/{customerId}');
$url = $request->getUrl();

$headers = array(
    // Request headers
    'Content-Type' => 'application/json (full)',
    'Ocp-Apim-Subscription-Key' => '{subscription key}',
);

$request->setHeader($headers);

$parameters = array(
    // Request parameters
);

$url->setQueryVariables($parameters);

$request->setMethod(HTTP_Request2::METHOD_PUT);

// Request body
$request->setBody("{body}");

try
{
    $response = $request->send();
    echo $response->getBody();
}
catch (HttpException $ex)
{
    echo $ex;
}

?>

########### Python 2.7 #############
import httplib, urllib, base64

headers = {
    # Request headers
    'Content-Type': 'application/json (full)',
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.urlencode({
})

try:
    conn = httplib.HTTPSConnection('dsapi-stage.directscale.com')
    conn.request("PUT", "/v1/customers/upgrade/{customerId}?%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################

########### Python 3.2 #############
import http.client, urllib.request, urllib.parse, urllib.error, base64

headers = {
    # Request headers
    'Content-Type': 'application/json (full)',
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.parse.urlencode({
})

try:
    conn = http.client.HTTPSConnection('dsapi-stage.directscale.com')
    conn.request("PUT", "/v1/customers/upgrade/{customerId}?%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################

require 'net/http'

uri = URI('https://dsapi-stage.directscale.com/v1/customers/upgrade/{customerId}')

request = Net::HTTP::Put.new(uri.request_uri)
# Request headers
request['Content-Type'] = 'application/json (full)'
# Request headers
request['Ocp-Apim-Subscription-Key'] = '{subscription key}'
# Request body
request.body = "{body}"

response = Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |http|
    http.request(request)
end

puts response.body