Update Newsletter Settings

PUT

/newsletters/{newsletter_id}/settings

• Production
• QA

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.

Authorizations

• BearerAuth

Parameters

Path Parameters

newsletter_id

required

Newsletter id (UUID).

string format: uuid

Newsletter id (UUID).

Header Parameters

X-Target-Org-Id

Any of:

string

string

null

null

Request Body ^required

Who a newsletter sends as, and how strict its opt-in is.

object

auto_verify_on_import

Any of:

boolean

boolean

null

null

default_reply_to

Any of:

string

string

null

null

default_sender_email

Any of:

string

string

null

null

default_sender_name

Any of:

string

string

null

null

double_opt_in

Any of:

boolean

boolean

null

null

double_opt_in_intent

Any of:

boolean

boolean

null

null

sending_domain

Any of:

string

string

null

null

skip_unverified_subscribers

Any of:

boolean

boolean

null

null

Responses

200

Successful Response

object

data

required

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

object

key

additional properties

any

pagination

Any of:

PaginationMeta

object

has_next

required

Whether there are more pages

boolean

limit

required

Items per page

integer

next_cursor

Any of:

string

string

null

null

notes

Any of:

Array<string>

Array<string>

null

null

page

required

Current page number (1-indexed)

integer

total

required

Total number of items

integer

total_available

Any of:

integer

integer

null

null

total_is_lower_bound

Any of:

boolean

boolean

null

null

null

null

422

Validation Error

object

detail

Array<object>

object

loc

required

Array

msg

required

string

type

required

string