Folders

Create folder

post

Authorizations

XApiKey & XUserId

X-Api-KeystringRequired

HIVO API Key

X-User-IdstringRequired

HIVO User ID

Body

application/json

pathstringRequired

Folder path to create. Slashes in the path are treated as folder separators.

Example: Parent/New Folder/

collectionIdstringOptional

Optional collection ID for a collection-scoped folder.

colorstringOptional

Optional folder color. Must be one of the colors configured in the client folder settings.

Example: primary

permsstring[] · max: 64Optional

Optional upload permissions to apply to the folder. Each permission should follow the structure users/{user ID}:{permission} or groups/{group ID}:{permission}.

Available permissions are:

• get: can view
• share: can share
• update: can edit
• *: full access

Use GET /v1/users or GET /v1/groups to find user or group IDs.

Note: Adding a group to the permission list of a folder grants users in that group the corresponding permission to all Assets inside the folder. See https://support.hivo.co/library/folder-management-tools/folder-permissions.

Example: users/abc123abc123abc12:*

Responses

201

Created

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

429

Too Many Requests

application/json

500

Internal Server Error

application/json

post

/v1/folders

HTTPcURLJavaScriptPython

POST /api/rest/v1/folders HTTP/1.1
Host: app.hivo.com.au
X-Api-Key: YOUR_API_KEY
X-User-Id: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 107

{
  "path": "Parent/New Folder/",
  "collectionId": "text",
  "color": "primary",
  "perms": [
    "users/abc123abc123abc12:*"
  ]
}

{
  "meta": {
    "timestamp": 1,
    "authentication": "text",
    "links": {
      "me": "https://example.com"
    }
  },
  "links": {
    "self": "https://example.com",
    "thumbnail": {
      "href": "https://example.com",
      "meta": {
        "version": "text",
        "ANY_ADDITIONAL_PROPERTY": "anything"
      }
    },
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "data": {
    "type": "folders",
    "id": "text",
    "attributes": {
      "path": "text",
      "collectionId": "text",
      "clientId": "text",
      "color": "text",
      "perms": [
        "text"
      ],
      "action": "create",
      "modifiedCount": 1,
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "links": {
      "self": "https://example.com",
      "thumbnail": {
        "href": "https://example.com",
        "meta": {
          "version": "text",
          "ANY_ADDITIONAL_PROPERTY": "anything"
        }
      },
      "ANY_ADDITIONAL_PROPERTY": "anything"
    }
  }
}