Toggle Newsletter Subscription

Sets the subscription state for a subscriber — the subscribe / unsubscribe toggle on the admin Marketing → Communications → Newsletter Subscribers screen.

TIP

New here? Read the Newsletter Subscribers overview for what a subscriber is and how its fields behave.

Endpoint

Endpoint	Method
/api/admin/marketing/subscribers/{id}	PUT

Details

• Requires an admin Bearer token and the marketing.communications.subscribers.edit permission.
• Sets is_subscribed for the subscriber row and mirrors the flag onto the linked customer's newsletter preference when a customer is linked.
• A missing is_subscribed field returns a 422.
• Returns the full updated subscriber payload.

Request body

Field	Type	Required	Notes
is_subscribed	bool	yes	true subscribed / false unsubscribed