Chilkat Online Tools

Xojo / Zoho CRM REST APIs / Updating a record through the external value of a lookup record in that module

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": [
//     {
//       "External_Contact_ID": "extcontact1",
//       "Account_Name": {
//         "External_Account_ID": "extaccount1"
//       }
//     }
//   ]
// }

Dim json As New Chilkat.JsonObject
success = json.UpdateString("data[0].External_Contact_ID","extcontact1")
success = json.UpdateString("data[0].Account_Name.External_Account_ID","extaccount1")

// Adds the "Authorization: Bearer <access_token>" header.
http.AuthToken = "<access_token>"
http.SetRequestHeader "X-EXTERNAL","Contacts.External_Contact_ID, Contacts.Account_Name.External_Account_ID"

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

Dim resp As Chilkat.HttpResponse
resp = http.PTextSb("PUT","https://domain.com/crm/v2/Contacts",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 "X-EXTERNAL: Contacts.External_Contact_ID, Contacts.Account_Name.External_Account_ID"
	-d '{
    "data": [
        {
            "External_Contact_ID": "extcontact1",
            "Account_Name": {
                "External_Account_ID": "extaccount1"
            }
        }
    ]
}'
https://domain.com/crm/v2/Contacts

Postman Collection Item JSON

{
  "name": "Updating a record through the external value of a lookup record in that module",
  "request": {
    "auth": {
      "type": "bearer",
      "bearer": [
        {
          "key": "token",
          "value": "{{access-token}}",
          "type": "string"
        }
      ]
    },
    "method": "PUT",
    "header": [
      {
        "key": "X-EXTERNAL",
        "value": "Contacts.External_Contact_ID, Contacts.Account_Name.External_Account_ID",
        "type": "text"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n    \"data\": [\n        {\n            \"External_Contact_ID\": \"extcontact1\",\n            \"Account_Name\": {\n                \"External_Account_ID\": \"extaccount1\"\n            }\n        }\n    ]\n}",
      "options": {
        "raw": {
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "{{api-domain}}/crm/v2/Contacts",
      "host": [
        "{{api-domain}}"
      ],
      "path": [
        "crm",
        "v2",
        "Contacts"
      ]
    },
    "description": "In this example, Contacts is the base module and contains an account lookup field Account_Name. To update a record in the Contacts module, you must specify the external field's API name and its value in the Accounts module, and the external field's API name and its value in the Contacts module."
  },
  "response": [
  ]
}