Skip to main content

tenantCreationInitiate

Creates a whole tenant from scratch via a workflow (Tenant, channel DB, media index, secrets, anonymous user, root catalog, default channel, order statuses, valuesets, attributes, roles, optional admin user). Runs asynchronously: returns a workflow handle immediately — poll tenantCreationStatus for progress and the final tenant id.

Errors: TENANT_CREATION_INITIATE_ERROR if the workflow could not be started.

tenantCreationInitiate(
  input: TenantCreationInput!
): TenantCreationResult!

Arguments​

tenantCreationInitiate.input ● TenantCreationInput! non-null input​

Company name, tenant config, email provider credentials, and initial admin user.

Type​

TenantCreationResult object​

Handle for an async tenant-creation workflow. The mutation returns immediately; poll tenantCreationStatus with the workflowId for progress and the final tenant id.