Identify a user or group
curl --request POST \
--url http://localhost:3000/api/identify \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"user": "my-user-id",
"group": {
"id": "my-group-id",
"metadata": {
"plan": "pro"
}
}
}
'import requests
url = "http://localhost:3000/api/identify"
payload = {
"user": "my-user-id",
"group": {
"id": "my-group-id",
"metadata": { "plan": "pro" }
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({user: 'my-user-id', group: {id: 'my-group-id', metadata: {plan: 'pro'}}})
};
fetch('http://localhost:3000/api/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_PORT => "3000",
CURLOPT_URL => "http://localhost:3000/api/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([
'user' => 'my-user-id',
'group' => [
'id' => 'my-group-id',
'metadata' => [
'plan' => 'pro'
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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 := "http://localhost:3000/api/identify"
payload := strings.NewReader("{\n \"user\": \"my-user-id\",\n \"group\": {\n \"id\": \"my-group-id\",\n \"metadata\": {\n \"plan\": \"pro\"\n }\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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("http://localhost:3000/api/identify")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"user\": \"my-user-id\",\n \"group\": {\n \"id\": \"my-group-id\",\n \"metadata\": {\n \"plan\": \"pro\"\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3000/api/identify")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"user\": \"my-user-id\",\n \"group\": {\n \"id\": \"my-group-id\",\n \"metadata\": {\n \"plan\": \"pro\"\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"user": "<string>",
"group": "<string>"
}User management
Identify a user or group
Identify a user, group, or both.
POST
/
api
/
identify
Identify a user or group
curl --request POST \
--url http://localhost:3000/api/identify \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"user": "my-user-id",
"group": {
"id": "my-group-id",
"metadata": {
"plan": "pro"
}
}
}
'import requests
url = "http://localhost:3000/api/identify"
payload = {
"user": "my-user-id",
"group": {
"id": "my-group-id",
"metadata": { "plan": "pro" }
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({user: 'my-user-id', group: {id: 'my-group-id', metadata: {plan: 'pro'}}})
};
fetch('http://localhost:3000/api/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_PORT => "3000",
CURLOPT_URL => "http://localhost:3000/api/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([
'user' => 'my-user-id',
'group' => [
'id' => 'my-group-id',
'metadata' => [
'plan' => 'pro'
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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 := "http://localhost:3000/api/identify"
payload := strings.NewReader("{\n \"user\": \"my-user-id\",\n \"group\": {\n \"id\": \"my-group-id\",\n \"metadata\": {\n \"plan\": \"pro\"\n }\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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("http://localhost:3000/api/identify")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"user\": \"my-user-id\",\n \"group\": {\n \"id\": \"my-group-id\",\n \"metadata\": {\n \"plan\": \"pro\"\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3000/api/identify")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"user\": \"my-user-id\",\n \"group\": {\n \"id\": \"my-group-id\",\n \"metadata\": {\n \"plan\": \"pro\"\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"user": "<string>",
"group": "<string>"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
User, group, or both to identify. Records are created for users or groups with appropriate metadata, or metadata is updated for existing users or groups. When a user is provided alongside a group, a link between the user and group is created.
⌘I