Chilkat Online Tools

Swift / Zoho CRM REST APIs / Handle Parent Module Fields During Transition

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.

    // {
    //   "blueprint": [
    //     {
    //       "transition_id": "2000000031536",
    //       "data": {
    //         "Lookup_2": {
    //           "phone": "123458939",
    //           "id": "2000000048165"
    //         }
    //       }
    //     }
    //   ]
    // }

    let json = CkoJsonObject()
    json.UpdateString("blueprint[0].transition_id", value: "2000000031536")
    json.UpdateString("blueprint[0].data.Lookup_2.phone", value: "123458939")
    json.UpdateString("blueprint[0].data.Lookup_2.id", value: "2000000048165")

    // Adds the "Authorization: Bearer <access_token>" header.
    http.AuthToken = "<access_token>"

    let sbRequestBody = CkoStringBuilder()
    json.EmitSb(sbRequestBody)

    var resp: CkoHttpResponse? = http.PTextSb("PUT", url: "https://domain.com/crm/v2.1/Leads/{{record_id}}/actions/blueprint", textData: sbRequestBody, charset: "utf-8", contentType: "application/json", md5: false, gzip: false)
    if http.LastMethodSuccess == false {
        print("\(http.LastErrorText)")
        return
    }

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

}

Curl Command

curl -X PUT
	-H "Authorization: Bearer <access_token>"
	-d '{
    "blueprint": [
        {
            "transition_id": "2000000031536",
            "data": {
                "Lookup_2": {
                    "phone": "123458939",
                    "id": "2000000048165"
                }
            }
        }
    ]
}'
https://domain.com/crm/v2.1/Leads/{{record_id}}/actions/blueprint

Postman Collection Item JSON

{
  "name": "Handle Parent Module Fields During Transition",
  "request": {
    "auth": {
      "type": "bearer",
      "bearer": [
        {
          "key": "token",
          "value": "{{access-token}}",
          "type": "string"
        }
      ]
    },
    "method": "PUT",
    "header": [
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n    \"blueprint\": [\n        {\n            \"transition_id\": \"2000000031536\",\n            \"data\": {\n                \"Lookup_2\": {\n                    \"phone\": \"123458939\",\n                    \"id\": \"2000000048165\"\n                }\n            }\n        }\n    ]\n}",
      "options": {
        "raw": {
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "{{api-domain}}/crm/v2.1/Leads/{{record_id}}/actions/blueprint",
      "host": [
        "{{api-domain}}"
      ],
      "path": [
        "crm",
        "v2.1",
        "Leads",
        "{{record_id}}",
        "actions",
        "blueprint"
      ]
    },
    "description": "To update a single transition at a time. An error is thrown if the record is not in transition, transition_id is wrong, field_value data type mismatches, or field validation fails."
  },
  "response": [
  ]
}