Skip to main content
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>"
}
'
{
  "data": {
    "_id": "<string>",
    "blockId": "<string>",
    "documentId": "<string>",
    "workspaceId": "<string>",
    "hierarchy": "<string>",
    "createdAt": 123,
    "updatedAt": 123,
    "originId": "<string>",
    "isDeleted": false
  }
}

Documentation Index

Fetch the complete documentation index at: https://developers.myhero.so/llms.txt

Use this file to discover all available pages before exploring further.

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.

Authorizations

​
Authorization
string
header
required

HERO personal access token

Body

application/json
​
_id
string
required
Minimum string length: 1
​
blockId
string
required
Minimum string length: 1
​
documentId
string
required
Minimum string length: 1
​
hierarchy
string
required
Minimum string length: 1

Response

200 response

​
data
object
required