Topics

Create a topic.

Creates an active topic appended to the catalog; optionally enrolls all existing subscribers.

post/topics

Request

  • Base URL: https://api.maildroppa.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.maildroppa.com/topics
  • Auth: API key in header X-API-Key

Request body

labelstring

Label shown to readers.

descriptionstring

Optional description shown to readers.

enrollExistingSubscribersboolean

Enroll all existing subscribers into the new topic. Defaults to false.

Example request

{
  "label": "Podcasts"
}

Response

Topic created.

idstring uuid
labelstring

Label shown to readers on forms and the preference page.

descriptionstring

Optional description shown to readers.

positioninteger

Catalog position; gaps are allowed.

status'ACTIVE' | 'ARCHIVED'
archivedAtUtcstring date-time
defaultTopicboolean

Whether this is the tenant default topic.

subscribedCountinteger

Subscribers currently subscribed to the topic.

optedOutCountinteger

Subscribers who opted out of the topic themselves.

enrollmentRunningboolean

Whether existing subscribers are currently being enrolled into the topic.

Example response

{
  "label": "Podcasts",
  "archivedAtUtc": "2022-03-10T16:15:50Z",
  "enrollment": {
    "startedAtUtc": "2022-03-10T16:15:50Z"
  }
}

Changes

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