Create company override

POST

Request

This endpoint expects an object.

company_idstringRequired

feature_idstringRequired

value_typeenumRequired

Allowed values: booleannumerictraitunlimited

expiration_datedatetimeOptional

metric_periodenumOptional

Allowed values: all_timebillingcurrent_monthcurrent_weekcurrent_day

metric_period_month_reset"first_of_month" or "billing_cycle"Optional

Allowed values: first_of_monthbilling_cycle

value_boolbooleanOptional

value_numericintegerOptional

value_trait_idstringOptional

Response

Created

dataobject

The updated resource

paramsmap from strings to any

Input parameters

POST

1 curl -X POST https://api.schematichq.com/company-overrides \
2      -H "X-Schematic-Api-Key: <apiKey>" \
3      -H "Content-Type: application/json" \
4      -d '{
5   "company_id": "company_id",
6   "feature_id": "feature_id",
7   "value_type": "boolean"
8 }'

200Successful

1 {
2   "data": {
3     "company_id": "company_id",
4     "created_at": "2024-01-15T09:30:00Z",
5     "environment_id": "environment_id",
6     "feature_id": "feature_id",
7     "id": "id",
8     "updated_at": "2024-01-15T09:30:00Z",
9     "value_type": "value_type",
10     "company": {
11       "add_ons": [
12         {
13           "id": "id",
14           "name": "name"
15         }
16       ],
17       "billing_subscriptions": [
18         {
19           "created_at": "2024-01-15T09:30:00Z",
20           "currency": "currency",
21           "customer_external_id": "customer_external_id",
22           "id": "id",
23           "interval": "interval",
24           "period_end": 1,
25           "period_start": 1,
26           "products": [
27             {
28               "created_at": "2024-01-15T09:30:00Z",
29               "currency": "currency",
30               "environment_id": "environment_id",
31               "external_id": "external_id",
32               "id": "id",
33               "interval": "interval",
34               "name": "name",
35               "price": 1,
36               "price_external_id": "price_external_id",
37               "quantity": 1.1,
38               "subscription_id": "subscription_id",
39               "updated_at": "2024-01-15T09:30:00Z",
40               "usage_type": "usage_type"
41             }
42           ],
43           "status": "status",
44           "subscription_external_id": "subscription_external_id",
45           "total_price": 1
46         }
47       ],
48       "created_at": "2024-01-15T09:30:00Z",
49       "entity_traits": [
50         {
51           "created_at": "2024-01-15T09:30:00Z",
52           "definition_id": "definition_id",
53           "environment_id": "environment_id",
54           "id": "id",
55           "updated_at": "2024-01-15T09:30:00Z",
56           "value": "value"
57         }
58       ],
59       "environment_id": "environment_id",
60       "id": "id",
61       "keys": [
62         {
63           "created_at": "2024-01-15T09:30:00Z",
64           "definition_id": "definition_id",
65           "entity_id": "entity_id",
66           "entity_type": "entity_type",
67           "environment_id": "environment_id",
68           "id": "id",
69           "key": "key",
70           "updated_at": "2024-01-15T09:30:00Z",
71           "value": "value"
72         }
73       ],
74       "name": "name",
75       "plans": [
76         {
77           "id": "id",
78           "name": "name"
79         }
80       ],
81       "updated_at": "2024-01-15T09:30:00Z",
82       "user_count": 1,
83       "billing_subscription": {
84         "created_at": "2024-01-15T09:30:00Z",
85         "currency": "currency",
86         "customer_external_id": "customer_external_id",
87         "id": "id",
88         "interval": "interval",
89         "period_end": 1,
90         "period_start": 1,
91         "products": [
92           {
93             "created_at": "2024-01-15T09:30:00Z",
94             "currency": "currency",
95             "environment_id": "environment_id",
96             "external_id": "external_id",
97             "id": "id",
98             "interval": "interval",
99             "name": "name",
100             "price": 1,
101             "price_external_id": "price_external_id",
102             "quantity": 1.1,
103             "subscription_id": "subscription_id",
104             "updated_at": "2024-01-15T09:30:00Z",
105             "usage_type": "usage_type"
106           }
107         ],
108         "status": "status",
109         "subscription_external_id": "subscription_external_id",
110         "total_price": 1
111       },
112       "last_seen_at": "2024-01-15T09:30:00Z",
113       "logo_url": "logo_url",
114       "plan": {
115         "id": "id",
116         "name": "name"
117       },
118       "traits": {
119         "key": "value"
120       }
121     },
122     "expiration_date": "2024-01-15T09:30:00Z",
123     "feature": {
124       "created_at": "2024-01-15T09:30:00Z",
125       "description": "description",
126       "feature_type": "feature_type",
127       "icon": "icon",
128       "id": "id",
129       "name": "name",
130       "updated_at": "2024-01-15T09:30:00Z",
131       "event_subtype": "event_subtype",
132       "lifecycle_phase": "lifecycle_phase",
133       "maintainer_id": "maintainer_id",
134       "trait_id": "trait_id"
135     },
136     "metric_period": "metric_period",
137     "metric_period_month_reset": "metric_period_month_reset",
138     "rule_id": "rule_id",
139     "value_bool": true,
140     "value_numeric": 1,
141     "value_trait": {
142       "created_at": "2024-01-15T09:30:00Z",
143       "display_name": "display_name",
144       "entity_type": "entity_type",
145       "hierarchy": [
146         "hierarchy"
147       ],
148       "id": "id",
149       "trait_type": "trait_type",
150       "updated_at": "2024-01-15T09:30:00Z"
151     },
152     "value_trait_id": "value_trait_id"
153   },
154   "params": {
155     "key": "value"
156   }
157 }

Built with

1	curl -X POST https://api.schematichq.com/company-overrides \
2	-H "X-Schematic-Api-Key: <apiKey>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"company_id": "company_id",
6	"feature_id": "feature_id",
7	"value_type": "boolean"
8	}'

1	{
2	"data": {
3	"company_id": "company_id",
4	"created_at": "2024-01-15T09:30:00Z",
5	"environment_id": "environment_id",
6	"feature_id": "feature_id",
7	"id": "id",
8	"updated_at": "2024-01-15T09:30:00Z",
9	"value_type": "value_type",
10	"company": {
11	"add_ons": [
12	{
13	"id": "id",
14	"name": "name"
15	}
16	],
17	"billing_subscriptions": [
18	{
19	"created_at": "2024-01-15T09:30:00Z",
20	"currency": "currency",
21	"customer_external_id": "customer_external_id",
22	"id": "id",
23	"interval": "interval",
24	"period_end": 1,
25	"period_start": 1,
26	"products": [
27	{
28	"created_at": "2024-01-15T09:30:00Z",
29	"currency": "currency",
30	"environment_id": "environment_id",
31	"external_id": "external_id",
32	"id": "id",
33	"interval": "interval",
34	"name": "name",
35	"price": 1,
36	"price_external_id": "price_external_id",
37	"quantity": 1.1,
38	"subscription_id": "subscription_id",
39	"updated_at": "2024-01-15T09:30:00Z",
40	"usage_type": "usage_type"
41	}
42	],
43	"status": "status",
44	"subscription_external_id": "subscription_external_id",
45	"total_price": 1
46	}
47	],
48	"created_at": "2024-01-15T09:30:00Z",
49	"entity_traits": [
50	{
51	"created_at": "2024-01-15T09:30:00Z",
52	"definition_id": "definition_id",
53	"environment_id": "environment_id",
54	"id": "id",
55	"updated_at": "2024-01-15T09:30:00Z",
56	"value": "value"
57	}
58	],
59	"environment_id": "environment_id",
60	"id": "id",
61	"keys": [
62	{
63	"created_at": "2024-01-15T09:30:00Z",
64	"definition_id": "definition_id",
65	"entity_id": "entity_id",
66	"entity_type": "entity_type",
67	"environment_id": "environment_id",
68	"id": "id",
69	"key": "key",
70	"updated_at": "2024-01-15T09:30:00Z",
71	"value": "value"
72	}
73	],
74	"name": "name",
75	"plans": [
76	{
77	"id": "id",
78	"name": "name"
79	}
80	],
81	"updated_at": "2024-01-15T09:30:00Z",
82	"user_count": 1,
83	"billing_subscription": {
84	"created_at": "2024-01-15T09:30:00Z",
85	"currency": "currency",
86	"customer_external_id": "customer_external_id",
87	"id": "id",
88	"interval": "interval",
89	"period_end": 1,
90	"period_start": 1,
91	"products": [
92	{
93	"created_at": "2024-01-15T09:30:00Z",
94	"currency": "currency",
95	"environment_id": "environment_id",
96	"external_id": "external_id",
97	"id": "id",
98	"interval": "interval",
99	"name": "name",
100	"price": 1,
101	"price_external_id": "price_external_id",
102	"quantity": 1.1,
103	"subscription_id": "subscription_id",
104	"updated_at": "2024-01-15T09:30:00Z",
105	"usage_type": "usage_type"
106	}
107	],
108	"status": "status",
109	"subscription_external_id": "subscription_external_id",
110	"total_price": 1
111	},
112	"last_seen_at": "2024-01-15T09:30:00Z",
113	"logo_url": "logo_url",
114	"plan": {
115	"id": "id",
116	"name": "name"
117	},
118	"traits": {
119	"key": "value"
120	}
121	},
122	"expiration_date": "2024-01-15T09:30:00Z",
123	"feature": {
124	"created_at": "2024-01-15T09:30:00Z",
125	"description": "description",
126	"feature_type": "feature_type",
127	"icon": "icon",
128	"id": "id",
129	"name": "name",
130	"updated_at": "2024-01-15T09:30:00Z",
131	"event_subtype": "event_subtype",
132	"lifecycle_phase": "lifecycle_phase",
133	"maintainer_id": "maintainer_id",
134	"trait_id": "trait_id"
135	},
136	"metric_period": "metric_period",
137	"metric_period_month_reset": "metric_period_month_reset",
138	"rule_id": "rule_id",
139	"value_bool": true,
140	"value_numeric": 1,
141	"value_trait": {
142	"created_at": "2024-01-15T09:30:00Z",
143	"display_name": "display_name",
144	"entity_type": "entity_type",
145	"hierarchy": [
146	"hierarchy"
147	],
148	"id": "id",
149	"trait_type": "trait_type",
150	"updated_at": "2024-01-15T09:30:00Z"
151	},
152	"value_trait_id": "value_trait_id"
153	},
154	"params": {
155	"key": "value"
156	}
157	}