Change a topic

Change a topic's name, description or visibility.

PATCHhttps://app.usenotix.dev/api/v1/topics/{topicId}

Needs a full access key. Sending access keys cannot call this. Key permissions lists the extra rules some calls have.

Change a topic's name, description or visibility. defaultSubscription cannot be changed; create a new topic instead.

Needs a full access key. Topics carry no domain, so a key limited to one domain may use them too. Read only, send-only and live AI keys answer 403 SCOPE_DENIED.

Path parameters

topicIdstringrequired

Body parameters

namestring

At most 100 characters.

descriptionstring

At most 500 characters. Can be null.

visibilitystring

One of PUBLIC, PRIVATE.

Headers

Authorizationstringrequired

Bearer followed by your API key.

Errors

400

The body is not valid. defaultSubscription cannot be changed.

404

No topic with this id in the team.

409

A topic with this name already exists.

Every error has the same shape. See all error codes.

curl -X PATCH "https://app.usenotix.dev/api/v1/topics/<topicId>" \
  -H "Authorization: Bearer $NOTIX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Acme",
  "description": "string",
  "visibility": "PUBLIC"
}'
Response200
{
  "id": "cm1x8f3k20001qz7v5b9d2e4a",
  "name": "Acme",
  "description": "string",
  "defaultSubscription": "OPT_IN",
  "visibility": "PUBLIC",
  "optedIn": 1,
  "optedOut": 1,
  "createdAt": "string",
  "updatedAt": "string"
}
Open in ClaudeOpen in ChatGPT