Create CollectionAccess

POST

/collection-accesses

Request

Body Params application/vnd.api+json

Example

{
    "data": {
        "type": "CollectionAccess",
        "attributes": {
            "level": "editor",
            "upgradeInstructionsType": "product",
            "upgradeInstructionsData": [
                "string"
            ]
        },
        "relationships": {
            "userGroup": {
                "data": {
                    "id": "FID001",
                    "type": "UserGroup"
                }
            },
            "collection": {
                "data": {
                    "id": "FID001",
                    "type": "Collection"
                }
            }
        }
    }
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.synap.ac/v3/collection-accesses' \
--header 'Content-Type: application/vnd.api+json' \
--data-raw '{
    "data": {
        "type": "CollectionAccess",
        "attributes": {
            "level": "editor",
            "upgradeInstructionsType": "product",
            "upgradeInstructionsData": [
                "string"
            ]
        },
        "relationships": {
            "userGroup": {
                "data": {
                    "id": "FID001",
                    "type": "UserGroup"
                }
            },
            "collection": {
                "data": {
                    "id": "FID001",
                    "type": "Collection"
                }
            }
        }
    }
}'

Responses

🟢201Created

application/vnd.api+json

Created

Body

Example

{
    "data": {
        "id": "FID001",
        "type": "CollectionAccess",
        "attributes": {
            "level": "editor",
            "upgradeInstructionsType": "product",
            "upgradeInstructionsData": [
                "string"
            ]
        },
        "relationships": {
            "userGroup": {
                "data": {
                    "id": "FID001",
                    "type": "UserGroup"
                }
            },
            "collection": {
                "data": {
                    "id": "FID001",
                    "type": "Collection"
                }
            }
        }
    }
}

🟢202Accepted

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found

🟠409409

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

Delete Annotation

Delete CollectionAccess