Chilkat Online Tools

TCL / Zoho CRM REST APIs / Deals

Back to Collection Items

load ./chilkat.dll

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

set http [new_CkHttp]

# 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": [
#     {
#       "Owner": {
#         "id": "{{user-id}}"
#       },
#       "Account_Name": {
#         "id": "{{account-id}}"
#       },
#       "Contact_Name": {
#         "id": "{{contact-id}}"
#       },
#       "Campaign_Source": {
#         "id": "{{campaign-id}}"
#       },
#       "Type": "New Business",
#       "Description": "Design your own layouts that align your business processes precisely. Assign them to profiles appropriately.",
#       "Deal_Name": "Deal_Name",
#       "Amount": 1237.67,
#       "Next_Step": "Next_Step",
#       "Stage": "Needs Analysis",
#       "Lead_Source": "Cold Call",
#       "Closing_Date": "2018-01-25"
#     }
#   ]
# }

set json [new_CkJsonObject]

CkJsonObject_UpdateString $json "data[0].Owner.id" "{{user-id}}"
CkJsonObject_UpdateString $json "data[0].Account_Name.id" "{{account-id}}"
CkJsonObject_UpdateString $json "data[0].Contact_Name.id" "{{contact-id}}"
CkJsonObject_UpdateString $json "data[0].Campaign_Source.id" "{{campaign-id}}"
CkJsonObject_UpdateString $json "data[0].Type" "New Business"
CkJsonObject_UpdateString $json "data[0].Description" "Design your own layouts that align your business processes precisely. Assign them to profiles appropriately."
CkJsonObject_UpdateString $json "data[0].Deal_Name" "Deal_Name"
CkJsonObject_UpdateNumber $json "data[0].Amount" "1237.67"
CkJsonObject_UpdateString $json "data[0].Next_Step" "Next_Step"
CkJsonObject_UpdateString $json "data[0].Stage" "Needs Analysis"
CkJsonObject_UpdateString $json "data[0].Lead_Source" "Cold Call"
CkJsonObject_UpdateString $json "data[0].Closing_Date" "2018-01-25"

CkHttp_SetRequestHeader $http "Authorization" "{{authorization-token}}"
CkHttp_SetRequestHeader $http "Content-Type" "application/json"

set sbRequestBody [new_CkStringBuilder]

CkJsonObject_EmitSb $json $sbRequestBody

# resp is a CkHttpResponse
set resp [CkHttp_PTextSb $http "PUT" "https://domain.com/crm/v2.1/Deals/{{record-id}}" $sbRequestBody "utf-8" "application/json" 0 0]
if {[CkHttp_get_LastMethodSuccess $http] == 0} then {
    puts [CkHttp_lastErrorText $http]
    delete_CkHttp $http
    delete_CkJsonObject $json
    delete_CkStringBuilder $sbRequestBody
    exit
}

puts [CkHttpResponse_get_StatusCode $resp]
puts [CkHttpResponse_bodyStr $resp]
delete_CkHttpResponse $resp


delete_CkHttp $http
delete_CkJsonObject $json
delete_CkStringBuilder $sbRequestBody

Curl Command

curl -X PUT
	-H "Authorization: Bearer <access_token>"
	-H "Authorization: {{authorization-token}}"
	-H "Content-Type: application/json"
	-d '{
	"data": [
		{
			"Owner": {
				"id": "{{user-id}}"
			},
			"Account_Name": {
				"id": "{{account-id}}"
			},
			"Contact_Name": {
				"id": "{{contact-id}}"
			},
			"Campaign_Source": {
				"id": "{{campaign-id}}"
			},
			"Type": "New Business",
			"Description": "Design your own layouts that align your business processes precisely. Assign them to profiles appropriately.",
			"Deal_Name": "Deal_Name",
			"Amount": 1237.67,
			"Next_Step": "Next_Step",
			"Stage": "Needs Analysis",
			"Lead_Source": "Cold Call",
			"Closing_Date": "2018-01-25"
		}
	]
}'
https://domain.com/crm/v2.1/Deals/{{record-id}}

Postman Collection Item JSON

{
  "name": "Deals",
  "request": {
    "method": "PUT",
    "header": [
      {
        "key": "Authorization",
        "value": "{{authorization-token}}"
      },
      {
        "key": "Content-Type",
        "value": "application/json"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n\t\"data\": [\n\t\t{\n\t\t\t\"Owner\": {\n\t\t\t\t\"id\": \"{{user-id}}\"\n\t\t\t},\n\t\t\t\"Account_Name\": {\n\t\t\t\t\"id\": \"{{account-id}}\"\n\t\t\t},\n\t\t\t\"Contact_Name\": {\n\t\t\t\t\"id\": \"{{contact-id}}\"\n\t\t\t},\n\t\t\t\"Campaign_Source\": {\n\t\t\t\t\"id\": \"{{campaign-id}}\"\n\t\t\t},\n\t\t\t\"Type\": \"New Business\",\n\t\t\t\"Description\": \"Design your own layouts that align your business processes precisely. Assign them to profiles appropriately.\",\n\t\t\t\"Deal_Name\": \"Deal_Name\",\n\t\t\t\"Amount\": 1237.67,\n\t\t\t\"Next_Step\": \"Next_Step\",\n\t\t\t\"Stage\": \"Needs Analysis\",\n\t\t\t\"Lead_Source\": \"Cold Call\",\n\t\t\t\"Closing_Date\": \"2018-01-25\"\n\t\t}\n\t]\n}"
    },
    "url": {
      "raw": "{{api-domain}}/crm/v2.1/Deals/{{record-id}}",
      "host": [
        "{{api-domain}}"
      ],
      "path": [
        "crm",
        "v2.1",
        "Deals",
        "{{record-id}}"
      ]
    },
    "description": "To update existing entities in the module."
  },
  "response": [
  ]
}