Create a clause reference
curl --request POST \
--url https://app.myhero.so/clause-reference \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"_id": "<string>",
"blockId": "<string>",
"documentId": "<string>",
"hierarchy": "<string>"
}
'import requests
url = "https://app.myhero.so/clause-reference"
payload = {
"_id": "<string>",
"blockId": "<string>",
"documentId": "<string>",
"hierarchy": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
_id: '<string>',
blockId: '<string>',
documentId: '<string>',
hierarchy: '<string>'
})
};
fetch('https://app.myhero.so/clause-reference', 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.myhero.so/clause-reference",
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([
'_id' => '<string>',
'blockId' => '<string>',
'documentId' => '<string>',
'hierarchy' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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.myhero.so/clause-reference"
payload := strings.NewReader("{\n \"_id\": \"<string>\",\n \"blockId\": \"<string>\",\n \"documentId\": \"<string>\",\n \"hierarchy\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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.myhero.so/clause-reference")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"_id\": \"<string>\",\n \"blockId\": \"<string>\",\n \"documentId\": \"<string>\",\n \"hierarchy\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.myhero.so/clause-reference")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"_id\": \"<string>\",\n \"blockId\": \"<string>\",\n \"documentId\": \"<string>\",\n \"hierarchy\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"_id": "<string>",
"blockId": "<string>",
"documentId": "<string>",
"workspaceId": "<string>",
"hierarchy": "<string>",
"createdAt": 123,
"updatedAt": 123,
"originId": "<string>",
"isDeleted": false
}
}{
"error": "<string>",
"message": "<string>",
"details": [
"<unknown>"
]
}{
"error": "<string>",
"message": "<string>",
"details": [
"<unknown>"
]
}Clauses
Create a clause reference
Creates a clause reference linking a block in a document to a cross-document clause hierarchy.
The caller must supply a pre-generated _id, blockId, documentId, and hierarchy path.
Requires edit access to the target document.
Returns the full ClauseReference record.
POST
/
clause-reference
Create a clause reference
curl --request POST \
--url https://app.myhero.so/clause-reference \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"_id": "<string>",
"blockId": "<string>",
"documentId": "<string>",
"hierarchy": "<string>"
}
'import requests
url = "https://app.myhero.so/clause-reference"
payload = {
"_id": "<string>",
"blockId": "<string>",
"documentId": "<string>",
"hierarchy": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
_id: '<string>',
blockId: '<string>',
documentId: '<string>',
hierarchy: '<string>'
})
};
fetch('https://app.myhero.so/clause-reference', 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.myhero.so/clause-reference",
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([
'_id' => '<string>',
'blockId' => '<string>',
'documentId' => '<string>',
'hierarchy' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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.myhero.so/clause-reference"
payload := strings.NewReader("{\n \"_id\": \"<string>\",\n \"blockId\": \"<string>\",\n \"documentId\": \"<string>\",\n \"hierarchy\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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.myhero.so/clause-reference")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"_id\": \"<string>\",\n \"blockId\": \"<string>\",\n \"documentId\": \"<string>\",\n \"hierarchy\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.myhero.so/clause-reference")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"_id\": \"<string>\",\n \"blockId\": \"<string>\",\n \"documentId\": \"<string>\",\n \"hierarchy\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"_id": "<string>",
"blockId": "<string>",
"documentId": "<string>",
"workspaceId": "<string>",
"hierarchy": "<string>",
"createdAt": 123,
"updatedAt": 123,
"originId": "<string>",
"isDeleted": false
}
}{
"error": "<string>",
"message": "<string>",
"details": [
"<unknown>"
]
}{
"error": "<string>",
"message": "<string>",
"details": [
"<unknown>"
]
}Authorizations
HERO personal access token
Body
application/json
Response
200 response
Show child attributes
Show child attributes
⌘I