Email Unsubscribe
Private Email Unsubscribe API endpoints
Record an opt-out the recipient asked for outside email, for example in a reply, a phone call or a support ticket. The address is trimmed and lowercased. Adds a marketing unsubscribe for the shop and address when none exists, and sets marketing_consent to false on the shop's customer with that address. Marketing mail from automations is then skipped for the address. A repeat call changes nothing and returns the existing unsubscribe. An unsubscribe cannot be listed or removed, and a later consent change on the customer does not remove it.
Request body
emailRequiredstringFormat: email.
ReturnsEmailUnsubscribe
Email unsubscribe object response
Error responses
422objectValidation failed, for example email is missing or is not a valid address.