Managing API and Product Changes

Cobre evolves its APIs and products continuously. When something changes, Cobre notifies affected clients ahead of time so integration teams can plan updates without surprises. This guide explains how that process works: how changes are classified, how much notice each type receives, what every notice contains, where it is delivered, and what your team should do when one arrives.

This guide is about how changes are communicated and how to respond to them — it does not itself introduce a new endpoint or object. Use it to plan the operational side of maintaining a Cobre integration over time.

How Changes Are Classified

Not every change affects an integration equally, so the amount of advance notice depends on the scope of the change.

Change type	What it is	Advance notice
Minor change	New fields or additional information in a response or webhook that does not affect existing integrations. No action is required to keep operating normally.	1 to 2 weeks
Simple change	Small adjustments that may require a minor code update, without redesigning the integration.	30 days
Medium change	Modifications requiring moderate integration work, such as changes to process logic or to how an endpoint is consumed.	90 days
Major change	Migrations, deprecations, or breaking changes that require redesigning part of the integration before a shutdown date.	180 days

The advance notice is counted from the first notice until the date the change takes effect — or, for migrations, until the shutdown date of the previous version.

The notice period is measured from the first communication, not from any later reminder. Plan your work against the original date to avoid acting close to a shutdown date.

Key Terms

Advance notice: The lead time between the first notice and the date a change takes effect (or the shutdown date for migrations).

Shutdown date: For migrations and deprecations, the date after which the previous version or behavior stops working.

Breaking change: A change that requires redesigning part of an integration before it can keep operating. Always communicated as a Major change.

Operational contact / Technical contact: The registered client contacts who receive change notices so both teams can coordinate the implementation.

KAM (Key Account Manager): Your assigned Cobre account contact, available to support implementation and answer questions.

What Every Notice Contains

Regardless of change type, every notice Cobre sends makes the following explicit:

What is changing, with technical precision — the exact affected field, endpoint, code, or format.

When the change applies — the effective date, and the shutdown date when a migration is involved.

Whether the change applies to you and what to do, or a clear statement that no action is required.

The updated documentation that explains the adjustment, so it can be implemented without ambiguity.

A contact for any questions.

Who Receives a Notice

Notices are sent to all registered operational and technical contacts of the clients affected by the change. Sending to both roles lets the two teams coordinate the implementation directly, without depending on the information being relayed internally between areas.

Keep your registered operational and technical contacts up to date. Change notices are only delivered to the contacts on record for your organization.

Communication Channels

Each notice is delivered by email to the registered technical and operational contacts. When the change requires it, the corresponding technical documentation at docs.cobre.com is also updated to reflect the adjustment.

How to Respond to a Notice

When a notice arrives, work through these actions to confirm impact and implement any required changes safely before the deadline.

Confirm if it applies

Description: Review the conditions in the notice — the affected endpoint, product, or flow — against what your integration actually uses.

What to expect after the action: A clear determination of whether the change affects you and, if so, which parts of your integration are in scope.

Review the updated docs

Description: If the notice links to a section on docs.cobre.com, review it for the technical detail needed to implement the adjustment.

What to expect after the action: A precise understanding of the new field, endpoint, code, or format and how to adapt your code to it.

Test in QA first

Description: For changes that may affect your integration, validate the adjustment in the test environment before deploying to production.

What to expect after the action: Confidence that your updated integration behaves correctly against the change before it reaches production traffic.

Implement before the deadline

Description: Complete the required adjustments before the effective or shutdown date. The advance notice is sized to give enough time, but act with margin.

What to expect after the action: A migrated or updated integration that continues operating without interruption after the change takes effect.

Contact your KAM

Description: Reach out to your Key Account Manager (KAM) with any questions. The standard Cobre support channel is also available.

What to expect after the action: Support from Cobre throughout the implementation.

What to expect from Cobre

Advance visibility of every change - You receive notice of minor, simple, medium, and major changes with lead time proportional to their impact — from 1–2 weeks up to 180 days.

Precise, actionable notices - Each notice states exactly what changes, when it applies, whether it affects you, what to do, and where the updated documentation lives.

Coordinated implementation - Because both operational and technical contacts are notified, your teams can coordinate the update directly.

Supported migrations - For breaking changes and deprecations, you have a defined shutdown date and KAM support to migrate before the previous version stops working.

Managing API and Product Changes

How Changes Are Classified#

Key Terms#

What Every Notice Contains#

Who Receives a Notice#

Communication Channels#

How to Respond to a Notice#

What to expect from Cobre#

How Changes Are Classified

Key Terms

What Every Notice Contains

Who Receives a Notice

Communication Channels

How to Respond to a Notice

What to expect from Cobre