Chilkat Online Tools

Xojo / Zoho CRM REST APIs / Deals

Back to Collection Items

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

Dim http As New Chilkat.Http
Dim success As Boolean

// 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"
//     }
//   ]
// }

Dim json As New Chilkat.JsonObject
success = json.UpdateString("data[0].Owner.id","{{user-id}}")
success = json.UpdateString("data[0].Account_Name.id","{{account-id}}")
success = json.UpdateString("data[0].Contact_Name.id","{{contact-id}}")
success = json.UpdateString("data[0].Campaign_Source.id","{{campaign-id}}")
success = json.UpdateString("data[0].Type","New Business")
success = json.UpdateString("data[0].Description","Design your own layouts that align your business processes precisely. Assign them to profiles appropriately.")
success = json.UpdateString("data[0].Deal_Name","Deal_Name")
success = json.UpdateNumber("data[0].Amount","1237.67")
success = json.UpdateString("data[0].Next_Step","Next_Step")
success = json.UpdateString("data[0].Stage","Needs Analysis")
success = json.UpdateString("data[0].Lead_Source","Cold Call")
success = json.UpdateString("data[0].Closing_Date","2018-01-25")

http.SetRequestHeader "Authorization","{{authorization-token}}"
http.SetRequestHeader "Content-Type","application/json"

Dim sbRequestBody As New Chilkat.StringBuilder
success = json.EmitSb(sbRequestBody)

Dim resp As Chilkat.HttpResponse
resp = http.PTextSb("PUT","https://domain.com/crm/v2.1/Deals/{{record-id}}",sbRequestBody,"utf-8","application/json",False,False)
If (http.LastMethodSuccess = False) Then
    System.DebugLog(http.LastErrorText)
    Return
End If

System.DebugLog(Str(resp.StatusCode))
System.DebugLog(resp.BodyStr)

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