251
All tools

Identify a user

Records a user's traits, such as email, name and plan, against their user ID and routes them to the source's destinations.

Updated Sep 27, 2026

identify-user.md

Identify a user

Records a user's traits, such as email, name and plan, against their user ID and routes them to the source's destinations.

Note: Answers 200 even for an event it drops (only oversized payloads and invalid JSON return 400), so confirm arrival in the source's Debugger.

Set up

Use the first option your agent supports.

API (official)

Note: SEGMENT_API_KEY holds the base64 of <write key>:. EU workspaces send to https://events.eu1.segmentapis.com instead.

Before anything else, confirm access with the cheapest read-only call, like a list or a search. Never send or change anything to test access.

Rules

  • Ask the user before anything that sends messages, costs money, or changes data, and say how many records it touches. One approval covers a batch the user has seen.
  • Never print API keys.

Ways in

RouteSourceCallRequiredDocs
APIOfficialPOST /v1/identifyAPI key in $SEGMENT_API_KEYDocs

Workflows using Identify a user

No workflows yet
No published workflow uses Identify a user yet.