Update a property
curl --request PATCH \
--url https://app.lettr.com/api/audience/properties/{propertyId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"fallback_value": "Friend"
}
'import requests
url = "https://app.lettr.com/api/audience/properties/{propertyId}"
payload = { "fallback_value": "Friend" }
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({fallback_value: 'Friend'})
};
fetch('https://app.lettr.com/api/audience/properties/{propertyId}', 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://app.lettr.com/api/audience/properties/{propertyId}",
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([
'fallback_value' => 'Friend'
]),
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://app.lettr.com/api/audience/properties/{propertyId}"
payload := strings.NewReader("{\n \"fallback_value\": \"Friend\"\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://app.lettr.com/api/audience/properties/{propertyId}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"fallback_value\": \"Friend\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.lettr.com/api/audience/properties/{propertyId}")
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 \"fallback_value\": \"Friend\"\n}"
response = http.request(request)
puts response.read_body{
"message": "Property retrieved successfully.",
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "first_name",
"type": "string",
"fallback_value": "Friend",
"created_at": "2023-11-07T05:31:56Z"
}
}Audience Properties
Update a property
Update the property’s fallback value. The name and type fields cannot be changed (they would orphan data on existing contacts). If the request body contains no recognized fields, the property is returned unchanged with a 200 response. Requires the audience:write scope and is blocked for sandbox API keys.
PATCH
/
audience
/
properties
/
{propertyId}
Update a property
curl --request PATCH \
--url https://app.lettr.com/api/audience/properties/{propertyId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"fallback_value": "Friend"
}
'import requests
url = "https://app.lettr.com/api/audience/properties/{propertyId}"
payload = { "fallback_value": "Friend" }
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({fallback_value: 'Friend'})
};
fetch('https://app.lettr.com/api/audience/properties/{propertyId}', 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://app.lettr.com/api/audience/properties/{propertyId}",
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([
'fallback_value' => 'Friend'
]),
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://app.lettr.com/api/audience/properties/{propertyId}"
payload := strings.NewReader("{\n \"fallback_value\": \"Friend\"\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://app.lettr.com/api/audience/properties/{propertyId}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"fallback_value\": \"Friend\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.lettr.com/api/audience/properties/{propertyId}")
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 \"fallback_value\": \"Friend\"\n}"
response = http.request(request)
puts response.read_body{
"message": "Property retrieved successfully.",
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "first_name",
"type": "string",
"fallback_value": "Friend",
"created_at": "2023-11-07T05:31:56Z"
}
}Update the property’s fallback value. The
name and type fields cannot be changed (they would orphan data on existing contacts). If the request body contains no recognized fields, the property is returned unchanged with a 200 response. Requires the audience:write scope and is blocked for sandbox API keys.Authorizations
API key for authentication
Path Parameters
Property ID
Body
application/json
Update a property's fallback value. The name and type fields are immutable (changing them would orphan data on existing contacts) and must not be provided.
Maximum string length:
255Example:
"Friend"
Was this page helpful?