Other/REST

Users

LAST EDIT Oct 08 2021

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!

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!

The retrieving users endpoint allows you to retrieve a user by their ID.

Removing Users

Copied!

The delete endpoint removes a user by their ID.

When you delete a user it will be converted to a missing reference and throw an error when enriching.

Updating Users

Copied!

This endpoint allows you to update a user by their ID.

Parameters

Copied!
nametypedescriptiondefaultoptional
idstringThe ID of the user to update-
dataobjectThe data related to the user-