Folder - Updates the name and description of a folder

Updates the name and description of a folder in the specified tenant.

put

Authorizations

Bearer

HTTPRequired

Please enter a valid token

Path parameters

tenantIdstring · uuidRequired

The unique identifier of the tenant.

folderIdstring · uuidRequired

The unique identifier of the folder to update.

Query parameters

versionstringOptional

The requested API version

Default: 1.0

Header parameters

embedfast-user-idstringOptional

Optional User Id

Body

application/jsontext/jsonapplication/*+json

Represents a request to update folder name and description.

namestring · nullableOptional

The updated name of the folder.

descriptionstring · nullableOptional

The updated description of the folder.

Responses

200

OK: The folder name and description were successfully updated.

text/plainapplication/jsontext/json

Class for representing response.

messagestring · nullableOptional

A public property of type string that has both a getter and a setter method, which allows for getting and setting the value of the Message property.

Default: Success Message

statusCodeinteger · int32Optional

A public property of type integer that has both a getter and a setter method, which allows for getting and setting the value of the StatusCode property.

Default: 200

201

Created

text/plainapplication/jsontext/json

400

Bad Request: The request is invalid.

text/plainapplication/jsontext/json

401

Unauthorized: Access token is missing or invalid.

text/plainapplication/jsontext/json

403

Forbidden: Permission denied to update the folder.

text/plainapplication/jsontext/json

500

Internal Server Error: An unexpected error occurred or a server timeout.

text/plainapplication/jsontext/json

put

/tenants/{tenantId}/folders/{folderId}/updateFolderNameAndDescription

HTTPcURLJavaScriptPython

PUT /tenants/{tenantId}/folders/{folderId}/updateFolderNameAndDescription HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 36

{
  "name": "text",
  "description": "text"
}

application/jsontext/jsonapplication/*+json

{
  "message": "Success Message",
  "statusCode": 200
}