Reorder Collection Folders

PATCH

/collections/{object_id}/relationships/folders

Request

Path Params

object_id

string

required

The primary key for each resource.

Example:

FID001

Body Params application/vnd.api+json

This is a resource linkage for a to-many relationship. It is like an array of Parse Pointers.

data

array [object {2}] | null

optional

string

required

The primary key for each resource.

Example:

FID001

type

enum<string>

required

Identifies the Resource.

Allowed value:

CollectionFolder

Examples:

_UserCollectionFolder

Example

{
    "data": [
        {
            "id": "FID001",
            "type": "CollectionFolder"
        }
    ]
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request PATCH 'https://api.synap.ac/v3/collections//relationships/folders' \
--header 'Content-Type: application/vnd.api+json' \
--data-raw '{
    "data": [
        {
            "id": "FID001",
            "type": "CollectionFolder"
        }
    ]
}'

Responses

🟢200OK

application/vnd.api+json

Success

Body

object {0}

Example

{}

🟢202Accepted

🟢204No Content

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found

Modified at 2025-07-08 10:51:21

Delete Collection

Reorder Collection Items