Back to Collection Items
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
$oHttp = ObjCreate("Chilkat.Http")
Local $bSuccess
; Use this online tool to generate code from sample JSON: Generate Code to Create JSON
; The following JSON is sent in the request body.
; {
; "staff": {
; "fname": "Ryen"
; }
; }
$oJson = ObjCreate("Chilkat.JsonObject")
$oJson.UpdateString("staff.fname","Ryen")
; Adds the "Authorization: Bearer <access_token>" header.
$oHttp.AuthToken = "<access_token>"
$oHttp.SetRequestHeader "Content-Type","application/json"
$oSbRequestBody = ObjCreate("Chilkat.StringBuilder")
$oJson.EmitSb($oSbRequestBody)
Local $oResp = $oHttp.PTextSb("PUT","https://api.freshbooks.com/accounting/account/{{accountId}}/users/staffs/{{staffId}}",$oSbRequestBody,"utf-8","application/json",False,False)
If ($oHttp.LastMethodSuccess = False) Then
ConsoleWrite($oHttp.LastErrorText & @CRLF)
Exit
EndIf
$oSbResponseBody = ObjCreate("Chilkat.StringBuilder")
$oResp.GetBodySb($oSbResponseBody)
$oJResp = ObjCreate("Chilkat.JsonObject")
$oJResp.LoadSb($oSbResponseBody)
$oJResp.EmitCompact = False
ConsoleWrite("Response Body:" & @CRLF)
ConsoleWrite($oJResp.Emit() & @CRLF)
Local $iRespStatusCode = $oResp.StatusCode
ConsoleWrite("Response Status Code = " & $iRespStatusCode & @CRLF)
If ($iRespStatusCode >= 400) Then
ConsoleWrite("Response Header:" & @CRLF)
ConsoleWrite($oResp.Header & @CRLF)
ConsoleWrite("Failed." & @CRLF)
Exit
EndIf
; Sample JSON response:
; (Sample code for parsing the JSON response is shown below)
; {
; "response": {
; "result": {
; "staff": {
; "accounting_systemid": "wkMd2g",
; "api_token": "9249ac8633763523fe614cdeb28787b9",
; "bus_phone": "",
; "currency_code": null,
; "display_name": "RyenMarr",
; "email": "api.freshbooks@gmail.com",
; "fax": "",
; "fname": "Ryen",
; "home_phone": null,
; "id": 1,
; "language": "en",
; "last_login": null,
; "level": 3,
; "lname": "Marr",
; "mob_phone": "",
; "note": null,
; "num_logins": 0,
; "organization": "Postman Sandbox",
; "p_city": "",
; "p_code": "",
; "p_country": "",
; "p_province": "",
; "p_street": "",
; "p_street2": "",
; "rate": null,
; "role": "admin",
; "signup_date": "2019-04-18 09:14:53",
; "updated": "2019-04-24 14:37:58",
; "userid": 1,
; "username": "rmarr@freshbooks.com",
; "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
Local $sAccounting_systemid = $oJResp.StringOf("response.result.staff.accounting_systemid")
Local $sApi_token = $oJResp.StringOf("response.result.staff.api_token")
Local $sBus_phone = $oJResp.StringOf("response.result.staff.bus_phone")
Local $sCurrency_code = $oJResp.StringOf("response.result.staff.currency_code")
Local $sDisplay_name = $oJResp.StringOf("response.result.staff.display_name")
Local $sV_Email = $oJResp.StringOf("response.result.staff.email")
Local $sFax = $oJResp.StringOf("response.result.staff.fax")
Local $sFname = $oJResp.StringOf("response.result.staff.fname")
Local $sHome_phone = $oJResp.StringOf("response.result.staff.home_phone")
Local $iId = $oJResp.IntOf("response.result.staff.id")
Local $sLanguage = $oJResp.StringOf("response.result.staff.language")
Local $sLast_login = $oJResp.StringOf("response.result.staff.last_login")
Local $iLevel = $oJResp.IntOf("response.result.staff.level")
Local $sLname = $oJResp.StringOf("response.result.staff.lname")
Local $sMob_phone = $oJResp.StringOf("response.result.staff.mob_phone")
Local $sNote = $oJResp.StringOf("response.result.staff.note")
Local $iNum_logins = $oJResp.IntOf("response.result.staff.num_logins")
Local $sOrganization = $oJResp.StringOf("response.result.staff.organization")
Local $sP_city = $oJResp.StringOf("response.result.staff.p_city")
Local $sP_code = $oJResp.StringOf("response.result.staff.p_code")
Local $sP_country = $oJResp.StringOf("response.result.staff.p_country")
Local $sP_province = $oJResp.StringOf("response.result.staff.p_province")
Local $sP_street = $oJResp.StringOf("response.result.staff.p_street")
Local $sP_street2 = $oJResp.StringOf("response.result.staff.p_street2")
Local $sRate = $oJResp.StringOf("response.result.staff.rate")
Local $sRole = $oJResp.StringOf("response.result.staff.role")
Local $sSignup_date = $oJResp.StringOf("response.result.staff.signup_date")
Local $sUpdated = $oJResp.StringOf("response.result.staff.updated")
Local $iUserid = $oJResp.IntOf("response.result.staff.userid")
Local $sUsername = $oJResp.StringOf("response.result.staff.username")
Local $iVis_state = $oJResp.IntOf("response.result.staff.vis_state")
Curl Command
curl -X PUT
-H "Authorization: Bearer <access_token>"
-H "Content-Type: application/json"
-d '{
"staff": {
"fname": "Ryen"
}
}'
https://api.freshbooks.com/accounting/account/{{accountId}}/users/staffs/{{staffId}}
Postman Collection Item JSON
{
"name": "Update Staff",
"request": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"name": "Content-Type",
"value": "application/json",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"staff\": {\n \"fname\": \"Ryen\"\n }\n}"
},
"url": {
"raw": "https://api.freshbooks.com/accounting/account/{{accountId}}/users/staffs/{{staffId}}",
"protocol": "https",
"host": [
"api",
"freshbooks",
"com"
],
"path": [
"accounting",
"account",
"{{accountId}}",
"users",
"staffs",
"{{staffId}}"
]
}
},
"response": [
{
"name": "Update Staff",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"name": "Content-Type",
"value": "application/json",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"staff\": {\n \"fname\": \"Ryen\"\n }\n}"
},
"url": {
"raw": "https://api.freshbooks.com/accounting/account/{{accountId}}/users/staffs/{{staffId}}",
"protocol": "https",
"host": [
"api",
"freshbooks",
"com"
],
"path": [
"accounting",
"account",
"{{accountId}}",
"users",
"staffs",
"{{staffId}}"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "nginx"
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "X-NewRelic-App-Data",
"value": "PxQBWV5TCBABVlVSAwEOVlcTGhE1AwE2QgNWEVlbQFtcCxYnRA9QFg1ZWU4DFVdfRgFPCkNFR0gRQlNBEVwQFlEEXkAUCBgCHVQMVQlUBFNRDgFXVlsACwZTTVYHHRVRUAAPUVNUWwACAQ9TDgwCEB8DWA1CBG4="
},
{
"key": "Access-Control-Allow-Origin",
"value": "*"
},
{
"key": "Expires",
"value": "Tue, 24 Apr 2018 18:37:58 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 18:37:58 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 \"staff\": {\n \"accounting_systemid\": \"wkMd2g\",\n \"api_token\": \"9249ac8633763523fe614cdeb28787b9\",\n \"bus_phone\": \"\",\n \"currency_code\": null,\n \"display_name\": \"RyenMarr\",\n \"email\": \"api.freshbooks@gmail.com\",\n \"fax\": \"\",\n \"fname\": \"Ryen\",\n \"home_phone\": null,\n \"id\": 1,\n \"language\": \"en\",\n \"last_login\": null,\n \"level\": 3,\n \"lname\": \"Marr\",\n \"mob_phone\": \"\",\n \"note\": null,\n \"num_logins\": 0,\n \"organization\": \"Postman Sandbox\",\n \"p_city\": \"\",\n \"p_code\": \"\",\n \"p_country\": \"\",\n \"p_province\": \"\",\n \"p_street\": \"\",\n \"p_street2\": \"\",\n \"rate\": null,\n \"role\": \"admin\",\n \"signup_date\": \"2019-04-18 09:14:53\",\n \"updated\": \"2019-04-24 14:37:58\",\n \"userid\": 1,\n \"username\": \"rmarr@freshbooks.com\",\n \"vis_state\": 0\n }\n }\n }\n}"
}
]
}
