Chilkat Online Tools

PureBasic / Zoho CRM REST APIs / Cases

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": [
    ;     {
    ;       "Email": "patricia.boyle1@zylker.com",
    ;       "Description": "This is a sample case",
    ;       "Deal_Name": {
    ;         "name": "Sample",
    ;         "id": "{{deal_id}}"
    ;       },
    ;       "Phone": "9090909090",
    ;       "Account_Name": {
    ;         "name": "Sample",
    ;         "id": "{{account_id}}"
    ;       },
    ;       "Solution": "This is a sample solution",
    ;       "Status": "New",
    ;       "Priority": "Medium",
    ;       "Product_Name": {
    ;         "name": "Sample Product",
    ;         "id": "{{product_name}}"
    ;       },
    ;       "Case_Origin": "Email",
    ;       "Subject": "This is a sample Case",
    ;       "Case_Reason": "User did not attend any training.",
    ;       "Related_To": {
    ;         "name": "Patricia Boyle",
    ;         "id": "{{contact_id}}"
    ;       }
    ;     }
    ;   ]
    ; }

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

    CkJsonObject::ckUpdateString(json,"data[0].Email","patricia.boyle1@zylker.com")
    CkJsonObject::ckUpdateString(json,"data[0].Description","This is a sample case")
    CkJsonObject::ckUpdateString(json,"data[0].Deal_Name.name","Sample")
    CkJsonObject::ckUpdateString(json,"data[0].Deal_Name.id","{{deal_id}}")
    CkJsonObject::ckUpdateString(json,"data[0].Phone","9090909090")
    CkJsonObject::ckUpdateString(json,"data[0].Account_Name.name","Sample")
    CkJsonObject::ckUpdateString(json,"data[0].Account_Name.id","{{account_id}}")
    CkJsonObject::ckUpdateString(json,"data[0].Solution","This is a sample solution")
    CkJsonObject::ckUpdateString(json,"data[0].Status","New")
    CkJsonObject::ckUpdateString(json,"data[0].Priority","Medium")
    CkJsonObject::ckUpdateString(json,"data[0].Product_Name.name","Sample Product")
    CkJsonObject::ckUpdateString(json,"data[0].Product_Name.id","{{product_name}}")
    CkJsonObject::ckUpdateString(json,"data[0].Case_Origin","Email")
    CkJsonObject::ckUpdateString(json,"data[0].Subject","This is a sample Case")
    CkJsonObject::ckUpdateString(json,"data[0].Case_Reason","User did not attend any training.")
    CkJsonObject::ckUpdateString(json,"data[0].Related_To.name","Patricia Boyle")
    CkJsonObject::ckUpdateString(json,"data[0].Related_To.id","{{contact_id}}")

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

    resp.i = CkHttp::ckPostJson3(http,"https://domain.com/crm/v2.1/Cases/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": [
        {
            "Email": "patricia.boyle1@zylker.com",
            "Description": "This is a sample case",
            "Deal_Name": {
                "name": "Sample",
                "id": "{{deal_id}}"
            },
            "Phone": "9090909090",
            "Account_Name": {
                "name": "Sample",
                "id": "{{account_id}}"
            },
            "Solution": "This is a sample solution",
            "Status": "New",
            "Priority": "Medium",
            "Product_Name": {
                "name": "Sample Product",
                "id": "{{product_name}}"
            },
            "Case_Origin": "Email",
            "Subject": "This is a sample Case",
            "Case_Reason": "User did not attend any training.",
            "Related_To": {
                "name": "Patricia Boyle",
                "id": "{{contact_id}}"
            }
        }
    ]
}'
https://domain.com/crm/v2.1/Cases/upsert

Postman Collection Item JSON

{
  "name": "Cases",
  "request": {
    "auth": {
      "type": "bearer",
      "bearer": [
        {
          "key": "token",
          "value": "{{access-token}}",
          "type": "string"
        }
      ]
    },
    "method": "POST",
    "header": [
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n    \"data\": [\n        {\n            \"Email\": \"patricia.boyle1@zylker.com\",\n            \"Description\": \"This is a sample case\",\n            \"Deal_Name\": {\n                \"name\": \"Sample\",\n                \"id\": \"{{deal_id}}\"\n            },\n            \"Phone\": \"9090909090\",\n            \"Account_Name\": {\n                \"name\": \"Sample\",\n                \"id\": \"{{account_id}}\"\n            },\n            \"Solution\": \"This is a sample solution\",\n            \"Status\": \"New\",\n            \"Priority\": \"Medium\",\n            \"Product_Name\": {\n                \"name\": \"Sample Product\",\n                \"id\": \"{{product_name}}\"\n            },\n            \"Case_Origin\": \"Email\",\n            \"Subject\": \"This is a sample Case\",\n            \"Case_Reason\": \"User did not attend any training.\",\n            \"Related_To\": {\n                \"name\": \"Patricia Boyle\",\n                \"id\": \"{{contact_id}}\"\n            }\n        }\n    ]\n}",
      "options": {
        "raw": {
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "{{api-domain}}/crm/v2.1/Cases/upsert",
      "host": [
        "{{api-domain}}"
      ],
      "path": [
        "crm",
        "v2.1",
        "Cases",
        "upsert"
      ]
    },
    "description": "To upsert records in the Cases module."
  },
  "response": [
  ]
}