Topics

Topics are subscription categories that contacts can opt in or out of. Use topics to let recipients control what types of emails they receive, such as "Marketing", "Product Updates", or "Weekly Digest".

Create a topic

POST
/v1/topics

Create a new subscription topic.

Request body

ParameterTypeDescription
namerequiredstringDisplay name for the topic.
cURL
curl -X POST https://api.txtly.com.au/v1/topics \
  -H "Authorization: Bearer tx_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{"name": "Product Updates"}'
Response — 201 Created
{
  "id": "top_abc123",
  "name": "Product Updates",
  "created_at": "2026-03-21T00:00:00Z"
}

List topics

GET
/v1/topics

List all topics for the current team.

Update a topic

PATCH
/v1/topics/{id}

Update the topic name.

Delete a topic

DELETE
/v1/topics/{id}

Delete a topic. Existing contact subscriptions for this topic will be removed.

Contact subscriptions

When creating or updating a contact, you can set their topic subscription status. Each contact-topic relationship has a status of eitheropt_inoropt_out. Broadcasts scoped to a topic will only be sent to contacts withopt_instatus.