SOAP API method EmailingDestination_registerUnsubscribe
Description
Unlike other register methods, we use this from several places, as we not only register an unsubscribe but execute the unsubscribe behaviour, so we have to add the caller parameter to pass it on to database or collection.
Parameters
| Name | Type | Description |
|---|---|---|
| id * | string | Unique identifier (id) of the object EmailingDestination. The method only applies to the emailingdestination with this id. |
| timestamp * | string | mysql timestamp |
| source * | string | source |
| execute | boolean | should we execute unsubscribe behaviour, or only register an unsubscribe? |
| login | Structure of type 'login' | Optional login data (soon deprecated) |
| access_token | string | Optional api access token |
| * required parameters | ||
Return values
| Name | Type | Description |
|---|---|---|
| value | boolean | did the unsubscribing succeed |
Structure 'login'
| Name | Type | Description |
|---|---|---|
| username | string | The username of the login attempt |
| account | string | The account name of the login attempt |
| password | string | The password for the login attempt |