add_custom_properties

Attach custom (key/value) metadata properties to an asset.

add_custom_properties

Attach custom (key/value) metadata properties to an asset.

Attach custom metadata properties to a confined asset.

Safety class: B · API type: admin · Min version:

📘

Confinement

Class B: content_id must be within your run-root anchor.

Signatures

def add_custom_properties(sdk, content_id, custom_properties=None, name=None, date=None):
    """Add custom_properties (and optional name/date) to content_id; return the response."""
    return sdk.add_custom_properties(content_id, name, date, custom_properties)
export async function addCustomProperties(sdk, contentId, customProperties = null, name = null, date = null) {
    // Attach custom metadata properties to a confined asset.
    return await sdk.addCustomProperties(contentId, name, date, customProperties);
}

Parameters

Parameter (Python)Parameter (JS)TypeRequiredNotes
sdksdkNomad_SDKyes
content_idcontentIdstryese.g. <asset-uuid>
custom_propertiescustomPropertiesdict | Nonenoe.g. {"externalId": "ext-1"}
namenamestr | Noneno
datedatestr | Noneno

Returns

dict | None — updated asset info; None on failure.

Errors

  • 401 unauthenticated
  • 404 asset not found

See also: Python ↔ JS naming map · Return shapes.