Skip to navigation
API ReferenceNewsletter List Subscriptions

Create newsletter list subscriber import OAuth Scope: newsletter_lists:write

Add a publication’s existing subscribers to a newsletter list in the background. With no body, every active subscriber is added. Pass custom_field_id to add only subscribers whose boolean custom field is true, or tag to add only subscribers with that tag. Subscribers already on the list are skipped, and only one import can run per list at a time. Poll Get newsletter list subscriber import to follow its progress.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

publicationIdstringRequiredformat: "^(pub_[0-9a-fA-F\-]+)$"
The prefixed ID of the publication object
newsletterListIdstringRequiredformat: "^(nl_list_[0-9a-fA-F\-]+)$"
The prefixed ID of the newsletter list object

Request

This endpoint expects an object.
custom_field_idstringOptional

The ID of a boolean custom field. Only subscribers with this field set to true are added. Cannot be combined with tag.

tagstringOptional

The name of a subscriber tag. Only subscribers with this tag are added. Cannot be combined with custom_field_id.

Response

Accepted
dataobject

Errors

400
Bad Request Error
401
Unauthorized Error
404
Not Found Error
422
Unprocessable Entity Error
429
Too Many Requests Error
500
Internal Server Error