# Braze User Data > External ID Migration API

**Canonical:** https://apis.io/apis/braze/braze-user-data-external-id-migration-api/  
**Provider:** Braze — https://apis.io/providers/braze/  
**Base URL:** https://rest.iad-01.braze.com  
**Documentation:** https://www.braze.com/docs/api/basics/

Braze User Data > External ID Migration API is one of 24 APIs that [Braze](https://apis.io/providers/braze/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. Tagged areas include User Data > External ID Migration. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

The External ID Migration API allows you to rename existing external IDs (creating a new primary ID and deprecating the existing ID) and remove deprecated IDs post-migration. <br><br> We've architected this solution to allow multiple External IDs in order to support a migration period whereby older versions of your apps still in the wild that use the previous External ID naming schema dont break. We highly recommend removing deprecated External IDs once your old naming schema is no longer in use.

## Machine-readable artifacts (4)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/braze/refs/heads/main/openapi/braze-user-data-external-id-migration-api-openapi.yml
- **Overlay** — https://raw.githubusercontent.com/api-evangelist/braze/refs/heads/main/overlays/braze-user-data-external-id-migration-overlay.yaml
- **Documentation** — https://www.braze.com/docs/api/basics/
- **GraphQL** — https://raw.githubusercontent.com/api-evangelist/braze/refs/heads/main/graphql/braze-graphql.md

## Other Braze APIs (12)

- [Braze Catalogs > Catalog Items > Asynchronous API](https://apis.io/apis/braze/braze-catalogs-catalog-items-asynchronous-api/)
- [Braze Catalogs > Catalog Items > Synchronous API](https://apis.io/apis/braze/braze-catalogs-catalog-items-synchronous-api/)
- [Braze Catalogs > Catalog Management > Synchronous API](https://apis.io/apis/braze/braze-catalogs-catalog-management-synchronous-api/)
- [Braze Email Lists & Addresses API](https://apis.io/apis/braze/braze-email-lists-addresses-api/)
- [Braze Export > Campaign API](https://apis.io/apis/braze/braze-export-campaign-api/)
- [Braze Export > Canvas API](https://apis.io/apis/braze/braze-export-canvas-api/)
- [Braze Export > Custom Events API](https://apis.io/apis/braze/braze-export-custom-events-api/)
- [Braze Export > KPI API](https://apis.io/apis/braze/braze-export-kpi-api/)
- [Braze Export > News Feed API](https://apis.io/apis/braze/braze-export-news-feed-api/)
- [Braze Export > Purchases API](https://apis.io/apis/braze/braze-export-purchases-api/)
- [Braze Export > Segment API](https://apis.io/apis/braze/braze-export-segment-api/)
- [Braze Export > Session Analytics API](https://apis.io/apis/braze/braze-export-session-analytics-api/)

## Tags

User Data > External ID Migration

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/braze/braze-user-data-external-id-migration-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/braze/.