Back to Collection Items
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
Dim http As New Chilkat.Http
Dim success As Boolean
// 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"
// }
// }
Dim json As New Chilkat.JsonObject
success = json.UpdateString("client.fname","Nicolas")
// Adds the "Authorization: Bearer <access_token>" header.
http.AuthToken = "<access_token>"
http.SetRequestHeader "Content-Type","application/json"
Dim sbRequestBody As New Chilkat.StringBuilder
success = json.EmitSb(sbRequestBody)
Dim resp As Chilkat.HttpResponse
resp = http.PTextSb("PUT","https://api.freshbooks.com/accounting/account/{{accountId}}/users/clients/{{customerId}}",sbRequestBody,"utf-8","application/json",False,False)
If (http.LastMethodSuccess = False) Then
System.DebugLog(http.LastErrorText)
Return
End If
Dim sbResponseBody As New Chilkat.StringBuilder
success = resp.GetBodySb(sbResponseBody)
Dim jResp As New Chilkat.JsonObject
success = jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = False
System.DebugLog("Response Body:")
System.DebugLog(jResp.Emit())
Dim respStatusCode As Int32
respStatusCode = resp.StatusCode
System.DebugLog("Response Status Code = " + Str(respStatusCode))
If (respStatusCode >= 400) Then
System.DebugLog("Response Header:")
System.DebugLog(resp.Header)
System.DebugLog("Failed.")
Return
End If
// 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
Dim Accounting_systemid As String
Accounting_systemid = jResp.StringOf("response.result.client.accounting_systemid")
Dim Allow_late_fees As Boolean
Allow_late_fees = jResp.BoolOf("response.result.client.allow_late_fees")
Dim Allow_late_notifications As Boolean
Allow_late_notifications = jResp.BoolOf("response.result.client.allow_late_notifications")
Dim Bus_phone As String
Bus_phone = jResp.StringOf("response.result.client.bus_phone")
Dim Company_industry As String
Company_industry = jResp.StringOf("response.result.client.company_industry")
Dim Company_size As String
Company_size = jResp.StringOf("response.result.client.company_size")
Dim Currency_code As String
Currency_code = jResp.StringOf("response.result.client.currency_code")
Dim Direct_link_token As String
Direct_link_token = jResp.StringOf("response.result.client.direct_link_token")
Dim v_Email As String
v_Email = jResp.StringOf("response.result.client.email")
Dim Fax As String
Fax = jResp.StringOf("response.result.client.fax")
Dim Fname As String
Fname = jResp.StringOf("response.result.client.fname")
Dim Has_retainer As String
Has_retainer = jResp.StringOf("response.result.client.has_retainer")
Dim Home_phone As String
Home_phone = jResp.StringOf("response.result.client.home_phone")
Dim Id As Int32
Id = jResp.IntOf("response.result.client.id")
Dim Language As String
Language = jResp.StringOf("response.result.client.language")
Dim Last_activity As String
Last_activity = jResp.StringOf("response.result.client.last_activity")
Dim Last_login As String
Last_login = jResp.StringOf("response.result.client.last_login")
Dim Level As Int32
Level = jResp.IntOf("response.result.client.level")
Dim Lname As String
Lname = jResp.StringOf("response.result.client.lname")
Dim Mob_phone As String
Mob_phone = jResp.StringOf("response.result.client.mob_phone")
Dim Note As String
Note = jResp.StringOf("response.result.client.note")
Dim Notified As Boolean
Notified = jResp.BoolOf("response.result.client.notified")
Dim Num_logins As Int32
Num_logins = jResp.IntOf("response.result.client.num_logins")
Dim Organization As String
Organization = jResp.StringOf("response.result.client.organization")
Dim P_city As String
P_city = jResp.StringOf("response.result.client.p_city")
Dim P_code As String
P_code = jResp.StringOf("response.result.client.p_code")
Dim P_country As String
P_country = jResp.StringOf("response.result.client.p_country")
Dim P_province As String
P_province = jResp.StringOf("response.result.client.p_province")
Dim P_street As String
P_street = jResp.StringOf("response.result.client.p_street")
Dim P_street2 As String
P_street2 = jResp.StringOf("response.result.client.p_street2")
Dim Pref_email As Boolean
Pref_email = jResp.BoolOf("response.result.client.pref_email")
Dim Pref_gmail As Boolean
Pref_gmail = jResp.BoolOf("response.result.client.pref_gmail")
Dim Retainer_id As String
Retainer_id = jResp.StringOf("response.result.client.retainer_id")
Dim Role As String
Role = jResp.StringOf("response.result.client.role")
Dim S_city As String
S_city = jResp.StringOf("response.result.client.s_city")
Dim S_code As String
S_code = jResp.StringOf("response.result.client.s_code")
Dim S_country As String
S_country = jResp.StringOf("response.result.client.s_country")
Dim S_province As String
S_province = jResp.StringOf("response.result.client.s_province")
Dim S_street As String
S_street = jResp.StringOf("response.result.client.s_street")
Dim S_street2 As String
S_street2 = jResp.StringOf("response.result.client.s_street2")
Dim Signup_date As String
Signup_date = jResp.StringOf("response.result.client.signup_date")
Dim Statement_token As String
Statement_token = jResp.StringOf("response.result.client.statement_token")
Dim Subdomain As String
Subdomain = jResp.StringOf("response.result.client.subdomain")
Dim Updated As String
Updated = jResp.StringOf("response.result.client.updated")
Dim Userid As Int32
Userid = jResp.IntOf("response.result.client.userid")
Dim Username As String
Username = jResp.StringOf("response.result.client.username")
Dim Vat_name As String
Vat_name = jResp.StringOf("response.result.client.vat_name")
Dim Vat_number As String
Vat_number = jResp.StringOf("response.result.client.vat_number")
Dim Vis_state As Int32
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}"
}
]
}
