SOAP API method EmailingDestination_registerUnsubscribe

Back to API references

Description
Register an unsubscribe request for this destination

Parameters
Parameter 'id' : string
Unique identifier (id) of the object EmailingDestination. The method only applies to the emailingdestination with this id.
Parameter 'timestamp' : string
mysql timestamp
Parameter 'source' : string
source, i.e. link or email
Parameter 'login' : Structure of type 'login'
Optional login data

Return values
Return value 'value' : boolean
did the unsubscribing succeed

Structure 'login'
This structure login was mentioned above. This structure has the following properties:
Property 'username' : string
The username of the login attempt
Property 'account' : string
The account name of the login attempt
Property 'password' : string
The password for the login attempt