Update a segment
curl --request PATCH \
--url https://api.watx.in/v1/segments/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "VIP buyers",
"description": null,
"filter": {
"match": "any",
"rules": [
{
"field": "tag",
"op": "has",
"value": "vip"
}
]
}
}
'import requests
url = "https://api.watx.in/v1/segments/{id}"
payload = {
"name": "VIP buyers",
"description": None,
"filter": {
"match": "any",
"rules": [
{
"field": "tag",
"op": "has",
"value": "vip"
}
]
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'VIP buyers',
description: null,
filter: {match: 'any', rules: [{field: 'tag', op: 'has', value: 'vip'}]}
})
};
fetch('https://api.watx.in/v1/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.watx.in/v1/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' => 'VIP buyers',
'description' => null,
'filter' => [
'match' => 'any',
'rules' => [
[
'field' => 'tag',
'op' => 'has',
'value' => 'vip'
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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.watx.in/v1/segments/{id}"
payload := strings.NewReader("{\n \"name\": \"VIP buyers\",\n \"description\": null,\n \"filter\": {\n \"match\": \"any\",\n \"rules\": [\n {\n \"field\": \"tag\",\n \"op\": \"has\",\n \"value\": \"vip\"\n }\n ]\n }\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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.watx.in/v1/segments/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"VIP buyers\",\n \"description\": null,\n \"filter\": {\n \"match\": \"any\",\n \"rules\": [\n {\n \"field\": \"tag\",\n \"op\": \"has\",\n \"value\": \"vip\"\n }\n ]\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.watx.in/v1/segments/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"VIP buyers\",\n \"description\": null,\n \"filter\": {\n \"match\": \"any\",\n \"rules\": [\n {\n \"field\": \"tag\",\n \"op\": \"has\",\n \"value\": \"vip\"\n }\n ]\n }\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"description": "<string>",
"color": "<string>",
"kind": "static",
"filter": {
"match": "all",
"rules": [
{
"field": "tag",
"op": "has",
"value": "<string>"
}
]
},
"member_count": 123,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
}{
"error": {
"code": "bad_request",
"message": "Only a dynamic segment has a filter"
}
}{
"error": {
"code": "unauthorized",
"message": "Missing or invalid API key"
}
}{
"error": {
"code": "forbidden",
"message": "This API key is missing the 'messages:send' scope"
}
}{
"error": {
"code": "not_found",
"message": "Contact not found"
}
}{
"error": {
"code": "rate_limited",
"message": "Rate limit exceeded for this API key"
}
}Segments
Update a segment
Updates the fields present in the body. kind is immutable and is
ignored here; sending filter for a static segment is a 400.
Requires the contacts:write scope.
PATCH
/
segments
/
{id}
Update a segment
curl --request PATCH \
--url https://api.watx.in/v1/segments/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "VIP buyers",
"description": null,
"filter": {
"match": "any",
"rules": [
{
"field": "tag",
"op": "has",
"value": "vip"
}
]
}
}
'import requests
url = "https://api.watx.in/v1/segments/{id}"
payload = {
"name": "VIP buyers",
"description": None,
"filter": {
"match": "any",
"rules": [
{
"field": "tag",
"op": "has",
"value": "vip"
}
]
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'VIP buyers',
description: null,
filter: {match: 'any', rules: [{field: 'tag', op: 'has', value: 'vip'}]}
})
};
fetch('https://api.watx.in/v1/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.watx.in/v1/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' => 'VIP buyers',
'description' => null,
'filter' => [
'match' => 'any',
'rules' => [
[
'field' => 'tag',
'op' => 'has',
'value' => 'vip'
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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.watx.in/v1/segments/{id}"
payload := strings.NewReader("{\n \"name\": \"VIP buyers\",\n \"description\": null,\n \"filter\": {\n \"match\": \"any\",\n \"rules\": [\n {\n \"field\": \"tag\",\n \"op\": \"has\",\n \"value\": \"vip\"\n }\n ]\n }\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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.watx.in/v1/segments/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"VIP buyers\",\n \"description\": null,\n \"filter\": {\n \"match\": \"any\",\n \"rules\": [\n {\n \"field\": \"tag\",\n \"op\": \"has\",\n \"value\": \"vip\"\n }\n ]\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.watx.in/v1/segments/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"VIP buyers\",\n \"description\": null,\n \"filter\": {\n \"match\": \"any\",\n \"rules\": [\n {\n \"field\": \"tag\",\n \"op\": \"has\",\n \"value\": \"vip\"\n }\n ]\n }\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"description": "<string>",
"color": "<string>",
"kind": "static",
"filter": {
"match": "all",
"rules": [
{
"field": "tag",
"op": "has",
"value": "<string>"
}
]
},
"member_count": 123,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
}{
"error": {
"code": "bad_request",
"message": "Only a dynamic segment has a filter"
}
}{
"error": {
"code": "unauthorized",
"message": "Missing or invalid API key"
}
}{
"error": {
"code": "forbidden",
"message": "This API key is missing the 'messages:send' scope"
}
}{
"error": {
"code": "not_found",
"message": "Contact not found"
}
}{
"error": {
"code": "rate_limited",
"message": "Rate limit exceeded for this API key"
}
}Authorizations
Your workspace API key, created in Settings → API keys, sent as
Authorization: Bearer <key>. New keys start with watx_live_; keys
issued before the rename start with converse360_live_ and still work.
Path Parameters
The segment id.
Body
application/json
Response
The updated segment.
Show child attributes
Show child attributes