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": "condition_type",
8             "created_at": "2024-01-15T09:30:00Z",
9             "environment_id": "environment_id",
10             "id": "id",
11             "operator": "operator",
12             "resource_ids": [
13               "resource_ids"
14             ],
15             "resources": [
16               {
17                 "id": "id",
18                 "name": "name"
19               }
20             ],
21             "rule_id": "rule_id",
22             "trait_value": "trait_value",
23             "updated_at": "2024-01-15T09:30:00Z"
24           }
25         ],
26         "created_at": "2024-01-15T09:30:00Z",
27         "environment_id": "environment_id",
28         "id": "id",
29         "rule_id": "rule_id",
30         "updated_at": "2024-01-15T09:30:00Z"
31       }
32     ],
33     "conditions": [
34       {
35         "condition_type": "condition_type",
36         "created_at": "2024-01-15T09:30:00Z",
37         "environment_id": "environment_id",
38         "id": "id",
39         "operator": "operator",
40         "resource_ids": [
41           "resource_ids"
42         ],
43         "resources": [
44           {
45             "id": "id",
46             "name": "name"
47           }
48         ],
49         "rule_id": "rule_id",
50         "trait_value": "trait_value",
51         "updated_at": "2024-01-15T09:30:00Z"
52       }
53     ],
54     "created_at": "2024-01-15T09:30:00Z",
55     "environment_id": "environment_id",
56     "id": "id",
57     "name": "name",
58     "priority": 1,
59     "rule_type": "rule_type",
60     "updated_at": "2024-01-15T09:30:00Z",
61     "value": true,
62     "flag_id": "flag_id",
63     "plan_id": "plan_id"
64   },
65   "params": {
66     "key": "value"
67   }
68 }

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

paramsmap from strings to any

Input parameters

Update audience

Path parameters

Headers

Request

Response

Errors