Chilkat Online Tools

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

Back to Collection Items

require 'chilkat'

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

http = Chilkat::CkHttp.new()

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

json = Chilkat::CkJsonObject.new()
json.UpdateString("data[0].Last_Name","Boyle P")
json.UpdateString("data[0].External_Contact_ID","Boyle123")
json.UpdateString("data[0].Email","p.boyle@abc.com")

# Adds the "Authorization: Bearer <access_token>" header.
http.put_AuthToken("<access_token>")
http.SetRequestHeader("X-EXTERNAL","Contacts.External_Contact_ID")

# resp is a CkHttpResponse
resp = http.PostJson3("https://domain.com/crm/v2/Contacts/upsert","application/json",json)
if (http.get_LastMethodSuccess() == false)
    print http.lastErrorText() + "\n";
    exit
end

print resp.get_StatusCode().to_s() + "\n";
print resp.bodyStr() + "\n";

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