Update Reference

Updates the client data of the specified reference.

Request

HTTP Request

PATCH /node/api/refs/:id

Permissions

referencePermissions & (modify-objects | manage-objects)

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\"}}"
}

Response

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

Example

Request

  • Bash

  • JavaScript

  • NodeJS

  • Python

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
let login = <...>
let password = <...>
let saymonHostname = <...>
let refId = <...>
let path = "/node/api/refs/" + refId;
let auth = "Basic " + btoa(login + ":" + password);

let headers = new Headers();
headers.append("Content-Type", "application/json");
headers.append("Authorization", auth);

let data = JSON.stringify({
    "client_data": "..."
});

let requestOptions = {
    method: "PATCH",
    headers: headers,
    body: data
};

fetch(saymonHostname + path, requestOptions)
    .then(response => response.text())
    .then(result => console.log(result))
    .catch(error => console.log("error", error));
const http = require("https");

let login = <...>
let password = <...>
let saymonHostname = <...>
let refId = <...>
let path = "/node/api/refs/" + refId;
let auth = "Basic " + Buffer.from(login + ":" + password).toString("base64");

let options = {
    "method": "PATCH",
    "hostname": saymonHostname,
    "headers": {
        "Authorization": auth
    },
    "path": path
};

let req = http.request(options, function (res) {
    let chunks = [];

    res.on("data", function (chunk) {
        chunks.push(chunk);
    });

    res.on("end", function (chunk) {
        let body = Buffer.concat(chunks);
        console.log(body.toString());
    });

    res.on("error", function (error) {
        console.error(error);
    });
});

let data = JSON.stringify({
    "client_data": "..."
});

req.write(data);
req.end();
import requests

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

params = {
    "client_data": "..."
}

response = requests.request("PATCH", url, json=params, auth=(login, password))
print(response.text)

Response

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

See Also