Overview

Schema patches allow you to stage changes to your schema before applying them. Rather than making live changes directly, you can create a patch that describes a set of field additions, modifications, or mapping changes, review the patch, and then apply it when ready.

This workflow is useful when:

• Making multiple related schema changes that should be applied together
• Reviewing changes before they affect live data processing
• Coordinating schema changes across a team

How Schema Patches Work

1. Create a Patch: Define the field and mapping changes you want to make. A patch is a set of proposed changes that haven't been applied yet.
2. Review: Inspect the patch to verify the changes are correct. You can compare the proposed changes against the current schema.
3. Apply: Apply the patch to update the schema. Once applied, the changes take effect for incoming data.
4. Revert (if needed): If a patch causes issues, you can revert to the previous schema version.

API Reference

List Patches

GET /v2/schema/patch

Returns all pending schema patches for the account.

Get a Patch

GET /v2/schema/patch/{id}

Returns details of a specific schema patch.

Create a Patch

POST /v2/schema/patch

Creates a new schema patch with proposed changes.

Update a Patch

PUT /v2/schema/patch/{id}

Updates an existing pending patch.

Apply a Patch

POST /v2/schema/patch/{id}/apply

Applies a pending patch to the live schema. This makes the proposed changes active.

Delete a Patch

DELETE /v2/schema/patch/{id}

Removes a pending patch without applying it.

Related

• Schema Versions - Publishing and reverting schema versions
• Fields & Mappings - Managing individual fields and mappings