Rename a folder

POST

https://api.synup.com/api/v4/locations/folders/rename

This API updates the name of an existing folder to a new name.

Important Notes:

The new folder name must be unique within your account.

Root folders cannot be renamed.

The folder being renamed must exist in your account.

Special characters in the new name will be converted to underscores (_).

Request

Header Params

Body Params application/json

Example

{
    "input": {
        "name": "Acme New",
        "oldName": "Acme"
    }
}

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/locations/folders/rename' \
--header 'Authorization: T9V35W3xxxxxxxxxxx' \
--header 'Content-Type: application/json' \
--data-raw '{
    "input": {
        "name": "Acme New",
        "oldName": "Acme"
    }
}'

Responses

🟢200OK

application/json

Successfully renamed the folder

Body

Example

{
    "data": {
        "renameFolder": {
            "clientMutationId": null,
            "errors": null,
            "folder": {
                "accountId": 16154,
                "archived": false,
                "createdAt": "2025-02-02 15:27:00 UTC",
                "id": "098ba54d-3659-46fa-9c17-4af4329ce421",
                "locationCount": null,
                "name": "2feb2025855pm_2",
                "root": false
            },
            "success": true
        }
    }
}

🟠400Bad Request

🟠404Record Not Found

🟠409409

Modified at 2025-05-26 13:02:03

Get details of a folder

Add locations to a folder