Skip to main content
PATCH
/
audience
/
topics
/
{topicId}
Update a topic
curl --request PATCH \
  --url https://app.lettr.com/api/audience/topics/{topicId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "visibility": "public"
}
'
{
  "message": "Topic retrieved successfully.",
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "Product updates",
    "description": "Monthly product updates",
    "default_subscription": "opt_in",
    "visibility": "public",
    "contacts_count": 12,
    "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.

Partially update a topic. The default_subscription field is immutable. Requires the audience:write scope and is blocked for sandbox API keys.

Authorizations

​
Authorization
string
header
required

API key for authentication

Path Parameters

​
topicId
string<uuid>
required

Topic ID

Body

application/json

Update a topic. All fields are optional. The default_subscription field is immutable.

​
name
string
Maximum string length: 255
​
description
string | null
Maximum string length: 1000
​
visibility
enum<string>

Whether the topic is visible to public subscription pages

Available options:
private,
public
Example:

"public"

Response

Updated

​
message
string
required
Example:

"Topic retrieved successfully."

​
data
object
required