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         "created_at": "2024-01-15T09:30:00Z",
12         "currency": "currency",
13         "customer_external_id": "customer_external_id",
14         "id": "id",
15         "interval": "interval",
16         "period_end": 1,
17         "period_start": 1,
18         "products": [
19           {
20             "created_at": "2024-01-15T09:30:00Z",
21             "currency": "currency",
22             "environment_id": "environment_id",
23             "external_id": "external_id",
24             "id": "id",
25             "interval": "interval",
26             "name": "name",
27             "price": 1,
28             "price_external_id": "price_external_id",
29             "quantity": 1.1,
30             "subscription_id": "subscription_id",
31             "updated_at": "2024-01-15T09:30:00Z",
32             "usage_type": "usage_type"
33           }
34         ],
35         "status": "status",
36         "subscription_external_id": "subscription_external_id",
37         "total_price": 1
38       }
39     ],
40     "created_at": "2024-01-15T09:30:00Z",
41     "entity_traits": [
42       {
43         "created_at": "2024-01-15T09:30:00Z",
44         "definition_id": "definition_id",
45         "environment_id": "environment_id",
46         "id": "id",
47         "updated_at": "2024-01-15T09:30:00Z",
48         "value": "value"
49       }
50     ],
51     "environment_id": "environment_id",
52     "id": "id",
53     "keys": [
54       {
55         "created_at": "2024-01-15T09:30:00Z",
56         "definition_id": "definition_id",
57         "entity_id": "entity_id",
58         "entity_type": "entity_type",
59         "environment_id": "environment_id",
60         "id": "id",
61         "key": "key",
62         "updated_at": "2024-01-15T09:30:00Z",
63         "value": "value"
64       }
65     ],
66     "name": "name",
67     "plans": [
68       {
69         "id": "id",
70         "name": "name"
71       }
72     ],
73     "updated_at": "2024-01-15T09:30:00Z",
74     "user_count": 1,
75     "billing_subscription": {
76       "created_at": "2024-01-15T09:30:00Z",
77       "currency": "currency",
78       "customer_external_id": "customer_external_id",
79       "id": "id",
80       "interval": "interval",
81       "period_end": 1,
82       "period_start": 1,
83       "products": [
84         {
85           "created_at": "2024-01-15T09:30:00Z",
86           "currency": "currency",
87           "environment_id": "environment_id",
88           "external_id": "external_id",
89           "id": "id",
90           "interval": "interval",
91           "name": "name",
92           "price": 1,
93           "price_external_id": "price_external_id",
94           "quantity": 1.1,
95           "subscription_id": "subscription_id",
96           "updated_at": "2024-01-15T09:30:00Z",
97           "usage_type": "usage_type"
98         }
99       ],
100       "status": "status",
101       "subscription_external_id": "subscription_external_id",
102       "total_price": 1,
103       "company_id": "company_id",
104       "expired_at": "2024-01-15T09:30:00Z",
105       "latest_invoice": {
106         "amount_due": 1,
107         "amount_paid": 1,
108         "amount_remaining": 1,
109         "collection_method": "collection_method",
110         "created_at": "2024-01-15T09:30:00Z",
111         "currency": "currency",
112         "customer_external_id": "customer_external_id",
113         "environment_id": "environment_id",
114         "id": "id",
115         "subtotal": 1,
116         "updated_at": "2024-01-15T09:30:00Z"
117       },
118       "metadata": {
119         "key": "value"
120       },
121       "payment_method": {
122         "created_at": "2024-01-15T09:30:00Z",
123         "customer_external_id": "customer_external_id",
124         "environment_id": "environment_id",
125         "external_id": "external_id",
126         "id": "id",
127         "payment_method_type": "payment_method_type",
128         "updated_at": "2024-01-15T09:30:00Z"
129       }
130     },
131     "last_seen_at": "2024-01-15T09:30:00Z",
132     "logo_url": "logo_url",
133     "plan": {
134       "id": "id",
135       "name": "name",
136       "billing_product_id": "billing_product_id",
137       "description": "description",
138       "image_url": "image_url",
139       "plan_period": "plan_period",
140       "plan_price": 1
141     },
142     "traits": {
143       "key": "value"
144     }
145   },
146   "params": {
147     "key": "value"
148   }
149 }

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	"created_at": "2024-01-15T09:30:00Z",
12	"currency": "currency",
13	"customer_external_id": "customer_external_id",
14	"id": "id",
15	"interval": "interval",
16	"period_end": 1,
17	"period_start": 1,
18	"products": [
19	{
20	"created_at": "2024-01-15T09:30:00Z",
21	"currency": "currency",
22	"environment_id": "environment_id",
23	"external_id": "external_id",
24	"id": "id",
25	"interval": "interval",
26	"name": "name",
27	"price": 1,
28	"price_external_id": "price_external_id",
29	"quantity": 1.1,
30	"subscription_id": "subscription_id",
31	"updated_at": "2024-01-15T09:30:00Z",
32	"usage_type": "usage_type"
33	}
34	],
35	"status": "status",
36	"subscription_external_id": "subscription_external_id",
37	"total_price": 1
38	}
39	],
40	"created_at": "2024-01-15T09:30:00Z",
41	"entity_traits": [
42	{
43	"created_at": "2024-01-15T09:30:00Z",
44	"definition_id": "definition_id",
45	"environment_id": "environment_id",
46	"id": "id",
47	"updated_at": "2024-01-15T09:30:00Z",
48	"value": "value"
49	}
50	],
51	"environment_id": "environment_id",
52	"id": "id",
53	"keys": [
54	{
55	"created_at": "2024-01-15T09:30:00Z",
56	"definition_id": "definition_id",
57	"entity_id": "entity_id",
58	"entity_type": "entity_type",
59	"environment_id": "environment_id",
60	"id": "id",
61	"key": "key",
62	"updated_at": "2024-01-15T09:30:00Z",
63	"value": "value"
64	}
65	],
66	"name": "name",
67	"plans": [
68	{
69	"id": "id",
70	"name": "name"
71	}
72	],
73	"updated_at": "2024-01-15T09:30:00Z",
74	"user_count": 1,
75	"billing_subscription": {
76	"created_at": "2024-01-15T09:30:00Z",
77	"currency": "currency",
78	"customer_external_id": "customer_external_id",
79	"id": "id",
80	"interval": "interval",
81	"period_end": 1,
82	"period_start": 1,
83	"products": [
84	{
85	"created_at": "2024-01-15T09:30:00Z",
86	"currency": "currency",
87	"environment_id": "environment_id",
88	"external_id": "external_id",
89	"id": "id",
90	"interval": "interval",
91	"name": "name",
92	"price": 1,
93	"price_external_id": "price_external_id",
94	"quantity": 1.1,
95	"subscription_id": "subscription_id",
96	"updated_at": "2024-01-15T09:30:00Z",
97	"usage_type": "usage_type"
98	}
99	],
100	"status": "status",
101	"subscription_external_id": "subscription_external_id",
102	"total_price": 1,
103	"company_id": "company_id",
104	"expired_at": "2024-01-15T09:30:00Z",
105	"latest_invoice": {
106	"amount_due": 1,
107	"amount_paid": 1,
108	"amount_remaining": 1,
109	"collection_method": "collection_method",
110	"created_at": "2024-01-15T09:30:00Z",
111	"currency": "currency",
112	"customer_external_id": "customer_external_id",
113	"environment_id": "environment_id",
114	"id": "id",
115	"subtotal": 1,
116	"updated_at": "2024-01-15T09:30:00Z"
117	},
118	"metadata": {
119	"key": "value"
120	},
121	"payment_method": {
122	"created_at": "2024-01-15T09:30:00Z",
123	"customer_external_id": "customer_external_id",
124	"environment_id": "environment_id",
125	"external_id": "external_id",
126	"id": "id",
127	"payment_method_type": "payment_method_type",
128	"updated_at": "2024-01-15T09:30:00Z"
129	}
130	},
131	"last_seen_at": "2024-01-15T09:30:00Z",
132	"logo_url": "logo_url",
133	"plan": {
134	"id": "id",
135	"name": "name",
136	"billing_product_id": "billing_product_id",
137	"description": "description",
138	"image_url": "image_url",
139	"plan_period": "plan_period",
140	"plan_price": 1
141	},
142	"traits": {
143	"key": "value"
144	}
145	},
146	"params": {
147	"key": "value"
148	}
149	}