SOAP API method EmailingDestination_registerUnsubscribe
Description
Register an unsubscribe request for this destination
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, i.e. link or email |
| 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 |