Create Highlight

POST

/highlights

Request

Body Params application/vnd.api+json

Example

{
    "data": {
        "type": "Highlight",
        "attributes": {
            "collectionItemId": "string",
            "color": "string",
            "range": "string",
            "summary": "string"
        },
        "relationships": {
            "owner": {
                "data": {
                    "id": "FID001",
                    "type": "User"
                }
            }
        }
    }
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.synap.ac/v3/highlights' \
--header 'Content-Type: application/vnd.api+json' \
--data-raw '{
    "data": {
        "type": "Highlight",
        "attributes": {
            "collectionItemId": "string",
            "color": "string",
            "range": "string",
            "summary": "string"
        },
        "relationships": {
            "owner": {
                "data": {
                    "id": "FID001",
                    "type": "User"
                }
            }
        }
    }
}'

Responses

🟢201Created

application/vnd.api+json

Created

Body

Example

{
    "data": {
        "id": "FID001",
        "type": "Highlight",
        "attributes": {
            "collectionItemId": "string",
            "color": "string",
            "range": "string",
            "summary": "string"
        },
        "relationships": {
            "owner": {
                "data": {
                    "id": "FID001",
                    "type": "User"
                }
            }
        }
    }
}

🟢202Accepted

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found

🟠409409

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

Reorder Collection Items

List Highlights