FRfrigadehq
users

POST /v1/public/users

Create a user, add properties, and tracking events

Request

  • The document declares no server URL.
  • Auth
    HTTP bearer

Request body

userIdstring required

The ID of the user as defined in your own application

propertiesobject

Optional properties to add to the user

bootstrapFlowStatesboolean

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

linkGuestIdstring

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.

Example request

{
  "userId": "d34daa11-3745-4ac0-880e-d4b4d51fe13f",
  "properties": {
    "email": "john@doe.com",
    "firstName": "John",
    "lastName": "Doe",
    "imageUrl": "https://example.com/john-doe.jpg"
  },
  "events": [
    {
      "event": "SignedUp",
      "properties": {
        "source": "landing-page",
        "campaign": "summer-sale"
      }
    }
  ]
}

Response

The user has been successfully created or updated

Changes

No recorded changes to this operation across all 1 revision of this API.