Create a new public folder

POST

/domains/{domainID}/folders

curl --request POST \
  --url https://example.com/api/v1/domains/1/folders \
  --header 'Content-Type: application/json' \
  --cookie grommunioAuthJwt=<grommunioAuthJwt> \
  --data '{ "displayname": "example", "container": "IPF.Note", "comment": "example", "parentID": "0", "syncToMobile": true }'

• Default deployment path

Authorizations

• JWTCookie

Parameters

Path Parameters

domainID

required

integer

ID of the domain

Header Parameters

X-Csrf-Token

string

CSRF Token

Request Body

Media typeapplication/json

object

displayname

required

Name of the folder

string

container

required

Container class

string

Allowed values: IPF.Note IPF.Contact IPF.Appointment IPF.Stickynote IPF.Task

comment

required

string

parentID

ID of the parent folder

string

default: 0

syncToMobile

boolean

Responses

201

Folder creation successful

Media typeapplication/json

object

folderid

string

displayname

string

comment

string

creationtime

Date string with time

string

nullable /^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$/

container

string

syncToMobile

boolean

Example^generated

{
  "folderid": "example",
  "displayname": "example",
  "comment": "example",
  "creationtime": "example",
  "container": "example",
  "syncToMobile": true
}

400

Validation of input parameters failed

Media typeapplication/json

object

message

string

errors

List of errors encountered during validation

Array<string>

Example^generated

{
  "message": "example",
  "errors": [
    "example"
  ]
}

404

The requested resource could not be found

Media typeapplication/json

object

message

string

Example^generated

{
  "message": "example"
}

500

An error occurred while processing the request

Media typeapplication/json

object

message

String representation of the exception

string

Example^generated

{
  "message": "example"
}

503

The database query failed

Media typeapplication/json

object

message

Description of the error

string

Example^generated

{
  "message": "example"
}