Identify a subscriber
curl --request POST \
--url https://api.buzzkit.dev/v1/client/identify \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"externalId": "<string>",
"identityHash": "<string>",
"email": "jsmith@example.com",
"attributes": {},
"device": {
"appVersion": "<string>",
"appBuild": "<string>",
"sdkVersion": "<string>",
"osVersion": "<string>",
"model": "<string>",
"locale": "<string>",
"installedAt": "<string>"
}
}
'import requests
url = "https://api.buzzkit.dev/v1/client/identify"
payload = {
"externalId": "<string>",
"identityHash": "<string>",
"email": "jsmith@example.com",
"attributes": {},
"device": {
"appVersion": "<string>",
"appBuild": "<string>",
"sdkVersion": "<string>",
"osVersion": "<string>",
"model": "<string>",
"locale": "<string>",
"installedAt": "<string>"
}
}
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({
externalId: '<string>',
identityHash: '<string>',
email: 'jsmith@example.com',
attributes: {},
device: {
appVersion: '<string>',
appBuild: '<string>',
sdkVersion: '<string>',
osVersion: '<string>',
model: '<string>',
locale: '<string>',
installedAt: '<string>'
}
})
};
fetch('https://api.buzzkit.dev/v1/client/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.buzzkit.dev/v1/client/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([
'externalId' => '<string>',
'identityHash' => '<string>',
'email' => 'jsmith@example.com',
'attributes' => [
],
'device' => [
'appVersion' => '<string>',
'appBuild' => '<string>',
'sdkVersion' => '<string>',
'osVersion' => '<string>',
'model' => '<string>',
'locale' => '<string>',
'installedAt' => '<string>'
]
]),
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 := "https://api.buzzkit.dev/v1/client/identify"
payload := strings.NewReader("{\n \"externalId\": \"<string>\",\n \"identityHash\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"attributes\": {},\n \"device\": {\n \"appVersion\": \"<string>\",\n \"appBuild\": \"<string>\",\n \"sdkVersion\": \"<string>\",\n \"osVersion\": \"<string>\",\n \"model\": \"<string>\",\n \"locale\": \"<string>\",\n \"installedAt\": \"<string>\"\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("https://api.buzzkit.dev/v1/client/identify")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"externalId\": \"<string>\",\n \"identityHash\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"attributes\": {},\n \"device\": {\n \"appVersion\": \"<string>\",\n \"appBuild\": \"<string>\",\n \"sdkVersion\": \"<string>\",\n \"osVersion\": \"<string>\",\n \"model\": \"<string>\",\n \"locale\": \"<string>\",\n \"installedAt\": \"<string>\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.buzzkit.dev/v1/client/identify")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"externalId\": \"<string>\",\n \"identityHash\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"attributes\": {},\n \"device\": {\n \"appVersion\": \"<string>\",\n \"appBuild\": \"<string>\",\n \"sdkVersion\": \"<string>\",\n \"osVersion\": \"<string>\",\n \"model\": \"<string>\",\n \"locale\": \"<string>\",\n \"installedAt\": \"<string>\"\n }\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {},
"error": {
"code": "<string>",
"message": "<string>",
"param": "<string>",
"details": {}
},
"metadata": {
"timestamp": "<string>",
"requestId": "<string>"
}
}{
"success": false,
"data": {},
"error": {
"code": "invalid_api_key",
"message": "<string>",
"param": "<string>",
"details": [
{
"param": "<string>",
"message": "<string>"
}
]
},
"metadata": {
"timestamp": "2023-11-07T05:31:56Z",
"requestId": "<string>"
}
}{
"success": false,
"data": {},
"error": {
"code": "invalid_api_key",
"message": "<string>",
"param": "<string>",
"details": [
{
"param": "<string>",
"message": "<string>"
}
]
},
"metadata": {
"timestamp": "2023-11-07T05:31:56Z",
"requestId": "<string>"
}
}{
"success": false,
"data": {},
"error": {
"code": "invalid_api_key",
"message": "<string>",
"param": "<string>",
"details": [
{
"param": "<string>",
"message": "<string>"
}
]
},
"metadata": {
"timestamp": "2023-11-07T05:31:56Z",
"requestId": "<string>"
}
}{
"success": false,
"data": {},
"error": {
"code": "invalid_api_key",
"message": "<string>",
"param": "<string>",
"details": [
{
"param": "<string>",
"message": "<string>"
}
]
},
"metadata": {
"timestamp": "2023-11-07T05:31:56Z",
"requestId": "<string>"
}
}{
"success": false,
"data": {},
"error": {
"code": "invalid_api_key",
"message": "<string>",
"param": "<string>",
"details": [
{
"param": "<string>",
"message": "<string>"
}
]
},
"metadata": {
"timestamp": "2023-11-07T05:31:56Z",
"requestId": "<string>"
}
}Client
Identify a subscriber
POST
/
v1
/
client
/
identify
Identify a subscriber
curl --request POST \
--url https://api.buzzkit.dev/v1/client/identify \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"externalId": "<string>",
"identityHash": "<string>",
"email": "jsmith@example.com",
"attributes": {},
"device": {
"appVersion": "<string>",
"appBuild": "<string>",
"sdkVersion": "<string>",
"osVersion": "<string>",
"model": "<string>",
"locale": "<string>",
"installedAt": "<string>"
}
}
'import requests
url = "https://api.buzzkit.dev/v1/client/identify"
payload = {
"externalId": "<string>",
"identityHash": "<string>",
"email": "jsmith@example.com",
"attributes": {},
"device": {
"appVersion": "<string>",
"appBuild": "<string>",
"sdkVersion": "<string>",
"osVersion": "<string>",
"model": "<string>",
"locale": "<string>",
"installedAt": "<string>"
}
}
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({
externalId: '<string>',
identityHash: '<string>',
email: 'jsmith@example.com',
attributes: {},
device: {
appVersion: '<string>',
appBuild: '<string>',
sdkVersion: '<string>',
osVersion: '<string>',
model: '<string>',
locale: '<string>',
installedAt: '<string>'
}
})
};
fetch('https://api.buzzkit.dev/v1/client/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.buzzkit.dev/v1/client/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([
'externalId' => '<string>',
'identityHash' => '<string>',
'email' => 'jsmith@example.com',
'attributes' => [
],
'device' => [
'appVersion' => '<string>',
'appBuild' => '<string>',
'sdkVersion' => '<string>',
'osVersion' => '<string>',
'model' => '<string>',
'locale' => '<string>',
'installedAt' => '<string>'
]
]),
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 := "https://api.buzzkit.dev/v1/client/identify"
payload := strings.NewReader("{\n \"externalId\": \"<string>\",\n \"identityHash\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"attributes\": {},\n \"device\": {\n \"appVersion\": \"<string>\",\n \"appBuild\": \"<string>\",\n \"sdkVersion\": \"<string>\",\n \"osVersion\": \"<string>\",\n \"model\": \"<string>\",\n \"locale\": \"<string>\",\n \"installedAt\": \"<string>\"\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("https://api.buzzkit.dev/v1/client/identify")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"externalId\": \"<string>\",\n \"identityHash\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"attributes\": {},\n \"device\": {\n \"appVersion\": \"<string>\",\n \"appBuild\": \"<string>\",\n \"sdkVersion\": \"<string>\",\n \"osVersion\": \"<string>\",\n \"model\": \"<string>\",\n \"locale\": \"<string>\",\n \"installedAt\": \"<string>\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.buzzkit.dev/v1/client/identify")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"externalId\": \"<string>\",\n \"identityHash\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"attributes\": {},\n \"device\": {\n \"appVersion\": \"<string>\",\n \"appBuild\": \"<string>\",\n \"sdkVersion\": \"<string>\",\n \"osVersion\": \"<string>\",\n \"model\": \"<string>\",\n \"locale\": \"<string>\",\n \"installedAt\": \"<string>\"\n }\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {},
"error": {
"code": "<string>",
"message": "<string>",
"param": "<string>",
"details": {}
},
"metadata": {
"timestamp": "<string>",
"requestId": "<string>"
}
}{
"success": false,
"data": {},
"error": {
"code": "invalid_api_key",
"message": "<string>",
"param": "<string>",
"details": [
{
"param": "<string>",
"message": "<string>"
}
]
},
"metadata": {
"timestamp": "2023-11-07T05:31:56Z",
"requestId": "<string>"
}
}{
"success": false,
"data": {},
"error": {
"code": "invalid_api_key",
"message": "<string>",
"param": "<string>",
"details": [
{
"param": "<string>",
"message": "<string>"
}
]
},
"metadata": {
"timestamp": "2023-11-07T05:31:56Z",
"requestId": "<string>"
}
}{
"success": false,
"data": {},
"error": {
"code": "invalid_api_key",
"message": "<string>",
"param": "<string>",
"details": [
{
"param": "<string>",
"message": "<string>"
}
]
},
"metadata": {
"timestamp": "2023-11-07T05:31:56Z",
"requestId": "<string>"
}
}{
"success": false,
"data": {},
"error": {
"code": "invalid_api_key",
"message": "<string>",
"param": "<string>",
"details": [
{
"param": "<string>",
"message": "<string>"
}
]
},
"metadata": {
"timestamp": "2023-11-07T05:31:56Z",
"requestId": "<string>"
}
}{
"success": false,
"data": {},
"error": {
"code": "invalid_api_key",
"message": "<string>",
"param": "<string>",
"details": [
{
"param": "<string>",
"message": "<string>"
}
]
},
"metadata": {
"timestamp": "2023-11-07T05:31:56Z",
"requestId": "<string>"
}
}Authorizations
An API key from the dashboard. The scopes listed on each operation are the resource:action grants a key needs (messages:send, subscribers:read, topics:*, *); account:* scopes and key management are session-only. Workspace keys (bk_ws_) reach every tenant and pick one with the buzzkit-tenant header; tenant keys (bk_tn_) are locked to one tenant; client keys (bk_pk_) ship inside an app and only work on /v1/client/*.
Body
application/jsonapplication/x-www-form-urlencodedmultipart/form-data
Required string length:
1 - 256Maximum string length:
128Maximum string length:
254Show child attributes
Show child attributes
Available options:
notDetermined, denied, authorized, provisional, ephemeral Show child attributes
Show child attributes