Newsletter

Update Newsletter Settings

Set the sender identity and the opt-in policy.

Set double_opt_in_intent rather than double_opt_in: the active flag the send pipeline reads is promoted automatically once the domain is verified and a sender address exists, and writing the active flag directly asks for a state the pipeline is not ready for.

put/newsletters/{newsletter_id}/settings

Request

  • Base URL: https://be.graph8.com/api/v1
  • URL: https://be.graph8.com/api/v1/newsletters/{newsletter_id}/settings
  • Auth: HTTP bearer

Path parameters

newsletter_idstring uuid required

Newsletter id (UUID).

Headers

Authorizationstring nullable
X-Target-Org-Idstring nullable

Request body

sending_domainstring nullable

Must be verified first - see settings/verify-domain.

default_sender_namestring nullable
default_sender_emailstring nullable
default_reply_tostring nullable
double_opt_inboolean nullable

The ACTIVE double-opt-in flag the send pipeline reads. Legacy: a true written here is routed to double_opt_in_intent and the active flag is auto-promoted once the domain and sender are ready.

double_opt_in_intentboolean nullable

The REQUEST for double opt-in, independent of readiness. Set this rather than double_opt_in - it is promoted automatically.

skip_unverified_subscribersboolean nullable
auto_verify_on_importboolean nullable

Response

Successful Response

dataNewsletterPayload required

An open envelope for a newsletter, an issue, a template or a send row.

Changes

No recorded changes to this operation across all 2 revisions of this API.