How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

segment Alias API

Operations for merging two user identities together.

segment Alias API is one of 23 APIs that Twilio Segment publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

Tagged areas include Alias. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an AsyncAPI specification.

This API exposes 1 operation across 1 path, and defines 5 schemas. It is described by OpenAPI 3.1.0, at version 1.0.0.

Requests are made against a single base URL, https://platform.segmentapis.com/v1beta.

1 operations 1 paths 5 schemas 1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0.0
Base URL
https://api.segmentapis.com
Authentication
HTTP Bearer
Terms of Service
Resource Areas
1

Authentication & Security 1

segment Alias API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). By default, every request must be authenticated.

  • bearerAuth — Segment Config API access token. Note that as of early 2024, Segment has stopped issuing new Config API tokens.

Paths & Operations 1

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

Alias 1

Operations for merging two user identities together.

POST
/alias
Merge two user identities
alias body → 200400401

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are Context (7 properties), AliasCall (6 properties), ErrorResponse (2 properties), SuccessResponse (1 property). Each schema is shown below with its type and property counts.

Context
object
Dictionary of extra context for the call. Context is a dictionary of extra information that provides useful context about a data point, such as the user's IP a…
7 properties
ErrorResponse
object
2 properties
SuccessResponse
object
1 property
AliasCall
object
An alias call merges two user identities.
6 properties 2 required
Integrations
object
Dictionary of destinations to enable or disable. Pass a destination name as key and true/false as the value to control which destinations receive the data.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

segment-alias-api-openapi.yml Raw ↑

Other APIs Twilio Segment publishes across the network.

Segment Pixel Tracking API
segment Batch API
segment Catalog API
segment Destinations API
segment Events API
segment External IDs API
segment Functions API
segment Group API
segment Identify API
segment Labels API
segment Links API
segment Page API
Where this information came from

This is an independent, third-party profile of segment Alias API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.