Customers

Set Customer Newsletter

Changed on

Subscribes or unsubscribes a customer from the shop's newsletter. Only subscribe a customer who actually consented; a subscribed customer can be targeted by your email campaigns and automations.

put/v1/shops/{shopId}/customers/{customerId}/newsletter

Request

Request body

newsletterboolean required

Whether the customer is subscribed to the newsletter. A customer who unsubscribed themselves stays unsubscribed.

newsletter_atstring

When the customer opted in, if you are importing an existing consent. Defaults to now. Cannot be in the future.

Example request

{
  "newsletter": true
}

Changes