Unsubscribe from a topic
POST {{baseUrl}}/subscriptions/:topic/unsubscribe
Unusbscribe a user from a particular topic (and optional categories).
Request Body
{"subscription"=>{"categories"=>[{"slug"=>"<string>", "reason"=>"<string>"}, {"slug"=>"<string>", "reason"=>"<string>"}]}}
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
X-MAGICBELL-API-KEY | string | (Required) The (public) API key of your MagicBell project. | |
X-MAGICBELL-USER-EXTERNAL-ID | string | ID of the user. Provide the X-MAGICBELL-USER-EMAIL header instead if you identify users by email. | |
X-MAGICBELL-USER-EMAIL | string | Email address of the user. Provide the X-MAGICBELL-USER-EXTERNAL-ID header instead if you identify users by ID. | |
X-MAGICBELL-USER-HMAC | string | HMAC calculated with the API secret and ID, or email, of the user. Required if the project has HMAC enabled. | |
Content-Type | string | ||
Accept | string |
RESPONSES
status: OK
{"subscription":{"categories":[{"slug":"\u003cstring\u003e","reason":"\u003cstring\u003e","status":"unsubscribed"},{"slug":"\u003cstring\u003e","reason":"\u003cstring\u003e","status":"subscribed"}],"topic":"\u003cstring\u003e"}}