Set Customer Details

PATCH /customer/set_customer_details

Description	URL	Response Format	Request Method	Authentication
Set the customer details for an Trackfinity customer record	https://domain/api/customer/set_customer_details	JSON	PATCH	HTTP headers

Parameters

Paremeters must be sent with the request body. The examples below show the parameters sent as x-www-form-urlencoded

If you want to remove a field you can pass in the string REMOVE and the field will be removed. All additional parameters have this option other then 'password'. At least one optional parameter must be passed in.

You need to pass either customer_id or subscription_id for customer lookup otherwise the call will fail.

Name	Description	Type	Required
customer_id	pass in the customer_id of the customer to modify	string	no
subscription_id	pass in the subscription of the customer to modify	string	no
firstname	pass in the first name of the customer	string	no
lastname	pass in the last name of the customer	string	no
email	pass in the email address of the customer	string	no
username	pass in the new username of the customer	string	no
password	pass in the new password of the customer	string	no
address1	pass in the address of the customer	string	no
address2	pass in address of the customer	string	no
city	pass in the city of the customer	string	no
state	pass in the state of the customer	string	no
country	pass in the country of the customer	string	no
zip	pass in the zip of the customer	string	no
custom1	pass in the custom1 field of the customer	string	no
custom2	pass in the custom1 field of the customer	string	no
custom3	pass in the custom1 field of the customer	string	no
custom4	pass in the custom1 field of the customer	string	no
custom5	pass in the custom1 field of the customer	string	no

Example Request

PATCH

https://domain/api/customer/set_customer_details

Response:

true

Example Code

php

<?php
$curl = curl_init();

$data = array(
    'customer_id' => 191,
    'firstname' => 'Test',
    'zip' => '66666',
    'email' => 'test@testmail.com',
    'country' => 'US',
);

$url = 'http://domain/api/customer/set_customer_details';

$headers = array(
    'api-key: 44b5498dbcb481a0d00b404c0169af62',
    'api-username: tf_admin'
);
curl_setopt($curl, CURLOPT_CUSTOMREQUEST, "PATCH");
curl_setopt($curl, CURLOPT_HTTPHEADER, $headers);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curl, CURLOPT_POSTFIELDS, http_build_query($data));
curl_setopt($curl, CURLOPT_URL, $url);

$resp = curl_exec($curl);
//dumps an associative array representation of the json
var_dump(json_decode($resp, true));
// Close request to clear up some resources
curl_close($curl);
?>

Python

This example requires pip and the request library which can be installed via pip by: 'pip install requests'.

import requests
import json

url = 'http://domain/api/customer/set_customer_details'

payload = {
    'customer_id': 191,
    'firstname': 'Test',
    'zip': '66666',
    'email': 'test@testmail.com',
    'country': 'US'
}


headers = {
        'api-key': '44b5498dbcb481a0d00b404c0169af62',
        'api-username': 'tf_admin'
        }

res = requests.patch(url, data=payload, headers=headers)
print res.json()

node.js

This example requires npm and the request module which can be installed via npm by: 'npm install request'.

var request = require('request');

data = {
    'customer_id': 191,
    'firstname': 'Test',
    'zip': '66666',
    'email': 'test@testmail.com',
    'country': 'US'
}

var options = {
    url: 'http://domain/api/customer/set_customer_details',
    method: 'PATCH',
    form: data,
    json: true,
    headers: {
        'api-key': '44b5498dbcb481a0d00b404c0169af62',
        'api-username': 'tf_admin'
    }
};

function callback(error, response, body) {
    if (!error && response.statusCode == 200) {
        console.log(body);
    }
    else{
        console.log(body);
    }
}
request(options, callback);

Curl curl -X PATCH 'http://domain/api/customer/set_customer_details' -H "api-key: 44b5498dbcb481a0d00b404c0169af62" -H "api-username: tf_admin" -H "Content-Type: application/x-www-form-urlencoded" -d 'customer_id=191&firstname=Test&zip=66666&email=test@testmail.com&country=US'