Back to Collection Items
<?php
include("chilkat_9_5_0.php");
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
$http = new CkHttp();
// Use this online tool to generate code from sample JSON: Generate Code to Create JSON
// The following JSON is sent in the request body.
// {
// "client": {
// "fname": "Nicolas"
// }
// }
$json = new CkJsonObject();
$json->UpdateString('client.fname','Nicolas');
// Adds the "Authorization: Bearer <access_token>" header.
$http->put_AuthToken('<access_token>');
$http->SetRequestHeader('Content-Type','application/json');
$sbRequestBody = new CkStringBuilder();
$json->EmitSb($sbRequestBody);
// resp is a CkHttpResponse
$resp = $http->PTextSb('PUT','https://api.freshbooks.com/accounting/account/{{accountId}}/users/clients/{{customerId}}',$sbRequestBody,'utf-8','application/json',false,false);
if ($http->get_LastMethodSuccess() == false) {
print $http->lastErrorText() . "\n";
exit;
}
$sbResponseBody = new CkStringBuilder();
$resp->GetBodySb($sbResponseBody);
$jResp = new CkJsonObject();
$jResp->LoadSb($sbResponseBody);
$jResp->put_EmitCompact(false);
print 'Response Body:' . "\n";
print $jResp->emit() . "\n";
$respStatusCode = $resp->get_StatusCode();
print 'Response Status Code = ' . $respStatusCode . "\n";
if ($respStatusCode >= 400) {
print 'Response Header:' . "\n";
print $resp->header() . "\n";
print 'Failed.' . "\n";
exit;
}
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "response": {
// "result": {
// "client": {
// "accounting_systemid": "wkMd2g",
// "allow_late_fees": true,
// "allow_late_notifications": true,
// "bus_phone": "",
// "company_industry": null,
// "company_size": null,
// "currency_code": "USD",
// "direct_link_token": null,
// "email": "first@company.com",
// "fax": "",
// "fname": "Nicolas",
// "has_retainer": null,
// "home_phone": "555-555-1234",
// "id": 31006,
// "language": "en",
// "last_activity": null,
// "last_login": null,
// "level": 0,
// "lname": "one",
// "mob_phone": "",
// "note": null,
// "notified": false,
// "num_logins": 0,
// "organization": "first company",
// "p_city": "",
// "p_code": "",
// "p_country": "Canada",
// "p_province": "",
// "p_street": "",
// "p_street2": "",
// "pref_email": true,
// "pref_gmail": false,
// "retainer_id": null,
// "role": "client",
// "s_city": "",
// "s_code": "",
// "s_country": "",
// "s_province": "",
// "s_street": "",
// "s_street2": "",
// "signup_date": "2019-04-18 13:38:23",
// "statement_token": null,
// "subdomain": null,
// "updated": "2019-04-24 13:47:39",
// "userid": 31006,
// "username": "clientone",
// "vat_name": null,
// "vat_number": "",
// "vis_state": 0
// }
// }
// }
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
$Accounting_systemid = $jResp->stringOf('response.result.client.accounting_systemid');
$Allow_late_fees = $jResp->BoolOf('response.result.client.allow_late_fees');
$Allow_late_notifications = $jResp->BoolOf('response.result.client.allow_late_notifications');
$Bus_phone = $jResp->stringOf('response.result.client.bus_phone');
$Company_industry = $jResp->stringOf('response.result.client.company_industry');
$Company_size = $jResp->stringOf('response.result.client.company_size');
$Currency_code = $jResp->stringOf('response.result.client.currency_code');
$Direct_link_token = $jResp->stringOf('response.result.client.direct_link_token');
$v_Email = $jResp->stringOf('response.result.client.email');
$Fax = $jResp->stringOf('response.result.client.fax');
$Fname = $jResp->stringOf('response.result.client.fname');
$Has_retainer = $jResp->stringOf('response.result.client.has_retainer');
$Home_phone = $jResp->stringOf('response.result.client.home_phone');
$Id = $jResp->IntOf('response.result.client.id');
$Language = $jResp->stringOf('response.result.client.language');
$Last_activity = $jResp->stringOf('response.result.client.last_activity');
$Last_login = $jResp->stringOf('response.result.client.last_login');
$Level = $jResp->IntOf('response.result.client.level');
$Lname = $jResp->stringOf('response.result.client.lname');
$Mob_phone = $jResp->stringOf('response.result.client.mob_phone');
$Note = $jResp->stringOf('response.result.client.note');
$Notified = $jResp->BoolOf('response.result.client.notified');
$Num_logins = $jResp->IntOf('response.result.client.num_logins');
$Organization = $jResp->stringOf('response.result.client.organization');
$P_city = $jResp->stringOf('response.result.client.p_city');
$P_code = $jResp->stringOf('response.result.client.p_code');
$P_country = $jResp->stringOf('response.result.client.p_country');
$P_province = $jResp->stringOf('response.result.client.p_province');
$P_street = $jResp->stringOf('response.result.client.p_street');
$P_street2 = $jResp->stringOf('response.result.client.p_street2');
$Pref_email = $jResp->BoolOf('response.result.client.pref_email');
$Pref_gmail = $jResp->BoolOf('response.result.client.pref_gmail');
$Retainer_id = $jResp->stringOf('response.result.client.retainer_id');
$Role = $jResp->stringOf('response.result.client.role');
$S_city = $jResp->stringOf('response.result.client.s_city');
$S_code = $jResp->stringOf('response.result.client.s_code');
$S_country = $jResp->stringOf('response.result.client.s_country');
$S_province = $jResp->stringOf('response.result.client.s_province');
$S_street = $jResp->stringOf('response.result.client.s_street');
$S_street2 = $jResp->stringOf('response.result.client.s_street2');
$Signup_date = $jResp->stringOf('response.result.client.signup_date');
$Statement_token = $jResp->stringOf('response.result.client.statement_token');
$Subdomain = $jResp->stringOf('response.result.client.subdomain');
$Updated = $jResp->stringOf('response.result.client.updated');
$Userid = $jResp->IntOf('response.result.client.userid');
$Username = $jResp->stringOf('response.result.client.username');
$Vat_name = $jResp->stringOf('response.result.client.vat_name');
$Vat_number = $jResp->stringOf('response.result.client.vat_number');
$Vis_state = $jResp->IntOf('response.result.client.vis_state');
?>
Curl Command
curl -X PUT
-H "Authorization: Bearer <access_token>"
-H "Content-Type: application/json"
-d '{
"client": {
"fname": "Nicolas"
}
}'
https://api.freshbooks.com/accounting/account/{{accountId}}/users/clients/{{customerId}}
Postman Collection Item JSON
{
"name": "Update Client",
"request": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"name": "Content-Type",
"value": "application/json",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"client\": {\n \"fname\": \"Nicolas\"\n }\n}"
},
"url": {
"raw": "https://api.freshbooks.com/accounting/account/{{accountId}}/users/clients/{{customerId}}",
"protocol": "https",
"host": [
"api",
"freshbooks",
"com"
],
"path": [
"accounting",
"account",
"{{accountId}}",
"users",
"clients",
"{{customerId}}"
],
"query": [
{
"key": "",
"value": "",
"disabled": true
}
]
}
},
"response": [
{
"name": "Update Client",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"name": "Content-Type",
"value": "application/json",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"client\": {\n \"fname\": \"Nicolas\"\n }\n}"
},
"url": {
"raw": "https://api.freshbooks.com/accounting/account/{{accountId}}/users/clients/{{customerId}}",
"protocol": "https",
"host": [
"api",
"freshbooks",
"com"
],
"path": [
"accounting",
"account",
"{{accountId}}",
"users",
"clients",
"{{customerId}}"
],
"query": [
{
"key": "",
"value": "",
"disabled": true
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "nginx"
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "X-NewRelic-App-Data",
"value": "PxQBWV5TCBABVlVSAwEOVlcTGhE1AwE2QgNWEVlbQFtcCxYnRA9QFg1ZWU4DFVdfRgFPCkNFR0gRQlNBEVwADlkHVhYaFAQeA0sLUAdSBVNRBAVXUVcNBQBRVE4CAxtEBQUGBVBTUQNVVA9bCg4AVBFJXwBdElY/"
},
{
"key": "Access-Control-Allow-Origin",
"value": "*"
},
{
"key": "Expires",
"value": "Tue, 24 Apr 2018 17:47:39 GMT"
},
{
"key": "Cache-Control",
"value": "no-cache"
},
{
"key": "Content-Encoding",
"value": "gzip"
},
{
"key": "Via",
"value": "1.1 google"
},
{
"key": "Via",
"value": "1.1 varnish"
},
{
"key": "Transfer-Encoding",
"value": "chunked"
},
{
"key": "Accept-Ranges",
"value": "bytes"
},
{
"key": "Date",
"value": "Wed, 24 Apr 2019 17:47:39 GMT"
},
{
"key": "Connection",
"value": "keep-alive"
},
{
"key": "X-Served-By",
"value": "cache-mdw17369-MDW"
},
{
"key": "X-Cache",
"value": "MISS"
},
{
"key": "X-Cache-Hits",
"value": "0"
},
{
"key": "Vary",
"value": "Accept-Encoding"
},
{
"key": "Country",
"value": "CA"
},
{
"key": "Strict-Transport-Security",
"value": "max-age=31536000; includeSubDomains; preload"
}
],
"cookie": [
],
"body": "{\n \"response\": {\n \"result\": {\n \"client\": {\n \"accounting_systemid\": \"wkMd2g\",\n \"allow_late_fees\": true,\n \"allow_late_notifications\": true,\n \"bus_phone\": \"\",\n \"company_industry\": null,\n \"company_size\": null,\n \"currency_code\": \"USD\",\n \"direct_link_token\": null,\n \"email\": \"first@company.com\",\n \"fax\": \"\",\n \"fname\": \"Nicolas\",\n \"has_retainer\": null,\n \"home_phone\": \"555-555-1234\",\n \"id\": 31006,\n \"language\": \"en\",\n \"last_activity\": null,\n \"last_login\": null,\n \"level\": 0,\n \"lname\": \"one\",\n \"mob_phone\": \"\",\n \"note\": null,\n \"notified\": false,\n \"num_logins\": 0,\n \"organization\": \"first company\",\n \"p_city\": \"\",\n \"p_code\": \"\",\n \"p_country\": \"Canada\",\n \"p_province\": \"\",\n \"p_street\": \"\",\n \"p_street2\": \"\",\n \"pref_email\": true,\n \"pref_gmail\": false,\n \"retainer_id\": null,\n \"role\": \"client\",\n \"s_city\": \"\",\n \"s_code\": \"\",\n \"s_country\": \"\",\n \"s_province\": \"\",\n \"s_street\": \"\",\n \"s_street2\": \"\",\n \"signup_date\": \"2019-04-18 13:38:23\",\n \"statement_token\": null,\n \"subdomain\": null,\n \"updated\": \"2019-04-24 13:47:39\",\n \"userid\": 31006,\n \"username\": \"clientone\",\n \"vat_name\": null,\n \"vat_number\": \"\",\n \"vis_state\": 0\n }\n }\n }\n}"
}
]
}
