Update a metaobject

patch /rest/api/metaobjects/{id}

Updates the Metaobject resource.

Partially updates a metaobject. The body is a JSON Merge Patch document: change the handle, status, or individual fields values. Updated field values are re-validated against the definition.

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	Metaobject identifier

Request body

Property	Type	Required	Description
status	"DRAFT" | "ACTIVE"	-	The publication status of the metaobject.
fields	MetaobjectFieldInput[]	-	The field values of the metaobject, one entry per field definition.
Show fields fields Property Type Required Description key string required value string | null -

Response

200 - Metaobject resource updated

Property	Type	Required	Description
@context	object	-
@id	string	required
@type	string	required
id	string	-	The resource's unique identifier (UUID).
definition	string	-	The MetaobjectDefinition (IRI) this metaobject is a record of.
handle	string	-	The metaobject's unique slug within its definition type.
status	"DRAFT" | "ACTIVE"	-	The publication status of the metaobject.
displayName	string | null	-	The human-readable label, derived from the field named by the definition's displayNameField.

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	-