Hanzo
OpenapiDataroom

Opens a new data room for the caller org and answers with it, including the…

Opens a new data room for the caller org and answers with it, including the short public id it is addressed by.

POST /v1/dataroom/datarooms

Addresshttps://api.hanzo.ai/v1/dataroom/datarooms
MethodPOST
Operationpost_dataroom_datarooms
AuthAuthorization: Bearer $HANZO_API_KEY

Opens a new data room for the caller org and answers with it, including the short public id it is addressed by.

name is required; without it the call is refused and the tenant store is untouched, because a dispatch answering 4xx rolls its transaction back. A new room holds no documents and is reachable by NOBODY until a share link is created over it — opening a room and granting access are two separate acts, so a room cannot leak by existing.

Request

2 fields, body application/json (required).

FieldInTypeRequiredDescription
descriptionbodyanyDescription is the room's description.
namebodyanyName is the room's display name.

Response

StatusBodyMeaning
200dataroomRoomOneok

200 body — 7 fields.

FieldInTypeAlwaysDescription
dataroombodydataroomRoom
dataroom.createdAtbodyintegerCreatedAt is when the room was created, in unix milliseconds.
dataroom.descriptionbodystringDescription is the room's description, null when none was given.
dataroom.idbodystringID is the room id, which is what other dataroom calls address it by.
dataroom.namebodystringName is the room's display name.
dataroom.pIdbodystringPId is the room's short public identifier, unique within the tenant.
dataroom.updatedAtbodyintegerUpdatedAt is when the room last changed, in unix milliseconds.

Failure carries the platform error shape — see Errors.

Examples

hanzo dataroom datarooms create

Dataroom API · All Hanzo APIs · Interactive reference

How is this guide?

On this page