Update CollectionItemEmbed

PATCH

/collection-item-embed/{object_id}

Collections

Request

Path Params

object_id

string

required

The primary key for each resource.

Example:

FID001

Body Params application/vnd.api+json

data

object (CollectionItemEmbed)

required

string

required

The primary key for each resource.

Example:

FID001

type

enum<string>

required

Identifies the Resource.

Allowed value:

CollectionItemEmbed

Example:

CollectionItemEmbed

attributes

object

optional

relationships

object

optional

Example

{
    "data": {
        "id": "FID001",
        "type": "CollectionItemEmbed",
        "attributes": {
            "title": "string",
            "description": "string",
            "shortDescription": "string",
            "customLabel": "string",
            "isPreviewOnly": true,
            "releaseStatus": "available",
            "studyEnabled": true,
            "attr": {}
        },
        "relationships": {
            "folder": {
                "data": {
                    "id": "FID001",
                    "type": "CollectionFolder"
                }
            },
            "subFolder": {
                "data": {
                    "id": "FID001",
                    "type": "CollectionSubFolder"
                }
            },
            "coverImage": {
                "data": {
                    "id": "FID001",
                    "type": "File"
                }
            },
            "embed": {
                "data": {
                    "id": "FID001",
                    "type": "Content"
                }
            }
        }
    }
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request PATCH 'https://api.synap.ac/v3/collection-item-embed/' \
--header 'Content-Type: application/vnd.api+json' \
--data-raw '{
    "data": {
        "id": "FID001",
        "type": "CollectionItemEmbed",
        "attributes": {
            "title": "string",
            "description": "string",
            "shortDescription": "string",
            "customLabel": "string",
            "isPreviewOnly": true,
            "releaseStatus": "available",
            "studyEnabled": true,
            "attr": {}
        },
        "relationships": {
            "folder": {
                "data": {
                    "id": "FID001",
                    "type": "CollectionFolder"
                }
            },
            "subFolder": {
                "data": {
                    "id": "FID001",
                    "type": "CollectionSubFolder"
                }
            },
            "coverImage": {
                "data": {
                    "id": "FID001",
                    "type": "File"
                }
            },
            "embed": {
                "data": {
                    "id": "FID001",
                    "type": "Content"
                }
            }
        }
    }
}'

Responses

🟢200OK

application/vnd.api+json

Success

Body

data

object (CollectionItemEmbed)

optional

string

required

The primary key for each resource.

Example:

FID001

type

enum<string>

required

Identifies the Resource.

Allowed value:

CollectionItemEmbed

Example:

CollectionItemEmbed

attributes

object

optional

relationships

object

optional

Example

{
    "data": {
        "id": "FID001",
        "type": "CollectionItemEmbed",
        "attributes": {
            "title": "string",
            "description": "string",
            "shortDescription": "string",
            "customLabel": "string",
            "type": "embed",
            "isPreviewOnly": true,
            "releaseStatus": "available",
            "studyEnabled": true,
            "attr": {}
        },
        "relationships": {
            "collection": {
                "data": {
                    "id": "FID001",
                    "type": "Collection"
                }
            },
            "folder": {
                "data": {
                    "id": "FID001",
                    "type": "CollectionFolder"
                }
            },
            "subFolder": {
                "data": {
                    "id": "FID001",
                    "type": "CollectionSubFolder"
                }
            },
            "coverImage": {
                "data": {
                    "id": "FID001",
                    "type": "File"
                }
            },
            "embed": {
                "data": {
                    "id": "FID001",
                    "type": "Content"
                }
            }
        }
    }
}

🟢204No Content

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found

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

Get CollectionItemEmbed

Delete CollectionItemEmbed