Identify users

Call the identify endpoint to create a customer record on Lumen. Every action(event) is linked to the appropriate user. Thus, call the 'identify' endpoint before calling on the 'track' endpoint to capture/record events for a user.

Send email and identifier with other properties of choice to create a customer on Lumen. Email(email) is compulsory. An identifier is generated if none is provided.

Identify a user

POST https://api-lumen-app.herokuapp.com/v1/identify

Create/Update a user

Headers

Name	Type	Description
Content-Type	String	application/json
api_key*	String	Your API Key

Request Body

Name	Type	Description
identifier	String	unique identifier
first_name	String	first name
last_name	String	last name
email*	String	user email
phone_number	String	phone number

200: OK

{
    status: true,
    message: "Customer identified successfully",
    data: {
        identifier: "your-identifier",
    }
}

401: Unauthorized

{
    status: false,
    message: "The provided api key is not valid"
}

Standard Properties

Property	Description	Required
email	Email Address	true
identifier	Unique user identifier	false
first_name	First Name	false
last_name	Last Name	false
phone_number	Phone number	false
device_token	This is necessary for push notification.	false

Custom Properties

Send in custom properties of choice with your preferred naming convention.

Recommendation

An identifier is better a UUID

Update Customer Records

In order to update a customer record, call the 'identify' endpoint and include the properties to add/update.