newsletter

Send Newsletter

Send newsletter to recipients. For production mode, this runs in the background.

post/newsletter/send

Request

  • Base URL: https://api.particl.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.particl.com/newsletter/send
  • Auth: none declared

Request body

newsletter_type'dtc' | 'exploding-retail' | 'marketing' | 'product-updates' | 'one-off-email' required
datestring required
timestampstring required
mode'test' | 'production' required
test_email'ben' | 'kenney' | 'smiley' nullable
audiencestring nullable
custom_querystring nullable
log_to_databaseboolean
has_headerboolean

Response

Successful Response

successboolean required
recipients_countinteger required
messagestring

Changes

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