Skip to main content

Changelog

Revision History

Date
VersionSummary
April 21, 20261.1.0Validation and error code updates
April 14, 20261.0.0Initial release

Revision Number Increments

VersionExplanation
1.0.0Major version with incompatible API changes. Includes number increment and new content.
1.0.0Minor version with functionality added in a backward compatible manner. Includes number increment and changes to current content.
1.0.0Patch version with backward compatible bug fixes. Includes number increment and content corrections that do not change functionality, such as graphics, grammar, etc.
Reference

Version 1.1.0

  • New error code ORG__HAS_ACTIVE_MANAGER_USER returned when attempting to delete an organization that has an active manager user.
  • New validation DepartmentMustBeValidForUseWithBrandPrimaryCategory - Validate that department value is valid for use in conjunction with the brand's primary category. See Department Validations for details.

Breaking Changes

API Version and Request Path Changes

  • API version in URL paths: /api/v3//api/v1/
  • API request templates now use orgs instead of companies.

Terminology Changes

  • All resource response bodies (Location, Brand, Brand Asset, Email ID, and so on) return orgId instead of companyId.
  • Feedback/notification body field renames in DELEGATION and OAUTH_APP_GRANT types. In these sub-objects:
    • companyDetailsorgDetails
    • companyLegalNameorgLegalName
    • companyIdorgId
  • Delegation API:
    • delegatedPartnerCompanyIddelegatedPartnerOrgId
    • expand=companyDetailsexpand=orgDetails
  • Narrative terminology updated from “company/companies” to “organization(s).”

Migration Impact

  • Action required: Update all API request paths and parameters from companies to orgs.
  • No behavioral change: This is a naming/terminology change only; request semantics, authorization, and responses are unchanged.

Webhook Request Header Renames

The following request headers have been renamed for the Webhook POST request and the Health Check:

Previous NameNew Name
BusinessConnect-TimestampBusiness-Timestamp
BusinessConnect-SignatureBusiness-Signature
BusinessConnect-Webhook-EnvironmentBusiness-Webhook-Environment

Migration Impact

  • Action required: Update webhook implementations to recognize the new header names.
  • No behavioral change: Header semantics and values are unchanged.

Removal of brandAssetId from Email ID

  • brandAssetId has been removed from all API operations
  • The field is no longer returned in Get responses and is not present in Create or Update response schemas.

Migration Impact

  • Action required: Remove brandAssetId from all client models and response handling.
  • No replacement: This field is no longer exposed by the API.

Validations

New empty array validations added. Severity is VIOLATION. Fields:

  • $.assetDetails.captions
  • $.assetDetails.classifications
  • $.locationDetails.accessPoints
  • $.locationDetails.actionLinkDetails.quicklinks
  • $.locationDetails.internalNicknames
  • $.locationDetails.keywords.other
  • $.locationDetails.keywords.products
  • $.locationDetails.keywords.services
  • $.locationDetails.locationAttributes
  • $.locationDetails.locationDescriptions
  • $.locationDetails.locationDescriptions[].descriptions
  • $.locationDetails.structuredAddress.dependentLocality
  • $.locationDetails.openingHoursByDay
  • $.locationDetails.openingHoursByDay[].times
  • $.locationDetails.paymentMethods
  • $.locationDetails.phoneNumbers
  • $.locationDetails.serviceHours
  • $.locationDetails.serviceHours[].hoursByDay[].times
  • $.locationDetails.specialHours[].descriptions
  • $.locationDetails.specialHours
  • $.locationDetails.specialHours[].hoursByDay[].times
  • $.locationDetails.urls
  • $.reviewDetails.interactionStatistics
  • $.reviewDetails.localizedReviews
  • $.reviewDetails.starRatings

Location Duplicate Detection on Create

A duplicate detection constraint for the Location Create operation is now enforced with the v1 API launch. This constraint was previously documented in the Already Exists error reference but was not implemented.

Behavior: An attempt to create a Location resource using field values that match an already existing Location resource will return 400 ALREADY_EXISTS with code LOCATION__ALREADY_EXISTS.

warning

Partners should review their Location create workflows prior to the v1 API launch to ensure requests do not submit duplicate records.

Migration Impact

  • Action required: Audit Location create integrations and update error-handling logic to account for LOCATION__ALREADY_EXISTS.
  • Behavioral change: Previously, duplicate Location create requests may have succeeded; they will now return a 400 error.

New Resource State

Location Resource

  • New state: PUBLISH_PAUSED. Targeted release date: Monday April 20.
note

PUBLISH_PAUSED will be supported by a new processing code PROCESSING__LocationPublishingPausedInMapRegion which is expected to be released on Monday May 4.

Enhancements

Business-Timestamp Behavior Correction

Expected week of May 4, 2026

The Business-Timestamp request header in Webhook POST requests now reflects the HTTP request send time.

Previously, Business-Timestamp reflected the time the feedback event was generated rather than when the HTTP POST request was sent.

Updated behavior:

  • Business-Timestamp is generated immediately prior to signing and sending the POST request.
  • The value no longer reflects the generation time of the feedback event described in the payload.

Migration Impact

  • No action required for partners who do not validate Business-Timestamp freshness.
  • Partners who implement freshness validation against Business-Timestamp will now receive accurate send-time values.

Documentation Corrections

Updated example response bodies to correct pagination.next values by removing the /api prefix from the path. Changes are visible in:

The correction applies to documentation examples only. At this time, API responses may return pagination links either with the /api prefix or starting with /{api_version} (for example, /v1). This variation will be standardized in a future release.