Skip to main content
POST
/
customers
/
identify
cURL
curl --request POST \
  --url https://api-dev.withflock.com/customers/identify \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "externalUserId": "customer_123",
  "email": "<string>",
  "name": "<string>",
  "environment": {},
  "customProperties": {}
}
'
{
  "id": "<string>",
  "externalUserId": "<string>",
  "email": "<string>",
  "name": "<string>",
  "referredBy": {
    "id": "<string>",
    "externalUserId": "<string>",
    "email": "<string>",
    "name": "<string>"
  },
  "referredById": {},
  "referredByReferralId": "<string>",
  "referredInCampaignId": "<string>",
  "visitedReferralsCount": 123,
  "convertedReferralsCount": 123,
  "referralCode": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "deletedAt": "2023-11-07T05:31:56Z",
  "organizationId": "<string>",
  "applicationId": "<string>",
  "customProperties": {},
  "environment": "production"
}

Documentation Index

Fetch the complete documentation index at: https://docs.withflock.com/llms.txt

Use this file to discover all available pages before exploring further.

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
required

The customer who referred this customer

​
referredById
object
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
required
​
environment
enum<string>
required
Available options:
production,
test