Back to Collection Items
load ./chilkat.dll
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
set 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.
# {
# "project": {
# "title": "K2 Hiking Guide",
# "due_date": "2019-04-20",
# "client_id": 123
# }
# }
set json [new_CkJsonObject]
CkJsonObject_UpdateString $json "project.title" "K2 Hiking Guide"
CkJsonObject_UpdateString $json "project.due_date" "2019-04-20"
CkJsonObject_UpdateInt $json "project.client_id" 123
# Adds the "Authorization: Bearer <access_token>" header.
CkHttp_put_AuthToken $http "<access_token>"
CkHttp_SetRequestHeader $http "Content-Type" "application/json"
set sbRequestBody [new_CkStringBuilder]
CkJsonObject_EmitSb $json $sbRequestBody
# resp is a CkHttpResponse
set resp [CkHttp_PTextSb $http "PUT" "https://api.freshbooks.com/projects/business/{{businessId}}/projects/{{projectId}}" $sbRequestBody "utf-8" "application/json" 0 0]
if {[CkHttp_get_LastMethodSuccess $http] == 0} then {
puts [CkHttp_lastErrorText $http]
delete_CkHttp $http
delete_CkJsonObject $json
delete_CkStringBuilder $sbRequestBody
exit
}
set sbResponseBody [new_CkStringBuilder]
CkHttpResponse_GetBodySb $resp $sbResponseBody
set jResp [new_CkJsonObject]
CkJsonObject_LoadSb $jResp $sbResponseBody
CkJsonObject_put_EmitCompact $jResp 0
puts "Response Body:"
puts [CkJsonObject_emit $jResp]
set respStatusCode [CkHttpResponse_get_StatusCode $resp]
puts "Response Status Code = $respStatusCode"
if {$respStatusCode >= 400} then {
puts "Response Header:"
puts [CkHttpResponse_header $resp]
puts "Failed."
delete_CkHttpResponse $resp
delete_CkHttp $http
delete_CkJsonObject $json
delete_CkStringBuilder $sbRequestBody
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
exit
}
delete_CkHttpResponse $resp
# Sample JSON response:
# (Sample code for parsing the JSON response is shown below)
# {
# "project": {
# "id": 3018266,
# "title": "K2 Hiking Guide",
# "description": null,
# "due_date": "2019-04-20",
# "client_id": 31006,
# "internal": false,
# "budget": null,
# "fixed_price": "3000.00",
# "rate": null,
# "billing_method": null,
# "project_type": "fixed_price",
# "active": true,
# "complete": false,
# "sample": false,
# "created_at": "2019-05-08T20:06:55",
# "updated_at": "2019-05-08T20:07:37",
# "logged_duration": null,
# "services": [
# ],
# "billed_amount": "0.00",
# "billed_status": "unbilled",
# "retainer_id": null,
# "group": {
# "id": 5049390,
# "members": [
# {
# "id": 6578346,
# "identity_id": 37256,
# "role": "owner",
# "first_name": "Marshall",
# "last_name": "Johnston",
# "email": "api.freshbooks@gmail.com",
# "company": "Postman Sandbox",
# "active": true
# }
# ],
# "pending_invitations": [
# ]
# }
# },
# "abilities": [
# {
# "name": "can_edit",
# "value": true
# },
# {
# "name": "can_archive",
# "value": true
# },
# {
# "name": "can_generate_invoice",
# "value": true
# },
# {
# "name": "can_delete",
# "value": true
# },
# {
# "name": "can_invite_team_member",
# "value": true
# },
# {
# "name": "can_manage_services",
# "value": true
# },
# {
# "name": "can_edit_hourly_budget",
# "value": true
# },
# {
# "name": "can_view_fixed_price",
# "value": true
# },
# {
# "name": "can_edit_fixed_price",
# "value": true
# },
# {
# "name": "can_edit_end_date",
# "value": true
# },
# {
# "name": "can_edit_flat_rate",
# "value": true
# },
# {
# "name": "can_edit_project_type",
# "value": true
# },
# {
# "name": "can_edit_title",
# "value": true
# },
# {
# "name": "can_view_review_tab",
# "value": true
# },
# {
# "name": "can_view_discuss_tab",
# "value": true
# },
# {
# "name": "can_track_time",
# "value": true
# },
# {
# "name": "can_create_comment",
# "value": true
# }
# ]
# }
# Sample code for parsing the JSON response...
# Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
set Id [CkJsonObject_IntOf $jResp "project.id"]
set Title [CkJsonObject_stringOf $jResp "project.title"]
set Description [CkJsonObject_stringOf $jResp "project.description"]
set Due_date [CkJsonObject_stringOf $jResp "project.due_date"]
set Client_id [CkJsonObject_IntOf $jResp "project.client_id"]
set Internal [CkJsonObject_BoolOf $jResp "project.internal"]
set Budget [CkJsonObject_stringOf $jResp "project.budget"]
set Fixed_price [CkJsonObject_stringOf $jResp "project.fixed_price"]
set Rate [CkJsonObject_stringOf $jResp "project.rate"]
set Billing_method [CkJsonObject_stringOf $jResp "project.billing_method"]
set Project_type [CkJsonObject_stringOf $jResp "project.project_type"]
set Active [CkJsonObject_BoolOf $jResp "project.active"]
set Complete [CkJsonObject_BoolOf $jResp "project.complete"]
set Sample [CkJsonObject_BoolOf $jResp "project.sample"]
set Created_at [CkJsonObject_stringOf $jResp "project.created_at"]
set Updated_at [CkJsonObject_stringOf $jResp "project.updated_at"]
set Logged_duration [CkJsonObject_stringOf $jResp "project.logged_duration"]
set Billed_amount [CkJsonObject_stringOf $jResp "project.billed_amount"]
set Billed_status [CkJsonObject_stringOf $jResp "project.billed_status"]
set Retainer_id [CkJsonObject_stringOf $jResp "project.retainer_id"]
set GroupId [CkJsonObject_IntOf $jResp "project.group.id"]
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "project.services"]
while {$i < $count_i} {
CkJsonObject_put_I $jResp $i
set i [expr $i + 1]
}
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "project.group.members"]
while {$i < $count_i} {
CkJsonObject_put_I $jResp $i
set id [CkJsonObject_IntOf $jResp "project.group.members[i].id"]
set identity_id [CkJsonObject_IntOf $jResp "project.group.members[i].identity_id"]
set role [CkJsonObject_stringOf $jResp "project.group.members[i].role"]
set first_name [CkJsonObject_stringOf $jResp "project.group.members[i].first_name"]
set last_name [CkJsonObject_stringOf $jResp "project.group.members[i].last_name"]
set email [CkJsonObject_stringOf $jResp "project.group.members[i].email"]
set company [CkJsonObject_stringOf $jResp "project.group.members[i].company"]
set active [CkJsonObject_BoolOf $jResp "project.group.members[i].active"]
set i [expr $i + 1]
}
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "project.group.pending_invitations"]
while {$i < $count_i} {
CkJsonObject_put_I $jResp $i
set i [expr $i + 1]
}
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "abilities"]
while {$i < $count_i} {
CkJsonObject_put_I $jResp $i
set name [CkJsonObject_stringOf $jResp "abilities[i].name"]
set value [CkJsonObject_BoolOf $jResp "abilities[i].value"]
set i [expr $i + 1]
}
delete_CkHttp $http
delete_CkJsonObject $json
delete_CkStringBuilder $sbRequestBody
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
Curl Command
curl -X PUT
-H "Authorization: Bearer <access_token>"
-H "Content-Type: application/json"
-d '{
"project": {
"title": "K2 Hiking Guide",
"due_date": "2019-04-20",
"client_id": {{customerId}}
}
}'
https://api.freshbooks.com/projects/business/{{businessId}}/projects/{{projectId}}
Postman Collection Item JSON
{
"name": "Update Project",
"request": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"project\": {\n \"title\": \"K2 Hiking Guide\",\n \"due_date\": \"2019-04-20\",\n \"client_id\": {{customerId}}\n }\n}"
},
"url": {
"raw": "https://api.freshbooks.com/projects/business/{{businessId}}/projects/{{projectId}}",
"protocol": "https",
"host": [
"api",
"freshbooks",
"com"
],
"path": [
"projects",
"business",
"{{businessId}}",
"projects",
"{{projectId}}"
]
},
"description": "Update project with project title. \n\n*`client_id` in this case is `customerId`*"
},
"response": [
{
"name": "Update Project",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"project\": {\n \"title\": \"K2 Hiking Guide\",\n \"due_date\": \"2019-04-20\",\n \"client_id\": {{customerId}}\n }\n}"
},
"url": {
"raw": "https://api.freshbooks.com/projects/business/{{businessId}}/projects/{{projectId}}",
"protocol": "https",
"host": [
"api",
"freshbooks",
"com"
],
"path": [
"projects",
"business",
"{{businessId}}",
"projects",
"{{projectId}}"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "nginx"
},
{
"key": "Content-Type",
"value": "application/vnd.api+json"
},
{
"key": "X-Version",
"value": "1905.7.0"
},
{
"key": "X-NewRelic-App-Data",
"value": "PxQBWV5TCBABVllUBAQOU10TGhE1AwE2QgNWEVlbQFtcCxYnRA9QFg1ZWU4FDFZFVRYSBxlDUhULRERQBxVNEkINUgdbTBpAVhZWFEMCVlgURFgLAwBMERxUTVIZAwRfVQYGBFpfVFMIVApVAQsYAwNSFUMEUlVSVFNUVF5aWgcEUwAAFR1RBwhCU24="
},
{
"key": "X-RateLimit-Limit",
"value": "20"
},
{
"key": "X-RateLimit-Remaining",
"value": "9"
},
{
"key": "X-RateLimit-Reset",
"value": "1557346118"
},
{
"key": "Retry-After",
"value": "60"
},
{
"key": "Access-Control-Allow-Origin",
"value": "*"
},
{
"key": "Expires",
"value": "Tue, 08 May 2018 20:07:37 GMT"
},
{
"key": "Cache-Control",
"value": "no-cache"
},
{
"key": "Via",
"value": "1.1 google"
},
{
"key": "Via",
"value": "1.1 varnish"
},
{
"key": "Content-Length",
"value": "1552"
},
{
"key": "Accept-Ranges",
"value": "bytes"
},
{
"key": "Date",
"value": "Wed, 08 May 2019 20:07:37 GMT"
},
{
"key": "Connection",
"value": "keep-alive"
},
{
"key": "X-Served-By",
"value": "cache-mdw17361-MDW"
},
{
"key": "X-Cache",
"value": "MISS"
},
{
"key": "X-Cache-Hits",
"value": "0"
},
{
"key": "Country",
"value": "CA"
},
{
"key": "Strict-Transport-Security",
"value": "max-age=31536000; includeSubDomains; preload"
}
],
"cookie": [
],
"body": "{\n \"project\": {\n \"id\": 3018266,\n \"title\": \"K2 Hiking Guide\",\n \"description\": null,\n \"due_date\": \"2019-04-20\",\n \"client_id\": 31006,\n \"internal\": false,\n \"budget\": null,\n \"fixed_price\": \"3000.00\",\n \"rate\": null,\n \"billing_method\": null,\n \"project_type\": \"fixed_price\",\n \"active\": true,\n \"complete\": false,\n \"sample\": false,\n \"created_at\": \"2019-05-08T20:06:55\",\n \"updated_at\": \"2019-05-08T20:07:37\",\n \"logged_duration\": null,\n \"services\": [],\n \"billed_amount\": \"0.00\",\n \"billed_status\": \"unbilled\",\n \"retainer_id\": null,\n \"group\": {\n \"id\": 5049390,\n \"members\": [\n {\n \"id\": 6578346,\n \"identity_id\": 37256,\n \"role\": \"owner\",\n \"first_name\": \"Marshall\",\n \"last_name\": \"Johnston\",\n \"email\": \"api.freshbooks@gmail.com\",\n \"company\": \"Postman Sandbox\",\n \"active\": true\n }\n ],\n \"pending_invitations\": []\n }\n },\n \"abilities\": [\n {\n \"name\": \"can_edit\",\n \"value\": true\n },\n {\n \"name\": \"can_archive\",\n \"value\": true\n },\n {\n \"name\": \"can_generate_invoice\",\n \"value\": true\n },\n {\n \"name\": \"can_delete\",\n \"value\": true\n },\n {\n \"name\": \"can_invite_team_member\",\n \"value\": true\n },\n {\n \"name\": \"can_manage_services\",\n \"value\": true\n },\n {\n \"name\": \"can_edit_hourly_budget\",\n \"value\": true\n },\n {\n \"name\": \"can_view_fixed_price\",\n \"value\": true\n },\n {\n \"name\": \"can_edit_fixed_price\",\n \"value\": true\n },\n {\n \"name\": \"can_edit_end_date\",\n \"value\": true\n },\n {\n \"name\": \"can_edit_flat_rate\",\n \"value\": true\n },\n {\n \"name\": \"can_edit_project_type\",\n \"value\": true\n },\n {\n \"name\": \"can_edit_title\",\n \"value\": true\n },\n {\n \"name\": \"can_view_review_tab\",\n \"value\": true\n },\n {\n \"name\": \"can_view_discuss_tab\",\n \"value\": true\n },\n {\n \"name\": \"can_track_time\",\n \"value\": true\n },\n {\n \"name\": \"can_create_comment\",\n \"value\": true\n }\n ]\n}"
}
]
}
