SOAP API method Collection_unsubscribe

Back to API references

Description
Unsubscribe a subprofile from the collection

Parameters
Parameter 'id' : int
Unique identifier (id) of the object Collection. The method only applies to the collection with this id.
Parameter 'subprofile' : Structure of type 'subprofile'
Parameter 'login' : Structure of type 'login'
Optional login data

Structure 'subprofile'
This structure subprofile was mentioned above. This structure has the following properties:
Property 'id' : int
The ID of the subprofile.
Property 'code' : string
The code of the subprofile.
Property 'created' : timestamp
The timestamp when the subprofile was created.
Property 'modified' : timestamp
The timestamp when the subprofile was last modified.
Property 'lastexport' : timestamp
The last timestamp when the subprofile was exported.
Property 'fields' : Map
Map of all fields of the subprofile, this property is only returned when the parameter 'allproperties' is set to true

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