Upsert user

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

1 { 2 "data": { 3 "company_memberships": [ 4 { 5 "company_id": "foo", 6 "created_at": "foo", 7 "id": "foo", 8 "updated_at": "foo", 9 "user_id": "foo", 10 "company": { 11 "created_at": "foo", 12 "environment_id": "foo", 13 "id": "foo", 14 "name": "foo", 15 "updated_at": "foo", 16 "last_seen_at": "foo", 17 "logo_url": "foo" 18 } 19 } 20 ], 21 "created_at": "foo", 22 "entity_traits": [ 23 { 24 "created_at": "foo", 25 "definition_id": "foo", 26 "environment_id": "foo", 27 "id": "foo", 28 "updated_at": "foo", 29 "value": "foo", 30 "definition": { 31 "created_at": "foo", 32 "display_name": "foo", 33 "entity_type": "foo", 34 "hierarchy": [ 35 "foo" 36 ], 37 "id": "foo", 38 "trait_type": "foo", 39 "updated_at": "foo" 40 } 41 } 42 ], 43 "environment_id": "foo", 44 "id": "foo", 45 "keys": [ 46 { 47 "created_at": "foo", 48 "definition_id": "foo", 49 "entity_id": "foo", 50 "entity_type": "foo", 51 "environment_id": "foo", 52 "id": "foo", 53 "key": "foo", 54 "updated_at": "foo", 55 "value": "foo", 56 "definition": { 57 "created_at": "foo", 58 "entity_type": "foo", 59 "id": "foo", 60 "key": "foo", 61 "updated_at": "foo" 62 } 63 } 64 ], 65 "name": "foo", 66 "updated_at": "foo", 67 "last_seen_at": "foo", 68 "traits": {} 69 }, 70 "params": {} 71 }

Request

This endpoint expects an object.

keysmap from strings to stringsRequired

See Key Management for more information

companieslist of maps from strings to strings or nullOptional

Optionally specify companies using array of key/value pairs

companymap from strings to strings or nullOptional

Add user to this company. Takes priority over companies. For exhaustive list of companies, use companies

company_idstring or nullOptional

Add user to this company. Takes priority over company_ids. For exhaustive list of companies, use company_ids

company_idslist of strings or nullOptional

Optionally specify companies using Schematic company ID

idstring or nullOptional

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

last_seen_atstring or nullOptionalformat: "date-time"

namestring or nullOptional

traitsobjectOptional

A map of trait names to trait values

update_onlyboolean or nullOptional

Response

dataobject

paramsobject

Input parameters

Headers

Request

Response

Errors