Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Amplitude User Mapping API

The Amplitude User Mapping (Aliasing) API allows developers to merge users with different user IDs together in Amplitude. This is useful when a user initially interacts with a product anonymously and later creates an account, or when users have multiple identifiers across different systems. The API maps these distinct identities into a single unified user profile to ensure accurate analytics and attribution.

Amplitude User Mapping API is one of 33 APIs that Amplitude publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Aliasing, Analytics, Identity, and Users. The published artifact set on APIs.io includes API documentation and an OpenAPI specification.

This API exposes 2 operations across 2 paths, and defines 4 schemas. It is described by OpenAPI 3.1.0, at version 2.

Requests are made against 2 base URLs: https://api2.amplitude.com, https://api.eu.amplitude.com.

2 operations 2 paths 4 schemas 2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
2
Base URL
https://api2.amplitude.com
Terms of Service
Resource Areas
1

Paths & Operations 2

Across 2 paths, the API surfaces 2 operations — 2 POST. Each is listed below with its method, path, parameters, and response codes.

User Mapping 2

User identity mapping and aliasing operations

POST
/api/2/usermap
Amplitude Map User Identities
mapUser body → 200400401
POST
/api/2/userunmap
Amplitude Unmap User Identities
unmapUser body → 200400401

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are UserMapping (3 properties), UserMapResponse (2 properties), UserMapRequest (1 property), UserUnmapRequest (1 property). Each schema is shown below with its type and property counts.

UserMapping
object
3 properties 2 required
UserMapResponse
object
2 properties
UserUnmapRequest
object
1 property 1 required
UserMapRequest
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

amplitude-user-mapping-api-openapi.yml Raw ↑

Other APIs Amplitude publishes across the network.

Amplitude Batch Event Upload API
Amplitude Identify API
Amplitude Group Identify API
Amplitude Export API
Amplitude Attribution API
Amplitude Releases API
Amplitude Session Replay API
Amplitude User Privacy API
Amplitude Webhooks and Cohort Sync
Amplitude Annotations API
Amplitude Cohorts API
Amplitude Data Access API