Create a new folder

POST

https://api.synup.com/api/v4/folders/create

This API creates a new folder to help organize locations within an account. The folder name must be unique across the account.

If a parent folder ID (parentFolder) or parent folder name (parentFolderName) is not provided, the folder will be created under the root folder.

Folders support a hierarchical structure, allowing subfolders to be organized within parent folders.

Request

Header Params

Body Params application/json

Example

{
    "input": {
        "name": "franchise",
        "parentFolderName": "all_franchise"
    }
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.synup.com/api/v4/folders/create' \
--header 'Authorization: API T9V35W3xxxxxxxxxxx' \
--header 'Content-Type: application/json' \
--data-raw '{
    "input": {
        "name": "franchise",
        "parentFolderName": "all_franchise"
    }
}'

Responses

🟢200OK

application/json

Folder created successfully

Body

Examples

Successful creationName already taken

{
    "data": {
        "createFolder": {
            "clientMutationId": null,
            "errors": null,
            "folder": {
                "accountId": 11073,
                "archived": false,
                "createdAt": "2024-04-03 10:29:49 UTC",
                "id": "d6cc61b3-6da7-4b64-a7c0-340c0df25f4c",
                "locationCount": null,
                "name": "franchise",
                "root": false
            },
            "success": true
        }
    }
}

Modified at 2025-05-26 13:01:39

Organizing locations

List all folders