v6

OpenAPI 3.0.4raw.githubusercontent.com2026-07-1500143.2 KB

Folder

Deletes a folder along with all its subfolders. Profiles within the folder will either be deleted or moved to the top-level based on the query parameters.

delete/folders/{guid}

Path parameters

guidstring uuid required

The unique identifier of the folder.

Query parameters

includeProfilesboolean

Flag to indicate if the contained profiles should be deleted (true) or moved to the top-level (false).

Response

OK.

deletedFoldersstring[] required

Ids of the deleted folders.

deletedProfilesstring[] required

Ids of the deleted profiles.

Example response

{
  "movedProfiles": [
    {
      "id": "a7cafbbe-6bc0-4575-8c6e-f1adf391f180",
      "name": "mystic-turtle",
      "tags": [
        "facebook",
        "instagram"
      ],
      "proxy": {
        "extra": {
          "host": "127.0.0.1",
          "port": 9951,
          "id": "username",
          "secret": "password"
        }
      },
      "createdAt": "2020-05-02T03:10:32.2452701+10:00",
      "device": {
        "type": "desktop",
        "name": "Samsung SM-A705FN"
      },
      "os": {
        "family": "windows",
        "version": "10.15.4",
        "platform": "64"
      },
      "browser": {
        "product": "chrome",
        "major": 81,
        "version": "81.0.4044"
      },
      "language": "en-US,en",
      "folderId": "c7aafbbe-b6c0-5475-c66e-1fadf39180f1"
    }
  ]
}