Upsert user trait | SchematicHQ

import { SchematicClient } from "@schematichq/schematic-typescript-node";
const client = new SchematicClient({ apiKey: "YOUR_API_KEY" });
await client.companies.upsertUserTrait({
    keys: {
        "key": "value"
    },
    trait: "trait"
});

{
  "data": {
    "company_memberships": [
      {
        "company_id": "comp_123456789",
        "created_at": "2023-11-20T14:22:00Z",
        "id": "mem_987654321",
        "updated_at": "2024-04-01T12:00:00Z",
        "user_id": "user_123456789",
        "company": {
          "created_at": "2023-11-20T14:22:00Z",
          "environment_id": "env_987654321",
          "id": "comp_123456789",
          "name": "Acme Corporation",
          "updated_at": "2024-04-01T12:00:00Z",
          "last_seen_at": "2024-04-10T16:45:00Z",
          "logo_url": "https://example.com/logos/acme_corp.png"
        }
      }
    ],
    "created_at": "2023-11-20T14:22:00Z",
    "entity_traits": [
      {
        "created_at": "2024-04-10T16:45:00Z",
        "definition_id": "trait_abc123",
        "environment_id": "env_987654321",
        "id": "traitval_456def",
        "updated_at": "2024-04-10T16:45:00Z",
        "value": "active",
        "definition": {
          "created_at": "2023-11-20T14:22:00Z",
          "display_name": "Subscription Status",
          "entity_type": "user",
          "hierarchy": [
            "account",
            "subscription"
          ],
          "id": "trait_abc123",
          "trait_type": "string",
          "updated_at": "2024-04-10T16:45:00Z"
        }
      }
    ],
    "environment_id": "env_987654321",
    "id": "user_123456789",
    "keys": [
      {
        "created_at": "2023-11-20T14:22:00Z",
        "definition_id": "key_email",
        "entity_id": "user_123456789",
        "entity_type": "user",
        "environment_id": "env_987654321",
        "id": "keyval_789ghi",
        "key": "email",
        "updated_at": "2024-04-10T16:45:00Z",
        "value": "jane.doe@example.com",
        "definition": {
          "created_at": "2023-11-20T14:22:00Z",
          "entity_type": "user",
          "id": "key_email",
          "key": "email",
          "updated_at": "2024-04-10T16:45:00Z"
        }
      }
    ],
    "name": "Jane Doe",
    "updated_at": "2024-04-10T16:45:00Z",
    "last_seen_at": "2024-04-10T16:45:00Z",
    "traits": {}
  },
  "params": {}
}

Authentication

X-Schematic-Api-Keystring

API Key authentication via header

Request

This endpoint expects an object.

keysmap from strings to stringsRequired

Key/value pairs to identify a company or user

traitstringRequired<=255 characters

Name of the trait to update

incrinteger or nullOptional

Amount to increment the trait by (positive or negative)

setstring or nullOptional<=1024 characters

Value to set the trait to

update_onlyboolean or nullOptional

Unless this is set, the company or user will be created if it does not already exist

Response

dataobject

paramsobject

Input parameters

Authentication

Request

Response

Errors