Audiences

Create an audience

Create a newsletter audience. consent_source is a required consent attestation.

post/audiences

Request

  • Base URL: https://shipmail.to/api/v1
  • URL: https://shipmail.to/api/v1/audiences
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://shipmail.to/api/auth/oauth2/authorize, token URL https://shipmail.to/api/auth/oauth2/token)

Headers

X-Shipmail-Organizationstring

OAuth access tokens only. The organization ID this request acts on. Required when the OAuth connection was approved for several organizations (400 validation_error without it); optional with one. An organization the connection was not approved for returns 403 authorization_error. Ignored for API keys, which belong to one organization.

Request body

namestring required
descriptionstring nullable
consent_sourcestring required

Where and how these people opted in. Required consent attestation.

Response

Audience created.

object'audience' required
idstring required
namestring required
descriptionstring nullable required
member_countinteger required

Total subscribers of any status.

subscribed_countinteger required

Subscribers currently receiving newsletters.

consent_sourcestring nullable required
feed_enabledboolean required

Whether this audience publishes an Atom feed of its sent newsletters.

feed_urlstring nullable required

Unguessable Shipmail Atom feed URL, or null when the feed is disabled.

created_atstring date-time required
updated_atstring date-time required
cleanup_enabledboolean required

List cleanup. A cold subscriber gets one last-chance email in place of a newsletter, and becomes dormant if they do not click keep within 14 days. On by default for audiences created since list cleanup shipped.

cleanup_ignored_issuesinteger required

How many tracked newsletters in a row a subscriber ignores before they count as cold. Default 6.

cleanup_inactive_daysinteger required

How many days without a sign of life (a human open or click, a reply, a confirmation, a signup again, a keep click) before a subscriber counts as cold. Default 180.

Changes

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