Upsert company

POST

Request

This endpoint expects an object.

keysmap from strings to stringsRequired

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

POST

1 curl -X POST https://api.schematichq.com/companies \
2      -H "X-Schematic-Api-Key: <apiKey>" \
3      -H "Content-Type: application/json" \
4      -d '{
5   "keys": {
6     "key": "value"
7   }
8 }'

200Successful

1 {
2   "data": {
3     "add_ons": [
4       {
5         "id": "id",
6         "name": "name"
7       }
8     ],
9     "billing_subscriptions": [
10       {
11         "currency": "currency",
12         "external_id": "external_id",
13         "id": "id",
14         "interval": "interval",
15         "total_price": 1,
16         "updated_at": "2024-01-15T09:30:00Z"
17       }
18     ],
19     "created_at": "2024-01-15T09:30:00Z",
20     "entity_traits": [
21       {
22         "created_at": "2024-01-15T09:30:00Z",
23         "definition_id": "definition_id",
24         "environment_id": "environment_id",
25         "id": "id",
26         "updated_at": "2024-01-15T09:30:00Z",
27         "value": "value"
28       }
29     ],
30     "environment_id": "environment_id",
31     "id": "id",
32     "keys": [
33       {
34         "created_at": "2024-01-15T09:30:00Z",
35         "definition_id": "definition_id",
36         "entity_id": "entity_id",
37         "entity_type": "entity_type",
38         "environment_id": "environment_id",
39         "id": "id",
40         "key": "key",
41         "updated_at": "2024-01-15T09:30:00Z",
42         "value": "value"
43       }
44     ],
45     "name": "name",
46     "plans": [
47       {
48         "id": "id",
49         "name": "name"
50       }
51     ],
52     "updated_at": "2024-01-15T09:30:00Z",
53     "user_count": 1,
54     "last_seen_at": "2024-01-15T09:30:00Z",
55     "logo_url": "logo_url",
56     "plan": {
57       "id": "id",
58       "name": "name",
59       "billing_product_id": "billing_product_id",
60       "description": "description",
61       "image_url": "image_url",
62       "plan_period": "plan_period",
63       "plan_price": 1
64     },
65     "traits": {
66       "key": "value"
67     }
68   },
69   "params": {
70     "key": "value"
71   }
72 }

Built with

1	curl -X POST https://api.schematichq.com/companies \
2	-H "X-Schematic-Api-Key: <apiKey>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"keys": {
6	"key": "value"
7	}
8	}'

1	{
2	"data": {
3	"add_ons": [
4	{
5	"id": "id",
6	"name": "name"
7	}
8	],
9	"billing_subscriptions": [
10	{
11	"currency": "currency",
12	"external_id": "external_id",
13	"id": "id",
14	"interval": "interval",
15	"total_price": 1,
16	"updated_at": "2024-01-15T09:30:00Z"
17	}
18	],
19	"created_at": "2024-01-15T09:30:00Z",
20	"entity_traits": [
21	{
22	"created_at": "2024-01-15T09:30:00Z",
23	"definition_id": "definition_id",
24	"environment_id": "environment_id",
25	"id": "id",
26	"updated_at": "2024-01-15T09:30:00Z",
27	"value": "value"
28	}
29	],
30	"environment_id": "environment_id",
31	"id": "id",
32	"keys": [
33	{
34	"created_at": "2024-01-15T09:30:00Z",
35	"definition_id": "definition_id",
36	"entity_id": "entity_id",
37	"entity_type": "entity_type",
38	"environment_id": "environment_id",
39	"id": "id",
40	"key": "key",
41	"updated_at": "2024-01-15T09:30:00Z",
42	"value": "value"
43	}
44	],
45	"name": "name",
46	"plans": [
47	{
48	"id": "id",
49	"name": "name"
50	}
51	],
52	"updated_at": "2024-01-15T09:30:00Z",
53	"user_count": 1,
54	"last_seen_at": "2024-01-15T09:30:00Z",
55	"logo_url": "logo_url",
56	"plan": {
57	"id": "id",
58	"name": "name",
59	"billing_product_id": "billing_product_id",
60	"description": "description",
61	"image_url": "image_url",
62	"plan_period": "plan_period",
63	"plan_price": 1
64	},
65	"traits": {
66	"key": "value"
67	}
68	},
69	"params": {
70	"key": "value"
71	}
72	}