PUT https://test-api.finerworks.com/v3/update_user

Update User Profile

Updates various features of a users account which can be useful.

Body

Name	Description	Type	Additional information
account_key	Account unique identifier. This is for the account that will be updated.	text	Required
billing_info	Optional - This is the address you want to keep on file in your billing address. To prevent payment validation issues (i.e. credit card zip code mismatch), this should be the same address as your credit card. If null, no changes or modifcations will occur for the user's billing address.	address	None.
business_info	Optional - This is the address you want to keep on file in your business address. If null, no changes or modifcations will occur for the user's billing address.	address	None.
logo_url	Optional - Location for the api to download and store your business logo which will be printed on packing slips. Only JPG files are allowed. This will be resized and saved as 600x180 pixels. If null and logo_data is not supplied, no changes or modifcations will occur for the user's logo.	text	None.
logo_data	Optional - Alternatively, the byte data for the image can be included in the JSON payload. This should be a JPG image file that has been converted to byte data. The image will be resized and saved as 600x180 pixels. If null no changes or modifcations will occur for the user's logo.	text	None.
portrait_data	Optional - Alternatively, the byte data for the image can be included in the JSON payload. This should be a JPG image file that has been converted to byte data. If null no changes or modifcations will occur for the user's portrait.	text	None.
payment_profile_id	Optional - Represents the user's BrainTree customer id. Required for billing of orders submitted via the api.	text	None.
shipping_preferences	Optional - Users can have a list of up to 3 difference shipping preferences. The first will be given priority. If the first is not available, then the second, will be given priorirty. If the second is not available, then the third option will be used.	array (shipping_preference)	None.
connections	Optional - An array of different connetions to 3rd party platforms.	array (third_party_connections)	None.
personal_details	Update the users social link profile	personal_details	None.

Example JSON Body

application/json, text/json

{
  "account_key": "sample string 1",
  "billing_info": {
    "first_name": "sample string 1",
    "last_name": "sample string 2",
    "company_name": "sample string 3",
    "address_1": "sample string 4",
    "address_2": "sample string 5",
    "address_3": "sample string 6",
    "city": "sample string 7",
    "state_code": "sample string 8",
    "province": "sample string 9",
    "zip_postal_code": "sample string 10",
    "country_code": "sample string 11",
    "phone": "sample string 12",
    "email": "sample string 13",
    "address_order_po": "sample string 14"
  },
  "business_info": {
    "first_name": "sample string 1",
    "last_name": "sample string 2",
    "company_name": "sample string 3",
    "address_1": "sample string 4",
    "address_2": "sample string 5",
    "address_3": "sample string 6",
    "city": "sample string 7",
    "state_code": "sample string 8",
    "province": "sample string 9",
    "zip_postal_code": "sample string 10",
    "country_code": "sample string 11",
    "phone": "sample string 12",
    "email": "sample string 13",
    "address_order_po": "sample string 14"
  },
  "logo_url": "sample string 2",
  "logo_data": "sample string 3",
  "portrait_data": "sample string 4",
  "payment_profile_id": "sample string 5",
  "shipping_preferences": [
    0,
    0
  ],
  "connections": [
    {
      "name": "sample string 1",
      "id": "sample string 2",
      "data": "sample string 3"
    },
    {
      "name": "sample string 1",
      "id": "sample string 2",
      "data": "sample string 3"
    }
  ],
  "personal_details": {
    "account_title": "sample string 1",
    "email_address": "sample string 2",
    "first_name": "sample string 3",
    "last_name": "sample string 4",
    "bio": "sample string 5",
    "paypal_email": "sample string 6",
    "social_links": {
      "sample string 1": "sample string 2",
      "sample string 3": "sample string 4"
    },
    "gallery_theme": "sample string 7"
  }
}

Sample Code Library

curl --location --request PUT 'https://test-api.finerworks.com/v3/update_user' \
--header 'Content-Type: application/json' \
--header 'web_api_key: my-web-api-key-goes-here' \
--header 'app_key: my-app-key-goes-here' \
--data-raw '{
  "account_key": "sample string 1",
  "billing_info": {
    "first_name": "sample string 1",
    "last_name": "sample string 2",
    "company_name": "sample string 3",
    "address_1": "sample string 4",
    "address_2": "sample string 5",
    "address_3": "sample string 6",
    "city": "sample string 7",
    "state_code": "sample string 8",
    "province": "sample string 9",
    "zip_postal_code": "sample string 10",
    "country_code": "sample string 11",
    "phone": "sample string 12",
    "email": "sample string 13",
    "address_order_po": "sample string 14"
  },
  "business_info": {
    "first_name": "sample string 1",
    "last_name": "sample string 2",
    "company_name": "sample string 3",
    "address_1": "sample string 4",
    "address_2": "sample string 5",
    "address_3": "sample string 6",
    "city": "sample string 7",
    "state_code": "sample string 8",
    "province": "sample string 9",
    "zip_postal_code": "sample string 10",
    "country_code": "sample string 11",
    "phone": "sample string 12",
    "email": "sample string 13",
    "address_order_po": "sample string 14"
  },
  "logo_url": "sample string 2",
  "logo_data": "sample string 3",
  "portrait_data": "sample string 4",
  "payment_profile_id": "sample string 5",
  "shipping_preferences": [
    0,
    0
  ],
  "connections": [
    {
      "name": "sample string 1",
      "id": "sample string 2",
      "data": "sample string 3"
    },
    {
      "name": "sample string 1",
      "id": "sample string 2",
      "data": "sample string 3"
    }
  ],
  "personal_details": {
    "account_title": "sample string 1",
    "email_address": "sample string 2",
    "first_name": "sample string 3",
    "last_name": "sample string 4",
    "bio": "sample string 5",
    "paypal_email": "sample string 6",
    "social_links": {
      "sample string 1": "sample string 2",
      "sample string 3": "sample string 4"
    },
    "gallery_theme": "sample string 7"
  }
}'

require_once 'HTTP/Request2.php';
$request = new HTTP_Request2();
$request->setUrl('https://test-api.finerworks.com/v3/update_user');
$request->setMethod(HTTP_Request2::METHOD_PUT);
$request->setConfig(array(
    'follow_redirects' => TRUE
));
$request->setHeader(array(
    'Content-Type' => 'application/json',
    'web_api_key' => 'my-web-api-key-goes-here',
    'app_key' => 'my-app-key-goes-here'
));
$request->setBody('{
  'account_key': 'sample string 1',
  'billing_info': {
    'first_name': 'sample string 1',
    'last_name': 'sample string 2',
    'company_name': 'sample string 3',
    'address_1': 'sample string 4',
    'address_2': 'sample string 5',
    'address_3': 'sample string 6',
    'city': 'sample string 7',
    'state_code': 'sample string 8',
    'province': 'sample string 9',
    'zip_postal_code': 'sample string 10',
    'country_code': 'sample string 11',
    'phone': 'sample string 12',
    'email': 'sample string 13',
    'address_order_po': 'sample string 14'
  },
  'business_info': {
    'first_name': 'sample string 1',
    'last_name': 'sample string 2',
    'company_name': 'sample string 3',
    'address_1': 'sample string 4',
    'address_2': 'sample string 5',
    'address_3': 'sample string 6',
    'city': 'sample string 7',
    'state_code': 'sample string 8',
    'province': 'sample string 9',
    'zip_postal_code': 'sample string 10',
    'country_code': 'sample string 11',
    'phone': 'sample string 12',
    'email': 'sample string 13',
    'address_order_po': 'sample string 14'
  },
  'logo_url': 'sample string 2',
  'logo_data': 'sample string 3',
  'portrait_data': 'sample string 4',
  'payment_profile_id': 'sample string 5',
  'shipping_preferences': [
    0,
    0
  ],
  'connections': [
    {
      'name': 'sample string 1',
      'id': 'sample string 2',
      'data': 'sample string 3'
    },
    {
      'name': 'sample string 1',
      'id': 'sample string 2',
      'data': 'sample string 3'
    }
  ],
  'personal_details': {
    'account_title': 'sample string 1',
    'email_address': 'sample string 2',
    'first_name': 'sample string 3',
    'last_name': 'sample string 4',
    'bio': 'sample string 5',
    'paypal_email': 'sample string 6',
    'social_links': {
      'sample string 1': 'sample string 2',
      'sample string 3': 'sample string 4'
    },
    'gallery_theme': 'sample string 7'
  }
}');
try {
    $response = $request->send();
    if ($response->getStatus() == 200) {
        echo $response->getBody();
    }
    else {
        echo 'Unexpected HTTP status: ' . $response->getStatus() . ' ' .
            $response->getReasonPhrase();
    }
}
catch(HTTP_Request2_Exception $e) {
    echo 'Error: ' . $e->getMessage();
}

var client = new RestClient("https://test-api.finerworks.com/v3/update_user");
client.Timeout = -1;
var request = new RestRequest(Method.PUT);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("web_api_key", "my-web-api-key-goes-here");
request.AddHeader("app_key", "my-app-key-goes-here");
request.AddParameter("application/json", "{
  'account_key': 'sample string 1',
  'billing_info': {
    'first_name': 'sample string 1',
    'last_name': 'sample string 2',
    'company_name': 'sample string 3',
    'address_1': 'sample string 4',
    'address_2': 'sample string 5',
    'address_3': 'sample string 6',
    'city': 'sample string 7',
    'state_code': 'sample string 8',
    'province': 'sample string 9',
    'zip_postal_code': 'sample string 10',
    'country_code': 'sample string 11',
    'phone': 'sample string 12',
    'email': 'sample string 13',
    'address_order_po': 'sample string 14'
  },
  'business_info': {
    'first_name': 'sample string 1',
    'last_name': 'sample string 2',
    'company_name': 'sample string 3',
    'address_1': 'sample string 4',
    'address_2': 'sample string 5',
    'address_3': 'sample string 6',
    'city': 'sample string 7',
    'state_code': 'sample string 8',
    'province': 'sample string 9',
    'zip_postal_code': 'sample string 10',
    'country_code': 'sample string 11',
    'phone': 'sample string 12',
    'email': 'sample string 13',
    'address_order_po': 'sample string 14'
  },
  'logo_url': 'sample string 2',
  'logo_data': 'sample string 3',
  'portrait_data': 'sample string 4',
  'payment_profile_id': 'sample string 5',
  'shipping_preferences': [
    0,
    0
  ],
  'connections': [
    {
      'name': 'sample string 1',
      'id': 'sample string 2',
      'data': 'sample string 3'
    },
    {
      'name': 'sample string 1',
      'id': 'sample string 2',
      'data': 'sample string 3'
    }
  ],
  'personal_details': {
    'account_title': 'sample string 1',
    'email_address': 'sample string 2',
    'first_name': 'sample string 3',
    'last_name': 'sample string 4',
    'bio': 'sample string 5',
    'paypal_email': 'sample string 6',
    'social_links': {
      'sample string 1': 'sample string 2',
      'sample string 3': 'sample string 4'
    },
    'gallery_theme': 'sample string 7'
  }
}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

var settings = {
    "url": "https://test-api.finerworks.com/v3/update_user",
    "method": "PUT",
    "timeout": 0,
    "headers": {
        "Content-Type": "application/json",
        "web_api_key": "my-web-api-key-goes-here",
        "app_key": "my-app-key-goes-here"
    },
    "data": JSON.stringify({
  'account_key': 'sample string 1',
  'billing_info': {
    'first_name': 'sample string 1',
    'last_name': 'sample string 2',
    'company_name': 'sample string 3',
    'address_1': 'sample string 4',
    'address_2': 'sample string 5',
    'address_3': 'sample string 6',
    'city': 'sample string 7',
    'state_code': 'sample string 8',
    'province': 'sample string 9',
    'zip_postal_code': 'sample string 10',
    'country_code': 'sample string 11',
    'phone': 'sample string 12',
    'email': 'sample string 13',
    'address_order_po': 'sample string 14'
  },
  'business_info': {
    'first_name': 'sample string 1',
    'last_name': 'sample string 2',
    'company_name': 'sample string 3',
    'address_1': 'sample string 4',
    'address_2': 'sample string 5',
    'address_3': 'sample string 6',
    'city': 'sample string 7',
    'state_code': 'sample string 8',
    'province': 'sample string 9',
    'zip_postal_code': 'sample string 10',
    'country_code': 'sample string 11',
    'phone': 'sample string 12',
    'email': 'sample string 13',
    'address_order_po': 'sample string 14'
  },
  'logo_url': 'sample string 2',
  'logo_data': 'sample string 3',
  'portrait_data': 'sample string 4',
  'payment_profile_id': 'sample string 5',
  'shipping_preferences': [
    0,
    0
  ],
  'connections': [
    {
      'name': 'sample string 1',
      'id': 'sample string 2',
      'data': 'sample string 3'
    },
    {
      'name': 'sample string 1',
      'id': 'sample string 2',
      'data': 'sample string 3'
    }
  ],
  'personal_details': {
    'account_title': 'sample string 1',
    'email_address': 'sample string 2',
    'first_name': 'sample string 3',
    'last_name': 'sample string 4',
    'bio': 'sample string 5',
    'paypal_email': 'sample string 6',
    'social_links': {
      'sample string 1': 'sample string 2',
      'sample string 3': 'sample string 4'
    },
    'gallery_theme': 'sample string 7'
  }
}),
};

$.ajax(settings).done(function (response) {
    console.log(response);
});

var https = require('follow-redirects').https;

var options = {
    'method': 'PUT',
    'hostname': 'test-api.finerworks.com',
    'path': '/v3/update_user',
    'headers': {
        'Content-Type': 'application/json',
        'web_api_key': 'my-web-api-key-goes-here',
        'app_key': 'my-app-key-goes-here'
    },
    'maxRedirects': 20
};

var req = https.request(options, function (res) {
    var chunks = [];
    res.on("data", function (chunk) { chunks.push(chunk); });
    res.on("end", function () {
        var body = Buffer.concat(chunks);
        console.log(body.toString());
    });
    res.on("error", function (error) { console.error(error); });
});

var postData = JSON.stringify({
  'account_key': 'sample string 1',
  'billing_info': {
    'first_name': 'sample string 1',
    'last_name': 'sample string 2',
    'company_name': 'sample string 3',
    'address_1': 'sample string 4',
    'address_2': 'sample string 5',
    'address_3': 'sample string 6',
    'city': 'sample string 7',
    'state_code': 'sample string 8',
    'province': 'sample string 9',
    'zip_postal_code': 'sample string 10',
    'country_code': 'sample string 11',
    'phone': 'sample string 12',
    'email': 'sample string 13',
    'address_order_po': 'sample string 14'
  },
  'business_info': {
    'first_name': 'sample string 1',
    'last_name': 'sample string 2',
    'company_name': 'sample string 3',
    'address_1': 'sample string 4',
    'address_2': 'sample string 5',
    'address_3': 'sample string 6',
    'city': 'sample string 7',
    'state_code': 'sample string 8',
    'province': 'sample string 9',
    'zip_postal_code': 'sample string 10',
    'country_code': 'sample string 11',
    'phone': 'sample string 12',
    'email': 'sample string 13',
    'address_order_po': 'sample string 14'
  },
  'logo_url': 'sample string 2',
  'logo_data': 'sample string 3',
  'portrait_data': 'sample string 4',
  'payment_profile_id': 'sample string 5',
  'shipping_preferences': [
    0,
    0
  ],
  'connections': [
    {
      'name': 'sample string 1',
      'id': 'sample string 2',
      'data': 'sample string 3'
    },
    {
      'name': 'sample string 1',
      'id': 'sample string 2',
      'data': 'sample string 3'
    }
  ],
  'personal_details': {
    'account_title': 'sample string 1',
    'email_address': 'sample string 2',
    'first_name': 'sample string 3',
    'last_name': 'sample string 4',
    'bio': 'sample string 5',
    'paypal_email': 'sample string 6',
    'social_links': {
      'sample string 1': 'sample string 2',
      'sample string 3': 'sample string 4'
    },
    'gallery_theme': 'sample string 7'
  }
});

req.write(postData);
req.end();

require "uri"
require "net/http"

url = URI("https://test-api.finerworks.com/v3/update_user")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Content-Type"] = "application/json"
request["web_api_key"] = "my-web-api-key-goes-here"
request["app_key"] = "my-app-key-goes-here"
request.body = "{
  'account_key': 'sample string 1',
  'billing_info': {
    'first_name': 'sample string 1',
    'last_name': 'sample string 2',
    'company_name': 'sample string 3',
    'address_1': 'sample string 4',
    'address_2': 'sample string 5',
    'address_3': 'sample string 6',
    'city': 'sample string 7',
    'state_code': 'sample string 8',
    'province': 'sample string 9',
    'zip_postal_code': 'sample string 10',
    'country_code': 'sample string 11',
    'phone': 'sample string 12',
    'email': 'sample string 13',
    'address_order_po': 'sample string 14'
  },
  'business_info': {
    'first_name': 'sample string 1',
    'last_name': 'sample string 2',
    'company_name': 'sample string 3',
    'address_1': 'sample string 4',
    'address_2': 'sample string 5',
    'address_3': 'sample string 6',
    'city': 'sample string 7',
    'state_code': 'sample string 8',
    'province': 'sample string 9',
    'zip_postal_code': 'sample string 10',
    'country_code': 'sample string 11',
    'phone': 'sample string 12',
    'email': 'sample string 13',
    'address_order_po': 'sample string 14'
  },
  'logo_url': 'sample string 2',
  'logo_data': 'sample string 3',
  'portrait_data': 'sample string 4',
  'payment_profile_id': 'sample string 5',
  'shipping_preferences': [
    0,
    0
  ],
  'connections': [
    {
      'name': 'sample string 1',
      'id': 'sample string 2',
      'data': 'sample string 3'
    },
    {
      'name': 'sample string 1',
      'id': 'sample string 2',
      'data': 'sample string 3'
    }
  ],
  'personal_details': {
    'account_title': 'sample string 1',
    'email_address': 'sample string 2',
    'first_name': 'sample string 3',
    'last_name': 'sample string 4',
    'bio': 'sample string 5',
    'paypal_email': 'sample string 6',
    'social_links': {
      'sample string 1': 'sample string 2',
      'sample string 3': 'sample string 4'
    },
    'gallery_theme': 'sample string 7'
  }
}"

response = https.request(request)
puts response.read_body

Name	Description	Type	Additional information
status		response_status	None.
user_account		user_account	None.

Example JSON Response

application/json, text/json

{
  "status": {
    "success": true,
    "status_code": 200,
    "message": "",
    "debug": null,
    "reference_id": "f4d0b336fe4443f3a75ec54a62a3f3d3",
    "domain": null
  },
  "user_account": {
    "web_api_key": "ef92bcd8-d1a3-49f5-a783-17bff2b205e7",
    "account_id": 1,
    "account_username": "bob_ross",
    "account_email": "bobbyross12@gmail.com",
    "account_title": null,
    "account_firstname": null,
    "account_lastname": null,
    "billing_info": {
      "first_name": "Bob",
      "last_name": "Ross",
      "company_name": "Happy Little Trees, Inc",
      "address_1": "742 Evergreen Terrace",
      "address_2": null,
      "address_3": null,
      "city": "Mountain Scene",
      "state_code": "AK",
      "province": null,
      "zip_postal_code": "88888",
      "country_code": "us",
      "phone": "555-555-5555",
      "email": null,
      "address_order_po": "12345"
    },
    "business_info": {
      "first_name": "Bob",
      "last_name": "Ross",
      "company_name": "Happy Little Trees, Inc",
      "address_1": "742 Evergreen Terrace",
      "address_2": null,
      "address_3": null,
      "city": "Mountain Scene",
      "state_code": "AK",
      "province": null,
      "zip_postal_code": "88888",
      "country_code": "us",
      "phone": "555-555-5555",
      "email": null,
      "address_order_po": "12345"
    },
    "logo_url": null,
    "profile_img_url": null,
    "payment_profile_id": null,
    "user_account_credits": 0.0,
    "enable_invoice_payment": false,
    "account_key": null,
    "shipping_preferences": [
      0,
      2,
      1
    ],
    "connections": null,
    "user_profile_complete": false,
    "order_fulfillment_checklist": null,
    "app_details": null,
    "personal_galleries": null,
    "bio": null,
    "gallery_theme": null,
    "social_links": null,
    "account_paypal": null,
    "geogalleries_license": false
  }
}