iService API Documentation

Zoom Window Out
Larger Text | Smaller Text
Hide Page Header
Show Expanding Text
Printable Version
Send Mail Feedback
Share This Topic
Save Permalink URL

Properties that may be edited by users

iService allows users to create custom contact and interaction properties of various types. The values for these properties are returned in an array that may contain multiple properties. Also, each property might contain multiple values. Since the JSON for properties is returned by many APIs, their format is listed here.

Name	Type	Description
properties	Array	This includes an array of property definitions.
properties[].propertyID	String	The id of contact property.
properties[].name	String	The name of the contact property.
properties[].isDate	Boolean	Indicates whether the values for the property are dates.
properties[].isDatetime	Boolean	Indicates whether the values for the property are Date Time elements.
properties[].isInteger	Boolean	Indicates whether the values for the property are Integers.
properties[].isNumber	Boolean	Indicates whether the values for the property are Numbers.
properties[].allowMultiple	Boolean	If true, there may be multiple values of the specified type.
properties[].hasDescriptions	Boolean	Only used if there are multiple values allowed, such as a phone number. This value indicates whether the values have a description, like home or work.
properties[].isMultiLine	Boolean	This creates a text area rather than a text input. It is only applicable to text properties.
properties[].isReadOnly	Boolean	Indicates whether the customer can read but not edit the property from a customer portal.
properties[].isRequired	Boolean	Indicates whether the property must have a value when a contact is updated.
properties[].values	Array	This includes an array of all the values for the property. If a property has allowMultiple true, it may return more than one value. See Property Values.
properties[].valueChoices	Array	An array of strings that are the valid values for each property displayed in a list.
properties[].descriptionChoices	Array	An array of strings used as the description for each property value.

An example of a properties section with two properties included is shown below. The first is a contact property named First Name, and it has a value of John. The second example is a contact property named Middle Initial, and it has no values specified.

The properties section contains a list of multiple properties and their details.

      "properties": [
        {
          "propertyID": "1",
          "name": "First Name",
          "isDate": false,
          "isDatetime": false,
          "isInteger": false,
          "isNumber": false,
          "allowMultiple": false,
          "hasDescriptions": false,
          "isMultiLine": false,
          "isReadOnly": false,
          "isRequired": false,
          "values": [
            {
              "description": null,
              "value": "John",
              "valueDateUtc": null,
              "valueDatetimeUtc": null,
              "valueInt": null,
              "valueNumber": null
            }
          ],
          "valueChoices": [],
          "descriptionChoices": []
        },

The pattern repeats for each property returned. The example below does not contain values.

        {
          "propertyID": "2",
          "name": "Middle Initial",
          "isDate": false,
          "isDatetime": false,
          "isInteger": false,
          "isNumber": false,
          "allowMultiple": false,
          "hasDescriptions": false,
          "isMultiLine": false,
          "isReadOnly": false,
          "isRequired": false,
          "values": [],
          "valueChoices": [],
          "descriptionChoices": []
        },

{

Dropdown Lists

Some contact properties are based on a list of values. The list is defined in the Tenant Settings page and referenced in the property definition. Those properties will return an array of the list value for the value Choices element. An example is below.

"valueChoices": [

"Audio-Video",

"Cameras",

"Cell Phones",

"Computers",

"Televisions"

Please enable JavaScript to view this site.

iService API Documentation

Properties that may be edited by users