Description
You can construct a link for your newsletters and mailings that allow users to unsubscribe
Endpoint URL:
GET https://{your-register-endpoint-domain.com}/register/optout
Request parameters
To create the optout link, you have to construct a URL with the following GET parameters:
| Parameter | Description | Type | Mandatory |
| code | Object ID of the user to be unsubscribed from receiving communications. | string | yes |
| e | Entrypoint key where the request is being made. If you send this params, DruID will show buttons that redirect user to ‘App url’ if user cancel the optout, or once the process optout is completed. | string | no, but it is always desirable to send it |
| tid | Typology of the consent on which the action is to be performed | numeric | no |
| pid | Property id of the consent on which the action is intended to be performed (provided by DruID) | numeric | no |
| v | view mode. Possible values are ‘confirm’, ‘redirect’. Default is ‘confirm’. | string | no |
| accept | simulate click on first screen shown to user. Default value is ‘false’. | boolean | no |
| request_locale | Locale. Forces navigator to show page in the specific locale | string | no |
| next | URL to redirect to after completing the process. If entrypoint is specified, it will redirect to the default entrypoint callback. | string | no |