Chilkat Online Tools

autoit / Zoho CRM REST APIs / Upserting the external field using the system-defined duplicate check field

Back to Collection Items

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

$oHttp = ObjCreate("Chilkat.Http")
Local $bSuccess

; 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": [
;     {
;       "Last_Name": "Boyle P",
;       "External_Contact_ID": "Boyle123",
;       "Email": "p.boyle@abc.com"
;     }
;   ]
; }

$oJson = ObjCreate("Chilkat.JsonObject")
$oJson.UpdateString("data[0].Last_Name","Boyle P")
$oJson.UpdateString("data[0].External_Contact_ID","Boyle123")
$oJson.UpdateString("data[0].Email","p.boyle@abc.com")

; Adds the "Authorization: Bearer <access_token>" header.
$oHttp.AuthToken = "<access_token>"
$oHttp.SetRequestHeader "X-EXTERNAL","Contacts.External_Contact_ID"

Local $oResp = $oHttp.PostJson3("https://domain.com/crm/v2/Contacts/upsert","application/json",$oJson)
If ($oHttp.LastMethodSuccess = False) Then
    ConsoleWrite($oHttp.LastErrorText & @CRLF)
    Exit
EndIf

ConsoleWrite($oResp.StatusCode & @CRLF)
ConsoleWrite($oResp.BodyStr & @CRLF)

Curl Command

curl -X POST
	-H "Authorization: Bearer <access_token>"
	-H "X-EXTERNAL: Contacts.External_Contact_ID"
	-d '{
    "data": [
        {
            "Last_Name": "Boyle P",
            "External_Contact_ID": "Boyle123",
            "Email": "p.boyle@abc.com"
        }
    ]
}'
https://domain.com/crm/v2/Contacts/upsert

Postman Collection Item JSON

{
  "name": "Upserting the external field using the system-defined duplicate check field",
  "request": {
    "auth": {
      "type": "bearer",
      "bearer": [
        {
          "key": "token",
          "value": "{{access-token}}",
          "type": "string"
        }
      ]
    },
    "method": "POST",
    "header": [
      {
        "key": "X-EXTERNAL",
        "value": "Contacts.External_Contact_ID",
        "type": "text"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n    \"data\": [\n        {\n            \"Last_Name\": \"Boyle P\",\n            \"External_Contact_ID\": \"Boyle123\",\n            \"Email\": \"p.boyle@abc.com\"\n        }\n    ]\n}",
      "options": {
        "raw": {
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "{{api-domain}}/crm/v2/Contacts/upsert",
      "host": [
        "{{api-domain}}"
      ],
      "path": [
        "crm",
        "v2",
        "Contacts",
        "upsert"
      ]
    },
    "description": "In this example, a new external value is passed to the external field External_Contact_ID in the Contacts module. Now, the system checks for the system-defined duplicate check field \"Email\". If that email ID exists for a contact, the system updates that contact with the new value for the external field."
  },
  "response": [
  ]
}