GET STARTED WITH APIs
Overview
ENDPOINTS
Upload File
Digital Asset Management (DAM)
Custom metadata fields
List all fields
get
Create new field
post
Update existing field
patch
Delete a field
delete
Managing assets
List and search assets
get
Managing folders
Caching
File Metadata
Account Management API
delete
https://api.imagekit.io
/v1/customMetadataFields/{id}

This API deletes a custom metadata field. Even after deleting a custom metadata field, you cannot create any new custom metadata field with the same name.

Request

id
string
required

Should be a valid custom metadata field id.

Auth
API key
:
Parameters
:
Note

Here, you can explore machine-generated code examples. For practical applications, refer to the examples section below, which includes detailed code snippets from the ImageKit SDKs.

curl --request DELETE \
  --url https://api.imagekit.io/v1/customMetadataFields/id \
  --header 'Accept: application/json' \
  --header 'Authorization: Basic 123'

Responses

Custom metadata field deleted successfully.

Body

1
{}

Examples

Copy
curl -X DELETE "https://api.imagekit.io/v1/customMetadataFields/field_id" \
-H 'Content-Type: application/json' \
-u your_private_key:

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.deleteCustomMetadataField(
    fieldId,
    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/'
)

delete_custom_metadata_field = imagekit.delete_custom_metadata_field(field_id="field_id")

print("Delete custom metadata field-", delete_custom_metadata_field, end="\n\n")

# Raw Response
print(delete_custom_metadata_field.response_metadata.raw)

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
);

$customMetadataFieldId = 'field_id';
$deleteCustomMetadataField = $imageKit->deleteCustomMetadataField($customMetadataFieldId);

echo("Delete Custom Metadata Field : " . json_encode($deleteCustomMetadataField));

ResultNoContent resultNoContent=ImageKit.getInstance().deleteCustomMetaDataField("field_id");

imagekitio = ImageKitIo::Client.new("your_private_key", "your_public_key", "your_url_endpoint")
imagekitio.delete_custom_metadata_field(id: 'field_id')

resp, err := ik.Metadata.DeleteCustomField(ctx, "field_id")


var imagekit = new ImageKit({
    publicKey : "your_public_api_key",
    privateKey : "your_private_api_key",
    urlEndpoint : "https://ik.imagekit.io/your_imagekit_id/"
});
ResultNoContent resultNoContentDel = imagekit.DeleteCustomMetaDataField("field_id");