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:

ParameterDescriptionTypeMandatory
codeObject ID of the user to be unsubscribed from receiving communications.stringyes
eEntrypoint 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.stringno, but it is always desirable to send it
tidTypology of the consent on which the action is to be performednumericno
pidProperty id of the consent on which the action is intended to be performed (provided by DruID)numericno
vview mode. Possible values are ‘confirm’, ‘redirect’. Default is ‘confirm’.stringno
acceptsimulate click on first screen shown to user. Default value is ‘false’.booleanno
request_localeLocale. Forces navigator to show page in the specific localestringno
nextURL to redirect to after completing the process. If entrypoint is specified, it will redirect to the default entrypoint callback.stringno