Skip to content

Delete Subscriber

Deletes a newsletter subscriber — the Delete row action on the admin Marketing → Communications → Newsletter Subscribers screen. When the subscriber is linked to a registered customer, that customer is unsubscribed before the row is removed.

TIP

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

Operation

OperationTypePurpose
deleteAdminMarketingSubscriberMutationDelete a newsletter subscriber

Details

  • Requires an admin Bearer token and the marketing.communications.subscribers.delete permission.
  • Pass the subscriber's IRI as id. Use the list query to discover valid ids.

Confirm success via the absence of errors

The delete mutation returns a success acknowledgement, not the deleted subscriber's data — adminMarketingSubscriber resolves to null on the payload. Treat a response with no errors[] as a successful delete. If you need a confirmation message in the body, use the REST endpoint (DELETE /api/admin/marketing/subscribers/{id}), which returns { "message": "Subscriber deleted." }.

Input fields

FieldTypeRequiredNotes
idIDYesThe subscriber's IRI

Released under the MIT License.