Alias Endpoint

POST /api/alias

Merges user identities. This endpoint is optional but recommended for preserving event history when users sign up.

Request

Headers

string

required

application/json

string

required

Your API key

Body

string

required

New user ID (the identified user ID)

string

required

Previous user ID (usually the anonymous ID)

string

required

ISO 8601 timestamp

Example Request

curl -X POST https://api.solute.dev/api/alias \
  -H "Content-Type: application/json" \
  -H "X-Api-Key: your_api_key" \
  -d '{
    "userId": "user_123",
    "previousId": "anon_456",
    "timestamp": "2025-01-15T10:30:00Z"
  }'

Response

Success Response

boolean

required

true if the request was successful

string

required

The new user ID

string

required

The previous user ID

Example Response

{
  "success": true,
  "userId": "user_123",
  "previousId": "anon_456"
}

Use Case

This endpoint is typically called when a user signs up. It merges their anonymous identity with their new user ID, ensuring all events from before signup are associated with the user.

Getting Started

Core Features

Framework Integration

Client SDK

React Integration

Server Integration

Backend API

POST /api/alias

Request

Headers

Body

Example Request

Response

Success Response

Example Response

Use Case

Identify Endpoint

Group Endpoint

​POST /api/alias

​Request

​Headers

​Body

​Example Request

​Response

​Success Response

​Example Response

​Use Case

​Related

Identify Endpoint

Group Endpoint

POST /api/alias

Request

Headers

Body

Example Request

Response

Success Response

Example Response

Use Case

Related