Update folder

POST

/folder/update

curl --request POST \
  --url https://app.legaldoc.com/api/v2/folder/update \
  --header 'Authorization: <Authorization>' \
  --header 'Content-Type: application/json' \
  --data '{ "folderId": "example", "data": { "name": "example", "parentId": "example", "visibility": "EVERYONE", "pinned": true } }'

Updates an existing folder

Authorizations

• apiKey

Request Body^required

Media typeapplication/json

object

folderId

required

string

data

required

object

name

string

>= 2 characters <= 100 characters

parentId

string | null

visibility

string

Allowed values: EVERYONE MANAGER_AND_ABOVE ADMIN

pinned

boolean

Responses

200

Successful response

Media typeapplication/json

object

id

required

string

name

required

string

userId

required

number

teamId

required

number

parentId

required

string | null

pinned

required

boolean

createdAt

required

string

updatedAt

required

string

visibility

required

string

Allowed values: EVERYONE MANAGER_AND_ABOVE ADMIN

type

required

string

Allowed values: DOCUMENT TEMPLATE

Example

{
  "visibility": "EVERYONE",
  "type": "DOCUMENT"
}

400

Invalid input data

Media typeapplication/json

object

message

required

string

code

required

string

issues

Array<object>

object

message

required

string

Example^generated

{
  "message": "example",
  "code": "example",
  "issues": [
    {
      "message": "example"
    }
  ]
}

401

Authorization not provided

Media typeapplication/json

object

message

required

string

code

required

string

issues

Array<object>

object

message

required

string

Example^generated

{
  "message": "example",
  "code": "example",
  "issues": [
    {
      "message": "example"
    }
  ]
}

403

Insufficient access

Media typeapplication/json

object

message

required

string

code

required

string

issues

Array<object>

object

message

required

string

Example^generated

{
  "message": "example",
  "code": "example",
  "issues": [
    {
      "message": "example"
    }
  ]
}

500

Internal server error

Media typeapplication/json

object

message

required

string

code

required

string

issues

Array<object>

object

message

required

string

Example^generated

{
  "message": "example",
  "code": "example",
  "issues": [
    {
      "message": "example"
    }
  ]
}