Chilkat Online Tools

Ruby / New FreshBooks / Send Estimate by Email

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.

# {
#   "estimate": {
#     "email_recipients": [
#       "example@freshbooks.com"
#     ],
#     "estimate_customized_email": {
#       "subject": "::company name:: sent you an estimate (::estimate number::)",
#       "body": "::company name:: sent you an estimate (::estimate number::)"
#     },
#     "action_email": true
#   }
# }

json = Chilkat::CkJsonObject.new()
json.UpdateString("estimate.email_recipients[0]","example@freshbooks.com")
json.UpdateString("estimate.estimate_customized_email.subject","::company name:: sent you an estimate (::estimate number::)")
json.UpdateString("estimate.estimate_customized_email.body","::company name:: sent you an estimate (::estimate number::)")
json.UpdateBool("estimate.action_email",true)

# Adds the "Authorization: Bearer <access_token>" header.
http.put_AuthToken("<access_token>")

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

# resp is a CkHttpResponse
resp = http.PTextSb("PUT","https://api.freshbooks.com/accounting/account/{{accountid}}/estimates/estimates/{{estimateid}}",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>"
	-d '{
    "estimate": {
        "email_recipients": [
            "example@freshbooks.com"
        ],
        "estimate_customized_email": {
            "subject": "::company name:: sent you an estimate (::estimate number::)",
            "body": "::company name:: sent you an estimate (::estimate number::)"
        },
        "action_email": true
    }
}'
https://api.freshbooks.com/accounting/account/{{accountid}}/estimates/estimates/{{estimateid}}

Postman Collection Item JSON

{
  "name": "Send Estimate by Email",
  "request": {
    "method": "PUT",
    "header": [
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n    \"estimate\": {\n        \"email_recipients\": [\n            \"example@freshbooks.com\"\n        ],\n        \"estimate_customized_email\": {\n            \"subject\": \"::company name:: sent you an estimate (::estimate number::)\",\n            \"body\": \"::company name:: sent you an estimate (::estimate number::)\"\n        },\n        \"action_email\": true\n    }\n}",
      "options": {
        "raw": {
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "https://api.freshbooks.com/accounting/account/{{accountid}}/estimates/estimates/{{estimateid}}",
      "protocol": "https",
      "host": [
        "api",
        "freshbooks",
        "com"
      ],
      "path": [
        "accounting",
        "account",
        "{{accountid}}",
        "estimates",
        "estimates",
        "{{estimateid}}"
      ]
    }
  },
  "response": [
  ]
}