Skip to main content
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"
}
'
{
  "id": "<string>",
  "workspaceId": "<string>",
  "name": "<string>",
  "definition": {
    "type": "Id"
  },
  "updatedAt": 123,
  "createdAt": 123,
  "definitionUpdatedAt": 123,
  "exampleValue": "<string>",
  "lastRecomputed": 123,
  "status": "NotStarted"
}

Authorizations

Authorization
string
header
required

Body

application/json
workspaceId
string
required
name
string
required
id
string
definition
IdUserPropertyDefinition · object

A user property definition.

exampleValue
string
updatedAt
number
lastRecomputed
number
status
Available options:
NotStarted

Response

Default Response

id
string
required
workspaceId
string
required
name
string
required
definition
IdUserPropertyDefinition · object
required

A user property definition.

updatedAt
number
required
createdAt
number
required
definitionUpdatedAt
number
required
exampleValue
string
lastRecomputed
number
status
Available options:
NotStarted