v1

latestOpenAPI 3.1.02026-07-263911,4691.1 MB

Directory (Sites)

Create a folder

post/directory/v1/folder

Request body

namestring required

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

parent_idstring

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

idstring

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

meta_labelstring 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.

domainstring

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

Response

A successful response.

Example response

{
  "folder": {
    "id": "4fb56fa8-fa23-4a9c-907e-8367abc75a2f",
    "name": "Sydney",
    "org_id": "d31e24be-e7a4-4a28-a230-044f850041fc",
    "creator_id": "a3452937-9fa7-4ba2-9ffa-c3bbee3fc947",
    "created_at": "2020-04-28T04:14:31:00Z",
    "modified_at": "2020-04-28T04:14:31:00Z",
    "meta_label": "location"
  }
}