Rename a Folder

Renames an existing folder.

Note: For more information about this command, including descriptions of any path and request parameters, request body schema, response codes and schemas, and payload examples, refer to the online API reference for this command at the following web page:

Rename a folder

URI

https://bartendercloud.com/api/librarian/folders/{folderId}/rename

Note: The bartendercloud.com domain that is referenced in the URI and in the code example that follows must be replaced with the contents of the DataCenterURI claim that is extracted from your access token. For more information, refer to Extracting the DataCenterURI Claim.

Path Parameters

folderId

Type: String

Specifies the ID of the folder. Required.

Query Parameters

None.

Example

  • C#

Request body: See FolderRenameRequest.

Response: See Folder.

Copy 
// Assume that folderId is the ID of the folder that will be renamed.
var client = new HttpClient();
client.DefaultRequestHeaders.Add("Authorization", $"Bearer {accessToken}");

var renameRequest = new FolderRenameRequest() {
    Name = "Label Designs 2"
};

HttpRequestMessage request = new HttpRequestMessage
{
   RequestUri = new Uri($"https://bartendercloud.com/api/librarian/folders/{folderId}/rename"),
   Content = new StringContent(JsonConvert.SerializeObject(renameRequest), Encoding.UTF8, "application/json"),
   Method = HttpMethod.Post
};

HttpResponseMessage msg = await client.SendAsync(request);

if (msg.IsSuccessStatusCode)
{
    return JsonConvert.DeserializeObject<Folder>(await msg.Content.ReadAsStringAsync());
}