cURL
curl --request PUT \
--url http://localhost:3001/api/admin/user-properties/ \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"workspaceId": "<string>",
"name": "<string>",
"id": "<string>",
"definition": {
"type": "Id"
},
"exampleValue": "<string>",
"updatedAt": 123,
"lastRecomputed": 123,
"status": "NotStarted"
}
'import requests
url = "http://localhost:3001/api/admin/user-properties/"
payload = {
"workspaceId": "<string>",
"name": "<string>",
"id": "<string>",
"definition": { "type": "Id" },
"exampleValue": "<string>",
"updatedAt": 123,
"lastRecomputed": 123,
"status": "NotStarted"
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
workspaceId: '<string>',
name: '<string>',
id: '<string>',
definition: {type: 'Id'},
exampleValue: '<string>',
updatedAt: 123,
lastRecomputed: 123,
status: 'NotStarted'
})
};
fetch('http://localhost:3001/api/admin/user-properties/', 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 => "3001",
CURLOPT_URL => "http://localhost:3001/api/admin/user-properties/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'workspaceId' => '<string>',
'name' => '<string>',
'id' => '<string>',
'definition' => [
'type' => 'Id'
],
'exampleValue' => '<string>',
'updatedAt' => 123,
'lastRecomputed' => 123,
'status' => 'NotStarted'
]),
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 := "http://localhost:3001/api/admin/user-properties/"
payload := strings.NewReader("{\n \"workspaceId\": \"<string>\",\n \"name\": \"<string>\",\n \"id\": \"<string>\",\n \"definition\": {\n \"type\": \"Id\"\n },\n \"exampleValue\": \"<string>\",\n \"updatedAt\": 123,\n \"lastRecomputed\": 123,\n \"status\": \"NotStarted\"\n}")
req, _ := http.NewRequest("PUT", 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.put("http://localhost:3001/api/admin/user-properties/")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"workspaceId\": \"<string>\",\n \"name\": \"<string>\",\n \"id\": \"<string>\",\n \"definition\": {\n \"type\": \"Id\"\n },\n \"exampleValue\": \"<string>\",\n \"updatedAt\": 123,\n \"lastRecomputed\": 123,\n \"status\": \"NotStarted\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3001/api/admin/user-properties/")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Put.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"workspaceId\": \"<string>\",\n \"name\": \"<string>\",\n \"id\": \"<string>\",\n \"definition\": {\n \"type\": \"Id\"\n },\n \"exampleValue\": \"<string>\",\n \"updatedAt\": 123,\n \"lastRecomputed\": 123,\n \"status\": \"NotStarted\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"workspaceId": "<string>",
"name": "<string>",
"definition": {
"type": "Id"
},
"updatedAt": 123,
"createdAt": 123,
"definitionUpdatedAt": 123,
"exampleValue": "<string>",
"lastRecomputed": 123,
"status": "NotStarted"
}{
"type": "UserPropertyAlreadyExists",
"message": "<string>"
}API Reference
PUT /api/admin/user-properties/
Create or update a user property.
PUT
/
api
/
admin
/
user-properties
/
cURL
curl --request PUT \
--url http://localhost:3001/api/admin/user-properties/ \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"workspaceId": "<string>",
"name": "<string>",
"id": "<string>",
"definition": {
"type": "Id"
},
"exampleValue": "<string>",
"updatedAt": 123,
"lastRecomputed": 123,
"status": "NotStarted"
}
'import requests
url = "http://localhost:3001/api/admin/user-properties/"
payload = {
"workspaceId": "<string>",
"name": "<string>",
"id": "<string>",
"definition": { "type": "Id" },
"exampleValue": "<string>",
"updatedAt": 123,
"lastRecomputed": 123,
"status": "NotStarted"
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
workspaceId: '<string>',
name: '<string>',
id: '<string>',
definition: {type: 'Id'},
exampleValue: '<string>',
updatedAt: 123,
lastRecomputed: 123,
status: 'NotStarted'
})
};
fetch('http://localhost:3001/api/admin/user-properties/', 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 => "3001",
CURLOPT_URL => "http://localhost:3001/api/admin/user-properties/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'workspaceId' => '<string>',
'name' => '<string>',
'id' => '<string>',
'definition' => [
'type' => 'Id'
],
'exampleValue' => '<string>',
'updatedAt' => 123,
'lastRecomputed' => 123,
'status' => 'NotStarted'
]),
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 := "http://localhost:3001/api/admin/user-properties/"
payload := strings.NewReader("{\n \"workspaceId\": \"<string>\",\n \"name\": \"<string>\",\n \"id\": \"<string>\",\n \"definition\": {\n \"type\": \"Id\"\n },\n \"exampleValue\": \"<string>\",\n \"updatedAt\": 123,\n \"lastRecomputed\": 123,\n \"status\": \"NotStarted\"\n}")
req, _ := http.NewRequest("PUT", 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.put("http://localhost:3001/api/admin/user-properties/")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"workspaceId\": \"<string>\",\n \"name\": \"<string>\",\n \"id\": \"<string>\",\n \"definition\": {\n \"type\": \"Id\"\n },\n \"exampleValue\": \"<string>\",\n \"updatedAt\": 123,\n \"lastRecomputed\": 123,\n \"status\": \"NotStarted\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3001/api/admin/user-properties/")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Put.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"workspaceId\": \"<string>\",\n \"name\": \"<string>\",\n \"id\": \"<string>\",\n \"definition\": {\n \"type\": \"Id\"\n },\n \"exampleValue\": \"<string>\",\n \"updatedAt\": 123,\n \"lastRecomputed\": 123,\n \"status\": \"NotStarted\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"workspaceId": "<string>",
"name": "<string>",
"definition": {
"type": "Id"
},
"updatedAt": 123,
"createdAt": 123,
"definitionUpdatedAt": 123,
"exampleValue": "<string>",
"lastRecomputed": 123,
"status": "NotStarted"
}{
"type": "UserPropertyAlreadyExists",
"message": "<string>"
}Authorizations
Body
application/json
A user property definition that resolves to a user's id.
- IdUserPropertyDefinition
- AnonymousIdUserPropertyDefinition
- GroupUserPropertyDefinition
- TraitUserPropertyDefinition
- PerformedUserPropertyDefinition
- FileUserPropertyDefinition
- KeyedPerformedUserPropertyDefinition
- PerformedManyUserPropertyDefinition
Show child attributes
Show child attributes
Available options:
NotStarted Response
Default Response
A user property definition that resolves to a user's id.
- IdUserPropertyDefinition
- AnonymousIdUserPropertyDefinition
- GroupUserPropertyDefinition
- TraitUserPropertyDefinition
- PerformedUserPropertyDefinition
- FileUserPropertyDefinition
- KeyedPerformedUserPropertyDefinition
- PerformedManyUserPropertyDefinition
Show child attributes
Show child attributes
Available options:
NotStarted ⌘I

