TCL / Zoho CRM REST APIs / Using External Field's Value
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]
set queryParams [new_CkJsonObject]
CkJsonObject_UpdateString $queryParams "fields" "External_Contact_ID,Last_Name,First_Name,Full_Name,Account_Name,OrgExternal"
CkJsonObject_UpdateInt $queryParams "per_page" 2
# Adds the "Authorization: Bearer <access_token>" header.
CkHttp_put_AuthToken $http "<access_token>"
CkHttp_SetRequestHeader $http "X-EXTERNAL" "Contacts.External_ID"
# resp is a CkHttpResponse
set resp [CkHttp_QuickRequestParams $http "GET" "https://domain.com/crm/v2/Contacts/externalcontact1" $queryParams]
if {[CkHttp_get_LastMethodSuccess $http] == 0} then {
puts [CkHttp_lastErrorText $http]
delete_CkHttp $http
delete_CkJsonObject $queryParams
exit
}
puts [CkHttpResponse_get_StatusCode $resp]
puts [CkHttpResponse_bodyStr $resp]
delete_CkHttpResponse $resp
delete_CkHttp $http
delete_CkJsonObject $queryParams
Curl Command
curl -G -d "fields=External_Contact_ID,Last_Name,First_Name,Full_Name,Account_Name,OrgExternal"
-d "per_page=2"
-H "Authorization: Bearer <access_token>"
-H "X-EXTERNAL: Contacts.External_ID"
https://domain.com/crm/v2/Contacts/externalcontact1
Postman Collection Item JSON
{
"name": "Using External Field's Value",
"request": {
"auth": {
"type": "bearer",
"bearer": [
{
"key": "token",
"value": "{{access-token}}",
"type": "string"
}
]
},
"method": "GET",
"header": [
{
"key": "X-EXTERNAL",
"value": "Contacts.External_ID",
"type": "text"
}
],
"url": {
"raw": "{{api-domain}}/crm/v2/Contacts/externalcontact1?fields=External_Contact_ID,Last_Name,First_Name,Full_Name,Account_Name,OrgExternal&per_page=2",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2",
"Contacts",
"externalcontact1"
],
"query": [
{
"key": "fields",
"value": "External_Contact_ID,Last_Name,First_Name,Full_Name,Account_Name,OrgExternal"
},
{
"key": "per_page",
"value": "2"
}
]
},
"description": "To fetch a record through the external field's value. In this example, Contacts is the base module's API name, External_Contact_ID is the API name of the external field, and externalcontact1 is the value of the external field in this module."
},
"response": [
]
}