Skip to main content
PATCH
/
api
/
segments
/
{id}
Update Tenant Segment
curl --request PATCH \
  --url https://api.embedreach.com/api/segments/{id} \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "conditions": [
    {
      "value": [
        "<string>"
      ],
      "type": "property"
    }
  ],
  "conditionGroups": [
    {
      "conditions": [
        {
          "value": [
            "<string>"
          ],
          "type": "property"
        }
      ],
      "type": "group"
    }
  ]
}
'
import requests

url = "https://api.embedreach.com/api/segments/{id}"

payload = {
"name": "<string>",
"description": "<string>",
"conditions": [
{
"value": ["<string>"],
"type": "property"
}
],
"conditionGroups": [
{
"conditions": [
{
"value": ["<string>"],
"type": "property"
}
],
"type": "group"
}
]
}
headers = {"Content-Type": "application/json"}

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

print(response.text)
const options = {
method: 'PATCH',
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'}]
})
};

fetch('https://api.embedreach.com/api/segments/{id}', 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/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'description' => '<string>',
'conditions' => [
[
'value' => [
'<string>'
],
'type' => 'property'
]
],
'conditionGroups' => [
[
'conditions' => [
[
'value' => [
'<string>'
],
'type' => 'property'
]
],
'type' => 'group'
]
]
]),
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/{id}"

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}")

req, _ := http.NewRequest("PATCH", 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.patch("https://api.embedreach.com/api/segments/{id}")
.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}")
.asString();
require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Patch.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}"

response = http.request(request)
puts response.read_body
{
  "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.

Path Parameters

id
string
required

The ID of the tenant segment to update

Body

application/json
name
string

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)

conditionGroups
object[]

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

Response

Status 200 response

success
boolean
required
message
string
data
object