Opt the authenticated customer out of an SMS-marketing provider

DELETE

/rest/v1/customer/me/sms-marketing/{providerId}

Customer-scoped self-service unsubscribe. Removes the caller's own subscription row for the given provider (e.g. 1 = Viber); the customer is taken from the bearer token, so one customer can never delete another's row. Idempotent — returns 200 whether or not a subscription existed. Ports the legacy /api/customer/setViberPhone (addToViber=false) opt-out path for velora.

Authorizations

bearerAuth

JWT access token obtained from /rest/auth/admin/login or /rest/auth/customer/login

Type

HTTP (bearer)

Parameters

Path Parameters

providerId*

SMS-marketing provider id (e.g. 1 = Viber)

Type

integer

Required

Responses

Unsubscribed (or no subscription existed)

DELETE

/rest/v1/customer/me/sms-marketing/{providerId}

Playground

Authorization

bearerAuth

Variables

Key

Value

providerId*

Samples

Powered by VitePress OpenAPI