Release timeline

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

May 22, 2025

TripApi

/v3/trips/arrangers/{arrangerId}/list
requestBody: Property tripFilters at path post>requestBody>tripFilters is removed.
requestBody: OneOf value TripDateRangeFilter at path post>requestBody>tripFilters is removed.
requestBody: Property filterType at path post>requestBody>tripFilters>filterType is removed.
requestBody: Property startDate at path post>requestBody>tripFilters>startDate is removed.
requestBody: Property endDate at path post>requestBody>tripFilters>endDate is removed.

/v3/trips/companies/{companyId}/list
requestBody: Property tripFilters at path post>requestBody>tripFilters is removed.
requestBody: OneOf value TripDateRangeFilter at path post>requestBody>tripFilters is removed.
requestBody: Property filterType at path post>requestBody>tripFilters>filterType is removed.
requestBody: Property startDate at path post>requestBody>tripFilters>startDate is removed.
requestBody: Property endDate at path post>requestBody>tripFilters>endDate is removed.

/v3/trips/users/{userId}/list
requestBody: Property tripFilters at path post>requestBody>tripFilters is removed.
requestBody: OneOf value TripDateRangeFilter at path post>requestBody>tripFilters is removed.
requestBody: Property filterType at path post>requestBody>tripFilters>filterType is removed.
requestBody: Property startDate at path post>requestBody>tripFilters>startDate is removed.
requestBody: Property endDate at path post>requestBody>tripFilters>endDate is removed.

May 19, 2025

EventApi

/v2/events
requestBody: eventCustomFieldResponses at path post>requestBody>eventCustomFieldResponses is deprecated.
requestBody: eventCustomFieldResponses at path post>requestBody>eventCustomFieldResponses is deprecated.

/v2/events/list
response: customFieldResponses at path post>response>200>events>customFieldResponses is deprecated.
response: customFieldResponses at path post>response>200>events>customFieldResponses is deprecated.

/v2/events/read-by-external-id
response: customFieldResponses at path get>response>200>event>customFieldResponses is deprecated.
response: customFieldResponses at path get>response>200>event>customFieldResponses is deprecated.

/v2/events/{eventId}
response: customFieldResponses at path get>response>200>event>customFieldResponses is deprecated.
response: customFieldResponses at path get>response>200>event>customFieldResponses is deprecated.

/v2/events/{eventId}/custom-field-responses
requestBody: eventCustomFieldResponses at path put>requestBody>eventCustomFieldResponses is deprecated.
requestBody: eventCustomFieldResponses at path put>requestBody>eventCustomFieldResponses is deprecated.
requestBody: Property eventCustomFieldResponses at path put>requestBody>eventCustomFieldResponses will be optional from 2025-05-06.

TripApi

/v3/trips/{tripId}/detail
response: Property selectedResponses at path get>response>200>pnrs>data>customFieldsV3Responses>selectedResponses is removed.
response: Property selectedResponses at path get>response>200>pendingShellPnrs>data>customFieldsV3Responses>selectedResponses is removed.
response: Property selectedResponses at path get>response>200>pendingManualFormPnrs>data>customFieldsV3Responses>selectedResponses is removed.
response: Property options at path get>response>200>pnrs>data>customFieldsV3Responses>selectedResponses>options is removed.
response: Property options at path get>response>200>pendingShellPnrs>data>customFieldsV3Responses>selectedResponses>options is removed.
response: Property options at path get>response>200>pendingManualFormPnrs>data>customFieldsV3Responses>selectedResponses>options is removed.
response: Property fieldId at path get>response>200>pnrs>data>customFieldsV3Responses>selectedResponses>fieldId is removed.
response: Property fieldId at path get>response>200>pendingShellPnrs>data>customFieldsV3Responses>selectedResponses>fieldId is removed.
response: Property fieldId at path get>response>200>pendingManualFormPnrs>data>customFieldsV3Responses>selectedResponses>fieldId is removed.
response: Property fieldName at path get>response>200>pnrs>data>customFieldsV3Responses>selectedResponses>fieldName is removed.
response: Property fieldName at path get>response>200>pendingShellPnrs>data>customFieldsV3Responses>selectedResponses>fieldName is removed.
response: Property fieldName at path get>response>200>pendingManualFormPnrs>data>customFieldsV3Responses>selectedResponses>fieldName is removed.
response: Property options at path get>response>200>pnrs>data>customFieldsV3Responses>selectedResponses>options is removed.
response: Property options at path get>response>200>pendingShellPnrs>data>customFieldsV3Responses>selectedResponses>options is removed.
response: Property options at path get>response>200>pendingManualFormPnrs>data>customFieldsV3Responses>selectedResponses>options is removed.
response: Property name at path get>response>200>pnrs>data>customFieldsV3Responses>selectedResponses>options>name is removed.
response: Property name at path get>response>200>pendingShellPnrs>data>customFieldsV3Responses>selectedResponses>options>name is removed.
response: Property name at path get>response>200>pendingManualFormPnrs>data>customFieldsV3Responses>selectedResponses>options>name is removed.
response: Property additionalUserInput at path get>response>200>pnrs>data>customFieldsV3Responses>selectedResponses>options>additionalUserInput is removed.
response: Property additionalUserInput at path get>response>200>pendingShellPnrs>data>customFieldsV3Responses>selectedResponses>options>additionalUserInput is removed.
response: Property additionalUserInput at path get>response>200>pendingManualFormPnrs>data>customFieldsV3Responses>selectedResponses>options>additionalUserInput is removed.
response: Property additionalInfos at path get>response>200>pnrs>data>customFieldsV3Responses>selectedResponses>options>additionalInfos is removed.
response: Property additionalInfos at path get>response>200>pendingShellPnrs>data>customFieldsV3Responses>selectedResponses>options>additionalInfos is removed.
response: Property additionalInfos at path get>response>200>pendingManualFormPnrs>data>customFieldsV3Responses>selectedResponses>options>additionalInfos is removed.

/v3/trips/{tripId}/pnrs
requestBody: Property selectedResponses at path post>requestBody>customFieldsV3Responses>selectedResponses is removed.
requestBody: Property options at path post>requestBody>customFieldsV3Responses>selectedResponses>options is removed.
requestBody: Property fieldId at path post>requestBody>customFieldsV3Responses>selectedResponses>fieldId is removed.
requestBody: Property fieldName at path post>requestBody>customFieldsV3Responses>selectedResponses>fieldName is removed.
requestBody: Property options at path post>requestBody>customFieldsV3Responses>selectedResponses>options is removed.
requestBody: Property name at path post>requestBody>customFieldsV3Responses>selectedResponses>options>name is removed.
requestBody: Property additionalUserInput at path post>requestBody>customFieldsV3Responses>selectedResponses>options>additionalUserInput is removed.
requestBody: Property additionalInfos at path post>requestBody>customFieldsV3Responses>selectedResponses>options>additionalInfos is removed.

/v3/trips/{tripId}/pnrs/{pnrId}
requestBody: Property selectedResponses at path put>requestBody>customFieldsV3Responses>selectedResponses is removed.
response: Property selectedResponses at path get>response>200>customFieldsV3Responses>selectedResponses is removed.
requestBody: Property options at path put>requestBody>customFieldsV3Responses>selectedResponses>options is removed.
response: Property options at path get>response>200>customFieldsV3Responses>selectedResponses>options is removed.
requestBody: Property fieldId at path put>requestBody>customFieldsV3Responses>selectedResponses>fieldId is removed.
response: Property fieldId at path get>response>200>customFieldsV3Responses>selectedResponses>fieldId is removed.
requestBody: Property fieldName at path put>requestBody>customFieldsV3Responses>selectedResponses>fieldName is removed.
response: Property fieldName at path get>response>200>customFieldsV3Responses>selectedResponses>fieldName is removed.
requestBody: Property options at path put>requestBody>customFieldsV3Responses>selectedResponses>options is removed.
response: Property options at path get>response>200>customFieldsV3Responses>selectedResponses>options is removed.
requestBody: Property name at path put>requestBody>customFieldsV3Responses>selectedResponses>options>name is removed.
response: Property name at path get>response>200>customFieldsV3Responses>selectedResponses>options>name is removed.
requestBody: Property additionalUserInput at path put>requestBody>customFieldsV3Responses>selectedResponses>options>additionalUserInput is removed.
response: Property additionalUserInput at path get>response>200>customFieldsV3Responses>selectedResponses>options>additionalUserInput is removed.
requestBody: Property additionalInfos at path put>requestBody>customFieldsV3Responses>selectedResponses>options>additionalInfos is removed.
response: Property additionalInfos at path get>response>200>customFieldsV3Responses>selectedResponses>options>additionalInfos is removed.

TemplateApi

/v2/event-templates
requestBody: customFieldResponses at path post>requestBody>customFieldResponses is deprecated.
requestBody: customFieldResponses at path post>requestBody>customFieldResponses is deprecated.

/v2/event-templates/list
response: customFieldResponses at path post>response>200>eventTemplates>customFieldResponses is deprecated.
response: customFieldResponses at path post>response>200>eventTemplates>customFieldResponses is deprecated.

/v2/event-templates/read-by-external-id
response: customFieldResponses at path get>response>200>eventTemplate>customFieldResponses is deprecated.
response: customFieldResponses at path get>response>200>eventTemplate>customFieldResponses is deprecated.

/v2/event-templates/{templateId}
response: customFieldResponses at path get>response>200>eventTemplate>customFieldResponses is deprecated.
response: customFieldResponses at path get>response>200>eventTemplate>customFieldResponses is deprecated.

/v2/event-templates/{templateId}/custom-field-responses
requestBody: customFieldResponses at path put>requestBody>customFieldResponses is deprecated.
requestBody: Property customFieldResponses at path put>requestBody>customFieldResponses will be optional from 2025-05-06.

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.

Release timeline

May 22, 2025

TripApi

`/v3/trips/arrangers/{arrangerId}/list`

`/v3/trips/companies/{companyId}/list`

`/v3/trips/users/{userId}/list`

May 19, 2025

EventApi

`/v2/events`

`/v2/events/list`

`/v2/events/read-by-external-id`

`/v2/events/{eventId}`

`/v2/events/{eventId}/custom-field-responses`

TripApi

`/v3/trips/{tripId}/detail`

`/v3/trips/{tripId}/pnrs`

`/v3/trips/{tripId}/pnrs/{pnrId}`

TemplateApi

`/v2/event-templates`

`/v2/event-templates/list`

`/v2/event-templates/read-by-external-id`

`/v2/event-templates/{templateId}`

`/v2/event-templates/{templateId}/custom-field-responses`

May 06, 2025

CompanyApi

`/v2/companies`

`/v2/companies/{companyId}`

April 16, 2025

AirApi

`/v3/air/company-credits/migrations`