Create or update a User
Create a user, add properties, and tracking events
This endpoint allows you to upsert new or existing Users. If the user already exists, it will be updated with the new data. Any property left unchanged will not be modified. Changes to tracking events are append-only.
Authorizations
Authentication header of the form Bearer: <token>
, where <token>
is either your public or private API key. See when to use which
Body
The ID of the user as defined in your own application
Optional properties to add to the user
If set to true, the user will automatically complete any eligible Flows with completionCriteria
that have not already been completed. This is useful if a Flow has been recently updated with new steps and you want to ensure that historic users complete the new steps
Optional tracking events to add to the user
Merges a guest with a non-guest user. Only works if the provided linkGuestId
is a guest user and the userId
does not yet have any state in any Flows.