Create or edit a metadata field. Omit the optional field handle to create a new metadata field.


This method is deprecated.

Authorized User Types

  • IpsUser
  • IpsAdmin
  • IpsCompanyAdmin
  • ImagePortalAdmin


Input (saveMetadataFieldParam)

Parameter name Type Required Description
companyHandle xsd:string Yes The handle to the company.
fieldHandle xsd:string No Field handle.
assetType xsd:string Yes Choice of asset types from which to save metadata.
name xsd:string Yes Field name.
fieldType xsd:string Yes Choice of metadata field types.
defaultValue xsd:string Yes Default value of the fields for all assets.
isHidden xsd:boolean No Hide or expose IPS system-specific metadata.
isEnforced xsd:boolean


A boolean flag that indicates whether the metadata field is enforced (validated) when the value is set.

If set to true, then a fault is thrown if an illegal value is set in setAssetMetadata / batchSetAssetMetadata.

Output (saveMetadataFieldReturn)

Name Type Required Description
fieldHandle xsd:string Yes Handle of the new metadata field.


This code sample creates a new metadata field constrained by the Asset Type and Metadata Field Types string constants. If the fieldHandle element has a valid field handle value, it changes the metadata values and gets the same field handle that you specified in the request.


<ns1:saveMetadataFieldParam xmlns:ns1="">


<saveMetadataFieldReturn xmlns="">

On this page