Skip to main content
Version: v1

Set User Properties

Set custom properties on users who have previously been identified in the browser via the FS.identify Browser API function.

System fields and custom field types

This REST API follows the same system fields as described in the corresponding client API and the field types as described in the Setting custom API properties KB article.

Anonymous users

This API will only work for previously-identified users for whom the FS.identify or FS.setUserVars Browser API was called. Anonymous users lack the required uid necessary for this API to function.

Path Parameters
    uid string required

    The application-specific ID you've given to the user. You will have passed that ID through the FS.identify Browser API function.

Query Parameters
    integration string optional

    Optional explicit integration field for integrations to mark their events.

Request Body required

    object

Responses
200

A successful response.

Loading...