Sign in

v7

latestOpenAPI 3.0.4raw.githubusercontent.com2026-08-033267145.4 KB
Folder

Create a new folder in your workspace by providing a human-readable name in the request body. Use this to organize your profiles effectively.

post/folders/new

Request body

namestring required

Human readable name of the new folder.

Example request

{
  "name": "My first folder"
}

Response

OK.

idstring uuid required

A unique identifier of the folder.

namestring required

The name of the folder.

lastModifiedAtstring date-time required

Timestamp of the last modification.

lastModifiedBystring required

Name of the user who last modified the folder.

createdAtstring date-time required

Timestamp of the creation.

createdBystring required

Name of the user who created the folder.

Example response

{
  "id": "a7cafbbe-6bc0-4575-8c6e-f1adf391f180",
  "name": "mystic-turtle",
  "lastModifiedAt": "2020-05-02T03:10:32.2452701+10:00",
  "lastModifiedBy": "Demo user",
  "createdAt": "2020-05-02T03:10:32.2452701+10:00",
  "createdBy": "Demo user",
  "profiles": [
    {
      "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"
    }
  ]
}