Audiences

Rotate an audience feed URL

Generate a replacement URL while keeping the current URL as a temporary redirect. A later rotation permanently breaks the oldest URL.

post/audiences/{id}/feed/rotate

Request

  • Base URL: https://shipmail.to/api/v1
  • URL: https://shipmail.to/api/v1/audiences/{id}/feed/rotate
  • 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.

Response

Audience feed settings with the replacement URL, or null URL when disabled.

object'audience_feed' required
audience_idstring required
enabledboolean required
titlestring nullable required
subtitlestring nullable required
site_urlstring uri nullable required
canonical_urlstring uri nullable required

Publisher-owned feed URL emitted as the Atom rel="self" link, or null when unset.

author_namestring nullable required
icon_urlstring uri nullable required
entry_limitinteger nullable required

Stored number of recent newsletters carried by the feed, or null when the publisher has not chosen a value and the default of 50 applies.

urlstring uri nullable required

Resolved Atom feed URL, or null while the feed is disabled. Anyone with a tokenized URL can read it.

updated_atstring date-time required

Changes

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