Customer Metadata

The Customer Metadata web service provides control over the Customer profile data schema.

Fetch All Customer Attributes

Usage: GET /metadata/customer

Returns schema information for all Customer Attributes and Preferences accessible by the current user.

Example JSON Response Data

[
    {"type":"master","dataType":12,"name":"Active Email Address","singleValued":true},
    {"type":"master","dataType":12,"name":"Address Line 1","singleValued":true},
    {"type":"master","dataType":12,"name":"Address Line 2","singleValued":true},
    {"type":"master","dataType":12,"name":"Alternate Customer ID","singleValued":true},
    {"type":"master","dataType":12,"name":"Alternate Phone","singleValued":true},
    {"type":"attribute","dataType":12,"name":"Android Registration ID","singleValued":true},
    {"type":"master","dataType":93,"name":"Birthdate","singleValued":true},
    {"type":"attribute","dataType":12,"name":"Channel Address","singleValued":true},
    {"type":"master","dataType":12,"name":"City","singleValued":true},
    {"type":"master","dataType":3,"name":"Content Type Code","singleValued":true},
    {"type":"master","dataType":12,"name":"Country","singleValued":true},
    {"type":"master","dataType":93,"name":"Date Of Acquisition","singleValued":true},
    {"type":"attribute","dataType":12,"name":"Email Client Type","boundedValues":["AOL","HTML","TEXT","UNKNOWN"],"singleValued":true},
    {"type":"attribute","dataType":12,"name":"Facebook ID","singleValued":true},
    {"type":"master","dataType":12,"name":"Fax","singleValued":true},
    {"type":"master","dataType":12,"name":"First Name","singleValued":true},
    {"type":"attribute","dataType":12,"name":"Gender","boundedValues":["Female","Male"],"singleValued":true},
    {"type":"attribute","dataType":12,"name":"Language","singleValued":true},
    {"type":"master","dataType":12,"name":"Last Name","singleValued":true},
    {"type":"master","dataType":12,"name":"Middle Name","singleValued":true},
    {"type":"attribute","dataType":12,"name":"Operating System","singleValued":true},
    {"type":"master","dataType":12,"name":"Organization","singleValued":true},
    {"type":"master","dataType":12,"name":"Phone","singleValued":true},
    {"type":"master","dataType":12,"name":"Province","singleValued":true},
    {"type":"master","dataType":12,"name":"Salutation","singleValued":true},
    {"type":"attribute","dataType":12,"name":"Secure eMessageID","singleValued":true},
    {"type":"master","dataType":12,"name":"State","singleValued":true},
    {"type":"master","dataType":93,"name":"Termination Date","singleValued":true},
    {"type":"attribute","dataType":12,"name":"Twitter ID","singleValued":true},
    {"type":"master","dataType":12,"name":"Zip Code","singleValued":true},
    {"type":"attribute","dataType":12,"name":"iOS Device Token ID","singleValued":true}
    ]

The data type field will have one of the following values:

3 -- Number
12 -- String
93 -- Timestamp, represented as number of milliseconds since January 1, 1970
3000 - URL

Attributes with bounded values specified must have their value appear in the bounded values list.

Fetch Single Customer Attribute

Usage: GET /metadata/customer/{Attribute Name}

Example: GET /metadata/customer/First Name

Returns schema information for the specified Customer Attribute or Preference.

Note: Attribute Names with spaces may need to be URL Encoded; e.g. GET /metadata/customer/First%20Name

Example JSON Response Data

{"type":"master","dataType":12,"name":"First Name","singleValued":true},

Error Codes

404 - if the Attribute or Preference does not exist
500 - for any other exception