Skip to main content
PUT
Set Customer Newsletter

Authorizations

Authorization
string
header
required

You can retrieve your API key from your dashboard under Account > Developers.

Path Parameters

shopId
integer
required

The shop ID.

customerId
integer
required

The customer ID.

Body

application/json
newsletter
boolean
required

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

Example:

null

newsletter_at
string

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

Example:

null

Response

200 - undefined