Amend changes an item on the caller org's trust centre — replace its file with…

Amend changes an item on the caller org's trust centre — replace its file with a newer edition, move it between public and gated, rewrite what it says, or…

PATCH /v1/dataroom/trust/artifacts/{id}

Dataroom → · All API references → · Six flows, four surfaces →


Address	`https://api.hanzo.ai/v1/dataroom/trust/artifacts/{id}`
Method	`PATCH`
Operation	`patch_dataroom_trust_artifacts_by_id`
Auth	`Authorization: Bearer $HANZO_API_KEY`

Amend changes an item on the caller org's trust centre — replace its file with a newer edition, move it between public and gated, rewrite what it says, or retire it — and answers with the item as it now stands.

Retiring is the withdrawal: the item leaves the public centre immediately and can no longer be granted, while grants already made over it stand, because a release that happened is part of the record and un-happening it in the record would be a lie. Restoring is the same call with retired false.

Moving an item an independent auditor signed to the public tier is refused, and refused by the database rather than only here. Only an admin of the org may call it, and the item is resolved in that org's own store, so another org's id is not found.

Request

9 fields, body application/json (required).

Field	In	Type	Required	Description
`id`	path	string	yes	ID is the item to change, taken from the path.
`body`	body	string	—	Body replaces the item's content.
`document`	body	string	—	Document replaces the file the item points at — this is how a report is superseded by its next edition.
`framework`	body	string	—	Framework replaces the standard it speaks to.
`id`	body	string	—	ID is the item to change, taken from the path.
`name`	body	string	—	Name replaces its title.
`retired`	body	boolean	—	Retired withdraws the item, or true→false restores it.
`summary`	body	string	—	Summary replaces the line about it.
`tier`	body	string	—	Tier moves it between public and gated.

Response

Status	Body	Meaning
`200`	trustItemView	ok

200 body — 12 fields.

Field	In	Type	Always	Description
`attester`	body	string	—	Attester is who vouched for it: self or auditor.
`body`	body	string	—	Body is the item's content for the kinds that are text rather than a file.
`createdAt`	body	integer	—	CreatedAt is when it was published, in unix milliseconds.
`document`	body	string	—	Document is the data-room document holding its bytes, empty when it has none.
`framework`	body	string	—	Framework is the standard it speaks to, when it speaks to one.
`id`	body	string	—	ID addresses the item.
`kind`	body	string	—	Kind is what it is.
`name`	body	string	—	Name is its title.
`retired`	body	boolean	—	Retired is whether it has been withdrawn. A retired item is absent from the public centre and cannot be granted; it is kept because a grant already made over…
`summary`	body	string	—	Summary is a line about it.
`tier`	body	string	—	Tier is public or gated.
`updatedAt`	body	integer	—	UpdatedAt is when it last changed, in unix milliseconds.

Failure carries the platform error shape — see Errors.

Examples

hanzo has no subcommand for this operation — the CLI serves only what cloud's live route table confirms. Use HTTP or an SDK.

import { Configuration, DataroomApi } from 'hanzoai';

const api = new DataroomApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.patchDataroomTrustArtifactsById({ id: 'id', body: "<body>", document: "<document>" });

from hanzoai.cloud import ApiClient, Configuration
from hanzoai.cloud.api import DataroomApi

client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = DataroomApi(client).patch_dataroom_trust_artifacts_by_id(id='id', body="<body>", document="<document>")

cfg := cloud.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := cloud.NewAPIClient(cfg)

resp, _, err := client.DataroomAPI.PatchDataroomTrustArtifactsById(context.Background()).Execute()
if err != nil {
	return err
}

use hanzo_cloud::apis::{configuration::Configuration, dataroom_api};

let mut cfg = Configuration::new();
cfg.bearer_access_token = std::env::var("HANZO_API_KEY").ok();

let result = dataroom_api::patch_dataroom_trust_artifacts_by_id(&cfg, Default::default()).await?;

import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.DataroomApi;

ApiClient client = new ApiClient();
client.setRequestInterceptor(b -> b.header("Authorization", "Bearer " + System.getenv("HANZO_API_KEY")));

var result = new DataroomApi(client).patchDataroomTrustArtifactsById();

The method above is the one at the current release of the document. [email protected] (npm) and [email protected] (PyPI) were generated from an earlier release, where this operation carried a different id, so it spells the method differently — regenerating the clients is what makes the two agree. SDKs →

curl -X PATCH https://api.hanzo.ai/v1/dataroom/trust/artifacts/<id> \
  -H "Authorization: Bearer $HANZO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
       "body": "<body>",
       "document": "<document>"
     }'

The door reaches dataroom through the dataroom tool, which names its 17 operations with its own verbs — this one among them, under a name only the door declares. describe explains any of them:

curl -X POST https://api.hanzo.ai/v1/mcp \
  -H "Content-Type: application/json" \
  -d '{
       "jsonrpc": "2.0",
       "id": 1,
       "method": "tools/call",
       "params": {
         "name": "describe",
         "arguments": {
           "op": "get_dataroom_analytic_dataroom"
         }
       }
     }'

Dataroom API · All Hanzo APIs · Interactive reference

Amend changes an item on the caller org's trust centre — replace its file with…

Request

Response

Examples

On this page