Create flag

POST

https://api.schematichq.com/flags

POST

/flags

1 import { SchematicClient } from "@schematichq/schematic-typescript-node";
2 
3 const client = new SchematicClient({ apiKey: "YOUR_API_KEY" });
4 await client.features.createFlag({
5     defaultValue: true,
6     description: "description",
7     flagType: "flag_type",
8     key: "key",
9     name: "name"
10 });

Try it

1 {
2   "data": {
3     "created_at": "2024-01-15T09:30:00Z",
4     "default_value": true,
5     "description": "description",
6     "flag_type": "flag_type",
7     "id": "id",
8     "key": "key",
9     "name": "name",
10     "rules": [
11       {
12         "condition_groups": [
13           {
14             "conditions": [
15               {
16                 "condition_type": "condition_type",
17                 "created_at": "2024-01-15T09:30:00Z",
18                 "environment_id": "environment_id",
19                 "id": "id",
20                 "operator": "operator",
21                 "resource_ids": [
22                   "resource_ids"
23                 ],
24                 "resources": [
25                   {
26                     "id": "id",
27                     "name": "name"
28                   }
29                 ],
30                 "rule_id": "rule_id",
31                 "trait_value": "trait_value",
32                 "updated_at": "2024-01-15T09:30:00Z"
33               }
34             ],
35             "created_at": "2024-01-15T09:30:00Z",
36             "environment_id": "environment_id",
37             "id": "id",
38             "rule_id": "rule_id",
39             "updated_at": "2024-01-15T09:30:00Z"
40           }
41         ],
42         "conditions": [
43           {
44             "condition_type": "condition_type",
45             "created_at": "2024-01-15T09:30:00Z",
46             "environment_id": "environment_id",
47             "id": "id",
48             "operator": "operator",
49             "resource_ids": [
50               "resource_ids"
51             ],
52             "resources": [
53               {
54                 "id": "id",
55                 "name": "name"
56               }
57             ],
58             "rule_id": "rule_id",
59             "trait_value": "trait_value",
60             "updated_at": "2024-01-15T09:30:00Z"
61           }
62         ],
63         "created_at": "2024-01-15T09:30:00Z",
64         "environment_id": "environment_id",
65         "id": "id",
66         "name": "name",
67         "priority": 1,
68         "rule_type": "rule_type",
69         "updated_at": "2024-01-15T09:30:00Z",
70         "value": true
71       }
72     ],
73     "updated_at": "2024-01-15T09:30:00Z",
74     "feature": {
75       "created_at": "2024-01-15T09:30:00Z",
76       "description": "description",
77       "feature_type": "feature_type",
78       "icon": "icon",
79       "id": "id",
80       "name": "name",
81       "updated_at": "2024-01-15T09:30:00Z",
82       "event_subtype": "event_subtype",
83       "lifecycle_phase": "lifecycle_phase",
84       "maintainer_id": "maintainer_id",
85       "plural_name": "plural_name",
86       "singular_name": "singular_name",
87       "trait_id": "trait_id"
88     },
89     "feature_id": "feature_id",
90     "last_checked_at": "2024-01-15T09:30:00Z",
91     "maintainer_id": "maintainer_id"
92   },
93   "params": {
94     "key": "value"
95   }
96 }

Request

This endpoint expects an object.

default_valuebooleanRequired

descriptionstringRequired

flag_type"boolean"Required

keystringRequired

namestringRequired

feature_idstringOptional

maintainer_idstringOptional

Response

Created

dataobject

paramsmap from strings to any

Input parameters

Create flag

Headers

Request

Response

Errors