Node.js Box: Create Folder

Back to Index

Creates a new folder. To create a folder in the root folder, use a parent folder id = "0".

Documentation: https://developer.box.com/reference#create-a-new-folder

CURL Command

curl https://api.box.com/2.0/folders \
-H "Authorization: Bearer BOX_ACCESS_TOKEN" \
-d '{"name":"Important Docs", "parent": {"id": "BOX_FOLDER_ID"}}' \
-X POST

Node.js Example

var os = require('os');
if (os.platform() == 'win32') {  
    var chilkat = require('chilkat_node6_win32'); 
} else if (os.platform() == 'linux') {
    if (os.arch() == 'arm') {
        var chilkat = require('chilkat_node6_arm');
    } else if (os.arch() == 'x86') {
        var chilkat = require('chilkat_node6_linux32');
    } else {
        var chilkat = require('chilkat_node6_linux64');
    }
} else if (os.platform() == 'darwin') {
    var chilkat = require('chilkat_node6_macosx');
}

function chilkatExample() {

    var rest = new chilkat.Rest();
    var success;

    //  URL: https://api.box.com/2.0/folders
    var bTls = true;
    var port = 443;
    var bAutoReconnect = true;
    success = rest.Connect("api.box.com",port,bTls,bAutoReconnect);
    if (success !== true) {
        console.log("ConnectFailReason: " + rest.ConnectFailReason);
        console.log(rest.LastErrorText);
        return;
    }

    var json = new chilkat.JsonObject();
    json.UpdateString("name","Important Docs");
    json.UpdateString("parent.id","BOX_FOLDER_ID");

    rest.AddHeader("Authorization","Bearer BOX_ACCESS_TOKEN");

    var sbRequestBody = new chilkat.StringBuilder();
    json.EmitSb(sbRequestBody);
    var sbResponseBody = new chilkat.StringBuilder();
    success = rest.FullRequestSb("POST","/2.0/folders",sbRequestBody,sbResponseBody);
    if (success !== true) {
        console.log(rest.LastErrorText);
        return;
    }

    var jsonResponse = new chilkat.JsonObject();
    jsonResponse.LoadSb(sbResponseBody);

    var type;
    var id;
    var sequence_id;
    var etag;
    var name;
    var created_at;
    var modified_at;
    var description;
    var size;
    var path_collectionTotal_count;
    var created_byType;
    var created_byId;
    var created_byName;
    var created_byLogin;
    var modified_byType;
    var modified_byId;
    var modified_byName;
    var modified_byLogin;
    var trashed_at;
    var purged_at;
    var content_created_at;
    var content_modified_at;
    var owned_byType;
    var owned_byId;
    var owned_byName;
    var owned_byLogin;
    var shared_link;
    var folder_upload_email;
    var parentType;
    var parentId;
    var parentSequence_id;
    var parentEtag;
    var parentName;
    var item_status;
    var item_collectionTotal_count;
    var item_collectionOffset;
    var item_collectionLimit;
    var i;
    var count_i;
    var sequence_id_bool;
    var etag_bool;
    var by;
    var direction;

    type = jsonResponse.StringOf("type");
    id = jsonResponse.StringOf("id");
    sequence_id = jsonResponse.StringOf("sequence_id");
    etag = jsonResponse.StringOf("etag");
    name = jsonResponse.StringOf("name");
    created_at = jsonResponse.StringOf("created_at");
    modified_at = jsonResponse.StringOf("modified_at");
    description = jsonResponse.StringOf("description");
    size = jsonResponse.IntOf("size");
    path_collectionTotal_count = jsonResponse.IntOf("path_collection.total_count");
    created_byType = jsonResponse.StringOf("created_by.type");
    created_byId = jsonResponse.StringOf("created_by.id");
    created_byName = jsonResponse.StringOf("created_by.name");
    created_byLogin = jsonResponse.StringOf("created_by.login");
    modified_byType = jsonResponse.StringOf("modified_by.type");
    modified_byId = jsonResponse.StringOf("modified_by.id");
    modified_byName = jsonResponse.StringOf("modified_by.name");
    modified_byLogin = jsonResponse.StringOf("modified_by.login");
    trashed_at = jsonResponse.IsNullOf("trashed_at");
    purged_at = jsonResponse.IsNullOf("purged_at");
    content_created_at = jsonResponse.StringOf("content_created_at");
    content_modified_at = jsonResponse.StringOf("content_modified_at");
    owned_byType = jsonResponse.StringOf("owned_by.type");
    owned_byId = jsonResponse.StringOf("owned_by.id");
    owned_byName = jsonResponse.StringOf("owned_by.name");
    owned_byLogin = jsonResponse.StringOf("owned_by.login");
    shared_link = jsonResponse.IsNullOf("shared_link");
    folder_upload_email = jsonResponse.IsNullOf("folder_upload_email");
    parentType = jsonResponse.StringOf("parent.type");
    parentId = jsonResponse.StringOf("parent.id");
    parentSequence_id = jsonResponse.IsNullOf("parent.sequence_id");
    parentEtag = jsonResponse.IsNullOf("parent.etag");
    parentName = jsonResponse.StringOf("parent.name");
    item_status = jsonResponse.StringOf("item_status");
    item_collectionTotal_count = jsonResponse.IntOf("item_collection.total_count");
    item_collectionOffset = jsonResponse.IntOf("item_collection.offset");
    item_collectionLimit = jsonResponse.IntOf("item_collection.limit");
    i = 0;
    count_i = jsonResponse.SizeOfArray("path_collection.entries");
    while (i < count_i) {
        jsonResponse.I = i;
        type = jsonResponse.StringOf("path_collection.entries[i].type");
        id = jsonResponse.StringOf("path_collection.entries[i].id");
        sequence_id_bool = jsonResponse.IsNullOf("path_collection.entries[i].sequence_id");
        etag_bool = jsonResponse.IsNullOf("path_collection.entries[i].etag");
        name = jsonResponse.StringOf("path_collection.entries[i].name");
        i = i+1;
    }

    i = 0;
    count_i = jsonResponse.SizeOfArray("item_collection.entries");
    while (i < count_i) {
        jsonResponse.I = i;
        i = i+1;
    }

    i = 0;
    count_i = jsonResponse.SizeOfArray("item_collection.order");
    while (i < count_i) {
        jsonResponse.I = i;
        by = jsonResponse.StringOf("item_collection.order[i].by");
        direction = jsonResponse.StringOf("item_collection.order[i].direction");
        i = i+1;
    }


}

chilkatExample();

Sample JSON Response Body

{
  "type": "folder",
  "id": "47885473705",
  "sequence_id": "0",
  "etag": "0",
  "name": "Important Docs",
  "created_at": "2018-03-16T06:54:57-07:00",
  "modified_at": "2018-03-16T06:54:57-07:00",
  "description": "",
  "size": 0,
  "path_collection": {
    "total_count": 1,
    "entries": [
      {
        "type": "folder",
        "id": "0",
        "sequence_id": null,
        "etag": null,
        "name": "All Files"
      }
    ]
  },
  "created_by": {
    "type": "user",
    "id": "2787704945",
    "name": "chilkat",
    "login": "AutomationUser_434741_3nmGYSS7o5@@boxdevedition.com"
  },
  "modified_by": {
    "type": "user",
    "id": "2787704945",
    "name": "chilkat",
    "login": "AutomationUser_434741_3nmGYSS7o5@@boxdevedition.com"
  },
  "trashed_at": null,
  "purged_at": null,
  "content_created_at": "2018-03-16T06:54:57-07:00",
  "content_modified_at": "2018-03-16T06:54:57-07:00",
  "owned_by": {
    "type": "user",
    "id": "2787704945",
    "name": "chilkat",
    "login": "AutomationUser_434741_3nmGYSS7o5@@boxdevedition.com"
  },
  "shared_link": null,
  "folder_upload_email": null,
  "parent": {
    "type": "folder",
    "id": "0",
    "sequence_id": null,
    "etag": null,
    "name": "All Files"
  },
  "item_status": "active",
  "item_collection": {
    "total_count": 0,
    "entries": [
    ],
    "offset": 0,
    "limit": 100,
    "order": [
      {
        "by": "type",
        "direction": "ASC"
      },
      {
        "by": "name",
        "direction": "ASC"
      }
    ]
  }
}