API Change Log

To keep our platform up to date, we may occasionally add new resources, new fields, new response keys to the Contentstack APIs, or change the existing resources. All such changes and upgrades are documented here.

August 4, 2022

Post this release, i.e., August 4, 2022, you will be allowed to skip the font size attribute while pasting content from a vendor (Google Document) while executing the Add stack settings API request. You can pass the "sys_rte_skip_format_on_paste" key within the stack_variables section in the request body.

July 26, 2022

Post this release, i.e., July 26th, 2022, we will stop supporting the ability to add multiple content deployment servers while setting up a specific publishing environment in Contentstack. We recommend that you instead make use of Webhooks to trigger deployment to multiple web servers whenever you publish content to an environment.

Once this product update goes live, all Content Management API (CMA) requests related to environments will no longer return the deploy_content and servers keys in the response. Please consider these parameters to avoid breaking changes in your application.

June 8, 2022

We introduced the following changes in our June 8, 2022 release:

• Contentstack now allows you to run a text-based search for an asset folder present in your stack. You can enter a search phrase that entirely or partially matches the name of the asset folder to bring it up in your search results.
  
  For example, you can run a Basic Search based on a search phrase such as “Marketing” to search for the “Marketing Images” asset folder, thus reducing effort and time.
• Contentstack now allows you to run a Basic Search for assets and asset folders based on a search phrase that partially matches the name of the asset or asset folder to bring it up in your search results. Instead of entering an exactly matching search phrase, you can type in a specific part of the asset or folder name for your basic search.
  
  For example, you can run a basic search using partially matching search phrases such as “smart” or “phone” to search for the “Smartphone.jpg” asset in your stack.

April 11, 2022

Post this release, i.e., April 11, 2022, Contentstack will restrict you from creating or importing content types and global fields with unique IDs specified in upper case. If you try to create or import a content type or global field with an uppercase unique ID, your Content Management API (CMA) requests will return an error in the response.

February 25, 2022

Beginning February 25, 2022, we will be gradually rolling out our "Branches" feature to all customers, which will be plan-based.

This feature release will introduce a change in the API responses returned for several Content Delivery API (CDA) / CDN and Content Management API (CMA) requests. To facilitate a smooth transition when you start using branches, we have listed below a few breaking changes in the API that you might need to update within your backend code.

You can refer to our API documentation on branches and branch aliases. Additionally, you can learn more about this feature in our Branches documentation.

Note: The “branches” feature is available only in the new Contentstack interface.

February 11, 2022

We introduced the following changes in our February 11, 2022 release:

• The Publish Queue of your stack now only maintains records of publishing/unpublishing activities performed within the last 90 days. This update ensures that constant publishing activity does not overload the queue.
• The Audit Log of your stack now only maintains records of activities (events) performed within the last 90 days.
• Contentstack now signs all webhook events sent to your endpoints with a webhook signature. This signature appears in each event's X-Contentstack-Request-Signature header. It allows you to verify the integrity of the data and the provider's authenticity (Contentstack) from which data is coming.

January 21, 2022

Post this release, i.e., January 21, 2022, whenever a webhook sends data to a specified notification URL, if any key name in the response begins with a dollar sign ($), it will be prefixed with the acronym "cs" as a wildcard. For example, the key named "$success" would be replaced with "cs$success."

January 7, 2022

Post January 07, 2022, Contentstack will deactivate all password reset links within 60 minutes from when you generate them. After that, you can reuse the Forgot password option to generate a new link. For more information, read our Forgot (Reset) password documentation.

October 19, 2021

Post this release, i.e., October 19, 2021, Contentstack will restrict you from using the Content Management API (CMA) to create more than one entry in a content type that has been marked as "Single." To create multiple entries using the same content type, you need to mark that content type as "Multiple."

October 7, 2021

Post this release, i.e., October __, 2021, Contentstack will deploy the Webhook Circuit Breaker (WCB) whenever any webhook uses up its allotted execution retry attempts. WCB automatically disables a webhook that repeatedly fails to retrieve data from a specific notification URL 10 times. The faulty webhook is then marked with an Unhealthy status.

If any webhook goes into an unhealthy state, webhook-related Content Management API (CMA) requests will return the unhealthy key in the response:

{
    "unhealthy":{
        "state":true
    }
}

September 6, 2021

Post this release, i.e., September 6, 2021, any regulars expression added within the validation property of your content type should be valid. This update will restrict you from saving your content type if an invalid regex has been entered to avoid catastrophic backtracking.

August 19, 2021

We introduced the following changes in our August 19, 2021 release:

• The Get executions of a webhook API request now allows you to filter the webhook execution details based on a particular date range. To do so, you can pass from and to as query parameters within the API request.
• The GET Audit Log and GET Audit Log Item requests will return the request_id key in the response body. This key helps map the API requests made throughout a stack with the Audit Log.

July 31, 2021

Post this release, i.e., July 31, 2021, Contentstack will follow an exponential webhook retry policy. Whenever any webhook fails to send data to the desired notification URL or a session timeout occurs, it attempts to send data again four more times. The interval time between two retries increases exponentially according to the retry attempt number.

Dec 16, 2020

We have stopped supporting Access Token for all stacks created post this release, i.e., December 16, 2020. For stacks created after this release, the Access Token will no longer be generated. Instead, you need to use the value of the environment-specific Delivery Token against the ‘access_token’ key to make authorized Content Delivery API (CDA) or CDN requests. Subsequently, you can use Management Tokens to make Content Management API (CMA) requests.

For stacks created before December 16, 2020, we will continue to support Access Tokens. However, we strongly recommend switching to Delivery Tokens and Management Tokens for the respective API requests mentioned above.

Read our FAQs on Access Token Removal to know more.

Note: Though we have stopped supporting Access Tokens, we haven’t removed the usage of the ‘access_token’ key for Content Delivery API requests. To make authorized Content Delivery API requests, you need to now pass the value of the delivery token against the access_token key.

Dec 4, 2020

Adding support for the include_fallback query parameter for the following Content Delivery API requests: Get All Entries, Get Single Entry, Get All Assets, and Get Single Asset.

Using the include_fallback=true parameter in the above API requests, you can fetch published content from the fallback languages, if the requested entry is not available for the specified language.

You can refer to our API documentation on entries and assets to learn more about retrieving published fallback content. Additionally, you can learn more about this feature in our Retrieve Fallback Language Content for Published Entries guide.

September 25, 2020

Post this release, i.e. September 25, 2020, all entry-related API requests that hit the Content Delivery API (CDA) or CDN and Content Management API (CMA) will return the _metadata key inside the multiple “Group” and “Global” fields or “Modular Blocks”. This key helps to uniquely identify each instance of the above fields when they have been marked as “Multiple”.

August 31, 2020

We have deprecated the include_workflow parameter for all Content Delivery API (CDA) or CDN requests. For stacks created post this release, i.e., August 31, 2020, users will no longer be able to fetch workflow stage details for published entries. However, for stacks created before this release, users will be able to retrieve workflow stage details for existing published entries. Read more about adding workflows and workflow stages.

Jun 24, 2020

Following changes have been introduced to new stacks of Organizations created post this release, i.e., June 24, 2020:

• Users will no longer be able to use the stack Access Token to make authorized Content Delivery API (CDA) or CDN requests. Instead, you need to use the value of the environment-specific delivery token of the stack against the access_token key. Read more about the relevant authentication parameters.
• Users will no longer be able to pass authentication parameters such as api_key (Stack API key), access_token (Access Token of the stack), authtoken (user-generated authtoken), and authorization (Management token of the stack) as query parameters for any stack-specific API requests. Read more about Queries.

Oct 18, 2019

• Management Token is a stack-level read-write token that lets you make authorized Content Management API requests. The token value needs to be passed in the new authorization header parameter. Read more about this token in the Authentication section.
• The Get executions of a webhook API request will return a maximum of 100 records while fetching the execution details for a specific webhook. Previously, there was no limit on the number of records returned.

July 29, 2019

The Reference field has been upgraded to include references to more than one content types.

The input format of your Reference field has been changed from an array of strings to an array of objects. The change in the Reference field format is as follows:

{
    ...
    "ref_field": ["entry_UID1", entry_UID2, ...]
    ...
}

{
    ...
    "ref_field": [{
            "uid": "entry_UID",
            "_content_type_uid": "referred_content_type"
        }, {}, ...
        ...
    ]
}

March 08, 2019

The webhook data of an entry or asset that is published or unpublished via release deployment now includes a source key that contains the (type, title, and uid) of the source (i.e., release). Here's an example of the key that is added to the webhook data:

"source": {
    "type": "release",
    "title": "{{release_title}}",
    "uid": "{{release_uid}}"
},

Oct 14, 2017

• The URL of assets for stacks created after this release will include the file name, and the URL pattern will be /v3/assets/:api_key/:asset_uid/:token/:filename. To enforce the changes on images of existing RTE or Markdown fields, you need to re-upload the images and then re-publish the entry for the changes to reflect. For more information, contact us.
• It will now be possible to get entries by URL even if the entries use default URL pattern. This change will be applicable only to the stacks created after this release.
• Entries that have empty URL after the upgrade, the user will have to re-save the entry to get them autopolulated in the URL field.

June 24, 2017

• The publish_details key that was available in the response of GET requests of draft entries and assets will be no longer returned by default. To include it in the response, use the include_publish_details parameter.
• The publish_details key available in the response of GET requests of entries and assets of specific environment(s) will now contain the details of only the environment(s) specified in the environment parameter, and not of all the environments.
• The image URL, when opened in the browser will render the image, instead of downloading it.
• Any API request will return a maximum of 100 records (changed from 1000 earlier). The next batch of records can be retrieved by making the same request and changing the skip parameter to 100 from 0.

Oct 30, 2016

• With the introduction of the new V3 APIs, there is a change in response of several API requests. These are breaking changes, and may require you to adjust your code. Click the 'Read more' link below to see what changed.