Skip to main content
POST
/
v1
/
folders
Create folder
curl --request POST \
  --url https://{instance}.omniapp.co/api/v1/folders \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "scope": "organization",
  "parentFolderId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "path": "<string>",
  "scope": "organization",
  "owner": {},
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization
string
header
required

Use either an Organization API Key or Personal Access Token (PAT). Include in the Authorization header as: Bearer YOUR_TOKEN

Body

application/json
name
string
required

Folder name

scope
enum<string>
required

Folder scope

Available options:
organization,
restricted
parentFolderId
string<uuid>

Parent folder ID

Response

Folder created successfully

id
string<uuid>
name
string
path
string
scope
enum<string>
Available options:
organization,
restricted
owner
object
createdAt
string<date-time>
updatedAt
string<date-time>