Back to Collection Items
LOCAL loHttp
LOCAL lnSuccess
LOCAL loJson
LOCAL loSbRequestBody
LOCAL loResp
LOCAL loSbResponseBody
LOCAL loJResp
LOCAL lnRespStatusCode
LOCAL lnId
LOCAL lnIdentity_id
LOCAL lcRole
LOCAL lcFirst_name
LOCAL lcLast_name
LOCAL lcEmail
LOCAL lcCompany
LOCAL lnActive
LOCAL lcName
LOCAL lnValue
LOCAL lnId
LOCAL lcTitle
LOCAL lcDescription
LOCAL lcDue_date
LOCAL lnClient_id
LOCAL lnInternal
LOCAL lcBudget
LOCAL lcFixed_price
LOCAL lcRate
LOCAL lcBilling_method
LOCAL lcProject_type
LOCAL lnActive
LOCAL lnComplete
LOCAL lnSample
LOCAL lcCreated_at
LOCAL lcUpdated_at
LOCAL lcLogged_duration
LOCAL lcBilled_amount
LOCAL lcBilled_status
LOCAL lcRetainer_id
LOCAL lnGroupId
LOCAL i
LOCAL lnCount_i
* 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.
* {
* "project": {
* "title": "K2 Hiking Guide",
* "due_date": "2019-04-20",
* "client_id": 123
* }
* }
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJson = CreateObject('Chilkat.JsonObject')
loJson.UpdateString("project.title","K2 Hiking Guide")
loJson.UpdateString("project.due_date","2019-04-20")
loJson.UpdateInt("project.client_id",123)
* 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/projects/business/{{businessId}}/projects/{{projectId}}",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)
* {
* "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
lnId = loJResp.IntOf("project.id")
lcTitle = loJResp.StringOf("project.title")
lcDescription = loJResp.StringOf("project.description")
lcDue_date = loJResp.StringOf("project.due_date")
lnClient_id = loJResp.IntOf("project.client_id")
lnInternal = loJResp.BoolOf("project.internal")
lcBudget = loJResp.StringOf("project.budget")
lcFixed_price = loJResp.StringOf("project.fixed_price")
lcRate = loJResp.StringOf("project.rate")
lcBilling_method = loJResp.StringOf("project.billing_method")
lcProject_type = loJResp.StringOf("project.project_type")
lnActive = loJResp.BoolOf("project.active")
lnComplete = loJResp.BoolOf("project.complete")
lnSample = loJResp.BoolOf("project.sample")
lcCreated_at = loJResp.StringOf("project.created_at")
lcUpdated_at = loJResp.StringOf("project.updated_at")
lcLogged_duration = loJResp.StringOf("project.logged_duration")
lcBilled_amount = loJResp.StringOf("project.billed_amount")
lcBilled_status = loJResp.StringOf("project.billed_status")
lcRetainer_id = loJResp.StringOf("project.retainer_id")
lnGroupId = loJResp.IntOf("project.group.id")
i = 0
lnCount_i = loJResp.SizeOfArray("project.services")
DO WHILE i < lnCount_i
loJResp.I = i
i = i + 1
ENDDO
i = 0
lnCount_i = loJResp.SizeOfArray("project.group.members")
DO WHILE i < lnCount_i
loJResp.I = i
lnId = loJResp.IntOf("project.group.members[i].id")
lnIdentity_id = loJResp.IntOf("project.group.members[i].identity_id")
lcRole = loJResp.StringOf("project.group.members[i].role")
lcFirst_name = loJResp.StringOf("project.group.members[i].first_name")
lcLast_name = loJResp.StringOf("project.group.members[i].last_name")
lcEmail = loJResp.StringOf("project.group.members[i].email")
lcCompany = loJResp.StringOf("project.group.members[i].company")
lnActive = loJResp.BoolOf("project.group.members[i].active")
i = i + 1
ENDDO
i = 0
lnCount_i = loJResp.SizeOfArray("project.group.pending_invitations")
DO WHILE i < lnCount_i
loJResp.I = i
i = i + 1
ENDDO
i = 0
lnCount_i = loJResp.SizeOfArray("abilities")
DO WHILE i < lnCount_i
loJResp.I = i
lcName = loJResp.StringOf("abilities[i].name")
lnValue = loJResp.BoolOf("abilities[i].value")
i = i + 1
ENDDO
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 '{
"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}"
}
]
}
