API

Create a folder

post
https://api.safetyculture.io/directory/v1/folder
  • When creating a folder, a new UUID will be used unless a custom UUID is provided with the id parameter.
  • Site name must be between 1 and 250 characters long.
  • If a parent_id is not provided, the folder will be created as a top level folder with a Nil/Empty UUID id.
  • A metaLabel (Location, Area, Region, State, Country) is required. Once created, the metaLabal cannot be modified. The metaLabel dictates where folders can be moved to, and whether Inspections can be conducted/associated with this folder.
Body Params

The parameters for CreateFolderRequest

The parameters for CreateFolderRequest

string
required

Required. Non-empty folder name. Limited to maximum 250 characters.

string

Optional. Parent folder UUID. If unspecified, will be created as a root
folder

string

Optional. Folder UUID. If unspecified, backend will generate the ID.

string
required

Required. Must be one of: "location", "area", "region", "state", or "country".
Note that these meta labels may not match custom site hierarchy labels used by the organization.

string

domain represents the type/domain/hierarchy for the folder. This is used
for getting folders of a certain domain, i.e. getting all template
folders or site folders

Responses

Updated about 2 months ago

Did this page help you?
Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 2 months ago

Did this page help you?