Skip to main content
POST
cURL

Authorizations

Authorization
string
header
required

Body

application/json
externalUserId
string
required

The customer external ID, usually the user ID in your system

Example:

"customer_123"

email
string
required
name
string
required

Name is required for communication purposes

environment
object
required

Possible values: production or test

customProperties
object
required

Additional data to be stored with the customer

Response

201 - application/json

Customer identified successfully.

id
string
required
externalUserId
string
required
email
string
required
name
string
required
referredBy
object | null
required

The customer who referred this customer

referredById
object | null
required
referredByReferralId
string | null
required
referredInCampaignId
string | null
required
visitedReferralsCount
number
required
convertedReferralsCount
number
required
referralCode
string
required
createdAt
string<date-time>
required
updatedAt
string<date-time>
required
deletedAt
string<date-time> | null
required
organizationId
string
required
applicationId
string
required
customProperties
object | null
required
environment
enum<string>
required
Available options:
production,
test