Create Tenant Segment

Create a new tenant segment

POST /api/segments

Create Tenant Segment

cURL

curl --request POST \
  --url https://api.embedreach.com/api/segments \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "conditions": [
    {
      "value": [
        "<string>"
      ],
      "type": "property"
    }
  ],
  "conditionGroups": [
    {
      "conditions": [
        {
          "value": [
            "<string>"
          ],
          "type": "property"
        }
      ],
      "type": "group"
    }
  ],
  "type": "custom"
}
'

import requests

url = "https://api.embedreach.com/api/segments"

payload = {
    "name": "<string>",
    "description": "<string>",
    "conditions": [
        {
            "value": ["<string>"],
            "type": "property"
        }
    ],
    "conditionGroups": [
        {
            "conditions": [
                {
                    "value": ["<string>"],
                    "type": "property"
                }
            ],
            "type": "group"
        }
    ],
    "type": "custom"
}
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({
    name: '<string>',
    description: '<string>',
    conditions: [{value: ['<string>'], type: 'property'}],
    conditionGroups: [{conditions: [{value: ['<string>'], type: 'property'}], type: 'group'}],
    type: 'custom'
  })
};

fetch('https://api.embedreach.com/api/segments', 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.embedreach.com/api/segments",
  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([
    'name' => '<string>',
    'description' => '<string>',
    'conditions' => [
        [
                'value' => [
                                '<string>'
                ],
                'type' => 'property'
        ]
    ],
    'conditionGroups' => [
        [
                'conditions' => [
                                [
                                                                'value' => [
                                                                                                                                '<string>'
                                                                ],
                                                                'type' => 'property'
                                ]
                ],
                'type' => 'group'
        ]
    ],
    'type' => 'custom'
  ]),
  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.embedreach.com/api/segments"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"conditions\": [\n    {\n      \"value\": [\n        \"<string>\"\n      ],\n      \"type\": \"property\"\n    }\n  ],\n  \"conditionGroups\": [\n    {\n      \"conditions\": [\n        {\n          \"value\": [\n            \"<string>\"\n          ],\n          \"type\": \"property\"\n        }\n      ],\n      \"type\": \"group\"\n    }\n  ],\n  \"type\": \"custom\"\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.embedreach.com/api/segments")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"conditions\": [\n    {\n      \"value\": [\n        \"<string>\"\n      ],\n      \"type\": \"property\"\n    }\n  ],\n  \"conditionGroups\": [\n    {\n      \"conditions\": [\n        {\n          \"value\": [\n            \"<string>\"\n          ],\n          \"type\": \"property\"\n        }\n      ],\n      \"type\": \"group\"\n    }\n  ],\n  \"type\": \"custom\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.embedreach.com/api/segments")

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  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"conditions\": [\n    {\n      \"value\": [\n        \"<string>\"\n      ],\n      \"type\": \"property\"\n    }\n  ],\n  \"conditionGroups\": [\n    {\n      \"conditions\": [\n        {\n          \"value\": [\n            \"<string>\"\n          ],\n          \"type\": \"property\"\n        }\n      ],\n      \"type\": \"group\"\n    }\n  ],\n  \"type\": \"custom\"\n}"

response = http.request(request)
puts response.read_body

200

{
  "success": true,
  "message": "<string>",
  "data": {
    "id": "<string>",
    "name": "<string>",
    "createdAt": "<string>",
    "description": "<string>"
  }
}

{
  "message": "<string>",
  "success": false,
  "errors": [
    "<string>"
  ]
}

Headers

reach-tenant-id · string

If using a platform scoped JWT, you can pass in a header to impersonate a specific tenant to impersonate the request as.

Body

application/json

name · string · required

A friendly name for the segment

description · string

A friendly description for the segment

conditions · object[]

The conditions to include in the segment (legacy format)

Option 1

Option 2

Option 3

Show child attributes

conditionGroups · object[]

Condition groups with AND/OR logic and related resource support (new format)

Show child attributes

type · enum<string> · default: custom

The type of segment

Available options: custom, one_off

Response

200

application/json

Status 200 response

success · boolean · required

message · string

data · object

Show child attributes