Skip to main content

Create a Folder

Description

Use a HTTP POST request to create a folder.

Request

HTTP Method: POST

Query ParameterDescription
nameThe folder name.
content_typeThe type of content stored in this folder CREDENTIAL RESOURCE or STORY
team_idID of team to which the folder should be created.

Sample request

curl -X POST \
https://<tenant-domain>/api/v1/folders/ \
-H 'content-type: application/json' \
-H 'x-user-email: <email-address>' \
-H 'x-user-token: <api-token>'
-d '{
"name": "Folder name",
"content_type": "CREDENTIAL",
"team_id": 1
}'

Response

A successful request will return a JSON object describing the created folder

Field description

ParameterDescription
idThe folder ID.
nameThe folder name.
team_idID of team to which the folder belongs.
content_typeThe type of content stored in this folder
sizeThe number of items in this folder

Sample response

{
"id": 1,
"name": "Folder name",
"content_type": "CREDENTIAL",
"team_id": 1,
"size": 0
}