Update Metadata Schema

Updates a metadata schema.

With this request, you can:

• Add a nonexistent attribute definition to the metadata schema.
• Update an existing attribute definition by overwriting its current values.

In the request, you can provide only those definitions you want to add or update. Definitions omitted in the request remain unchanged.

However, if you want to update a definition, you will have to add all its current key-value pairs as well. Only the pairs sent in the request are saved for this definition. This means that the key-value pairs that are not sent in a request are restored to default values. For example, if your definition has an array with values and it is not sent in an update request, the array values will be deleted.

👍 Additional Notes

• You cannot change the type of an existing schema, e.g. from "string" to "number".

• You can remove a definition with this endpoint by providing "deleted": true in the request. It will be moved to the Removed definitions section in the user interface. However, you cannot permanently remove a definition with this endpoint.

📘 Metadata Documentation

Read the Getting Started with Metadata and Metadata Mapping articles to learn how metadata work in Voucherify.

Authorizations

X-Management-Id · string · header · required

X-Management-Token · string · header · required

Path Parameters

projectId · string · required

Provide the unique identifier of the project.

Example:

"proj_TrlkLiH4"

metadataSchemaId · string · required

Provide the unique identifier of the metadata schema.

Example:

"ms_f0r4hm3ta6a4a5ch3ma"

Body

application/json

Defines the metadata schema to be updated.

properties · object · required

Contains metadata definitions. There can be many properties within this object.

Only the properties sent in the request will be updated. However, if you send a property, all its key-value pairs must be provided - otherwise, they will be overwritten to new values.

You cannot change the "type" property. However, it is required, so you need to add it to the request.

Show child attributes

allow_defined_only · boolean

Restricts the creation of metadata fields when set to true. In other words, it indicates whether or not you are allowed to create new metadata definitions; for example, in the campaign manager or publication manager. If it is set to true, then only the defined fields will be available for assigning values.

Response

200

application/json

Returns the details about the updated metadata schema.

Response body schema for PUT management/v1/projects/{projectId}/metadata-schemas/{metadataSchemaId}. Object representing a metadata schema.

id · string · required

Unique identifier of the metadata schema.

related_object · string · required

The resource type. You can define custom metadata schemas, which have a custom "related_object" resource type. The standard metadata schemas are: "campaign", "customer", "earning_rule", "loyalty_tier", "order", "order_item", "product", "promotion_tier", "publication", "redemption", "reward", "voucher".

properties · object · required

Contains metadata definitions.

Show child attributes

allow_defined_only · boolean | null · required

Restricts the creation of metadata fields when set to true. It indicates whether or not you can create new metadata definitions, e.g. in the campaign or publication manager. If set to true, then only the defined fields are available for assigning values.

created_at · string<date-time> · required

Timestamp representing the date and time when the metadata schema was created. The value for this parameter is shown in the ISO 8601 format.

Example:

"2021-12-03T13:33:44.556Z"

updated_at · string<date-time> | null · required

Timestamp representing the date and time when the metadata schema was updated. The value for this parameter is shown in the ISO 8601 format.

Example:

"2022-08-11T08:05:30.695Z"

object · string · default: metadata_schema · required

The type of the object represented by the JSON. This object stores information about the metadata schema.