Changelog
2026-09-07
Affiliate Manager
POST /affiliate-manager/affiliate-campaign/{locationId}/affiliate/{affiliateId}/move-campaign
- endpoint added
PUT /affiliate-manager/affiliate-campaign/{locationId}/affiliate/{affiliateId}/referral-id
- endpoint added
PUT /affiliate-manager/affiliate-campaign/{locationId}/campaign/{campaignId}/affiliate/{affiliateId}/suspension
- endpoint added
GET /affiliate-manager/affiliate-campaign/{locationId}/referral-id/validate
- endpoint added
GET /affiliate-manager/{locationId}/affiliate/{affiliateId}/payout-method
- endpoint added
POST /affiliate-manager/{locationId}/affiliate/{affiliateId}/payout-method
- endpoint added
DELETE /affiliate-manager/{locationId}/affiliate/{affiliateId}/payout-method/{payoutMethodId}
- endpoint added
PUT /affiliate-manager/{locationId}/affiliate/{affiliateId}/payout-method/{payoutMethodId}
- endpoint added
PATCH /affiliate-manager/{locationId}/affiliate/{affiliateId}/payout-method/{payoutMethodId}/primary
- endpoint added
GET /affiliate-manager/{locationId}/affiliates
- ⚠️ for the
queryrequest parameterlimit, the max was set to100.00 - ⚠️ for the
queryrequest parameterlimit, the min was set to0.00 - ⚠️ for the
queryrequest parameterskip, the min was set to0.00 - ⚠️ the
affiliates/items/createdByresponse's propertytypechanged fromobjecttoanyfor status200 - ⚠️ the
affiliates/items/lastUpdatedByresponse's propertytypechanged fromobjecttoanyfor status200 - added the optional property
affiliates/items/commissionTierto the response with the200status - added the optional property
affiliates/items/companyNameto the response with the200status - added the optional property
affiliates/items/companyPhoneNumberto the response with the200status - added the optional property
affiliates/items/countryto the response with the200status - added
#/components/schemas/AffiliateAuditResponseDtoto theaffiliates/items/createdByresponse propertyallOflist for the response status200 - added
#/components/schemas/AffiliateAuditResponseDtoto theaffiliates/items/lastUpdatedByresponse propertyallOflist for the response status200
POST /affiliate-manager/{locationId}/affiliates
- endpoint added
GET /affiliate-manager/{locationId}/affiliates/{affiliateId}
- ⚠️ the
createdByresponse's propertytypechanged fromobjecttoanyfor status200 - ⚠️ the
lastUpdatedByresponse's propertytypechanged fromobjecttoanyfor status200 - added the optional property
commissionTierto the response with the200status - added the optional property
companyNameto the response with the200status - added the optional property
companyPhoneNumberto the response with the200status - added the optional property
countryto the response with the200status - removed the optional property
clickCountfrom the response with the200status - removed the optional property
currencyfrom the response with the200status - removed the optional property
customerfrom the response with the200status - removed the optional property
droppedCustomerfrom the response with the200status - removed the optional property
leadfrom the response with the200status - removed the optional property
ownedfrom the response with the200status - removed the optional property
paidfrom the response with the200status - added
#/components/schemas/AffiliateAuditResponseDtoto thecreatedByresponse propertyallOflist for the response status200 - added
#/components/schemas/AffiliateAuditResponseDtoto thelastUpdatedByresponse propertyallOflist for the response status200
PUT /affiliate-manager/{locationId}/affiliates/{affiliateId}
- endpoint added
DELETE /affiliate-manager/{locationId}/affiliates/{affiliateId}/customer/{customerId}
- endpoint added
GET /affiliate-manager/{locationId}/affiliates/{affiliateId}/customers
- endpoint added
PATCH /affiliate-manager/{locationId}/affiliates/{affiliateId}/customers/{customerId}/state
- endpoint added
POST /affiliate-manager/{locationId}/affiliates/{affiliateId}/lead/create
- endpoint added
GET /affiliate-manager/{locationId}/affiliates/{affiliateId}/lead/validate
- endpoint added
PUT /affiliate-manager/{locationId}/affiliates/{affiliateId}/status
- endpoint added
POST /affiliate-manager/{locationId}/affiliates/{affiliateId}/tax-form
- endpoint added
GET /affiliate-manager/{locationId}/campaigns
- endpoint added
GET /affiliate-manager/{locationId}/campaigns/{campaignId}
- endpoint added
POST /affiliate-manager/{locationId}/commission
- endpoint added
DELETE /affiliate-manager/{locationId}/commission/{commissionId}
- endpoint added
PUT /affiliate-manager/{locationId}/commission/{commissionId}/deny
- endpoint added
PUT /affiliate-manager/{locationId}/commission/{commissionId}/status
- endpoint added
GET /affiliate-manager/{locationId}/commissions
- ⚠️ the
queryrequest parameterstatuswas restricted to a list of enum values - ⚠️ added the new
approvedenum value to thecommissions/items/statusresponse property for the response status200 - ⚠️ added the new
deniedenum value to thecommissions/items/statusresponse property for the response status200 - ⚠️ added the new
paidenum value to thecommissions/items/statusresponse property for the response status200 - ⚠️ added the new
pendingenum value to thecommissions/items/statusresponse property for the response status200 - added the new enum value
approvedto thequeryrequest parameterstatus - added the new enum value
deniedto thequeryrequest parameterstatus - added the new enum value
paidto thequeryrequest parameterstatus - added the new enum value
pendingto thequeryrequest parameterstatus
GET /affiliate-manager/{locationId}/country-bank-mapping
- endpoint added
GET /affiliate-manager/{locationId}/media
- endpoint added
DELETE /affiliate-manager/{locationId}/media/{mediaId}
- endpoint added
PUT /affiliate-manager/{locationId}/media/{mediaId}
- endpoint added
GET /affiliate-manager/{locationId}/payouts
- ⚠️ the
queryrequest parameterstatuswas restricted to a list of enum values - ⚠️ the
payouts/items/affiliate/allOf[#/components/schemas/OAuthAffiliateListItemResponseDto]/createdByresponse's propertytypechanged fromobjecttoanyfor status200 - ⚠️ the
payouts/items/affiliate/allOf[#/components/schemas/OAuthAffiliateListItemResponseDto]/lastUpdatedByresponse's propertytypechanged fromobjecttoanyfor status200 - added the new enum value
approvedto thequeryrequest parameterstatus - added the new enum value
deniedto thequeryrequest parameterstatus - added the new enum value
paidto thequeryrequest parameterstatus - added the new enum value
pendingto thequeryrequest parameterstatus - added the optional property
payouts/items/affiliate/allOf[#/components/schemas/OAuthAffiliateListItemResponseDto]/commissionTierto the response with the200status - added the optional property
payouts/items/affiliate/allOf[#/components/schemas/OAuthAffiliateListItemResponseDto]/companyNameto the response with the200status - added the optional property
payouts/items/affiliate/allOf[#/components/schemas/OAuthAffiliateListItemResponseDto]/companyPhoneNumberto the response with the200status - added the optional property
payouts/items/affiliate/allOf[#/components/schemas/OAuthAffiliateListItemResponseDto]/countryto the response with the200status - added
#/components/schemas/AffiliateAuditResponseDtoto thepayouts/items/affiliate/allOf[#/components/schemas/OAuthAffiliateListItemResponseDto]/createdByresponse propertyallOflist for the response status200 - added
#/components/schemas/AffiliateAuditResponseDtoto thepayouts/items/affiliate/allOf[#/components/schemas/OAuthAffiliateListItemResponseDto]/lastUpdatedByresponse propertyallOflist for the response status200
2026-08-25
Chat Widget
POST /chat-widget/
- ⚠️ request property
settings/allOf[#/components/schemas/WidgetSettingsDTO]/chatTypewas restricted to a list of enum values - ⚠️ request property
settings/allOf[#/components/schemas/WidgetSettingsDTO]/dimensions/allOf[#/components/schemas/WidgetSettingsCustomizationDTO]/positionwas restricted to a list of enum values - ⚠️ request property
settings/allOf[#/components/schemas/WidgetSettingsDTO]/localewas restricted to a list of enum values - ⚠️ request property
settings/allOf[#/components/schemas/WidgetSettingsDTO]/promptTypewas restricted to a list of enum values - ⚠️ request property
settings/allOf[#/components/schemas/WidgetSettingsDTO]/theme/allOf[#/components/schemas/WidgetSettingsThemeDTO]/namewas restricted to a list of enum values - ⚠️ request property
settings/allOf[#/components/schemas/WidgetSettingsDTO]/widgetPlacementwas restricted to a list of enum values - ⚠️ removed the request property
settings/allOf[#/components/schemas/WidgetSettingsDTO]/advanceSettings/allOf[#/components/schemas/AdvanceSettingsDTO]/aTwoPCompliance - ⚠️ removed the request property
settings/allOf[#/components/schemas/WidgetSettingsDTO]/useEmailField - ⚠️ removed the request property
settings/allOf[#/components/schemas/WidgetSettingsDTO]/widgetId - ⚠️ the
settings/allOf[#/components/schemas/WidgetSettingsDTO]/advanceSettings/allOf[#/components/schemas/AdvanceSettingsDTO]/businessOfficeHours/allOf[#/components/schemas/BusinessOfficeHoursDTO]/openHours/items/request propertytypechanged fromstringtoobject - ⚠️ the
settings/allOf[#/components/schemas/WidgetSettingsDTO]/advanceSettings/allOf[#/components/schemas/AdvanceSettingsDTO]/contactFormOptions/items/request propertytypechanged fromstringtoobject - added the new optional request property
settings/allOf[#/components/schemas/WidgetSettingsDTO]/advanceSettings/allOf[#/components/schemas/AdvanceSettingsDTO]/businessOfficeHours/allOf[#/components/schemas/BusinessOfficeHoursDTO]/openHours/items/daysOfTheWeek - added the new optional request property
settings/allOf[#/components/schemas/WidgetSettingsDTO]/advanceSettings/allOf[#/components/schemas/AdvanceSettingsDTO]/businessOfficeHours/allOf[#/components/schemas/BusinessOfficeHoursDTO]/openHours/items/hours - added the new optional request property
settings/allOf[#/components/schemas/WidgetSettingsDTO]/advanceSettings/allOf[#/components/schemas/AdvanceSettingsDTO]/contactFormOptions/items/dataType - added the new optional request property
settings/allOf[#/components/schemas/WidgetSettingsDTO]/advanceSettings/allOf[#/components/schemas/AdvanceSettingsDTO]/contactFormOptions/items/disabled - added the new optional request property
settings/allOf[#/components/schemas/WidgetSettingsDTO]/advanceSettings/allOf[#/components/schemas/AdvanceSettingsDTO]/contactFormOptions/items/fieldKey - added the new optional request property
settings/allOf[#/components/schemas/WidgetSettingsDTO]/advanceSettings/allOf[#/components/schemas/AdvanceSettingsDTO]/contactFormOptions/items/id - added the new optional request property
settings/allOf[#/components/schemas/WidgetSettingsDTO]/advanceSettings/allOf[#/components/schemas/AdvanceSettingsDTO]/contactFormOptions/items/label - added the new optional request property
settings/allOf[#/components/schemas/WidgetSettingsDTO]/advanceSettings/allOf[#/components/schemas/AdvanceSettingsDTO]/contactFormOptions/items/picklistOptions - added the new optional request property
settings/allOf[#/components/schemas/WidgetSettingsDTO]/advanceSettings/allOf[#/components/schemas/AdvanceSettingsDTO]/contactFormOptions/items/placeholder - added the new optional request property
settings/allOf[#/components/schemas/WidgetSettingsDTO]/advanceSettings/allOf[#/components/schemas/AdvanceSettingsDTO]/contactFormOptions/items/required - added the new optional request property
settings/allOf[#/components/schemas/WidgetSettingsDTO]/advanceSettings/allOf[#/components/schemas/AdvanceSettingsDTO]/contactFormOptions/items/value - added the new optional request property
settings/allOf[#/components/schemas/WidgetSettingsDTO]/theme/allOf[#/components/schemas/WidgetSettingsThemeDTO]/typography - added the new optional request property
settings/allOf[#/components/schemas/WidgetSettingsDTO]/theme/allOf[#/components/schemas/WidgetSettingsThemeDTO]/value - the request property
settings/allOf[#/components/schemas/WidgetSettingsDTO]/chatIconbecame optional - the request property
settings/allOf[#/components/schemas/WidgetSettingsDTO]/chatTypebecame optional - added the new
autoenum value to the request propertysettings/allOf[#/components/schemas/WidgetSettingsDTO]/locale - added the new
avatarenum value to the request propertysettings/allOf[#/components/schemas/WidgetSettingsDTO]/promptType - added the new
blueenum value to the request propertysettings/allOf[#/components/schemas/WidgetSettingsDTO]/theme/allOf[#/components/schemas/WidgetSettingsThemeDTO]/name - added the new
bottom-leftenum value to the request propertysettings/allOf[#/components/schemas/WidgetSettingsDTO]/dimensions/allOf[#/components/schemas/WidgetSettingsCustomizationDTO]/position - added the new
bottom-rightenum value to the request propertysettings/allOf[#/components/schemas/WidgetSettingsDTO]/dimensions/allOf[#/components/schemas/WidgetSettingsCustomizationDTO]/position - added the new
customenum value to the request propertysettings/allOf[#/components/schemas/WidgetSettingsDTO]/theme/allOf[#/components/schemas/WidgetSettingsThemeDTO]/name - added the new
da-dkenum value to the request propertysettings/allOf[#/components/schemas/WidgetSettingsDTO]/locale - added the new
deenum value to the request propertysettings/allOf[#/components/schemas/WidgetSettingsDTO]/locale - added the new
emailChatenum value to the request propertysettings/allOf[#/components/schemas/WidgetSettingsDTO]/chatType - added the new
embeddedenum value to the request propertysettings/allOf[#/components/schemas/WidgetSettingsDTO]/widgetPlacement - added the new
en-gbenum value to the request propertysettings/allOf[#/components/schemas/WidgetSettingsDTO]/locale - added the new
en-usenum value to the request propertysettings/allOf[#/components/schemas/WidgetSettingsDTO]/locale - added the new
esenum value to the request propertysettings/allOf[#/components/schemas/WidgetSettingsDTO]/locale - added the new
facebookenum value to the request propertysettings/allOf[#/components/schemas/WidgetSettingsDTO]/theme/allOf[#/components/schemas/WidgetSettingsThemeDTO]/name - added the new
fienum value to the request propertysettings/allOf[#/components/schemas/WidgetSettingsDTO]/locale - added the new
fr-caenum value to the request propertysettings/allOf[#/components/schemas/WidgetSettingsDTO]/locale - added the new
fr-frenum value to the request propertysettings/allOf[#/components/schemas/WidgetSettingsDTO]/locale - added the new
goldenenum value to the request propertysettings/allOf[#/components/schemas/WidgetSettingsDTO]/theme/allOf[#/components/schemas/WidgetSettingsThemeDTO]/name - added the new
hrenum value to the request propertysettings/allOf[#/components/schemas/WidgetSettingsDTO]/locale - added the new
huenum value to the request propertysettings/allOf[#/components/schemas/WidgetSettingsDTO]/locale - added the new
instagramenum value to the request propertysettings/allOf[#/components/schemas/WidgetSettingsDTO]/theme/allOf[#/components/schemas/WidgetSettingsThemeDTO]/name - added the new
itenum value to the request propertysettings/allOf[#/components/schemas/WidgetSettingsDTO]/locale - added the new
lavenderenum value to the request propertysettings/allOf[#/components/schemas/WidgetSettingsDTO]/theme/allOf[#/components/schemas/WidgetSettingsThemeDTO]/name - added the new
liveChatenum value to the request propertysettings/allOf[#/components/schemas/WidgetSettingsDTO]/chatType - added the new
locationenum value to the request propertysettings/allOf[#/components/schemas/WidgetSettingsDTO]/locale - added the new
middle-leftenum value to the request propertysettings/allOf[#/components/schemas/WidgetSettingsDTO]/dimensions/allOf[#/components/schemas/WidgetSettingsCustomizationDTO]/position - added the new
middle-rightenum value to the request propertysettings/allOf[#/components/schemas/WidgetSettingsDTO]/dimensions/allOf[#/components/schemas/WidgetSettingsCustomizationDTO]/position - added the new
nlenum value to the request propertysettings/allOf[#/components/schemas/WidgetSettingsDTO]/locale - added the new
noenum value to the request propertysettings/allOf[#/components/schemas/WidgetSettingsDTO]/locale - added the new
normalenum value to the request propertysettings/allOf[#/components/schemas/WidgetSettingsDTO]/promptType - added the new
pt-brenum value to the request propertysettings/allOf[#/components/schemas/WidgetSettingsDTO]/locale - added the new
pt-ptenum value to the request propertysettings/allOf[#/components/schemas/WidgetSettingsDTO]/locale - added the new
stickyenum value to the request propertysettings/allOf[#/components/schemas/WidgetSettingsDTO]/widgetPlacement - added the new
sv-seenum value to the request propertysettings/allOf[#/components/schemas/WidgetSettingsDTO]/locale - added the new
tanenum value to the request propertysettings/allOf[#/components/schemas/WidgetSettingsDTO]/theme/allOf[#/components/schemas/WidgetSettingsThemeDTO]/name - added the new
tealenum value to the request propertysettings/allOf[#/components/schemas/WidgetSettingsDTO]/theme/allOf[#/components/schemas/WidgetSettingsThemeDTO]/name - added the new
top-leftenum value to the request propertysettings/allOf[#/components/schemas/WidgetSettingsDTO]/dimensions/allOf[#/components/schemas/WidgetSettingsCustomizationDTO]/position - added the new
top-rightenum value to the request propertysettings/allOf[#/components/schemas/WidgetSettingsDTO]/dimensions/allOf[#/components/schemas/WidgetSettingsCustomizationDTO]/position - added
subschema #1, subschema #2to thesettings/allOf[#/components/schemas/WidgetSettingsDTO]/acknowledgementDetails/allOf[#/components/schemas/AcknowledgementDetailsDTO]/iconrequest propertyoneOflist - added
subschema #1, subschema #2to thesettings/allOf[#/components/schemas/WidgetSettingsDTO]/acknowledgementDetails/allOf[#/components/schemas/AcknowledgementDetailsDTO]/liveChatIconrequest propertyoneOflist - added
subschema #1, subschema #2to thesettings/allOf[#/components/schemas/WidgetSettingsDTO]/chatIconrequest propertyoneOflist - the
settings/allOf[#/components/schemas/WidgetSettingsDTO]/acknowledgementDetails/allOf[#/components/schemas/AcknowledgementDetailsDTO]/iconrequest propertytypewas widened fromstringtoany - the
settings/allOf[#/components/schemas/WidgetSettingsDTO]/acknowledgementDetails/allOf[#/components/schemas/AcknowledgementDetailsDTO]/liveChatIconrequest propertytypewas widened fromstringtoany - the
settings/allOf[#/components/schemas/WidgetSettingsDTO]/chatIconrequest propertytypewas widened fromstringtoany - added the media type
application/jsonfor the response with the status201
POST /chat-widget/clone
- added the media type
application/jsonfor the response with the status201
GET /chat-widget/data/{locationId}/{id}
- added the media type
application/jsonfor the response with the status200
PATCH /chat-widget/data/{locationId}/{id}
- ⚠️ request property
settings/allOf[#/components/schemas/WidgetSettingsDTO]/chatTypewas restricted to a list of enum values - ⚠️ request property
settings/allOf[#/components/schemas/WidgetSettingsDTO]/dimensions/allOf[#/components/schemas/WidgetSettingsCustomizationDTO]/positionwas restricted to a list of enum values - ⚠️ request property
settings/allOf[#/components/schemas/WidgetSettingsDTO]/localewas restricted to a list of enum values - ⚠️ request property
settings/allOf[#/components/schemas/WidgetSettingsDTO]/promptTypewas restricted to a list of enum values - ⚠️ request property
settings/allOf[#/components/schemas/WidgetSettingsDTO]/theme/allOf[#/components/schemas/WidgetSettingsThemeDTO]/namewas restricted to a list of enum values - ⚠️ request property
settings/allOf[#/components/schemas/WidgetSettingsDTO]/widgetPlacementwas restricted to a list of enum values - ⚠️ removed the request property
settings/allOf[#/components/schemas/WidgetSettingsDTO]/advanceSettings/allOf[#/components/schemas/AdvanceSettingsDTO]/aTwoPCompliance - ⚠️ removed the request property
settings/allOf[#/components/schemas/WidgetSettingsDTO]/useEmailField - ⚠️ removed the request property
settings/allOf[#/components/schemas/WidgetSettingsDTO]/widgetId - ⚠️ the
settings/allOf[#/components/schemas/WidgetSettingsDTO]/advanceSettings/allOf[#/components/schemas/AdvanceSettingsDTO]/businessOfficeHours/allOf[#/components/schemas/BusinessOfficeHoursDTO]/openHours/items/request propertytypechanged fromstringtoobject - ⚠️ the
settings/allOf[#/components/schemas/WidgetSettingsDTO]/advanceSettings/allOf[#/components/schemas/AdvanceSettingsDTO]/contactFormOptions/items/request propertytypechanged fromstringtoobject - added the new optional request property
settings/allOf[#/components/schemas/WidgetSettingsDTO]/advanceSettings/allOf[#/components/schemas/AdvanceSettingsDTO]/businessOfficeHours/allOf[#/components/schemas/BusinessOfficeHoursDTO]/openHours/items/daysOfTheWeek - added the new optional request property
settings/allOf[#/components/schemas/WidgetSettingsDTO]/advanceSettings/allOf[#/components/schemas/AdvanceSettingsDTO]/businessOfficeHours/allOf[#/components/schemas/BusinessOfficeHoursDTO]/openHours/items/hours - added the new optional request property
settings/allOf[#/components/schemas/WidgetSettingsDTO]/advanceSettings/allOf[#/components/schemas/AdvanceSettingsDTO]/contactFormOptions/items/dataType - added the new optional request property
settings/allOf[#/components/schemas/WidgetSettingsDTO]/advanceSettings/allOf[#/components/schemas/AdvanceSettingsDTO]/contactFormOptions/items/disabled - added the new optional request property
settings/allOf[#/components/schemas/WidgetSettingsDTO]/advanceSettings/allOf[#/components/schemas/AdvanceSettingsDTO]/contactFormOptions/items/fieldKey - added the new optional request property
settings/allOf[#/components/schemas/WidgetSettingsDTO]/advanceSettings/allOf[#/components/schemas/AdvanceSettingsDTO]/contactFormOptions/items/id - added the new optional request property
settings/allOf[#/components/schemas/WidgetSettingsDTO]/advanceSettings/allOf[#/components/schemas/AdvanceSettingsDTO]/contactFormOptions/items/label - added the new optional request property
settings/allOf[#/components/schemas/WidgetSettingsDTO]/advanceSettings/allOf[#/components/schemas/AdvanceSettingsDTO]/contactFormOptions/items/picklistOptions - added the new optional request property
settings/allOf[#/components/schemas/WidgetSettingsDTO]/advanceSettings/allOf[#/components/schemas/AdvanceSettingsDTO]/contactFormOptions/items/placeholder - added the new optional request property
settings/allOf[#/components/schemas/WidgetSettingsDTO]/advanceSettings/allOf[#/components/schemas/AdvanceSettingsDTO]/contactFormOptions/items/required - added the new optional request property
settings/allOf[#/components/schemas/WidgetSettingsDTO]/advanceSettings/allOf[#/components/schemas/AdvanceSettingsDTO]/contactFormOptions/items/value - added the new optional request property
settings/allOf[#/components/schemas/WidgetSettingsDTO]/theme/allOf[#/components/schemas/WidgetSettingsThemeDTO]/typography - added the new optional request property
settings/allOf[#/components/schemas/WidgetSettingsDTO]/theme/allOf[#/components/schemas/WidgetSettingsThemeDTO]/value - the request property
settings/allOf[#/components/schemas/WidgetSettingsDTO]/chatIconbecame optional - the request property
settings/allOf[#/components/schemas/WidgetSettingsDTO]/chatTypebecame optional - added the new
autoenum value to the request propertysettings/allOf[#/components/schemas/WidgetSettingsDTO]/locale - added the new
avatarenum value to the request propertysettings/allOf[#/components/schemas/WidgetSettingsDTO]/promptType - added the new
blueenum value to the request propertysettings/allOf[#/components/schemas/WidgetSettingsDTO]/theme/allOf[#/components/schemas/WidgetSettingsThemeDTO]/name - added the new
bottom-leftenum value to the request propertysettings/allOf[#/components/schemas/WidgetSettingsDTO]/dimensions/allOf[#/components/schemas/WidgetSettingsCustomizationDTO]/position - added the new
bottom-rightenum value to the request propertysettings/allOf[#/components/schemas/WidgetSettingsDTO]/dimensions/allOf[#/components/schemas/WidgetSettingsCustomizationDTO]/position - added the new
customenum value to the request propertysettings/allOf[#/components/schemas/WidgetSettingsDTO]/theme/allOf[#/components/schemas/WidgetSettingsThemeDTO]/name - added the new
da-dkenum value to the request propertysettings/allOf[#/components/schemas/WidgetSettingsDTO]/locale - added the new
deenum value to the request propertysettings/allOf[#/components/schemas/WidgetSettingsDTO]/locale - added the new
emailChatenum value to the request propertysettings/allOf[#/components/schemas/WidgetSettingsDTO]/chatType - added the new
embeddedenum value to the request propertysettings/allOf[#/components/schemas/WidgetSettingsDTO]/widgetPlacement - added the new
en-gbenum value to the request propertysettings/allOf[#/components/schemas/WidgetSettingsDTO]/locale - added the new
en-usenum value to the request propertysettings/allOf[#/components/schemas/WidgetSettingsDTO]/locale - added the new
esenum value to the request propertysettings/allOf[#/components/schemas/WidgetSettingsDTO]/locale - added the new
facebookenum value to the request propertysettings/allOf[#/components/schemas/WidgetSettingsDTO]/theme/allOf[#/components/schemas/WidgetSettingsThemeDTO]/name - added the new
fienum value to the request propertysettings/allOf[#/components/schemas/WidgetSettingsDTO]/locale - added the new
fr-caenum value to the request propertysettings/allOf[#/components/schemas/WidgetSettingsDTO]/locale - added the new
fr-frenum value to the request propertysettings/allOf[#/components/schemas/WidgetSettingsDTO]/locale - added the new
goldenenum value to the request propertysettings/allOf[#/components/schemas/WidgetSettingsDTO]/theme/allOf[#/components/schemas/WidgetSettingsThemeDTO]/name - added the new
hrenum value to the request propertysettings/allOf[#/components/schemas/WidgetSettingsDTO]/locale - added the new
huenum value to the request propertysettings/allOf[#/components/schemas/WidgetSettingsDTO]/locale - added the new
instagramenum value to the request propertysettings/allOf[#/components/schemas/WidgetSettingsDTO]/theme/allOf[#/components/schemas/WidgetSettingsThemeDTO]/name - added the new
itenum value to the request propertysettings/allOf[#/components/schemas/WidgetSettingsDTO]/locale - added the new
lavenderenum value to the request propertysettings/allOf[#/components/schemas/WidgetSettingsDTO]/theme/allOf[#/components/schemas/WidgetSettingsThemeDTO]/name - added the new
liveChatenum value to the request propertysettings/allOf[#/components/schemas/WidgetSettingsDTO]/chatType - added the new
locationenum value to the request propertysettings/allOf[#/components/schemas/WidgetSettingsDTO]/locale - added the new
middle-leftenum value to the request propertysettings/allOf[#/components/schemas/WidgetSettingsDTO]/dimensions/allOf[#/components/schemas/WidgetSettingsCustomizationDTO]/position - added the new
middle-rightenum value to the request propertysettings/allOf[#/components/schemas/WidgetSettingsDTO]/dimensions/allOf[#/components/schemas/WidgetSettingsCustomizationDTO]/position - added the new
nlenum value to the request propertysettings/allOf[#/components/schemas/WidgetSettingsDTO]/locale - added the new
noenum value to the request propertysettings/allOf[#/components/schemas/WidgetSettingsDTO]/locale - added the new
normalenum value to the request propertysettings/allOf[#/components/schemas/WidgetSettingsDTO]/promptType - added the new
pt-brenum value to the request propertysettings/allOf[#/components/schemas/WidgetSettingsDTO]/locale - added the new
pt-ptenum value to the request propertysettings/allOf[#/components/schemas/WidgetSettingsDTO]/locale - added the new
stickyenum value to the request propertysettings/allOf[#/components/schemas/WidgetSettingsDTO]/widgetPlacement - added the new
sv-seenum value to the request propertysettings/allOf[#/components/schemas/WidgetSettingsDTO]/locale - added the new
tanenum value to the request propertysettings/allOf[#/components/schemas/WidgetSettingsDTO]/theme/allOf[#/components/schemas/WidgetSettingsThemeDTO]/name - added the new
tealenum value to the request propertysettings/allOf[#/components/schemas/WidgetSettingsDTO]/theme/allOf[#/components/schemas/WidgetSettingsThemeDTO]/name - added the new
top-leftenum value to the request propertysettings/allOf[#/components/schemas/WidgetSettingsDTO]/dimensions/allOf[#/components/schemas/WidgetSettingsCustomizationDTO]/position - added the new
top-rightenum value to the request propertysettings/allOf[#/components/schemas/WidgetSettingsDTO]/dimensions/allOf[#/components/schemas/WidgetSettingsCustomizationDTO]/position - added
subschema #1, subschema #2to thesettings/allOf[#/components/schemas/WidgetSettingsDTO]/acknowledgementDetails/allOf[#/components/schemas/AcknowledgementDetailsDTO]/iconrequest propertyoneOflist - added
subschema #1, subschema #2to thesettings/allOf[#/components/schemas/WidgetSettingsDTO]/acknowledgementDetails/allOf[#/components/schemas/AcknowledgementDetailsDTO]/liveChatIconrequest propertyoneOflist - added
subschema #1, subschema #2to thesettings/allOf[#/components/schemas/WidgetSettingsDTO]/chatIconrequest propertyoneOflist - the
settings/allOf[#/components/schemas/WidgetSettingsDTO]/acknowledgementDetails/allOf[#/components/schemas/AcknowledgementDetailsDTO]/iconrequest propertytypewas widened fromstringtoany - the
settings/allOf[#/components/schemas/WidgetSettingsDTO]/acknowledgementDetails/allOf[#/components/schemas/AcknowledgementDetailsDTO]/liveChatIconrequest propertytypewas widened fromstringtoany - the
settings/allOf[#/components/schemas/WidgetSettingsDTO]/chatIconrequest propertytypewas widened fromstringtoany - added the media type
application/jsonfor the response with the status200
PUT /chat-widget/data/{locationId}/{id}
- ⚠️ request property
settings/allOf[#/components/schemas/WidgetSettingsDTO]/chatTypewas restricted to a list of enum values - ⚠️ request property
settings/allOf[#/components/schemas/WidgetSettingsDTO]/dimensions/allOf[#/components/schemas/WidgetSettingsCustomizationDTO]/positionwas restricted to a list of enum values - ⚠️ request property
settings/allOf[#/components/schemas/WidgetSettingsDTO]/localewas restricted to a list of enum values - ⚠️ request property
settings/allOf[#/components/schemas/WidgetSettingsDTO]/promptTypewas restricted to a list of enum values - ⚠️ request property
settings/allOf[#/components/schemas/WidgetSettingsDTO]/theme/allOf[#/components/schemas/WidgetSettingsThemeDTO]/namewas restricted to a list of enum values - ⚠️ request property
settings/allOf[#/components/schemas/WidgetSettingsDTO]/widgetPlacementwas restricted to a list of enum values - ⚠️ removed the request property
settings/allOf[#/components/schemas/WidgetSettingsDTO]/advanceSettings/allOf[#/components/schemas/AdvanceSettingsDTO]/aTwoPCompliance - ⚠️ removed the request property
settings/allOf[#/components/schemas/WidgetSettingsDTO]/useEmailField - ⚠️ removed the request property
settings/allOf[#/components/schemas/WidgetSettingsDTO]/widgetId - ⚠️ the
settings/allOf[#/components/schemas/WidgetSettingsDTO]/advanceSettings/allOf[#/components/schemas/AdvanceSettingsDTO]/businessOfficeHours/allOf[#/components/schemas/BusinessOfficeHoursDTO]/openHours/items/request propertytypechanged fromstringtoobject - ⚠️ the
settings/allOf[#/components/schemas/WidgetSettingsDTO]/advanceSettings/allOf[#/components/schemas/AdvanceSettingsDTO]/contactFormOptions/items/request propertytypechanged fromstringtoobject - added the new optional request property
settings/allOf[#/components/schemas/WidgetSettingsDTO]/advanceSettings/allOf[#/components/schemas/AdvanceSettingsDTO]/businessOfficeHours/allOf[#/components/schemas/BusinessOfficeHoursDTO]/openHours/items/daysOfTheWeek - added the new optional request property
settings/allOf[#/components/schemas/WidgetSettingsDTO]/advanceSettings/allOf[#/components/schemas/AdvanceSettingsDTO]/businessOfficeHours/allOf[#/components/schemas/BusinessOfficeHoursDTO]/openHours/items/hours - added the new optional request property
settings/allOf[#/components/schemas/WidgetSettingsDTO]/advanceSettings/allOf[#/components/schemas/AdvanceSettingsDTO]/contactFormOptions/items/dataType - added the new optional request property
settings/allOf[#/components/schemas/WidgetSettingsDTO]/advanceSettings/allOf[#/components/schemas/AdvanceSettingsDTO]/contactFormOptions/items/disabled - added the new optional request property
settings/allOf[#/components/schemas/WidgetSettingsDTO]/advanceSettings/allOf[#/components/schemas/AdvanceSettingsDTO]/contactFormOptions/items/fieldKey - added the new optional request property
settings/allOf[#/components/schemas/WidgetSettingsDTO]/advanceSettings/allOf[#/components/schemas/AdvanceSettingsDTO]/contactFormOptions/items/id - added the new optional request property
settings/allOf[#/components/schemas/WidgetSettingsDTO]/advanceSettings/allOf[#/components/schemas/AdvanceSettingsDTO]/contactFormOptions/items/label - added the new optional request property
settings/allOf[#/components/schemas/WidgetSettingsDTO]/advanceSettings/allOf[#/components/schemas/AdvanceSettingsDTO]/contactFormOptions/items/picklistOptions - added the new optional request property
settings/allOf[#/components/schemas/WidgetSettingsDTO]/advanceSettings/allOf[#/components/schemas/AdvanceSettingsDTO]/contactFormOptions/items/placeholder - added the new optional request property
settings/allOf[#/components/schemas/WidgetSettingsDTO]/advanceSettings/allOf[#/components/schemas/AdvanceSettingsDTO]/contactFormOptions/items/required - added the new optional request property
settings/allOf[#/components/schemas/WidgetSettingsDTO]/advanceSettings/allOf[#/components/schemas/AdvanceSettingsDTO]/contactFormOptions/items/value - added the new optional request property
settings/allOf[#/components/schemas/WidgetSettingsDTO]/theme/allOf[#/components/schemas/WidgetSettingsThemeDTO]/typography - added the new optional request property
settings/allOf[#/components/schemas/WidgetSettingsDTO]/theme/allOf[#/components/schemas/WidgetSettingsThemeDTO]/value - the request property
settings/allOf[#/components/schemas/WidgetSettingsDTO]/chatIconbecame optional - the request property
settings/allOf[#/components/schemas/WidgetSettingsDTO]/chatTypebecame optional - added the new
autoenum value to the request propertysettings/allOf[#/components/schemas/WidgetSettingsDTO]/locale - added the new
avatarenum value to the request propertysettings/allOf[#/components/schemas/WidgetSettingsDTO]/promptType - added the new
blueenum value to the request propertysettings/allOf[#/components/schemas/WidgetSettingsDTO]/theme/allOf[#/components/schemas/WidgetSettingsThemeDTO]/name - added the new
bottom-leftenum value to the request propertysettings/allOf[#/components/schemas/WidgetSettingsDTO]/dimensions/allOf[#/components/schemas/WidgetSettingsCustomizationDTO]/position - added the new
bottom-rightenum value to the request propertysettings/allOf[#/components/schemas/WidgetSettingsDTO]/dimensions/allOf[#/components/schemas/WidgetSettingsCustomizationDTO]/position - added the new
customenum value to the request propertysettings/allOf[#/components/schemas/WidgetSettingsDTO]/theme/allOf[#/components/schemas/WidgetSettingsThemeDTO]/name - added the new
da-dkenum value to the request propertysettings/allOf[#/components/schemas/WidgetSettingsDTO]/locale - added the new
deenum value to the request propertysettings/allOf[#/components/schemas/WidgetSettingsDTO]/locale - added the new
emailChatenum value to the request propertysettings/allOf[#/components/schemas/WidgetSettingsDTO]/chatType - added the new
embeddedenum value to the request propertysettings/allOf[#/components/schemas/WidgetSettingsDTO]/widgetPlacement - added the new
en-gbenum value to the request propertysettings/allOf[#/components/schemas/WidgetSettingsDTO]/locale - added the new
en-usenum value to the request propertysettings/allOf[#/components/schemas/WidgetSettingsDTO]/locale - added the new
esenum value to the request propertysettings/allOf[#/components/schemas/WidgetSettingsDTO]/locale - added the new
facebookenum value to the request propertysettings/allOf[#/components/schemas/WidgetSettingsDTO]/theme/allOf[#/components/schemas/WidgetSettingsThemeDTO]/name - added the new
fienum value to the request propertysettings/allOf[#/components/schemas/WidgetSettingsDTO]/locale - added the new
fr-caenum value to the request propertysettings/allOf[#/components/schemas/WidgetSettingsDTO]/locale - added the new
fr-frenum value to the request propertysettings/allOf[#/components/schemas/WidgetSettingsDTO]/locale - added the new
goldenenum value to the request propertysettings/allOf[#/components/schemas/WidgetSettingsDTO]/theme/allOf[#/components/schemas/WidgetSettingsThemeDTO]/name - added the new
hrenum value to the request propertysettings/allOf[#/components/schemas/WidgetSettingsDTO]/locale - added the new
huenum value to the request propertysettings/allOf[#/components/schemas/WidgetSettingsDTO]/locale - added the new
instagramenum value to the request propertysettings/allOf[#/components/schemas/WidgetSettingsDTO]/theme/allOf[#/components/schemas/WidgetSettingsThemeDTO]/name - added the new
itenum value to the request propertysettings/allOf[#/components/schemas/WidgetSettingsDTO]/locale - added the new
lavenderenum value to the request propertysettings/allOf[#/components/schemas/WidgetSettingsDTO]/theme/allOf[#/components/schemas/WidgetSettingsThemeDTO]/name - added the new
liveChatenum value to the request propertysettings/allOf[#/components/schemas/WidgetSettingsDTO]/chatType - added the new
locationenum value to the request propertysettings/allOf[#/components/schemas/WidgetSettingsDTO]/locale - added the new
middle-leftenum value to the request propertysettings/allOf[#/components/schemas/WidgetSettingsDTO]/dimensions/allOf[#/components/schemas/WidgetSettingsCustomizationDTO]/position - added the new
middle-rightenum value to the request propertysettings/allOf[#/components/schemas/WidgetSettingsDTO]/dimensions/allOf[#/components/schemas/WidgetSettingsCustomizationDTO]/position - added the new
nlenum value to the request propertysettings/allOf[#/components/schemas/WidgetSettingsDTO]/locale - added the new
noenum value to the request propertysettings/allOf[#/components/schemas/WidgetSettingsDTO]/locale - added the new
normalenum value to the request propertysettings/allOf[#/components/schemas/WidgetSettingsDTO]/promptType - added the new
pt-brenum value to the request propertysettings/allOf[#/components/schemas/WidgetSettingsDTO]/locale - added the new
pt-ptenum value to the request propertysettings/allOf[#/components/schemas/WidgetSettingsDTO]/locale - added the new
stickyenum value to the request propertysettings/allOf[#/components/schemas/WidgetSettingsDTO]/widgetPlacement - added the new
sv-seenum value to the request propertysettings/allOf[#/components/schemas/WidgetSettingsDTO]/locale - added the new
tanenum value to the request propertysettings/allOf[#/components/schemas/WidgetSettingsDTO]/theme/allOf[#/components/schemas/WidgetSettingsThemeDTO]/name - added the new
tealenum value to the request propertysettings/allOf[#/components/schemas/WidgetSettingsDTO]/theme/allOf[#/components/schemas/WidgetSettingsThemeDTO]/name - added the new
top-leftenum value to the request propertysettings/allOf[#/components/schemas/WidgetSettingsDTO]/dimensions/allOf[#/components/schemas/WidgetSettingsCustomizationDTO]/position - added the new
top-rightenum value to the request propertysettings/allOf[#/components/schemas/WidgetSettingsDTO]/dimensions/allOf[#/components/schemas/WidgetSettingsCustomizationDTO]/position - added
subschema #1, subschema #2to thesettings/allOf[#/components/schemas/WidgetSettingsDTO]/acknowledgementDetails/allOf[#/components/schemas/AcknowledgementDetailsDTO]/iconrequest propertyoneOflist - added
subschema #1, subschema #2to thesettings/allOf[#/components/schemas/WidgetSettingsDTO]/acknowledgementDetails/allOf[#/components/schemas/AcknowledgementDetailsDTO]/liveChatIconrequest propertyoneOflist - added
subschema #1, subschema #2to thesettings/allOf[#/components/schemas/WidgetSettingsDTO]/chatIconrequest propertyoneOflist - the
settings/allOf[#/components/schemas/WidgetSettingsDTO]/acknowledgementDetails/allOf[#/components/schemas/AcknowledgementDetailsDTO]/iconrequest propertytypewas widened fromstringtoany - the
settings/allOf[#/components/schemas/WidgetSettingsDTO]/acknowledgementDetails/allOf[#/components/schemas/AcknowledgementDetailsDTO]/liveChatIconrequest propertytypewas widened fromstringtoany - the
settings/allOf[#/components/schemas/WidgetSettingsDTO]/chatIconrequest propertytypewas widened fromstringtoany - added the media type
application/jsonfor the response with the status200
GET /chat-widget/list
- added the media type
application/jsonfor the response with the status200
DELETE /chat-widget/{locationId}/{id}
- added the media type
application/jsonfor the response with the status200
Components
- added the schema
BadRequestDTO - added the schema
ChatWidgetDTO - added the schema
ChatWidgetListItemDTO - added the schema
ChatWidgetListResponseDTO - added the schema
ContactFormOptionsDTO - added the schema
InvalidLocationDTO - added the schema
NotFoundDTO - added the schema
OpenHoursDTO - added the schema
UnauthorizedDTO - added the schema
UnprocessableDTO - added the schema
WidgetSettingsTypographyColorDTO - added the schema
WidgetSettingsTypographyDTO - removed the schema
A2PComplianceDTO
2026-08-21
Ad Publishing
GET /ad-publishing/facebook/ad-accounts
- added the media type
application/jsonfor the response with the status200
DELETE /ad-publishing/facebook/ad-accounts/{adAccountId}
- added the media type
application/jsonfor the response with the status200
GET /ad-publishing/facebook/ad-accounts/{adAccountId}
- added the media type
application/jsonfor the response with the status200
PUT /ad-publishing/facebook/ads
- added the media type
application/jsonfor the response with the status200
DELETE /ad-publishing/facebook/ads/{adId}
- added the media type
application/jsonfor the response with the status200
POST /ad-publishing/facebook/ads/{adId}/duplicate
- ⚠️ removed the success response with the status
201 - added the success response with the status
200
POST /ad-publishing/facebook/ads/{adId}/pause
- ⚠️ removed the success response with the status
201 - added the success response with the status
200
POST /ad-publishing/facebook/ads/{adId}/resume
- ⚠️ removed the success response with the status
201 - added the success response with the status
200
PUT /ad-publishing/facebook/adsets
- added the media type
application/jsonfor the response with the status200
DELETE /ad-publishing/facebook/adsets/{adSetId}
- added the media type
application/jsonfor the response with the status200
POST /ad-publishing/facebook/adsets/{adSetId}/duplicate
- ⚠️ removed the success response with the status
201 - added the success response with the status
200
POST /ad-publishing/facebook/adsets/{adSetId}/pause
- ⚠️ removed the success response with the status
201 - added the success response with the status
200
POST /ad-publishing/facebook/adsets/{adSetId}/resume
- ⚠️ removed the success response with the status
201 - added the success response with the status
200
GET /ad-publishing/facebook/campaign/{campaignId}
- added the media type
application/jsonfor the response with the status200
PUT /ad-publishing/facebook/campaigns
- added the media type
application/jsonfor the response with the status200
DELETE /ad-publishing/facebook/campaigns/{campaignId}
- added the media type
application/jsonfor the response with the status200
POST /ad-publishing/facebook/campaigns/{campaignId}/duplicate
- ⚠️ removed the success response with the status
201 - added the success response with the status
200
POST /ad-publishing/facebook/campaigns/{campaignId}/pause
- ⚠️ removed the success response with the status
201 - added the success response with the status
200
POST /ad-publishing/facebook/campaigns/{campaignId}/publish
- ⚠️ removed the success response with the status
201 - added the success response with the status
200
POST /ad-publishing/facebook/campaigns/{campaignId}/resume
- ⚠️ removed the success response with the status
201 - added the success response with the status
200
GET /ad-publishing/facebook/conversation-forms
- added the required property
oneOf[#/components/schemas/PaginatedFacebookConversationFormsDTO]/conversationForms/items/createdAtto the response with the200status - added the required property
oneOf[#/components/schemas/PaginatedFacebookConversationFormsDTO]/conversationForms/items/idto the response with the200status - added the required property
oneOf[#/components/schemas/PaginatedFacebookConversationFormsDTO]/conversationForms/items/locationIdto the response with the200status - added the required property
oneOf[#/components/schemas/PaginatedFacebookConversationFormsDTO]/conversationForms/items/nameto the response with the200status - added the required property
oneOf[#/components/schemas/PaginatedFacebookConversationFormsDTO]/conversationForms/items/questionsto the response with the200status - added the required property
oneOf[#/components/schemas/PaginatedFacebookConversationFormsDTO]/conversationForms/items/textto the response with the200status - added the required property
oneOf[#/components/schemas/PaginatedFacebookConversationFormsDTO]/conversationForms/items/updatedAtto the response with the200status - added the required property
oneOf[subschema #1]/items/createdAtto the response with the200status - added the required property
oneOf[subschema #1]/items/idto the response with the200status - added the required property
oneOf[subschema #1]/items/locationIdto the response with the200status - added the required property
oneOf[subschema #1]/items/nameto the response with the200status - added the required property
oneOf[subschema #1]/items/questionsto the response with the200status - added the required property
oneOf[subschema #1]/items/textto the response with the200status - added the required property
oneOf[subschema #1]/items/updatedAtto the response with the200status
POST /ad-publishing/facebook/conversation-forms
- added the media type
application/jsonfor the response with the status201
GET /ad-publishing/facebook/custom-audience
- added the optional property
oneOf[subschema #1]/items/approximateCountLowerBoundto the response with the200status - added the optional property
oneOf[subschema #1]/items/approximateCountUpperBoundto the response with the200status - added the optional property
oneOf[subschema #1]/items/dataSourceto the response with the200status - added the optional property
oneOf[subschema #1]/items/deliveryStatusto the response with the200status - added the optional property
oneOf[subschema #1]/items/descriptionto the response with the200status - added the optional property
oneOf[subschema #1]/items/idto the response with the200status - added the optional property
oneOf[subschema #1]/items/nameto the response with the200status - added the optional property
oneOf[subschema #1]/items/operationStatusto the response with the200status - added the optional property
oneOf[subschema #1]/items/subtypeto the response with the200status - added the optional property
oneOf[subschema #1]/items/timeCreatedto the response with the200status - added the optional property
oneOf[subschema #1]/items/timeUpdatedto the response with the200status
DELETE /ad-publishing/facebook/custom-audience/{audienceId}
- added the media type
application/jsonfor the response with the status200
GET /ad-publishing/facebook/custom-audience/{audienceId}
- added the media type
application/jsonfor the response with the status200
PUT /ad-publishing/facebook/custom-audience/{audienceId}
- added the media type
application/jsonfor the response with the status200
DELETE /ad-publishing/facebook/custom-audience/{audienceId}/member
- added the media type
application/jsonfor the response with the status200
PUT /ad-publishing/facebook/custom-audience/{audienceId}/member
- added the media type
application/jsonfor the response with the status200
PUT /ad-publishing/facebook/custom-audience/{audienceId}/member/batch
- added the media type
application/jsonfor the response with the status200
GET /ad-publishing/facebook/entity
- added the media type
application/jsonfor the response with the status200
DELETE /ad-publishing/facebook/integration
- added the media type
application/jsonfor the response with the status200
GET /ad-publishing/facebook/integration
- added the media type
application/jsonfor the response with the status200
POST /ad-publishing/facebook/integration
- ⚠️ removed the success response with the status
201 - added the success response with the status
200
GET /ad-publishing/facebook/lead-form/{leadFormId}
- added the media type
application/jsonfor the response with the status200
GET /ad-publishing/facebook/me
- added the media type
application/jsonfor the response with the status200
DELETE /ad-publishing/facebook/page
- added the media type
application/jsonfor the response with the status200
PUT /ad-publishing/facebook/page/default
- added the media type
application/jsonfor the response with the status200
GET /ad-publishing/facebook/page/{pageId}/forms
- ⚠️ added
#/components/schemas/FacebookPublishedLeadFormDTO, #/components/schemas/FacebookDraftLeadFormDTOto theoneOf[subschema #1]/items/response propertyoneOflist for the response status200 - ⚠️ the
oneOf[subschema #1]/items/response's propertytypechanged fromobjecttoanyfor status200
POST /ad-publishing/facebook/page/{pageId}/forms
- added the media type
application/jsonfor the response with the status201
GET /ad-publishing/facebook/page/{pageId}/instagram
- added the media type
application/jsonfor the response with the status200
GET /ad-publishing/facebook/pixels
- ⚠️ added
#/components/schemas/FacebookConversionPixelListDTOto the response bodyoneOflist for the response status200 - ⚠️ the
oneOf[subschema #1 -> subschema #3]/response's propertytypechanged fromobjecttoarray<object>for status200 - added the optional property
oneOf[#/components/schemas/PaginatedFacebookPixelsDTO]/items/items/createdAtto the response with the200status - added the optional property
oneOf[#/components/schemas/PaginatedFacebookPixelsDTO]/items/items/fbIsCrmPixelto the response with the200status - added the optional property
oneOf[#/components/schemas/PaginatedFacebookPixelsDTO]/items/items/fbPixelCodeto the response with the200status - added the optional property
oneOf[#/components/schemas/PaginatedFacebookPixelsDTO]/items/items/fbPixelIdto the response with the200status - added the optional property
oneOf[#/components/schemas/PaginatedFacebookPixelsDTO]/items/items/nameto the response with the200status - added the optional property
oneOf[#/components/schemas/PaginatedFacebookPixelsDTO]/items/items/typeto the response with the200status
PUT /ad-publishing/facebook/pixels
- added the media type
application/jsonfor the response with the status200
GET /ad-publishing/facebook/reporting
- added the media type
application/jsonfor the response with the status200
GET /ad-publishing/facebook/reporting/campaign/{campaignId}
- added the media type
application/jsonfor the response with the status200
GET /ad-publishing/facebook/reporting/list
- added the media type
application/jsonfor the response with the status200
GET /ad-publishing/facebook/targeting/search
- added the media type
application/jsonfor the response with the status200
GET /ad-publishing/google/ad-accounts
- added the media type
application/jsonfor the response with the status200
DELETE /ad-publishing/google/ad-accounts/{adAccountId}
- added the media type
application/jsonfor the response with the status200
GET /ad-publishing/google/ad-accounts/{adAccountId}
- added the media type
application/jsonfor the response with the status200
PUT /ad-publishing/google/ads
- ⚠️ the request property
audience/allOf[#/components/schemas/GoogleCampaignAudienceDTO]/geoLocationsbecame required - ⚠️ the request property
audience/allOf[#/components/schemas/GoogleCampaignAudienceDTO]/localesbecame required - ⚠️ the request property
audience/allOf[#/components/schemas/GoogleCampaignAudienceDTO]/targetInterests/allOf[#/components/schemas/GoogleTargetInterestsDTO]/affinitybecame required - ⚠️ the request property
audience/allOf[#/components/schemas/GoogleCampaignAudienceDTO]/targetInterests/allOf[#/components/schemas/GoogleTargetInterestsDTO]/inMarketbecame required - ⚠️ removed the request property
audience/allOf[#/components/schemas/GoogleCampaignAudienceDTO]/segments/items/id - ⚠️ removed the request property
audience/allOf[#/components/schemas/GoogleCampaignAudienceDTO]/segments/items/type - ⚠️ the
audience/allOf[#/components/schemas/GoogleCampaignAudienceDTO]/segments/items/request propertytypechanged fromobjecttostring - added the media type
application/jsonfor the response with the status200
GET /ad-publishing/google/ads/{adId}
- added the media type
application/jsonfor the response with the status200
POST /ad-publishing/google/ads/{adId}/publish
- ⚠️ removed the success response with the status
201 - added the success response with the status
200
GET /ad-publishing/google/ads/{adId}/publishing-progress
- endpoint added
POST /ad-publishing/google/assets
- ⚠️ removed the success response with the status
201 - added the success response with the status
200
GET /ad-publishing/google/audiences
- added the required property
oneOf[#/components/schemas/PaginatedGoogleAudiencesDTO]/audiences/items/dimensionsto the response with the200status - added the required property
oneOf[#/components/schemas/PaginatedGoogleAudiencesDTO]/audiences/items/exclusionDimensionto the response with the200status - added the required property
oneOf[#/components/schemas/PaginatedGoogleAudiencesDTO]/audiences/items/idto the response with the200status - added the required property
oneOf[#/components/schemas/PaginatedGoogleAudiencesDTO]/audiences/items/nameto the response with the200status - added the required property
oneOf[#/components/schemas/PaginatedGoogleAudiencesDTO]/audiences/items/resourceNameto the response with the200status - added the required property
oneOf[#/components/schemas/PaginatedGoogleAudiencesDTO]/audiences/items/scopeto the response with the200status - added the required property
oneOf[#/components/schemas/PaginatedGoogleAudiencesDTO]/audiences/items/statusto the response with the200status - added the required property
oneOf[subschema #1]/items/dimensionsto the response with the200status - added the required property
oneOf[subschema #1]/items/exclusionDimensionto the response with the200status - added the required property
oneOf[subschema #1]/items/idto the response with the200status - added the required property
oneOf[subschema #1]/items/nameto the response with the200status - added the required property
oneOf[subschema #1]/items/resourceNameto the response with the200status - added the required property
oneOf[subschema #1]/items/scopeto the response with the200status - added the required property
oneOf[subschema #1]/items/statusto the response with the200status
PUT /ad-publishing/google/audiences
- added the media type
application/jsonfor the response with the status200
GET /ad-publishing/google/audiences/{audienceId}
- added the media type
application/jsonfor the response with the status200
GET /ad-publishing/google/conversions
- added the media type
application/jsonfor the response with the status200
PUT /ad-publishing/google/conversions
- added the media type
application/jsonfor the response with the status200
DELETE /ad-publishing/google/conversions/{conversionId}
- added the media type
application/jsonfor the response with the status200
GET /ad-publishing/google/conversions/{conversionId}
- added the media type
application/jsonfor the response with the status200
GET /ad-publishing/google/entity
- added the media type
application/jsonfor the response with the status200
GET /ad-publishing/google/integration
- added the media type
application/jsonfor the response with the status200
POST /ad-publishing/google/integration
- ⚠️ removed the success response with the status
201 - added the success response with the status
200
POST /ad-publishing/google/keyword-ideas
- ⚠️ removed the success response with the status
201 - added the success response with the status
200
GET /ad-publishing/google/me
- added the media type
application/jsonfor the response with the status200
GET /ad-publishing/google/reporting
- added the media type
application/jsonfor the response with the status200
GET /ad-publishing/google/reporting/campaign/{campaignId}
- added the media type
application/jsonfor the response with the status200
GET /ad-publishing/google/reporting/list
- added the media type
application/jsonfor the response with the status200
GET /ad-publishing/google/segments
- ⚠️ added
#/components/schemas/GoogleCustomSegmentSummaryDTO, #/components/schemas/GoogleDataSegmentDTOto theoneOf[#/components/schemas/PaginatedGoogleSegmentsDTO]/segments/items/response propertyoneOflist for the response status200 - ⚠️ added
#/components/schemas/GoogleCustomSegmentSummaryDTO, #/components/schemas/GoogleDataSegmentDTOto theoneOf[subschema #1]/items/response propertyoneOflist for the response status200 - ⚠️ the
oneOf[#/components/schemas/PaginatedGoogleSegmentsDTO]/segments/items/response's propertytypechanged fromobjecttoanyfor status200 - ⚠️ the
oneOf[subschema #1]/items/response's propertytypechanged fromobjecttoanyfor status200
PUT /ad-publishing/google/segments
- added the media type
application/jsonfor the response with the status200
POST /ad-publishing/google/segments/offline-user-list-job
- ⚠️ removed the success response with the status
201 - added the success response with the status
200
DELETE /ad-publishing/google/segments/{segmentId}
- added the media type
application/jsonfor the response with the status200
GET /ad-publishing/google/segments/{segmentId}
- added the media type
application/jsonfor the response with the status200
GET /ad-publishing/google/targeting/search
- added the media type
application/jsonfor the response with the status200
DELETE /ad-publishing/linkedin/ad-account
- added the media type
application/jsonfor the response with the status200
GET /ad-publishing/linkedin/ad-account
- added the media type
application/jsonfor the response with the status200
GET /ad-publishing/linkedin/ad-accounts
- added the media type
application/jsonfor the response with the status200
PUT /ad-publishing/linkedin/ads
- ⚠️ added the new required request property
adCampaigns/items/ads/items/createdAt - ⚠️ added the new required request property
adCampaigns/items/ads/items/updatedAt - ⚠️ the request property
adCampaigns/items/ads/items/adCampaignGroupIdbecame required - ⚠️ the request property
adCampaigns/items/ads/items/adCampaignIdbecame required - ⚠️ the request property
adCampaigns/items/ads/items/callToActionLabelbecame required - ⚠️ the request property
adCampaigns/items/ads/items/descriptionbecame required - ⚠️ the request property
adCampaigns/items/ads/items/destinationFormIdbecame required - ⚠️ the request property
adCampaigns/items/ads/items/destinationUrlbecame required - ⚠️ the request property
adCampaigns/items/ads/items/idbecame required - ⚠️ the request property
adCampaigns/items/ads/items/introductoryTextbecame required - ⚠️ the request property
adCampaigns/items/ads/items/linkedInErrorbecame required - ⚠️ the request property
adCampaigns/items/ads/items/mediabecame required - ⚠️ the request property
adCampaigns/items/ads/items/media/items/namebecame required - ⚠️ the request property
adCampaigns/items/ads/items/media/items/srcbecame required - ⚠️ the request property
adCampaigns/items/ads/items/media/items/typebecame required - ⚠️ the request property
adCampaigns/items/ads/items/namebecame required - ⚠️ the request property
adCampaigns/items/ads/items/publishingStatusbecame required - ⚠️ the request property
budget/allOf[#/components/schemas/LinkedInBudgetDTO]/amountbecame required - ⚠️ the request property
budget/allOf[#/components/schemas/LinkedInBudgetDTO]/budgetTypebecame required - ⚠️ removed the enum value
ARCHIVEDof the request propertyadCampaigns/items/ads/items/publishingStatus - ⚠️ removed the enum value
DRAFTof the request propertyadCampaigns/items/ads/items/publishingStatus - ⚠️ removed the enum value
FAILEDof the request propertyadCampaigns/items/ads/items/publishingStatus - ⚠️ removed the enum value
IN_REVIEWof the request propertyadCampaigns/items/ads/items/publishingStatus - ⚠️ removed the enum value
PAUSEDof the request propertyadCampaigns/items/ads/items/publishingStatus - ⚠️ removed the enum value
PUBLISHEDof the request propertyadCampaigns/items/ads/items/publishingStatus - ⚠️ removed the enum value
PUBLISHINGof the request propertyadCampaigns/items/ads/items/publishingStatus - ⚠️ removed the enum value
REJECTEDof the request propertyadCampaigns/items/ads/items/publishingStatus - ⚠️ removed the enum value
SCHEDULEDof the request propertyadCampaigns/items/ads/items/publishingStatus - ⚠️ removed the enum value
WITH_ISSUESof the request propertyadCampaigns/items/ads/items/publishingStatus - ⚠️ removed the enum value
imageof the request propertyadCampaigns/items/ads/items/media/items/type - ⚠️ removed the enum value
videoof the request propertyadCampaigns/items/ads/items/media/items/type - ⚠️ removed the request property
adCampaigns/items/ads/items/headline - ⚠️ removed the request property
adCampaigns/items/ads/items/media/items/frames - ⚠️ removed the request property
adCampaigns/items/ads/items/media/items/selectedPoster - ⚠️ removed the request property
adCampaigns/items/ads/items/media/items/thumbnailUrl - ⚠️ removed the request property
adCampaigns/items/ads/items/meta - added the new optional request property
adCampaigns/items/ads/items/media/items/_id - added the new optional request property
adCampaigns/items/ads/items/media/items/urn - added the media type
application/jsonfor the response with the status200
GET /ad-publishing/linkedin/ads/{adId}
- added the media type
application/jsonfor the response with the status200
POST /ad-publishing/linkedin/ads/{adId}/publish
- ⚠️ removed the success response with the status
201 - added the success response with the status
200
GET /ad-publishing/linkedin/integration
- added the media type
application/jsonfor the response with the status200
POST /ad-publishing/linkedin/integration
- ⚠️ removed the success response with the status
201 - added the success response with the status
200
GET /ad-publishing/linkedin/me
- added the media type
application/jsonfor the response with the status200
GET /ad-publishing/linkedin/reporting
- added the media type
application/jsonfor the response with the status200
GET /ad-publishing/linkedin/reporting/campaign-group/{campaignGroupId}
- added the media type
application/jsonfor the response with the status200
GET /ad-publishing/linkedin/reporting/list
- added the media type
application/jsonfor the response with the status200
GET /ad-publishing/linkedin/targeting/search
- added the media type
application/jsonfor the response with the status200
POST /ad-publishing/linkedin/{accountId}/form
- ⚠️ removed the success response with the status
201 - added the success response with the status
200
GET /ad-publishing/linkedin/{accountId}/forms
- added the optional property
oneOf[#/components/schemas/PaginatedLinkedInLeadFormsDTO]/leadForms/items/contentto the response with the200status - added the optional property
oneOf[#/components/schemas/PaginatedLinkedInLeadFormsDTO]/leadForms/items/createdto the response with the200status - added the optional property
oneOf[#/components/schemas/PaginatedLinkedInLeadFormsDTO]/leadForms/items/creationLocaleto the response with the200status - added the optional property
oneOf[#/components/schemas/PaginatedLinkedInLeadFormsDTO]/leadForms/items/hiddenFieldsto the response with the200status - added the optional property
oneOf[#/components/schemas/PaginatedLinkedInLeadFormsDTO]/leadForms/items/idto the response with the200status - added the optional property
oneOf[#/components/schemas/PaginatedLinkedInLeadFormsDTO]/leadForms/items/lastModifiedto the response with the200status - added the optional property
oneOf[#/components/schemas/PaginatedLinkedInLeadFormsDTO]/leadForms/items/nameto the response with the200status - added the optional property
oneOf[#/components/schemas/PaginatedLinkedInLeadFormsDTO]/leadForms/items/ownerto the response with the200status - added the optional property
oneOf[#/components/schemas/PaginatedLinkedInLeadFormsDTO]/leadForms/items/reviewInfoto the response with the200status - added the optional property
oneOf[#/components/schemas/PaginatedLinkedInLeadFormsDTO]/leadForms/items/stateto the response with the200status - added the optional property
oneOf[#/components/schemas/PaginatedLinkedInLeadFormsDTO]/leadForms/items/versionIdto the response with the200status - added the optional property
oneOf[subschema #1]/items/contentto the response with the200status - added the optional property
oneOf[subschema #1]/items/createdto the response with the200status - added the optional property
oneOf[subschema #1]/items/creationLocaleto the response with the200status - added the optional property
oneOf[subschema #1]/items/hiddenFieldsto the response with the200status - added the optional property
oneOf[subschema #1]/items/idto the response with the200status - added the optional property
oneOf[subschema #1]/items/lastModifiedto the response with the200status - added the optional property
oneOf[subschema #1]/items/nameto the response with the200status - added the optional property
oneOf[subschema #1]/items/ownerto the response with the200status - added the optional property
oneOf[subschema #1]/items/reviewInfoto the response with the200status - added the optional property
oneOf[subschema #1]/items/stateto the response with the200status - added the optional property
oneOf[subschema #1]/items/versionIdto the response with the200status
PATCH /ad-publishing/linkedin/{adId}/status
- added the media type
application/jsonfor the response with the status200
Components
- removed the schema
GoogleSegmentTargetDTO - removed the schema
LinkedInMediaDTO
2026-08-18
Knowledge Base
Backward compatible
We have made changes to rename the Knowledge Base endpoint path prefix from /knowledge-base to /knowledge-bases. This change is backward compatible — both the existing /knowledge-base endpoints and the new /knowledge-bases endpoints continue to work, so no action is required. New integrations should use /knowledge-bases.
2026-08-13
Ad Publishing
GET /ad-publishing/facebook/ad-accounts
- ⚠️ the
queryrequest parametertypewas restricted to a list of enum values - added the new enum value
AD_MANAGERto thequeryrequest parametertype - added the new enum value
INTEGRATIONto thequeryrequest parametertype
GET /ad-publishing/facebook/ad-accounts/{adAccountId}
- ⚠️ deleted the
queryrequest parameterisDraft
PUT /ad-publishing/facebook/ads
- added the new optional request property
descriptions - added the new optional request property
headlines - added the new optional request property
primaryTexts
GET /ad-publishing/facebook/campaigns/{campaignId}/publishing-progress
- ⚠️ deleted the
queryrequest parameterisDraft
DELETE /ad-publishing/facebook/custom-audience/{audienceId}
- ⚠️ deleted the
queryrequest parameterisDraft
GET /ad-publishing/facebook/custom-audience/{audienceId}
- ⚠️ deleted the
queryrequest parameterisDraft
PUT /ad-publishing/facebook/custom-audience/{audienceId}/member/batch
- ⚠️ request property
operationTypewas restricted to a list of enum values - added the new
ADDenum value to the request propertyoperationType - added the new
REMOVEenum value to the request propertyoperationType - added the new
REPLACEenum value to the request propertyoperationType
GET /ad-publishing/facebook/integration
- ⚠️ deleted the
queryrequest parameterisDraft
GET /ad-publishing/facebook/me
- ⚠️ deleted the
queryrequest parameterisDraft
PUT /ad-publishing/facebook/page/default
- ⚠️ deleted the
queryrequest parameterisDraft
POST /ad-publishing/facebook/page/{pageId}/forms
- ⚠️ request property
greetingCard/allOf[#/components/schemas/GreetingCard]/stylewas restricted to a list of enum values - ⚠️ request property
thankYouPage/allOf[#/components/schemas/ThankYouPage]/buttonTypewas restricted to a list of enum values - added the new
CALL_BUSINESSenum value to the request propertythankYouPage/allOf[#/components/schemas/ThankYouPage]/buttonType - added the new
DOWNLOADenum value to the request propertythankYouPage/allOf[#/components/schemas/ThankYouPage]/buttonType - added the new
LIST_STYLEenum value to the request propertygreetingCard/allOf[#/components/schemas/GreetingCard]/style - added the new
PARAGRAPH_STYLEenum value to the request propertygreetingCard/allOf[#/components/schemas/GreetingCard]/style - added the new
VIEW_WEBSITEenum value to the request propertythankYouPage/allOf[#/components/schemas/ThankYouPage]/buttonType
GET /ad-publishing/facebook/pixels
- ⚠️ the
queryrequest parameterchannelwas restricted to a list of enum values - added the new enum value
FACEBOOKto thequeryrequest parameterchannel - added the new enum value
IGto thequeryrequest parameterchannel
PUT /ad-publishing/facebook/pixels
- ⚠️ request property
typewas restricted to a list of enum values - added the new
FUNNEL_EVENTenum value to the request propertytype - added the new
INSTAGRAM_DMenum value to the request propertytype - added the new
LEAD_EVENTenum value to the request propertytype
GET /ad-publishing/facebook/targeting/search
- ⚠️ the
queryrequest parametertypewas restricted to a list of enum values - added the new enum value
geolocationto thequeryrequest parametertype - added the new enum value
interestto thequeryrequest parametertype - added the new enum value
languageto thequeryrequest parametertype
GET /ad-publishing/google/ad-accounts/{adAccountId}
- ⚠️ deleted the
queryrequest parameterisDraft
PUT /ad-publishing/google/ads
- ⚠️ request property
audience/allOf[#/components/schemas/GoogleCampaignAudienceDTO]/ageRange/items/enumwas restricted to a list of enum values - ⚠️ request property
audience/allOf[#/components/schemas/GoogleCampaignAudienceDTO]/gender/items/enumwas restricted to a list of enum values - ⚠️ removed the enum value
DISCOVERYof the request propertyadvertisingChannelType - ⚠️ removed the enum value
DISPLAYof the request propertyadvertisingChannelType - ⚠️ removed the enum value
HOTELof the request propertyadvertisingChannelType - ⚠️ removed the enum value
LOCALof the request propertyadvertisingChannelType - ⚠️ removed the enum value
MULTI_CHANNELof the request propertyadvertisingChannelType - ⚠️ removed the enum value
PERFORMANCE_MAXof the request propertyadvertisingChannelType - added the new
AGE_RANGE_18_24enum value to the request propertyaudience/allOf[#/components/schemas/GoogleCampaignAudienceDTO]/ageRange/items/enum - added the new
AGE_RANGE_25_34enum value to the request propertyaudience/allOf[#/components/schemas/GoogleCampaignAudienceDTO]/ageRange/items/enum - added the new
AGE_RANGE_35_44enum value to the request propertyaudience/allOf[#/components/schemas/GoogleCampaignAudienceDTO]/ageRange/items/enum - added the new
AGE_RANGE_45_54enum value to the request propertyaudience/allOf[#/components/schemas/GoogleCampaignAudienceDTO]/ageRange/items/enum - added the new
AGE_RANGE_55_64enum value to the request propertyaudience/allOf[#/components/schemas/GoogleCampaignAudienceDTO]/ageRange/items/enum - added the new
AGE_RANGE_65_UPenum value to the request propertyaudience/allOf[#/components/schemas/GoogleCampaignAudienceDTO]/ageRange/items/enum - added the new
AGE_RANGE_UNDETERMINEDenum value to the request propertyaudience/allOf[#/components/schemas/GoogleCampaignAudienceDTO]/ageRange/items/enum - added the new
FEMALEenum value to the request propertyaudience/allOf[#/components/schemas/GoogleCampaignAudienceDTO]/gender/items/enum - added the new
MALEenum value to the request propertyaudience/allOf[#/components/schemas/GoogleCampaignAudienceDTO]/gender/items/enum - added the new
UNDETERMINEDenum value to the request propertyaudience/allOf[#/components/schemas/GoogleCampaignAudienceDTO]/gender/items/enum
GET /ad-publishing/google/ads/{adId}
- ⚠️ deleted the
queryrequest parameterisDraft
GET /ad-publishing/google/assets
- ⚠️ removed the enum value
IMAGEfrom thequeryrequest parametertype - ⚠️ removed the enum value
LEAD_FORMfrom thequeryrequest parametertype - ⚠️ removed the enum value
TEXTfrom thequeryrequest parametertype
POST /ad-publishing/google/assets
- ⚠️ removed the enum value
LEAD_FORMof the request propertytype - ⚠️ removed
#/components/schemas/LeadFormAssetPayloadDTOfrom thepayloadrequest propertyoneOflist
PUT /ad-publishing/google/audiences
- ⚠️ added the new required request property
dimensions/allOf[#/components/schemas/AudienceDimensionDTO]/ageRanges/items/minAge - ⚠️ added the new required request property
exclusionDimension/allOf[#/components/schemas/AudienceDimensionDTO]/ageRanges/items/minAge - ⚠️ request property
dimensions/allOf[#/components/schemas/AudienceDimensionDTO]/genders/items/was restricted to a list of enum values - ⚠️ request property
dimensions/allOf[#/components/schemas/AudienceDimensionDTO]/parentalStatuses/items/was restricted to a list of enum values - ⚠️ request property
exclusionDimension/allOf[#/components/schemas/AudienceDimensionDTO]/genders/items/was restricted to a list of enum values - ⚠️ request property
exclusionDimension/allOf[#/components/schemas/AudienceDimensionDTO]/parentalStatuses/items/was restricted to a list of enum values - ⚠️ the
dimensions/allOf[#/components/schemas/AudienceDimensionDTO]/ageRanges/items/request propertytypechanged fromstringtoobject - ⚠️ the
exclusionDimension/allOf[#/components/schemas/AudienceDimensionDTO]/ageRanges/items/request propertytypechanged fromstringtoobject - added the new optional request property
dimensions/allOf[#/components/schemas/AudienceDimensionDTO]/ageRanges/items/maxAge - added the new optional request property
exclusionDimension/allOf[#/components/schemas/AudienceDimensionDTO]/ageRanges/items/maxAge - added the new
FEMALEenum value to the request propertydimensions/allOf[#/components/schemas/AudienceDimensionDTO]/genders/items/ - added the new
FEMALEenum value to the request propertyexclusionDimension/allOf[#/components/schemas/AudienceDimensionDTO]/genders/items/ - added the new
MALEenum value to the request propertydimensions/allOf[#/components/schemas/AudienceDimensionDTO]/genders/items/ - added the new
MALEenum value to the request propertyexclusionDimension/allOf[#/components/schemas/AudienceDimensionDTO]/genders/items/ - added the new
NOT_A_PARENTenum value to the request propertydimensions/allOf[#/components/schemas/AudienceDimensionDTO]/parentalStatuses/items/ - added the new
NOT_A_PARENTenum value to the request propertyexclusionDimension/allOf[#/components/schemas/AudienceDimensionDTO]/parentalStatuses/items/ - added the new
PARENTenum value to the request propertydimensions/allOf[#/components/schemas/AudienceDimensionDTO]/parentalStatuses/items/ - added the new
PARENTenum value to the request propertyexclusionDimension/allOf[#/components/schemas/AudienceDimensionDTO]/parentalStatuses/items/ - added the new
UNDETERMINEDenum value to the request propertydimensions/allOf[#/components/schemas/AudienceDimensionDTO]/genders/items/ - added the new
UNDETERMINEDenum value to the request propertydimensions/allOf[#/components/schemas/AudienceDimensionDTO]/parentalStatuses/items/ - added the new
UNDETERMINEDenum value to the request propertyexclusionDimension/allOf[#/components/schemas/AudienceDimensionDTO]/genders/items/ - added the new
UNDETERMINEDenum value to the request propertyexclusionDimension/allOf[#/components/schemas/AudienceDimensionDTO]/parentalStatuses/items/
GET /ad-publishing/google/audiences/{audienceId}
- ⚠️ deleted the
queryrequest parameterisDraft
GET /ad-publishing/google/conversions
- ⚠️ the
queryrequest parametercategorywas restricted to a list of enum values - ⚠️ the
queryrequest parameterconversionTypewas restricted to a list of enum values - added the new enum value
ADD_TO_CARTto thequeryrequest parametercategory - added the new enum value
BEGIN_CHECKOUTto thequeryrequest parametercategory - added the new enum value
BOOK_APPOINTMENTto thequeryrequest parametercategory - added the new enum value
CONTACTto thequeryrequest parametercategory - added the new enum value
CONVERTED_LEADto thequeryrequest parametercategory - added the new enum value
DEFAULTto thequeryrequest parametercategory - added the new enum value
DOWNLOADto thequeryrequest parametercategory - added the new enum value
ENGAGEMENTto thequeryrequest parametercategory - added the new enum value
GET_DIRECTIONSto thequeryrequest parametercategory - added the new enum value
IMPORTED_LEADto thequeryrequest parametercategory - added the new enum value
LEADto thequeryrequest parametercategory - added the new enum value
LEAD_FORM_SUBMITto thequeryrequest parameterconversionType - added the new enum value
OUTBOUND_CLICKto thequeryrequest parametercategory - added the new enum value
PAGE_VIEWto thequeryrequest parametercategory - added the new enum value
PHONE_CALL_LEADto thequeryrequest parametercategory - added the new enum value
PURCHASEto thequeryrequest parametercategory - added the new enum value
QUALIFIED_LEADto thequeryrequest parametercategory - added the new enum value
REQUEST_QUOTEto thequeryrequest parametercategory - added the new enum value
SIGNUPto thequeryrequest parametercategory - added the new enum value
STORE_SALEto thequeryrequest parametercategory - added the new enum value
STORE_VISITto thequeryrequest parametercategory - added the new enum value
SUBMIT_LEAD_FORMto thequeryrequest parametercategory - added the new enum value
SUBSCRIBE_PAIDto thequeryrequest parametercategory - added the new enum value
UPLOAD_CALLSto thequeryrequest parameterconversionType - added the new enum value
UPLOAD_CLICKSto thequeryrequest parameterconversionType - added the new enum value
WEBPAGEto thequeryrequest parameterconversionType
PUT /ad-publishing/google/conversions
- ⚠️ request property
categorywas restricted to a list of enum values - ⚠️ removed the enum value
LEAD_FORM_SUBMITof the request propertytype - ⚠️ removed the enum value
UPLOAD_CALLSof the request propertytype - ⚠️ removed the enum value
WEBPAGEof the request propertytype - added the new
ADD_TO_CARTenum value to the request propertycategory - added the new
BEGIN_CHECKOUTenum value to the request propertycategory - added the new
BOOK_APPOINTMENTenum value to the request propertycategory - added the new
CONTACTenum value to the request propertycategory - added the new
CONVERTED_LEADenum value to the request propertycategory - added the new
DEFAULTenum value to the request propertycategory - added the new
DOWNLOADenum value to the request propertycategory - added the new
ENGAGEMENTenum value to the request propertycategory - added the new
GET_DIRECTIONSenum value to the request propertycategory - added the new
IMPORTED_LEADenum value to the request propertycategory - added the new
LEADenum value to the request propertycategory - added the new
OUTBOUND_CLICKenum value to the request propertycategory - added the new
PAGE_VIEWenum value to the request propertycategory - added the new
PHONE_CALL_LEADenum value to the request propertycategory - added the new
PURCHASEenum value to the request propertycategory - added the new
QUALIFIED_LEADenum value to the request propertycategory - added the new
REQUEST_QUOTEenum value to the request propertycategory - added the new
SIGNUPenum value to the request propertycategory - added the new
STORE_SALEenum value to the request propertycategory - added the new
STORE_VISITenum value to the request propertycategory - added the new
SUBMIT_LEAD_FORMenum value to the request propertycategory - added the new
SUBSCRIBE_PAIDenum value to the request propertycategory
DELETE /ad-publishing/google/conversions/{conversionId}
- ⚠️ deleted the
queryrequest parameterisDraft
GET /ad-publishing/google/conversions/{conversionId}
- ⚠️ deleted the
queryrequest parameterisDraft
GET /ad-publishing/google/integration
- ⚠️ deleted the
queryrequest parameterisDraft
POST /ad-publishing/google/keyword-ideas
- ⚠️ deleted the
queryrequest parameterisDraft
GET /ad-publishing/google/me
- ⚠️ deleted the
queryrequest parameterisDraft
GET /ad-publishing/google/segments
- ⚠️ the
queryrequest parametertypewas restricted to a list of enum values - added the new enum value
ALLto thequeryrequest parametertype - added the new enum value
CUSTOM_SEGMENTSto thequeryrequest parametertype - added the new enum value
DATA_SEGMENTSto thequeryrequest parametertype
GET /ad-publishing/google/targeting/search
- ⚠️ the
queryrequest parametertypewas restricted to a list of enum values - added the new enum value
geolocationto thequeryrequest parametertype - added the new enum value
languageto thequeryrequest parametertype
GET /ad-publishing/linkedin/ad-accounts
- ⚠️ deleted the
queryrequest parameterisDraft
GET /ad-publishing/linkedin/ads/{adId}
- ⚠️ deleted the
queryrequest parameterisDraft
GET /ad-publishing/linkedin/integration
- ⚠️ deleted the
queryrequest parameterisDraft
GET /ad-publishing/linkedin/me
- ⚠️ deleted the
queryrequest parameterisDraft
POST /ad-publishing/linkedin/{accountId}/form
- ⚠️ deleted the
queryrequest parameterisDraft
PATCH /ad-publishing/linkedin/{adId}/status
- ⚠️ deleted the
queryrequest parameterisDraft
Components
- removed the schema
CustomQuestionFieldDTO - removed the schema
GoogleDemographicTargetDTO - removed the schema
LeadFormAssetPayloadDTO - removed the schema
LeadFormFieldDTO
2026-08-12
Knowledge Base
GET /knowledge-bases/files
- endpoint added
POST /knowledge-bases/files
- endpoint added
DELETE /knowledge-bases/files/{fileId}
- endpoint added
GET /knowledge-bases/files/{fileId}
- endpoint added
2026-08-06
Saas Api
GET /saas/locations
- the
queryrequest parametercustomerIdbecame optional - the
queryrequest parametersubscriptionIdbecame optional - added the media type
application/jsonfor the response with the status200
2026-08-05
Ad Publishing
GET /ad-publishing/facebook/reporting/list
- ⚠️ the
queryrequest parameterlistTypewas restricted to a list of enum values - added the new enum value
adsto thequeryrequest parameterlistType - added the new enum value
adsetsto thequeryrequest parameterlistType - added the new enum value
campaignsto thequeryrequest parameterlistType - added the new enum value
noneto thequeryrequest parameterlistType
GET /ad-publishing/google/reporting/list
- ⚠️ the
queryrequest parameterlistTypewas restricted to a list of enum values - added the new enum value
adGroupsto thequeryrequest parameterlistType - added the new enum value
adsto thequeryrequest parameterlistType - added the new enum value
campaignsto thequeryrequest parameterlistType - added the new enum value
keywordsto thequeryrequest parameterlistType
GET /ad-publishing/linkedin/reporting/list
- ⚠️ the
queryrequest parameterlistTypewas restricted to a list of enum values - added the new enum value
adsto thequeryrequest parameterlistType - added the new enum value
campaignGroupsto thequeryrequest parameterlistType - added the new enum value
campaignsto thequeryrequest parameterlistType
2026-08-03
Contacts
Components
- removed the schema
ContactsMetaSchema - removed the schema
customFieldsInputArraySchema - removed the schema
customFieldsInputObjectSchema - removed the schema
customFieldsInputStringSchemaAd Publishing
GET /ad-publishing/facebook/conversation-forms
- ⚠️ deleted the
queryrequest parameterisDraft - added the new optional
queryrequest parameterafter - added the new optional
queryrequest parameterlimit - added the media type
application/jsonfor the response with the status200
GET /ad-publishing/facebook/custom-audience
- added the new optional
queryrequest parameterafter - added the new optional
queryrequest parameterlimit - added the new optional
queryrequest parameterprojection - added the media type
application/jsonfor the response with the status200
GET /ad-publishing/facebook/page/{pageId}/forms
- ⚠️ deleted the
queryrequest parameterisDraft - added the new optional
queryrequest parameterafter - added the new optional
queryrequest parameterlimit - added the new optional
queryrequest parameterprojection - added the media type
application/jsonfor the response with the status200
GET /ad-publishing/facebook/pixels
- added the new optional
queryrequest parameterafter - added the new optional
queryrequest parameterlimit - added the new optional
queryrequest parameterprojection - added the media type
application/jsonfor the response with the status200
GET /ad-publishing/google/assets
- added the new optional
queryrequest parameterlimit - added the new optional
queryrequest parameterpageToken - added the media type
application/jsonfor the response with the status200
GET /ad-publishing/google/audiences
- ⚠️ deleted the
queryrequest parameterisDraft - added the new optional
queryrequest parameterlimit - added the new optional
queryrequest parameterpageToken - added the media type
application/jsonfor the response with the status200
GET /ad-publishing/google/conversion-goals
- ⚠️ deleted the
queryrequest parameterisDraft - added the new optional
queryrequest parameterlimit - added the new optional
queryrequest parameterpageToken - added the media type
application/jsonfor the response with the status200
GET /ad-publishing/google/conversions
- added the new optional
queryrequest parameterlimit - added the new optional
queryrequest parameterpageToken
GET /ad-publishing/google/segments
- added the new optional
queryrequest parameterlimit - added the new optional
queryrequest parameterpageToken - added the media type
application/jsonfor the response with the status200
GET /ad-publishing/google/target-interests
- added the new optional
queryrequest parameterlimit - added the new optional
queryrequest parameterpageToken - added the new optional
queryrequest parameterprojection - added the media type
application/jsonfor the response with the status200
GET /ad-publishing/linkedin/{accountId}/forms
- ⚠️ deleted the
queryrequest parameterisDraft - added the new optional
queryrequest parameterlimit - added the new optional
queryrequest parameterpageToken - added the new optional
queryrequest parameterprojection - added the media type
application/jsonfor the response with the status200
2026-07-28
Opportunities
GET /opportunities/{id}
- added
#/components/schemas/GetOpportunityResponseSchemato theopportunityresponse propertyallOflist for the response status200 - removed
#/components/schemas/SearchOpportunitiesResponseSchemafrom theopportunityresponse propertyallOflist for the response status200
2026-07-07
Ad Publishing
GET /ad-publishing/facebook/pages
- added the new optional
queryrequest parameterafter - added the new optional
queryrequest parameterlimit - added the media type
application/jsonfor the response with the status200
2026-06-26
Opportunities
POST /opportunities/pipelines
- endpoint added
DELETE /opportunities/pipelines/{pipelineId}
- endpoint added
GET /opportunities/pipelines/{pipelineId}
- endpoint added
PUT /opportunities/pipelines/{pipelineId}
- endpoint added
2026-06-18
Ad Publishing
GET /ad-publishing/facebook/campaigns/{campaignId}/publishing-progress
Saas
GET /saas/allow-attach-rebilling/{locationId}
- endpoint added
2026-06-15
Users
GET /users/
- ⚠️ added the new
pipelines.createenum value to theusers/items/scopesresponse property for the response status200
POST /users/
- ⚠️ added the new
pipelines.createenum value to thescopesresponse property for the response status201 - added the new
pipelines.createenum value to the request propertyscopes/items/ - added the new
pipelines.createenum value to the request propertyscopesAssignedToOnly/items/
GET /users/search
- ⚠️ added the new
pipelines.createenum value to theusers/items/scopesresponse property for the response status200
POST /users/search/filter-by-email
- ⚠️ added the new
pipelines.createenum value to theusers/items/scopesresponse property for the response status200
GET /users/{userId}
- ⚠️ added the new
pipelines.createenum value to thescopesresponse property for the response status200
PUT /users/{userId}
- ⚠️ added the new
pipelines.createenum value to thescopesresponse property for the response status200 - added the new
pipelines.createenum value to the request propertyscopes/items/ - added the new
pipelines.createenum value to the request propertyscopesAssignedToOnly/items/
2026-06-12
Ad Publishing
GET /ad-publishing/facebook/reporting/list
- the
queryrequest parametercampaignIdbecame optional
2026-04-28
Users
GET /users/
- endpoint deprecated
2026-04-21
Notes
POST /notes/
- endpoint added
POST /notes/search
- endpoint added
DELETE /notes/{id}
- endpoint added
GET /notes/{id}
- endpoint added
PUT /notes/{id}
- endpoint added
PATCH /notes/{id}/attachments
- endpoint added
PUT /notes/{id}/relations
- endpoint added
POST /notes/{id}/restore
- endpoint added
2026-04-15
Users
GET /users/
- ⚠️ added the new
audit-logs.exportenum value to theusers/items/scopesresponse property for the response status200 - ⚠️ added the new
audit-logs.readonlyenum value to theusers/items/scopesresponse property for the response status200 - ⚠️ added the new
locations.agency-subaccounts.manageenum value to theusers/items/scopesresponse property for the response status200 - ⚠️ added the new
locations.billing.manageenum value to theusers/items/scopesresponse property for the response status200 - ⚠️ added the new
locations.createenum value to theusers/items/scopesresponse property for the response status200 - ⚠️ added the new
locations.deleteenum value to theusers/items/scopesresponse property for the response status200 - ⚠️ added the new
locations.details.manageenum value to theusers/items/scopesresponse property for the response status200 - ⚠️ added the new
locations.export.listenum value to theusers/items/scopesresponse property for the response status200 - ⚠️ added the new
locations.features-limits.manageenum value to theusers/items/scopesresponse property for the response status200 - ⚠️ added the new
locations.pause-resumeenum value to theusers/items/scopesresponse property for the response status200 - ⚠️ added the new
payments/settings.writeenum value to theusers/items/scopesresponse property for the response status200
POST /users/
- ⚠️ added the new
audit-logs.exportenum value to thescopesresponse property for the response status201 - ⚠️ added the new
audit-logs.readonlyenum value to thescopesresponse property for the response status201 - ⚠️ added the new
locations.agency-subaccounts.manageenum value to thescopesresponse property for the response status201 - ⚠️ added the new
locations.billing.manageenum value to thescopesresponse property for the response status201 - ⚠️ added the new
locations.createenum value to thescopesresponse property for the response status201 - ⚠️ added the new
locations.deleteenum value to thescopesresponse property for the response status201 - ⚠️ added the new
locations.details.manageenum value to thescopesresponse property for the response status201 - ⚠️ added the new
locations.export.listenum value to thescopesresponse property for the response status201 - ⚠️ added the new
locations.features-limits.manageenum value to thescopesresponse property for the response status201 - ⚠️ added the new
locations.pause-resumeenum value to thescopesresponse property for the response status201 - ⚠️ added the new
payments/settings.writeenum value to thescopesresponse property for the response status201 - added the new optional request property
twilioPhone - added the new
audit-logs.exportenum value to the request propertyscopes/items/ - added the new
audit-logs.exportenum value to the request propertyscopesAssignedToOnly/items/ - added the new
audit-logs.readonlyenum value to the request propertyscopes/items/ - added the new
audit-logs.readonlyenum value to the request propertyscopesAssignedToOnly/items/ - added the new
locations.agency-subaccounts.manageenum value to the request propertyscopes/items/ - added the new
locations.agency-subaccounts.manageenum value to the request propertyscopesAssignedToOnly/items/ - added the new
locations.billing.manageenum value to the request propertyscopes/items/ - added the new
locations.billing.manageenum value to the request propertyscopesAssignedToOnly/items/ - added the new
locations.createenum value to the request propertyscopes/items/ - added the new
locations.createenum value to the request propertyscopesAssignedToOnly/items/ - added the new
locations.deleteenum value to the request propertyscopes/items/ - added the new
locations.deleteenum value to the request propertyscopesAssignedToOnly/items/ - added the new
locations.details.manageenum value to the request propertyscopes/items/ - added the new
locations.details.manageenum value to the request propertyscopesAssignedToOnly/items/ - added the new
locations.export.listenum value to the request propertyscopes/items/ - added the new
locations.export.listenum value to the request propertyscopesAssignedToOnly/items/ - added the new
locations.features-limits.manageenum value to the request propertyscopes/items/ - added the new
locations.features-limits.manageenum value to the request propertyscopesAssignedToOnly/items/ - added the new
locations.pause-resumeenum value to the request propertyscopes/items/ - added the new
locations.pause-resumeenum value to the request propertyscopesAssignedToOnly/items/ - added the new
payments/settings.writeenum value to the request propertyscopes/items/ - added the new
payments/settings.writeenum value to the request propertyscopesAssignedToOnly/items/
GET /users/search
- ⚠️ added the new
audit-logs.exportenum value to theusers/items/scopesresponse property for the response status200 - ⚠️ added the new
audit-logs.readonlyenum value to theusers/items/scopesresponse property for the response status200 - ⚠️ added the new
locations.agency-subaccounts.manageenum value to theusers/items/scopesresponse property for the response status200 - ⚠️ added the new
locations.billing.manageenum value to theusers/items/scopesresponse property for the response status200 - ⚠️ added the new
locations.createenum value to theusers/items/scopesresponse property for the response status200 - ⚠️ added the new
locations.deleteenum value to theusers/items/scopesresponse property for the response status200 - ⚠️ added the new
locations.details.manageenum value to theusers/items/scopesresponse property for the response status200 - ⚠️ added the new
locations.export.listenum value to theusers/items/scopesresponse property for the response status200 - ⚠️ added the new
locations.features-limits.manageenum value to theusers/items/scopesresponse property for the response status200 - ⚠️ added the new
locations.pause-resumeenum value to theusers/items/scopesresponse property for the response status200 - ⚠️ added the new
payments/settings.writeenum value to theusers/items/scopesresponse property for the response status200
POST /users/search/filter-by-email
- ⚠️ added the new
audit-logs.exportenum value to theusers/items/scopesresponse property for the response status200 - ⚠️ added the new
audit-logs.readonlyenum value to theusers/items/scopesresponse property for the response status200 - ⚠️ added the new
locations.agency-subaccounts.manageenum value to theusers/items/scopesresponse property for the response status200 - ⚠️ added the new
locations.billing.manageenum value to theusers/items/scopesresponse property for the response status200 - ⚠️ added the new
locations.createenum value to theusers/items/scopesresponse property for the response status200 - ⚠️ added the new
locations.deleteenum value to theusers/items/scopesresponse property for the response status200 - ⚠️ added the new
locations.details.manageenum value to theusers/items/scopesresponse property for the response status200 - ⚠️ added the new
locations.export.listenum value to theusers/items/scopesresponse property for the response status200 - ⚠️ added the new
locations.features-limits.manageenum value to theusers/items/scopesresponse property for the response status200 - ⚠️ added the new
locations.pause-resumeenum value to theusers/items/scopesresponse property for the response status200 - ⚠️ added the new
payments/settings.writeenum value to theusers/items/scopesresponse property for the response status200
GET /users/{userId}
- ⚠️ added the new
audit-logs.exportenum value to thescopesresponse property for the response status200 - ⚠️ added the new
audit-logs.readonlyenum value to thescopesresponse property for the response status200 - ⚠️ added the new
locations.agency-subaccounts.manageenum value to thescopesresponse property for the response status200 - ⚠️ added the new
locations.billing.manageenum value to thescopesresponse property for the response status200 - ⚠️ added the new
locations.createenum value to thescopesresponse property for the response status200 - ⚠️ added the new
locations.deleteenum value to thescopesresponse property for the response status200 - ⚠️ added the new
locations.details.manageenum value to thescopesresponse property for the response status200 - ⚠️ added the new
locations.export.listenum value to thescopesresponse property for the response status200 - ⚠️ added the new
locations.features-limits.manageenum value to thescopesresponse property for the response status200 - ⚠️ added the new
locations.pause-resumeenum value to thescopesresponse property for the response status200 - ⚠️ added the new
payments/settings.writeenum value to thescopesresponse property for the response status200
PUT /users/{userId}
- ⚠️ added the new
audit-logs.exportenum value to thescopesresponse property for the response status200 - ⚠️ added the new
audit-logs.readonlyenum value to thescopesresponse property for the response status200 - ⚠️ added the new
locations.agency-subaccounts.manageenum value to thescopesresponse property for the response status200 - ⚠️ added the new
locations.billing.manageenum value to thescopesresponse property for the response status200 - ⚠️ added the new
locations.createenum value to thescopesresponse property for the response status200 - ⚠️ added the new
locations.deleteenum value to thescopesresponse property for the response status200 - ⚠️ added the new
locations.details.manageenum value to thescopesresponse property for the response status200 - ⚠️ added the new
locations.export.listenum value to thescopesresponse property for the response status200 - ⚠️ added the new
locations.features-limits.manageenum value to thescopesresponse property for the response status200 - ⚠️ added the new
locations.pause-resumeenum value to thescopesresponse property for the response status200 - ⚠️ added the new
payments/settings.writeenum value to thescopesresponse property for the response status200 - added the new optional request property
twilioPhone - added the new
audit-logs.exportenum value to the request propertyscopes/items/ - added the new
audit-logs.exportenum value to the request propertyscopesAssignedToOnly/items/ - added the new
audit-logs.readonlyenum value to the request propertyscopes/items/ - added the new
audit-logs.readonlyenum value to the request propertyscopesAssignedToOnly/items/ - added the new
locations.agency-subaccounts.manageenum value to the request propertyscopes/items/ - added the new
locations.agency-subaccounts.manageenum value to the request propertyscopesAssignedToOnly/items/ - added the new
locations.billing.manageenum value to the request propertyscopes/items/ - added the new
locations.billing.manageenum value to the request propertyscopesAssignedToOnly/items/ - added the new
locations.createenum value to the request propertyscopes/items/ - added the new
locations.createenum value to the request propertyscopesAssignedToOnly/items/ - added the new
locations.deleteenum value to the request propertyscopes/items/ - added the new
locations.deleteenum value to the request propertyscopesAssignedToOnly/items/ - added the new
locations.details.manageenum value to the request propertyscopes/items/ - added the new
locations.details.manageenum value to the request propertyscopesAssignedToOnly/items/ - added the new
locations.export.listenum value to the request propertyscopes/items/ - added the new
locations.export.listenum value to the request propertyscopesAssignedToOnly/items/ - added the new
locations.features-limits.manageenum value to the request propertyscopes/items/ - added the new
locations.features-limits.manageenum value to the request propertyscopesAssignedToOnly/items/ - added the new
locations.pause-resumeenum value to the request propertyscopes/items/ - added the new
locations.pause-resumeenum value to the request propertyscopesAssignedToOnly/items/ - added the new
payments/settings.writeenum value to the request propertyscopes/items/ - added the new
payments/settings.writeenum value to the request propertyscopesAssignedToOnly/items/
2026-04-14
Marketplace
GET /marketplace/app/{appId}/installations
- added the optional property
installationDetails/allOf[#/components/schemas/InstallerDetailsDTO]/companyPlanto the response with the200status - response property
installationDetails/allOf[#/components/schemas/InstallerDetailsDTO]/companyHighLevelPlandeprecated