Delete a folder

POST

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

This API deletes a specified folder from the account. This action is irreversible.

Behavior:

Any locations within the folder will be unassigned but not archived.

Once deleted, the folder cannot be restored.

Request

Header Params

Body Params application/json

Example

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

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

Responses

🟢200OK

application/json

Folder successfully deleted

Body

Example

{
    "data": {
        "deleteFolder": {
            "errors": null,
            "success": true
        }
    }
}

🟠400Bad Request

🟠403Forbidden

🟠404Record Not Found

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

Remove locations from a folder

List locations under a folder