Changelog

2025

July

• Restrict the list of possible statuses to be used on the activeStage as part of the Modify job endpoint.

May

• Adding and removing custom thumbnails now available as a part of customThumbnailFileId and removeCustomThumbnail as a part of Modify Asset.
• New endpoint for Adaptive Video Streaming is added.

March

• Add fileName as part of the Retrieve assets response.
• Added Collection Views V2 section to the Analytics module, and deprecation notice to V1.
• Deprecated Asset Download V2, Asset Create, and Asset Create CSV endpoints.
• Added Search for similar assets endpoint.

January

• Renamed retrieve derivative presets Endpoint.
• Added new 2 endpoints to list and get derivative presets / account additionals account additionals.
• Added the additionalId property as part of mediaitems response in Retrieve assets and Retrieve specific asset.
• Added Asset Creations V2 into Asset Usage V2 section of the Analytics module.
• Removed deprecated Asset Views and Asset Downloads endpoint in Asset Usage V1.

2024

December

• Added Asset Downloads V2 into Asset Usage V2 section of the Analytics module.
• Added Upload assets modern stack
• Added save a modern stack uploaded asset to a Workflow Job

November

• Added Retrieve users with pagination

September

• Added Retrieve stages of specific job
• Added Retrieve specific stage
• Added Modify stage
• Added dateFinished field to Retrieve jobs, Retrieve the jobs of a specific campaign and Retrieve specific job endpoints.
• Added Finish job
• Added Retrieve specific users

August

• Expanded sharing rights in collectionOptions when sharing a collection to show View only and Download watermarked assets options.
• Added the option to edit the custom thumbnail of a collection in Modify Collection endpoint.

July

Added jobKey field to Retrieve jobs, Retrieve the jobs of a specific campaign and Retrieve specific job endpoints. Added jobFinishedHistory field to Retrieve jobs, Retrieve the jobs of a specific campaign and Retrieve specific job endpoints.

May

Added Asset Usage V2 section to the Analytics module.

April

• Migrated antivirus endpoints to quarantine endpoint

March

• Added option to Close Workflow Campaign.
• Added Antivirus audit endpoint to Antivirus module
• Added Antivirus asset endpoint to Antivirus module to retrieve an asset based on id

January

• Added isSSOOnly field to Retrieve specific user, Retrieve current user, Create user and Modify user endpoints

January

• Added possibility to set an externalReference on options in the metaproperty API Create metaproperty option and Update metaproperty option. This can be used as a replacement for the name as it doesn't have the same limitations with regards to allowed characters and is always editable. In the future this will fully replace the name attribute.

2023

December

• Added Asset Download V2 enpoint to the Analytics module.

August

• Changed HTTP error code for Rate limits from HTTP 400 Forbidden to HTTP 429 Too Many Requests.
• Removed references to OAuth1 and Permanent Tokens as we are starting the deprecation process for these authentication methods. Communication regarding timelines for this will be done via the standard customer communication processes when a timeline has been decided on.

June

• Added Historical Data section to the Analytics module.

May

• Removed deprecated Search Keyword endpoints.

March

• Added Search section to the Analytics module. Search Executions endpoints.
• Added timeZone field to Retrieve specific user and Retrieve current user responses.
• Added Collection section to the Analytics module. Collection Views endpoints.
• Added Reporting section to the Analytics module. Asset Reports and Specific Asset Report endpoints.

February

• Changed cursor format in all Analytics endpoints. The behaviour and usage remains the same.
• Added externalReference that is available in new taxonomy to Retrieve metaproperty options by ids and Retrieve metaproperty options
• Removed showInDuplicateView from metaproperty API Create metaproperty and Update metaproperty

January

• Removed showInListView and showInGridView from metaproperty API Create metaproperty and Update metaproperty

2022

December

• Added id to response of Create metaproperty, Create metaproperty option and Create option group

October

• Added Asset Create, Asset Remove, Asset Archive, Search Keyword and User Login enpoints to the Analytics module.
• Added Asset Activity and User Activity enpoints to the Analytics module.

August

• Removed deprecated metaproperty isSearchable from metaproperty responses, the metaproperty is always searchable.
• Added Analytics module.
• Added Asset View and Asset Download endpoints to the Analytics module.

June

• Added profileId field to Retrieve users response.

March

• Added endpoints for metaproperty visibility restrictions.

2021

August

• Added responsible, accountable and status filters and to Retrieve jobs and Retrieve the jobs of a specific campaign endpoints

June

• Added Dynamic Asset Transformations
• Updated the response body of Retrieve assets with transformBaseUrl.
• Updated the response body of Retrieve specific asset with transformBaseUrl.

May

• Added Retrieve media of specific job

February

• Added Add options to asset endpoint.
• Added Remove options from asset endpoint.

2020

October

• Updated the OAuth2.0 section with more information on the endpoints and new Client Credentials grant type.

July

• Added Retrieve groups endpoint
• Added groupids parameter to Create user and Modify user endpoints

May

• Added pagination options to Retrieve users

April

• Added booking time output to Retrieve jobs and Retrieve specific job

February

• Added limited and limitedDate attributes to Modify specific asset endpoint
• Added limited parameter and undocumented keyVisual parameter in Retrieve assets endpoint (keyVisual remains working for backwards compatibility)
• Added includeVersionNumber parameter to the Retrieve assets endpoint

January

• Added user information to Retrieve collections and Retrieve specific collection calls
• Added filtering and pagination options to Retrieve jobs and Retrieve the jobs of a specific campaign endpoints

2019

December

• Added 3d as possible value for asset type to Retrieve assets and Retrieve metaproperties calls
• Added integration_id and uri parameters to Retrieve asset usage
• Added new call: Sync asset usage

November

• Added stats parameter to the Retrieve specific asset call to return information about the asset views and downloads

September

• Added OAuth 2.0 section
• Added OAuth scopes mapping documentation
• Added security roles/permissions mapping information to Security roles section
• Added isDisplayField, isDrilldown, showInListView, showInGridView, showInDuplicateView and useDependencies attributes to Retrieve metaproperties and Retrieve specific metaproperty calls
• Added isApiField, isDisplayField, isDrilldown, isSearchable, showInListView, showInGridView, showInDuplicateView and useDependencies attributes to the data object in Create metaproperty and Modify metaproperty

August

• Added missing security roles information
• Added Product layer metaproperties section
• Added Workflow campaigns section
• Added Workflow jobs section
• Added Workflow metaproperties section
• Added Workflow users section
• Added Workflow groups section
• Added missing calls to Brandstore section

July

• Added SOLR cursor documentation to Retrieve assets call

June

• Corrected responses Content-type in the Register every uploaded chunk and Get closest AmazonS3 upload endpoint calls

May

• Added new isOpenImageBank attribute to Retrieve Account Information response

February

• Added username attribute to Modify user call
• Updated attributes information in Create user call

January

• Added pagination parameters (limit and page) to the Retrieve metaproperty options call

2018

November

• Added ids parameter information to the Retrieve metaproperties call
• Updated information about attributes for Upload file in chunks and register every uploaded chunk call
• Added all public video derivatives to Retrieve specific asset and Retrieve assets responses

October

• Added ids parameter information to the Retrieve collections call

September

• Added id parameter information to the Retrieve assets call

August

• Changed default order to relevance when passing a keyword to the Assets call
• Added minCount parameter to the Retrieve collections call
• Added new icon attribute to the Retrieve smartfilters response
• Added new zindex attribute to the Retrieve smartfilters response
• Added documentation about how to include the URL to the orginal asset file in the response of the Retrieve assets call

July

• Fixed documentation about id parameter for Register uploaded chunk call
• Updated information about limit parameter in Retrieve all tags call
• Added new 400 response information to Initialise upload call
• Added new isPublic attribute to the Modify collection call
• Added new includeMediaItems parameter to the Retrieve assets call
• Added new "groups" property to the Retrieve users and Retrieve specific user responses
• Added new isPublic parameter to the Retrieve collections call
• Added link to Paw file
• Added information about the response returned after a successful login in Authorise & Authenticate section

June

• Added information about views and downloads properties being deprecated in Assets section

May

• Added the "Create Permanent access token pairs" section
• Updated the Modify user call

April

• Added accessType parameter to Save as a new asset call