Update public folder

PATCH

/domains/{domainID}/folders/{folderID}

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

• Default deployment path

Authorizations

• JWTCookie

Parameters

Path Parameters

domainID

required

integer

ID of the domain

folderID

required

integer

ID of the folder

Header Parameters

X-Csrf-Token

string

CSRF Token

Request Body

Media typeapplication/json

object

displayname

Name of the folder

string

container

Container class

string

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

comment

string

syncToMobile

boolean

Responses

200

Folder update successful

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"
}