Chilkat Online Tools

TCL / Zoho CRM REST APIs / Upserting a record when the external value is unique

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": [
#     {
#       "Last_Name": "Boyle",
#       "External_Contact_ID": "Boyle1"
#     }
#   ]
# }

set json [new_CkJsonObject]

CkJsonObject_UpdateString $json "data[0].Last_Name" "Boyle"
CkJsonObject_UpdateString $json "data[0].External_Contact_ID" "Boyle1"

# Adds the "Authorization: Bearer <access_token>" header.
CkHttp_put_AuthToken $http "<access_token>"
CkHttp_SetRequestHeader $http "X-EXTERNAL" "Contacts.External_Contact_ID"

set resp [new_CkHttpResponse]

set success [CkHttp_HttpJson $http "POST" "https://domain.com/crm/v2/Contacts/upsert" $json "application/json" $resp]
if {$success == 0} then {
    puts [CkHttp_lastErrorText $http]
    delete_CkHttp $http
    delete_CkJsonObject $json
    delete_CkHttpResponse $resp
    exit
}

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

delete_CkHttp $http
delete_CkJsonObject $json
delete_CkHttpResponse $resp

Curl Command

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

Postman Collection Item JSON

{
  "name": "Upserting a record when the external value is unique",
  "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\",\n            \"External_Contact_ID\": \"Boyle1\"\n        }\n    ]\n}",
      "options": {
        "raw": {
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "{{api-domain}}/crm/v2/Contacts/upsert",
      "host": [
        "{{api-domain}}"
      ],
      "path": [
        "crm",
        "v2",
        "Contacts",
        "upsert"
      ]
    },
    "description": "Let us consider an example of an upsert request in the Contacts module. When the external field's value is unique, and if the other duplicate fields are checked, the system inserts the contact."
  },
  "response": [
  ]
}