Chilkat Online Tools

PureBasic / New FreshBooks / Send Estimate by Email

Back to Collection Items

IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkHttpResponse.pb"

Procedure ChilkatExample()

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

    http.i = CkHttp::ckCreate()
    If http.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success.i

    ; 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.i = CkJsonObject::ckCreate()
    If json.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::ckUpdateString(json,"estimate.email_recipients[0]","example@freshbooks.com")
    CkJsonObject::ckUpdateString(json,"estimate.estimate_customized_email.subject","::company name:: sent you an estimate (::estimate number::)")
    CkJsonObject::ckUpdateString(json,"estimate.estimate_customized_email.body","::company name:: sent you an estimate (::estimate number::)")
    CkJsonObject::ckUpdateBool(json,"estimate.action_email",1)

    ; Adds the "Authorization: Bearer <access_token>" header.
    CkHttp::setCkAuthToken(http, "<access_token>")

    sbRequestBody.i = CkStringBuilder::ckCreate()
    If sbRequestBody.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::ckEmitSb(json,sbRequestBody)

    resp.i = CkHttp::ckPTextSb(http,"PUT","https://api.freshbooks.com/accounting/account/{{accountid}}/estimates/estimates/{{estimateid}}",sbRequestBody,"utf-8","application/json",0,0)
    If CkHttp::ckLastMethodSuccess(http) = 0
        Debug CkHttp::ckLastErrorText(http)
        CkHttp::ckDispose(http)
        CkJsonObject::ckDispose(json)
        CkStringBuilder::ckDispose(sbRequestBody)
        ProcedureReturn
    EndIf

    Debug Str(CkHttpResponse::ckStatusCode(resp))
    Debug CkHttpResponse::ckBodyStr(resp)
    CkHttpResponse::ckDispose(resp)



    CkHttp::ckDispose(http)
    CkJsonObject::ckDispose(json)
    CkStringBuilder::ckDispose(sbRequestBody)


    ProcedureReturn
EndProcedure

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": [
  ]
}