Last updated

Release timeline

This document outlines the timeline for the upcoming and currently released backward incompatible (i.e., breaking changes) updates to the APIs.

May 06, 2025

CompanyApi

/v2/companies

  • requestBody: Property enabled at path post>requestBody>supportConfig>cognigyChatConfig>enabled will be required from 2025-05-12.
  • requestBody: Property enabled at path post>requestBody>supportConfigs>cognigyChatConfig>enabled will be required from 2025-05-12.
  • requestBody: Property scriptUrl at path post>requestBody>supportConfig>cognigyChatConfig>scriptUrl will be required from 2025-05-12.
  • requestBody: Property scriptUrl at path post>requestBody>supportConfigs>cognigyChatConfig>scriptUrl will be required from 2025-05-12.
  • requestBody: Property initWebchatEndpoint at path post>requestBody>supportConfig>cognigyChatConfig>initWebchatEndpoint will be required from 2025-05-12.
  • requestBody: Property initWebchatEndpoint at path post>requestBody>supportConfigs>cognigyChatConfig>initWebchatEndpoint will be required from 2025-05-12.
  • requestBody: Property sessionTimeout at path post>requestBody>supportConfig>cognigyChatConfig>sessionTimeout will be required from 2025-05-12.
  • requestBody: Property sessionTimeout at path post>requestBody>supportConfigs>cognigyChatConfig>sessionTimeout will be required from 2025-05-12.

/v2/companies/{companyId}

  • requestBody: Property enabled at path put>requestBody>supportConfig>cognigyChatConfig>enabled will be required from 2025-05-12.
  • response: Property enabled at path get>response>200>supportConfig>cognigyChatConfig>enabled will be required from 2025-05-12.
  • requestBody: Property scriptUrl at path put>requestBody>supportConfig>cognigyChatConfig>scriptUrl will be required from 2025-05-12.
  • response: Property scriptUrl at path get>response>200>supportConfig>cognigyChatConfig>scriptUrl will be required from 2025-05-12.
  • requestBody: Property initWebchatEndpoint at path put>requestBody>supportConfig>cognigyChatConfig>initWebchatEndpoint will be required from 2025-05-12.
  • response: Property initWebchatEndpoint at path get>response>200>supportConfig>cognigyChatConfig>initWebchatEndpoint will be required from 2025-05-12.
  • requestBody: Property sessionTimeout at path put>requestBody>supportConfig>cognigyChatConfig>sessionTimeout will be required from 2025-05-12.
  • response: Property sessionTimeout at path get>response>200>supportConfig>cognigyChatConfig>sessionTimeout will be required from 2025-05-12.

April 16, 2025

AirApi

/v3/air/company-credits/migrations

  • requestBody: Property isMoveToCompanyCredits at path post>requestBody>isMoveToCompanyCredits is removed.