Audiences

Update audience feed settings

Enable or disable an audience Atom feed and update its public metadata.

patch/audiences/{id}/feed

Request

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

Idempotency-Keystring

Unique key for idempotent requests. Printable ASCII, 1-255 characters. The response is cached for 24 hours. A message send also derives the message ID from the key, so after the cache expires a retry on the same endpoint returns the message already sent, without comparing the body, for as long as that message exists.

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

enabledboolean
titlestring nullable
subtitlestring nullable
site_urlstring nullable

Absolute https URL, or null to clear.

canonical_urlstring nullable

Publisher-owned absolute https feed URL to emit as the Atom rel="self" link, or null to clear.

author_namestring nullable
icon_urlstring nullable

Absolute https URL, or null to clear.

entry_limitinteger nullable

Number of recent newsletters carried by the feed, or null to revert to the default of 50.

Response

Updated audience feed settings.

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.