Skip to main content
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"
}
'
{
  "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"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.lettr.com/llms.txt

Use this file to discover all available pages before exploring further.

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

​
Authorization
string
header
required

API key for authentication

Path Parameters

​
propertyId
string<uuid>
required

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.

​
fallback_value
string | null
Maximum string length: 255
Example:

"Friend"

Response

Updated

​
message
string
required
Example:

"Property retrieved successfully."

​
data
object
required