Skip to content

DAM REST API overview

The DAM REST API is used to integrate external systems with Sales Layer digital asset management capabilities.

It covers two resource types: images and files (non-image assets such as documents, spreadsheets, archives, and more). An integration can list, retrieve, create, update, and delete records of either type. Both resource types share the same authentication, pagination, and general error-handling patterns, but each has its own endpoints, supported file extensions, and processing behavior.

Use this API when an external system needs to keep product images, product documentation, media references, or asset metadata aligned with Sales Layer.

Main capabilities

CapabilityWhat it is used for
Create imagesRegister a new image from a publicly accessible HTTP or HTTPS URL and optionally assign tags.
List and filter imagesRetrieve image records and narrow results by supported query parameters.
Retrieve a single imageGet the full record for a specific image by its reference (filename).
Update imagesReplace an image's source content and/or tags for an existing image reference.
Delete imagesRemove an image resource by its reference (filename).
Create filesRegister a new non-image file (documents, spreadsheets, archives, and more) from a publicly accessible HTTP or HTTPS URL and optionally assign tags.
List and filter filesRetrieve file records and narrow results by supported query parameters.
Retrieve a single fileGet the full record for a specific file by its reference (filename).
Update filesReplace a file's source content and/or tags for an existing file reference.
Delete filesRemove a file resource by its reference (filename).

Endpoint summary

MethodPathFunctional description
GET/dam/imagesRetrieves image records. Use this endpoint to search, filter, sort, and paginate DAM images.
POST/dam/imagesCreates an image from a publicly accessible URL. The image is processed asynchronously after creation.
GET/dam/images({reference})Retrieves the full record for a single image by its reference (the image filename, unique per tenant).
PATCH/dam/images({reference})Partially updates an image by replacing its source content and/or tags. The replacement URL can use any filename — only the file's content type must match the image's current file type.
DELETE/dam/images({reference})Deletes an image resource by its reference (filename) when it can be safely removed.
GET/dam/filesRetrieves non-image file records. Use this endpoint to search, filter, sort, and paginate DAM files.
POST/dam/filesCreates a file from a publicly accessible URL. Unlike images, a file is usable immediately — nothing processes it in the background afterward.
GET/dam/files({reference})Retrieves the full record for a single file by its reference (the file name, unique per tenant).
PATCH/dam/files({reference})Partially updates a file by replacing its source content and/or tags. The replacement URL can use any filename — only the file's content type must match the file's current type.
DELETE/dam/files({reference})Deletes a file resource by its reference (filename). Deletion does not cascade: entities still referencing the deleted file are not updated.

Typical integration scenarios

Use the DAM REST API to:

  • Retrieve image or file records to verify processing status or asset availability.
  • Register externally hosted images or files so they can be managed in Sales Layer.
  • Replace image or file content, or update tags, for an existing reference.
  • Remove obsolete images or files as part of a controlled cleanup workflow.
  • Keep product documentation (datasheets, manuals, certificates) alongside product imagery in the same asset management surface.

Before implementing

Make sure your integration:

  • Sends a valid API key in the X-API-KEY header.
  • Uses pagination when reading lists of images or files.
  • Uses references (filenames), not internal numeric IDs, as identifiers when retrieving, updating, or deleting individual images or files. Files have no internal ID at all; images do have one, but it is not guaranteed stable as a public key — address images by reference as well.
  • Uses public HTTP or HTTPS URLs when creating or replacing images or files.
  • Handles temporary processing states when creating, updating, or deleting images (a 409 response means the image conflicts with an active background processing workflow). Files are not queued for background processing, so file writes never return a 409 for this reason — a 409 on POST /files instead means the filename already exists or the account's file-library quota has been reached. Image and file libraries have separate quotas.
  • Checks the accepted file extensions and size limits documented in the OpenAPI reference before uploading — they differ between images and files, and are enforced by inspecting the file's content, not its URL extension.
  • Applies retry and rate limiting behavior as described in Rate limiting.
  • Reviews DAM error details for image- and file-specific failure cases.

Technical reference

Use the DAM REST API v2.0 OpenAPI reference for request parameters, schemas, examples, and status codes.