Topics

Update a topic

Rename it, re-describe it, flip default_opt_in, or archive it.

key is absent from the body on purpose. Every stored preference and every integration refers to a topic by its key, so changing one would orphan them silently. There is no DELETE for the same reason — archived: true removes the topic from the preference centre and from new sends while every opt-out recorded against it survives.

Requires the topics:write scope — Create and edit topics, and change what your contacts are subscribed to — this decides who your campaigns reach.

patch/api/v1/topics/{id}

Request

  • Base URL: https://api.sendly.now
  • URL: https://api.sendly.now/api/v1/topics/{id}
  • Auth: one of:
    • HTTP bearer
    • API key in cookie better-auth.session_token
    • OAuth 2 (authorization code, authorization URL https://app.sendly.now/api/auth/oauth2/authorize, token URL https://app.sendly.now/api/auth/oauth2/token, scopes: topics:write)

Path parameters

idstring uuid required

Resource id.

Request body

archivedboolean
default_opt_inboolean
descriptionstring nullable
namestring

Response

The updated topic

archivedboolean required

Hidden from the preference centre and from new sends, WITHOUT discarding the opt-outs recorded against it. There is no delete for the same reason: deleting a topic would delete the choices people made about it.

created_atstring date-time required
default_opt_inboolean required

What a contact with NO answer counts as. True is the honest default for a topic added after a list already exists: those contacts consented to hear from you, and inventing an opt-out they never asked for would silence mail they expect. False means the topic must be opted INTO, and absence means not asked rather than no.

descriptionstring nullable required
idstring required
keystring required

Stable, URL-safe, unique within the project. This is what a preference form and an API caller name the topic by, so it must survive a rename of name — which is the whole reason it exists beside one.

namestring required
subscribed_countinteger required

Contacts who explicitly said yes. Excludes those covered only by default_opt_in.

unsubscribed_countinteger required

Changes

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