Add folder share

POST 
/shares/folders/:indexKey

Creates a new folder share; available as an Add-On Module

Request

Path Parameters

indexKey stringrequired

Index Key Identifier

Query Parameters

siteId string

Site Identifier

application/json

Body

required

share

object

group string

Share with Group

permissions UserSharePermission (string)[]

List of share permissions

Possible values: [READ, WRITE, DELETE]

Responses

201

201 CREATED

Response Headers

• Access-Control-Allow-Origin

  string

• Access-Control-Allow-Methods

  string

• Access-Control-Allow-Headers

  string

application/json

Schema

Schema

message string

API Response message

shareKey string

Share Identifier

Example (from schema)

{
  "message": "string",
  "shareKey": "string"
}

400

400 OK

application/json

Schema

Schema

errors

object[]

List of errors

Array [

key string

Error Key

error string

Error Message

]

Example (from schema)

{
  "errors": [
    {
      "key": "string",
      "error": "string"
    }
  ]
}

Loading...