segment · Schema

AliasCall

An alias call merges two user identities.

Properties

Name Type Description
userId string The new user ID to associate.
previousId string The previous ID to be merged with the user ID.
context object
integrations object
timestamp string ISO 8601 date string when the message was originally sent.
messageId string Unique identifier for the message to deduplicate.
View JSON Schema on GitHub

JSON Schema

segment-aliascall-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/AliasCall",
  "title": "AliasCall",
  "type": "object",
  "required": [
    "previousId",
    "userId"
  ],
  "description": "An alias call merges two user identities.",
  "properties": {
    "userId": {
      "type": "string",
      "description": "The new user ID to associate."
    },
    "previousId": {
      "type": "string",
      "description": "The previous ID to be merged with the user ID."
    },
    "context": {
      "$ref": "#/components/schemas/Context"
    },
    "integrations": {
      "$ref": "#/components/schemas/Integrations"
    },
    "timestamp": {
      "type": "string",
      "format": "date-time",
      "description": "ISO 8601 date string when the message was originally sent."
    },
    "messageId": {
      "type": "string",
      "description": "Unique identifier for the message to deduplicate."
    }
  }
}