Audience

Update a topic

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

patch/audience/topics/{topicId}

Request

  • Base URL: https://app.lettr.com/api
  • URL: https://app.lettr.com/api/audience/topics/{topicId}
  • Auth: HTTP bearer

Path parameters

topicIdstring uuid required

Topic ID

Request body

namestring
descriptionstring nullable
visibility'private' | 'public'

Whether the topic is visible to public subscription pages

Example request

{
  "visibility": "public"
}

Response

Updated

messagestring required

Example response

{
  "message": "Topic retrieved successfully.",
  "data": {
    "name": "Product updates",
    "description": "Monthly product updates",
    "default_subscription": "opt_in",
    "visibility": "public",
    "contacts_count": 12
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.