Create or update a user
curl --request POST \
--url https://api.hacktionbase.com/v1/users \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"externalId": "user_123",
"email": "jsmith@example.com",
"anonymousId": "<string>",
"attributes": {},
"accounts": [
{
"externalId": "org_456",
"name": "<string>",
"domain": "acme.com",
"industry": "SaaS",
"plans": [
{
"key": "pro",
"label": "Pro Monthly",
"price": 1,
"currency": "USD"
}
],
"plan": "<string>",
"attributes": {},
"tags": [
"<string>"
],
"categories": [
"<string>"
]
}
],
"tags": [
"<string>"
],
"categories": [
"<string>"
]
}
'import requests
url = "https://api.hacktionbase.com/v1/users"
payload = {
"externalId": "user_123",
"email": "jsmith@example.com",
"anonymousId": "<string>",
"attributes": {},
"accounts": [
{
"externalId": "org_456",
"name": "<string>",
"domain": "acme.com",
"industry": "SaaS",
"plans": [
{
"key": "pro",
"label": "Pro Monthly",
"price": 1,
"currency": "USD"
}
],
"plan": "<string>",
"attributes": {},
"tags": ["<string>"],
"categories": ["<string>"]
}
],
"tags": ["<string>"],
"categories": ["<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: 'user_123',
email: 'jsmith@example.com',
anonymousId: '<string>',
attributes: {},
accounts: [
{
externalId: 'org_456',
name: '<string>',
domain: 'acme.com',
industry: 'SaaS',
plans: [{key: 'pro', label: 'Pro Monthly', price: 1, currency: 'USD'}],
plan: '<string>',
attributes: {},
tags: ['<string>'],
categories: ['<string>']
}
],
tags: ['<string>'],
categories: ['<string>']
})
};
fetch('https://api.hacktionbase.com/v1/users', 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.hacktionbase.com/v1/users",
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' => 'user_123',
'email' => 'jsmith@example.com',
'anonymousId' => '<string>',
'attributes' => [
],
'accounts' => [
[
'externalId' => 'org_456',
'name' => '<string>',
'domain' => 'acme.com',
'industry' => 'SaaS',
'plans' => [
[
'key' => 'pro',
'label' => 'Pro Monthly',
'price' => 1,
'currency' => 'USD'
]
],
'plan' => '<string>',
'attributes' => [
],
'tags' => [
'<string>'
],
'categories' => [
'<string>'
]
]
],
'tags' => [
'<string>'
],
'categories' => [
'<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.hacktionbase.com/v1/users"
payload := strings.NewReader("{\n \"externalId\": \"user_123\",\n \"email\": \"jsmith@example.com\",\n \"anonymousId\": \"<string>\",\n \"attributes\": {},\n \"accounts\": [\n {\n \"externalId\": \"org_456\",\n \"name\": \"<string>\",\n \"domain\": \"acme.com\",\n \"industry\": \"SaaS\",\n \"plans\": [\n {\n \"key\": \"pro\",\n \"label\": \"Pro Monthly\",\n \"price\": 1,\n \"currency\": \"USD\"\n }\n ],\n \"plan\": \"<string>\",\n \"attributes\": {},\n \"tags\": [\n \"<string>\"\n ],\n \"categories\": [\n \"<string>\"\n ]\n }\n ],\n \"tags\": [\n \"<string>\"\n ],\n \"categories\": [\n \"<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.hacktionbase.com/v1/users")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"externalId\": \"user_123\",\n \"email\": \"jsmith@example.com\",\n \"anonymousId\": \"<string>\",\n \"attributes\": {},\n \"accounts\": [\n {\n \"externalId\": \"org_456\",\n \"name\": \"<string>\",\n \"domain\": \"acme.com\",\n \"industry\": \"SaaS\",\n \"plans\": [\n {\n \"key\": \"pro\",\n \"label\": \"Pro Monthly\",\n \"price\": 1,\n \"currency\": \"USD\"\n }\n ],\n \"plan\": \"<string>\",\n \"attributes\": {},\n \"tags\": [\n \"<string>\"\n ],\n \"categories\": [\n \"<string>\"\n ]\n }\n ],\n \"tags\": [\n \"<string>\"\n ],\n \"categories\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.hacktionbase.com/v1/users")
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\": \"user_123\",\n \"email\": \"jsmith@example.com\",\n \"anonymousId\": \"<string>\",\n \"attributes\": {},\n \"accounts\": [\n {\n \"externalId\": \"org_456\",\n \"name\": \"<string>\",\n \"domain\": \"acme.com\",\n \"industry\": \"SaaS\",\n \"plans\": [\n {\n \"key\": \"pro\",\n \"label\": \"Pro Monthly\",\n \"price\": 1,\n \"currency\": \"USD\"\n }\n ],\n \"plan\": \"<string>\",\n \"attributes\": {},\n \"tags\": [\n \"<string>\"\n ],\n \"categories\": [\n \"<string>\"\n ]\n }\n ],\n \"tags\": [\n \"<string>\"\n ],\n \"categories\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"ok": true,
"requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}Endpoints
Create or Update User
Upsert a user keyed by externalId. Requires an ingestion API key (ak_*). Embedded accounts are upserted and linked to the user (additive — see UserUpsertRequest).
POST
/
users
Create or update a user
curl --request POST \
--url https://api.hacktionbase.com/v1/users \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"externalId": "user_123",
"email": "jsmith@example.com",
"anonymousId": "<string>",
"attributes": {},
"accounts": [
{
"externalId": "org_456",
"name": "<string>",
"domain": "acme.com",
"industry": "SaaS",
"plans": [
{
"key": "pro",
"label": "Pro Monthly",
"price": 1,
"currency": "USD"
}
],
"plan": "<string>",
"attributes": {},
"tags": [
"<string>"
],
"categories": [
"<string>"
]
}
],
"tags": [
"<string>"
],
"categories": [
"<string>"
]
}
'import requests
url = "https://api.hacktionbase.com/v1/users"
payload = {
"externalId": "user_123",
"email": "jsmith@example.com",
"anonymousId": "<string>",
"attributes": {},
"accounts": [
{
"externalId": "org_456",
"name": "<string>",
"domain": "acme.com",
"industry": "SaaS",
"plans": [
{
"key": "pro",
"label": "Pro Monthly",
"price": 1,
"currency": "USD"
}
],
"plan": "<string>",
"attributes": {},
"tags": ["<string>"],
"categories": ["<string>"]
}
],
"tags": ["<string>"],
"categories": ["<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: 'user_123',
email: 'jsmith@example.com',
anonymousId: '<string>',
attributes: {},
accounts: [
{
externalId: 'org_456',
name: '<string>',
domain: 'acme.com',
industry: 'SaaS',
plans: [{key: 'pro', label: 'Pro Monthly', price: 1, currency: 'USD'}],
plan: '<string>',
attributes: {},
tags: ['<string>'],
categories: ['<string>']
}
],
tags: ['<string>'],
categories: ['<string>']
})
};
fetch('https://api.hacktionbase.com/v1/users', 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.hacktionbase.com/v1/users",
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' => 'user_123',
'email' => 'jsmith@example.com',
'anonymousId' => '<string>',
'attributes' => [
],
'accounts' => [
[
'externalId' => 'org_456',
'name' => '<string>',
'domain' => 'acme.com',
'industry' => 'SaaS',
'plans' => [
[
'key' => 'pro',
'label' => 'Pro Monthly',
'price' => 1,
'currency' => 'USD'
]
],
'plan' => '<string>',
'attributes' => [
],
'tags' => [
'<string>'
],
'categories' => [
'<string>'
]
]
],
'tags' => [
'<string>'
],
'categories' => [
'<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.hacktionbase.com/v1/users"
payload := strings.NewReader("{\n \"externalId\": \"user_123\",\n \"email\": \"jsmith@example.com\",\n \"anonymousId\": \"<string>\",\n \"attributes\": {},\n \"accounts\": [\n {\n \"externalId\": \"org_456\",\n \"name\": \"<string>\",\n \"domain\": \"acme.com\",\n \"industry\": \"SaaS\",\n \"plans\": [\n {\n \"key\": \"pro\",\n \"label\": \"Pro Monthly\",\n \"price\": 1,\n \"currency\": \"USD\"\n }\n ],\n \"plan\": \"<string>\",\n \"attributes\": {},\n \"tags\": [\n \"<string>\"\n ],\n \"categories\": [\n \"<string>\"\n ]\n }\n ],\n \"tags\": [\n \"<string>\"\n ],\n \"categories\": [\n \"<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.hacktionbase.com/v1/users")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"externalId\": \"user_123\",\n \"email\": \"jsmith@example.com\",\n \"anonymousId\": \"<string>\",\n \"attributes\": {},\n \"accounts\": [\n {\n \"externalId\": \"org_456\",\n \"name\": \"<string>\",\n \"domain\": \"acme.com\",\n \"industry\": \"SaaS\",\n \"plans\": [\n {\n \"key\": \"pro\",\n \"label\": \"Pro Monthly\",\n \"price\": 1,\n \"currency\": \"USD\"\n }\n ],\n \"plan\": \"<string>\",\n \"attributes\": {},\n \"tags\": [\n \"<string>\"\n ],\n \"categories\": [\n \"<string>\"\n ]\n }\n ],\n \"tags\": [\n \"<string>\"\n ],\n \"categories\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.hacktionbase.com/v1/users")
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\": \"user_123\",\n \"email\": \"jsmith@example.com\",\n \"anonymousId\": \"<string>\",\n \"attributes\": {},\n \"accounts\": [\n {\n \"externalId\": \"org_456\",\n \"name\": \"<string>\",\n \"domain\": \"acme.com\",\n \"industry\": \"SaaS\",\n \"plans\": [\n {\n \"key\": \"pro\",\n \"label\": \"Pro Monthly\",\n \"price\": 1,\n \"currency\": \"USD\"\n }\n ],\n \"plan\": \"<string>\",\n \"attributes\": {},\n \"tags\": [\n \"<string>\"\n ],\n \"categories\": [\n \"<string>\"\n ]\n }\n ],\n \"tags\": [\n \"<string>\"\n ],\n \"categories\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"ok": true,
"requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
Example:
"user_123"
Account memberships — each account is upserted (keyed by its own externalId) and linked to the user. Additive: accounts omitted from a later call are NOT unlinked.
Show child attributes
Show child attributes
Deprecated — single account membership. Use accounts instead.
Show child attributes
Show child attributes
Tag labels, resolved server-side. Unknown labels are silently ignored (tags are created from the dashboard).
Category labels, resolved server-side. Unknown labels are silently ignored.