POST mailinglists

POST
/mailinglists

Authorization

Bearer
headerAuthorizationBearer <token>

Paste your JWT token here

Request Body

The DTO containing the provider list to curate and its visibility.

application/json
  1. body

Defines the DTO for curating a new mailing list.

providerListId*string

The mail subscription provider's identifier for the list to curate (e.g. a Mailchimp interest ID).

visibility*MailinglistVisibility

Controls where a curated mailing list is shown to members. General lists appear everywhere (registration, account settings, the yearly renewal page); YearlyRenewalOnly lists appear only on the yearly study-renewal page, alongside the General lists.

Formatint32
Value in"General""YearlyRenewalOnly"

Response Body

Created

application/json
  1. response

Represents a curated mailing list together with its live-resolved display name and whether the underlying provider list still exists.

id?integer

The curation record's own identifier.

Formatint32
providerListId?string

The mail subscription provider's identifier for the list.

name?|

The list's current display name at the provider, or null if it's orphaned.

visibility?MailinglistVisibility

Controls where a curated mailing list is shown to members. General lists appear everywhere (registration, account settings, the yearly renewal page); YearlyRenewalOnly lists appear only on the yearly study-renewal page, alongside the General lists.

Formatint32
Value in"General""YearlyRenewalOnly"
orphaned?boolean

Whether the curated provider list no longer exists at the provider.

curl -X POST 'https://example.com/mailinglists' \  -H 'Content-Type: application/json' \  -d '{  "providerListId": "string",  "visibility": "General"}'
{  "id": 0,  "providerListId": "string",  "name": "string",  "visibility": "General",  "orphaned": true}