Plan and complete an API migration

01 / ASSESS

Identify the affected contract change #

Start with the API changelog. It records operations added or removed between persisted OpenAPI versions. Then open the relevant operation in the API reference and compare its path, parameters, request shape, responses, and schemas with your integration.

02 / PREPARE

Update one integration boundary at a time #

• List every caller, scheduled job, webhook consumer, and SDK wrapper that uses the affected operation.
• Update request construction and response handling together, including error paths and pagination.
• Keep API keys, tokens, tenant data, and production identifiers out of test fixtures and support requests.

03 / VALIDATE

Validate before release #

Run the updated cURL or SDK request with valid tenant credentials in your test environment. Confirm the expected success response, required error handling, and pagination behavior before deploying your integration.

04 / REPLACE

Replace deprecated operations #

The API reference marks operations that are deprecated in the current OpenAPI contract. Treat those markers as a prompt to identify a supported replacement, update every caller, and remove the old path only after the replacement is verified.