Select your Platform:
backend SDKs
client SDKs
Users
Confused about "Users"?
Let us know how we can improve our documentation:
Stream allows you to store user information and embed them inside activities or use them for personalization. When stored in activities, users are automatically enriched by Stream.
Adding Users
Copied!Confused about "Adding Users"?
Let us know how we can improve our documentation:
This endpoint allows you to insert a new user.
Name | Type | Description |
|---|---|---|
id | string | The unique identifier for the new user (eg. username, user id, etc.). The value is restricted to alphanumeric characters, dashes and underscore symbols. |
data | object | The data related to the user. |
Retrieving Users
Copied!Confused about "Retrieving Users"?
Let us know how we can improve our documentation:
The retrieving users endpoint allows you to retrieve a user by their ID.
Removing Users
Copied!Confused about "Removing Users"?
Let us know how we can improve our documentation:
The delete endpoint removes a user by their ID.
Updating Users
Copied!Confused about "Updating Users"?
Let us know how we can improve our documentation:
This endpoint allows you to update a user by their ID.
Parameters
Copied!Confused about "Parameters"?
Let us know how we can improve our documentation:
| name | type | description | default | optional |
|---|---|---|---|---|
| id | string | The ID of the user to update | - | |
| data | object | The data related to the user | - |