Changelog
Revision History
Date | Version | Summary |
|---|---|---|
| June 26, 2026 | 1.5.1 | Location asset update validation documentation |
| June 23, 2026 | 1.5.0 | Brand delete notification and feedback documentation; Delegation notification documentation corrections; Get Access Token Details response enhancements; Location capture eligibility guidance; Undelete Location API enhancement |
| June 15, 2026 | 1.4.4 | OAuth scopes documentation update; OAuth authorization request parameter name correction: redirection_endpoint → redirect_uri |
| June 11, 2026 | 1.4.3 | Webhook health check message type correction: HEALTH_CHECK → HEALTH |
| June 10, 2026 | 1.4.2 | OAuth scope correction: OAUTH_BRAND_WRITE does not permit brand deletion |
| June 9, 2026 | 1.4.1 | Delegation state value correction |
| June 5, 2026 | 1.4.0 | New 409 Conflict status code and BRAND__CREATION_IN_PROGRESS error code |
| May 21, 2026 | 1.3.0 | Location duplicate detection error code update |
| May 19, 2026 | 1.2.1 | Delegation API documentation |
| May 5, 2026 | 1.2.0 | Notifications API enhancements |
| April 21, 2026 | 1.1.0 | Validation and error code updates |
| April 14, 2026 | 1.0.0 | Initial release |
Revision Number Increments
| Version | Explanation |
|---|---|
| 1.0.0 | Major version with incompatible API changes. Includes number increment and new content. |
| 1.0.0 | Minor version with functionality added in a backward compatible manner. Includes number increment and changes to current content. |
| 1.0.0 | Patch version with backward compatible bug fixes. Includes number increment and content corrections that do not change functionality, such as graphics, grammar, etc. |
Version 1.5.1
Location Asset Update Validation
Documentation
Added missing VALIDATION__UpdatedLocationAssetShouldNotMatchExistingLocationAsset to the Location Asset validation rules. This validation rejects a location asset update when the submitted asset data is identical to the previous stored record.
The null byte character (U+0000, JSON escape \u0000) will be added to the list of unsupported characters. A property MUST NOT contain this character in its value. Submissions containing U+0000 in any string field will be rejected with a VIOLATION severity validation report. Affected validations follow the HasUnsupportedCharacter naming pattern (for example, DisplayNamesNameHasUnsupportedCharacter).
Targeted enforcement date: August 10, 2026
Version 1.5.0
Brand Delete Notification and Feedback
Documentation
Added brand delete example response bodies to Type Processing Successful (Notification and Feedback tabs). When a brand is deleted, a PROCESSING_SUCCESSFUL notification and feedback record with state: DELETED is generated for the organization that initiated the delete and all partners whose delegation scope includes the brand.
Delegation Notifications
Documentation Correction
Corrected the Type Delegation notification description and example response body:
- Removed location delete as a triggering event —
DELEGATIONnotifications are not generated when a delegated brand location is deleted - Added missing
operationfield to the Location Delegation example response body - Corrected
statevalue in the Location Delegation example fromPUBLISHEDtoSUBMITTED - Removed
DELETEfromoperationpossible values - Removed "or deleted" from
brandIdandetagfield descriptions
Get Access Token Details
Enhancement
The Get Access Token Details response body (GET /api/v1/me) now includes companyDetails and companyId for backward compatibility with existing integrations. These fields are deprecated — clients should transition to orgDetails and orgId. New integrations should use orgDetails and orgId only.
Location Capture Eligibility
New Guidance
Added Location Capture Eligibility guidance covering what does and does not qualify as a location eligible for submission. Includes eligible place types, general disqualifiers, and detailed examples of ineligible entities — departments and internal subdivisions, utility and service spaces, and administrative designations.
Undelete Location
Enhancement
Owner organization types with API access granted can now use the Undelete Location API. The VALIDATION__UndeleteOperationNotSupportedForOrgType validation has been removed.
Version 1.4.4
OAuth Scopes
Documentation Update
Updated OAuth 2.0 Scopes:
- Expanded scope tables to show granular permissions for each scope
Documentation Correction
Corrected the authorization request parameter name in Request Authorization Code. The parameter was incorrectly documented as redirection_endpoint; the correct name is redirect_uri, consistent with the API implementation and RFC 6749.