Chilkat Online Tools

Go / Zoho CRM REST APIs / Add Notes to a Record in Transition

Back to Collection Items

    // This example assumes the Chilkat API to have been previously unlocked.
    // See Global_Ref.html">Global Unlock Sample for sample code.

    http := chilkat.NewHttp()
    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": "401308000003240197",
    //       "data": {
    //         "Phone": 8940372937,
    //         "Notes": "Updated via blueprint"
    //       }
    //     }
    //   ]
    // }

    json := chilkat.NewJsonObject()
    json.UpdateString("blueprint[0].transition_id","401308000003240197")
    json.UpdateInt("blueprint[0].data.Phone",123)
    json.UpdateString("blueprint[0].data.Notes","Updated via blueprint")

    // Adds the "Authorization: Bearer <access_token>" header.
    http.SetAuthToken("<access_token>")

    sbRequestBody := chilkat.NewStringBuilder()
    json.EmitSb(sbRequestBody)

    resp := http.PTextSb("PUT","https://domain.com/crm/v2.1/Leads/{{record_id}}/actions/blueprint",sbRequestBody,"utf-8","application/json",false,false)
    if http.LastMethodSuccess() == false {
        fmt.Println(http.LastErrorText())
        http.DisposeHttp()
        json.DisposeJsonObject()
        sbRequestBody.DisposeStringBuilder()
        return
    }

    fmt.Println(resp.StatusCode())
    fmt.Println(resp.BodyStr())
    resp.DisposeHttpResponse()

    http.DisposeHttp()
    json.DisposeJsonObject()
    sbRequestBody.DisposeStringBuilder()

Curl Command

curl -X PUT
	-H "Authorization: Bearer <access_token>"
	-d '{
    "blueprint": [
        {
            "transition_id": "401308000003240197",
            "data": {
                "Phone": 8940372937,
                "Notes": "Updated via blueprint"
            }
        }
    ]
}'
https://domain.com/crm/v2.1/Leads/{{record_id}}/actions/blueprint

Postman Collection Item JSON

{
  "name": "Add Notes to a Record in 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\": \"401308000003240197\",\n            \"data\": {\n                \"Phone\": 8940372937,\n                \"Notes\": \"Updated via blueprint\"\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": [
  ]
}