contactID

Number

This parameter represents an id of Contact.

details

object

This parameter represents the user’s personal details in the form of properties.

details[].properties

Array

An array of strings that returns the properties and values of a contact.

details[].properties[].propertyID

String

This returns the id of the property.

details[].properties[].propertyName

String

This returns the name of the property

details[].properties[].values

Array

This returns multiple values of property

details[].properties[].values[].value

String

This returns single value of property

details[].setLogins

Boolean

True or false value indicating whether login values are being set.

details[].logins

Array

An array of strings. This array includes all of the logins for the contact.

details[].logins[].name

String

The vale for the login.

details[].logins[].type

String

The type of login (blank, email, bounced, or Google).

membership

Array

This parameter represents the segment membership selected for the user.

{
  "contactID": 466,
  "details": {
    "properties": [
      {
        "propertyID": "1",
        "propertyName": "First Name",
        "values": [
          {
            "value": "John"
          }
        ]
      },
      {
        "propertyID": "2",
        "propertyName": "Middle Initial",
        "values": []
      },
      {
        "propertyID": "3",
        "propertyName": "Last Name",
        "values": [
          {
            "value": "Deer"
          }
        ]
      }
    ],
    "setLogins": true,
    "logins": [
      {
        "name": "customer11@1to1service.com",
        "type": "Email"
      }
    ]
  },
  "membership": [
    "2",
    "3",
    "4",
    "5",
    "6",
    "7",
    "8",
    "10",
    "11",
    "12"
  ]
}

errors

Array

An array of strings. Returns the error message if an error is encountered, otherwise a blank array if there is no error.

errorDetails

Array

An array of strings. Provides detailed information about the error encountered, otherwise returns a blank array if no error is encountered.

{
    "errors": [],
    "errorDetails": []
}