younifyd
Menu

Update Metadata Schema

Update Metadata Schema

PUT/management/v1/projects/{projectId}/metadata-schemas/{metadataSchemaId}

Use it in a workflow

  1. Add a step and choose the Voucherify connector.
  2. Pick the Update Metadata Schema action (under Management).
  3. Fill in the fields below, then reference the result from later steps as {{updateMetadataSchema.response.data}}.

Request

Path parameters

projectIdstringrequired

Provide the unique identifier of the project.

metadataSchemaIdstringrequired

Provide the unique identifier of the metadata schema.

Request body

Enter the body as JSON in the step's Body field.

allow_defined_onlyboolean

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.

propertiesobject

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.

json
{
  "allow_defined_only": false,
  "properties": {}
}

Response

Returns 200 with an object. Read it in later steps with {{updateMetadataSchema.response.data.<field>}}.

Need more? See the Voucherify guide for connection setup and behaviour shared by every action.

Update Metadata Schema — Voucherify — Documentation