Remove Folders for User

POST

https://api.synup.com/api/v4/users/folders/remove

This API removes specific locations associated with a user, revoking their access to those locations.

Behavior:

Supports removing one or multiple locations from a user.

Updates the user’s permissions and access scope accordingly.

Request

Header Params

Body Params application/json

Example

{
    "input": {
        "userId": "VXNlcjoxMDAyOA==",
        "folderIds": [
            "c1d92c09-8ddd-469e-af96-0eb64a48d647",
            "a5af4f5d-41b6-4a8a-b24f-98741b021b7b"
        ]
    }
}

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/users/folders/remove' \
--header 'Authorization: API T9V35W3xxxxxxxxxxx' \
--header 'Content-Type: application/json' \
--data-raw '{
    "input": {
        "userId": "VXNlcjoxMDAyOA==",
        "folderIds": [
            "c1d92c09-8ddd-469e-af96-0eb64a48d647",
            "a5af4f5d-41b6-4a8a-b24f-98741b021b7b"
        ]
    }
}'

Responses

🟢200OK

application/json

Successfully removed folders for user

Body

Examples

defaultalternative

{
    "data": {
        "removeFoldersForUser": {
            "status": [
                {
                    "errors": null,
                    "folderId": "c1d92c09-8ddd-469e-af96-0eb64a48d647",
                    "success": true
                },
                {
                    "errors": null,
                    "folderId": "a5af4f5d-41b6-4a8a-b24f-98741b021b7b",
                    "success": true
                }
            ]
        }
    }
}

Modified at 2025-07-21 09:51:44

Update a User

Remove Locations for User