Hanzo
OpenapiFramework

Creates an app lane's DocTypes in the caller's org.

Creates an app lane's DocTypes in the caller's org.

POST /v1/framework/modules/{module}/install

Addresshttps://api.hanzo.ai/v1/framework/modules/{module}/install
MethodPOST
Operationpost_framework_modules_by_module_install
AuthAuthorization: Bearer $HANZO_API_KEY

Creates an app lane's DocTypes in the caller's org. Idempotent and create-if-absent: a DocType the org already has is reported as existing and never replaced, so re-installing cannot clobber a definition the org has since edited. Manager-only.

Request

1 field.

FieldInTypeRequiredDescription
modulepathstringyesModule is the lane's registered name ("cms", "erp"), from the path.

Response

StatusBodyMeaning
200Installok

200 body — 3 fields.

FieldInTypeAlwaysDescription
createdbodystring[]
existingbodystring[]
modulebodystring

Failure carries the platform error shape — see Errors.

Examples

hanzo framework modules install <module>

Framework API · All Hanzo APIs · Interactive reference

How is this guide?

On this page