Back to API references

SOAP API method Collection_unsubscribe

Description

Unsubscribe a subprofile from the collection

Parameters

Name Type Description
id * int Unique identifier (id) of the object Collection. The method only applies to the collection with this id.
subprofile * Structure of type 'subprofile'
login Structure of type 'login' Optional login data (soon deprecated)
access_token string Optional api access token
* required parameters

Structure 'subprofile'

Name Type Description
id int The ID of the subprofile.
code string The code of the subprofile.
created timestamp The timestamp when the subprofile was created.
modified timestamp The timestamp when the subprofile was last modified.
lastexport timestamp The last timestamp when the subprofile was exported.
fields Map Map of all fields of the subprofile, this property is only returned when the parameter 'allproperties' is set to true

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