Update a metaobject definition

patch /rest/api/metaobject_definitions/{id}

Updates the MetaobjectDefinition resource.

Partially updates a metaobject definition. The body is a JSON Merge Patch document: change the name, displayNameField, or the fieldDefinitions.

Changing fields affects records

Editing fieldDefinitions changes the shape every Metaobject of this type is validated against. Removing or retyping a field can invalidate existing records’ values.

Headers

Name	Type	Required	Description
X-Flowkiwi-Organization-Id	string	required	The organization the request acts as. Determines the identity, permissions and ownership applied when reading or modifying data on the instance.

Path parameters

Name	Type	Required	Description
id	string	required	MetaobjectDefinition identifier

Request body

Property	Type	Required	Description
name	string | null	-
description	string | null	-
displayNameField	string | null	-	The key of the field definition used as the display name for records of this type. Optional - when omitted it is null and records have no derived display name. When set, it must match the key of one of this definition's fieldDefinitions, otherwise the request is rejected with 422.
fieldDefinitions	EmbeddedMetaobjectFieldDefinitionResource[]	-	The field definitions that make up this metaobject definition.
Show fieldDefinitions fields Property Type Required Description key string required The field key, unique within the definition (referenced by metaobject fields). name string required The human-readable name of the field. description string | null - An optional description of the field. type string required The field data type, as an IRI to the field-type resource. required boolean - Whether a value for this field is required on metaobjects of the definition. validations EmbeddedMetaobjectFieldDefinitionValidationResource[] - The validation rules applied to values of this field. Show validations fields Property Type Required Description name string required The type of validation rule value string required The validation parameter value. Format depends on the validation type.

Response

200 - MetaobjectDefinition resource updated

Property	Type	Required	Description
@context	object	-
@id	string	required
@type	string	required
id	string	-	The resource's unique identifier (UUID).
type	string	required	The unique slug identifier for this metaobject definition.
name	string	required	The human-readable name of the metaobject definition.
description	string | null	-	The description of the metaobject definition.
displayNameField	string | null	-	The key of the field definition used as the display name for records of this type. Optional - when omitted it is null and records have no derived display name. When set, it must match the key of one of this definition's fieldDefinitions, otherwise the request is rejected with 422.
fieldDefinitions	EmbeddedMetaobjectFieldDefinitionResource[]	-	The field definitions that make up this metaobject definition.
Show fieldDefinitions fields Property Type Required Description id string - The resource's unique identifier (UUID). key string required The field key, unique within the definition (referenced by metaobject fields). name string required The human-readable name of the field. description string | null - An optional description of the field. type string required The field data type, as an IRI to the field-type resource. required boolean - Whether a value for this field is required on metaobjects of the definition. validations EmbeddedMetaobjectFieldDefinitionValidationResource[] - The validation rules applied to values of this field. Show validations fields Property Type Required Description name string required The type of validation rule value string required The validation parameter value. Format depends on the validation type.
createdAt	string	-	The date and time when the resource was created (ISO 8601 format).
updatedAt	string	-	The date and time when the resource was last modified (ISO 8601 format).

Errors

400 - Invalid input

Property	Type	Required	Description
@context	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	number | 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 - Access denied. The caller is missing one or more identity permissions required for this operation.

Content-Type: application/problem+json

Property	Type	Required	Description
@context	object	-
@id	string	required
@type	string	required
type	string	-
title	string	-
status	integer	-
detail	string	-
missingPermissions	string[]	-	Identity permissions that the caller is missing for this operation. Present only when the 403 is caused by a denied identity:* permission.

404 - Not found

Property	Type	Required	Description
@context	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	number | 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

422 - An error occurred

Property	Type	Required	Description
@context	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	-