Skip to main content
POST
/
v3
/
groups
/
definitions
/
{group}
/
rules
Add Group Rule
curl --request POST \
  --url https://api.{tenant}.getomneo.com/api/v3/groups/definitions/{group}/rules \
  --header 'Content-Type: application/json' \
  --data '
{
  "group_rule_definition_id": 123,
  "name": "<string>",
  "arguments": [
    "<string>"
  ],
  "sort_order": 1,
  "is_active": true,
  "meta": [
    "<string>"
  ],
  "evaluator": "<string>",
  "rule": "<string>",
  "rule_definition": "<string>"
}
'
import requests

url = "https://api.{tenant}.getomneo.com/api/v3/groups/definitions/{group}/rules"

payload = {
"group_rule_definition_id": 123,
"name": "<string>",
"arguments": ["<string>"],
"sort_order": 1,
"is_active": True,
"meta": ["<string>"],
"evaluator": "<string>",
"rule": "<string>",
"rule_definition": "<string>"
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
group_rule_definition_id: 123,
name: '<string>',
arguments: ['<string>'],
sort_order: 1,
is_active: true,
meta: ['<string>'],
evaluator: '<string>',
rule: '<string>',
rule_definition: '<string>'
})
};

fetch('https://api.{tenant}.getomneo.com/api/v3/groups/definitions/{group}/rules', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.{tenant}.getomneo.com/api/v3/groups/definitions/{group}/rules",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'group_rule_definition_id' => 123,
'name' => '<string>',
'arguments' => [
'<string>'
],
'sort_order' => 1,
'is_active' => true,
'meta' => [
'<string>'
],
'evaluator' => '<string>',
'rule' => '<string>',
'rule_definition' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://api.{tenant}.getomneo.com/api/v3/groups/definitions/{group}/rules"

payload := strings.NewReader("{\n \"group_rule_definition_id\": 123,\n \"name\": \"<string>\",\n \"arguments\": [\n \"<string>\"\n ],\n \"sort_order\": 1,\n \"is_active\": true,\n \"meta\": [\n \"<string>\"\n ],\n \"evaluator\": \"<string>\",\n \"rule\": \"<string>\",\n \"rule_definition\": \"<string>\"\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.{tenant}.getomneo.com/api/v3/groups/definitions/{group}/rules")
.header("Content-Type", "application/json")
.body("{\n \"group_rule_definition_id\": 123,\n \"name\": \"<string>\",\n \"arguments\": [\n \"<string>\"\n ],\n \"sort_order\": 1,\n \"is_active\": true,\n \"meta\": [\n \"<string>\"\n ],\n \"evaluator\": \"<string>\",\n \"rule\": \"<string>\",\n \"rule_definition\": \"<string>\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.{tenant}.getomneo.com/api/v3/groups/definitions/{group}/rules")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"group_rule_definition_id\": 123,\n \"name\": \"<string>\",\n \"arguments\": [\n \"<string>\"\n ],\n \"sort_order\": 1,\n \"is_active\": true,\n \"meta\": [\n \"<string>\"\n ],\n \"evaluator\": \"<string>\",\n \"rule\": \"<string>\",\n \"rule_definition\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body
{
  "data": {
    "id": 123,
    "group_definition_id": 123,
    "group_rule_definition_id": 123,
    "type": "<string>",
    "name": "<string>",
    "arguments": [
      "<unknown>"
    ],
    "sort_order": 123,
    "is_active": true,
    "meta": [
      "<unknown>"
    ],
    "effective": {
      "handle": "<string>",
      "evaluator": "<string>",
      "rule": {},
      "name": "<string>",
      "arguments": [
        "<unknown>"
      ]
    },
    "created_at": "<string>",
    "updated_at": "<string>"
  }
}
{
"message": "<string>"
}
{
"message": "<string>"
}
{
"message": "<string>"
}
{
"message": "<string>",
"errors": {}
}

Path Parameters

group
integer
required

The group ID

Body

application/json
type
enum<string>
required
Available options:
inclusion,
exclusion
group_rule_definition_id
integer
required

Every rule references a reusable definition. The standalone endpoint is reference-only: author templates (with an explicit, globally-unique handle) via /groups/rule-definitions first.

name
string | null
Maximum string length: 255
arguments
string[] | null
sort_order
integer
Required range: x >= 0
is_active
boolean
meta
string[] | null
evaluator
string
rule
string
rule_definition
string

Response

GroupRule

data
GroupRule · object
required