Unsubscribe an email address from future messages by calling this API from your custom unsubscribe page. Automatically disables the associated email subscription using a token-based approach.
enabled
property to false
app_id
: OneSignal app IDnotification_id
: The ID of the specific email message senttoken
: The email token, a secure reference to the subscriptionYour OneSignal App ID in UUID v4 format. See Keys & IDs.
The "id" of the email message. Can be passed into the request from the email received by the user with liquid syntax {{message.id}}
. See Create a Custom Unsubscribe Page for setup details.
The unsubscribe token that is generated via liquid syntax {{subscription.unsubscribe_token}}
when personalizing an email. See Create a Custom Unsubscribe Page for setup details.
202
The response is of type object
.