Update CollectionFolder

PATCH

/collection-folders/{object_id}

Request

Path Params

Body Params application/vnd.api+json

Example

{
    "data": {
        "id": "FID001",
        "type": "CollectionFolder",
        "attributes": {
            "name": "string"
        },
        "relationships": {
            "collection": {
                "data": {
                    "id": "FID001",
                    "type": "Collection"
                }
            },
            "coverImage": {
                "data": {
                    "id": "FID001",
                    "type": "File"
                }
            },
            "items": {
                "data": [
                    {
                        "id": "FID001",
                        "type": "CollectionSubFolder"
                    }
                ]
            }
        }
    }
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request PATCH 'https://api.synap.ac/v3/collection-folders/' \
--header 'Content-Type: application/vnd.api+json' \
--data-raw '{
    "data": {
        "id": "FID001",
        "type": "CollectionFolder",
        "attributes": {
            "name": "string"
        },
        "relationships": {
            "collection": {
                "data": {
                    "id": "FID001",
                    "type": "Collection"
                }
            },
            "coverImage": {
                "data": {
                    "id": "FID001",
                    "type": "File"
                }
            },
            "items": {
                "data": [
                    {
                        "id": "FID001",
                        "type": "CollectionSubFolder"
                    }
                ]
            }
        }
    }
}'

Responses

🟢200OK

application/vnd.api+json

Success

Body

Example

{
    "data": {
        "id": "FID001",
        "type": "CollectionFolder",
        "attributes": {
            "name": "string"
        },
        "relationships": {
            "collection": {
                "data": {
                    "id": "FID001",
                    "type": "Collection"
                }
            },
            "coverImage": {
                "data": {
                    "id": "FID001",
                    "type": "File"
                }
            },
            "items": {
                "data": [
                    {
                        "id": "FID001",
                        "type": "CollectionSubFolder"
                    }
                ]
            }
        }
    }
}

🟢204No Content

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found

Modified at 2025-09-15 09:58:55

Get CollectionFolder

Delete CollectionFolder