Create feature

POST

https://api.schematichq.com/features

POST

/features

1 import { SchematicClient } from "@schematichq/schematic-typescript-node";
2 
3 async function main() {
4     const client = new SchematicClient({
5         apiKey: "YOUR_API_KEY_HERE",
6     });
7     await client.features.createFeature({
8         description: "Feature flag to enable the new user onboarding flow",
9         featureType: "boolean",
10         name: "New User Onboarding",
11     });
12 }
13 main();

1 {
2   "data": {
3     "created_at": "2024-01-15T09:30:00Z",
4     "description": "Feature flag to enable the new user onboarding flow",
5     "feature_type": "boolean",
6     "flags": [
7       {
8         "created_at": "2024-01-15T09:30:00Z",
9         "default_value": false,
10         "description": "Flag to toggle the new onboarding experience",
11         "flag_type": "boolean",
12         "id": "flag-5678efgh",
13         "key": "new_user_onboarding_enabled",
14         "name": "New User Onboarding Flag",
15         "rules": [
16           {
17             "condition_groups": [
18               {
19                 "conditions": [
20                   {
21                     "condition_type": "equals",
22                     "created_at": "2024-01-10T12:00:00Z",
23                     "environment_id": "env-prod-1234",
24                     "id": "cond-2222bbbb",
25                     "operator": "equals",
26                     "resource_ids": [
27                       "res-3333cccc"
28                     ],
29                     "resources": [
30                       {
31                         "id": "res-3333cccc",
32                         "name": "Premium Plan",
33                         "description": "Premium subscription plan",
34                         "image_url": "https://example.com/images/premium_plan.png"
35                       }
36                     ],
37                     "rule_id": "rule-4444dddd",
38                     "trait_value": "true",
39                     "updated_at": "2024-01-10T12:00:00Z",
40                     "comparison_trait": {
41                       "created_at": "2023-12-01T08:00:00Z",
42                       "display_name": "Is Premium Customer",
43                       "entity_type": "company",
44                       "hierarchy": [
45                         "subscription",
46                         "customer_status"
47                       ],
48                       "id": "trait-premium-001",
49                       "trait_type": "boolean",
50                       "updated_at": "2024-01-10T12:00:00Z"
51                     },
52                     "comparison_trait_id": "trait-premium-001",
53                     "condition_group_id": "condgrp-1111aaaa",
54                     "event_subtype": "user_signup",
55                     "flag_id": "flag-5678efgh",
56                     "metric_period": "monthly",
57                     "metric_period_month_reset": "1",
58                     "metric_value": 1,
59                     "trait": {
60                       "created_at": "2023-12-01T08:00:00Z",
61                       "display_name": "Is Premium Customer",
62                       "entity_type": "company",
63                       "hierarchy": [
64                         "subscription",
65                         "customer_status"
66                       ],
67                       "id": "trait-premium-001",
68                       "trait_type": "boolean",
69                       "updated_at": "2024-01-10T12:00:00Z"
70                     },
71                     "trait_entity_type": "company",
72                     "trait_id": "trait-premium-001"
73                   }
74                 ],
75                 "created_at": "2024-01-10T12:00:00Z",
76                 "environment_id": "env-prod-1234",
77                 "id": "condgrp-1111aaaa",
78                 "rule_id": "rule-4444dddd",
79                 "updated_at": "2024-01-10T12:00:00Z",
80                 "flag_id": "flag-5678efgh"
81               }
82             ],
83             "conditions": [
84               {
85                 "condition_type": "equals",
86                 "created_at": "2024-01-10T12:00:00Z",
87                 "environment_id": "env-prod-1234",
88                 "id": "cond-2222bbbb",
89                 "operator": "equals",
90                 "resource_ids": [
91                   "res-3333cccc"
92                 ],
93                 "resources": [
94                   {
95                     "id": "res-3333cccc",
96                     "name": "Premium Plan",
97                     "description": "Premium subscription plan",
98                     "image_url": "https://example.com/images/premium_plan.png"
99                   }
100                 ],
101                 "rule_id": "rule-4444dddd",
102                 "trait_value": "true",
103                 "updated_at": "2024-01-10T12:00:00Z",
104                 "comparison_trait": {
105                   "created_at": "2023-12-01T08:00:00Z",
106                   "display_name": "Is Premium Customer",
107                   "entity_type": "company",
108                   "hierarchy": [
109                     "subscription",
110                     "customer_status"
111                   ],
112                   "id": "trait-premium-001",
113                   "trait_type": "boolean",
114                   "updated_at": "2024-01-10T12:00:00Z"
115                 },
116                 "comparison_trait_id": "trait-premium-001",
117                 "condition_group_id": "condgrp-1111aaaa",
118                 "event_subtype": "user_signup",
119                 "flag_id": "flag-5678efgh",
120                 "metric_period": "monthly",
121                 "metric_period_month_reset": "1",
122                 "metric_value": 1,
123                 "trait": {
124                   "created_at": "2023-12-01T08:00:00Z",
125                   "display_name": "Is Premium Customer",
126                   "entity_type": "company",
127                   "hierarchy": [
128                     "subscription",
129                     "customer_status"
130                   ],
131                   "id": "trait-premium-001",
132                   "trait_type": "boolean",
133                   "updated_at": "2024-01-10T12:00:00Z"
134                 },
135                 "trait_entity_type": "company",
136                 "trait_id": "trait-premium-001"
137               }
138             ],
139             "created_at": "2024-01-10T12:00:00Z",
140             "environment_id": "env-prod-1234",
141             "id": "rule-4444dddd",
142             "name": "Enable for Premium Customers",
143             "priority": 10,
144             "rule_type": "targeting",
145             "updated_at": "2024-01-10T12:00:00Z",
146             "value": true,
147             "flag_id": "flag-5678efgh"
148           }
149         ],
150         "updated_at": "2024-01-15T09:30:00Z",
151         "feature": {
152           "created_at": "2024-01-15T09:30:00Z",
153           "description": "Feature flag to enable the new user onboarding flow",
154           "feature_type": "boolean",
155           "icon": "rocket",
156           "id": "feat-1234abcd",
157           "name": "New User Onboarding",
158           "updated_at": "2024-01-15T09:30:00Z",
159           "event_subtype": "user_signup",
160           "lifecycle_phase": "beta",
161           "maintainer_id": "maintainer-5678efgh",
162           "plural_name": "New User Onboardings",
163           "singular_name": "New User Onboarding",
164           "trait_id": "trait-9012ijkl"
165         },
166         "feature_id": "feat-1234abcd",
167         "last_checked_at": "2024-01-15T09:30:00Z",
168         "maintainer_id": "maintainer-5678efgh"
169       }
170     ],
171     "icon": "rocket",
172     "id": "feat-1234abcd",
173     "name": "New User Onboarding",
174     "plans": [
175       {
176         "id": "plan-pro-7890",
177         "name": "Pro Plan",
178         "description": "Pro subscription plan with advanced features",
179         "image_url": "https://example.com/images/pro_plan.png"
180       }
181     ],
182     "updated_at": "2024-01-15T09:30:00Z",
183     "event_subtype": "user_signup",
184     "event_summary": {
185       "company_count": 42,
186       "environment_id": "env-prod-1234",
187       "event_count": 10500,
188       "event_subtype": "user_signup",
189       "user_count": 9800,
190       "last_seen_at": "2024-01-15T09:30:00Z"
191     },
192     "lifecycle_phase": "beta",
193     "maintainer_id": "maintainer-5678efgh",
194     "plural_name": "New User Onboardings",
195     "singular_name": "New User Onboarding",
196     "trait": {
197       "created_at": "2023-12-01T08:00:00Z",
198       "display_name": "Is Premium Customer",
199       "entity_type": "company",
200       "hierarchy": [
201         "subscription",
202         "customer_status"
203       ],
204       "id": "trait-premium-001",
205       "trait_type": "boolean",
206       "updated_at": "2024-01-10T12:00:00Z"
207     },
208     "trait_id": "trait-premium-001"
209   },
210   "params": {}
211 }

Authentication

X-Schematic-Api-Keystring

API Key authentication via header

Request

This endpoint expects an object.

descriptionstringRequired<=1024 characters

feature_typeenumRequired

Allowed values:

namestringRequired<=512 characters

event_subtypestring or nullOptional

flagobjectOptional

iconstring or nullOptional

lifecycle_phaseenum or nullOptional

maintainer_idstring or nullOptional

plural_namestring or nullOptional

singular_namestring or nullOptional

trait_idstring or nullOptional

Response

Created

dataobject

paramsobject

Input parameters

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error