Update Reference

Updates the client data of the specified reference.

Request

HTTP Request

PATCH /node/api/refs/:id
text

Permissions

referencePermissions & (modify-objects | manage-objects)
text

Path parameters

Parameter Type Description

id

String
required

The ID of a reference to be updated.

Body parameters

Parameter Type Description

client_data

String

The updated client data in the JSON format.

Request body

{
    "client_data": "{\"headlinePropIds\":[],\"custom_style\":{\"zIndex\":79,\"left\":\"200px\",\"top\":\"270px\",\"width\":\"300px\",\"height\":\"200px\"}}"
}
json

Response

Returns the updated reference. See the Reference model for more information.

Example

Request

login=<...>
password=<...>
saymon_hostname=<...>
ref_id=<...>
url=https://$saymon_hostname/node/api/refs/$ref_id

curl -X PATCH $url -u $login:$password \
    -H "Content-Type: application/json" \
    -d @- <<EOF
{
    "client_data": "..."
}
EOF
bash

Response

{
    "id": "5e60fb67630502472925ffbf",
    "target": "5e21b85b308c3c66d64e07c8",
    "owner": 1,
    "client_data": "..."
}
json