Chilkat Online Tools

Ruby / New FreshBooks / Modify existing application

Back to Collection Items

require 'chilkat'

# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.

http = Chilkat::CkHttp.new()

# Use this online tool to generate code from sample JSON: Generate Code to Create JSON

# The following JSON is sent in the request body.

# {
#   "name": "<app_name>",
#   "client_secret": "<app client secret>",
#   "redirect_uri": "<app redirect uri>",
#   "description": "<app descripttion>",
#   "website_url": "<link to app website>",
#   "settings_url": "<link to app settings>",
#   "logo_public_id": "<jwt returned from post https://api.freshbooks.com/uploads/images>"
# }

json = Chilkat::CkJsonObject.new()
json.UpdateString("name","<app_name>")
json.UpdateString("client_secret","<app client secret>")
json.UpdateString("redirect_uri","<app redirect uri>")
json.UpdateString("description","<app descripttion>")
json.UpdateString("website_url","<link to app website>")
json.UpdateString("settings_url","<link to app settings>")
json.UpdateString("logo_public_id","<jwt returned from post https://api.freshbooks.com/uploads/images>")

# Adds the "Authorization: Bearer <access_token>" header.
http.put_AuthToken("<access_token>")
http.SetRequestHeader("Content-Type","application/json")

sbRequestBody = Chilkat::CkStringBuilder.new()
json.EmitSb(sbRequestBody)

# resp is a CkHttpResponse
resp = http.PTextSb("PUT","https://api.freshbooks.com/auth/api/v1/partners/applications/<app_client_id>",sbRequestBody,"utf-8","application/json",false,false)
if (http.get_LastMethodSuccess() == false)
    print http.lastErrorText() + "\n";
    exit
end

print resp.get_StatusCode().to_s() + "\n";
print resp.bodyStr() + "\n";

Curl Command

curl -X PUT
	-H "Authorization: Bearer <access_token>"
	-H "Content-Type: application/json"
	-d '{ 
   "name": "<app_name>",
   "client_secret":"<app client secret>",
   "redirect_uri":"<app redirect uri>",
   "description":"<app descripttion>",
   "website_url":"<link to app website>",
   "settings_url":"<link to app settings>",
   "logo_public_id":"<jwt returned from post https://api.freshbooks.com/uploads/images>"
}'
https://api.freshbooks.com/auth/api/v1/partners/applications/<app_client_id>

Postman Collection Item JSON

{
  "name": "Modify existing application",
  "request": {
    "method": "PUT",
    "header": [
      {
        "key": "Content-Type",
        "name": "Content-Type",
        "value": "application/json",
        "type": "text"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{ \n   \"name\": \"<app_name>\",\n   \"client_secret\":\"<app client secret>\",\n   \"redirect_uri\":\"<app redirect uri>\",\n   \"description\":\"<app descripttion>\",\n   \"website_url\":\"<link to app website>\",\n   \"settings_url\":\"<link to app settings>\",\n   \"logo_public_id\":\"<jwt returned from post https://api.freshbooks.com/uploads/images>\"\n}"
    },
    "url": {
      "raw": "https://api.freshbooks.com/auth/api/v1/partners/applications/<app_client_id>",
      "protocol": "https",
      "host": [
        "api",
        "freshbooks",
        "com"
      ],
      "path": [
        "auth",
        "api",
        "v1",
        "partners",
        "applications",
        "<app_client_id>"
      ]
    }
  },
  "response": [
  ]
}