Lock or unlock a library entity
curl --request POST \
--url https://app.octavehq.com/api/v2/entity-lock/update \
--header 'Content-Type: application/json' \
--header 'api_key: <api-key>' \
--data '
{
"entityId": "<string>",
"locked": true
}
'import requests
url = "https://app.octavehq.com/api/v2/entity-lock/update"
payload = {
"entityId": "<string>",
"locked": True
}
headers = {
"api_key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {api_key: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({entityId: '<string>', locked: true})
};
fetch('https://app.octavehq.com/api/v2/entity-lock/update', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://app.octavehq.com/api/v2/entity-lock/update",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'entityId' => '<string>',
'locked' => true
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"api_key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://app.octavehq.com/api/v2/entity-lock/update"
payload := strings.NewReader("{\n \"entityId\": \"<string>\",\n \"locked\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("api_key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://app.octavehq.com/api/v2/entity-lock/update")
.header("api_key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"entityId\": \"<string>\",\n \"locked\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.octavehq.com/api/v2/entity-lock/update")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["api_key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"entityId\": \"<string>\",\n \"locked\": true\n}"
response = http.request(request)
puts response.read_body{
"_metadata": {
"requestId": "requestId",
"timestamp": "2021-01-01T00:00:00.000Z",
"usage": 0,
"message": "message"
},
"success": true,
"locked": true
}Library Locks
Lock or unlock a library entity
Explicitly change a library entity’s lock. Named override editors can unlock on their own behalf; ordinary edits preserve the lock. Requires API write and library lock entitlements.
POST
/
api
/
v2
/
entity-lock
/
update
Lock or unlock a library entity
curl --request POST \
--url https://app.octavehq.com/api/v2/entity-lock/update \
--header 'Content-Type: application/json' \
--header 'api_key: <api-key>' \
--data '
{
"entityId": "<string>",
"locked": true
}
'import requests
url = "https://app.octavehq.com/api/v2/entity-lock/update"
payload = {
"entityId": "<string>",
"locked": True
}
headers = {
"api_key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {api_key: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({entityId: '<string>', locked: true})
};
fetch('https://app.octavehq.com/api/v2/entity-lock/update', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://app.octavehq.com/api/v2/entity-lock/update",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'entityId' => '<string>',
'locked' => true
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"api_key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://app.octavehq.com/api/v2/entity-lock/update"
payload := strings.NewReader("{\n \"entityId\": \"<string>\",\n \"locked\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("api_key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://app.octavehq.com/api/v2/entity-lock/update")
.header("api_key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"entityId\": \"<string>\",\n \"locked\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.octavehq.com/api/v2/entity-lock/update")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["api_key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"entityId\": \"<string>\",\n \"locked\": true\n}"
response = http.request(request)
puts response.read_body{
"_metadata": {
"requestId": "requestId",
"timestamp": "2021-01-01T00:00:00.000Z",
"usage": 0,
"message": "message"
},
"success": true,
"locked": true
}Authorizations
Body
application/json
Available options:
product, service, solution, persona, playbook, segment, use_case, competitor, alternative, buying_trigger, core_feature, objection, proof_point, reference, hypothesis, brand_voice, skill Minimum string length:
1True to lock editing; false to explicitly unlock for everyone with normal editing access.