API ReferenceFolder Actions

Create an Object Folder

Create a new object folder. This folder will appear in your organization's library.

Headers

x-api-keystringRequired
Your organization's active API Key.

Request

This endpoint expects an object.
namestringRequired
A descriptive title for the object folder you'd like to create.
organization_idstringRequiredformat: "uuid"
Your organization's unique identifier.
created_bystringOptional
The email of the user creating the folder. If this parameter is left empty, the value will default to 'API'.

Response

201 - Folder creation successful

detection_item_collection_mapobject or null
A summary of how many objects in the folder returned are collected or uncollected.
idstring or nullformat: "uuid"
The folder id of the newly created folder within your organization's library.
namestring or null
The folder name of the nrely created folder within your organization's library.
organization_idstring or nullformat: "uuid"
Your organization's unique identifier.
created_atdatetime or null
The date and time at which this folder was originally created within your organization's library.
updated_atdatetime or null
The date and time at which this folder was last updated within your organization's library.
deleted_atdatetime or null
The date and time at which this folder was deleted within your organization's library. This value will always be null for newly created folders.
created_bystring or null
The email of the user that originally created this folder within your organization's library. If this parameter is left empty, the value will default to 'API'.

Errors