Chilkat Online Tools

Node.js / Zoho CRM REST APIs / Upload Attachments to the Blueprint

Back to Collection Items

var os = require('os');
if (os.platform() == 'win32') {  
    if (os.arch() == 'ia32') {
        var chilkat = require('@chilkat/ck-node21-win-ia32');
    } else {
        var chilkat = require('@chilkat/ck-node21-win64'); 
    }
} else if (os.platform() == 'linux') {
    if (os.arch() == 'arm') {
        var chilkat = require('@chilkat/ck-node21-arm');
    } else if (os.arch() == 'x86') {
        var chilkat = require('@chilkat/ck-node21-linux32');
    } else {
        var chilkat = require('@chilkat/ck-node21-linux64');
    }
} else if (os.platform() == 'darwin') {
    if (os.arch() == 'arm64') {
        var chilkat = require('@chilkat/ck-node21-mac-m1');
    } else {
        var chilkat = require('@chilkat/ck-node21-macosx');
    }
}


function chilkatExample() {

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

    var http = new chilkat.Http();
    var success;

    // 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": "1000000031897",
    //       "data": {
    //         "Attachments": {
    //           "$file_id": [
    //             "59cf260313b6907ffc56957f4241bd94ba3e0b6aad53b50f8b38583a859d623a",
    //             "59cf260313b6907ffc56957f4241bd94ba3e0b6aad53b50f8b38583a859d624d"
    //           ]
    //         }
    //       }
    //     }
    //   ]
    // }

    var json = new chilkat.JsonObject();
    json.UpdateString("blueprint[0].transition_id","1000000031897");
    json.UpdateString("blueprint[0].data.Attachments.$file_id[0]","59cf260313b6907ffc56957f4241bd94ba3e0b6aad53b50f8b38583a859d623a");
    json.UpdateString("blueprint[0].data.Attachments.$file_id[1]","59cf260313b6907ffc56957f4241bd94ba3e0b6aad53b50f8b38583a859d624d");

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

    var sbRequestBody = new chilkat.StringBuilder();
    json.EmitSb(sbRequestBody);

    // resp: HttpResponse
    var 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) {
        console.log(http.LastErrorText);
        return;
    }

    console.log(resp.StatusCode);
    console.log(resp.BodyStr);


}

chilkatExample();

Curl Command

curl -X PUT
	-H "Authorization: Bearer <access_token>"
	-d '{
    "blueprint": [
       {
            "transition_id": "1000000031897",
            "data": {
                "Attachments": {
                    "$file_id": [
                        "59cf260313b6907ffc56957f4241bd94ba3e0b6aad53b50f8b38583a859d623a",
                        "59cf260313b6907ffc56957f4241bd94ba3e0b6aad53b50f8b38583a859d624d"
                    ]
                }
            }
        }
    ]
}'
https://domain.com/crm/v2.1/Leads/{{record_id}}/actions/blueprint

Postman Collection Item JSON

{
  "name": "Upload Attachments to the Blueprint",
  "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\": \"1000000031897\",\n            \"data\": {\n                \"Attachments\": {\n                    \"$file_id\": [\n                        \"59cf260313b6907ffc56957f4241bd94ba3e0b6aad53b50f8b38583a859d623a\",\n                        \"59cf260313b6907ffc56957f4241bd94ba3e0b6aad53b50f8b38583a859d624d\"\n                    ]\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": [
  ]
}