Upsert user

POST

1 import { SchematicClient, Schematic } from "@schematichq/schematic-typescript-node";
2 
3 const client = new SchematicClient({ apiKey: "YOUR_API_KEY" });
4 await client.companies.upsertUser({
5     company: {
6         "key": "value"
7     },
8     keys: {
9         "key": "value"
10     }
11 });

Play

1 {
2   "data": {
3     "company_memberships": [
4       {
5         "company_id": "company_id",
6         "created_at": "2024-01-15T09:30:00Z",
7         "id": "id",
8         "updated_at": "2024-01-15T09:30:00Z",
9         "user_id": "user_id"
10       }
11     ],
12     "created_at": "2024-01-15T09:30:00Z",
13     "entity_traits": [
14       {
15         "created_at": "2024-01-15T09:30:00Z",
16         "definition_id": "definition_id",
17         "environment_id": "environment_id",
18         "id": "id",
19         "updated_at": "2024-01-15T09:30:00Z",
20         "value": "value"
21       }
22     ],
23     "environment_id": "environment_id",
24     "id": "id",
25     "keys": [
26       {
27         "created_at": "2024-01-15T09:30:00Z",
28         "definition_id": "definition_id",
29         "entity_id": "entity_id",
30         "entity_type": "entity_type",
31         "environment_id": "environment_id",
32         "id": "id",
33         "key": "key",
34         "updated_at": "2024-01-15T09:30:00Z",
35         "value": "value"
36       }
37     ],
38     "name": "name",
39     "updated_at": "2024-01-15T09:30:00Z",
40     "last_seen_at": "2024-01-15T09:30:00Z",
41     "traits": {
42       "key": "value"
43     }
44   },
45   "params": {
46     "key": "value"
47   }
48 }

Request

This endpoint expects an object.

companymap from strings to stringsRequired

Optionally specify company using key/value pairs

keysmap from strings to stringsRequired

company_idstringOptional

Optionally specify company using Schematic company ID

idstringOptional

If you know the Schematic ID, you can use that here instead of keys

last_seen_atdatetimeOptional

namestringOptional

traitsmap from strings to anyOptional

A map of trait names to trait values

update_onlybooleanOptional

Response

dataobject

paramsmap from strings to any

Input parameters

Upsert user

Headers

Request

Response

Errors