Back to Collection Items
LOCAL loHttp
LOCAL lnSuccess
LOCAL loJson
LOCAL loSbRequestBody
LOCAL loResp
LOCAL loSbResponseBody
LOCAL loJResp
LOCAL lnRespStatusCode
LOCAL lcAccounting_systemid
LOCAL lcApi_token
LOCAL lcBus_phone
LOCAL lcCurrency_code
LOCAL lcDisplay_name
LOCAL lcV_Email
LOCAL lcFax
LOCAL lcFname
LOCAL lcHome_phone
LOCAL lnId
LOCAL lcLanguage
LOCAL lcLast_login
LOCAL lnLevel
LOCAL lcLname
LOCAL lcMob_phone
LOCAL lcNote
LOCAL lnNum_logins
LOCAL lcOrganization
LOCAL lcP_city
LOCAL lcP_code
LOCAL lcP_country
LOCAL lcP_province
LOCAL lcP_street
LOCAL lcP_street2
LOCAL lcRate
LOCAL lcRole
LOCAL lcSignup_date
LOCAL lcUpdated
LOCAL lnUserid
LOCAL lcUsername
LOCAL lnVis_state
* This example assumes the Chilkat API to have been previously unlocked.
* See Global Unlock Sample for sample code.
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.Http')
loHttp = CreateObject('Chilkat.Http')
* 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"
* }
* }
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJson = CreateObject('Chilkat.JsonObject')
loJson.UpdateString("staff.fname","Ryen")
* Adds the "Authorization: Bearer <access_token>" header.
loHttp.AuthToken = "<access_token>"
loHttp.SetRequestHeader("Content-Type","application/json")
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.StringBuilder')
loSbRequestBody = CreateObject('Chilkat.StringBuilder')
loJson.EmitSb(loSbRequestBody)
loResp = loHttp.PTextSb("PUT","https://api.freshbooks.com/accounting/account/{{accountId}}/users/staffs/{{staffId}}",loSbRequestBody,"utf-8","application/json",0,0)
IF (loHttp.LastMethodSuccess = 0) THEN
? loHttp.LastErrorText
RELEASE loHttp
RELEASE loJson
RELEASE loSbRequestBody
CANCEL
ENDIF
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.StringBuilder')
loSbResponseBody = CreateObject('Chilkat.StringBuilder')
loResp.GetBodySb(loSbResponseBody)
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJResp = CreateObject('Chilkat.JsonObject')
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = 0
? "Response Body:"
? loJResp.Emit()
lnRespStatusCode = loResp.StatusCode
? "Response Status Code = " + STR(lnRespStatusCode)
IF (lnRespStatusCode >= 400) THEN
? "Response Header:"
? loResp.Header
? "Failed."
RELEASE loResp
RELEASE loHttp
RELEASE loJson
RELEASE loSbRequestBody
RELEASE loSbResponseBody
RELEASE loJResp
CANCEL
ENDIF
RELEASE loResp
* 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
lcAccounting_systemid = loJResp.StringOf("response.result.staff.accounting_systemid")
lcApi_token = loJResp.StringOf("response.result.staff.api_token")
lcBus_phone = loJResp.StringOf("response.result.staff.bus_phone")
lcCurrency_code = loJResp.StringOf("response.result.staff.currency_code")
lcDisplay_name = loJResp.StringOf("response.result.staff.display_name")
lcV_Email = loJResp.StringOf("response.result.staff.email")
lcFax = loJResp.StringOf("response.result.staff.fax")
lcFname = loJResp.StringOf("response.result.staff.fname")
lcHome_phone = loJResp.StringOf("response.result.staff.home_phone")
lnId = loJResp.IntOf("response.result.staff.id")
lcLanguage = loJResp.StringOf("response.result.staff.language")
lcLast_login = loJResp.StringOf("response.result.staff.last_login")
lnLevel = loJResp.IntOf("response.result.staff.level")
lcLname = loJResp.StringOf("response.result.staff.lname")
lcMob_phone = loJResp.StringOf("response.result.staff.mob_phone")
lcNote = loJResp.StringOf("response.result.staff.note")
lnNum_logins = loJResp.IntOf("response.result.staff.num_logins")
lcOrganization = loJResp.StringOf("response.result.staff.organization")
lcP_city = loJResp.StringOf("response.result.staff.p_city")
lcP_code = loJResp.StringOf("response.result.staff.p_code")
lcP_country = loJResp.StringOf("response.result.staff.p_country")
lcP_province = loJResp.StringOf("response.result.staff.p_province")
lcP_street = loJResp.StringOf("response.result.staff.p_street")
lcP_street2 = loJResp.StringOf("response.result.staff.p_street2")
lcRate = loJResp.StringOf("response.result.staff.rate")
lcRole = loJResp.StringOf("response.result.staff.role")
lcSignup_date = loJResp.StringOf("response.result.staff.signup_date")
lcUpdated = loJResp.StringOf("response.result.staff.updated")
lnUserid = loJResp.IntOf("response.result.staff.userid")
lcUsername = loJResp.StringOf("response.result.staff.username")
lnVis_state = loJResp.IntOf("response.result.staff.vis_state")
RELEASE loHttp
RELEASE loJson
RELEASE loSbRequestBody
RELEASE loSbResponseBody
RELEASE loJResp
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}"
}
]
}
