Update audience

PUT

https://api.schematichq.com/plan-audiences/:plan_audience_id

PUT

/plan-audiences/:plan_audience_id

1 import { SchematicClient } from "@schematichq/schematic-typescript-node";
2 
3 const client = new SchematicClient({ apiKey: "YOUR_API_KEY" });
4 await client.plans.updateAudience("plan_audience_id", {
5     conditionGroups: [{
6             conditions: [{
7                     conditionType: "company",
8                     operator: "eq",
9                     resourceIds: ["resource_ids"]
10                 }]
11         }],
12     conditions: [{
13             conditionType: "company",
14             operator: "eq",
15             resourceIds: ["resource_ids"]
16         }]
17 });

Try it

1 {
2   "data": {
3     "condition_groups": [
4       {
5         "conditions": [
6           {
7             "condition_type": "foo",
8             "created_at": "foo",
9             "environment_id": "foo",
10             "id": "foo",
11             "operator": "foo",
12             "resource_ids": [
13               "foo"
14             ],
15             "resources": [
16               {
17                 "id": "foo",
18                 "name": "foo",
19                 "description": "foo",
20                 "image_url": "foo"
21               }
22             ],
23             "rule_id": "foo",
24             "trait_value": "foo",
25             "updated_at": "foo",
26             "comparison_trait": {
27               "created_at": "foo",
28               "display_name": "foo",
29               "entity_type": "foo",
30               "hierarchy": [
31                 "foo"
32               ],
33               "id": "foo",
34               "trait_type": "foo",
35               "updated_at": "foo"
36             },
37             "comparison_trait_id": "foo",
38             "condition_group_id": "foo",
39             "event_subtype": "foo",
40             "flag_id": "foo",
41             "metric_period": "foo",
42             "metric_period_month_reset": "foo",
43             "metric_value": 42,
44             "plan_id": "foo",
45             "trait": {
46               "created_at": "foo",
47               "display_name": "foo",
48               "entity_type": "foo",
49               "hierarchy": [
50                 "foo"
51               ],
52               "id": "foo",
53               "trait_type": "foo",
54               "updated_at": "foo"
55             },
56             "trait_entity_type": "foo",
57             "trait_id": "foo"
58           }
59         ],
60         "created_at": "foo",
61         "environment_id": "foo",
62         "id": "foo",
63         "rule_id": "foo",
64         "updated_at": "foo",
65         "flag_id": "foo",
66         "plan_id": "foo"
67       }
68     ],
69     "conditions": [
70       {
71         "condition_type": "foo",
72         "created_at": "foo",
73         "environment_id": "foo",
74         "id": "foo",
75         "operator": "foo",
76         "resource_ids": [
77           "foo"
78         ],
79         "resources": [
80           {
81             "id": "foo",
82             "name": "foo",
83             "description": "foo",
84             "image_url": "foo"
85           }
86         ],
87         "rule_id": "foo",
88         "trait_value": "foo",
89         "updated_at": "foo",
90         "comparison_trait": {
91           "created_at": "foo",
92           "display_name": "foo",
93           "entity_type": "foo",
94           "hierarchy": [
95             "foo"
96           ],
97           "id": "foo",
98           "trait_type": "foo",
99           "updated_at": "foo"
100         },
101         "comparison_trait_id": "foo",
102         "condition_group_id": "foo",
103         "event_subtype": "foo",
104         "flag_id": "foo",
105         "metric_period": "foo",
106         "metric_period_month_reset": "foo",
107         "metric_value": 42,
108         "plan_id": "foo",
109         "trait": {
110           "created_at": "foo",
111           "display_name": "foo",
112           "entity_type": "foo",
113           "hierarchy": [
114             "foo"
115           ],
116           "id": "foo",
117           "trait_type": "foo",
118           "updated_at": "foo"
119         },
120         "trait_entity_type": "foo",
121         "trait_id": "foo"
122       }
123     ],
124     "created_at": "foo",
125     "environment_id": "foo",
126     "id": "foo",
127     "name": "foo",
128     "priority": 42,
129     "rule_type": "foo",
130     "updated_at": "foo",
131     "value": true,
132     "flag_id": "foo",
133     "plan_id": "foo"
134   },
135   "params": {}
136 }

Path parameters

plan_audience_idstringRequired

plan_audience_id

Request

This endpoint expects an object.

condition_groupslist of objectsRequired

conditionslist of objectsRequired

Response

dataobject

The updated resource

paramsobject

Input parameters

Update audience

Path parameters

Headers

Request

Response

Errors