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

Authentication

X-Schematic-Api-Keystring

API Key authentication via header

Path parameters

plan_audience_idstringRequired

plan_audience_id

Request

This endpoint expects an object.

condition_groupslist of objectsRequired

conditionslist of objectsRequired

Response

dataobject

paramsobject

Input parameters

Authentication

Path parameters

Request

Response

Errors