PeopleUpsert person

Upsert person

Create or update a person, keyed on the identifier you send (userId/external_id/user_id). Email is never used as the key. This is the same code path as POST /people; there is no was_created flag in the response.

curl -X POST "https://api.flameup.ai/api/v1/people/upsert" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -d '{
  "userId": "example_string",
  "external_id": "example_string",
  "user_id": "example_string",
  "email": "user@example.com",
  "phone": "+1-555-0123",
  "anonymousId": "example_string",
  "traits": {},
  "timestamp": "2024-12-25T10:00:00Z"
}'
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "workspace_id": "123e4567-e89b-12d3-a456-426614174000",
  "userId": "example_string"
}
POST
/people/upsert
POST
Base URLstring

Target server for requests. Edit to use your own host.

Bearer Token
Bearer Tokenstring
Required

Your Flameup API key (passed as Bearer token)

Your Flameup API key (passed as Bearer token)
Content-Typestring
Required

The media type of the request body

Options: application/json
userIdstring

Your own user id. external_id and user_id are accepted aliases. Send only one — if two are present and disagree the request is rejected rather than one being picked for you.

emailstring
Format: email
anonymousIdstring

Anonymous id to merge into this person.

traitsobject

Merged with existing traits; new values win.

timestampstring
Format: date-time
Request Preview
Response

Response will appear here after sending the request

Authentication

header
Authorizationstring
Required

Bearer token. Your Flameup API key (passed as Bearer token)

Body

application/json
userIdstring

Your own user id. external_id and user_id are accepted aliases. Send only one — if two are present and disagree the request is rejected rather than one being picked for you.

anonymousIdstring

Anonymous id to merge into this person.

traitsobject

Merged with existing traits; new values win.

Responses