Hanzo
OpenapiDataroom

Puts an already-uploaded document into one of the caller org's data rooms and…

Puts an already-uploaded document into one of the caller org's data rooms and answers with the new membership id.

POST /v1/dataroom/datarooms/{id}/documents

Addresshttps://api.hanzo.ai/v1/dataroom/datarooms/{id}/documents
MethodPOST
Operationpost_dataroom_datarooms_by_id_documents
AuthAuthorization: Bearer $HANZO_API_KEY

Puts an already-uploaded document into one of the caller org's data rooms and answers with the new membership id.

It ATTACHES, it never uploads: the bytes must already be stored, so the usual order is upload the document, then add it to the room. Both the room and the document must exist in the caller's own store — either missing is not found — and a document already in the room is refused as a conflict rather than duplicated.

Request

4 fields, body application/json (required).

FieldInTypeRequiredDescription
idpathstringyesID is the room to add to. It is the path segment: the URL is the addressing authority, and the org it is resolved in comes from the caller's principal, so an…
documentIdbodyanyDocumentId is the document to attach.
idbodystringID is the room to add to. It is the path segment: the URL is the addressing authority, and the org it is resolved in comes from the caller's principal, so an…
orderIndexbodyanyOrderIndex fixes the document's place in the viewer's list.

Response

StatusBodyMeaning
200dataroomMembershipok

200 body — 3 fields.

FieldInTypeAlwaysDescription
dataroomDocumentIdbodystringDataroomDocumentId is the new membership id.
dataroomIdbodystringDataroomId is the room the document was added to.
documentIdbodystringDocumentId is the document that was added.

Failure carries the platform error shape — see Errors.

Examples

hanzo dataroom datarooms documents <id>

Dataroom API · All Hanzo APIs · Interactive reference

How is this guide?

On this page