Back to API references

SOAP API method Profile_updateSubProfiles

Description

The requirements parameter contains a list of requirement objects that are used to search for matching subprofiles. Any matching subprofiles are then updated by the given values from the fields parameter. If no match was found, a new subprofile can be created.

Parameters

Name Type Description
id * int Unique identifier (id) of the object Profile. The method only applies to the profile with this id.
timestamp string The timestamp for the historic profile
collection * Structure of type 'collection' The collection to search in
requirements * Collection of type 'requirements' An array of requirement objects to search for subprofiles
fields * Collection of type 'fields' Associative array of new values for matching subprofiles
create boolean Create a new subprofile based on the fields if no match was found
caller Structure of type 'caller' The caller object (or null if called by old code)
login Structure of type 'login' Optional login data (soon deprecated)
access_token string Optional api access token
start int Optional parameter that specifies the first element in the collection to be returned. If this parameter is omitted, the first entry in the collection is also the first entry that is returned. Use this parameter is you only want to retrieve a part of the collection.
length int Optional parameter that can be used to limit the number of returned elements of this method. If this parameter is omitted, all entries in the collection are returned. If you specify a length, this method will not return more than the specified number of entries.
allproperties boolean Optional parameter that specifies if only a limited number of properties of the requested objects are returned or, when this parameter is set to true, whether all properties of the objects are returned.
* required parameters

Return values

Name Type Description
start int The first element of the collection
length int The number of elements that are returned
total int The total available elements of the collection
allproperties int When this element is available in the return value, the objects in the collection are fully filled, otherwise only a limited number of fields from the objects are filled
subprofile Collection of type 'subprofile' The updated or created subprofiles

Structure 'collection'

Name Type Description
id int The ID of the collection.
name string The name of the collection.
weight int The weight of the collection.
created string The date and time when the account was created.
unsubscribebehavior string Get the unsubscribe behavior of the collection. Possible values are 'nothing', 'remove' or 'update'.
countsubprofiles int The number of subprofiles.
lastbuilt timestamp When was the item rebuilt for the last time?

Structure 'requirement'

Name Type Description
fieldname string The name of the field.
casesensitive boolean Is the comparison case sensitive.
operator string The operator to use, the possible operators are '=','!=','<>','LIKE', 'NOT LIKE', '<','>','<=','>=','CONTAINS'.
value string The value of the requirement.

Structure 'requirements'

Name Type Description
requirement Structure of type 'requirement'

Structure 'pair'

Name Type Description
key string
value string

Structure 'fields'

Name Type Description
pair Structure of type 'pair'

Structure 'caller'

Name Type Description
followups bool Are the follow-ups enabled
caller string The name of the caller
identity string|null The identity of the caller, this is the name that is accepted by the webcaller

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

Structure 'subprofile'

Name Type Description
id int The ID of the subprofile.