Skip to main content

Deleting Profile Folder

Description: This method is used for deleting a profile folder. The profileFolderId value must match the existing folder in the specified workspace.

Request parameters:

ParameterTypeFormatDefaultDescription
profileFolderIdstringuuidUnique identifier of the profile folder to delete.
workspaceIdintegerint64-1The identifier of the workspace associated with the profile folder. Defaults to -1 if not specified.
note

The ID of the profile folder to delete should be specified inside curly braces { } in the URL path.

Example request:

DELETE
CURL:

curl 'http://localhost:8160/v1/profile_folders/{profileFolderId}?workspaceId=-1' \
--request DELETE \
--header 'Api-Token: YOUR_SECRET_TOKEN'

C#:

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Delete,
RequestUri = new Uri("http://localhost:8160/v1/profile_folders/%7BprofileFolderId%7D"),
Headers =
{
{ "Api-Token", "YOUR_SECRET_TOKEN" },
},
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}

Cube:

http://localhost:8160/v1/profile_folders/{profileFolderId}?workspaceId=-1

Additionally:
User-Agent: {-Profile.UserAgent-}
Api-Token: Token from UserArea2.

Response API:

Response codeResult
200 OKSuccess
500 ErrorInternal Server Error

Success Response (200 OK):

No content returned on successful deletion.

Error Response (500):

{
"message": null
}