Chilkat Online Tools

Python / Zoho CRM REST APIs / Updating a subform lookup record through an external field in the associated module

Back to Collection Items

import sys
import chilkat2

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

http = chilkat2.Http()

# 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": [
#     {
#       "Subform_External": [
#         {
#           "Deal_Lookup": {
#             "External_Deal_ID": "userdeal1"
#           }
#         }
#       ]
#     }
#   ]
# }

json = chilkat2.JsonObject()
json.UpdateString("data[0].Subform_External[0].Deal_Lookup.External_Deal_ID","userdeal1")

# Adds the "Authorization: Bearer <access_token>" header.
http.AuthToken = "<access_token>"
http.SetRequestHeader("X-EXTERNAL","Contacts.External_Contact_ID,Contacts.Subform_External.Deal_Lookup.External_Deal_ID")

sbRequestBody = chilkat2.StringBuilder()
json.EmitSb(sbRequestBody)

# resp is a CkHttpResponse
resp = http.PTextSb("PUT","https://domain.com/crm/v2/Contacts/extcontact2",sbRequestBody,"utf-8","application/json",False,False)
if (http.LastMethodSuccess == False):
    print(http.LastErrorText)
    sys.exit()

print(str(resp.StatusCode))
print(resp.BodyStr)

Curl Command

curl -X PUT
	-H "Authorization: Bearer <access_token>"
	-H "X-EXTERNAL: Contacts.External_Contact_ID,Contacts.Subform_External.Deal_Lookup.External_Deal_ID"
	-d '{
    "data": [
        {
            "Subform_External": [
                {
                    "Deal_Lookup": {
                        "External_Deal_ID": "userdeal1"
                    }
                }
            ]
        }
    ]
}'
https://domain.com/crm/v2/Contacts/extcontact2

Postman Collection Item JSON

{
  "name": "Updating a subform lookup record through an external field in the associated 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.Subform_External.Deal_Lookup.External_Deal_ID",
        "type": "text"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n    \"data\": [\n        {\n            \"Subform_External\": [\n                {\n                    \"Deal_Lookup\": {\n                        \"External_Deal_ID\": \"userdeal1\"\n                    }\n                }\n            ]\n        }\n    ]\n}",
      "options": {
        "raw": {
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "{{api-domain}}/crm/v2/Contacts/extcontact2",
      "host": [
        "{{api-domain}}"
      ],
      "path": [
        "crm",
        "v2",
        "Contacts",
        "extcontact2"
      ]
    },
    "description": "Specify the external field's API name and its value in the lookup field JSON object of the Subform."
  },
  "response": [
  ]
}