POST
/
v1
/
public
/
users
cURL
curl --request POST \
  --url https://api.frigade.com/v1/public/users \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "userId": "d34daa11-3745-4ac0-880e-d4b4d51fe13f",
  "properties": {
    "email": "john@doe.com",
    "firstName": "John",
    "lastName": "Doe",
    "imageUrl": "https://example.com/john-doe.jpg"
  },
  "bootstrapFlowStates": true,
  "events": [
    {
      "event": "SignedUp",
      "properties": {
        "source": "landing-page",
        "campaign": "summer-sale"
      }
    }
  ],
  "linkGuestId": "<string>"
}'
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

​
Authorization
string
header
required

Authentication header of the form Bearer: <token>, where <token> is either your public or private API key. See when to use which

Body

application/json
​
userId
string
required

The ID of the user as defined in your own application

Example:

"d34daa11-3745-4ac0-880e-d4b4d51fe13f"

​
properties
object

Optional properties to add to the user

Example:
{
  "email": "john@doe.com",
  "firstName": "John",
  "lastName": "Doe",
  "imageUrl": "https://example.com/john-doe.jpg"
}
​
bootstrapFlowStates
boolean

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

​
events
object[]

Optional tracking events to add to the user

Example:
[
  {
    "event": "SignedUp",
    "properties": {
      "source": "landing-page",
      "campaign": "summer-sale"
    }
  }
]
​
linkGuestId
string

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.

Response

201

The user has been successfully created or updated