Welcome‎ > ‎Version 3‎ > ‎Publisher Api‎ > ‎Data Structures‎ > ‎

Profile

Data Structure holding all profile information.

Fields:
Field Data Type Nulls Description
emailstring

The email address associated with the profile
firstName
string
Y
The first name on the profile. deprecated Please use Consumer.FirstName
isGcAuth bool
Gets whether this partial profile is protected by gc auth.  That means a password/username has been set up for the account.
lastName
string
Y
The last name on the profile.  deprecated Please use Consumer.LastName
profileData list
A list of profile data items.
userKeystring

The user key of the profile.  This value is what binds together the commerce aspects.
username stringYThe username for the profile.  Can be null.
 

Sample JSON Response:
{
    "email": "email1@email.com",
    "firstName": "Sylvester"
    "isGCAuth": true,
    "lastName": "Martin",
    "profileData": [
        {
            "Key": "Name",
            "Value": "Sylvester"
        },
        {
            "Key": "City",
            "Value": "Benbrook"
        }
    ],
    "userKey": "UserKey1",
    "username": "username1"
}



Sample XML Response:
<profile>
    <email>email1@email.com</email>
    <firstName>Sylvester</firstName>
    <isGCAuth>true</isGCAuth>
    <lastName>Martin</lastName>
    <profileData>
        <dataItem>
            <key>Name</key>
            <value>Sylvester</value>
        </dataItem>
        <dataItem>
            <key>City</key>
            <value>Benbrook</value>
        </dataItem>
    </profileData>
    <userKey>UserKey1</userKey>
    <username>username1</username>
</profile>

Comments