Toggle Subscription

Sets a subscriber's subscription state — 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.

Operation

Operation	Type	Purpose
updateAdminMarketingSubscriber	Mutation	Toggle a subscriber's subscription state

Details

• Requires an admin Bearer token and the marketing.communications.subscribers.edit permission.
• Pass the subscriber's IRI as id and the new isSubscribed value.
• When the subscriber is linked to a registered customer, the same flag is mirrored onto that customer's newsletter preference.
• Omitting isSubscribed fails validation (422).
• The mutation returns the full updated subscriber payload.

Input fields

Field	Type	Required	Notes
id	ID	Yes	The subscriber's IRI
isSubscribed	Boolean	Yes	true to subscribe / false to unsubscribe