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": {}
}
'import requests
url = "https://api-dev.withflock.com/customers/identify"
payload = {
"externalUserId": "customer_123",
"email": "<string>",
"name": "<string>",
"environment": {},
"customProperties": {}
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
externalUserId: 'customer_123',
email: '<string>',
name: '<string>',
environment: {},
customProperties: {}
})
};
fetch('https://api-dev.withflock.com/customers/identify', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api-dev.withflock.com/customers/identify",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'externalUserId' => 'customer_123',
'email' => '<string>',
'name' => '<string>',
'environment' => [
],
'customProperties' => [
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api-dev.withflock.com/customers/identify"
payload := strings.NewReader("{\n \"externalUserId\": \"customer_123\",\n \"email\": \"<string>\",\n \"name\": \"<string>\",\n \"environment\": {},\n \"customProperties\": {}\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api-dev.withflock.com/customers/identify")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"externalUserId\": \"customer_123\",\n \"email\": \"<string>\",\n \"name\": \"<string>\",\n \"environment\": {},\n \"customProperties\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-dev.withflock.com/customers/identify")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"externalUserId\": \"customer_123\",\n \"email\": \"<string>\",\n \"name\": \"<string>\",\n \"environment\": {},\n \"customProperties\": {}\n}"
response = http.request(request)
puts response.read_body{
"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": {}
}Customers
Identify Customer
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": {}
}
'import requests
url = "https://api-dev.withflock.com/customers/identify"
payload = {
"externalUserId": "customer_123",
"email": "<string>",
"name": "<string>",
"environment": {},
"customProperties": {}
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
externalUserId: 'customer_123',
email: '<string>',
name: '<string>',
environment: {},
customProperties: {}
})
};
fetch('https://api-dev.withflock.com/customers/identify', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api-dev.withflock.com/customers/identify",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'externalUserId' => 'customer_123',
'email' => '<string>',
'name' => '<string>',
'environment' => [
],
'customProperties' => [
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api-dev.withflock.com/customers/identify"
payload := strings.NewReader("{\n \"externalUserId\": \"customer_123\",\n \"email\": \"<string>\",\n \"name\": \"<string>\",\n \"environment\": {},\n \"customProperties\": {}\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api-dev.withflock.com/customers/identify")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"externalUserId\": \"customer_123\",\n \"email\": \"<string>\",\n \"name\": \"<string>\",\n \"environment\": {},\n \"customProperties\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-dev.withflock.com/customers/identify")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"externalUserId\": \"customer_123\",\n \"email\": \"<string>\",\n \"name\": \"<string>\",\n \"environment\": {},\n \"customProperties\": {}\n}"
response = http.request(request)
puts response.read_body{
"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": {}
}Authorizations
Body
application/json
The customer external ID, usually the user ID in your system
Example:
"customer_123"
Name is required for communication purposes
Possible values: production or test
Additional data to be stored with the customer
Response
201 - application/json
Customer identified successfully.
The customer who referred this customer
Show child attributes
Show child attributes
Available options:
production, test ⌘I