Topics

Update a topic

Name, description and visibility. default_subscription is rejected: it is a consent decision, and changing it would start or stop mail for every contact who never chose.

patch/topics/{id}

Request

  • Base URL: https://api.eusend.dev
  • URL: https://api.eusend.dev/topics/{id}
  • Auth: HTTP bearer

Path parameters

idstring uuid required

The topic id.

Request body

namestring
descriptionstring nullable

Send null to clear it.

visibility'public' | 'private'

Response

Updated.

idstring uuid required
namestring required
descriptionstring nullable required
defaultSubscription'opt_in' | 'opt_out' required

What a contact who has never expressed a preference receives. Fixed at creation.

visibility'public' | 'private' required
subscriberCountinteger

Contacts who explicitly opted in. Returned by create and list, not by get. For an opt_out topic this is the reachable audience; for an opt_in topic it is not, since everyone who never chose is subscribed too.

createdAtstring date-time required
updatedAtstring date-time nullable

Changes

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