Remove asset links
const url = 'https://apibase.ecomweb.app/api/v1/stores/example/assets/links';const options = { method: 'DELETE', headers: {'x-api-key': '<x-api-key>', 'Content-Type': 'application/json'}, body: '{"asset_ids":["example"],"entity_type":"example","entity_id":"example","entity_field":"example"}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request DELETE \ --url https://apibase.ecomweb.app/api/v1/stores/example/assets/links \ --header 'Content-Type: application/json' \ --header 'x-api-key: <x-api-key>' \ --data '{ "asset_ids": [ "example" ], "entity_type": "example", "entity_id": "example", "entity_field": "example" }'Removes the links between the listed assets and the records that use them, without deleting the assets. Narrow it with entity_type, entity_id and entity_field; with none of them the assets are unlinked from every record.
Required scopes: write:assets
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”The store’s ref, as returned by GET /stores.
Request Bodyrequired
Section titled “Request Bodyrequired”object
Array of asset IDs to unlink
Entity type filter (optional - if not provided, unlinks from all entities)
Entity ID filter (optional)
Entity field filter (optional)
Example generated
{ "asset_ids": [ "example" ], "entity_type": "example", "entity_id": "example", "entity_field": "example"}Responses
Section titled “Responses”object
Number of links removed.
A readable confirmation.
Example generated
{ "count": 1, "message": "example"}The request is malformed or failed validation.
object
The HTTP status code.
What went wrong; validation failures list one message per problem.
The HTTP status text, such as Bad Request.
object
A stable, machine-readable error code.
A human-readable explanation.
Extra context about the error, when there is any.
object
When the error happened, as an ISO 8601 timestamp.
Example generated
{ "statusCode": 1, "message": [ "example" ], "error": "example"}The key is missing, invalid, revoked or expired.
object
The HTTP status code.
What went wrong; validation failures list one message per problem.
The HTTP status text, such as Bad Request.
object
A stable, machine-readable error code.
A human-readable explanation.
Extra context about the error, when there is any.
object
When the error happened, as an ISO 8601 timestamp.
Example generated
{ "statusCode": 1, "message": [ "example" ], "error": "example"}The key may not do this: a missing scope, a readonly key, a publishable key on a Store API route, or a disallowed origin.
object
The HTTP status code.
What went wrong; validation failures list one message per problem.
The HTTP status text, such as Bad Request.
object
A stable, machine-readable error code.
A human-readable explanation.
Extra context about the error, when there is any.
object
When the error happened, as an ISO 8601 timestamp.
Example generated
{ "statusCode": 1, "message": [ "example" ], "error": "example"}