Create an instance

post /api/organizations/{organizationId}/instances

Create an instance.

Creates a new instance within an organization. Provide a display name and a unique handle. The instance becomes the scope your product data lives in.

Handle is permanent

The handle must be unique and is fixed for the life of the instance - it cannot be changed later. Choose a stable, URL-safe value. Only the display name can be updated afterwards.

Path parameters

Name	Type	Required	Description
organizationId	string	required	OrganizationInstancesResource identifier

Request body

Property	Type	Required	Description
name	string	required	Human-readable display name of the instance.
handle	string	required	Stable, URL-safe identifier of the instance. Used as the tenant subdomain when addressing the per-instance product services (e.g. https://acme-eu.product-management.flowkiwi.net). Lowercase letters and hyphens only, no leading or trailing hyphen, max 30 characters, unique across all instances. It cannot be changed after creation.

Response

201 - Instance successfully created

Property	Type	Required	Description
@context	string | object	-
@id	string	required
@type	string	required
id	string | null	-	Unique identifier of the instance.
name	string | null	-	Human-readable display name of the instance.
handle	string | null	-	Stable, URL-safe identifier of the instance. Used as the tenant subdomain when addressing the per-instance product services (e.g. https://acme-eu.product-management.flowkiwi.net). Lowercase letters and hyphens only, no leading or trailing hyphen, unique across all instances.
created_at	string | null	-	Date and time the instance was created (ISO 8601, UTC).
updated_at	string | null	-	Date and time the instance was last updated (ISO 8601, UTC).
organization	OrganizationInfo | null	-
Show organization fields Property Type Required Description id string - name string -
created_by_organization	OrganizationInfo | null	-
Show created_by_organization fields Property Type Required Description id string - name string -

Errors

400 - Invalid input

Property	Type	Required	Description
@context	string | object	-
@id	string	required
@type	string	required
title	string | null	-	A short, human-readable summary of the problem.
detail	string | null	-	A human-readable explanation specific to this occurrence of the problem.
status	integer | null	-
instance	string | null	-	A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.
type	string	-	A URI reference that identifies the problem type

403 - Only organization owners can create instances

No response body.

404 - Organization not found

No response body.

422 - Validation error

Property	Type	Required	Description
@context	string | object	-
@id	string	required
@type	string	required
status	integer	-
violations	object[]	-
Show violations fields Property Type Required Description propertyPath string required The property path of the violation message string required The message associated with the violation code string - The code of the violation hint string - An extra hint to understand the violation payload object - The serialized payload of the violation
detail	string	-
type	string	-
title	string | null	-
instance	string | null	-