Update custom metadata field

patch
https://api.imagekit.io
/v1/customMetadataFields/:id
Update an existing custom metadata field
Examples
cURL
Node.js
Python
PHP
Java
Ruby
Go
curl -X PATCH "https://api.imagekit.io/v1/customMetadataFields/field_id" \
-H 'Content-Type: application/json' \
-u your_private_key: -d'
{
    "schema": {
        "minValue": 500,
        "maxValue": 2500
    }
}
'
var ImageKit = require("imagekit");
​
var imagekit = new ImageKit({
    publicKey : "your_public_api_key",
    privateKey : "your_private_api_key",
    urlEndpoint : "https://ik.imagekit.io/your_imagekit_id/"
});
​
var fieldId = "field_id";
imagekit.updateCustomMetadataField(
    fieldId,
    {
        schema: {
            minValue: 500,
            maxValue: 2500
        }
    }, 
    function(error, result) {
        if(error) console.log(error);
        else console.log(result);
    }
);
from imagekitio import ImageKit
​
imagekit = ImageKit(
    public_key='your_public_api_key',
    private_key='your_private_api_key',
    url_endpoint = 'https://ik.imagekit.io/your_imagekit_id/'
)
​
update_custom_metadata_fields = imagekit.update_custom_metadata_fields(field_id="id", 
                                                 options=UpdateCustomMetadataFieldsRequestOptions(label="test-update",
                                                  schema=CustomMetadataFieldsSchema(
                                                      min_value=100,
                                                      max_value=200))
)
​
print("Update custom metadata field-", update_custom_metadata_fields, end="\n\n")
​
# Raw Response
print(update_custom_metadata_fields.response_metadata.raw)
​
# print the label of updated custom metadata fields
print(update_custom_metadata_fields.label)
​
# print the schema's min value of updated custom metadata fields
print(update_custom_metadata_fields.schema.min_value)
use ImageKit\ImageKit;
​
$public_key = "your_public_api_key";
$your_private_key = "your_private_api_key";
$url_end_point = "https://ik.imagekit.io/your_imagekit_id";
​
$imageKit = new ImageKit(
    $public_key,
    $your_private_key,
    $url_end_point
);
​
$body = [
    "schema" => [
        "minValue" => 500
        "maxValue" => 2500
    ]
];
​
$customMetadataFieldId = 'field_id';
$updateCustomMetadataField = $imageKit->updateCustomMetadataField($customMetadataFieldId, $body);
​
echo("Update Custom Metadata Field : " . json_encode($updateCustomMetadataField));
CustomMetaDataFieldSchemaObject schemaObject = new CustomMetaDataFieldSchemaObject();
schemaObject.setMinValue(500);
schemaObject.setMaxValue(2500);
​
CustomMetaDataFieldUpdateRequest customMetaDataFieldUpdateRequest = new CustomMetaDataFieldUpdateRequest();
customMetaDataFieldUpdateRequest.setId("field_id");
customMetaDataFieldUpdateRequest.setLabel("");
customMetaDataFieldUpdateRequest.setSchema(schemaObject);
​
ResultCustomMetaDataField resultCustomMetaDataField = ImageKit.getInstance().updateCustomMetaDataFields(customMetaDataFieldUpdateRequest);
imagekitio = ImageKitIo::Client.new("your_private_key", "your_public_key", "your_url_endpoint")
imagekitio.update_custom_metadata_field(
  id: 'field_id', #required
  schema: {   #required if label not available
    minValue: 500,
    maxValue: 2500
  }
)
// Atleast Label or Schema is required
resp, err := ik.Metadata.UpdateCustomField(ctx, "field_id", UpdateCustomFieldParam{
    Label: "Cost",
    Schema: {
        MinValue: 100,
        MaxValue: 2500,
    },
})

Get custom metadata field

Delete custom metadata field

Last modified 1d ago

Copy link

On this page

patch

Update an existing custom metadata field

Examples