Organization
Folder

Create folder in organization

Changed on

Create a new folder in the organization library.

post/v1/organizations/{organizationRef}/folders

Request

  • Base URL: https://example.com/api
  • URL: https://example.com/api/v1/organizations/{organizationRef}/folders
  • Auth: OAuth 2 (authorization code, authorization URL /oauth/authorize, token URL /oauth/token; client credentials, token URL /oauth/token; password, token URL /oauth/token, scopes: organization, document)

Request body

namestring required

Name of the folder.

parent_idstring nullable

Parent folder ID. Omit to create at the library root.

Example request

{
  "name": "Guides",
  "parent_id": "9bsv0s46s6s002p9ltq0"
}

Response

Created

idstring required

Unique identifier of the folder.

namestring required

Name of the folder.

created_atstring date-time required

Date when the folder was created.

updated_atstring date-time nullable required

Date when the folder was updated.

Example response

{
  "id": "9bsv0s46s6s002p9ltq0",
  "name": "Guides",
  "library": {
    "id": "9bsv0s46s6s002p9ltq0",
    "name": "Product"
  },
  "parent": {
    "id": "9bsv0s46s6s002p9ltq0",
    "name": "Guides",
    "parent_id": "9bsv0s46s6s002p9ltq0"
  },
  "created_by": {
    "id": "9bsv0s46s6s002p9ltq0",
    "first_name": "Test",
    "last_name": "User",
    "picture": "https://example.com/users/my-user.png"
  }
}

Changes

  • 8a34c0b5508eRevision changes
    • info

      added the non-success response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status