Back to API references

SOAP API method Profile_createSubProfile

Description

Creates and returns a subprofile, based on a collection name or ID and a assoc array of fields witch should be filled in the subprofile.

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'
fields * Collection of type 'fields' Is the same as an assoc array
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
* required parameters

Return values

Name Type Description
subprofile Structure of type 'subprofile'

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 'pair'

Name Type Description
key string
value string

Structure 'fields'

Name Type Description
pair Structure of type 'pair'

Structure 'caller'

Name Type Description
followups boolean Are the follow-ups enabled
caller string The name of the caller
identity string 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.
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