Chilkat Online Tools

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

Back to Collection Items

func chilkatTest() {
    // This example assumes the Chilkat API to have been previously unlocked.
    // See Global Unlock Sample for sample code.

    let http = CkoHttp()
    var success: Bool

    // 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": "Contact with a Subform",
    //       "Subform_External": [
    //         {
    //           "Deal_Lookup": {
    //             "External_Deal_ID": "userdeal1"
    //           }
    //         }
    //       ]
    //     }
    //   ]
    // }

    let json = CkoJsonObject()
    json.UpdateString("data[0].Last_Name", value: "Contact with a Subform")
    json.UpdateString("data[0].Subform_External[0].Deal_Lookup.External_Deal_ID", value: "userdeal1")

    // Adds the "Authorization: Bearer <access_token>" header.
    http.AuthToken = "<access_token>"
    http.SetRequestHeader("X-EXTERNAL", value: "Contacts.External_ID")

    var resp: CkoHttpResponse? = http.PostJson3("https://domain.com/crm/v2/Contacts", contentType: "application/json", json: json)
    if http.LastMethodSuccess == false {
        print("\(http.LastErrorText)")
        return
    }

    print("\(resp!.StatusCode.intValue)")
    print("\(resp!.BodyStr)")
    resp = nil

}

Curl Command

curl -X POST
	-H "Authorization: Bearer <access_token>"
	-H "X-EXTERNAL: Contacts.External_ID"
	-d '{
    "data": [
        {
            "Last_Name": "Contact with a Subform",
            "Subform_External": [
                {
                    "Deal_Lookup": {
                        "External_Deal_ID": "userdeal1"
                    }
                }
            ]
        }
    ]
}'
https://domain.com/crm/v2/Contacts

Postman Collection Item JSON

{
  "name": "Inserting 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": "POST",
    "header": [
      {
        "key": "X-EXTERNAL",
        "value": "Contacts.External_ID",
        "type": "text"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n    \"data\": [\n        {\n            \"Last_Name\": \"Contact with a Subform\",\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",
      "host": [
        "{{api-domain}}"
      ],
      "path": [
        "crm",
        "v2",
        "Contacts"
      ]
    },
    "description": "In this example, Subform_External is the API name of the subform in the Contacts module. It has a look up field to the Deals module. The Deals module has an external field External_Deal_ID. We will reference this external field in the subform and insert a record in the Contacts module."
  },
  "response": [
  ]
}