Chilkat Online Tools

PureBasic / Zoho CRM REST APIs / Deals

Back to Collection Items

IncludeFile "CkJsonObject.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.

    ; {
    ;   "data": [
    ;     {
    ;       "Closing_Date": "2021-01-25",
    ;       "Deal_Name": "Sample",
    ;       "Stage": "Qualification",
    ;       "Account_Name": {
    ;         "name": "Zylker",
    ;         "id": "{{account_id}}"
    ;       },
    ;       "Amount": 5000,
    ;       "Probability": 10,
    ;       "Contact_Name": {
    ;         "name": "Patricia Boyle",
    ;         "id": "{{contact_id}}"
    ;       },
    ;       "Type": "Existing Business",
    ;       "Lead_Source": "Advertisement"
    ;     }
    ;   ]
    ; }

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

    CkJsonObject::ckUpdateString(json,"data[0].Closing_Date","2021-01-25")
    CkJsonObject::ckUpdateString(json,"data[0].Deal_Name","Sample")
    CkJsonObject::ckUpdateString(json,"data[0].Stage","Qualification")
    CkJsonObject::ckUpdateString(json,"data[0].Account_Name.name","Zylker")
    CkJsonObject::ckUpdateString(json,"data[0].Account_Name.id","{{account_id}}")
    CkJsonObject::ckUpdateInt(json,"data[0].Amount",5000)
    CkJsonObject::ckUpdateInt(json,"data[0].Probability",10)
    CkJsonObject::ckUpdateString(json,"data[0].Contact_Name.name","Patricia Boyle")
    CkJsonObject::ckUpdateString(json,"data[0].Contact_Name.id","{{contact_id}}")
    CkJsonObject::ckUpdateString(json,"data[0].Type","Existing Business")
    CkJsonObject::ckUpdateString(json,"data[0].Lead_Source","Advertisement")

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

    resp.i = CkHttp::ckPostJson3(http,"https://domain.com/crm/v2.1/Deals/upsert","application/json",json)
    If CkHttp::ckLastMethodSuccess(http) = 0
        Debug CkHttp::ckLastErrorText(http)
        CkHttp::ckDispose(http)
        CkJsonObject::ckDispose(json)
        ProcedureReturn
    EndIf

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



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


    ProcedureReturn
EndProcedure

Curl Command

curl -X POST
	-H "Authorization: Bearer <access_token>"
	-d '{
    "data": [
        {
            "Closing_Date": "2021-01-25",
            "Deal_Name": "Sample",
            "Stage": "Qualification",
            "Account_Name": {
                "name": "Zylker",
                "id": "{{account_id}}"
            },
            "Amount": 5000,
            "Probability": 10,
            "Contact_Name": {
                "name": "Patricia Boyle",
                "id": "{{contact_id}}"
            },
            "Type": "Existing Business",
            "Lead_Source": "Advertisement"
        }
    ]
}'
https://domain.com/crm/v2.1/Deals/upsert

Postman Collection Item JSON

{
  "name": "Deals",
  "request": {
    "auth": {
      "type": "bearer",
      "bearer": [
        {
          "key": "token",
          "value": "{{access-token}}",
          "type": "string"
        }
      ]
    },
    "method": "POST",
    "header": [
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n    \"data\": [\n        {\n            \"Closing_Date\": \"2021-01-25\",\n            \"Deal_Name\": \"Sample\",\n            \"Stage\": \"Qualification\",\n            \"Account_Name\": {\n                \"name\": \"Zylker\",\n                \"id\": \"{{account_id}}\"\n            },\n            \"Amount\": 5000,\n            \"Probability\": 10,\n            \"Contact_Name\": {\n                \"name\": \"Patricia Boyle\",\n                \"id\": \"{{contact_id}}\"\n            },\n            \"Type\": \"Existing Business\",\n            \"Lead_Source\": \"Advertisement\"\n        }\n    ]\n}",
      "options": {
        "raw": {
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "{{api-domain}}/crm/v2.1/Deals/upsert",
      "host": [
        "{{api-domain}}"
      ],
      "path": [
        "crm",
        "v2.1",
        "Deals",
        "upsert"
      ]
    },
    "description": "To upsert records in the Deals module."
  },
  "response": [
  ]
}